@webgap/notifier

WebGAP Notifier

README

This is the WebGAP Notifications Management module.
Handles abstraction for multiple notification mechanisms.

Dependencies

Handles logging using @webgap/logger.
Handles objects using @webgap/object-utils.
Handles date format using @webgap/format-utils.
Loads default configuration using @webgap/configuration.
Generates IDs using node-uuid.
Handles Strings using string.

Requirements

A configuration file must exist (check @webgap/configuration documentation).

API

Installation

npm install @webgap/notifier --save

Usage

var Notifier = require('@webgap/notifier').Notifier,
    Notification = Notifier.Notification,
    Message = Notification.Message,
    notifier = new Notifier();

// create Email Notification System Class 
function EmailSystem() {}
// EmailSystem must implement a notify function
EmailSystem.prototype.notify = function (options, callback) {
  console.log('\nEmail system send message: ' + JSON.stringify(options.notification));
  return callback();
};

// register the system
notifier.register('EMAIL', EmailSystem);
...
// register as many systems as you want - notifier.register('OTHER', OtherSystem);
...
// set a default system for most common notification mechanism
notifier.setDefaultNotificationSystem({notificationSystem: notifier.systems.EMAIL});

// create notification
var notification = new Notification({
  userId: 'id of the user to notify', 
  message: new Message({
    key: 'messages.error.text',
    data: { errorCode: 111 }
  })
});

// notify using the default system
notifier.notify({notification: notification}, function callback(err) {
  err && console.log(err);
});
...
// notify using specific(s) system(s)
notifier.notify({notificationSystems: [notifier.systems.EMAIL, notifier.systems.OTHER], notification: notification}, function callback(err) {
  err && console.log(err);
});

License

Apache License, Version 2.0