push-node

nodejs-push

Push4 / App Notifications API module for Node.js.

To use this module you need an account at AppNotifications.com. To access your account details and push to yourself you need the API credential code which you find in your account settings.

Installation

Either get and load the code from Github:

git clone https://github.com/fvdm/nodejs-push.git

var apn = require('./nodejs-push')

Or install via NPM and load the code from wherever your modules are installed:

npm install push-node

var apn = require('push-node')

Usage

For now, while still beta, you can only access methods for your own account. For example, sending notifications to yourself or retrieving the list of notifications. To do this you need to set the api.credential setting, which can be found in your account settings.

Example

Send a notification to yourself.

var apn = require('push-node')

// authenticate
apn.api.credential = 'my API secret'

// notify
apn.account.notify(
	{
		message: 'Alert message',
		action_loc_key: 'Alert Button'
		title: 'Subject line',
		subtitle: 'Below the subject',
		long_message: 'The message (also in preview if <b>long_message_preview</b> is not set)',
		long_message_preview: 'Preview text',
	},
	console.log
)

Output:

{ title: 'Subject line',
  message_level: 0,
  long_message: 'The message (also in preview if <b>long_message_preview</b> is not set)',
  long_message_preview: 'Preview text',
  subtitle: 'Below the subject',
  send_at: '2012/07/11 19:07:32 +0000',
  id: 12344,
  favorite: false,
  hasread: false,
  message: 'Alert message',
  display_ads: false }

Unlicense

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

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

For more information, please refer to http://unlicense.org/