Struct aws_sdk_chime::operation::create_channel_membership::builders::CreateChannelMembershipFluentBuilder

pub struct CreateChannelMembershipFluentBuilder { /* private fields */ }

👎Deprecated: Replaced by CreateChannelMembership in the Amazon Chime SDK Messaging Namespace

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.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannelMembership, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Implementations

impl CreateChannelMembershipFluentBuilder

pub fn as_input(&self) -> &CreateChannelMembershipInputBuilder

Access the CreateChannelMembership as a reference.

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

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 customize( self ) -> CustomizableOperation<CreateChannelMembershipOutput, CreateChannelMembershipError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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 get_channel_arn(&self) -> &Option<String>

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 get_member_arn(&self) -> &Option<String>

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 get_type(&self) -> &Option<ChannelMembershipType>

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.

pub fn get_chime_bearer(&self) -> &Option<String>

The AppInstanceUserArn of the user that makes the API call.

Trait Implementations

impl Clone for CreateChannelMembershipFluentBuilder

fn clone(&self) -> CreateChannelMembershipFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateChannelMembershipFluentBuilder

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

Formats the value using the given formatter.