One Signal

Installation

npm install onesignal --save

Usage

// Create a client object
var oneSignal = require('onesignal')('[apiKey]', '[appId]', true);

OneSignal(apiKey, appId, sandbox)

One Signal Client

| Param | Type | Description | | --- | --- | --- | | apiKey | String | REST API Key | | appId | String | OneSignal App ID | | sandbox | Boolean | use the sandbox certificate for iOS (default: false) |

Methods

addDevice(identifier, osType) ⇒ Promise

Register a new device and its identifier to OneSignal and get OneSignal ID.

Returns: Promise - resolve with OneSignal ID

| Param | Type | Description | | --- | --- | --- | | identifier | String | the device token | | osType | String | ios, android |

editDevice(oneSignalId, newIdentifier) ⇒ Promise

Update the identifier of an existing device.

| Param | Type | Description | | --- | --- | --- | | oneSignalId | String | the one signal device id | | newIdentifier | String | the new device token |

createNotification(message, data, oneSignalIds) ⇒ Promise

Create and send a notification.

| Param | Type | Description | | --- | --- | --- | | message | String | the notification message | | data | Object | any custom data | | oneSignalIds | Array | a list of OneSignal devices ids |

License

This project is under the MIT license.