Class Module

constructor

• new Module(): FirebaseInAppMessagingTypes.Module

  Returns FirebaseInAppMessagingTypes.Module

setAutomaticDataCollectionEnabled

• setAutomaticDataCollectionEnabled(enabled: boolean): Promise<null>

  Enable or disable automatic data collection for Firebase In-App Messaging.

  When enabled, generates a registration token on app startup if there is no valid one and generates a new token when it is deleted (which prevents deleteInstanceId() from stopping the periodic sending of data).

  This setting is persisted across app restarts and overrides the setting specified in your manifest/plist file.

  Example

  // Disable data collection
  firebase.inAppMessaging().setAutomaticDataCollectionEnabled(false);
  Copy

  Parameters

  • enabled: boolean

    Whether automatic data collection is enabled.

  Returns Promise<null>

setMessagesDisplaySuppressed

• setMessagesDisplaySuppressed(enabled: boolean): Promise<null>

  Enable or disable suppression of Firebase In App Messaging messages.

  When enabled, no in app messages will be rendered until either you disable suppression, or the app restarts. This state is not persisted between app restarts.

  Example

  // Suppress messages
  await firebase.inAppMessaging().setMessagesDisplaySuppressed(true);
  Copy

  Parameters

  • enabled: boolean

    Whether messages should be suppressed.

  Returns Promise<null>

triggerEvent

• triggerEvent(eventId: string): Promise<null>

  Trigger in-app messages programmatically

  Example

  // Suppress messages
  await firebase.inAppMessaging().triggerEvent("exampleTrigger");
  Copy

  Parameters

  • eventId: string

    The id of the event.

  Returns Promise<null>

app

isAutomaticDataCollectionEnabled

const isDataCollectionEnabled = firebase.inAppMessaging().isAutomaticDataCollectionEnabled;
Copy

isMessagesDisplaySuppressed

const isSuppressed = firebase.inAppMessaging().isMessagesDisplaySuppressed;
Copy