Skip to content

/AWS1/IF_CHS=>DELETECHANNELMEMBERSHIP()

About DeleteChannelMembership

Removes a member from 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.

Method Signature

METHODS /AWS1/IF_CHS~DELETECHANNELMEMBERSHIP
  IMPORTING
    !IV_CHANNELARN TYPE /AWS1/CHSCHIMEARN OPTIONAL
    !IV_MEMBERARN TYPE /AWS1/CHSCHIMEARN OPTIONAL
    !IV_CHIMEBEARER TYPE /AWS1/CHSCHIMEARN OPTIONAL
    !IV_SUBCHANNELID TYPE /AWS1/CHSSUBCHANNELID OPTIONAL
  RAISING
    /AWS1/CX_CHSBADREQUESTEX
    /AWS1/CX_CHSCONFLICTEXCEPTION
    /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 from which you want to remove the user.

iv_memberarn TYPE /AWS1/CHSCHIMEARN /AWS1/CHSCHIMEARN

The AppInstanceUserArn of the member that you're removing from the channel.

iv_chimebearer TYPE /AWS1/CHSCHIMEARN /AWS1/CHSCHIMEARN

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

Optional arguments:

iv_subchannelid TYPE /AWS1/CHSSUBCHANNELID /AWS1/CHSSUBCHANNELID

The ID of the SubChannel in the request.

Only for use by moderators.

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.

lo_client->deletechannelmembership(
  iv_channelarn = |string|
  iv_chimebearer = |string|
  iv_memberarn = |string|
  iv_subchannelid = |string|
).