Inbox Message Details

  • Public protocol representing an inbox message from the Marketing Cloud. Consumers receive instances of this protocol via InboxFeature methods. Every property is read-only: an inbox message is an immutable snapshot of what the SDK received. Optional properties are nil when the backend did not supply a value.

    See more

    Declaration

    Swift

    @objc(SFMCSdkInboxMessage)
public protocol InboxMessage

  • The kind of inbox message, surfaced via InboxMessage/inboxMessageType.

    See more

    Declaration

    Swift

    @objc(SFMCSdkInboxMessageType)
public enum InboxMessageType : Int

  • Known audienceType values the server sends today.

    audienceType is a raw string, passed through verbatim. It is not limited to these constants — keep an else for unknown values. Missing or empty defaults to device.

    See more

    Declaration

    Swift

    @objc(SFMCSdkInboxAudienceType)
public final class InboxAudienceType : NSObject

  • Action metadata associated with an inbox button.

    See more

    Declaration

    Swift

    @objc(SFMCSdkInboxAction)
public protocol InboxAction

  • Known type values the server sends today.

    type is a raw string, passed through verbatim. It is not limited to these constants — keep an else for unknown values. Missing type is none.

    See more

    Declaration

    Swift

    @objc(SFMCSdkInboxActionType)
public final class InboxActionType : NSObject

  • Display text for an inbox subject, subtitle, or body.

    See more

    Declaration

    Swift

    @objc(SFMCSdkInboxText)
public protocol InboxText

  • Immutable button metadata delivered with an inbox message.

    See more

    Declaration

    Swift

    @objc(SFMCSdkInboxButton)
public protocol InboxButton
  • See more

    Declaration

    Swift

    @objc(SFMCSdkInboxMedia)
public protocol InboxMedia

  • Known type values the server sends today.

    type is a raw string, passed through verbatim. It is not limited to these constants — keep an else for unknown values. Missing or empty authored value is nil.

    See more

    Declaration

    Swift

    @objc(SFMCSdkInboxMediaType)
public final class InboxMediaType : NSObject

  • One user tap on an inbox message, passed to InboxFeatureApi.trackMessageInteractionEvent(_:interaction:).

    See more

    Declaration

    Swift

    @objc(SFMCSdkInboxMessageInteraction)
public final class InboxMessageInteraction : NSObject

  • Classifies the engagement object the user tapped on an inbox message.

    Distinct from InboxActionType, which describes what a tap does (WEB_URL, APP_URL, and so on). This type only says which object was tapped.

    • .cta: the message-level call to action. Pass id: nil.
    • .button: a button on the message. id must be that button’s InboxButton.id.
    See more

    Declaration

    Swift

    @objc(SFMCSdkInboxInteractionType)
public enum InboxInteractionType : Int, CaseIterable
    extension InboxInteractionType: CustomStringConvertible