/AWS1/CL_CHSCHANNELMESSAGE¶
The details of a message in a channel.
CONSTRUCTOR
¶
IMPORTING¶
Optional arguments:¶
iv_channelarn
TYPE /AWS1/CHSCHIMEARN
/AWS1/CHSCHIMEARN
¶
The ARN of the channel.
iv_messageid
TYPE /AWS1/CHSMESSAGEID
/AWS1/CHSMESSAGEID
¶
The ID of a 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 message metadata.
iv_type
TYPE /AWS1/CHSCHANNELMESSAGETYPE
/AWS1/CHSCHANNELMESSAGETYPE
¶
The message type.
iv_createdtimestamp
TYPE /AWS1/CHSTIMESTAMP
/AWS1/CHSTIMESTAMP
¶
The time at which the message was created.
iv_lasteditedtimestamp
TYPE /AWS1/CHSTIMESTAMP
/AWS1/CHSTIMESTAMP
¶
The time at which a message was edited.
iv_lastupdatedtimestamp
TYPE /AWS1/CHSTIMESTAMP
/AWS1/CHSTIMESTAMP
¶
The time at which a message was updated.
io_sender
TYPE REF TO /AWS1/CL_CHSIDENTITY
/AWS1/CL_CHSIDENTITY
¶
The message sender.
iv_redacted
TYPE /AWS1/CHSNONNULLABLEBOOLEAN
/AWS1/CHSNONNULLABLEBOOLEAN
¶
Hides the content of a message.
iv_persistence
TYPE /AWS1/CHSCHANNELMSGPERSISTEN00
/AWS1/CHSCHANNELMSGPERSISTEN00
¶
The persistence setting for a channel message.
io_status
TYPE REF TO /AWS1/CL_CHSCHANNELMSGSTATST00
/AWS1/CL_CHSCHANNELMSGSTATST00
¶
The status of the channel message.
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_subchannelid
TYPE /AWS1/CHSSUBCHANNELID
/AWS1/CHSSUBCHANNELID
¶
The ID of the SubChannel.
iv_contenttype
TYPE /AWS1/CHSCONTENTTYPE
/AWS1/CHSCONTENTTYPE
¶
The content type of the channel message. For Amazon Lex V2 bot responses, the content type is
application/amz-chime-lex-msgs
for success responses andapplication/amz-chime-lex-error
for 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¶
ChannelArn¶
The ARN of the channel.
Accessible with the following methods¶
Method | Description |
---|---|
GET_CHANNELARN() |
Getter for CHANNELARN, with configurable default |
ASK_CHANNELARN() |
Getter for CHANNELARN w/ exceptions if field has no value |
HAS_CHANNELARN() |
Determine if CHANNELARN has a value |
MessageId¶
The ID of a 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 message metadata.
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 message type.
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 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 |
LastEditedTimestamp¶
The time at which a message was 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 |
LastUpdatedTimestamp¶
The time at which a message was 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 |
Sender¶
The message sender.
Accessible with the following methods¶
Method | Description |
---|---|
GET_SENDER() |
Getter for SENDER |
Redacted¶
Hides the content of a message.
Accessible with the following methods¶
Method | Description |
---|---|
GET_REDACTED() |
Getter for REDACTED |
Persistence¶
The persistence setting for a channel message.
Accessible with the following methods¶
Method | Description |
---|---|
GET_PERSISTENCE() |
Getter for PERSISTENCE, with configurable default |
ASK_PERSISTENCE() |
Getter for PERSISTENCE w/ exceptions if field has no value |
HAS_PERSISTENCE() |
Determine if PERSISTENCE has a value |
Status¶
The status of the channel message.
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 |
SubChannelId¶
The ID of the SubChannel.
Accessible with the following methods¶
Method | Description |
---|---|
GET_SUBCHANNELID() |
Getter for SUBCHANNELID, with configurable default |
ASK_SUBCHANNELID() |
Getter for SUBCHANNELID w/ exceptions if field has no value |
HAS_SUBCHANNELID() |
Determine if SUBCHANNELID has a value |
ContentType¶
The content type of the channel message. For Amazon Lex V2 bot responses, the content type is
application/amz-chime-lex-msgs
for success responses andapplication/amz-chime-lex-error
for 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 |