# pushwoosh-client

> A node js client to consume the Pushwoosh API to send push notifications to mobile devices

Latest version **1.5.0** (published 2017-10-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install pushwoosh-client
pnpm add pushwoosh-client
yarn add pushwoosh-client
bun add pushwoosh-client
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.5.0 |
| Published | 2017-10-26 |
| First published | 2015-03-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Nick Luo |
| Maintainers | yoik, nick.luo, mauricebutler |
| Keywords | PushWoosh, Push Woosh, Push, notifications |

## Links

- npm: https://www.npmjs.com/package/pushwoosh-client
- Repository: https://github.com/nluo/pushwoosh-node-client
- Homepage: https://github.com/nluo/pushwoosh-node-client#readme
- Issues: https://github.com/nluo/pushwoosh-node-client/issues
- npm.io page: https://npm.io/package/pushwoosh-client

## Dependencies (1)

- [request](https://npm.io/package/request.md) ^2.54.0

## Alternatives

- [update-check](https://npm.io/package/update-check.md) — 4.0M weekly downloads
- [react-native-onesignal](https://npm.io/package/react-native-onesignal.md) — 134.5K weekly downloads
- [react-redux-toastr](https://npm.io/package/react-redux-toastr.md) — 33.7K weekly downloads
- [@nocobase/plugin-notification-manager](https://npm.io/package/@nocobase/plugin-notification-manager.md) — 2.0K weekly downloads
- [react-simple-toasts](https://npm.io/package/react-simple-toasts.md) — 1.9K weekly downloads

## Recent versions

- 1.5.0 (latest) — 2017-10-26
- 1.4.0 — 2016-12-23
- 1.3.1 — 2016-11-20
- 1.3.0 — 2016-07-29
- 1.2.1 — 2016-02-02
- 1.2.0 — 2015-10-15
- 1.1.1 — 2015-07-09
- 1.1.0 — 2015-07-09
- 1.0.3 — 2015-06-17
- 1.0.2 — 2015-04-02
- 1.0.1 — 2015-04-01
- 1.0.0 — 2015-03-31

## README

# pushwoosh-node-client

[![Build Status](https://travis-ci.org/nluo/pushwoosh-node-client.svg?branch=master)](https://travis-ci.org/nluo/pushwoosh-node-client) [![Join the chat at https://gitter.im/nluo/pushwoosh-node-client](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/nluo/pushwoosh-node-client?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

A node js client to consume the Pushwoosh API to send push notifications to mobile devices

## Quick Reference

#### Installation

    npm i pushwoosh-client --save


#### Send message to all devices

```javascript
var Pushwoosh = require('pushwoosh-client');
var client= new Pushwoosh("AppCode", "AuthToken");

client.sendMessage('Hello world', function(error, response) {
     if (error) {
        console.log('Some error occurs: ', error);
     }

     console.log('Pushwoosh API response is', response);
});
```

#### To a specific device or devices
To send messages to a specificed device or devices, you can pass a device token or an arrays with devices

```javascript
// Push to a device
client.sendMessage('Hello world', 'device token', function(error, response) {
     ...
});
// Push to multiple devices
client.sendMessage('Hello world', ['deviceToken1', 'deivceToken2'], function(error, response) {
     ...
});
```

#### Configure option if we don't want to send to all devices by default
By default, if we don't provide the device params, it will send push notifications to all devices. Sometimes this might not be what we want.

If we initialise Pushwoosh Client with `shouldSendToAllDevices` to `false`, then it will NOT send push notifications and return a callback error if we did not provide any device/devices.

```javascript
var Pushwoosh = require('pushwoosh-client');
var client= new Pushwoosh("AppsGroupCode", "AuthToken", {
    shouldSendToAllDevices: false
});

client.sendMessage('Hello world', function(error, response) {
     // We will get error here as we don't have any device/devices provided
});
```

Note: `shouldSendToAllDevices` is set to `true` if we don't configure it in option 

#### Extra options/payload
To pass extra options (please refer to the Pushwoosh [doc](http://docs.pushwoosh.com/docs/createmessage) for the available options) , you could define an option object and pass it to the function as a 2nd or 3rd parameter. E.g. if you want to pass addtional payload to the device, you could do:

```javascript
var Pushwoosh = require('pushwoosh-client'),
    client= new Pushwoosh("AppCode", "AuthToken"),
    options = {
        data: {
            username: 'bob smith',
            email: 'bob@example.com'
        }
    };
    client.sendMessage('Hello world', 'device token', options, function(error, response) {
     ...
    });
```
Note that if you define devices or content in the options, the devices and message will be overwritten.
```javascript
var options = {
        data: {
            username: 'bob smith',
            email: 'bob@example.com'
        },
        devices: ['deviceToken1', 'deviceToken2', 'deviceToken3']
    };
client.sendMessage('Hello world', 'device token', options, function(error, response) {
     ...
});
```
Then this will send to ['deviceToken1', 'deviceToken2', 'deviceToken3'] as defined in options.  so you probably just want to just do
```javascript
client.sendMessage('Hello world', options, function(error, response) {
    ...
});
```

#### Applications group
To use Puswoosh `applications_group` code(which allows you to send to multilple applications) instead of `application` code, you must pass a third `options` argument when creating the client with `useApplicationsGroup` set to true:
```javascript
var Pushwoosh = require('pushwoosh-client');
var client= new Pushwoosh("AppsGroupCode", "AuthToken", {
    useApplicationsGroup: true,
    ...
});

// Will push using "applications_group":"AppsGroupCode" for all of the explained invocation patterns
client.sendMessage('Hello world', function(error, response) {
     ...
});
// or
client.sendMessage('Hello world', options, function(error, response) {
    ...
});
// ... and so on
```

#### Register device
To register a device's push token in Pushwoosh:
```javascript
var Pushwoosh = require('pushwoosh-client');
var client= new Pushwoosh('AppCode', 'AuthToken');

var registerDeviceOptions = {
    push_token: 'pushtoken',
    hwid: 'hwid',
    device_type: 3,
    language: 'en', // optional, two-letter code ISO-639-1
    timezone: -3600 // optional, offset in seconds
};

// this will register the device for the client's 'AppCode' application
client.registerDevice(registerDeviceOptions, function(error, response) {
     ...
});
```

#### Unregister device
To unregister a device in Pushwoosh:
```javascript
var Pushwoosh = require('pushwoosh-client');
var client= new Pushwoosh('AppCode', 'AuthToken');

var unregisterDeviceOptions = {
    hwid: 'hwid'
};

// this will unregister the device from the client's 'AppCode' application
client.unregisterDevice(unregisterDeviceOptions, function(error, response) {
     ...
});
```

#### Set tags for device
To set tags for a device in Pushwoosh:
```javascript
var Pushwoosh = require('pushwoosh-client');
var client= new Pushwoosh('AppCode', 'AuthToken');
 
var setTagsOptions = {
    hwid: 'hwid',
    tags: {
        price: "1.99",
        language: "pl"
    }
};
 
// this will set the device tags for the client's 'AppCode' application
client.setTags(setTagsOptions , function(error, response) {
    ...
});
```
 
#### Get tags for device
To get tags for a device from Pushwoosh:
```javascript
var Pushwoosh = require('pushwoosh-client');
var client= new Pushwoosh('AppCode', 'AuthToken');

var getTagsOptions = {
    hwid: 'hwid'
};

// this will get the device tags for the client's 'AppCode' application
client.getTags(getTagsOptions , function(error, response) {
    ...
});
```

### Tests

    npm test

Currently tests are all passed and with 100% coverage

---
_Source: https://npm.io/package/pushwoosh-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._