InAppMessageDisplayDelegate

public protocol InAppMessageDisplayDelegate : AnyObject, Sendable

Message display delegate

  • Called to check if the message is ready to be displayed. This method will be called for every message that is pending display whenever a display condition changes. Use notifyDisplayConditionsChanged to notify whenever a condition changes to reevaluate the pending In-App messages.

    Declaration

    Swift

    @MainActor
func isMessageReadyToDisplay(_ message: InAppMessage, scheduleID: String) -> Bool

    Parameters

    message

    The message
    scheduleID

    The schedule ID

    Return Value

    true if the message is ready to display, false otherwise.

  • Called when a message will be displayed.

    Declaration

    Swift

    @MainActor
func messageWillDisplay(_ message: InAppMessage, scheduleID: String)

    Parameters

    message

    The message
    scheduleID

    The schedule ID

  • Called when a message finished displaying

    Declaration

    Swift

    @MainActor
func messageFinishedDisplaying(_ message: InAppMessage, scheduleID: String)

    Parameters

    message

    The message
    scheduleID

    The schedule ID