/AWS1/CL_CHSCHANNELMESSAGESUMM¶
Summary of the messages in a Channel.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_messageid TYPE /AWS1/CHSMESSAGEID /AWS1/CHSMESSAGEID¶
The ID of the message.
iv_content TYPE /AWS1/CHSCONTENT /AWS1/CHSCONTENT¶
The content of the channel message. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
iv_metadata TYPE /AWS1/CHSMETADATA /AWS1/CHSMETADATA¶
The metadata of the message.
iv_type TYPE /AWS1/CHSCHANNELMESSAGETYPE /AWS1/CHSCHANNELMESSAGETYPE¶
The type of message.
iv_createdtimestamp TYPE /AWS1/CHSTIMESTAMP /AWS1/CHSTIMESTAMP¶
The time at which the message summary was created.
iv_lastupdatedtimestamp TYPE /AWS1/CHSTIMESTAMP /AWS1/CHSTIMESTAMP¶
The time at which a message was last updated.
iv_lasteditedtimestamp TYPE /AWS1/CHSTIMESTAMP /AWS1/CHSTIMESTAMP¶
The time at which a message was last edited.
io_sender TYPE REF TO /AWS1/CL_CHSIDENTITY /AWS1/CL_CHSIDENTITY¶
The message sender.
iv_redacted TYPE /AWS1/CHSNONNULLABLEBOOLEAN /AWS1/CHSNONNULLABLEBOOLEAN¶
Indicates whether a message was redacted.
io_status TYPE REF TO /AWS1/CL_CHSCHANNELMSGSTATST00 /AWS1/CL_CHSCHANNELMSGSTATST00¶
The message status. The status value is
SENTfor messages sent to a channel without a channel flow. For channels associated with channel flow, the value determines the processing stage.
it_messageattributes TYPE /AWS1/CL_CHSMESSAGEATTRVALUE=>TT_MESSAGEATTRIBUTEMAP TT_MESSAGEATTRIBUTEMAP¶
The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
iv_contenttype TYPE /AWS1/CHSCONTENTTYPE /AWS1/CHSCONTENTTYPE¶
The content type of the channel message listed in the summary. For Amazon Lex V2 bot responses, the content type is
application/amz-chime-lex-msgsfor success responses andapplication/amz-chime-lex-errorfor failure responses. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
it_target TYPE /AWS1/CL_CHSTARGET=>TT_TARGETLIST TT_TARGETLIST¶
The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.
Queryable Attributes¶
MessageId¶
The ID of the message.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MESSAGEID() |
Getter for MESSAGEID, with configurable default |
ASK_MESSAGEID() |
Getter for MESSAGEID w/ exceptions if field has no value |
HAS_MESSAGEID() |
Determine if MESSAGEID has a value |
Content¶
The content of the channel message. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CONTENT() |
Getter for CONTENT, with configurable default |
ASK_CONTENT() |
Getter for CONTENT w/ exceptions if field has no value |
HAS_CONTENT() |
Determine if CONTENT has a value |
Metadata¶
The metadata of the message.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_METADATA() |
Getter for METADATA, with configurable default |
ASK_METADATA() |
Getter for METADATA w/ exceptions if field has no value |
HAS_METADATA() |
Determine if METADATA has a value |
Type¶
The type of message.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TYPE() |
Getter for TYPE, with configurable default |
ASK_TYPE() |
Getter for TYPE w/ exceptions if field has no value |
HAS_TYPE() |
Determine if TYPE has a value |
CreatedTimestamp¶
The time at which the message summary was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDTIMESTAMP() |
Getter for CREATEDTIMESTAMP, with configurable default |
ASK_CREATEDTIMESTAMP() |
Getter for CREATEDTIMESTAMP w/ exceptions if field has no va |
HAS_CREATEDTIMESTAMP() |
Determine if CREATEDTIMESTAMP has a value |
LastUpdatedTimestamp¶
The time at which a message was last updated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTUPDATEDTIMESTAMP() |
Getter for LASTUPDATEDTIMESTAMP, with configurable default |
ASK_LASTUPDATEDTIMESTAMP() |
Getter for LASTUPDATEDTIMESTAMP w/ exceptions if field has n |
HAS_LASTUPDATEDTIMESTAMP() |
Determine if LASTUPDATEDTIMESTAMP has a value |
LastEditedTimestamp¶
The time at which a message was last edited.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTEDITEDTIMESTAMP() |
Getter for LASTEDITEDTIMESTAMP, with configurable default |
ASK_LASTEDITEDTIMESTAMP() |
Getter for LASTEDITEDTIMESTAMP w/ exceptions if field has no |
HAS_LASTEDITEDTIMESTAMP() |
Determine if LASTEDITEDTIMESTAMP has a value |
Sender¶
The message sender.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SENDER() |
Getter for SENDER |
Redacted¶
Indicates whether a message was redacted.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_REDACTED() |
Getter for REDACTED |
Status¶
The message status. The status value is
SENTfor messages sent to a channel without a channel flow. For channels associated with channel flow, the value determines the processing stage.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS |
MessageAttributes¶
The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MESSAGEATTRIBUTES() |
Getter for MESSAGEATTRIBUTES, with configurable default |
ASK_MESSAGEATTRIBUTES() |
Getter for MESSAGEATTRIBUTES w/ exceptions if field has no v |
HAS_MESSAGEATTRIBUTES() |
Determine if MESSAGEATTRIBUTES has a value |
ContentType¶
The content type of the channel message listed in the summary. For Amazon Lex V2 bot responses, the content type is
application/amz-chime-lex-msgsfor success responses andapplication/amz-chime-lex-errorfor failure responses. For more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime SDK Messaging Developer Guide.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CONTENTTYPE() |
Getter for CONTENTTYPE, with configurable default |
ASK_CONTENTTYPE() |
Getter for CONTENTTYPE w/ exceptions if field has no value |
HAS_CONTENTTYPE() |
Determine if CONTENTTYPE has a value |
Target¶
The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TARGET() |
Getter for TARGET, with configurable default |
ASK_TARGET() |
Getter for TARGET w/ exceptions if field has no value |
HAS_TARGET() |
Determine if TARGET has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_CHANNELMESSAGESUMMARYLIST¶
TYPES TT_CHANNELMESSAGESUMMARYLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_CHSCHANNELMESSAGESUMM WITH DEFAULT KEY
.