AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the ListChannelMessages operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Chime.AmazonChimeRequest
      Amazon.Chime.Model.ListChannelMessagesRequest

Namespace: Amazon.Chime.Model
Assembly: AWSSDK.Chime.dll
Version: 3.x.y.z

Syntax

C#
public class ListChannelMessagesRequest : AmazonChimeRequest
         IAmazonWebServiceRequest

The ListChannelMessagesRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property ChannelArn System.String

Gets and sets the property ChannelArn.

The ARN of the channel.

Public Property ChimeBearer System.String

Gets and sets the property ChimeBearer.

The AppInstanceUserArn of the user that makes the API call.

Public Property MaxResults System.Int32

Gets and sets the property MaxResults.

The maximum number of messages that you want returned.

Public Property NextToken System.String

Gets and sets the property NextToken.

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

Public Property NotAfter System.DateTime

Gets and sets the property NotAfter.

The final or ending time stamp for your requested messages.

Public Property NotBefore System.DateTime

Gets and sets the property NotBefore.

The initial or starting time stamp for your requested messages.

Public Property SortOrder Amazon.Chime.SortOrder

Gets and sets the property SortOrder.

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

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5