bartt/node-nma

A Node.js library and CLI tool to send notifications via Notify My Android

node-nma

A Node.js library and CLI tool to send notifications via Notify My Android. This is a fork of Randall Gordon's node-nma. It provides the same functionality with a slightly different API. Callbacks are now handled by the promise returned by nma. Because of this breaking change, I've created a new npm package: nma-promise. It's version number reflects node-nma's ancestry.

Installation

If you want to use the CLI tool, Use the -g flag to install globally.

$ npm install [-g] nma-promise

Code Example

var nma = require("nma-promise");

nma({
  "apikey": "02cfc1a5f4e567929c31c13953e1adef247118562f148f7a",
  "application": "Your App",
  "event": "An Event",
  "description": "And a description of that event...",
  "priority": 0, // Priority
  "url": "http://www.somewebsite.com/",
  "content-type": "text/plain"
}).then(resolved_fn).catch(rejected_fn);

If the notification goes through without error resolved_fn will be called and receive an array of:

• Notify My Android's response object and
• the body of Notify My Android's response

In case of an error rejected_fn will be called and receive an array of:

• the Error encountered and
• Notify My Android's response object and
• the body of Notify My Android's response

Also, apikey can be a list of comma separated keys if you're using multiple keys.

CLI Usage

Follows the NMA API closely:

$ nma -k apikey -a application -e event -d description -p priority -u url -c content-type

Complete usage details via nma --help

Usage: nma [options]

Options:

  -h, --help                 output usage information
  -V, --version              output the version number
  -k, --apikey <key>         API key(s), separated by commas
  -a, --application <app>    Name of the application generating the notification
  -e, --event <event>        Subject of the notification
  -d, --description <desc>   Full text of the notification
  -p, --priority [0]         -2 = Very Low; -1 = Moderate; 0 = Normal; 1 = High; 2 = Emergency
  -u, --url <url>            URL/URI to associate with the notification
  -c, --content-type [type]  Set to "text/html" and basic html will be rendered while displaying the notification

License

MIT