Options
View as MarkdownWhen initializing the Android SDK, you have the flexibility to provide various initialization options.
Options
Below are the options that control various aspects of the Android SDK.
| Option | Type | Default | Description |
|---|---|---|---|
| application | Any? |
null |
The application specific object (in the case of Android: ApplicationContext). |
| endpoint | String |
test.example.com/v1 |
The base endpoint used to construct the event sending and settings retrieval endpoints. |
| autoAddKrenalisDestination | Boolean |
true |
This automatically adds the Krenalis Destination plugin. The SDK supports also the autoAddSegmentDestination option from the Segment SDK, which can be used as an alternative with the same effect. |
| collectDeviceId | Boolean |
false |
Set to true to automatically collect the device Id. |
| defaultSettings | Settings |
Settings( strategy="Isolation", integrations={}, plan={}, edgeFunction={}, middlewareSettings={}, metrics={}, consentSettings={}) |
The settings object used as fallback in case of network failure. |
| flushAt | Int |
20 |
The count of events at which Krenalis flushes events. |
| flushInterval | Int |
30 |
The interval in seconds at which Krenalis flushes events. |
| flushPolicies | List<FlushPolicy> |
[] |
Add more granular control for when to flush. |
| storageProvider | StorageProvider |
ConcreteStorageProvider |
In Android, this must be set to AndroidStorageProvider. The SDK constructors configure this automatically. |
| trackApplicationLifecycleEvents | Boolean |
false |
Set to true to automatically track Lifecycle events. |
| trackDeepLinks | Boolean |
false |
Set to true to automatically track opened Deep Links based on intents. |
| useLifecycleObserver | Boolean |
false |
Set to true to use LifecycleObserver to track Application lifecycle events. |
| sessionAutoTrack | Boolean |
true |
This automatically tracks the user sessions. |
| sessionTimeout | Long |
5 * 60000 (5 minutes) |
The interval in milliseconds at which the user session expires. |