Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ To get started with the Analytics-Kotlin mobile library:
```java
// Create an analytics client with the given application context and Segment write key.
Analytics("YOUR_WRITE_KEY", applicationContext) {
analyticsScope = applicationCoroutineScope
// Automatically track Lifecycle events
trackApplicationLifecycleEvents = true
flushAt = 3
Expand All @@ -61,15 +60,12 @@ To get started with the Analytics-Kotlin mobile library:
----------- | -----------
`writeKey` *required* | This is your Segment write key. |
`application` | Default set to `null`. <br> The application specific object (in the case of `Android: ApplicationContext`).
`analyticsScope` | Default set to `MainScope()`. <br> The `CoroutineScope` where all analytics coroutines run. |
`analyticsDispatcher` | Default set to `Executors.newSingleThreadExecutor()`. <br> The Dispatcher running analytics tasks. |
`apiHost` | Default set to `api.segment.io/v1`. <br> This sets a default API Host to which Segment sends events. |
`autoAddSegmentDestination` | Default set to `true`. <br> This automatically adds the Segment Destination plugin. You can set this to `false` if you want to manually add the Segment Destination plugin. |
`collectDeviceId` | Default set to `false`. <br> Set to `true` to automatically collect the device Id. |
`defaultSettings` | Default set to `{}`. <br> The settings object used as fallback in case of network failure. |
`flushAt` | Default set to `20`. <br> The count of events at which Segment flushes events. |
`flushInterval` | Default set to `30` (seconds). <br> The interval in seconds at which Segment flushes events. |
`ioDispatcher` | Default set to `Dispatchers.IO`. <br> The Dispatcher running IO tasks. |
`recordScreenViews` | Default set to `false`. <br> Set to `true` to automatically trigger screen events on Activity Start. |
`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. |
`trackApplicationLifecycleEvents` | Default set to `false`. <br> Set to `true` to automatically track Lifecycle events. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,15 +55,12 @@ To get started with the Analytics-Kotlin server library:
----------- | -----------
`writeKey` *required* | This is your Segment write key. |
`application` | Default set to `null`. <br> The application specific object (in the case of `Android: ApplicationContext`).
`analyticsScope` | Default set to `MainScope()`. <br> The `CoroutineScope` where all analytics coroutines run. |
`analyticsDispatcher` | Default set to `Executors.newSingleThreadExecutor()`. <br> The Dispatcher running analytics tasks. |
`apiHost` | Default set to `api.segment.io/v1`. <br> This sets a default API Host to which Segment sends events. |
`autoAddSegmentDestination` | Default set to `true`. <br> This automatically adds the Segment Destination plugin. You can set this to `false` if you want to manually add the Segment Destination plugin. |
`collectDeviceId` | Default set to `false`. <br> Set to `true` to automatically collect the device Id. |
`defaultSettings` | Default set to `{}`. <br> The settings object used as fallback in case of network failure. |
`flushAt` | Default set to `20`. <br> The count of events at which Segment flushes events. |
`flushInterval` | Default set to `30` (seconds). <br> The interval in seconds at which Segment flushes events. |
`ioDispatcher` | Default set to `Dispatchers.IO`. <br> The Dispatcher running IO tasks. |
`recordScreenViews` | Default set to `false`. <br> Set to `true` to automatically trigger screen events on Activity Start. |
`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. |
`trackApplicationLifecycleEvents` | Default set to `false`. <br> Set to `true` to automatically track Lifecycle events. |
Expand Down