-
Notifications
You must be signed in to change notification settings - Fork 3
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [EkLine] reported by reviewdog 🐶
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [EkLine] reported by reviewdog 🐶
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [EkLine] reported by reviewdog 🐶
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [EkLine] reported by reviewdog 🐶
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -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 | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [EkLine] reported by reviewdog 🐶
Suggested change
|
||||||
- Admin access to DevRev PLuG settings | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [EkLine] reported by reviewdog 🐶
Suggested change
|
||||||
- Access to Bundle ID, Team ID, and APNs/FCM keys | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [EkLine] reported by reviewdog 🐶
Suggested change
|
||||||
- Mobile SDK integration with your Android app | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [EkLine] reported by reviewdog 🐶
Suggested change
|
||||||
</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"> | ||||||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -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 | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [EkLine] reported by reviewdog 🐶
Suggested change
|
||||||
- Admin access to DevRev PLuG settings | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [EkLine] reported by reviewdog 🐶
Suggested change
|
||||||
- Access to Bundle ID, Team ID, and APNs/FCM keys | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [EkLine] reported by reviewdog 🐶
Suggested change
|
||||||
- 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"> | ||||||
|
This file was deleted.
There was a problem hiding this comment.
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)
fern-api-docs/fern/docs/pages/plug-sdk/android.mdx
Line 5 in 24a96ac