InAppMessage
Represents an in-app message.
Represents an in-app message.
Properties
| Properties | Type | Description |
|---|---|---|
| appId | String | The application ID of the message.val appId: String? |
| userId | String | The user ID associated with the message.val userId: String? |
| deviceId | String | The device ID associated with the message.val deviceId: String? |
| message | String | The message content.var message: String? |
| type | InAppMessageType | The message type.val type: InAppMessageType |
| thread | InAppThread | The thread associated with the message.var thread: InAppThread? |
| extras | JSONObject | Any extra data associated with the message.val extras: JSONObject |
| customTags | JSONObject | Any custom tags associated with the message.var customTags: JSONObject? |
| attachments | InAppAttachment | Attachments associated with the message.var attachments: ArrayList<InAppAttachment>? |
| interactiveData | InAppInteractiveData | The interactive data associated with the message.val interactiveData: InAppInteractiveData? |
| quickReply | InAppQuickReply | The InAppQuickReplyhe quick reply associated with the message.val quickReply: InAppQuickReply? |
| reference | String | The reference of the message.val reference: String? |
| transactionId | String | The transaction ID of the message.val transactionId: String |
| relatedTransactionId | String | The related transaction ID of the message.var relatedTransactionId: String? |
| status | InAppMessageStatus | The status of the message.var status: InAppMessageStatus |
| isOutgoing | Boolean | Is the message outgoing.val isOutgoing: Boolean |
| readAt | Date | The date when the message was read.var readAt: Date? |
| createdAt | Date | The date when the message was created.val createdAt: Date? |
| submittedAt | Date | The date when the message was submitted.val submittedAt: Date? |
| deliveredAt | Date | The date when the message was delivered.var deliveredAt: Date? |
Functions
toJson
Converts the message to a JSON object.
Syntax:fun toJson(): JSONObject
Return
The JSON object representing the message.
Companion Functions
fromJson
Converts a JSONObject to a message.
Syntax:fun fromJson(jsonObject: JSONObject): InAppMessage
Parameters
| Parameters | Type | Description |
|---|---|---|
| jsonObject | JSONObject | The JSONObject to convert. |
Return
The message converted from the JSONObject.
val ccTransactionId: String? // Webex Contact Center or CCE tenants transaction ID
val isRedacted: Boolean // true if content was redacted
Description
ccTransactionId
ccTransactionIdWebex Contact Center or CCE-scoped identifier, populated only for CC tenants. The existing transactionId continues to identify the message on the Webex Connect platform. The two are correlated by the server.
isRedacted
isRedactedtrue when the server has stripped the original message content for privacy, compliance, or DSR. UI should render a redacted placeholder instead of the original body.
Updated about 2 months ago