Skip to content

Commit dc7471b

Browse files
Tidy up commit
1 parent 53e5f8a commit dc7471b

File tree

4 files changed

+34
-34
lines changed

4 files changed

+34
-34
lines changed

src/pages/docs/platform/account/app/notifications.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,10 @@ Important considerations:
5757
- Device tokens are environment-specific and cannot be used interchangeably.
5858

5959
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.
6161
2. Go to **push notifications setup** and click **configure push**.
6262
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.
6464
5. Click **save** to apply the changes.
6565

6666
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:
7979

8080
| Field | Purpose | How to Use |
8181
| ----- | ------- | ---------- |
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. |
8585

8686
### Push notification target
8787

8888
Direct your push notifications to specific targets within the Ably platform. Select the appropriate target according to your notification strategy:
8989

9090
| Target | Purpose | How to Use |
9191
| ------ | ------- | ---------- |
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. |
9595

9696
## Push inspector widget
9797

9898
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.
9999

100100
| Section | Purpose | How to Use |
101101
| ------- | ------- | ---------- |
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. |

src/pages/docs/push/configure/device.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -470,7 +470,7 @@ private ClientOptions GetAblyOptions(string clientId)
470470

471471
#### Manual device registration with cross-platform push services <a id="cross-platform"/>
472472

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

475475
<Aside data-type='important'>
476476
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.
@@ -534,11 +534,11 @@ deviceDetails.push.recipient = @{
534534
```
535535
</Code>
536536
537-
This approach allows you to:
538-
- Use FCM for both Android and iOS devices for unified push messaging.
539-
- Override the default platform-specific push service assignments.
540-
- Maintain full control over device registration parameters.
541-
- Integrate with Firebase's analytics and other services across platforms.
537+
This approach allows:
538+
- Using FCM for both Android and iOS devices for unified push messaging.
539+
- Overriding the default platform-specific push service assignments.
540+
- Maintaining full control over device registration parameters.
541+
- Integration with Firebase's analytics and other services across platforms.
542542
543543
#### Test your push notification activation <a id="test-push"/>
544544

src/pages/docs/push/index.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ Push notifications notify user devices or browsers regardless of whether an appl
1919

2020
You can publish push notifications to user devices or browsers [directly](/docs/push/publish/#direct-publishing) or [via channels](#via-channels).
2121

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

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

2626
## Push notification process
2727

@@ -110,20 +110,20 @@ channel.subscribe(msg => console.log(msg));
110110

111111
## Troubleshooting push notifications <a id="troubleshooting"/>
112112

113-
If you're not receiving expected push notifications, follow these debugging steps:
113+
If not receiving expected push notifications, follow these debugging steps:
114114

115115
### Verify device registration
116116

117-
Check if your device is registered in the Ably dashboard:
117+
Check if the device is registered in the Ably dashboard:
118118
1. Go to Notifications tab → Device inspector
119-
2. Search for your device using `deviceId` or `clientId`
119+
2. Search for the device using `deviceId` or `clientId`
120120
3. Verify device state:
121121
- ACTIVE: Ready to receive notifications
122122
- FAILED: Check error details (common: registration expired, invalid token)
123123

124124
### Test delivery
125125

126-
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.
127127

128128
### Check for errors
129129

@@ -143,7 +143,7 @@ Web Push:
143143

144144
### Duplicate notifications
145145

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:
147147

148148
- `deviceId` subscriptions deliver notifications to a single specific device.
149149
- `clientId` subscriptions deliver notifications to all devices sharing that client ID.

src/pages/docs/push/publish.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1348,21 +1348,21 @@ channel.publish(message);
13481348

13491349
## Handling push notifications on devices <a id="handling-push-notifications"/>
13501350

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

13531353
### Deep links and app navigation <a id="deep-links"/>
13541354

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

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

13591359
#### Android deep linking with push notifications
13601360

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

13631363
Using `onMessageReceived` (recommended):
13641364

1365-
Handle push notifications in your `FirebaseMessagingService` and create deep links programmatically:
1365+
Handle push notifications in `FirebaseMessagingService` and create deep links programmatically:
13661366

13671367
```java
13681368
@Override
@@ -1388,9 +1388,9 @@ private Intent createDeepLinkIntent(String screen, Map<String, String> data) {
13881388

13891389
Using `click_action` with intent filters:
13901390

1391-
Specify a `click_action` in your push notification payload and handle it with intent filters:
1391+
Specify a `click_action` in the push notification payload and handle it with intent filters:
13921392

1393-
1. Add `click_action` to your notification payload when publishing via Ably:
1393+
1. Add `click_action` to the notification payload when publishing via Ably:
13941394

13951395
```json
13961396
{
@@ -1408,7 +1408,7 @@ Specify a `click_action` in your push notification payload and handle it with in
14081408
}
14091409
```
14101410

1411-
2. Configure intent filters in your `AndroidManifest.xml`:
1411+
2. Configure intent filters in `AndroidManifest.xml`:
14121412
```xml
14131413
<activity android:name=".ChatActivity">
14141414
<intent-filter>
@@ -1420,7 +1420,7 @@ Specify a `click_action` in your push notification payload and handle it with in
14201420

14211421
#### iOS deep linking with push notifications
14221422

1423-
On iOS, handle deep links in your app delegate or scene delegate:
1423+
On iOS, handle deep links in the app delegate or scene delegate:
14241424

14251425
Using URL schemes:
14261426
```swift
@@ -1449,7 +1449,7 @@ private func navigateToScreen(_ screen: String, with data: [AnyHashable: Any]) {
14491449
```
14501450

14511451
Using Universal Links:
1452-
Configure universal links in your app and handle them when users tap on push notifications:
1452+
Configure universal links in the app and handle them when users tap on push notifications:
14531453

14541454
```swift
14551455
func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool {

0 commit comments

Comments
 (0)