firebase-inappmessaging/com.google.firebase.inappmessaging/FirebaseInAppMessaging

FirebaseInAppMessaging

actual class FirebaseInAppMessaging(source)

Firebase In-App Messaging, as the Android SDK's com.google.firebase.inappmessaging.FirebaseInAppMessaging: the headless SDK that fetches the campaigns, decides when a message is due and records its impressions and clicks. A message is rendered by the display component, which is the SDK's default UI unless setMessageDisplayComponent replaces it.

  • Android: the Android SDK itself. The default UI is the display SDK, which this module depends on (see com.google.firebase.inappmessaging.display.FirebaseInAppMessagingDisplay).

  • Apple platforms: the iOS SDK's FIRInAppMessaging. The listeners are fed from its delegate, which this class sets when a listener is added (replacing a delegate set on it directly), and setMessageDisplayComponent sets its messageDisplayComponent. The iOS SDK has a default UI on iOS only: on tvOS a message is displayed only by a component set here.

  • JVM: firebase-java-sdk has no In-App Messaging, so no message is ever displayed and the members do nothing.

In-App Messaging always belongs to the default com.google.firebase.FirebaseApp: get it with getInstance or Firebase.inAppMessaging.

actual class FirebaseInAppMessaging(source)

The iOS SDK's FIRInAppMessaging. There is one instance per FIRInAppMessaging, as the listeners live here: they are fed from its delegate, which this instance sets (and keeps alive, the property being weak) when a listener is added, replacing a delegate set on ios directly.

expect class FirebaseInAppMessaging(source)

Firebase In-App Messaging, as the Android SDK's com.google.firebase.inappmessaging.FirebaseInAppMessaging: the headless SDK that fetches the campaigns, decides when a message is due and records its impressions and clicks. A message is rendered by the display component, which is the SDK's default UI unless setMessageDisplayComponent replaces it.

  • Android: the Android SDK itself. The default UI is the display SDK, which this module depends on (see com.google.firebase.inappmessaging.display.FirebaseInAppMessagingDisplay).

  • Apple platforms: the iOS SDK's FIRInAppMessaging. The listeners are fed from its delegate, which this class sets when a listener is added (replacing a delegate set on it directly), and setMessageDisplayComponent sets its messageDisplayComponent. The iOS SDK has a default UI on iOS only: on tvOS a message is displayed only by a component set here.

  • JVM: firebase-java-sdk has no In-App Messaging, so no message is ever displayed and the members do nothing.

In-App Messaging always belongs to the default com.google.firebase.FirebaseApp: get it with getInstance or Firebase.inAppMessaging.

actual class FirebaseInAppMessaging(source)

firebase-java-sdk has no In-App Messaging: no message is ever fetched or displayed on the JVM, so the listeners and the display component are never called, and the settings are only kept in memory.

Types

Link copied to clipboard
actual object Companion
actual object Companion
expect object Companion
actual object Companion

Properties

Link copied to clipboard
val ios: FIRInAppMessaging

The underlying Firebase iOS SDK object.

Link copied to clipboard
actual var isAutomaticDataCollectionEnabled: Boolean

Whether automatic data collection is enabled: the SDK fetches messages and reports their impressions and clicks only when it is. Setting it persists across app restarts and overrides the manifest (Info.plist on Apple platforms) and the Firebase-wide setting.

actual var isAutomaticDataCollectionEnabled: Boolean

Whether automatic data collection is enabled: the SDK fetches messages and reports their impressions and clicks only when it is. Setting it persists across app restarts and overrides the manifest (Info.plist on Apple platforms) and the Firebase-wide setting.

expect var isAutomaticDataCollectionEnabled: Boolean

Whether automatic data collection is enabled: the SDK fetches messages and reports their impressions and clicks only when it is. Setting it persists across app restarts and overrides the manifest (Info.plist on Apple platforms) and the Firebase-wide setting.

@Volatile
actual var isAutomaticDataCollectionEnabled: Boolean

Kept in memory: nothing is collected on the JVM.

Functions

Link copied to clipboard
actual fun addClickListener(clickListener: FirebaseInAppMessagingClickListener)

Registers clickListener, which is notified when the user clicks an action of a message. Registering the same listener again has no effect. On Android the listener runs on a background thread; on Apple platforms on the thread the iOS SDK reports the click on, the main thread for its default UI.

actual fun addClickListener(clickListener: FirebaseInAppMessagingClickListener)

Registers clickListener, which is notified when the user clicks an action of a message. Registering the same listener again has no effect. On Android the listener runs on a background thread; on Apple platforms on the thread the iOS SDK reports the click on, the main thread for its default UI.

expect fun addClickListener(clickListener: FirebaseInAppMessagingClickListener)

Registers clickListener, which is notified when the user clicks an action of a message. Registering the same listener again has no effect. On Android the listener runs on a background thread; on Apple platforms on the thread the iOS SDK reports the click on, the main thread for its default UI.

actual fun addClickListener(clickListener: FirebaseInAppMessagingClickListener)

Does nothing: no message is displayed on the JVM.

Link copied to clipboard
actual fun addDismissListener(dismissListener: FirebaseInAppMessagingDismissListener)

Registers dismissListener, which is notified when a message is dismissed; see addClickListener.

actual fun addDismissListener(dismissListener: FirebaseInAppMessagingDismissListener)

Registers dismissListener, which is notified when a message is dismissed; see addClickListener.

expect fun addDismissListener(dismissListener: FirebaseInAppMessagingDismissListener)

Registers dismissListener, which is notified when a message is dismissed; see addClickListener.

actual fun addDismissListener(dismissListener: FirebaseInAppMessagingDismissListener)

Does nothing: no message is displayed on the JVM.

Link copied to clipboard
actual fun addDisplayErrorListener(displayErrorListener: FirebaseInAppMessagingDisplayErrorListener)

Registers displayErrorListener, which is notified when a message cannot be displayed; see addClickListener. On Apple platforms the iOS SDK's NSError is mapped onto the closest FirebaseInAppMessagingDisplayCallbacks.InAppMessagingErrorReason: a failed image download is IMAGE_FETCH_ERROR, invalid image data IMAGE_DISPLAY_ERROR, and anything else UNSPECIFIED_RENDER_ERROR; the reason a display component set with setMessageDisplayComponent reports is kept as it is.

actual fun addDisplayErrorListener(displayErrorListener: FirebaseInAppMessagingDisplayErrorListener)

Registers displayErrorListener, which is notified when a message cannot be displayed; see addClickListener. On Apple platforms the iOS SDK's NSError is mapped onto the closest FirebaseInAppMessagingDisplayCallbacks.InAppMessagingErrorReason: a failed image download is IMAGE_FETCH_ERROR, invalid image data IMAGE_DISPLAY_ERROR, and anything else UNSPECIFIED_RENDER_ERROR; the reason a display component set with setMessageDisplayComponent reports is kept as it is.

expect fun addDisplayErrorListener(displayErrorListener: FirebaseInAppMessagingDisplayErrorListener)

Registers displayErrorListener, which is notified when a message cannot be displayed; see addClickListener. On Apple platforms the iOS SDK's NSError is mapped onto the closest FirebaseInAppMessagingDisplayCallbacks.InAppMessagingErrorReason: a failed image download is IMAGE_FETCH_ERROR, invalid image data IMAGE_DISPLAY_ERROR, and anything else UNSPECIFIED_RENDER_ERROR; the reason a display component set with setMessageDisplayComponent reports is kept as it is.

actual fun addDisplayErrorListener(displayErrorListener: FirebaseInAppMessagingDisplayErrorListener)

Does nothing: no message is displayed on the JVM.

Link copied to clipboard
actual fun addImpressionListener(impressionListener: FirebaseInAppMessagingImpressionListener)

Registers impressionListener, which is notified when a message has been displayed long enough to count as an impression; see addClickListener.

actual fun addImpressionListener(impressionListener: FirebaseInAppMessagingImpressionListener)

Registers impressionListener, which is notified when a message has been displayed long enough to count as an impression; see addClickListener.

expect fun addImpressionListener(impressionListener: FirebaseInAppMessagingImpressionListener)

Registers impressionListener, which is notified when a message has been displayed long enough to count as an impression; see addClickListener.

actual fun addImpressionListener(impressionListener: FirebaseInAppMessagingImpressionListener)

Does nothing: no message is displayed on the JVM.

Link copied to clipboard
actual fun areMessagesSuppressed(): Boolean

Whether the display of messages is suppressed, see setMessagesSuppressed. On Android only the display SDK honours it, so a custom display component should check it; the iOS SDK displays no message while it is set.

actual fun areMessagesSuppressed(): Boolean

Whether the display of messages is suppressed, see setMessagesSuppressed. On Android only the display SDK honours it, so a custom display component should check it; the iOS SDK displays no message while it is set.

expect fun areMessagesSuppressed(): Boolean

Whether the display of messages is suppressed, see setMessagesSuppressed. On Android only the display SDK honours it, so a custom display component should check it; the iOS SDK displays no message while it is set.

actual fun areMessagesSuppressed(): Boolean

Whether the display of messages is suppressed, see setMessagesSuppressed. On Android only the display SDK honours it, so a custom display component should check it; the iOS SDK displays no message while it is set.

Link copied to clipboard
actual fun clearDisplayListener()

Removes the display component, so that no message is displayed; the Android SDK's hidden clearDisplayListener(). On Android the display SDK binds its component again when an activity resumes. On Apple platforms this also removes the iOS SDK's default UI, which com.google.firebase.inappmessaging.display.FirebaseInAppMessagingDisplay.getInstance brings back.

actual fun clearDisplayListener()

Removes the display component, so that no message is displayed; the Android SDK's hidden clearDisplayListener(). On Android the display SDK binds its component again when an activity resumes. On Apple platforms this also removes the iOS SDK's default UI, which com.google.firebase.inappmessaging.display.FirebaseInAppMessagingDisplay.getInstance brings back.

expect fun clearDisplayListener()

Removes the display component, so that no message is displayed; the Android SDK's hidden clearDisplayListener(). On Android the display SDK binds its component again when an activity resumes. On Apple platforms this also removes the iOS SDK's default UI, which com.google.firebase.inappmessaging.display.FirebaseInAppMessagingDisplay.getInstance brings back.

actual fun clearDisplayListener()

Removes the display component, so that no message is displayed; the Android SDK's hidden clearDisplayListener(). On Android the display SDK binds its component again when an activity resumes. On Apple platforms this also removes the iOS SDK's default UI, which com.google.firebase.inappmessaging.display.FirebaseInAppMessagingDisplay.getInstance brings back.

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
actual fun removeClickListener(clickListener: FirebaseInAppMessagingClickListener)

Unregisters a listener registered with addClickListener.

actual fun removeClickListener(clickListener: FirebaseInAppMessagingClickListener)

Unregisters a listener registered with addClickListener.

expect fun removeClickListener(clickListener: FirebaseInAppMessagingClickListener)

Unregisters a listener registered with addClickListener.

actual fun removeClickListener(clickListener: FirebaseInAppMessagingClickListener)

Unregisters a listener registered with addClickListener.

Link copied to clipboard
actual fun removeDismissListener(dismissListener: FirebaseInAppMessagingDismissListener)

Unregisters a listener registered with addDismissListener.

actual fun removeDismissListener(dismissListener: FirebaseInAppMessagingDismissListener)

Unregisters a listener registered with addDismissListener.

expect fun removeDismissListener(dismissListener: FirebaseInAppMessagingDismissListener)

Unregisters a listener registered with addDismissListener.

actual fun removeDismissListener(dismissListener: FirebaseInAppMessagingDismissListener)

Unregisters a listener registered with addDismissListener.

Link copied to clipboard
actual fun removeDisplayErrorListener(displayErrorListener: FirebaseInAppMessagingDisplayErrorListener)

Unregisters a listener registered with addDisplayErrorListener.

actual fun removeDisplayErrorListener(displayErrorListener: FirebaseInAppMessagingDisplayErrorListener)

Unregisters a listener registered with addDisplayErrorListener.

expect fun removeDisplayErrorListener(displayErrorListener: FirebaseInAppMessagingDisplayErrorListener)

Unregisters a listener registered with addDisplayErrorListener.

actual fun removeDisplayErrorListener(displayErrorListener: FirebaseInAppMessagingDisplayErrorListener)

Unregisters a listener registered with addDisplayErrorListener.

Link copied to clipboard
actual fun removeImpressionListener(impressionListener: FirebaseInAppMessagingImpressionListener)

Unregisters a listener registered with addImpressionListener.

actual fun removeImpressionListener(impressionListener: FirebaseInAppMessagingImpressionListener)

Unregisters a listener registered with addImpressionListener.

expect fun removeImpressionListener(impressionListener: FirebaseInAppMessagingImpressionListener)

Unregisters a listener registered with addImpressionListener.

actual fun removeImpressionListener(impressionListener: FirebaseInAppMessagingImpressionListener)

Unregisters a listener registered with addImpressionListener.

Link copied to clipboard
actual fun setAutomaticDataCollectionEnabled(isAutomaticCollectionEnabled: Boolean?)

Like setting isAutomaticDataCollectionEnabled, where null clears the override on Android, so that the manifest and then the Firebase-wide setting apply again. The iOS SDK has no override to clear: on Apple platforms null leaves the setting unchanged.

actual fun setAutomaticDataCollectionEnabled(isAutomaticCollectionEnabled: Boolean?)

null leaves the setting unchanged: the iOS SDK has no override to clear.

expect fun setAutomaticDataCollectionEnabled(isAutomaticCollectionEnabled: Boolean?)

Like setting isAutomaticDataCollectionEnabled, where null clears the override on Android, so that the manifest and then the Firebase-wide setting apply again. The iOS SDK has no override to clear: on Apple platforms null leaves the setting unchanged.

actual fun setAutomaticDataCollectionEnabled(isAutomaticCollectionEnabled: Boolean?)

Kept in memory; null restores the default, true.

Link copied to clipboard
actual fun setMessageDisplayComponent(messageDisplay: FirebaseInAppMessagingDisplay)

Makes messageDisplay render the messages, in place of the default UI. It must report what happens to the message through the FirebaseInAppMessagingDisplayCallbacks it is given, so that the SDK records the impression and click and moves on to the next message.

actual fun setMessageDisplayComponent(messageDisplay: FirebaseInAppMessagingDisplay)

Sets the iOS SDK's messageDisplayComponent: the iOS SDK's own default UI for com.google.firebase.inappmessaging.display.FirebaseInAppMessagingDisplay (none on tvOS, which then displays nothing), or else a component that converts each message and calls messageDisplay on the main thread.

expect fun setMessageDisplayComponent(messageDisplay: FirebaseInAppMessagingDisplay)

Makes messageDisplay render the messages, in place of the default UI. It must report what happens to the message through the FirebaseInAppMessagingDisplayCallbacks it is given, so that the SDK records the impression and click and moves on to the next message.

actual fun setMessageDisplayComponent(messageDisplay: FirebaseInAppMessagingDisplay)

Does nothing: no message is displayed on the JVM.

Link copied to clipboard
actual fun setMessagesSuppressed(areMessagesSuppressed: Boolean?)

Suppresses (or resumes) the display of messages, until the app restarts. The parameter is a boxed Boolean, as in the Android SDK; null is not allowed and throws a NullPointerException.

actual fun setMessagesSuppressed(areMessagesSuppressed: Boolean?)

Suppresses (or resumes) the display of messages, until the app restarts. The parameter is a boxed Boolean, as in the Android SDK; null is not allowed and throws a NullPointerException.

expect fun setMessagesSuppressed(areMessagesSuppressed: Boolean?)

Suppresses (or resumes) the display of messages, until the app restarts. The parameter is a boxed Boolean, as in the Android SDK; null is not allowed and throws a NullPointerException.

actual fun setMessagesSuppressed(areMessagesSuppressed: Boolean?)

Suppresses (or resumes) the display of messages, until the app restarts. The parameter is a boxed Boolean, as in the Android SDK; null is not allowed and throws a NullPointerException.

Link copied to clipboard
open override fun toString(): String
open override fun toString(): String
Link copied to clipboard
actual fun triggerEvent(eventName: String)

Triggers the campaigns whose trigger is the analytics event eventName, as if the event had been logged, and displays the first one that is due.

actual fun triggerEvent(eventName: String)

Triggers the campaigns whose trigger is the analytics event eventName, as if the event had been logged, and displays the first one that is due.

expect fun triggerEvent(eventName: String)

Triggers the campaigns whose trigger is the analytics event eventName, as if the event had been logged, and displays the first one that is due.

actual fun triggerEvent(eventName: String)

Does nothing: there are no campaigns on the JVM.

Generated by Dokka
firebase-multiplatform, Apache License 2.0. Based on GitLive's firebase-kotlin-sdk.