Inbox Models Module v1.0.0/com.salesforce.marketingcloud.inboxmodels/InboxMessage

InboxMessage

data class InboxMessage(val id: String, val subject: InboxMessage.InboxStyledText? = null, val sound: String? = null, val media: InboxMessage.InboxMedia? = null, val startDateUtc: Date? = null, val endDateUtc: Date? = null, val sendDateUtc: Date? = null, val custom: String? = null, val customKeys: Map<String, String>? = null, val subtitle: InboxMessage.InboxStyledText? = null, val inboxMessage: InboxMessage.InboxStyledText? = null, val notificationMessage: NotificationMessage? = null, val messageType: InboxMessage.InboxMessageType, var deleted: Boolean = false, val source: Event.Producer = Event.Producer.MCE_MODULE, val action: InboxMessage.InboxAction = InboxAction(), val buttons: List<InboxMessage.InboxButton>? = null, val audienceType: String = AudienceType.DEVICE)

An Inbox message from MCE or MAM (source). Render subject, subtitle and inboxMessage; the push copy of a message that was also sent as a push notification is on notificationMessage.

Constructors

InboxMessage

constructor(id: String, subject: InboxMessage.InboxStyledText? = null, sound: String? = null, media: InboxMessage.InboxMedia? = null, startDateUtc: Date? = null, endDateUtc: Date? = null, sendDateUtc: Date? = null, custom: String? = null, customKeys: Map<String, String>? = null, subtitle: InboxMessage.InboxStyledText? = null, inboxMessage: InboxMessage.InboxStyledText? = null, notificationMessage: NotificationMessage? = null, messageType: InboxMessage.InboxMessageType, deleted: Boolean = false, source: Event.Producer = Event.Producer.MCE_MODULE, action: InboxMessage.InboxAction = InboxAction(), buttons: List<InboxMessage.InboxButton>? = null, audienceType: String = AudienceType.DEVICE)

Types

AudienceType

object AudienceType

The audienceType values the server sends today.

InboxAction

data class InboxAction

The call-to-action on an inbox message. MAM sends it directly; on the classic MCE and push paths it is derived from the message url.

InboxButton

data class InboxButton

A call-to-action button on a MAM inbox message. A button without an id is not surfaced (taps are resolved by id); a button without text is kept with an empty text; a button without an action carries a NONE action.

InboxMedia

data class InboxMedia

Media on an inbox message. url is never null: media that arrives with only altText or a mediaType keeps an empty url rather than being dropped.

InboxMessageType

enum InboxMessageType : Enum<InboxMessage.InboxMessageType>

Represents the type of an inbox message.

InboxStyledText

data class InboxStyledText

A text value on an inbox message. Read the display string from text. The owning property is nullable (absent → null); when present, text itself is guaranteed non-null.

Properties

action

@JvmField

val action: InboxMessage.InboxAction

The message call-to-action; never null. MAM sends it directly. On the classic MCE and push paths it is derived from the message url: OTHER with the url as its value, or NONE when there is no url. A deleted tombstone and a message without one carry NONE.

audienceType

@JvmField

val audienceType: String

Audience-targeting metadata; AudienceType.DEVICE when absent (the classic MCE path never sends it). Retained even on a deleted tombstone (like requestId). Passed through verbatim and case-sensitive; not limited to the AudienceType values, so keep an else branch.

buttons

@JvmField

val buttons: List<InboxMessage.InboxButton>?

MAM inbox CTA buttons; null on the classic MCE path. Round-trips via toJson.

custom

@JvmField

val custom: String?

customKeys

@JvmField

val customKeys: Map<String, String>?

deleted

var deleted: Boolean

endDateUtc

@JvmField

val endDateUtc: Date?

@JvmField

val id: String

inboxMessage

@JvmField

val inboxMessage: InboxMessage.InboxStyledText?

The inbox body. MCE: inboxMessage (Inbox 2.0). MAM: message. A push alert (Alert+Inbox or PCTI) is on notificationMessage, not here.

media

@JvmField

val media: InboxMessage.InboxMedia?

messageType

@JvmField

val messageType: InboxMessage.InboxMessageType

The type the SDK computes for this message. MCE: from the server messageType and contentType. MAM: InboxMessageType.PCTI or InboxMessageType.ADV. A message from any other source is expected to be InboxMessageType.LEGACY. Use messageType.index for the integer value.

notificationMessage

@JvmField

val notificationMessage: NotificationMessage?

The push content of a message that was also sent as a push notification: MCE PCTI and Alert+Inbox, and MAM PCTI. null for an inbox-only message, and when the send has no alert.

read

var read: Boolean

sendDateUtc

@JvmField

val sendDateUtc: Date?

sound

@JvmField

val sound: String?

source

@JvmField

val source: Event.Producer

The server the message came from: Event.Producer.MCE_MODULE or Event.Producer.MAM_MODULE.