Skip to content

ISS-160289: Update the React Native SDK guide #195

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
May 6, 2025
Merged

ISS-160289: Update the React Native SDK guide #195

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4a5bbdc
Update the react native SDK guide.
dhananjayj-dev Apr 3, 2025
cfcacf6
Fix the grammar
dhananjayj-dev Apr 3, 2025
b937d89
Fix some phrasings and typos
dhananjayj-dev Apr 7, 2025
184d651
Update react-native.mdx
dhananjayj-dev Apr 7, 2025
a86f668
Merge branch 'main' into feature/ISS-160289-update-react-native-guide
dhananjayj-dev May 6, 2025
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
36 changes: 18 additions & 18 deletions fern/docs/pages/plug-sdk/react-native.mdx
View file
Open in desktop
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)

fern-api-docs/fern/docs/pages/plug-sdk/react-native.mdx

Line 19 in 4a5bbdc

The SDK will be ready for use once you execute the following configuration 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 🐶

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

fern-api-docs/fern/docs/pages/plug-sdk/react-native.mdx

Line 32 in 4a5bbdc

On iOS, if you haven't previously identified the user, the DevRev SDK will automatically create an anonymous user for you immediately after the SDK is configured.

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)

fern-api-docs/fern/docs/pages/plug-sdk/react-native.mdx

Line 115 in 4a5bbdc

If a custom handler is not defined, all external and in-app links from the support chat will open using the system's default browser, such as Chrome.

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)

fern-api-docs/fern/docs/pages/plug-sdk/react-native.mdx

Line 215 in 4a5bbdc

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 🐶

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

fern-api-docs/fern/docs/pages/plug-sdk/react-native.mdx

Line 286 in 184d651

On iOS devices, you must pass the received push notification payload to the DevRev SDK for processing. The SDK will then handle the notification and execute the necessary actions.

Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ On iOS, if you haven't previously identified the user, the DevRev SDK will autom
</Callout>

<Callout intent="note">
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).
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 used. For more information, refer to [Object customization](https://devrev.ai/docs/product/object-customization).
</Callout>

You can select from the following methods to identify users within your application:
Expand Down Expand Up @@ -71,7 +71,7 @@ The `userID` property cannot be updated.
Once user identification is complete, you can start using the chat (conversations) dialog supported by our DevRev SDK. The support chat feature can be shown as a modal screen from the top-most screen. 

<Callout intent="note">
This functionality requires the SDK to be configured and the user to be identified, whether they are unverified or anonymous.
This feature requires the SDK to be configured and the user to be identified, whether they are unverified or anonymous.
</Callout>

To show the support chat screen in your app, you can use the following method:
Expand All @@ -90,7 +90,7 @@ DevRev.createSupportConversation()

### In-app link handling

In some instances, links opened from the support chat are displayed within the app rather than in a browser. You can manage whether the chat modal should close after a link is opened by using the following method:
In certain cases, tapping links in the support chat opens them in the app instead of a browser. You can control whether the chat modal screen is dismissed after the link is opened by calling the following method:

```typescript
DevRev.setShouldDismissModalsOnOpenLink(value: boolean)
Expand All @@ -101,7 +101,7 @@ Setting this flag to `true` applies the system's default behavior for opening li
### In-app link callback

<Callout intent="note">
This functionality is for Android only.
This feature is for Android only.
</Callout>

For scenarios where custom handling is needed, links from the support chat can be captured with the following method:
Expand All @@ -116,12 +116,12 @@ If a custom handler is not defined, all external and in-app links from the suppo

## Analytics

The DevRev SDK allows you to send custom analytic events by using a properties map. You can track these events using the following function:

<Callout intent="note">
This functionality requires the SDK to be configured and the user to be identified, whether they are unverified or anonymous.
This feature requires the SDK to be configured and the user to be identified, whether they are unverified or anonymous.
</Callout>

The DevRev SDK allows you to send custom analytic events by using a properties map. You can track these events using the following function:

```typescript
DevRev.trackEvent(name: string, properties?: Map<string, string>)
```
Expand All @@ -146,7 +146,7 @@ DevRev.resumeAllMonitoring()

### Session recording

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

<Callout intent="note">
The session recording feature is opt-out and is enabled by default.
Expand All @@ -156,10 +156,11 @@ The session recording feature includes the following methods to control the reco

| Method | Action |
|--------------------------------------------------------------------|-----------------------------------------------------------|
|`DevRev.startRecording()` | Starts the session recording. |
|`DevRev.stopRecording()` | Ends the session recording and uploads it to the portal. |
|`DevRev.pauseRecording()` | Pauses the ongoing session recording. |
|`DevRev.resumeRecording()` | Resumes a paused session recording. |
|`DevRev.startRecording()` | Start the session recording. |
|`DevRev.stopRecording()` | Stop the session recording and upload it to the portal. |
|`DevRev.pauseRecording()` | Pause the ongoing session recording. |
|`DevRev.resumeRecording()` | Resume a paused session recording. |
|`DevRev.processAllOnDemandSessions()` | Stop the ongoing session recording and upload all offline sessions on demand, including the current one.|

### Session properties

Expand Down Expand Up @@ -195,7 +196,7 @@ DevRev.unmarkSensitiveViews(tags: any[])

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.

The mechanism utilizes balanced start and stop methods, both of which accept a timer name and an optional dictionary of properties.
The mechanism uses balanced start and stop methods, both of which accept a timer name and an optional dictionary of properties.

To start a timer, use the following method:

Expand All @@ -219,9 +220,9 @@ DevRev.trackScreen(name: string)

## Push notifications

You can configure your app to receive push notifications from the DevRev SDK. The SDK is designed to handle push notifications and execute actions based on the notification's content.
You can configure your app to receive push notifications from the DevRev SDK. The SDK is able to handle push notifications and execute actions based on the notification's content.

The DevRev backend sends push notifications to your app to alert users about new messages in the PLuG support chat.
The DevRev backend sends push notifications to your app to notify users about new messages in the PLuG support chat.

### Configuration

Expand All @@ -230,7 +231,7 @@ To receive push notifications, you need to configure your DevRev organization by
### Register for push notifications

<Callout intent="note">
Push notifications require SDK configuration and user identification, whether unverified or anonymous, to ensure delivery to the correct user.
To ensure delivery to the correct user, push notifications require that the SDK has been configured and the user has been identified.
</Callout>

The DevRev SDK offers a method to register your device for receiving push notifications. You can register for push notifications using the following method:
Expand All @@ -239,7 +240,7 @@ The DevRev SDK offers a method to register your device for receiving push notifi
DevRevSDK.registerDeviceToken(deviceToken: string, deviceID: string)
```

On Android devices, the `deviceToken` should be the Firebase Cloud Messaging (FCM) token value, while on iOS devices, it should be the Apple Push Notification Service (APNS) token.
On Android devices, the `deviceToken` must be the Firebase Cloud Messaging (FCM) token value. On iOS devices, it must be the Apple Push Notification Service (APNs) token.

### Unregister from push notifications

Expand Down Expand Up @@ -297,4 +298,3 @@ DevRevSDK.processPushNotification(JSON.stringify(payload));
## License

Apache 2.0

Loading