InAppMessaging Protocol Reference


                    
                    
                    onIsReadyToDisplay

Called when the Message is requested to be displayed. Return true if the message is ready to display, false otherwise.

Declaration

Swift

@MainActor
var onIsReadyToDisplay: (@MainActor @Sendable (_ message: InAppMessage, _ scheduleID: String) -> Bool)? { get set }


                    
                    
                    themeManager

Theme manager

Declaration

Swift

@MainActor
var themeManager: InAppAutomationThemeManager { get }


                    
                    
                    displayInterval

Display interval

Declaration

Swift

@MainActor
var displayInterval: TimeInterval { get set }


                    
                    
                    displayDelegate

Display delegate

Declaration

Swift

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


                    
                    
                    sceneDelegate

Scene delegate

Declaration

Swift

@MainActor
var sceneDelegate: (any InAppMessageSceneDelegate)? { get set }


                    
                    
                    setCustomAdapter(forType:factoryBlock:)

Sets a factory block for a custom display adapter. If the factory block returns a nil adapter, the default adapter will be used.

Declaration

Swift

@MainActor
func setCustomAdapter(
    forType: CustomDisplayAdapterType,
    factoryBlock: @escaping @Sendable (DisplayAdapterArgs) -> (any CustomDisplayAdapter)?
)

Parameters

`forType`	The type
`factoryBlock`	The factory block


                    
                    
                    notifyDisplayConditionsChanged()

Notifies In-App messages that the display conditions should be reevaluated. This should only be called when state that was used to prevent a display with InAppMessageDisplayDelegate changes.

Declaration

Swift

@MainActor
func notifyDisplayConditionsChanged()