Better script documentation (bf346dc6) · Commits · codevise / cordova-plugin-notification

scripts/ios/didRegisterUserNotificationSettings.js

+2 −0

Changes for scripts/ios/didRegisterUserNotificationSettings.js: 2 added lines, 0 removed lines.
Original line number	Diff line number	Diff line
		#!/usr/bin/env node

		/*
		* Copyright (c) 2013-2015 by appPlant UG. All rights reserved.
		*

scripts/windows/broadcastActivateEvent.js

+42 −6

Changes for scripts/windows/broadcastActivateEvent.js: 42 added lines, 6 removed lines.
Original line number	Diff line number	Diff line
		#!/usr/bin/env node

		// This Plugin-Hook sets ToastCapable on true to allow windows-platform
		// cordova apps displaing local-notifications
		/*
		* Copyright (c) 2013-2015 by appPlant UG. All rights reserved.
		*
		* @APPPLANT_LICENSE_HEADER_START@
		*
		* 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.
		*
		* @APPPLANT_LICENSE_HEADER_END@
		*/


		// Includes a snippet into the cordova-core js file
		// to fire the activated event after device is ready


		var fs = require('fs'),
		rootdir = process.argv[2];
		@@ -9,7 +34,17 @@ var fs = require('fs'),
		if (!rootdir)
		return;

		function replace_string_in_file (filename, to_replace, replace_with) {
		/**
		* Replaces a string with another one in a file.
		*
		* @param {String} path
		* Absolute or relative file path from cordova root project.
		* @param {String} to_replace
		* The string to replace.
		* @param {String}
		* The string to replace with.
		*/
		function replace (filename, to_replace, replace_with) {
		var data = fs.readFileSync(filename, 'utf8'),
		result;

		@@ -20,6 +55,7 @@ function replace_string_in_file (filename, to_replace, replace_with) {
		fs.writeFileSync(filename, result, 'utf8');
		}

		// Fires the activated event again after device is ready
		var snippet =
		"var activatedHandler = function (args) {" +
		"channel.deviceready.subscribe(function () {" +
		@@ -32,13 +68,13 @@ var snippet =
		"}, false);\n" +
		" app.start();";


		// Path to cordova-core js files where the snippet needs to be included
		var files = [
		'platforms/windows/www/cordova.js',
		'platforms/windows/platform_www/cordova.js'
		];


		// Includes the snippet before app.start() is called
		for (var i = 0; i < files.length; i++) {
		replace_string_in_file(files[i], 'app.start();', snippet);
		replace(files[i], 'app.start();', snippet);
		}

scripts/windows/setToastCapable.js

+40 −5

Changes for scripts/windows/setToastCapable.js: 40 added lines, 5 removed lines.
Original line number	Diff line number	Diff line
		#!/usr/bin/env node

		// This Plugin-Hook sets ToastCapable on true to allow windows-platform
		// cordova apps displaing local-notifications
		/*
		* Copyright (c) 2013-2015 by appPlant UG. All rights reserved.
		*
		* @APPPLANT_LICENSE_HEADER_START@
		*
		* 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.
		*
		* @APPPLANT_LICENSE_HEADER_END@
		*/


		// Hook sets ToastCapable on true to enable local-notifications


		var fs = require('fs'),
		rootdir = process.argv[2];
		@@ -9,7 +33,17 @@ var fs = require('fs'),
		if (!rootdir)
		return;

		function replace_string_in_file (filename, to_replace, replace_with) {
		/**
		* Replaces a string with another one in a file.
		*
		* @param {String} path
		* Absolute or relative file path from cordova root project.
		* @param {String} to_replace
		* The string to replace.
		* @param {String}
		* The string to replace with.
		*/
		function replace (filename, to_replace, replace_with) {
		var data = fs.readFileSync(filename, 'utf8'),
		result;

		@@ -21,13 +55,14 @@ function replace_string_in_file (filename, to_replace, replace_with) {
		fs.writeFileSync(filename, result, 'utf8');
		}


		// Paths to all manifest files where the permission needs to be set
		var manifests = [
		'platforms/windows/package.phone.appxmanifest',
		'platforms/windows/package.windows.appxmanifest',
		'platforms/windows/package.windows80.appxmanifest'
		];

		// Includes the permission
		for (var i = 0; i < manifests.length; i++) {
		replace_string_in_file(manifests[i], '<m3:VisualElements ', '<m3:VisualElements ToastCapable="true" ');
		replace(manifests[i], '<m3:VisualElements ', '<m3:VisualElements ToastCapable="true" ');
		}