Skip to content

/AWS1/CL_CHS=>LSTCHANNELMEMBERSHIPSFORAP00()

About ListChannelMembershipsForAppInstanceUser

Lists all channels that an AppInstanceUser or AppInstanceBot is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own.

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

IMPORTING

Required arguments:

iv_chimebearer TYPE /AWS1/CHSCHIMEARN /AWS1/CHSCHIMEARN

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

Optional arguments:

iv_appinstanceuserarn TYPE /AWS1/CHSCHIMEARN /AWS1/CHSCHIMEARN

The ARN of the user or bot.

iv_maxresults TYPE /AWS1/CHSMAXRESULTS /AWS1/CHSMAXRESULTS

The maximum number of users that you want returned.

iv_nexttoken TYPE /AWS1/CHSNEXTTOKEN /AWS1/CHSNEXTTOKEN

The token returned from previous API requests until the number of channel memberships is reached.

RETURNING

oo_output TYPE REF TO /aws1/cl_chslstchannelmember03 /AWS1/CL_CHSLSTCHANNELMEMBER03

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->/aws1/if_chs~lstchannelmembershipsforap00(
  iv_appinstanceuserarn = |string|
  iv_chimebearer = |string|
  iv_maxresults = 123
  iv_nexttoken = |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_channelmemberships( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lo_channelsummary = lo_row_1->get_channelsummary( ).
      IF lo_channelsummary IS NOT INITIAL.
        lv_nonemptyresourcename = lo_channelsummary->get_name( ).
        lv_chimearn = lo_channelsummary->get_channelarn( ).
        lv_channelmode = lo_channelsummary->get_mode( ).
        lv_channelprivacy = lo_channelsummary->get_privacy( ).
        lv_metadata = lo_channelsummary->get_metadata( ).
        lv_timestamp = lo_channelsummary->get_lastmessagetimestamp( ).
      ENDIF.
      lo_appinstanceusermembersh = lo_row_1->get_appinstusermemberships00( ).
      IF lo_appinstanceusermembersh IS NOT INITIAL.
        lv_channelmembershiptype = lo_appinstanceusermembersh->get_type( ).
        lv_timestamp = lo_appinstanceusermembersh->get_readmarkertimestamp( ).
        lv_subchannelid = lo_appinstanceusermembersh->get_subchannelid( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.