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 ListChannels operation. Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.

Functionality & restrictions

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, ListChannels, 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.ListChannelsRequest

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

Syntax

C#
public class ListChannelsRequest : AmazonChimeRequest
         IAmazonWebServiceRequest

The ListChannelsRequest type exposes the following members

Constructors

NameDescription
Public Method ListChannelsRequest()

Properties

NameTypeDescription
Public Property AppInstanceArn System.String

Gets and sets the property AppInstanceArn.

The ARN of the AppInstance.

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 channels that you want to return.

Public Property NextToken System.String

Gets and sets the property NextToken.

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

Public Property Privacy Amazon.Chime.ChannelPrivacy

Gets and sets the property Privacy.

The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.

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