Skip to content

Commit 0228748

Browse files
authored
Merge pull request #3320 from segmentio/vanand17-patch-1
Add Analytics-Kotlin plugin examples link
2 parents 39173c9 + 06fa6e2 commit 0228748

File tree

1 file changed

+10
-8
lines changed
  • src/connections/sources/catalog/libraries/mobile/kotlin-android

1 file changed

+10
-8
lines changed

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

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ With Analytics-Kotlin, you can send data using Kotlin applications to any analyt
1616
If you're migrating to Analytics-Kotlin from a different mobile library, you can skip to the [migration guide](/docs/connections/sources/catalog/libraries/mobile/kotlin-android/migration/).
1717

1818

19-
## Getting Started
19+
## Getting started
2020

2121
To get started with the Analytics-Kotlin mobile library:
2222

@@ -92,7 +92,9 @@ To get started with the Analytics-Kotlin mobile library:
9292
9393
The SDK internally uses a number of Java 8 language APIs through desugaring. Make sure your project either [enables desugaring](https://developer.android.com/studio/write/java8-support#library-desugaring)) or requires a minimum API level of 26.
9494
95-
## Tracking Methods
95+
You'll find configuration options such as IDFA collection and automatic screen tracking in Segment’s [Plugin Examples repository](https://github.com/segmentio/analytics-kotlin/tree/main/samples/kotlin-android-app/src/main/java/com/segment/analytics/next/plugins){:target="_blank"}.
96+
97+
## Tracking methods
9698
9799
Once you've installed the mobile or server Analytics-Kotlin library, you can start collecting data through Segment's tracking methods:
98100
- [Identify](#identify)
@@ -153,7 +155,7 @@ analytics.track("View Product", buildJsonObject {
153155
### Screen
154156
The [Screen](/docs/connections/spec/screen/) method lets you record whenever a user sees a screen in your mobile app, along with optional extra information about the page being viewed.
155157

156-
You'll want to record a screen event whenever the user opens a screen in your app. This could be a view, fragment, dialog or activity depending on your app.
158+
You'll want to record a screen event whenever the user opens a screen in your app. This could be a view, fragment, dialog, or activity depending on your app.
157159

158160
Not all integrations support screen, so when it's not supported explicitly, the screen method tracks as an event with the same parameters.
159161

@@ -203,10 +205,10 @@ analytics.group("user-123", buildJsonObject {
203205
{% endcodeexampletab %}
204206
{% endcodeexample %}
205207

206-
## Plugin Architecture
208+
## Plugin architecture
207209
Segment's plugin architecture enables you to modify and augment how the analytics client works. From modifying event payloads to changing analytics functionality, plugins help to speed up the process of getting things done.
208210

209-
Plugins are run through a timeline, which executes in order of insertion based on their entry types. Segment has these 5 entry types:
211+
Plugins are run through a timeline, which executes in order of insertion based on their entry types. Segment has these five entry types:
210212

211213
| Type | Details |
212214
| ------------- | ---------------------------------------------------------------------------------------------- |
@@ -217,7 +219,7 @@ Plugins are run through a timeline, which executes in order of insertion based o
217219
| `utility` | Executes only with manual calls such as Logging. |
218220

219221
### Fundamentals
220-
There are 3 basic types of plugins that you can use as a foundation for modifying functionality. They are: [`Plugin`](#plugin), [`EventPlugin`](#eventplugin), and [`DestinationPlugin`](#destinationplugin).
222+
There are three basic types of plugins that you can use as a foundation for modifying functionality. They are: [`Plugin`](#plugin), [`EventPlugin`](#eventplugin), and [`DestinationPlugin`](#destinationplugin).
221223

222224
#### Plugin
223225
`Plugin` acts on any event payload going through the timeline.
@@ -341,7 +343,7 @@ analytics.add(yourPlugin)
341343
See how different platforms and languages use Analytics-Kotlin in different [example projects](https://github.com/segmentio/analytics-kotlin/tree/main/samples).
342344
The example projects contain sample [plugins](https://github.com/segmentio/analytics-kotlin/tree/main/samples/kotlin-android-app/src/main/java/com/segment/analytics/next/plugins) and [destination plugins](https://github.com/segmentio/analytics-kotlin/tree/main/samples/kotlin-android-app-destinations/src/main/java/com/segment/analytics/destinations/plugins) you can utilize.
343345

344-
## Utility Methods
346+
## Utility methods
345347
The Analytics-Kotlin utility methods help you work with plugins from the analytics timeline. They include:
346348
- [Add](#add)
347349
- [Find](#find)
@@ -440,7 +442,7 @@ analytics.reset()
440442
{% endcodeexampletab %}
441443
{% endcodeexample %}
442444

443-
## Build Your Own Destination
445+
## Build Your own destination
444446

445447
If Segment doesn't support your Kotlin destination, you can build your own with the template Segment provides.
446448

0 commit comments

Comments
 (0)