Skip to content

/AWS1/CL_CHE=>LISTCHANNELMEMBERSHIPS()

About ListChannelMemberships

Lists all channel memberships in a channel.

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, ListChannelMemberships, 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.

Method Signature

IMPORTING

Required arguments:

IV_CHANNELARN TYPE /AWS1/CHECHIMEARN /AWS1/CHECHIMEARN

The maximum number of channel memberships that you want returned.

Optional arguments:

IV_TYPE TYPE /AWS1/CHECHANNELMEMBERSHIPTYPE /AWS1/CHECHANNELMEMBERSHIPTYPE

The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned.

IV_MAXRESULTS TYPE /AWS1/CHEMAXRESULTS /AWS1/CHEMAXRESULTS

The maximum number of channel memberships that you want returned.

IV_NEXTTOKEN TYPE /AWS1/CHENEXTTOKEN /AWS1/CHENEXTTOKEN

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

IV_CHIMEBEARER TYPE /AWS1/CHECHIMEARN /AWS1/CHECHIMEARN

The AppInstanceUserArn of the user that makes the API call.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_CHELSTCHANNELMEMBER01 /AWS1/CL_CHELSTCHANNELMEMBER01