MessageCenter

@MainActor
public protocol MessageCenter : AnyObject, Sendable

Airship Message Center Protocol.

  • Called when the Message Center is requested to be displayed. Return true if the display was handled, false to fall back to default SDK behavior.

    Declaration

    Swift

    @MainActor
var onDisplay: (@MainActor @Sendable (_ messageID: String?) -> Bool)? { get set }

  • Called when the Message Center is requested to be dismissed.

    Declaration

    Swift

    @MainActor
var onDismissDisplay: (@MainActor @Sendable () -> Void)? { get set }

  • Message center display delegate.

    Declaration

    Swift

    @MainActor
var displayDelegate: (any MessageCenterDisplayDelegate)? { get set }

  • Message center inbox.

    Declaration

    Swift

    @MainActor
var inbox: any MessageCenterInbox { get }

  • The message center controller.

    Declaration

    Swift

    @MainActor
var controller: MessageCenterController { get set }

  • Default message center theme.

    Declaration

    Swift

    @MainActor
var theme: MessageCenterTheme? { get set }

  • Default message center predicate. Only applies to the OOTB Message Center. If you are embedding the MessageCenterView directly you should pass the predicate in through the view extension .messageCenterPredicate(_:).

    Declaration

    Swift

    @MainActor
var predicate: (any MessageCenterPredicate)? { get set }

  • Loads a Message center theme from a plist file. If you are embedding the MessageCenterView directly you should pass the theme in through the view extension .messageCenterTheme(_:).

    Declaration

    Swift

    @MainActor
func setThemeFromPlist(_ plist: String) throws

    Parameters

    plist

    The name of the plist in the bundle.

  • Display the message center.

    Declaration

    Swift

    @MainActor
func display()

  • Display the given message with animation.

    Declaration

    Swift

    @MainActor
func display(messageID: String)

    Parameters

    messageID

    The messageID of the message.

  • Dismiss the message center.

    Declaration

    Swift

    @MainActor
func dismiss()