Struct aws_sdk_chime::operation::list_channel_messages::builders::ListChannelMessagesFluentBuilder
source · pub struct ListChannelMessagesFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to ListChannelMessages
.
List all the messages in a channel. Returns a paginated list of ChannelMessages
. By default, sorted by creation timestamp in descending order.
Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.
Also, 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, ListChannelMessages, 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 ListChannelMessagesFluentBuilder
impl ListChannelMessagesFluentBuilder
sourcepub fn as_input(&self) -> &ListChannelMessagesInputBuilder
pub fn as_input(&self) -> &ListChannelMessagesInputBuilder
Access the ListChannelMessages as a reference.
sourcepub async fn send(
self
) -> Result<ListChannelMessagesOutput, SdkError<ListChannelMessagesError, HttpResponse>>
pub async fn send( self ) -> Result<ListChannelMessagesOutput, SdkError<ListChannelMessagesError, 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<ListChannelMessagesOutput, ListChannelMessagesError, Self>
pub fn customize( self ) -> CustomizableOperation<ListChannelMessagesOutput, ListChannelMessagesError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn into_paginator(self) -> ListChannelMessagesPaginator
pub fn into_paginator(self) -> ListChannelMessagesPaginator
Create a paginator for this request
Paginators are used by calling send().await
which returns a PaginationStream
.
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 sort_order(self, input: SortOrder) -> Self
pub fn sort_order(self, input: SortOrder) -> Self
The order in which you want messages sorted. Default is Descending, based on time created.
sourcepub fn set_sort_order(self, input: Option<SortOrder>) -> Self
pub fn set_sort_order(self, input: Option<SortOrder>) -> Self
The order in which you want messages sorted. Default is Descending, based on time created.
sourcepub fn get_sort_order(&self) -> &Option<SortOrder>
pub fn get_sort_order(&self) -> &Option<SortOrder>
The order in which you want messages sorted. Default is Descending, based on time created.
sourcepub fn not_before(self, input: DateTime) -> Self
pub fn not_before(self, input: DateTime) -> Self
The initial or starting time stamp for your requested messages.
sourcepub fn set_not_before(self, input: Option<DateTime>) -> Self
pub fn set_not_before(self, input: Option<DateTime>) -> Self
The initial or starting time stamp for your requested messages.
sourcepub fn get_not_before(&self) -> &Option<DateTime>
pub fn get_not_before(&self) -> &Option<DateTime>
The initial or starting time stamp for your requested messages.
sourcepub fn not_after(self, input: DateTime) -> Self
pub fn not_after(self, input: DateTime) -> Self
The final or ending time stamp for your requested messages.
sourcepub fn set_not_after(self, input: Option<DateTime>) -> Self
pub fn set_not_after(self, input: Option<DateTime>) -> Self
The final or ending time stamp for your requested messages.
sourcepub fn get_not_after(&self) -> &Option<DateTime>
pub fn get_not_after(&self) -> &Option<DateTime>
The final or ending time stamp for your requested messages.
sourcepub fn max_results(self, input: i32) -> Self
pub fn max_results(self, input: i32) -> Self
The maximum number of messages that you want returned.
sourcepub fn set_max_results(self, input: Option<i32>) -> Self
pub fn set_max_results(self, input: Option<i32>) -> Self
The maximum number of messages that you want returned.
sourcepub fn get_max_results(&self) -> &Option<i32>
pub fn get_max_results(&self) -> &Option<i32>
The maximum number of messages that you want returned.
sourcepub fn next_token(self, input: impl Into<String>) -> Self
pub fn next_token(self, input: impl Into<String>) -> Self
The token passed by previous API calls until all requested messages are returned.
sourcepub fn set_next_token(self, input: Option<String>) -> Self
pub fn set_next_token(self, input: Option<String>) -> Self
The token passed by previous API calls until all requested messages are returned.
sourcepub fn get_next_token(&self) -> &Option<String>
pub fn get_next_token(&self) -> &Option<String>
The token passed by previous API calls until all requested messages are returned.
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 ListChannelMessagesFluentBuilder
impl Clone for ListChannelMessagesFluentBuilder
source§fn clone(&self) -> ListChannelMessagesFluentBuilder
fn clone(&self) -> ListChannelMessagesFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more