Marketing Cloud SDK / com.salesforce.marketingcloud.messages.inbox / InboxMessageManager

InboxMessageManager

interface InboxMessageManager

Types

InboxRefreshListener

interface InboxRefreshListener

InboxResponseListener

interface InboxResponseListener

Properties

TAG

static val TAG: String!

Functions

deleteMessage

Marks a InboxMessage as deleted in local storage. This will prevent the message from being shown in the future unless local storage is cleared on the device.

abstract fun deleteMessage(message: InboxMessage): Unit
abstract fun deleteMessage(messageId: String): Unit

getDeletedMessageCount

Get the number deleted Inbox Messages regardless of their read status.

abstract fun getDeletedMessageCount(): Int

getDeletedMessages

Gets a List of Active, Deleted Inboc Messages for use with your own adapter.

abstract fun getDeletedMessages(): MutableList<InboxMessage!>

getMessageCount

abstract fun getMessageCount(): Int

getMessages

Gets a List of Active, Read & Unread, not Deleted Inbox Messages for use with your own adapter.

abstract fun getMessages(): MutableList<InboxMessage!>

getReadMessageCount

Get the number of read, not deleted Inbox Messages

abstract fun getReadMessageCount(): Int

getReadMessages

Gets a List of Active, Read, not Deleted Inbox Messages for use with your own adapter.

abstract fun getReadMessages(): MutableList<InboxMessage!>

getUnreadMessageCount

Get the number of unread, not deleted Inbox Messages

abstract fun getUnreadMessageCount(): Int

getUnreadMessages

Gets a List of Active, Unread, not Deleted Inbox Messages for use with your own adapter.

abstract fun getUnreadMessages(): MutableList<InboxMessage!>

markAllMessagesDeleted

Marks all active InboxMessages as deleted.

abstract fun markAllMessagesDeleted(): Unit

markAllMessagesRead

Marks all active, unread InboxMessages as read.

abstract fun markAllMessagesRead(): Unit

refreshInbox

Requests an updated list of Inbox Messages from the Marketing Cloud Servers. The Inbox request can be made, at most, once per minute. This throttle also includes the Inbox request that is made by the SDK when your application is brought into the foreground.

abstract fun refreshInbox(listener: InboxRefreshListener?): Unit

registerInboxResponseListener

Call this method to be notified of Inbox events within the Marketing Cloud SDK.

abstract fun registerInboxResponseListener(listener: InboxResponseListener): Unit

setMessageRead

Marks a InboxMessage as read in local storage. This status will persist unless local storage is cleared on the device.

abstract fun setMessageRead(message: InboxMessage): Unit
abstract fun setMessageRead(messageId: String): Unit

unregisterInboxResponseListener

Unregister your InboxMessageManager.InboxResponseListener listener.

abstract fun unregisterInboxResponseListener(listener: InboxResponseListener): Unit