firebase-inappmessaging/com.google.firebase.inappmessaging/FirebaseInAppMessagingDisplayCallbacks

FirebaseInAppMessagingDisplayCallbacks

interface FirebaseInAppMessagingDisplayCallbacks(source)

Reports what happens to a message to the SDK, mirroring FirebaseInAppMessagingDisplayCallbacks: a display component receives one with each message. Each call records the event and notifies the matching listeners of FirebaseInAppMessaging; the task completes once it is recorded. On Apple platforms each call is passed to the iOS SDK's display delegate on the main thread, where the iOS SDK expects it, and the task completes after that.

Types

InAppMessagingDismissType

enum InAppMessagingDismissType : Enum<FirebaseInAppMessagingDisplayCallbacks.InAppMessagingDismissType>

How a message was dismissed.

InAppMessagingErrorReason

enum InAppMessagingErrorReason : Enum<FirebaseInAppMessagingDisplayCallbacks.InAppMessagingErrorReason>

Why a message could not be displayed.

Functions

displayErrorEncountered

abstract fun displayErrorEncountered(inAppMessagingErrorReason: FirebaseInAppMessagingDisplayCallbacks.InAppMessagingErrorReason): Task<Nothing?>

The message could not be displayed, for inAppMessagingErrorReason.

impressionDetected

abstract fun impressionDetected(): Task<Nothing?>

The message has been displayed long enough to count as an impression.

abstract fun messageClicked(action: Action): Task<Nothing?>

The user clicked action of the message; this also counts as an impression. On Apple platforms the iOS SDK then opens the action's URL, if it has one.

messageDismissed

abstract fun messageDismissed(dismissType: FirebaseInAppMessagingDisplayCallbacks.InAppMessagingDismissType): Task<Nothing?>

The message was dismissed in the way given by dismissType; this also counts as an impression.