Skip to content

Commit 2109ac5

Browse files
committed
edits
1 parent 41a5ad9 commit 2109ac5

File tree

2 files changed

+23
-20
lines changed

2 files changed

+23
-20
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,4 +145,4 @@ To test your destination:
145145
Segment recommends you to test your destination implementation end-to-end. Send some sample analytics events and ensure that they reach the destination.
146146

147147
> info ""
148-
> For more information about the Analytics Kotlin Plugin architecture and how it can help you customize your tracking implementation to suit your needs, refer to the [Plugin Architecture Guide.](/docs/connections/sources/catalog/libraries/mobile/kotlin-android/kotlin-android-plugin-architecture)
148+
> For more information about the Analytics Kotlin Plugin architecture and how it can help you customize your tracking implementation to suit your needs, refer to the [Plugin Architecture guide](/docs/connections/sources/catalog/libraries/mobile/kotlin-android/kotlin-android-plugin-architecture).

src/connections/sources/catalog/libraries/mobile/kotlin-android/destination-plugins/survicate-kotlin-android.md

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,19 @@ title: Analytics Kotlin Survicate Plugin
33
strat: kotlin-android
44
---
55

6-
[Survicate](https://survicate.com/){:target="_blank"} is an all-in-one customer feedback platform that helps you collect and act on feedback from your customers. It helps you understand your customers and improve their experience with your product or service.
6+
[Survicate](https://survicate.com/){:target="_blank"} is an all-in-one customer feedback platform that helps you collect and act on feedback from your customers. With Survicate, you can better understand your customers and improve their experience with your product or service.
77

8-
Add Survicate device mode support to your applications using this plugin for [Analytics-Kotlin](https://github.com/segmentio/analytics-kotlin){:target="_blank"}.
8+
Add Survicate device mode support to your applications using [this plugin](https://github.com/segmentio/analytics-kotlin){:target="_blank"} for Analytics-Kotlin.
99

1010
## Getting started
1111

12-
First you need to provide a Survicate workspace key.
12+
To get started, you need to provide a Survicate workspace key.
1313

14-
You can do this in 2 ways:
14+
You can do this in two ways:
1515

16-
1. Add the key in the Segment panel -> Destinations -> Your Android app destination -> Settings. You need to put the key inside the Connection Settings as a "Workspace Key".
16+
1. Add the key in the Segment panel. Navigate to **Connections > Destinations** and locate your Android app destination. Click **Settings**, then enter the key inside the Connection Settings as a "Workspace Key".
1717

18-
2. Alternatively, you can add your Survicate workspace key as a metadata inside AndroidManifest
18+
2. Alternatively, you can add your Survicate workspace key as metadata inside AndroidManifest:
1919

2020
```xml
2121
<application
@@ -25,8 +25,11 @@ You can do this in 2 ways:
2525
<meta-data android:name="com.survicate.surveys.workspaceKey" android:value="YOUR_WORKSPACE_KEY"/>
2626
</application>
2727
```
28+
2829
## Adding the dependency
29-
Define Maven repository
30+
31+
To define the Maven repository:
32+
3033
```
3134
allprojects {
3235
repositories {
@@ -36,15 +39,15 @@ allprojects {
3639
}
3740
```
3841

39-
Add dependency to your app's build.gradle file
42+
Add the dependency to your app's build.gradle file:
4043
```
4144
dependencies {
4245
// ...
4346
implementation 'com.survicate:survicate-segment-analytics-kotlin:<latest_version>'
4447
}
4548
```
4649

47-
You can find current version in the [plugin repository](https://github.com/Survicate/analytics-kotlin-survicate)
50+
You can find the current version in the [plugin repository](https://github.com/Survicate/analytics-kotlin-survicate){:target="_blank"}.
4851

4952
## Using the Plugin in your App
5053
In order to activate the Survicate plugin, you have to add a `SurvicateDestination` to the Analytics instance.
@@ -56,22 +59,22 @@ analytics = Analytics(segmentKey, applicationContext) {
5659
analytics.add(SurvicateDestination(applicationContext))
5760
```
5861

59-
Make sure to keep only one instance of the `Analytics` (e.g. initialize it inside Application's onCreate method). This is important, because the Survicate SDK underneath can only be initialized once.
62+
Only keep one instance of the `Analytics` (for example, initialize it inside the application's `onCreate` method). This is important because the Survicate SDK underneath can only be initialized once.
6063

61-
Now you can use the Analytics as usual, having the events mapped to Survicate SDK as described below.
64+
Now you can use the Analytics, having the events mapped to the Survicate SDK as described below.
6265

63-
_**Identify**_
66+
#### Identify
6467

65-
In the SurvicateDestination plugin, the `identify` method from Segment is transferred to the `setUserTraits` method of Survicate. You can provide multiple key-value pairs. The `userId` argument of `Analytics.identify` is also set as a user trait with the key "user_id".
68+
In the SurvicateDestination plugin, the Identify method from Segment is transferred to the `setUserTraits` method of Survicate. You can provide multiple key-value pairs. The `userId` argument of `Analytics.identify` is also set as a user trait with the key "user_id".
6669

67-
_**Track**_
70+
#### Track
6871

69-
The `track` method from Segment is used as the `invokeEvent` method in Survicate. This means that when you track an event in Segment, it will be invoked in Survicate.
72+
The Track method from Segment is used as the `invokeEvent` method in Survicate. This means that when you track an event in Segment, it will be invoked in Survicate.
7073

71-
_**Screen**_
74+
#### Screen
7275

73-
Similarly, the screen method from Segment is used as the `enterScreen` method in Survicate. This means that when you track a screen in Segment, it will be entered in Survicate.
76+
Similarly, the Screen method from Segment is used as the `enterScreen` method in Survicate. This means that when you track a screen in Segment, it will be entered in Survicate.
7477

75-
_**Reset**_
78+
#### Reset
7679

77-
The `reset` method from Segment is used as the reset method in Survicate. This means that when you reset the Segment client, the Survicate client will also be reset.
80+
The Reset method from Segment is used as the reset method in Survicate. This means that when you reset the Segment client, the Survicate client is also reset.

0 commit comments

Comments
 (0)