Struct aws_sdk_chime::operation::send_channel_message::builders::SendChannelMessageFluentBuilder
source ยท pub struct SendChannelMessageFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to SendChannelMessage
.
Sends a message to a particular channel that the member is a part of.
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.
Also, STANDARD
messages can contain 4KB of data and the 1KB of metadata. CONTROL
messages can contain 30 bytes of data and no metadata.
This API is is no longer supported and will not be updated. We recommend using the latest version, SendChannelMessage, 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ยง
sourceยงimpl SendChannelMessageFluentBuilder
impl SendChannelMessageFluentBuilder
sourcepub fn as_input(&self) -> &SendChannelMessageInputBuilder
pub fn as_input(&self) -> &SendChannelMessageInputBuilder
Access the SendChannelMessage as a reference.
sourcepub async fn send(
self
) -> Result<SendChannelMessageOutput, SdkError<SendChannelMessageError, HttpResponse>>
pub async fn send( self ) -> Result<SendChannelMessageOutput, SdkError<SendChannelMessageError, 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.
sourcepub fn customize(
self
) -> CustomizableOperation<SendChannelMessageOutput, SendChannelMessageError, Self>
pub fn customize( self ) -> CustomizableOperation<SendChannelMessageOutput, SendChannelMessageError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn channel_arn(self, input: impl Into<String>) -> Self
pub fn channel_arn(self, input: impl Into<String>) -> Self
The ARN of the channel.
sourcepub fn set_channel_arn(self, input: Option<String>) -> Self
pub fn set_channel_arn(self, input: Option<String>) -> Self
The ARN of the channel.
sourcepub fn get_channel_arn(&self) -> &Option<String>
pub fn get_channel_arn(&self) -> &Option<String>
The ARN of the channel.
sourcepub fn set_content(self, input: Option<String>) -> Self
pub fn set_content(self, input: Option<String>) -> Self
The content of the message.
sourcepub fn get_content(&self) -> &Option<String>
pub fn get_content(&self) -> &Option<String>
The content of the message.
sourcepub fn type(self, input: ChannelMessageType) -> Self
pub fn type(self, input: ChannelMessageType) -> Self
The type of message, STANDARD
or CONTROL
.
sourcepub fn set_type(self, input: Option<ChannelMessageType>) -> Self
pub fn set_type(self, input: Option<ChannelMessageType>) -> Self
The type of message, STANDARD
or CONTROL
.
sourcepub fn get_type(&self) -> &Option<ChannelMessageType>
pub fn get_type(&self) -> &Option<ChannelMessageType>
The type of message, STANDARD
or CONTROL
.
sourcepub fn persistence(self, input: ChannelMessagePersistenceType) -> Self
pub fn persistence(self, input: ChannelMessagePersistenceType) -> Self
Boolean that controls whether the message is persisted on the back end. Required.
sourcepub fn set_persistence(
self,
input: Option<ChannelMessagePersistenceType>
) -> Self
pub fn set_persistence( self, input: Option<ChannelMessagePersistenceType> ) -> Self
Boolean that controls whether the message is persisted on the back end. Required.
sourcepub fn get_persistence(&self) -> &Option<ChannelMessagePersistenceType>
pub fn get_persistence(&self) -> &Option<ChannelMessagePersistenceType>
Boolean that controls whether the message is persisted on the back end. Required.
sourcepub fn metadata(self, input: impl Into<String>) -> Self
pub fn metadata(self, input: impl Into<String>) -> Self
The optional metadata for each message.
sourcepub fn set_metadata(self, input: Option<String>) -> Self
pub fn set_metadata(self, input: Option<String>) -> Self
The optional metadata for each message.
sourcepub fn get_metadata(&self) -> &Option<String>
pub fn get_metadata(&self) -> &Option<String>
The optional metadata for each message.
sourcepub fn client_request_token(self, input: impl Into<String>) -> Self
pub fn client_request_token(self, input: impl Into<String>) -> Self
The Idempotency
token for each client request.
sourcepub fn set_client_request_token(self, input: Option<String>) -> Self
pub fn set_client_request_token(self, input: Option<String>) -> Self
The Idempotency
token for each client request.
sourcepub fn get_client_request_token(&self) -> &Option<String>
pub fn get_client_request_token(&self) -> &Option<String>
The Idempotency
token for each client request.
sourcepub fn chime_bearer(self, input: impl Into<String>) -> Self
pub fn chime_bearer(self, input: impl Into<String>) -> Self
The AppInstanceUserArn
of the user that makes the API call.
sourcepub fn set_chime_bearer(self, input: Option<String>) -> Self
pub fn set_chime_bearer(self, input: Option<String>) -> Self
The AppInstanceUserArn
of the user that makes the API call.
sourcepub fn get_chime_bearer(&self) -> &Option<String>
pub fn get_chime_bearer(&self) -> &Option<String>
The AppInstanceUserArn
of the user that makes the API call.
Trait Implementationsยง
sourceยงimpl Clone for SendChannelMessageFluentBuilder
impl Clone for SendChannelMessageFluentBuilder
sourceยงfn clone(&self) -> SendChannelMessageFluentBuilder
fn clone(&self) -> SendChannelMessageFluentBuilder
1.0.0 ยท sourceยงfn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementationsยง
impl Freeze for SendChannelMessageFluentBuilder
impl !RefUnwindSafe for SendChannelMessageFluentBuilder
impl Send for SendChannelMessageFluentBuilder
impl Sync for SendChannelMessageFluentBuilder
impl Unpin for SendChannelMessageFluentBuilder
impl !UnwindSafe for SendChannelMessageFluentBuilder
Blanket Implementationsยง
sourceยงimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
sourceยงfn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
sourceยงimpl<T> Instrument for T
impl<T> Instrument for T
sourceยงfn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourceยงfn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceยงimpl<T> IntoEither for T
impl<T> IntoEither for T
sourceยงfn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresourceยงfn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more