react-native-firebase

react-native-firebase / in-app-messaging/lib/modular

in-app-messaging/lib/modular

Type Aliases

FirebaseInAppMessaging

FirebaseInAppMessaging = FirebaseInAppMessagingTypes.Module

Defined in: in-app-messaging/lib/modular/index.d.ts:3

Functions

getInAppMessaging()

getInAppMessaging(): Module

Defined in: in-app-messaging/lib/modular/index.d.ts:5

Returns

Module

isAutomaticDataCollectionEnabled()

isAutomaticDataCollectionEnabled(inAppMessaging): boolean

Defined in: in-app-messaging/lib/modular/index.d.ts:50

Determines whether automatic data collection is enabled or not.

Example

const inAppMessaging = getInAppMessaging();
const isDataCollectionEnabled = isAutomaticDataCollectionEnabled(inAppMessaging);

Parameters

inAppMessaging

Module

Returns

boolean

isMessagesDisplaySuppressed()

isMessagesDisplaySuppressed(inAppMessaging): boolean

Defined in: in-app-messaging/lib/modular/index.d.ts:17

Determines whether messages are suppressed or not.

Example

const inAppMessaging = getInAppMessaging();
const isSuppressed = isMessagesDisplaySuppressed(inAppMessaging);

Parameters

inAppMessaging

Module

Returns

boolean

setAutomaticDataCollectionEnabled()

setAutomaticDataCollectionEnabled(inAppMessaging, enabled): Promise<null>

Defined in: in-app-messaging/lib/modular/index.d.ts:70

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
const inAppMessaging = getInAppMessaging();
setAutomaticDataCollectionEnabled(inAppMessaging, false);

Parameters

inAppMessaging

Module

enabled

boolean

Returns

Promise<null>

setMessagesDisplaySuppressed()

setMessagesDisplaySuppressed(inAppMessaging, enabled): Promise<null>

Defined in: in-app-messaging/lib/modular/index.d.ts:35

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
const inAppMessaging = getInAppMessaging();
await setMessagesDisplaySuppressed(inAppMessaging, true);

Parameters

inAppMessaging

Module

enabled

boolean

Returns

Promise<null>

triggerEvent()

triggerEvent(inAppMessaging, eventId): Promise<null>

Defined in: in-app-messaging/lib/modular/index.d.ts:86

Trigger in-app messages programmatically

Example

// Suppress messages
const inAppMessaging = getInAppMessaging();
await triggerEvent(inAppMessaging, "exampleTrigger");

Parameters

inAppMessaging

Module

eventId

string

Returns

Promise<null>