/* Copyright 2013-2014 appPlant UG Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ var exec = require('cordova/exec'), channel = require('cordova/channel'); // Called after 'deviceready' event channel.deviceready.subscribe( function () { // Device is ready now, the listeners are registered // and all queued events can be executed. exec(null, null, 'LocalNotification', 'deviceready', []); }); // Called before 'deviceready' event channel.onCordovaReady.subscribe( function () { // The cordova device plugin is ready now channel.onCordovaInfoReady.subscribe( function () { if (device.platform == 'Android') { channel.onPause.subscribe( function () { // Necessary to set the state to `background` exec(null, null, 'LocalNotification', 'pause', []); }); channel.onResume.subscribe( function () { // Necessary to set the state to `foreground` exec(null, null, 'LocalNotification', 'resume', []); }); // Necessary to set the state to `foreground` exec(null, null, 'LocalNotification', 'resume', []); } // Merges the platform specific properties into the default properties exports.applyPlatformSpecificOptions(); }); }); /** * @private * * Default values. */ exports._defaults = { message: '', title: '', autoCancel: false, badge: -1, id: '0', json: '', repeat: '' }; /** * Returns the default settings * * @return {Object} */ exports.getDefaults = function () { return this._defaults; }; /** * Overwrite default settings * * @param {Object} defaults */ exports.setDefaults = function (newDefaults) { var defaults = this.getDefaults(); for (var key in defaults) { if (newDefaults[key] !== undefined) { defaults[key] = newDefaults[key]; } } }; /** * Add a new entry to the registry * * @param {Object} props * The notification properties * @param {Function} callback * A function to be called after the notification has been canceled * @param {Object} scope * The scope for the callback function * * @return {Number} * The notification's ID */ exports.add = function (props, callback, scope) { var options = this.mergeWithDefaults(props), fn = this.createCallbackFn(callback, scope); this.convertOptions(options); if (['WinCE', 'Win32NT'].indexOf(device.platform) > -1) { fn = function (cmd) { eval(cmd); }; } this.registerPermission(function(granted) { if (granted) { this.exec('add', options, callback, scope); } }, this); return options.id; }; /** * Update existing notification specified by ID in options. * * @param {Object} options * The notification properties to update * @param {Function} callback * A function to be called after the notification has been updated * @param {Object} scope * The scope for the callback function */ exports.update = function (options, callback, scope) { this.exec('update', options, callback, scope); }; /** * Clears the specified notification. * * @param {String} id * The ID of the notification * @param {Function} callback * A function to be called after the notification has been cleared * @param {Object} scope * The scope for the callback function */ exports.clear = function (id, callback, scope) { var notId = (id || '0').toString(); this.exec('clear', notId, callback, scope); }; /** * Clears all previously sheduled notifications. * * @param {Function} callback * A function to be called after all notifications have been cleared * @param {Object} scope * The scope for the callback function */ exports.clearAll = function (callback, scope) { this.exec('clearAll', null, callback, scope); }; /** * Cancels the specified notification. * * @param {String} id * The ID of the notification * @param {Function} callback * A function to be called after the notification has been canceled * @param {Object} scope * The scope for the callback function */ exports.cancel = function (id, callback, scope) { var notId = (id || '0').toString(); this.exec('cancel', notId, callback, scope); }; /** * Removes all previously registered notifications. * * @param {Function} callback * A function to be called after all notifications have been canceled * @param {Object} scope * The scope for the callback function */ exports.cancelAll = function (callback, scope) { this.exec('cancelAll', null, callback, scope); }; /** * Retrieves a list with all currently pending notifications. * * @param {Function} callback * A callback function to be called with the list * @param {Object} scope * The scope for the callback function */ exports.getScheduledIds = function (callback, scope) { this.exec('getScheduledIds', null, callback, scope); }; /** * Checks wether a notification with an ID is scheduled. * * @param {String} id * The ID of the notification * @param {Function} callback * A callback function to be called with the list * @param {Object} scope * The scope for the callback function */ exports.isScheduled = function (id, callback, scope) { var notId = (id || '0').toString(); this.exec('isScheduled', notId, callback, scope); }; /** * Retrieves a list with all triggered notifications. * * @param {Function} callback * A callback function to be called with the list * @param {Object} scope * The scope for the callback function */ exports.getTriggeredIds = function (callback, scope) { this.exec('getTriggeredIds', null, callback, scope); }; /** * Checks wether a notification with an ID was triggered. * * @param {String} id * The ID of the notification * @param {Function} callback * A callback function to be called with the list * @param {Object} scope * The scope for the callback function */ exports.isTriggered = function (id, callback, scope) { var notId = (id || '0').toString(); this.exec('isTriggered', notId, callback, scope); }; /** * Informs if the app has the permission to show notifications. * * @param {Function} callback * The function to be exec as the callback * @param {Object?} scope * The callback function's scope */ exports.hasPermission = function (callback, scope) { var fn = this.createCallbackFn(callback, scope); if (device.platform != 'iOS') { fn(true); return; } exec(fn, null, 'LocalNotification', 'hasPermission', []); }; /** * Register permission to show notifications if not already granted. * * @param {Function} callback * The function to be exec as the callback * @param {Object?} scope * The callback function's scope */ exports.registerPermission = function (callback, scope) { var fn = this.createCallbackFn(callback, scope); if (device.platform != 'iOS') { fn(true); return; } exec(fn, null, 'LocalNotification', 'registerPermission', []); }; /** * @deprecated * * Register permission to show notifications if not already granted. * * @param {Function} callback * The function to be exec as the callback * @param {Object?} scope * The callback function's scope */ exports.promptForPermission = function (callback, scope) { console.warn( '`notification.local.promptForPermission` is deprecated,', 'please use `notification.local.registerPermission`.' ); exports.registerPermission.apply(this, arguments); }; /** * Add new entries to the registry (more than one) * * @param {Object} options * The notification properties * @param {Function} callback * A function to be called after the notification has been added * @param {Object} scope * The scope for the callback function * * @return {Number} * The notification's ID */ exports.addMultiple = function (notifications, callback, scope) { var length = notifications.length; var notificationsMerged = new Array(), callbackFn = this.createCallbackFn(callback, scope); for (var i=0;i -1) { callbackFn = function (cmd) { eval(cmd); }; } notificationsMerged.push(options); } cordova.exec(callbackFn, null, 'LocalNotification', 'addMultiple', notificationsMerged); return options.id; }; /** * Clear the specified notifications (more than one). * * @param {String} id * The ID of the notification * @param {Function} callback * A function to be called after the notifications has been cleared. * @param {Object} scope * The scope for the callback function */ exports.clearMultiple = function (ids, callback, scope) { var length = ids.length; var idArray = new Array(), callbackFn = this.createCallbackFn(callback, scope); for (var i=0;i