Skip to content

Commit 8bc7ce3

Browse files
committed
fix misleading description on storage provider
1 parent cf65725 commit 8bc7ce3

File tree

1 file changed

+2
-1
lines changed
  • src/connections/sources/catalog/libraries/mobile/kotlin-android

1 file changed

+2
-1
lines changed

src/connections/sources/catalog/libraries/mobile/kotlin-android/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ To get started with the Analytics-Kotlin mobile library:
4242
4343
```java
4444
// Create an analytics client with the given application context and Segment write key.
45+
// NOTE: in android, application context is required to pass as the second parameter.
4546
Analytics("YOUR_WRITE_KEY", applicationContext) {
4647
// Automatically track Lifecycle events
4748
trackApplicationLifecycleEvents = true
@@ -67,7 +68,7 @@ To get started with the Analytics-Kotlin mobile library:
6768
`flushAt` | Default set to `20`. <br> The count of events at which Segment flushes events. |
6869
`flushInterval` | Default set to `30` (seconds). <br> The interval in seconds at which Segment flushes events. |
6970
`recordScreenViews` | Default set to `false`. <br> Set to `true` to automatically trigger screen events on Activity Start. |
70-
`storageProvider` | Default set to `ConcreteStorageProvider`. <br> The provider for storage class. It’s best not to modify this as it can disrupt your storage logic and you won’t be able to correctly store events. <br> NOTE: in Android, if you create `Configuration` through a constructor, this must be set to `AndroidStorageProvider`.|
71+
`storageProvider` | Default set to `ConcreteStorageProvider`. <br> In Android, this must be set to `AndroidStorageProvider`. The `Analytics` constructors configure this automatically. |
7172
`trackApplicationLifecycleEvents` | Default set to `false`. <br> Set to `true` to automatically track Lifecycle events. |
7273
`trackDeepLinks` | Default set to `false`. <br> Set to `true` to automatically track opened Deep Links based on intents. |
7374
`useLifecycleObserver` | Default set to `false`. <br> Set to `true` to use `LifecycleObserver` to track Application lifecycle events. |

0 commit comments

Comments
 (0)