Skip to content

Commit 692473d

Browse files
committed
Improve section in document
1 parent dc0000a commit 692473d

File tree

1 file changed

+25
-27
lines changed

1 file changed

+25
-27
lines changed

fern/docs/pages/plug-sdk/android.mdx

Lines changed: 25 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ After completing these steps in your `build.gradle` Groovy script, you should be
5151
</Tab>
5252
</Tabs>
5353

54-
## Set up the DevRev SDK
54+
### Set up the DevRev SDK
5555

5656
1. Open the DevRev web app at [https://app.devrev.ai](https://app.devrev.ai) and go to the **Settings** page.
5757
2. Under **PLuG settings** copy the value under **Your unique App ID**.
@@ -155,7 +155,7 @@ The identification function should be placed appropriately in your app after the
155155
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).
156156
</Callout>
157157

158-
#### Anonymous identification
158+
### Anonymous identification
159159

160160
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.
161161

@@ -176,7 +176,7 @@ The anonymous identification method allows you to create an anonymous user with
176176
</Tab>
177177
</Tabs>
178178

179-
#### Unverified identification
179+
### Unverified identification
180180

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

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

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

202-
#### Verified identification
202+
### Verified identification
203203

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

@@ -261,7 +261,7 @@ Use this property to check whether the user has been provided to the SDK:
261261
</Tab>
262262
</Tabs>
263263

264-
#### Updating the user
264+
### Updating the user
265265

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

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

291-
#### Logout
291+
### Logout
292292
You can perform a logout of the current user by calling the following method:
293293

294294
<Tabs>
@@ -327,7 +327,7 @@ Once user identification is complete, you can start using the chat (conversation
327327
</Tab>
328328
</Tabs>
329329

330-
#### Creating a new conversation
330+
### Creating a new conversation
331331

332332
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.
333333

@@ -461,7 +461,7 @@ For example:
461461

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

464-
#### Opting-in or out
464+
### Opting-in or out
465465

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

@@ -514,7 +514,7 @@ If the user was disabled for session recording by using the stopAllMonitoring()
514514
This feature will only store a monitoring permission flag, it will not provide any UI or dialog.
515515
</Callout>
516516

517-
#### Session recording
517+
### Session recording
518518

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

@@ -562,7 +562,7 @@ To check if on-demand sessions are enabled, use:
562562
</Tab>
563563
</Tabs>
564564

565-
#### Session properties
565+
### Session properties
566566

567567
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.
568568

@@ -594,13 +594,11 @@ To clear the session properties in scenarios such as user logout or when the ses
594594
</Tab>
595595
</Tabs>
596596

597-
#### Masking sensitive data
597+
### Masking sensitive data
598598
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.
599599

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

602-
##### Mask
603-
###### Using tag
604602
> [!NOTE]
605603
> Use Tag method only when you don't have any other tag already applied to your UI element.
606604
@@ -634,7 +632,7 @@ You can also set the tag programmatically:
634632
</Tab>
635633
</Tabs>
636634

637-
###### Using API
635+
### Using API
638636

639637
<Tabs>
640638
<Tab title="Kotlin">
@@ -674,8 +672,8 @@ For example:
674672
</Tab>
675673
</Tabs>
676674

677-
##### Unmask
678-
###### Using tag
675+
### Unmask
676+
### Using tag
679677
> [!NOTE]
680678
> Use Tag method only when you don't have any other tag already applied to your UI element.
681679
@@ -710,7 +708,7 @@ You can also set the tag programmatically:
710708
</Tab>
711709
</Tabs>
712710

713-
###### Using API
711+
### Using API
714712

715713
<Tabs>
716714
<Tab title="Kotlin">
@@ -750,7 +748,7 @@ For example:
750748
</Tab>
751749
</Tabs>
752750

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

756754
```kotlin
@@ -769,23 +767,23 @@ TextField(
769767
)
770768
```
771769

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

775773
For example:
776774
```html
777775
<label class="devrev-mask">OTP: 12345</label>
778776
```
779777

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

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

788-
#### Timers
786+
### Timers
789787

790788
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.
791789

@@ -844,7 +842,7 @@ For example:
844842
</Tab>
845843
</Tabs>
846844

847-
#### Screen tracking
845+
### Screen tracking
848846

849847
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:
850848

@@ -881,7 +879,7 @@ For example:
881879
The DevRev SDK allows tracking of screen transitions to understand user navigation within your app.
882880
You can check if a screen transition is in progress and manually update the state using the following methods:
883881

884-
#### Check if the screen is transitioning
882+
### Check if the screen is transitioning
885883

886884
<Tabs>
887885
<Tab title="Kotlin">
@@ -896,7 +894,7 @@ You can check if a screen transition is in progress and manually update the stat
896894
</Tab>
897895
</Tabs>
898896

899-
##### Set screen transitioning state
897+
### Set screen transitioning state
900898

901899
<Tabs>
902900
<Tab title="Kotlin">
@@ -923,7 +921,7 @@ To receive push notifications, you need to configure your DevRev organization by
923921

924922
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).
925923

926-
#### Register for push notifications
924+
### Register for push notifications
927925

928926
<Callout intent="note">
929927
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.
@@ -964,7 +962,7 @@ This method will generate and return the device token.
964962
// Use the token as needed
965963
```
966964

967-
#### Unregister from push notifications
965+
### Unregister from push notifications
968966

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

@@ -991,7 +989,7 @@ The method requires the device identifier, which should be the same as the one u
991989
</Tab>
992990
</Tabs>
993991

994-
#### Handle push notifications
992+
### Handle push notifications
995993
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.
996994

997995
<Tabs>

0 commit comments

Comments
 (0)