LISTCHANNELS()`¶

About ListChannels¶

Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.

Functionality & restrictions

Use privacy = PUBLIC to retrieve all public channels in the account.
Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Method Signature¶

METHODS /AWS1/IF_CHS~LISTCHANNELS
  IMPORTING
    !IV_APPINSTANCEARN TYPE /AWS1/CHSCHIMEARN OPTIONAL
    !IV_PRIVACY TYPE /AWS1/CHSCHANNELPRIVACY OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/CHSMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/CHSNEXTTOKEN OPTIONAL
    !IV_CHIMEBEARER TYPE /AWS1/CHSCHIMEARN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_chslistchannelsrsp
  RAISING
    /AWS1/CX_CHSBADREQUESTEX
    /AWS1/CX_CHSFORBIDDENEXCEPTION
    /AWS1/CX_CHSSERVICEFAILUREEX
    /AWS1/CX_CHSSERVICEUNAVAILEX
    /AWS1/CX_CHSTHROTTLEDCLIENTEX
    /AWS1/CX_CHSUNAUTHDCLIENTEX
    /AWS1/CX_CHSCLIENTEXC
    /AWS1/CX_CHSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_appinstancearn` `TYPE /AWS1/CHSCHIMEARN` `/AWS1/CHSCHIMEARN`¶

The ARN of the AppInstance.

`iv_chimebearer` `TYPE /AWS1/CHSCHIMEARN` `/AWS1/CHSCHIMEARN`¶

The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

Optional arguments:¶

`iv_privacy` `TYPE /AWS1/CHSCHANNELPRIVACY` `/AWS1/CHSCHANNELPRIVACY`¶

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

`iv_maxresults` `TYPE /AWS1/CHSMAXRESULTS` `/AWS1/CHSMAXRESULTS`¶

The maximum number of channels that you want to return.

`iv_nexttoken` `TYPE /AWS1/CHSNEXTTOKEN` `/AWS1/CHSNEXTTOKEN`¶

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

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_chslistchannelsrsp` `/AWS1/CL_CHSLISTCHANNELSRSP`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->listchannels(
  iv_appinstancearn = |string|
  iv_chimebearer = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_privacy = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_channels( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_nonemptyresourcename = lo_row_1->get_name( ).
      lv_chimearn = lo_row_1->get_channelarn( ).
      lv_channelmode = lo_row_1->get_mode( ).
      lv_channelprivacy = lo_row_1->get_privacy( ).
      lv_metadata = lo_row_1->get_metadata( ).
      lv_timestamp = lo_row_1->get_lastmessagetimestamp( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_CHS=>LISTCHANNELS()¶