Skip to content

ISS-163750: Update the Android SDK guide #204

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 8 commits into from
Closed
Changes from 7 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
120 changes: 61 additions & 59 deletions fern/docs/pages/plug-sdk/android.mdx
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [EkLine] reported by reviewdog 🐶

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

This method will generate and return the device token.

Original file line number Diff line number Diff line change
Expand Up @@ -11,47 +11,41 @@ This section describes the process of integrating the DevRev SDK with your Andro

To integrate the latest version of our SDK into your app, follow these steps:

1. Our SDK is available on Maven Central. To access it, add `mavenCentral` to your root level `build.gradle` file.
```gradle
repositories {
mavenCentral()
}
```

<Tabs>
<Tab title="Kotlin">

1. Add the following dependencies to your app's `build.gradle.kts` file to get the latest version of our SDK:
2. Add the following dependencies to your app's `build.gradle.kts` file to get the latest version of our SDK:

```kotlin
dependencies {
implementation("ai.devrev.sdk:devrev-sdk:<version>")
}
```
2. Our SDK is available on Maven Central. To access it, add `mavenCentral` to your root `build.gradle.kts` file.
```kotlin
repositories {
mavenCentral()
}
```
After completing these steps in your `build.gradle.kts` Kotlin script, you should be able to import and use the DevRev SDK in your Android application.

</Tab>
<Tab title="Groovy">

1. Add the following dependencies to your app's `build.gradle` file to get the latest version of our SDK:
2. Add the following dependencies to your app's `build.gradle` file to get the latest version of our SDK:

```groovy
dependencies {
implementation 'ai.devrev.sdk:devrev-sdk:<version>'
}
```

2. Our SDK is available on Maven Central. To access it, add `mavenCentral` to your root `build.gradle` file.
```groovy
repositories {
mavenCentral()
}
```
After completing these steps in your `build.gradle` Groovy script, you should be able to import and use the DevRev SDK in your Android application.

</Tab>
</Tabs>

## Set up the DevRev SDK
After completing these steps in your gradle files, you should be able to import and use the DevRev SDK in your Android application.

### Set up the DevRev SDK

1. Open the DevRev web app at [https://app.devrev.ai](https://app.devrev.ai) and go to the **Settings** page.
2. Under **PLuG settings** copy the value under **Your unique App ID**.
Expand Down Expand Up @@ -155,7 +149,7 @@ The identification function should be placed appropriately in your app after the
The `Identity` structure allows for custom fields in the user, organization, and account traits. These fields must be configured through the DevRev app before they can be utilized. For more information, refer to [Object customization](https://devrev.ai/docs/product/object-customization).
</Callout>

#### Anonymous identification
### Anonymous identification

The anonymous identification method allows you to create an anonymous user with an optional user identifier, ensuring that no other data is stored or associated with the user.

Expand All @@ -176,7 +170,7 @@ The anonymous identification method allows you to create an anonymous user with
</Tab>
</Tabs>

#### Unverified identification
### Unverified identification

The unverified identification method identifies users with a unique identifier, but it does not verify their identity with the DevRev backend.

Expand All @@ -199,7 +193,7 @@ The unverified identification method identifies users with a unique identifier,

The function accepts the `DevRev.Identity` structure, with the user identifier (`userID`) as the only required property, all other properties are optional.

#### Verified identification
### Verified identification

The verified identification method is used to identify the user with a unique identifier and verify the user's identity with the DevRev backend.

Expand Down Expand Up @@ -261,7 +255,7 @@ Use this property to check whether the user has been provided to the SDK:
</Tab>
</Tabs>

#### Updating the user
### Updating the user

To update a user's information, use the following method:

Expand All @@ -288,7 +282,7 @@ The function accepts the `DevRev.Identity` ojbect.
The `userID` property cannot be updated.
</Callout>

#### Logout
### Logout
You can perform a logout of the current user by calling the following method:

<Tabs>
Expand Down Expand Up @@ -327,7 +321,7 @@ Once user identification is complete, you can start using the chat (conversation
</Tab>
</Tabs>

#### Creating a new conversation
### Creating a new conversation

You have the ability to create a new conversation from within your app. The method will show the support chat screen and create a new conversation at the same time.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [EkLine] reported by reviewdog 🐶

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

Suggested change
You have the ability to create a new conversation from within your app. The method will show the support chat screen and create a new conversation at the same time.
You have the ability to create a new conversation from within your app. The method shows the support chat screen and creates a new conversation at the same time.


Expand Down Expand Up @@ -359,10 +353,6 @@ The support button can also accept default parameters like

```kotlin
android:src="@your_drawable_here"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Recommend combining these lines into a single codeblock rather than two with "and" between.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As they are separate properties, I'd leave them as is.

```
and

```kotlin
android:backgroundTint="@your_background_color"
```

Expand Down Expand Up @@ -457,11 +447,11 @@ For example:
</Tab>
</Tabs>

## Session analytics
### Session analytics

The DevRev SDK provides observability features to help you understand how your users are interacting with your app.

#### Opting-in or out
### Opting-in or out

Session analytics features are opted-in by default, enabling them from the start. However, you can opt-out using the following method:

Expand Down Expand Up @@ -514,7 +504,7 @@ If the user was disabled for session recording by using the stopAllMonitoring()
This feature will only store a monitoring permission flag, it will not provide any UI or dialog.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [EkLine] reported by reviewdog 🐶

Suggestions:

    Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

Suggested change
This feature will only store a monitoring permission flag, it will not provide any UI or dialog.
This feature only stores a monitoring permission flag, it does not provide any UI or dialog.

</Callout>

#### Session recording
### Session recording

You can enable session recording to capture user interactions with your app.

Expand All @@ -524,13 +514,26 @@ The session recording feature is opt-out and is enabled by default.

Here are the available methods to help you control the session recording feature:

|Kotlin |Java |Action |
|---|---|---|
| DevRev.startRecording() | DevRevObservabilityExtKt.startRecording(DevRev.INSTANCE, context); | Starts the session recording. |
| DevRev.stopRecording() | DevRevObservabilityExtKt.stopRecording(DevRev.INSTANCE); | Stops the session recording and uploads it to the portal. |
| DevRev.pauseRecording() | DevRevObservabilityExtKt.pauseRecording(DevRev.INSTANCE); | Pauses the ongoing session recording. |
| DevRev.resumeRecording() | DevRevObservabilityExtKt.resumeRecording(DevRev.INSTANCE); | Resumes a paused session recording. |
| DevRev.processAllOnDemandSessions() | DevRevObservabilityExtKt.processAllOnDemandSessions(DevRev.INSTANECE); | Stops the ongoing user recording and uploads all offline sessions on demand, including the current one. |
<Tabs>
<Tab title="Kotlin">
| Method | Action |
|----------------------------------------|------------------------------------------------------------------------|
| `DevRev.startRecording()` | Starts the session recording. |
| `DevRev.stopRecording()` | Stops the session recording and uploads it to the portal. |
| `DevRev.pauseRecording()` | Pauses the ongoing session recording. |
| `DevRev.resumeRecording()` | Resumes a paused session recording. |
| `DevRev.processAllOnDemandSessions()` | Stops the ongoing user recording and uploads all offline sessions on demand, including the current one. |
</Tab>
<Tab title="Java">
| Method | Action |
|-----------------------------------------------------------------------------|------------------------------------------------------------------------|
| `DevRevObservabilityExtKt.startRecording(DevRev.INSTANCE, context);` | Starts the session recording. |
| `DevRevObservabilityExtKt.stopRecording(DevRev.INSTANCE);` | Stops the session recording and uploads it to the portal. |
| `DevRevObservabilityExtKt.pauseRecording(DevRev.INSTANCE);` | Pauses the ongoing session recording. |
| `DevRevObservabilityExtKt.resumeRecording(DevRev.INSTANCE);` | Resumes a paused session recording. |
| `DevRevObservabilityExtKt.processAllOnDemandSessions(DevRev.INSTANCE);` | Stops the ongoing user recording and uploads all offline sessions on demand, including the current one. |
</Tab>
</Tabs>

Using this property will return the status of the session recording:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [EkLine] reported by reviewdog 🐶

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

Suggested change
Using this property will return the status of the session recording:
Using this property returns the status of the session recording:


Expand Down Expand Up @@ -562,7 +565,7 @@ To check if on-demand sessions are enabled, use:
</Tab>
</Tabs>

#### Session properties
### Session properties

You can add custom properties to the session recording to help you understand the context of the session. The properties are defined as a dictionary of string values.

Expand Down Expand Up @@ -594,15 +597,14 @@ To clear the session properties in scenarios such as user logout or when the ses
</Tab>
</Tabs>

#### Masking sensitive data
### Masking sensitive data
To protect sensitive data, the DevRev SDK provides an auto-masking feature that masks data before sending to the server. Input views such as text fields, text views, and web views are automatically masked.

While the auto-masking feature may be sufficient for most situations, you can manually mark/unmark additional views as sensitive.

##### Mask
###### Using tag
> [!NOTE]
> Use Tag method only when you don't have any other tag already applied to your UI element.
### Mask
### Using tag
<Note>Use the `Tag` method only when you don't have any other tag already applied to your UI element.</Note>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@zeeshan-devrev @rohan-devrev can we check if the method is actually uppercased?


```xml
android:tag="devrev-mask"
Expand Down Expand Up @@ -634,7 +636,7 @@ You can also set the tag programmatically:
</Tab>
</Tabs>

###### Using API
### Using API

<Tabs>
<Tab title="Kotlin">
Expand Down Expand Up @@ -674,8 +676,8 @@ For example:
</Tab>
</Tabs>

##### Unmask
###### Using tag
### Unmask
### Using tag
> [!NOTE]
> Use Tag method only when you don't have any other tag already applied to your UI element.

Expand Down Expand Up @@ -710,7 +712,7 @@ You can also set the tag programmatically:
</Tab>
</Tabs>

###### Using API
### Using API

<Tabs>
<Tab title="Kotlin">
Expand Down Expand Up @@ -750,7 +752,7 @@ For example:
</Tab>
</Tabs>

##### Mask jetpack compose views
### Mask jetpack compose views
If you want to mask any Jetpack Compose UI element(s) or view(s), you can apply a mask on it using a modifier.

```kotlin
Expand All @@ -769,23 +771,23 @@ TextField(
)
```

##### Mask webView elements
### Mask webView elements
If you wish to mask any WebView element on a Web page explicitly, you can mask it by using class 'devrev-mask'

For example:
```html
<label class="devrev-mask">OTP: 12345</label>
```

##### Unmask webView elements
### Unmask webView elements
If you wish to explicitly un-mask any manually masked WebView element, you can un-mask it by using class 'devrev-unmask'

For example:
```html
<input type="text" placeholder="Enter Username" name="username" required class="devrev-unmask">
```

#### Timers
### Timers

The DevRev SDK offers a timer mechanism to measure the time spent on specific tasks, allowing you to track events such as response time, loading time, or any other duration-based metrics.

Expand Down Expand Up @@ -844,7 +846,7 @@ For example:
</Tab>
</Tabs>

#### Screen tracking
### Screen tracking

The DevRev SDK offers automatic screen tracking to help you understand how users navigate through your app. Although view controllers are automatically tracked, you can manually track screens using the following method:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [EkLine] reported by reviewdog 🐶

Consider using 'go' instead of 'navigate'. (EK25033)

Suggested change
The DevRev SDK offers automatic screen tracking to help you understand how users navigate through your app. Although view controllers are automatically tracked, you can manually track screens using the following method:
The DevRev SDK offers automatic screen tracking to help you understand how users go through your app. Although view controllers are automatically tracked, you can manually track screens using the following method:

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Navigate is the correct verb here.


Expand Down Expand Up @@ -879,9 +881,9 @@ For example:
### Screen transition management

The DevRev SDK allows tracking of screen transitions to understand user navigation within your app.
You can check if a screen transition is in progress and manually update the state using the following methods:
You can check if a screen transition is in progress and manually update the state using the following methods.

#### Check if the screen is transitioning
### Check if the screen is transitioning

<Tabs>
<Tab title="Kotlin">
Expand All @@ -896,7 +898,7 @@ You can check if a screen transition is in progress and manually update the stat
</Tab>
</Tabs>

##### Set screen transitioning state
### Set screen transitioning state

<Tabs>
<Tab title="Kotlin">
Expand All @@ -923,7 +925,7 @@ To receive push notifications, you need to configure your DevRev organization by

You need to ensure that your Android app is configured to receive push notifications. To set it up, follow the [Firebase documentation](https://firebase.google.com/docs/cloud-messaging/android/client).

#### Register for push notifications
### Register for push notifications

<Callout intent="note">
Push notifications require that the SDK has been configured and the user has been identified (unverified and anonymous users). The user identification is required to send the push notification to the correct user.
Expand Down Expand Up @@ -964,7 +966,7 @@ This method will generate and return the device token.
// Use the token as needed
```

#### Unregister from push notifications
### Unregister from push notifications

If your app no longer needs to receive push notifications, you can unregister the device.

Expand All @@ -991,7 +993,7 @@ The method requires the device identifier, which should be the same as the one u
</Tab>
</Tabs>

#### Handle push notifications
### Handle push notifications
The DevRev SDK currently does not support automatic handling of push notifications. To open the PLuG chat and manage navigation internally, you must pass the message payload received in the notification to the SDK.

<Tabs>
Expand Down
Loading