Inbox Feature Module v1.0.0/com.salesforce.marketingcloud.inboxfeature/InboxFeature

InboxFeature

class InboxFeature : ModuleInterface

Public entry point for the Inbox feature within the Salesforce Marketing Cloud SDK. Implements ModuleInterface so the unified SDK can report state and dispatch scheduled jobs to Inbox.

Owns Inbox storage, the public InboxMessageManager, the runtime enable/disable toggle and GDPR handling. Mirrors the shape of the other feature modules, InAppMessagingFeature and MobileAppMessaging.

Types

Companion

object Companion

Properties

state

open override val state: JSONObject

Returns the current state of the InboxFeature module as a JSONObject.

Functions

disableInbox

fun disableInbox()

Disables Inbox at runtime and persists the choice across restarts. Fetched messages are no longer stored; a later GDPR block still wipes the stored messages.

enableInbox

fun enableInbox()

Enables Inbox at runtime and persists the choice across restarts. Refused (logged, no state change) while GDPR-blocked. When Inbox goes from disabled to enabled, fetching resumes.

getConfig

fun getConfig(): InboxFeatureConfig

Returns the InboxFeatureConfig used to initialize this instance.

getInboxMessageManager

fun getInboxMessageManager(): InboxMessageManager

Returns the InboxMessageManager, the public read / mutate / refresh surface for Inbox.

getInitializationStatus

fun getInitializationStatus(): InboxFeatureInitializationStatus?

Returns the last known InboxFeatureInitializationStatus, or null if the module is torn down.

isInboxEnabled

fun isInboxEnabled(): Boolean

Returns true if Inbox is currently active. Precedence is GDPR block > runtime toggle > config default; a GDPR block returns false even if Inbox was enabled at runtime.

isTornDown

fun isTornDown(): Boolean

True if the module has been torn down and must be re-initialized before use.