we-plugin-notification

2.0.1 • Public • Published

We.js Notification plugin

Send notifications to your users, this plugin is inspired in github notifications

Installation:

we i we-plugin-notification

API:

Authenticated user notifications is avaible at /notification page or API endpoint

How to register one new notification:

// after create register one notifications
we.db.models.notification.create({
  locale: res.locals.locale,
  // use i18n to localize your notification title after save like in this example
  title: res.locals.__('post.image.create.notification.title'),
  // text related to your notification, may be one teaser
  text: 'bla, bla, bla ... text here',
  // this url is used to redirect use to related content
  // add hostname for compatibility with emails
  redirectUrl: hostname+'/post/'+record.id,
  // user id of user how will be notified
  userId: 10,
  // user how did the notified action, optional
  actorId: actor.id,
  // model name, optional
  modelName: 'post',
  // model id, optional  
  modelId: record.id,
  // type may be used for show icons or 
  // custom css in your notification
  type: 'post-created-in-group'
}).then(function (r) {
  // done!
  // continue with your logic here ...
}).catch(done);

URLs

See plugin.js file

NPM Info:

NPM

License

the MIT license.

Readme

Keywords

Package Sidebar

Install

npm i we-plugin-notification

Weekly Downloads

1

Version

2.0.1

License

MIT

Unpacked Size

34.9 kB

Total Files

15

Last publish

Collaborators

  • albertosouza