@causalfoundry/react-native-cf-core NPM

Causal Foundry React Native (Android) SDK Setup

For detailed documentation please visit: docs.causalfoundry.ai

Guidelines

Including lifecycle components is required in order to use the SDK as SDK requires lifecycle components to listen for app events regarding app sessions and app moving to the background.
Anything you include in the meta will be sent to the backend and be visible in the log monitoring section, but it will not be processed.
Custom Event Attributes can be of these data types: String, Number, Boolean, Date, List, Map.
Make sure to include your SDK key in the manifest of your Android App so that SDK can have that while initialization or else it would through an IllegalAccessException.
Make sure to initialize the SDK in the Application class or else if you trigger SDK events without that it will through RuntimeException.
updateImmediately is an optional param, by default its value is true. You can decide for each event if it needs to be updated immediately, or it can wait until the end of the app session.
Please ensure consistent usage of the names of Custom Events in meta and their Custom Attributes across all your apps (Android, iOS) and website.
Please use the same name conventions as provided by the enums if you choose to pass strings as values or else the event will be discarded and an IllegalArgumentException will be thrown.
Nudges may not be delivered to apps which were put into background restriction by the user (such as via: Setting -> Apps and Notification -> app-name -> Battery). Once your app is removed from background restriction, new messages to the app will be delivered as before. In order to prevent lost messages and other background restriction impacts, make sure to avoid bad behaviors listed by the Android vitals effort. These behaviors could lead to the Android device recommending to the user that your app be background restricted. Your app can check if it is background restricted using: isBackgroundRestricted().
In cases where the user restricted the app to show push notifications for the whole app or blocked the Causal Foundry notification channel, the SDK will log blockevent for that nudge.