1. module phonegap-plugin-push
   1. object phonegap-plugin-push.cordova
   2. object phonegap-plugin-push.push
2. module phonegap-plugin-push.cordova
   1. function phonegap-plugin-push.cordova.require (moduleId)
   2. object phonegap-plugin-push.cordova.required
3. module phonegap-plugin-push.push
   1. function phonegap-plugin-push.push.PushNotification (options)
   2. function phonegap-plugin-push.push.hasPermission (successCallback, errorCallback)
   3. function phonegap-plugin-push.push.init (options)

module phonegap-plugin-push

module phonegap-plugin-push.cordova

function phonegap-plugin-push.cordova.require (moduleId)

• description and source-code

  require = function (moduleId) {
      // define a default function if it doesn't exist
      if (!cordova.required[moduleId]) {
          cordova.required[moduleId] = function() {};
      }
      // create a new module mapping between the module Id and cordova.required.
      return new ModuleMap(moduleId);
  }

• example usage

  ...
  /* global cordova:false */
  /* globals window */
  
  /*!
  * Module dependencies.
  */
  
  var exec = cordova.require('cordova/exec');
  
  /**
  * PushNotification constructor.
  *
  * @param {Object} options to initiate Push Notifications.
  * @return {PushNotification} instance that can be monitored and cancelled.
  */
  ...

module phonegap-plugin-push.push

function phonegap-plugin-push.push.PushNotification (options)

• description and source-code

  PushNotification = function (options) {
      this._handlers = {
          'registration': [],
          'notification': [],
          'error': []
      };
  
      // require options parameter
      if (typeof options === 'undefined') {
          throw new Error('The options argument is required.');
      }
  
      // store the options to this object instance
      this.options = options;
  
      // triggered on registration and notification
      var that = this;
      var success = function(result) {
          if (result && typeof result.registrationId !== 'undefined') {
              that.emit('registration', result);
          } else if (result && result.additionalData && typeof result.additionalData.actionCallback !== 'undefined') {
              var executeFuctionOrEmitEventByName = function(callbackName, context, arg) {
                var namespaces = callbackName.split('.');
                var func = namespaces.pop();
                for (var i = 0; i < namespaces.length; i++) {
                  context = context[namespaces[i]];
                }
  
                if (typeof context[func] === 'function') {
                  context[func].call(context, arg);
                } else {
                  that.emit(callbackName, arg);
                }
              };
  
              executeFuctionOrEmitEventByName(result.additionalData.actionCallback, window, result);
          } else if (result) {
              that.emit('notification', result);
          }
      };
  
      // triggered on error
      var fail = function(msg) {
          var e = (typeof msg === 'string') ? new Error(msg) : msg;
          that.emit('error', e);
      };
  
      // wait at least one process tick to allow event subscriptions
      setTimeout(function() {
          exec(success, fail, 'PushNotification', 'init', [options]);
      }, 10);
  }

• example usage

  n/a

function phonegap-plugin-push.push.hasPermission (successCallback, errorCallback)

• description and source-code

  hasPermission = function (successCallback, errorCallback) {
      exec(successCallback, errorCallback, 'PushNotification', 'hasPermission', []);
  }

• example usage

  n/a

function phonegap-plugin-push.push.init (options)

• description and source-code

  init = function (options) {
      return new PushNotification(options);
  }

• example usage

  n/a