From 6ad86fa2919e5ba943dfa6200a96454934e02078 Mon Sep 17 00:00:00 2001 From: Pranitha P Shetty Date: Mon, 12 May 2025 11:31:12 +0530 Subject: [PATCH] Restructure mobile SDK documentation for React Native --- fern/docs/pages/plug-sdk/react-native.mdx | 100 ++++++++++++++++------ 1 file changed, 75 insertions(+), 25 deletions(-) diff --git a/fern/docs/pages/plug-sdk/react-native.mdx b/fern/docs/pages/plug-sdk/react-native.mdx index 29ef2eb8..848bd221 100644 --- a/fern/docs/pages/plug-sdk/react-native.mdx +++ b/fern/docs/pages/plug-sdk/react-native.mdx @@ -1,6 +1,7 @@ This section describes the process of integrating the DevRev SDK with your React Native app. -## Installation +## Quickstart Guide +### Installation To install the DevRev SDK, run the following command: @@ -8,7 +9,7 @@ To install the DevRev SDK, run the following command: npm install @devrev/sdk-react-native ``` -## Set up the DevRev SDK +### Set up the DevRev SDK In DevRev, go to **Settings** > **PLuG Chat** copy the value under **Your unique App ID**. After obtaining the credentials, you can configure the DevRev SDK in your app. @@ -22,7 +23,8 @@ The SDK will be ready for use once you execute the following configuration metho DevRev.configure(appID: string) ``` -## Identification +## Features +### Identification To access certain features of the DevRev SDK, user identification is required. @@ -38,7 +40,7 @@ The `Identity` structure allows for custom fields in the user, organization, and You can select from the following methods to identify users within your application: -### 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. @@ -46,7 +48,7 @@ The anonymous identification method allows you to create an anonymous user with DevRev.identifyAnonymousUser(userID: string) ``` -### 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. @@ -54,7 +56,14 @@ The unverified identification method identifies users with a unique identifier, DevRev.identifyUnverifiedUser(userID: string, organizationID?: string) ``` -### Update the user +#### Verified identification +The verified identification method identifies users with a unique identifier and verifies their identity with the DevRev backend. + +```typescript +DevRev.identifyVerifiedUser(userID: string, sessionToken: string) +``` + +#### Update the user You can update the user's information using the following method: @@ -66,7 +75,7 @@ DevRev.updateUser(identity: Identity) The `userID` property cannot be updated. -## PLuG support chat +### PLuG support chat 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.  @@ -80,7 +89,7 @@ To show the support chat screen in your app, you can use the following method: DevRev.showSupport() ``` -### Creating a new support conversation +#### Creating a new support conversation You can initiate a new support conversation directly from your app. This method displays the support chat screen and simultaneously creates a new conversation. @@ -88,7 +97,7 @@ You can initiate a new support conversation directly from your app. This method DevRev.createSupportConversation() ``` -### In-app link handling +#### 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: @@ -98,7 +107,7 @@ DevRev.setShouldDismissModalsOnOpenLink(value: boolean) Setting this flag to `true` applies the system's default behavior for opening links, which includes dismissing any DevRev modal screens to facilitate handling your own deep links. -### In-app link callback +#### In-app link callback This functionality is for Android only. @@ -114,7 +123,7 @@ DevRevSDK.setInAppLinkHandler((url) => { 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. - ## Analytics + ### 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: @@ -126,11 +135,11 @@ This functionality requires the SDK to be configured and the user to be identifi DevRev.trackEvent(name: string, properties?: Map) ``` -## Session analytics +### Session analytics The DevRev SDK offers session analytics features to help you understand how users interact 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: @@ -144,7 +153,7 @@ To opt back in, use the following method: DevRev.resumeAllMonitoring() ``` -### Session recording +#### Session recording You can enable session recording to capture user interactions with your app. @@ -161,7 +170,7 @@ The session recording feature includes the following methods to control the reco |`DevRev.pauseRecording()` | Pauses the ongoing session recording. | |`DevRev.resumeRecording()` | Resumes a paused session recording. | -### 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 map of string values. @@ -175,7 +184,7 @@ To clear the session properties in scenarios such as user logout or when the ses DevRev.clearSessionProperties() ``` -### 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. @@ -191,7 +200,7 @@ If any previously masked views need to be unmasked, you can use the following me DevRev.unmarkSensitiveViews(tags: any[]) ``` -### 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. @@ -209,7 +218,7 @@ To stop a timer, use the following method: DevRev.stopTimer(name: string, properties: Map) ``` -### 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: @@ -217,17 +226,17 @@ The DevRev SDK offers automatic screen tracking to help you understand how users DevRev.trackScreen(name: string) ``` -## Push notifications +### 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. The DevRev backend sends push notifications to your app to alert users about new messages in the PLuG support chat. -### Configuration +#### Configuration To receive push notifications, you need to configure your DevRev organization by following the instructions in the [push notifications](./push-notification) section. -### Register for push notifications +#### Register for push notifications Push notifications require SDK configuration and user identification, whether unverified or anonymous, to ensure delivery to the correct user. @@ -254,9 +263,9 @@ DevRevSDK.unregisterDevice(deviceID: string) The method requires the device identifier, which should be the same as the one used when registering the device. -### Processing push notifications +#### Processing push notifications -#### Android +##### Android On Android, notifications are implemented as data messages to offer flexibility. However, this means that automatic click processing isn't available. To handle notification clicks, developers need to intercept the click event, extract the payload, and pass it to a designated method for processing. This custom approach enables tailored notification handling in Android applications. @@ -280,7 +289,7 @@ const notificationPayload = { const messageJson = notificationPayload["message"]; DevRevSDK.processPushNotification(JSON.stringify(messageJson)); ``` -#### iOS +##### iOS 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. @@ -294,7 +303,48 @@ For example: DevRevSDK.processPushNotification(JSON.stringify(payload)); ``` -## License +#### Screen transition tracking (Android only) +On Android, the DevRev SDK provides methods to manually track the screen transitions. + +When a screen transition begins, you must call the following method: + +```typescript +DevRev.startScreenTransition() +``` + +When a screen transition ends, you must call the following method: + +```typescript +DevRev.endScreenTransition() +``` + +## Troubleshooting +- **Issue**: Support chat won't show. + **Solution**: Ensure you have correctly called one of the identification methods: `DevRev.identifyUnverifiedUser(...)`, `DevRev.identifyVerifiedUser(...)`, or `DevRev.identifyAnonymousUser(...)`. + +- **Issue**: Not receiving push notifications. + **Solution**: The DevRev SDK reports all errors in the console using Apple's Unified Logging System. Look for error messages in the subsystem `ai.devrev.sdk`. + + +## Migration Guide +This guide and chart should help facilitate the transition from the legacy UserExperior SDK to the new DevRev SDK in your React Native application, providing insights into feature equivalents and method changes. + +### Feature Equivalence Chart +| Feature | UserExperior SDK | DevRev SDK | +|-|-|-| +| Installation | `npm install react-native-userexperior` | `npm install @devrev/sdk-react-native` | +| Initialization | `UserExperior.startRecording(string)` | `DevRev.configure(appID: string)` | +| User Identification | `UserExperior.setUserIdentifier(string)` | `DevRev.identifyAnonymousUser(userID: string)`
`DevRev.identifyUnverifiedUser(identity: Identity)`
`DevRev.updateUser(identity: Identity)`
`DevRev.identifyVerifiedUser(userID: string, sessionToken: string)`
`DevRev.logout(deviceID: string)` | +| Event Tracking | `UserExperior.logEvent(string, Map)` | `DevRev.trackEvent(name: string, properties?: Map)` | +| Session Recording | `UserExperior.stopRecording()`
`UserExperior.pauseRecording()`
`UserExperior.resumeRecording()` | `DevRev.startRecording()`
`DevRev.stopRecording()`
`DevRev.pauseRecording()`
`DevRev.resumeRecording()`
`DevRev.processAllOnDemandSessions()` | +| Opting in/out | Not supported. | `DevRev.stopAllMonitoring()`
`DevRev.resumeAllMonitoring()` | +| Session Properties | `UserExperior.setUserProperties(Map)` | `DevRev.addSessionProperties(properties: Map)`
`DevRev.clearSessionProperties()` | +| Masking Sensitive Data | `UserExperior.addInSecureViewBucket(any[])`
`UserExperior.removeFromSecureViewBucket(any[])` | `DevRev.markSensitiveViews(tags: any[])`
`DevRev.unmarkSensitiveViews(tags: any[])` | +| Timers | Not supported. | `DevRev.startTimer()`
`DevRev.stopTimer()` | +| PLuG support chat | Not supported. | `DevRev.showSupport()`
`DevRev.createSupportConversation()`
`DevRev.setShouldDismissModalsOnOpenLink()`
`DevRev.setInAppLinkHandler()` | +| Push Notifications | Not supported. | `DevRev.registerDeviceToken()`
`DevRev.unregisterDevice(deviceID: string)`
`DevRev.processPushNotification()` | + +### License Apache 2.0