onesignal

KO | EN

gitlite — search

#python #hacktoberfest #typescript #go #android #machine-learning #rust #deep-learning #linux #docker #nodejs #macos #vue #security

(★ 20)

A Wrapper for OneSignal Push Notification Delivery for Node.js. Provides the minimal functionality to send notifications for iOS and Android.

onesignal 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# OneSignal

[![npm](https://img.shields.io/npm/v/onesignal.svg)](https://www.npmjs.com/package/onesignal)
[![npm](https://img.shields.io/npm/l/onesignal.svg)](https://github.com/faressoft/onesignal/blob/master/LICENSE)

A Wrapper for <a href="https://onesignal.com">OneSignal</a> Push Notification Delivery for Node.js. Provides the minimal functionality to send notifications for iOS and Android.

# Installation

```
npm install onesignal --save
```

# Usage

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

## OneSignal(apiKey, appId, sandbox)
OneSignal Client

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

## Methods

<dl>
<dt><a href="#addDevice">addDevice(identifier, osType)</a> ⇒ <code>Promise</code></dt>
<dd>Register a new device and its identifier to OneSignal and get OneSignal ID</dd>
<dt><a href="#editDevice">editDevice(oneSignalId, newIdentifier)</a> ⇒ <code>Promise</code></dt>
<dd>Update the identifier of an existing device</dd>
<dt><a href="#createNotification">createNotification(message, data, oneSignalIds)</a> ⇒ <code>Promise</code></dt>
<dd>Create and send a notification</dd>
</dl>

### addDevice(identifier, osType) ⇒ <code>Promise</code>
Register a new device and its identifier to OneSignal and get OneSignal ID.

**Returns**: <code>Promise</code> - resolve with OneSignal ID

| Param | Type | Description |
| --- | --- | --- |
| identifier | <code>String</code> | the device token |
| osType | <code>String</code> | ios, android |

### editDevice(oneSignalId, newIdentifier) ⇒ <code>Promise</code>
Update the identifier of an existing device.

| Param | Type | Description |
| --- | --- | --- |
| oneSignalId | <code>String</code> | the onesignal device id |
| newIdentifier | <code>String</code> | the new device token |

### createNotification(message, data, oneSignalIds) ⇒ <code>Promise</code>
Create and send a notification.

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

# License

This project is under the MIT license.

onesignal

onesignal 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

onesignal

onesignal 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README