Git Product home page Git Product logo

loopback-component-kue-push's Introduction

loopback-component-kue-push

A handy loopback component to send push notifications for iOS and Android using kue.

Installation

npm i loopback-component-kue-push --save

Configuration

Add a loopback-component-kue-push object to your project's component-config.json:

"loopback-component-kue-push": {
    "redis": {
      "host": "127.0.0.1",
      "port": 6379,
    },
    "pushSettings": {
      "apn": {
        "token": {
          "key": "./AuthKey.p8",
          "keyId": "<KEY_ID>",
          "teamId": "<TEAM_ID>"
        },
        "production": false,
      },
      "gcm": {
        "id": "<SERVER_KEY>"
      }
    }
  }

When no redis configuration is added, defults shown will be used.

For the actual push configuration (pushSettings) also see node-pushnotifications package.

Usage example

In your model.js you can send push notifications like this:

module.exports = function(Model) {

  Model.afterRemote('create', (context, next) => {

    var push = Model.app.push;

    push.send({
      token: ['TOKEN_1', 'TOKEN_2'], // string or array of push registration tokens
      message: {
        title: 'YEAH!',
        body: 'Such notification!',
        topic: 'com.example.app',
        sound: 'default',
      }
    }, (error, response) => {
      if (error) {
        // something went wrong adding the job to the que
        return console.error(error);
      }

      console.log(response);
    });

    next();

  });

};

For all options concerning the message (sound, badge count etc.) see the node-pushnotifications package documentation.

loopback-component-kue-push's People

Contributors

mahnuh avatar

Stargazers

Valentin avatar

Watchers

Valentin Klinghammer avatar James Cloos avatar  avatar Valentin avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.