DISCONNECTUSER()`¶

About DisconnectUser¶

Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.

Method Signature¶

IMPORTING¶

Required arguments:¶

`iv_roomidentifier` `TYPE /AWS1/IVCROOMIDENTIFIER` `/AWS1/IVCROOMIDENTIFIER`¶

Identifier of the room from which the user's clients should be disconnected. Currently this must be an ARN.

`iv_userid` `TYPE /AWS1/IVCUSERID` `/AWS1/IVCUSERID`¶

ID of the user (connection) to disconnect from the room.

Optional arguments:¶

`iv_reason` `TYPE /AWS1/IVCREASON` `/AWS1/IVCREASON`¶

Reason for disconnecting the user.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ivcdisconnectuserrsp` `/AWS1/CL_IVCDISCONNECTUSERRSP`¶

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_ivc~disconnectuser(
  iv_reason = |string|
  iv_roomidentifier = |string|
  iv_userid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.

/AWS1/CL_IVC=>DISCONNECTUSER()¶