@causalfoundry/react-native-cf-chw-mgmt/README.md

causalfoundry.ai SDK for tracking logs for Community Healthcare Worker's usage of the app.

# Causal Foundry React Native (Android) SDK Setup - CHW MGMT

For detailed documentation please visit: [docs.causalfoundry.ai/chw-mgmt](https://docs.causalfoundry.ai/chw-mgmt/)

# Guidelines

- Including lifecycle components is required 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.

Please feel free to drop in a few lines at `hello@causalfoundry.ai` in case you have any further queries. We're always
just an email away!