cordova-plugin-local-notifications/www/local-notification-util.js

/*
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apache License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://opensource.org/licenses/Apache-2.0/ and read it before using this
 * file.
 *
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 */

// var exec    = require('cordova/exec'),
//     channel = require('cordova/channel');


// /***********
//  * MEMBERS *
//  ***********/

// // Default values
// exports._defaults = {
//     text:  '',
//     title: '',
//     sound: 'res://platform_default',
//     badge: 0,
//     id:    0,
//     data:  undefined,
//     every: undefined,
//     at:    undefined
// };

// // listener
// exports._listener = {};


// /********
//  * UTIL *
//  ********/

// /**
//  * Merge platform specific properties into the default ones.
//  *
//  * @return {Object}
//  *      The default properties for the platform
//  */
// exports.applyPlatformSpecificOptions = function () {
//     var defaults = this._defaults;

//     switch (device.platform) {
//     case 'Android':
//         defaults.icon      = 'res://ic_popup_reminder';
//         defaults.smallIcon = undefined;
//         defaults.ongoing   = false;
//         defaults.autoClear = true;
//         defaults.led       = undefined;
//         defaults.color     = undefined;
//         break;
//     }

//     return defaults;
// };

// /**
//  * Merge custom properties with the default values.
//  *
//  * @param {Object} options
//  *      Set of custom values
//  *
//  * @retrun {Object}
//  *      The merged property list
//  */
// exports.mergeWithDefaults = function (options) {
//     var defaults = this.getDefaults();

//     options.at   = this.getValueFor(options, 'at', 'firstAt', 'date');
//     options.text = this.getValueFor(options, 'text', 'message');
//     options.data = this.getValueFor(options, 'data', 'json');

//     if (defaults.hasOwnProperty('autoClear')) {
//         options.autoClear = this.getValueFor(options, 'autoClear', 'autoCancel');
//     }

//     if (options.autoClear !== true && options.ongoing) {
//         options.autoClear = false;
//     }

//     if (options.at === undefined || options.at === null) {
//         options.at = new Date();
//     }

//     for (var key in defaults) {
//         if (options[key] === null || options[key] === undefined) {
//             if (options.hasOwnProperty(key) && ['data','sound'].indexOf(key) > -1) {
//                 options[key] = undefined;
//             } else {
//                 options[key] = defaults[key];
//             }
//         }
//     }

//     for (key in options) {
//         if (!defaults.hasOwnProperty(key)) {
//             delete options[key];
//             console.warn('Unknown property: ' + key);
//         }
//     }

//     return options;
// };

// /**
//  * Convert the passed values to their required type.
//  *
//  * @param {Object} options
//  *      Set of custom values
//  *
//  * @retrun {Object}
//  *      The converted property list
//  */
// exports.convertProperties = function (options) {

//     if (options.id) {
//         if (isNaN(options.id)) {
//             options.id = this.getDefaults().id;
//             console.warn('Id is not a number: ' + options.id);
//         } else {
//             options.id = Number(options.id);
//         }
//     }

//     if (options.title) {
//         options.title = options.title.toString();
//     }

//     if (options.text) {
//         options.text  = options.text.toString();
//     }

//     if (options.badge) {
//         if (isNaN(options.badge)) {
//             options.badge = this.getDefaults().badge;
//             console.warn('Badge number is not a number: ' + options.id);
//         } else {
//             options.badge = Number(options.badge);
//         }
//     }

//     if (options.at) {
//         if (typeof options.at == 'object') {
//             options.at = options.at.getTime();
//         }

//         options.at = Math.round(options.at/1000);
//     }

//     if (typeof options.data == 'object') {
//         options.data = JSON.stringify(options.data);
//     }

//     if (options.every) {
//         if (device.platform == 'iOS' && typeof options.every != 'string') {
//             options.every = this.getDefaults().every;
//             var warning = 'Every option is not a string: ' + options.id;
//             warning += '. Expects one of: second, minute, hour, day, week, ';
//             warning += 'month, year on iOS.';
//             console.warn(warning);
//         }
//     }

//     return options;
// };

/**
 * Create a callback function to get executed within a specific scope.
 *
 * @param [ Function ] fn    The function to be exec as the callback.
 * @param [ Object ]   scope The callback function's scope.
 *
 * @return [ Function ]
 */
exports.createCallbackFn = function (fn, scope) {

    if (typeof fn != 'function')
        return;

    return function () {
        fn.apply(scope || this, arguments);
    };
};

// /**
//  * Convert the IDs to numbers.
//  *
//  * @param {String/Number[]} ids
//  *
//  * @return Array of Numbers
//  */
// exports.convertIds = function (ids) {
//     var convertedIds = [];

//     for (var i = 0; i < ids.length; i++) {
//         convertedIds.push(Number(ids[i]));
//     }

//     return convertedIds;
// };

// /**
//  * First found value for the given keys.
//  *
//  * @param {Object} options
//  *      Object with key-value properties
//  * @param {String[]} keys*
//  *      Key list
//  */
// exports.getValueFor = function (options) {
//     var keys = Array.apply(null, arguments).slice(1);

//     for (var i = 0; i < keys.length; i++) {
//         var key = keys[i];

//         if (options.hasOwnProperty(key)) {
//             return options[key];
//         }
//     }
// };

// /**
//  * Fire event with given arguments.
//  *
//  * @param {String} event
//  *      The event's name
//  * @param {args*}
//  *      The callback's arguments
//  */
// exports.fireEvent = function (event) {
//     var args     = Array.apply(null, arguments).slice(1),
//         listener = this._listener[event];

//     if (!listener)
//         return;

//     for (var i = 0; i < listener.length; i++) {
//         var fn    = listener[i][0],
//             scope = listener[i][1];

//         fn.apply(scope, args);
//     }
// };

// /**
//  * Execute the native counterpart.
//  *
//  * @param {String} action
//  *      The name of the action
//  * @param args[]
//  *      Array of arguments
//  * @param {Function} callback
//  *      The callback function
//  * @param {Object} scope
//  *      The scope for the function
//  */
// exports.exec = function (action, args, callback, scope) {
//     var fn = this.createCallbackFn(callback, scope),
//         params = [];

//     if (Array.isArray(args)) {
//         params = args;
//     } else if (args) {
//         params.push(args);
//     }

//     exec(fn, null, 'LocalNotification', action, params);
// };


// /*********
//  * HOOKS *
//  *********/

// // 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 () {
//     // Device plugin is ready now
//     channel.onCordovaInfoReady.subscribe(function () {
//         // Merge platform specifics into defaults
//         exports.applyPlatformSpecificOptions();
//     });
// });