Skip to content

Commit a584c1a

Browse files
authored
doc nits
1 parent 6b604c1 commit a584c1a

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

doc/provider.markdown

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -63,30 +63,30 @@ The `Provider` can continue to be used for sending notifications and the counter
6363

6464
## Class: apn.Provider
6565

66-
`apn.Provider` provides a number of methods for sending notifications, broadcasting notifications, and managing channels. Calling any of the methods will return a `Promise` for each notification and is discussed more in [Results from APN Provider Methods](#results-from-apnprovider-methods).
66+
`apn.Provider` provides a number of methods for sending notifications, broadcasting notifications, and managing channels. Calling any of the methods will return a `Promise` for each notification, which is discussed more in [Results from APN Provider Methods](#results-from-apnprovider-methods).
6767

6868
### connection.send(notification, recipients)
6969

70-
This is the main interface for sending notifications. Create a `Notification` object and pass it in, along with a single recipient or an array of them and node-apn will take care of the rest, delivering a copy of the notification to each recipient.
70+
This is the main interface for sending notifications. Create a `Notification` object and pass it in, along with a single recipient or an array of them, and node-apn will take care of the rest, delivering a copy of the notification to each recipient.
7171

7272
> A "recipient" is a `String` containing the hex-encoded device token.
7373
7474
Calling `send` will return a `Promise`. The Promise will resolve after each notification (per token) has reached a final state.
7575

7676
### connection.manageChannels(notification, bundleId, action)
77-
This is the interface for managing broadcast channels. Create a single `Notification` object or an aray of them and pass the notification(s) in, along with a bundleId, and an action (`create`, `read`, `readAll`, `delete`) and node-apn will take care of the rest, asking the APNs to perform the action using the criteria specified in each notification.
77+
This is the interface for managing broadcast channels. Create a single `Notification` object or an array of them and pass the notification(s) in, along with a bundleId, and an action (`create`, `read`, `readAll`, `delete`) and node-apn will take care of the rest, asking the APNs to perform the action using the criteria specified in each notification.
7878

79-
> A "bundleId" is a `String` containing bundle identifier for the application.
79+
> A "bundleId" is a `String` containing the bundle identifier for the application.
8080
8181
> An "action" is a `String` containing: `create`, `read`, `readAll`, or `delete` and represents what action to perform with a channel (See more in [Apple Documentation](https://developer.apple.com/documentation/usernotifications/sending-channel-management-requests-to-apns)).
8282
8383
Calling `manageChannels` will return a `Promise`. The Promise will resolve after each notification has reached a final state.
8484

8585
### connection.broadcast(notification, bundleId)
8686

87-
This is the interface for broadcasting Live Activity notifications. Create a single `Notification` object or an aray of them and pass the notification(s) in, along with a bundleId and node-apn will take care of the rest, asking the APNs to broadcast using the criteria specified in each notification.
87+
This is the interface for broadcasting Live Activity notifications. Create a single `Notification` object or an array of them and pass the notification(s) in, along with a bundleId and node-apn will take care of the rest, asking the APNs to broadcast using the criteria specified in each notification.
8888

89-
> A "bundleId" is a `String` containing bundle identifier for the application.
89+
> A "bundleId" is a `String` containing the bundle identifier for the application.
9090
9191
Calling `broadcast` will return a `Promise`. The Promise will resolve after each notification has reached a final state.
9292

@@ -95,8 +95,8 @@ Calling `broadcast` will return a `Promise`. The Promise will resolve after each
9595
Each notification can end in one of three possible states:
9696

9797
- `sent` - the notification was accepted by Apple for delivery to the given recipient
98-
- `failed` (rejected) - the notification was rejected by Apple. A rejection has an associated `status` and `reason` which is included.
99-
- `failed` (error) - a connection-level error occurred which prevented successful communication with Apple. In very rare cases it's possible that the notification was still delivered. However, this state usually results from a network problem.
98+
- `failed` (rejected) - the notification was rejected by Apple. A rejection has an associated `status` and `reason` which are included.
99+
- `failed` (error) - a connection-level error occurred, which prevented successful communication with Apple. In very rare cases, it's possible that the notification was still delivered. However, this state usually results from a network problem.
100100

101101
When the returned `Promise` resolves, its value will be an Object containing two properties
102102

@@ -108,7 +108,7 @@ Being `sent` does **not** guarantee the notification will be _delivered_, other
108108

109109
#### failed
110110

111-
An array of objects for each failed token or bundle identifier. Each object will contain the device token or bundle identifier which failed and details of the failure which will differ between rejected and errored notifications.
111+
An array of objects for each failed token or bundle identifier. Each object will contain the device token or bundle identifier that failed and details of the failure, which will differ between rejected and errored notifications.
112112

113113
For **rejected** notifications using `send()`, the object will take the following form
114114

0 commit comments

Comments
 (0)