Skip to content

/AWS1/CL_IVCGETROOMRESPONSE

GetRoomResponse

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_arn TYPE /AWS1/IVCROOMARN /AWS1/IVCROOMARN

Room ARN, from the request (if identifier was an ARN).

iv_id TYPE /AWS1/IVCROOMID /AWS1/IVCROOMID

Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.

iv_name TYPE /AWS1/IVCROOMNAME /AWS1/IVCROOMNAME

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

iv_createtime TYPE /AWS1/IVCTIME /AWS1/IVCTIME

Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.

iv_updatetime TYPE /AWS1/IVCTIME /AWS1/IVCTIME

Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.

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 attached to the resource. Array of maps, each of the form string:string (key:value).

it_loggingconfidentifiers TYPE /AWS1/CL_IVCLOGCONFIDLIST_W=>TT_LOGGINGCONFIDENTIFIERLIST TT_LOGGINGCONFIDENTIFIERLIST

Array of logging configurations attached to the room.


Queryable Attributes

arn

Room ARN, from the request (if identifier was an ARN).

Accessible with the following methods

Method Description
GET_ARN() Getter for ARN, with configurable default
ASK_ARN() Getter for ARN w/ exceptions if field has no value
HAS_ARN() Determine if ARN has a value

id

Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.

Accessible with the following methods

Method Description
GET_ID() Getter for ID, with configurable default
ASK_ID() Getter for ID w/ exceptions if field has no value
HAS_ID() Determine if ID has a value

name

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

Accessible with the following methods

Method Description
GET_NAME() Getter for NAME, with configurable default
ASK_NAME() Getter for NAME w/ exceptions if field has no value
HAS_NAME() Determine if NAME has a value

createTime

Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.

Accessible with the following methods

Method Description
GET_CREATETIME() Getter for CREATETIME, with configurable default
ASK_CREATETIME() Getter for CREATETIME w/ exceptions if field has no value
HAS_CREATETIME() Determine if CREATETIME has a value

updateTime

Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.

Accessible with the following methods

Method Description
GET_UPDATETIME() Getter for UPDATETIME, with configurable default
ASK_UPDATETIME() Getter for UPDATETIME w/ exceptions if field has no value
HAS_UPDATETIME() Determine if UPDATETIME has a value

maximumMessageRatePerSecond

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

Accessible with the following methods

Method Description
GET_MAXIMUMMESSAGERATEPERSEC() Getter for MAXIMUMMESSAGERATEPERSECOND, with configurable de
ASK_MAXIMUMMESSAGERATEPERSEC() Getter for MAXIMUMMESSAGERATEPERSECOND w/ exceptions if fiel
HAS_MAXIMUMMESSAGERATEPERSEC() Determine if MAXIMUMMESSAGERATEPERSECOND has a value

maximumMessageLength

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.

Accessible with the following methods

Method Description
GET_MAXIMUMMESSAGELENGTH() Getter for MAXIMUMMESSAGELENGTH, with configurable default
ASK_MAXIMUMMESSAGELENGTH() Getter for MAXIMUMMESSAGELENGTH w/ exceptions if field has n
HAS_MAXIMUMMESSAGELENGTH() Determine if MAXIMUMMESSAGELENGTH has a value

messageReviewHandler

Configuration information for optional review of messages.

Accessible with the following methods

Method Description
GET_MESSAGEREVIEWHANDLER() Getter for MESSAGEREVIEWHANDLER

tags

Tags attached to the resource. Array of maps, each of the form string:string (key:value).

Accessible with the following methods

Method Description
GET_TAGS() Getter for TAGS, with configurable default
ASK_TAGS() Getter for TAGS w/ exceptions if field has no value
HAS_TAGS() Determine if TAGS has a value

loggingConfigurationIdentifiers

Array of logging configurations attached to the room.

Accessible with the following methods

Method Description
GET_LOGGINGCONFIDENTIFIERS() Getter for LOGGINGCONFIDENTIFIERS, with configurable default
ASK_LOGGINGCONFIDENTIFIERS() Getter for LOGGINGCONFIDENTIFIERS w/ exceptions if field has
HAS_LOGGINGCONFIDENTIFIERS() Determine if LOGGINGCONFIDENTIFIERS has a value