Public Properties

The SDK offers these convenience methods for retrieving inbox messages:

Message Properties

Each method returns an array of dictionaries. Each dictionary within the array represents a message. This table lists the properties returned in these dictionaries.

Key	Data Type	Notes
`alert`	String?	Available in SDK v8 and later.
`contentType`	String?	For internal SDK use. Don’t use in consuming applications.
`custom`	String?	Available in SDK v8 and later.
`deleted`	Boolean	Available in SDK v8 and later.
`endDateUtc`	Date?	Available in SDK v8 and later.
`id`	String?	Available in SDK v8 and later.
`inboxMessage`	String?	Available in SDK v9 and later.
`inboxMessageType`	Int?	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 PCTI message. Available in SDK v9 and later.
`inboxSubtitle`	String?	Only present when `inboxMessageType` is 2. Available in SDK v9 and later.
`messageDeleted`	String?	For internal SDK use. Don’t use in consuming applications.
`messageHash`	String?	For internal SDK use. Don’t use in consuming applications.
`name`	String?	Available in SDK v8 and later.
`notificationMessage`	[String: Any]?	The message content for a PCTI message. Only present when `inboxMessageType` is 3. Available in SDK v9 and later.
`read`	Boolean	Available in SDK v8 and later.
`requestId`	String?	For internal SDK use. Don’t use in consuming applications.
`sound`	String?	Available in SDK v8 and later.
`startDateUtc`	Date?	Available in SDK v8 and later.
`statusDirty`	String?	For internal SDK use. Don’t use in consuming applications.
`subject`	String?	Available in SDK v8 and later.
`subtitle`	String?	Available in SDK v8 and later.
`title`	String?	Available in SDK v8 and later.
`url`	String?	Available in SDK v8 and later.

Sort Inbox Messages by Sent Date

To sort inbox messages in your inbox implementation, use the value of sendDateUtc from the inbox message returned by getAllMessages and other getters.