Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Faast.io push notifications for Node.js
JavaScript
branch: develop

README.md

push-node

Faast push notification API module for node.js.

To use this module you need an account at Faast and set the API token from your account.

Example

Send a notification to yourself.

// setup
var faast = require('push-node')( 'API token' )

// notify
faast.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',
    run_command: 'http://example.net/12345'
  },
  console.log
)

Installation

Build Status

Stable: npm install push-node

Develop: npm install fvdm/nodejs-push#develop

Methods

The methods below take a callback function as last parameter. The callback receives two parameters err in case of an error and data.

function myCallback( err, data ) {
  if( err ) {
    console.log( err )
    console.log( err.stack )
  } else {
    console.log( data.id )
  }
}

faast.notify( props, myCallback )

Errors

message description
request failed The request cannot be made, see err.error
request closed The connection was closed too early
invalid response The API returned unparsable data
API error The API returned an error, see err.code and err.body

settings ( callback )

The user account details and settings.

faast.settings( console.log )

Output

{ fb_push_command: 0,
  facebook_paid: true,
  force_twitter_client: true,
  twitter_sound: 'S',
  unlocked: true,
  weekend_silent_mode_at: '2000/01/02 23:00:00 +0000',
  facebook_sound: '' }

notify ( vars, callback )

Send a notification to the user.

faast.notify(
  {
    message: 'Alert message',
    long_message: 'The message (also in preview if <b>long_message_preview</b> is not set)',
    title: 'Subject line',
    subtitle: 'Below the subject',
    long_message_preview: 'Preview text',
    action_loc_key: 'Alert Button'
  },
  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:27:00 +0000',
  id: 12345,
  favorite: false,
  hasread: false,
  message: 'Alert message',
  display_ads: false }

Fields

name description
message Alert message text
action_loc_key Alert button text
title Subject line
subtitle Below the subject
long_message HTML message content
(also in preview if long_message_preview is not set)
long_message_preview Preview text
run_command URL to open on 'action_loc_key' button
silent No alert window, just increase badge number
message_level Importance, -2 to 2
sound Alert sound ID,
see https://gist.github.com/penso/1217045
icon_url Notification icon URL

notifications ( callback )

Get a list (array) of notifications from the server.

faast.notifications( console.log )

Output

[ { thread_id: null,
    title: 'Subject line',
    send_at: '2012/07/11 19:34:15 +0000',
    app_id: null,
    long_message_preview: 'Preview text',
    subtitle: 'Below the subject',
    icon_url: null,
    id: 50103867 },
  { thread_id: null,
    title: 'Subject line',
    send_at: '2012/07/11 19:34:12 +0000',
    app_id: null,
    long_message_preview: 'Preview text',
    subtitle: 'Below the subject',
    icon_url: null,
    id: 50103866 } ]

destroyall ( callback )

Delete all notifications from the server. This won't touch the device(s) as they use a local cache.

faast.destroyall( console.log )

Output

{ Response: { OK: 'OK' } }

feeds ( callback )

Get a list (array) of subscribed RSS feeds.

faast.feeds( console.log )

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/

Something went wrong with that request. Please try again.