DSCCHANNELMEMBERSHIPFORAPP00()`¶

About DescribeChannelMembershipForAppInstanceUser¶

Returns the details of a channel based on the membership of the specified AppInstanceUser or AppInstanceBot.

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~DSCCHANNELMEMBERSHIPFORAPP00
  IMPORTING
    !IV_CHANNELARN TYPE /AWS1/CHSCHIMEARN OPTIONAL
    !IV_APPINSTANCEUSERARN TYPE /AWS1/CHSCHIMEARN OPTIONAL
    !IV_CHIMEBEARER TYPE /AWS1/CHSCHIMEARN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_chsdscchannelmember03
  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_channelarn` `TYPE /AWS1/CHSCHIMEARN` `/AWS1/CHSCHIMEARN`¶

The ARN of the channel to which the user belongs.

`iv_appinstanceuserarn` `TYPE /AWS1/CHSCHIMEARN` `/AWS1/CHSCHIMEARN`¶

The ARN of the user or bot in a channel.

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

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

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_chsdscchannelmember03` `/AWS1/CL_CHSDSCCHANNELMEMBER03`¶

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->dscchannelmembershipforapp00(
  iv_appinstanceuserarn = |string|
  iv_channelarn = |string|
  iv_chimebearer = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_channelmembershipforapp = lo_result->get_channelmembership( ).
  IF lo_channelmembershipforapp IS NOT INITIAL.
    lo_channelsummary = lo_channelmembershipforapp->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_channelmembershipforapp->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.
ENDIF.

/AWS1/IF_CHS=>DSCCHANNELMEMBERSHIPFORAPP00()¶