PUTCHANNELMEMBERSHIPPREFER00()`¶

About PutChannelMembershipPreferences¶

Sets the membership preferences of an AppInstanceUser or AppInstanceBot for the specified channel. The user or bot must be a member of the channel. Only the user or bot who owns the membership can set preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can't set preferences for other users. Banned users or bots can't set membership preferences for the channel from which they are banned.

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

Method Signature¶

METHODS /AWS1/IF_CHS~PUTCHANNELMEMBERSHIPPREFER00
  IMPORTING
    !IV_CHANNELARN TYPE /AWS1/CHSCHIMEARN OPTIONAL
    !IV_MEMBERARN TYPE /AWS1/CHSCHIMEARN OPTIONAL
    !IV_CHIMEBEARER TYPE /AWS1/CHSCHIMEARN OPTIONAL
    !IO_PREFERENCES TYPE REF TO /AWS1/CL_CHSCHANNELMEMBERSHI01 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_chsputchannelmember01
  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.

`iv_memberarn` `TYPE /AWS1/CHSCHIMEARN` `/AWS1/CHSCHIMEARN`¶

The ARN of the member setting the preferences.

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

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

`io_preferences` `TYPE REF TO /AWS1/CL_CHSCHANNELMEMBERSHI01` `/AWS1/CL_CHSCHANNELMEMBERSHI01`¶

The channel membership preferences of an AppInstanceUser .

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_chsputchannelmember01` `/AWS1/CL_CHSPUTCHANNELMEMBER01`¶

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->putchannelmembershipprefer00(
  io_preferences = new /aws1/cl_chschannelmembershi01(
    io_pushnotifications = new /aws1/cl_chspushntfpreferences(
      iv_allownotifications = |string|
      iv_filterrule = |string|
    )
  )
  iv_channelarn = |string|
  iv_chimebearer = |string|
  iv_memberarn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_chimearn = lo_result->get_channelarn( ).
  lo_identity = lo_result->get_member( ).
  IF lo_identity IS NOT INITIAL.
    lv_chimearn = lo_identity->get_arn( ).
    lv_resourcename = lo_identity->get_name( ).
  ENDIF.
  lo_channelmembershipprefer = lo_result->get_preferences( ).
  IF lo_channelmembershipprefer IS NOT INITIAL.
    lo_pushnotificationprefere = lo_channelmembershipprefer->get_pushnotifications( ).
    IF lo_pushnotificationprefere IS NOT INITIAL.
      lv_allownotifications = lo_pushnotificationprefere->get_allownotifications( ).
      lv_filterrule = lo_pushnotificationprefere->get_filterrule( ).
    ENDIF.
  ENDIF.
ENDIF.

/AWS1/IF_CHS=>PUTCHANNELMEMBERSHIPPREFER00()¶