Packages and Configuration Options
UpdatedSDK packages
The SDK consists of a few packages. You must use the CioConfig
and CustomerIO
packages to configure and initialize the SDK.
Package Product | Required? | Description |
---|---|---|
CustomerIO | ✅ | The main SDK package. Used to initialize the SDK and call the SDK’s methods. |
CioConfig | ✅ | Configure the SDK including in-app messaging support. |
CioRegion | Used inside the CioConfig.region option to declare your region—EU or US. | |
CioLogLevel | Used inside the CioConfig.logLevel option to set the level of logs you can view from the SDK. |
Configuration options
You can determine global behaviors for the SDK in using CioConfig
package. You must provide configuration options before you initialize the SDK; you cannot declare configuration changes after you initialize the SDK.
Import CioConfig
and then set configuration options to configure things like your logging level and whether or not you want to automatically track device attributes, etc. Note that the logLevel
option requires the CioLogLevel
package and the region
option requires the CioRegion
package.
import {
CioLogLevel, CioRegion, CustomerIO, CioConfig
} from 'customerio-reactnative';
const App = () => {
useEffect(() => {
const config: CioConfig = {
cdpApiKey: 'CDP API Key', // Mandatory
migrationSiteId: 'siteId', // Required if migrating from an earlier version
region: CioRegion.US,
logLevel: CioLogLevel.Debug,
trackApplicationLifecycleEvents: true,
inApp: {
siteId: 'site_id',
},
push: {
android: {
pushClickBehavior: PushClickBehaviorAndroid.ResetTaskStack
}
}
};
CustomerIO.initialize(config)
}, [])
}
Option | Type | Default | Description |
---|---|---|---|
cdpApiKey | string | Required: the key you'll use to initialize the SDK and send data to Customer.io | |
migrationSiteId | string | Required if you're updating from 3.x: the credential for previous versions of the SDK. This key lets the SDK send remaining tasks to Customer.io when your audience updates your app. | |
region | CioRegion.EU or CioRegion.US | CioRegion.US | Requires the CioRegion package. You must set the region your account is in the EU (CioRegion.EU ). |
autoTrackDeviceAttributes | boolean | true | Automatically gathers information about devices, like operating system, device locale, model, app version, etc |
trackApplicationLifecycleEvents | boolean | true | Set to false if you don't want the app to send lifecycle events |
logLevel | string | error | Requires the CioLogLevel package. Sets the level of logs you can view from the SDK. Set to debug or info to see more logging output. |
inApp | object | Required for in-app support. This object takes a siteId property, determining the workspace your in-app messages come from. | |
push | object | Takes a single option called PushClickBehaviorAndroid . This object and option controls how your app behaves when your Android audience taps push notifications. |