You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/pages/docs/platform/account/app/notifications.mdx
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,10 +57,10 @@ Important considerations:
57
57
- Device tokens are environment-specific and cannot be used interchangeably.
58
58
59
59
How to configure the sandbox endpoint:
60
-
1. In your Ably [dashboard](https://ably.com/accounts), navigate to the **Notifications** tab under your app settings.
60
+
1. In the Ably [dashboard](https://ably.com/accounts), navigate to the **Notifications** tab under app settings.
61
61
2. Go to **push notifications setup** and click **configure push**.
62
62
3. In the **Apple push notification service** section, look for the **sandbox endpoint** option.
63
-
4. Enable the sandbox endpoint checkbox if you want to use Apple's testing environment.
63
+
4. Enable the sandbox endpoint checkbox to use Apple's testing environment.
64
64
5. Click **save** to apply the changes.
65
65
66
66
This separation between sandbox and production environments ensures that test notifications don't reach real users and provides a safe environment for development and testing.
@@ -79,26 +79,26 @@ Define the content of your push notification using the fields below:
79
79
80
80
| Field | Purpose | How to Use |
81
81
| ----- | ------- | ---------- |
82
-
|**Notification title**| A title for the push notification, which will appear as the headline on the user's device. | Enter a short, clear title that captures the essence of the notification. |
83
-
|**Notification body**| The main content of the notification to be displayed below the title. | Write the key information or message that you want the user to read. |
84
-
|**Notification data**| Optional JSON data that the app can use for specific actions upon receiving the notification. | Include any extra data needed for app functionality, such as custom metadata or instructions. |
82
+
| Notification title | A title for the push notification, which will appear as the headline on the user's device. | Enter a short, clear title that captures the essence of the notification. |
83
+
| Notification body | The main content of the notification to be displayed below the title. | Write the key information or message that you want the user to read. |
84
+
| Notification data | Optional JSON data that the app can use for specific actions upon receiving the notification. | Include any extra data needed for app functionality, such as custom metadata or instructions. |
85
85
86
86
### Push notification target
87
87
88
88
Direct your push notifications to specific targets within the Ably platform. Select the appropriate target according to your notification strategy:
89
89
90
90
| Target | Purpose | How to Use |
91
91
| ------ | ------- | ---------- |
92
-
|**Channel name**| Push notifications to all subscribers of a specific channel. | Enter the channel name and click **push to channel** to notify all devices subscribed to that channel. |
93
-
|**Device ID**| Send a notification directly to a specific device. | Enter the Device ID and click **push to device** to target a single device with the notification. |
94
-
|**Client ID**| Notify a specific client registered with Ably. | Enter the Client ID and click **push to client** to send the notification to the chosen client. |
92
+
| Channel name | Push notifications to all subscribers of a specific channel. | Enter the channel name and click push to channel to notify all devices subscribed to that channel. |
93
+
| Device ID | Send a notification directly to a specific device. | Enter the Device ID and click push to device to target a single device with the notification. |
94
+
| Client ID | Notify a specific client registered with Ably. | Enter the Client ID and click push to client to send the notification to the chosen client. |
95
95
96
96
## Push inspector widget
97
97
98
98
The Push Inspector widget allows you to monitor and manage your push notification infrastructure directly from the Ably dashboard. It provides insights into channel subscriptions, device registrations, and client registrations, making it easier to debug and optimize your notification setup.
99
99
100
100
| Section | Purpose | How to Use |
101
101
| ------- | ------- | ---------- |
102
-
|**Channel subscriptions**| View and inspect all channels currently subscribed to push notifications. | Click **inspect channel** to see detailed information about a specific channel, including the number of subscribers and recent activity. |
103
-
|**Device registrations**| Access a list of all devices registered to receive push notifications. | Click **inspect device** to view detailed information about a specific device, such as its registration status, platform, and recent notifications. |
104
-
|**Client registrations**| Get an overview of all clients registered for push notifications within your Ably account. | Click **inspect client ID** to see detailed information about a specific client, including its subscriptions and recent activity. |
102
+
| Channel subscriptions | View and inspect all channels currently subscribed to push notifications. | Click inspect channel to see detailed information about a specific channel, including the number of subscribers and recent activity. |
103
+
| Device registrations | Access a list of all devices registered to receive push notifications. | Click inspect device to view detailed information about a specific device, such as its registration status, platform, and recent notifications. |
104
+
| Client registrations | Get an overview of all clients registered for push notifications within the Ably account. | Click inspect client ID to see detailed information about a specific client, including its subscriptions and recent activity. |
#### Manual device registration with cross-platform push services <aid="cross-platform"/>
472
472
473
-
In some scenarios, you may want to use FCM for iOS devices instead of APNs, or manually register devices with custom platform configurations. This is useful when you want to use Firebase's unified messaging system across both Android and iOS platforms.
473
+
In some scenarios, you may want to use FCM for iOS devices instead of APNs, or manually register devices with custom platform configurations. This is useful when using Firebase's unified messaging system across both Android and iOS platforms.
474
474
475
475
<Asidedata-type='important'>
476
476
When using manual device registration, be aware that the local device will default to APNs for iOS. You must explicitly set the platform and transport type to override this behavior.
Copy file name to clipboardExpand all lines: src/pages/docs/push/index.mdx
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,9 +19,9 @@ Push notifications notify user devices or browsers regardless of whether an appl
19
19
20
20
You can publish push notifications to user devices or browsers [directly](/docs/push/publish/#direct-publishing) or [via channels](#via-channels).
21
21
22
-
**Publishing directly** sends push notifications to specific devices or browsers identified by unique identifiers, such as a `deviceId` or a `clientId`. This approach is akin to sending a personal message or alerts directly to an individual user's device or browser, bypassing the need for channel subscriptions. It excels in targeted and personalized communications, such as alerts specific to a user's actions, account notifications, or customized updates.
22
+
Publishing directly sends push notifications to specific devices or browsers identified by unique identifiers, such as a `deviceId` or a `clientId`. This approach is akin to sending a personal message or alerts directly to an individual user's device or browser, bypassing the need for channel subscriptions. It excels in targeted and personalized communications, such as alerts specific to a user's actions, account notifications, or customized updates.
23
23
24
-
**Publishing via channels** uses a [Pub/Sub](/docs/channels/messages) model. Messages are sent to channels to which multiple devices or browsers can subscribe. When a message is published to a channel, all devices or browsers subscribed to that channel receive the notification. This approach is particularly powerful for simultaneously publishing messages to multiple users.
24
+
Publishing via channels uses a [Pub/Sub](/docs/channels/messages) model. Messages are sent to channels to which multiple devices or browsers can subscribe. When a message is published to a channel, all devices or browsers subscribed to that channel receive the notification. This approach is particularly powerful for simultaneously publishing messages to multiple users.
Use the [push inspector](/docs/platform/account/app/notifications#push-inspector) in your dashboard to send test notifications directly to your device.
126
+
Use the [push inspector](/docs/platform/account/app/notifications#push-inspector) in the dashboard to send test notifications directly to the device.
127
127
128
128
### Check for errors
129
129
@@ -143,7 +143,7 @@ Web Push:
143
143
144
144
### Duplicate notifications
145
145
146
-
If you're receiving duplicate push notifications for the same device, this typically occurs when a device has both a `deviceId` and `clientId` subscription to the same channel:
146
+
If receiving duplicate push notifications for the same device, this typically occurs when a device has both a `deviceId` and `clientId` subscription to the same channel:
147
147
148
148
-`deviceId` subscriptions deliver notifications to a single specific device.
149
149
-`clientId` subscriptions deliver notifications to all devices sharing that client ID.
Copy file name to clipboardExpand all lines: src/pages/docs/push/publish.mdx
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1348,21 +1348,21 @@ channel.publish(message);
1348
1348
1349
1349
## Handling push notifications on devices <aid="handling-push-notifications"/>
1350
1350
1351
-
After Ably delivers push notifications to devices, your mobile application needs to handle them appropriately. This includes processing the notification content, navigating users to relevant sections of your app, and implementing deep linking functionality.
1351
+
After Ably delivers push notifications to devices, mobile applications need to handle them appropriately. This includes processing the notification content, navigating users to relevant sections of the app, and implementing deep linking functionality.
1352
1352
1353
1353
### Deep links and app navigation <aid="deep-links"/>
1354
1354
1355
-
Deep links allow push notifications to navigate users directly to specific screens or content within your mobile application. While Ably handles the delivery of push notifications, creating and handling deep links is implemented within your mobile app code.
1355
+
Deep links allow push notifications to navigate users directly to specific screens or content within mobile applications. While Ably handles the delivery of push notifications, creating and handling deep links is implemented within mobile app code.
1356
1356
1357
-
You don't create deep links using Ably itself. Instead, you handle deep links in your app's push notification receivers and use the notification data to determine where to navigate users.
1357
+
Deep links are not created using Ably itself. Instead, handle deep links in app push notification receivers and use the notification data to determine where to navigate users.
1358
1358
1359
1359
#### Android deep linking with push notifications
1360
1360
1361
-
On Android, you can implement deep links and app navigation in several ways.
1361
+
On Android, implement deep links and app navigation in several ways.
1362
1362
1363
1363
Using `onMessageReceived` (recommended):
1364
1364
1365
-
Handle push notifications in your `FirebaseMessagingService` and create deep links programmatically:
1365
+
Handle push notifications in `FirebaseMessagingService` and create deep links programmatically:
0 commit comments