File: platform/plugins/Users/classes/Users/Device.js

/**
 * Class representing device rows.
 *
 * @module Users
 */
var Q = require('Q');
var Db = Q.require('Db');
var Users = Q.require('Users');

/**
 * Class representing 'Device' rows in the 'Users' database
 * @namespace Users
 * @class Device
 * @extends Base.Users.Device
 * @constructor
 * @param fields {object} The fields values to initialize table row as
 * an associative array of `{column: value}` pairs
 */
function Users_Device (fields) {

	// Run constructors of mixed in objects
	Users_Device.constructors.apply(this, arguments);

	/*
	 * Add any privileged methods to the model class here.
	 * Public methods should probably be added further below.
	 * If file 'Device.js.inc' exists, its content is included
	 * * * */

	/* * * */
}

/**
 * @method pushNotification
 * @param {Object} notification
 * @param {String|Object} [notification.alert] Either the text of an alert to show,
 *  or an object with the following fields:
 * @param {string|array} [notification.alert] Either the text of an alert to show,
 *  or an object with the following fields:
 * @param {String} [notification.alert.title] The title of the notification
 * @param {String} [notification.alert.body] The body of the notification
 * @param {String} [notification.alert.titleLocKey] Apple-only
 * @param {String} [notification.alert.titleLocArgs] Apple-only
 * @param {String} [notification.alert.actionLocKey] Apple-only
 * @param {String} [notification.alert.locKey] Apple-only
 * @param {String} [notification.alert.locArgs] Apple-only
 * @param {String} [notification.alert.launchImage] Apple-only
 * @param {String} [notification.badge] The badge
 * @param {String} [notification.sound] The name of the sound file in the app bundle or Library/Sounds folder
 * @param {String} [notification.icon] Url of icon, can be png any square size
 * @param {String} [notification.url] Url to which the notifiation will be linked
 * @param {array} [notification.actions] Array of up to two arrays with keys 'action' and 'title'.
 * @param {String} [notification.category] Apple-only. The name of the category for actions registered on the client side.
 * @param {Object} [notification.payload] Put all your custom notification fields here
 * @param {Object} [options]
 * @param {String} [options.view] Optionally set a view to render for the alert body
 * @param {Boolean} [options.isSource] If true, uses Q.Handlebars.renderSource instead of render
 * @param {timestamp} [options.expiry] A UNIX timestamp for when the notification expires
 * @param {String} [options.priority="high"] Can be set to "normal" to make it lower priority
 * @param {String} [options.collapseId] A string under 64 bytes for collapsing notifications
 * @param {String} [options.id] You can provide your own uuid for the notification
 * @param {boolean} [options.silent=false] Deliver a silent notification, may throw an exception
 * @param {Function} [callback] This is called after the notification was sent. The first parameter might contain any errors. The "this" object is the Users.Device
 */
Users_Device.prototype.pushNotification = function (notification, options, callback) {
	if (typeof options === 'function') {
		callback = options;
		options = {};
	}
	var o = Q.extend({}, options);
	var n = Q.copy(notification);
	if (!Q.isInteger(o.priority)) {
		o.priority = (o.priority === 'high') ? 10 : 5;
	}
	if (o.priority) {
		notification.priority = o.priority;
	}
	if (o.expiry) {
		n.expiry = o.expiry;
	}
	if (o.collapseId) {
		n.collapseId = o.collapseId;
	}
	if (n.alert && n.alert.title) {
		// if subject is object - get subject from text file
		if (Array.isArray(n.alert.title)) {
			n.alert.title = Q.getObject(n.alert.title[1], Q.Text.get(n.alert.title[0], o.language));
		}

		n.alert.title = Q.Handlebars.renderSource(n.alert.title, o.fields);
	}
	if (o && o.view) {
		var body = Q.view(o.view, o.fields, {language: o.language, source: o.isSource});
		Q.setObject(['alert', 'body'], body, n);
	}
	return this.handlePushNotification(n, o, callback);
};

/**
 * Sends a push notification.
 * This default implementation, just throws an error.
 * @method handlePushNotification
 */
Users_Device.prototype.handlePushNotification = function () {
	throw new Q.Error("Users.Device.prototype.handlePushNotification: not implemented");	
};

/**
 * Called by various Db methods to get a custom row object
 * @param {Object} fields Any fields to set in the row
 * @param {Boolean} retrieved whether the row is retrieved
 * @return {Users.Device}
 */
Users_Device.newRow = function (fields, retrieved) {
	if (!fields.platform) {
		throw new Q.Error("Users.Device.newRow: missing fields.platform");
	}
	var platform = fields.platform.toLowerCase().toCapitalized();
	var PlatformDevice = Users_Device[platform];
	return new PlatformDevice(fields, retrieved);
};

Q.mixin(Users_Device, Q.require('Base/Users/Device'));

/*
 * Add any public methods here by assigning them to Users_Device.prototype
 */

/**
 * The setUp() method is called the first time
 * an object of this class is constructed.
 * @method setUp
 */
Users_Device.prototype.setUp = function () {
	// put any code here
	// overrides the Base class
};

module.exports = Users.Device = Users_Device;

Q.require('Users/Device/Ios');
Q.require('Users/Device/Android');
Q.require('Users/Device/Chrome');
Q.require('Users/Device/Firefox');
Q.require('Users/Device/Safari');