Struct aws_sdk_chimesdkmessaging::client::fluent_builders::ListChannelMessages

pub struct ListChannelMessages { /* private fields */ }

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.

Implementations

impl ListChannelMessages

pub async fn send(
    self
) -> Result<ListChannelMessagesOutput, SdkError<ListChannelMessagesError>>

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 into_paginator(self) -> ListChannelMessagesPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

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

The ARN of the channel.

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

The ARN of the channel.

pub fn sort_order(self, input: SortOrder) -> Self

The order in which you want messages sorted. Default is Descending, based on time created.

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.

pub fn not_before(self, input: DateTime) -> Self

The initial or starting time stamp for your requested messages.

pub fn set_not_before(self, input: Option<DateTime>) -> Self

The initial or starting time stamp for your requested messages.

pub fn not_after(self, input: DateTime) -> Self

The final or ending time stamp for your requested messages.

pub fn set_not_after(self, input: Option<DateTime>) -> Self

The final or ending time stamp for your requested messages.

pub fn max_results(self, input: i32) -> Self

The maximum number of messages that you want returned.

pub fn set_max_results(self, input: Option<i32>) -> Self

The maximum number of messages that you want returned.

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

The token passed by previous API calls until all requested messages are returned.

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

The token passed by previous API calls until all requested messages are returned.

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 ListChannelMessages

fn clone(&self) -> ListChannelMessages

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListChannelMessages

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

Formats the value using the given formatter.