Permalink
Browse files

Lots of Doc. Some Notification helper methods.

  • Loading branch information...
argon committed Jun 16, 2012
1 parent 8490ab0 commit 5530d7d31053d933cbff064a35b763c44f5160fa
Showing with 370 additions and 114 deletions.
  1. +62 −27 README.md
  2. +75 −31 lib/connection.js
  3. +12 −47 lib/device.js
  4. +5 −0 lib/errors.js
  5. +52 −8 lib/feedback.js
  6. +163 −0 lib/notification.js
  7. +1 −1 package.json
View
@@ -15,7 +15,7 @@ Via [npm][]:
$ npm install apn
-As a submodule of your project
+As a submodule of your project (you will also need to install [q][q])
$ git submodule add http://github.com/argon/node-apn.git apn
$ git submodule update --init
@@ -30,35 +30,39 @@ As a submodule of your project
- Notification
- Device
- Feedback
-- errors
+- Errors
### Connecting
Create a new connection to the gateway server using a dictionary of options. The defaults are listed below:
var options = {
- cert: 'cert.pem', /* Certificate file */
- certData: null, /* Optional: if supplied uses this instead of Certificate File */
- key: 'key.pem', /* Key file */
- keyData: null, /* Optional: if supplied uses this instead of Key file */
- passphrase: null, /* Optional: A passphrase for the Key file */
+ cert: 'cert.pem', /* Certificate file path */
+ certData: null, /* String or Buffer containing certificate data, if supplied uses this instead of cert file path */
+ key: 'key.pem', /* Key file path */
+ keyData: null, /* String or Buffer containing key data, as certData */
+ passphrase: null, /* A passphrase for the Key file */
+ ca: null /* String or Buffer of CA data to use for the TLS connection */
gateway: 'gateway.push.apple.com',/* gateway address */
port: 2195, /* gateway port */
enhanced: true, /* enable enhanced format */
- errorCallback: undefined, /* Callback when error occurs */
- cacheLength: 5 /* Number of notifications to cache for error purposes */
+ errorCallback: undefined, /* Callback when error occurs function(err,notification) */
+ cacheLength: 100 /* Number of notifications to cache for error purposes */
};
var apnsConnection = new apns.Connection(options);
+
+**Important:** In a development environment you must set `gateway` to `gateway.sandbox.push.apple.com`.
### Sending a notification
-To send a notification first create a `Device` object. Pass it the device token as either a hexadecimal string, or alternatively as a `Buffer` object containing the binary token, setting the second argument to `false`.
+To send a notification first create a `Device` object. Pass it the device token as either a hexadecimal string, or alternatively as a `Buffer` object containing the token in binary form.
- var myDevice = new apns.Device(token /*, ascii=true*/);
+ var myDevice = new apns.Device(token);
-Next create a notification object and set parameters. See the [payload documentation][pl] for more details
+Next, create a notification object and set parameters. See the [payload documentation][pl] for more details.
var note = new apns.Notification();
+ note.expiry = 60;
note.badge = 3;
note.sound = "ping.aiff";
note.alert = "You have a new message";
@@ -67,32 +71,41 @@ Next create a notification object and set parameters. See the [payload documenta
apnsConnection.sendNotification(note);
+As of version 1.2.0 it is also possible to use a set of methods provided by Notification object (`setAlertText`, `setActionLocKey`, `setLocKey`, `setLocArgs`, `setLaunchImage`) to aid the creation of the alert parameters. For applications which provide Newsstand capability there is a new boolean parameter `note.newsstandAvailable` to specify `content-available` in the payload.
+
The above options will compile the following dictionary to send to the device:
{"messageFrom":"Caroline","aps":{"badge":3,"sound":"ping.aiff","alert":"You have a new message"}}
-\* N.B.: If you wish to send notifications containing emoji or other multi-byte characters you will need to set `note.encoding = 'ucs2'`. This tells node to send the message with 16bit characters, however it also means your message payload will be limited to 127 characters.
+**\*N.B.:** If you wish to send notifications containing emoji or other multi-byte characters you will need to set `note.encoding = 'ucs2'`. This tells node to send the message with 16bit characters, however it also means your message payload will be limited to 127 characters.
### Handling Errors
-If the enhanced binary interface is enabled and an error occurs when sending a message then subsequent messages will be automatically resent* and the connection will be re-established. If an `errorCallback` is also specified in the connection options then it will be invoked with 2 arguments.
+If the enhanced binary interface is enabled and an error occurs - as defined in Apple's documentation - when sending a message, then subsequent messages will be automatically resent* and the connection will be re-established. If an `errorCallback` is also specified in the connection options then it will be invoked with 2 arguments `(err, notification)`
+
+If a notification fails to be sent because a connection error occurs then the `errorCallback` will be called for each notification waiting for the connection which failed. In this case the first parameter will be an Error object instead of an error number.
+
+`errorCallback` will be called in 3 situations with the parameters shown.
-1. The error number as returned from Apple. This can be compared to the predefined values in the `Errors` object.
-1. The notification object as it existed when the notification was converted and sent to the server.
+1. The notification has been rejected by Apple (or determined to have an invalid device token or payload before sending) for one of the reasons shown in Table 5-1 [here][errors] `errorCallback(errorCode, notification)`
+1. A notification has been rejected by Apple but it has been removed from the cache so it is not possible to identify which. In this case subsequent notifications may be lost. **If this happens you should consider increasing your `cacheLength` value to prevent data loss** `errorCallback(255, null)`
+1. A connection error has occurred before the notification can be sent. `errorCallback(Error object, notification)`
+
+**\*N.B.:** The `cacheLength` option for the connection specifies the number of sent notifications which will be cached, on a FIFO basis for error handling purposes. If `cacheLength` is not set to a large enough value, then in high volume environments, a notification - possibly including some subsequent notifications - may be removed from the cache before Apple returns an error associated with it. In this case the `errorCallback` will still be called, but with a `null` notification and error code 255. If this happens you should consider increasing `cacheLength` to prevent losing notifications. All the notifications still residing in the cache will be resent automatically.
-\* N.B.: The `cacheLength` option specifies the number of sent notifications which will be cached for error handling purposes. At present if more than the specified number of notifications have been sent between the incorrect notification being sent and the error being received then no resending will occur. This is only envisaged within very high volume environments and a higher cache number might be desired.
### Setting up the feedback service
Apple recommends checking the feedback service periodically for a list of devices for which there were failed delivery attempts.
-Using the `Feedback` object it is possible to periodically query the server for the list. You should provide a function which will accept two arguments, the `time` returned by the server (epoch time) and a `Device` object containing the device token. You can also set the query interval in seconds. Again the default options are shown below.
+Using the `Feedback` object it is possible to periodically query the server for the list. You should provide a function `feedback` which will accept two arguments, the `time` returned by the server (epoch time) and a `Buffer` object containing the device token. You can also set the query interval in seconds. The default options are shown below.
var options = {
cert: 'cert.pem', /* Certificate file */
- certData: null, /* Certificate file contents */
+ certData: null, /* Certificate file contents (String|Buffer) */
key: 'key.pem', /* Key file */
- keyData: null, /* Key file contents */
- passphrase: null, /* Optional: A passphrase for the Key file */
+ keyData: null, /* Key file contents (String|Buffer) */
+ passphrase: null, /* A passphrase for the Key file */
+ ca: null, /* Certificate authority data to pass to the TLS connection */
address: 'feedback.push.apple.com', /* feedback address */
port: 2196, /* feedback port */
feedback: false, /* enable feedback service, set to callback */
@@ -101,11 +114,17 @@ Using the `Feedback` object it is possible to periodically query the server for
var feedback = new apns.Feedback(options);
+This will automatically start a timer to check with Apple every `interval` seconds. You can cancel the interval by calling `feedback.cancel()`. If you do not wish to have the service automatically queried then set `interval` to 0 and use `feedback.start()`.
+
+**Important:** In a development environment you must set `address` to `feedback.sandbox.push.apple.com`.
+
+More information about the feedback service can be found in the [feedback service documentation][fs].
+
## Converting your APNs Certificate
-After requesting the certificate from Apple export your private key as a .p12 file and download the .cer file from the iOS Provisioning Portal.
+After requesting the certificate from Apple, export your private key as a .p12 file and download the .cer file from the iOS Provisioning Portal.
-Now in the directory containing cert.cer and key.p12 execute the following commands to generate your .pem files:
+Now, in the directory containing cert.cer and key.p12 execute the following commands to generate your .pem files:
$ openssl x509 -in cert.cer -inform DER -outform PEM -out cert.pem
$ openssl pkcs12 -in key.p12 -out key.pem -nodes
@@ -114,12 +133,10 @@ If you are using a development certificate you may wish to name them differently
## Credits
-Written and maintained by [Andrew Naylor][mphys].
+Written and maintained by [Andrew Naylor][andrewnaylor].
Contributors: [Ian Babrou][bobrik], [dgthistle][dgthistle], [Keith Larsen][keithnlarsen], [Mike P][mypark]
-Special thanks to [Ben Noordhuis][bnoordhuis] for `invoke_after` code.
-
## License
Released under the MIT License
@@ -138,22 +155,40 @@ all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+[errors]:https://developer.apple.com/library/ios/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingWIthAPS/CommunicatingWIthAPS.html#//apple_ref/doc/uid/TP40008194-CH101-SW4 "The Binary Interface and Notification Formats"
[pl]: https://developer.apple.com/library/ios/#documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/ApplePushService/ApplePushService.html#//apple_ref/doc/uid/TP40008194-CH100-SW1 "Local and Push Notification Programming Guide: Apple Push Notification Service"
-[mphys]: http://mphys.com
+[fs]:https://developer.apple.com/library/ios/#documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingWIthAPS/CommunicatingWIthAPS.html#//apple_ref/doc/uid/TP40008194-CH101-SW3 "Communicating With APS"
+[andrewnaylor]: http://andrewnaylor.co.uk
[bnoordhuis]: http://bnoordhuis.nl
[npm]: https://github.com/isaacs/npm
[bobrik]: http://bobrik.name
[dgthistle]: https://github.com/dgthistle
[keithnlarsen]: https://github.com/keithnlarsen
[mypark]: https://github.com/mypark
+[q]: https://github.com/kriskowal/q
## Changelog
+1.2.0:
+
+* Complete rewrite of the connection handling.
+* [q][q] is now required.
+* Change in the error handling logic. When a notification errors and it cannot be found in the cache, then all notifications in the cache will be resent instead of being discarded.
+* `errorCallback` will also be invoked for connection errors.
+* New methods on `Notification` to aid settings the alert properties.
+* `content-available` can now be set for Newsstand applications by setting the `newsstandAvailable` property on the Notification object.
+* `Notification` objects now have a `.clone(device)` method to assist you in sending the same notification to multiple devices.
+* Included some js-doc tags in the source.
+* Device object now provides a `.toString()` method to return the hex representation of the device token.
+* Fixes #23, #28, #32, #34, #35, #40, #42
+
1.1.7:
+
* Fixes a problem with sockets being closed on transmission error causing EPIPE errors in node.
* Issues #29, #30
1.1.6:
+
* Fixes a regression from v1.1.5 causing connections to stall and messages to not be sent.
1.1.5:
Oops, something went wrong.

0 comments on commit 5530d7d

Please sign in to comment.