SENDEVENT()`¶

About SendEvent¶

Sends an event to a room. Use this within your application’s business logic to send events to clients of a room; e.g., to notify clients to change the way the chat UI is rendered.

Method Signature¶

METHODS /AWS1/IF_IVC~SENDEVENT
  IMPORTING
    !IV_ROOMIDENTIFIER TYPE /AWS1/IVCROOMIDENTIFIER OPTIONAL
    !IV_EVENTNAME TYPE /AWS1/IVCEVENTNAME OPTIONAL
    !IT_ATTRIBUTES TYPE /AWS1/CL_IVCEVENTATTRIBUTES_W=>TT_EVENTATTRIBUTES OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ivcsendeventresponse
  RAISING
    /AWS1/CX_IVCACCESSDENIEDEX
    /AWS1/CX_IVCPENDINGVERIFICAT00
    /AWS1/CX_IVCRESOURCENOTFOUNDEX
    /AWS1/CX_IVCTHROTTLINGEX
    /AWS1/CX_IVCVALIDATIONEX
    /AWS1/CX_IVCCLIENTEXC
    /AWS1/CX_IVCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

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

Identifier of the room to which the event will be sent. Currently this must be an ARN.

`iv_eventname` `TYPE /AWS1/IVCEVENTNAME` `/AWS1/IVCEVENTNAME`¶

Application-defined name of the event to send to clients.

Optional arguments:¶

`it_attributes` `TYPE /AWS1/CL_IVCEVENTATTRIBUTES_W=>TT_EVENTATTRIBUTES` `TT_EVENTATTRIBUTES`¶

Application-defined metadata to attach to the event sent to clients. The maximum length of the metadata is 1 KB total.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ivcsendeventresponse` `/AWS1/CL_IVCSENDEVENTRESPONSE`¶

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->sendevent(
  it_attributes = VALUE /aws1/cl_ivceventattributes_w=>tt_eventattributes(
    (
      VALUE /aws1/cl_ivceventattributes_w=>ts_eventattributes_maprow(
        key = |string|
        value = new /aws1/cl_ivceventattributes_w( |string| )
      )
    )
  )
  iv_eventname = |string|
  iv_roomidentifier = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_id = lo_result->get_id( ).
ENDIF.

/AWS1/IF_IVC=>SENDEVENT()¶