Public Properties

The Salesforce Engagement SDK offers these convenience methods for retrieving inbox messages:

Each method returns a list of InboxMessage Objects. A consuming application can access these properties within each message object.

Message Properties

Key	Type	Nullable	SDK Version Availability
`alert`	String	Yes	Version 8 and later
`custom`	String	Yes	Version 8 and later
`customKeys`	`Map<String, String>`	Yes	Version 8 and later
`deleted`	Boolean	No	Version 8 and later
`endDateUtc`	Date	Yes	Version 8 and later
`id`	String	No	Version 8 and later
`inboxMessage`	String	Yes	Version 9 and later
`inboxMessageType`	Int	Yes	Version 9 and later
`inboxSubtitle`	String	Yes	Version 9 and later
`media`	InboxMessage.Media	Yes	Version 8 and later
`notificationMessage`	NotificationMessage	Yes	Version 9 and later
`read`	Boolean	No	Version 8 and later
`sendDateUtc`	Date	Yes	Version 8 and later
`sound`	String	Yes	Version 8 and later
`startDateUtc`	Date	Yes	Version 8 and later
`subject`	String	Yes	Version 8 and later
`subtitle`	String	Yes	Version 8 and later
`title`	String	Yes	Version 8 and later
`url`	String	Yes	Version 8 and later

The inboxMessageType classifies inbox messages using integer values to represent different types. A value of 1 indicates an Inbox 1.0 message, 2 signifies an Inbox 2.0 message, and 3 represents a Push Copy to Inbox (PCTI) message. This attribute applies to Inbox 1.0, Inbox 2.0, and PCTI. Additionally, inboxSubtitle and inboxMessage are available to Inbox 2.0, while notificationMessage is specific to PCTI.

The remaining properties in the message dictionary, such as contentType and requestId, are reserved for internal use. Don’t use these properties in your app.

Sort Inbox Messages by Sent Date

To sort inbox messages in your custom inbox implementation, use the value of sendDateUtc from the Inbox Message returned by getMessages.