InboxMessageManager

Package: com.salesforce.marketingcloud.messages.inbox
SDK Version: 11.0.0

The InboxMessageManager interface provides functionality for managing inbox messages in the Salesforce Marketing Cloud SDK.

1interface InboxRefreshListener

Listener interface for inbox refresh operations.

1interface InboxResponseListener

Listener interface for inbox response events.

1abstract fun deleteMessage(message: InboxMessage)
2abstract fun deleteMessage(messageId: String)

Marks an InboxMessage as deleted in local storage.

Parameters:

• message - The InboxMessage to delete
• messageId - The ID of the message to delete

1abstract fun disableInbox()

This method provides the capability to disable the InboxMessage feature on the current device using the SDK.

1abstract fun enableInbox()

Enables the InboxMessage feature on the current device.

1abstract fun getDeletedMessageCount(): Int

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

Returns: Count of deleted messages

1abstract fun getDeletedMessages(): List<InboxMessage>

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

Returns: List of deleted InboxMessage objects

1abstract fun getMessageCount(): Int

Gets the total message count.

Returns: Total message count

1abstract fun getMessages(): List<InboxMessage>

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

Returns: List of active InboxMessage objects

1abstract fun getReadMessageCount(): Int

Get the number of read, not deleted Inbox Messages.

Returns: Count of read messages

1abstract fun getReadMessages(): List<InboxMessage>

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

Returns: List of read InboxMessage objects

1abstract fun getUnreadMessageCount(): Int

Get the number of unread, not deleted Inbox Messages.

Returns: Count of unread messages

1abstract fun getUnreadMessages(): List<InboxMessage>

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

Returns: List of unread InboxMessage objects

1abstract fun isInboxEnabled(): Boolean

Checks if the inbox feature is enabled.

Returns: Boolean indicating if inbox is enabled

1abstract fun markAllMessagesDeleted()

Marks all active InboxMessages as deleted.

1abstract fun markAllMessagesRead()

Marks all active, unread InboxMessages as read.

1abstract fun refreshInbox(listener: InboxRefreshListener?)

Requests an updated list of Inbox Messages from the Marketing Cloud Servers.

Parameters:

• listener - Optional listener for refresh completion

1abstract fun registerInboxResponseListener(listener: InboxResponseListener)

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

Parameters:

• listener - The InboxResponseListener to register

1abstract fun setMessageRead(message: InboxMessage)
2abstract fun setMessageRead(messageId: String)

Marks an InboxMessage as read in local storage.

Parameters:

• message - The InboxMessage to mark as read
• messageId - The ID of the message to mark as read

1abstract fun unregisterInboxResponseListener(listener: InboxResponseListener)

Unregister your InboxResponseListener listener.

Parameters:

• listener - The InboxResponseListener to unregister