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.

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

Conversation

dhananjayj-dev
Copy link
Contributor

This PR updates the React Native SDK guide.

@dhananjayj-dev dhananjayj-dev requested a review from bojan April 3, 2025 13:45
@dhananjayj-dev dhananjayj-dev self-assigned this Apr 3, 2025
@dhananjayj-dev dhananjayj-dev requested a review from a team as a code owner April 3, 2025 13:45
Copy link
Contributor

github-actions bot commented Apr 3, 2025

🌟 EkLine Reviewer

Hello! I’m here to help improve your docs. I’ve reviewed your pull request, and left in-line suggestions for quick fixes. For details, visit the Analytics Page.

For questions or feedback, please email support@ekline.io.

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)

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)

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)

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)

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

github-actions bot commented Apr 3, 2025

@bojan bojan changed the title ISS-160289: Update the react native SDK guide ISS-160289: Update the React Native SDK guide Apr 3, 2025
Copy link
Contributor

github-actions bot commented Apr 3, 2025

Copy link
Contributor

@bc-devrev bc-devrev left a comment

Choose a reason for hiding this comment

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

Approved with some suggestions.

@@ -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, the links opened from the support chat are opened in the app instead of a browser. You can control whether the chat modal should be dismissed after the link is opened by calling 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.

The revision has the problem that "opened" is repeated. I'd recommend sticking with the original phrasing of this line.

Copy link
Contributor

@bojan bojan Apr 4, 2025

Choose a reason for hiding this comment

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

There were a few issues in the original phrasing, we can try to rephrase the part where opened is duplicated.

Suggested change
In certain cases, the links opened from the support chat are opened in the app instead of a browser. You can control whether the chat modal should be dismissed after the link is opened by calling the following method:
In certain cases, tapping links in the support chat will open them in the app instead of a browser. You can control whether the chat modal screen should be dismissed after the link is opened by calling the following method:

|`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 uploads it to the portal. |
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
|`DevRev.stopRecording()` | Stop the session recording and uploads it to the portal. |
|`DevRev.stopRecording()` | Stop the session recording and upload it to the portal. |

|`DevRev.stopRecording()` | Stop the session recording and uploads 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 uploads all offline sessions on demand, including the current one.|
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
|`DevRev.processAllOnDemandSessions()` | Stop the ongoing session recording and uploads all offline sessions on demand, including the current one.|
|`DevRev.processAllOnDemandSessions()` | Stop the ongoing session recording and upload all offline sessions on demand, including the current one.|

@@ -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.
Push notifications require that the SDK has been configured and the user has been identified, to ensure delivery to the correct user.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Push notifications require that the SDK has been configured and the user has been identified, 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.

@@ -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` should be the Firebase Cloud Messaging (FCM) token value, while on iOS devices, it should be the Apple Push Notification Service (APNs) token.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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.

Copy link
Contributor

github-actions bot commented Apr 7, 2025

@dhananjayj-dev
Copy link
Contributor Author

@bc-devrev - Worked on your suggestions. Please re-review.
cc @bojan

@dhananjayj-dev dhananjayj-dev requested a review from bc-devrev April 7, 2025 09:57
Copy link
Contributor

@bojan bojan left a comment

Choose a reason for hiding this comment

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

One minor thing.

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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)

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.

Copy link
Contributor

github-actions bot commented Apr 7, 2025

@dhananjayj-dev dhananjayj-dev requested a review from bojan May 6, 2025 13:56
Copy link
Contributor

github-actions bot commented May 6, 2025

@dhananjayj-dev dhananjayj-dev merged commit 8630688 into main May 6, 2025
5 checks passed
@dhananjayj-dev dhananjayj-dev deleted the feature/ISS-160289-update-react-native-guide branch May 6, 2025 14:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants