Struct aws_sdk_chime::client::fluent_builders::CreateChannelMembership

pub struct CreateChannelMembership { /* private fields */ }

Fluent builder constructing a request to CreateChannelMembership.

Adds a user to a channel. The InvitedBy response field is derived from the request header. A channel member can:

• List messages

• Send messages

• Receive messages

• Edit their own messages

• Leave the channel

Privacy settings impact this action as follows:

• Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.

• Private Channels: You must be a member to list or send messages.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Implementations

impl CreateChannelMembership

pub async fn send(
    self
) -> Result<CreateChannelMembershipOutput, SdkError<CreateChannelMembershipError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn channel_arn(self, input: impl Into<String>) -> Self

The ARN of the channel to which you're adding users.

pub fn set_channel_arn(self, input: Option<String>) -> Self

The ARN of the channel to which you're adding users.

pub fn member_arn(self, input: impl Into<String>) -> Self

The ARN of the member you want to add to the channel.

pub fn set_member_arn(self, input: Option<String>) -> Self

The ARN of the member you want to add to the channel.

pub fn type(self, input: ChannelMembershipType) -> Self

The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.

pub fn set_type(self, input: Option<ChannelMembershipType>) -> Self

The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.

pub fn chime_bearer(self, input: impl Into<String>) -> Self

The AppInstanceUserArn of the user that makes the API call.

pub fn set_chime_bearer(self, input: Option<String>) -> Self

The AppInstanceUserArn of the user that makes the API call.

Trait Implementations

impl Clone for CreateChannelMembership

fn clone(&self) -> CreateChannelMembership

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateChannelMembership

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.