/AWS1/IF_IVC=>CREATEROOM()

About CreateRoom

Creates a room that allows clients to connect and pass messages.

Method Signature

METHODS /AWS1/IF_IVC~CREATEROOM
  IMPORTING
    !IV_NAME TYPE /AWS1/IVCROOMNAME OPTIONAL
    !IV_MAXIMUMMESSAGERATEPERSEC TYPE /AWS1/IVCROOMMAXMSGRATEPERSEC OPTIONAL
    !IV_MAXIMUMMESSAGELENGTH TYPE /AWS1/IVCROOMMAXMESSAGELENGTH OPTIONAL
    !IO_MESSAGEREVIEWHANDLER TYPE REF TO /AWS1/CL_IVCMSGREVIEWHANDLER OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_IVCTAGS_W=>TT_TAGS OPTIONAL
    !IT_LOGGINGCONFIDENTIFIERS TYPE /AWS1/CL_IVCLOGCONFIDLIST_W=>TT_LOGGINGCONFIDENTIFIERLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ivccreateroomresponse
  RAISING
    /AWS1/CX_IVCACCESSDENIEDEX
    /AWS1/CX_IVCCONFLICTEXCEPTION
    /AWS1/CX_IVCPENDINGVERIFICAT00
    /AWS1/CX_IVCRESOURCENOTFOUNDEX
    /AWS1/CX_IVCSERVICEQUOTAEXCDEX
    /AWS1/CX_IVCVALIDATIONEX
    /AWS1/CX_IVCCLIENTEXC
    /AWS1/CX_IVCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_name TYPE /AWS1/IVCROOMNAME /AWS1/IVCROOMNAME

Room name. The value does not need to be unique.

iv_maximummessageratepersec TYPE /AWS1/IVCROOMMAXMSGRATEPERSEC /AWS1/IVCROOMMAXMSGRATEPERSEC

Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.

iv_maximummessagelength TYPE /AWS1/IVCROOMMAXMESSAGELENGTH /AWS1/IVCROOMMAXMESSAGELENGTH

Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.

io_messagereviewhandler TYPE REF TO /AWS1/CL_IVCMSGREVIEWHANDLER /AWS1/CL_IVCMSGREVIEWHANDLER

Configuration information for optional review of messages.

it_tags TYPE /AWS1/CL_IVCTAGS_W=>TT_TAGS TT_TAGS

Tags to attach to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented there.

it_loggingconfidentifiers TYPE /AWS1/CL_IVCLOGCONFIDLIST_W=>TT_LOGGINGCONFIDENTIFIERLIST TT_LOGGINGCONFIDENTIFIERLIST

Array of logging-configuration identifiers attached to the room.

RETURNING

oo_output TYPE REF TO /aws1/cl_ivccreateroomresponse /AWS1/CL_IVCCREATEROOMRESPONSE

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->createroom(
  io_messagereviewhandler = new /aws1/cl_ivcmsgreviewhandler(
    iv_fallbackresult = |string|
    iv_uri = |string|
  )
  it_loggingconfidentifiers = VALUE /aws1/cl_ivclogconfidlist_w=>tt_loggingconfidentifierlist(
    ( new /aws1/cl_ivclogconfidlist_w( |string| ) )
  )
  it_tags = VALUE /aws1/cl_ivctags_w=>tt_tags(
    (
      VALUE /aws1/cl_ivctags_w=>ts_tags_maprow(
        value = new /aws1/cl_ivctags_w( |string| )
        key = |string|
      )
    )
  )
  iv_maximummessagelength = 123
  iv_maximummessageratepersec = 123
  iv_name = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_roomarn = lo_result->get_arn( ).
  lv_roomid = lo_result->get_id( ).
  lv_roomname = lo_result->get_name( ).
  lv_time = lo_result->get_createtime( ).
  lv_time = lo_result->get_updatetime( ).
  lv_roommaxmessagerateperse = lo_result->get_maximummessageratepersec( ).
  lv_roommaxmessagelength = lo_result->get_maximummessagelength( ).
  lo_messagereviewhandler = lo_result->get_messagereviewhandler( ).
  IF lo_messagereviewhandler IS NOT INITIAL.
    lv_lambdaarn = lo_messagereviewhandler->get_uri( ).
    lv_fallbackresult = lo_messagereviewhandler->get_fallbackresult( ).
  ENDIF.
  LOOP AT lo_result->get_tags( ) into ls_row.
    lv_key = ls_row-key.
    lo_value = ls_row-value.
    IF lo_value IS NOT INITIAL.
      lv_tagvalue = lo_value->get_value( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_loggingconfidentifiers( ) into lo_row_1.
    lo_row_2 = lo_row_1.
    IF lo_row_2 IS NOT INITIAL.
      lv_loggingconfigurationide = lo_row_2->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.