Skip to content

split platform push notification instructions #197

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 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all 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
4 changes: 4 additions & 0 deletions fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,10 @@ redirects:
permanent: true
- source: /:path*/sdks/mobile/:slug*
destination: /:path*/sdks/:slug*
permanent: true
- source: /:path*/sdks/push-notification
destination: /:path*/sdks/
permanent: true

analytics:
ga4:
Expand Down
29 changes: 28 additions & 1 deletion 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 🐶

Must put the ending punctuation at the end of a list item. (EK00041)

- Android Studio 2022.1.1 or later

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 🐶

Must put the ending punctuation at the end of a list item. (EK00041)

- Android Gradle plugin version 7.4 or later

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 🐶

Must put the ending punctuation at the end of a list item. (EK00041)

- Gradle version 7.6 or later

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 🐶

Must put the ending punctuation at the end of a list item. (EK00041)

- Minimum Android SDK 24

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)

2. After obtaining the credentials, you can configure the DevRev SDK in your app. The SDK will be ready for use once you execute the 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 🐶

Must put the ending punctuation at the end of a list item. (EK00041)

DevRev.configure(context: Context, appId: String)

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 🐶

Don't use language (such as 'disabled ') that defines people by their disability. (EK00030)

If session recording was disabled for the user using the `stopAllMonitoring()` method, you can enable recording at runtime with this 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 🐶

Keep one space between words and punctuation in 'v.I'. (EK00025)

|Starts the session recording. |startRecording() |startRecording(DevRev.INSTANCE, context); |

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 🐶

Keep one space between words and punctuation in 'v.I'. (EK00025)

|Ends the session recording and uploads it to the portal. |stopRecording() |stopRecording(DevRev.INSTANCE); |

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 🐶

Keep one space between words and punctuation in 'v.I'. (EK00025)

|Pauses the ongoing session recording. |pauseRecording() |pauseRecording(DevRev.INSTANCE); |

Original file line number Diff line number Diff line change
Expand Up @@ -481,10 +481,37 @@ You can configure your app to receive push notifications from the DevRev SDK. Th

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

To receive push notifications, you need to configure your DevRev organization by following the instructions in the [push notifications](./push-notification) section.
To receive push notifications, you need to configure your DevRev organization by following the instructions below.

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

### Configure DevRev org

<Info>
**Prerequisites**

- Google Developer Account and Firebase project access
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 🐶

Must put the ending punctuation at the end of a list item. (EK00041)

Suggested change
- Google Developer Account and Firebase project access
- Google Developer Account and Firebase project access.

- Admin access to DevRev PLuG settings
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 🐶

Must put the ending punctuation at the end of a list item. (EK00041)

Suggested change
- Admin access to DevRev PLuG settings
- Admin access to DevRev PLuG settings.

- Access to Bundle ID, Team ID, and APNs/FCM keys
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 🐶

Must put the ending punctuation at the end of a list item. (EK00041)

Suggested change
- Access to Bundle ID, Team ID, and APNs/FCM keys
- Access to Bundle ID, Team ID, and APNs/FCM keys.

- Mobile SDK integration with your Android app
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 🐶

Must put the ending punctuation at the end of a list item. (EK00041)

Suggested change
- Mobile SDK integration with your Android app
- Mobile SDK integration with your Android app.

</Info>

1. Go to **Settings** > **Support** > **PLuG settings** > **Mobile push notifications**.

2. Click **+ Configure app** and select **Android App**.

3. Fill in the configuration form.

- **App name**: Your Android app's name.
- **Bundle ID**: Your app's unique identifier in reverse domain notation, such as, `com.example.app`. Refer to [Google’s documentation](https://developer.android.com/studio/build/application-id) to confirm your bundle ID.
- **Upload Service Account Key**: A Service Account Key JSON file (up to 10 MB) generated via Google Cloud for Firebase Cloud Messaging (FCM). Create this key following [Google’s documentation](https://firebase.google.com/docs/).

Click **Save App** to complete the setup.

4. Click **Save and Publish** to activate push notifications in your DevRev SDK.

For additional support or inquiries, refer to the latest [Android developer documentation](https://developer.android.com/) as guidelines may change.

### Register for push notifications

<Callout intent="note">
Expand Down
34 changes: 31 additions & 3 deletions fern/docs/pages/plug-sdk/ios.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -320,12 +320,40 @@ You can configure your app to receive push notifications from the DevRev SDK. Th

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

### Configuration

To receive push notifications, you need to configure your DevRev organization by following the instructions in the [push notifications](./push-notification) section.
To receive push notifications, you need to configure your DevRev organization by following the instructions below.

You need to ensure that your iOS app is configured to receive push notifications. You can follow the [Apple documentation](https://developer.apple.com/documentation/usernotifications/registering_your_app_with_apns) for guidance on registering your app with Apple Push Notification Service (APNs).

### Configure DevRev org

<Info>
**Prerequisites**

- Apple Developer Program access
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 🐶

Must put the ending punctuation at the end of a list item. (EK00041)

Suggested change
- Apple Developer Program access
- Apple Developer Program access.

- Admin access to DevRev PLuG settings
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 🐶

Must put the ending punctuation at the end of a list item. (EK00041)

Suggested change
- Admin access to DevRev PLuG settings
- Admin access to DevRev PLuG settings.

- Access to Bundle ID, Team ID, and APNs/FCM keys
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 🐶

Must put the ending punctuation at the end of a list item. (EK00041)

Suggested change
- Access to Bundle ID, Team ID, and APNs/FCM keys
- Access to Bundle ID, Team ID, and APNs/FCM keys.

- Mobile SDK integration with your iOS app.
</Info>

1. Go to **Settings** > **Support** > **PLuG settings** > **Mobile push notifications**.

2. Click **+ Configure app** and select **iOS App**.

3. Fill in the configuration form.

- **App name**: Your iOS app's name.
- **Bundle ID**: The app's unique identifier in reverse domain notation, such as, `com.example.app`. Refer to [Apple's documentation](https://developer.apple.com/documentation/appstoreconnectapi/bundle_ids) to confirm your bundle ID.
- **Apple Team ID**: The 10-character Apple Team ID assigned to your organization. Details are available in [Apple's Team ID documentation](https://developer.apple.com/help/account/manage-your-team/locate-your-team-id/).
- **Key ID**: The ID for your APNs auth key. See [Apple's Key ID documentation](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/sending_notification_requests_to_apns) for further instructions.
- **Upload APNs Auth Key**: The `.p8` APNs auth key file (maximum size: 10 MB).
- **Sandbox Environment**: Check this for development environments to enable notifications in debug builds.

Click **Save App** to complete the setup.

4. Click **Save and Publish** to activate push notifications in your DevRev SDK.

For additional support or inquiries, refer to the latest [Apple developer documentation](https://developer.apple.com/) as guidelines may change.

### Register for push notifications

<Callout intent="note">
Expand Down
42 changes: 0 additions & 42 deletions fern/docs/pages/plug-sdk/push-notification.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions fern/versions/public.yml
Original file line number Diff line number Diff line change
Expand Up @@ -106,9 +106,6 @@ navigation:
slug: react-native
icon: fa-brands fa-react
path: ../docs/pages/plug-sdk/react-native.mdx
- page: Push notifications for mobile
slug: push-notification
path: ../docs/pages/plug-sdk/push-notification.mdx
- section: Snap-in development
slug: snapin-development
contents:
Expand Down
Loading