Added doWork() listener (regiseterForUpdates/ deregisterForUpdates)

Red-Folder · Nov 9, 2013 · 0e3a990 · 0e3a990
1 parent 635538b
commit 0e3a990
Show file tree

Hide file tree

Showing 25 changed files with 70 additions and 1 deletion.
diff --git a/2.2.0/README.md b/2.2.0/README.md
@@ -40,6 +40,7 @@ Add the following to AndroidManifest.xml
 ```
 ## Change Log ##
 
+* 20th September 2013 - Added runOnce support (see https://github.com/Red-Folder/Cordova-Plugin-BackgroundService/issues/14)
 * 4th September 2013 - Fixes for NullPointerException (see https://github.com/Red-Folder/Cordova-Plugin-BackgroundService/issues/7)
 * 27th August 2013 - Added TimerMilliseconds to returned JSONObject (see Issue 5)
 * 12th May 2013 - Updated to handle service being restarted by OS

diff --git a/2.2.0/backgroundserviceplugin-2.2.0.jar b/2.2.0/backgroundserviceplugin-2.2.0.jar
diff --git a/2.3.0/README.md b/2.3.0/README.md
@@ -40,6 +40,7 @@ Add the following to AndroidManifest.xml
 ```
 ## Change Log ##
 
+* 20th September 2013 - Added runOnce support (see https://github.com/Red-Folder/Cordova-Plugin-BackgroundService/issues/14)
 * 4th September 2013 - Fixes for NullPointerException (see https://github.com/Red-Folder/Cordova-Plugin-BackgroundService/issues/7)
 * 27th August 2013 - Added TimerMilliseconds to returned JSONObject (see Issue 5)
 * 12th May 2013 - Updated to handle service being restarted by OS

diff --git a/2.3.0/backgroundserviceplugin-2.3.0.jar b/2.3.0/backgroundserviceplugin-2.3.0.jar
diff --git a/2.4.0/README.md b/2.4.0/README.md
@@ -40,6 +40,7 @@ Add the following to AndroidManifest.xml
 ```
 ## Change Log ##
 
+* 20th September 2013 - Added runOnce support (see https://github.com/Red-Folder/Cordova-Plugin-BackgroundService/issues/14)
 * 4th September 2013 - Fixes for NullPointerException (see https://github.com/Red-Folder/Cordova-Plugin-BackgroundService/issues/7)
 * 27th August 2013 - Added TimerMilliseconds to returned JSONObject (see Issue 5)
 * 12th May 2013 - Updated to handle service being restarted by OS

diff --git a/2.4.0/backgroundserviceplugin-2.4.0.jar b/2.4.0/backgroundserviceplugin-2.4.0.jar
diff --git a/2.5.0/README.md b/2.5.0/README.md
@@ -40,6 +40,7 @@ Add the following to AndroidManifest.xml
 ```
 ## Change Log ##
 
+* 20th September 2013 - Added runOnce support (see https://github.com/Red-Folder/Cordova-Plugin-BackgroundService/issues/14)
 * 4th September 2013 - Fixes for NullPointerException (see https://github.com/Red-Folder/Cordova-Plugin-BackgroundService/issues/7)
 * 27th August 2013 - Added TimerMilliseconds to returned JSONObject (see Issue 5)
 * 12th May 2013 - Updated to handle service being restarted by OS

diff --git a/2.5.0/backgroundserviceplugin-2.5.0.jar b/2.5.0/backgroundserviceplugin-2.5.0.jar
diff --git a/2.6.0/README.md b/2.6.0/README.md
@@ -40,6 +40,7 @@ Add the following to AndroidManifest.xml
 ```
 ## Change Log ##
 
+* 20th September 2013 - Added runOnce support (see https://github.com/Red-Folder/Cordova-Plugin-BackgroundService/issues/14)
 * 4th September 2013 - Fixes for NullPointerException (see https://github.com/Red-Folder/Cordova-Plugin-BackgroundService/issues/7)
 * 27th August 2013 - Added TimerMilliseconds to returned JSONObject (see Issue 5)
 * 12th May 2013 - Updated to handle service being restarted by OS

diff --git a/2.6.0/backgroundserviceplugin-2.6.0.jar b/2.6.0/backgroundserviceplugin-2.6.0.jar
diff --git a/2.7.0/README.md b/2.7.0/README.md
@@ -40,6 +40,7 @@ Add the following to AndroidManifest.xml
 ```
 ## Change Log ##
 
+* 20th September 2013 - Added runOnce support (see https://github.com/Red-Folder/Cordova-Plugin-BackgroundService/issues/14)
 * 4th September 2013 - Fixes for NullPointerException (see https://github.com/Red-Folder/Cordova-Plugin-BackgroundService/issues/7)
 * 27th August 2013 - Added TimerMilliseconds to returned JSONObject (see Issue 5)
 * 12th May 2013 - Updated to handle service being restarted by OS

diff --git a/2.7.0/backgroundserviceplugin-2.7.0.jar b/2.7.0/backgroundserviceplugin-2.7.0.jar
diff --git a/2.8.0/README.md b/2.8.0/README.md
@@ -40,6 +40,7 @@ Add the following to AndroidManifest.xml
 ```
 ## Change Log ##
 
+* 20th September 2013 - Added runOnce support (see https://github.com/Red-Folder/Cordova-Plugin-BackgroundService/issues/14)
 * 4th September 2013 - Fixes for NullPointerException (see https://github.com/Red-Folder/Cordova-Plugin-BackgroundService/issues/7)
 * 27th August 2013 - Added TimerMilliseconds to returned JSONObject (see Issue 5)
 * 12th May 2013 - Updated to handle service being restarted by OS

diff --git a/2.8.0/backgroundserviceplugin-2.8.0.jar b/2.8.0/backgroundserviceplugin-2.8.0.jar
diff --git a/2.8.1/README.md b/2.8.1/README.md
@@ -40,6 +40,7 @@ Add the following to AndroidManifest.xml
 ```
 ## Change Log ##
 
+* 20th September 2013 - Added runOnce support (see https://github.com/Red-Folder/Cordova-Plugin-BackgroundService/issues/14)
 * 4th September 2013 - Fixes for NullPointerException (see https://github.com/Red-Folder/Cordova-Plugin-BackgroundService/issues/7)
 * 27th August 2013 - Added TimerMilliseconds to returned JSONObject (see Issue 5)
 * 12th May 2013 - Updated to handle service being restarted by OS

diff --git a/2.8.1/backgroundserviceplugin-2.8.1.jar b/2.8.1/backgroundserviceplugin-2.8.1.jar
diff --git a/2.9.0/README.md b/2.9.0/README.md
@@ -40,6 +40,7 @@ Add the following to AndroidManifest.xml
 ```
 ## Change Log ##
 
+* 20th September 2013 - Added runOnce support (see https://github.com/Red-Folder/Cordova-Plugin-BackgroundService/issues/14)
 * 4th September 2013 - Fixes for NullPointerException (see https://github.com/Red-Folder/Cordova-Plugin-BackgroundService/issues/7)
 * 27th August 2013 - Added TimerMilliseconds to returned JSONObject (see Issue 5)
 * 12th May 2013 - Updated to handle service being restarted by OS

diff --git a/2.9.0/backgroundserviceplugin-2.9.0.jar b/2.9.0/backgroundserviceplugin-2.9.0.jar
diff --git a/3.0.0/README.md b/3.0.0/README.md
@@ -42,6 +42,7 @@ Add the following to AndroidManifest.xml
 ```
 ## Change Log ##
 
+* 20th September 2013 - Added runOnce support (see https://github.com/Red-Folder/Cordova-Plugin-BackgroundService/issues/14)
 * 4th September 2013 - Fixes for NullPointerException (see https://github.com/Red-Folder/Cordova-Plugin-BackgroundService/issues/7)
 * 27th August 2013 - Added TimerMilliseconds to returned JSONObject (see Issue 5)
 * 12th May 2013 - Updated to handle service being restarted by OS

diff --git a/3.0.0/backgroundserviceplugin-3.0.0.jar b/3.0.0/backgroundserviceplugin-3.0.0.jar
diff --git a/3.1.0/README.md b/3.1.0/README.md
@@ -42,6 +42,8 @@ Add the following to AndroidManifest.xml
 ```
 ## Change Log ##
 
+* 9th November 2013 - Added ability to listen for doWork() updates using registerForUpdates/ deregisterForUpdates.  See individual version README for support info (rolling out version by version.  For more info see https://github.com/Red-Folder/Cordova-Plugin-BackgroundService/issues/17
+* 20th September 2013 - Added runOnce support (see https://github.com/Red-Folder/Cordova-Plugin-BackgroundService/issues/14)
 * 4th September 2013 - Fixes for NullPointerException (see https://github.com/Red-Folder/Cordova-Plugin-BackgroundService/issues/7)
 * 27th August 2013 - Added TimerMilliseconds to returned JSONObject (see Issue 5)
 * 12th May 2013 - Updated to handle service being restarted by OS

diff --git a/3.1.0/backgroundService-3.1.0.js b/3.1.0/backgroundService-3.1.0.js
@@ -46,6 +46,7 @@ function CreateBackgroundService(serviceName, require, exports, module) {
 	  *		JSONObject Configuration - A JSONObject of the configuration of the service (contents dependant on the service)
 	  *		JSONObject LastestResult - A JSONObject of the last result of the service (contents dependant on the service)
 	  *		int TimerMilliseconds - Milliseconds used by the background service if Timer enabled
+	  *		Boolean RegisteredForUpdates - True if the Service is registered to send updates to the front-end
 	  */
 
 	/**
@@ -191,6 +192,34 @@ function CreateBackgroundService(serviceName, require, exports, module) {
 						[this.getServiceName()]);
 	};
 
+	/**
+	  * Registers for doWork() updates
+	  *
+	  * @param successCallback The callback which will be called if the method is successful
+	  * @param failureCallback The callback which will be called if the method encounters an error
+	  */
+	BackgroundService.prototype.registerForUpdates = function(successCallback, failureCallback) { 
+		return exec(	successCallback,      
+						failureCallback,      
+						'BackgroundServicePlugin',      
+						'registerForUpdates',      
+						[this.getServiceName()]);
+	};
+
+	/**
+	  * Deregisters for doWork() updates
+	  *
+	  * @param successCallback The callback which will be called if the method is successful
+	  * @param failureCallback The callback which will be called if the method encounters an error
+	  */
+	BackgroundService.prototype.deregisterForUpdates = function(successCallback, failureCallback) { 
+		return exec(	successCallback,      
+						failureCallback,      
+						'BackgroundServicePlugin',      
+						'deregisterForUpdates',      
+						[this.getServiceName()]);
+	};
+
 	var backgroundService = new BackgroundService(serviceName);
 	module.exports = backgroundService;
 }; 
diff --git a/3.1.0/backgroundserviceplugin-3.1.0.jar b/3.1.0/backgroundserviceplugin-3.1.0.jar
diff --git a/3.1.0/index-3.1.0.html b/3.1.0/index-3.1.0.html
@@ -80,6 +80,16 @@
 													function(e){handleError(e)});
  			}
 
+ 			function registerForUpdates() {
+				myService.registerForUpdates(	function(r){handleSuccess(r)},
+												function(e){handleError(e)});
+ 			}
+
+ 			function deregisterForUpdates() {
+				myService.deregisterForUpdates(	function(r){handleSuccess(r)},
+												function(e){handleError(e)});
+ 			}
+
  			function setConfig() {
 				var helloToTxt = document.getElementById("helloToTxt");
  				var helloToString = helloToTxt.value;
@@ -98,13 +108,15 @@
 				var serviceBtn = document.getElementById("toggleService");
 				var timerBtn = document.getElementById("toggleTimer");
 				var bootBtn = document.getElementById("toggleBoot");
+				var listenBtn = document.getElementById("toggleListen");
 				var updateBtn = document.getElementById("updateBtn");
 				var refreshBtn = document.getElementById("refreshBtn");
 
 				var serviceStatus = document.getElementById("serviceStatus");
 				var timerStatus = document.getElementById("timerStatus");
 				var bootStatus = document.getElementById("bootStatus");
-
+				var listenStatus = document.getElementById("listenStatus");
+
 				serviceBtn.disabled = false;
 				if (data.ServiceRunning) {
 					serviceStatus.innerHTML = "Running";
@@ -142,6 +154,15 @@
 					bootStatus.innerHTML = "Not registered";
 					bootBtn.onclick = registerForBootStart;
 				}
+
+				listenBtn.disabled = false;
+				if (data.RegisteredForUpdates) {
+					listenStatus.innerHTML = "Registered";
+					listenBtn.onclick = deregisterForUpdates;
+				} else {
+					listenStatus.innerHTML = "Not registered";
+					listenBtn.onclick = registerForUpdates;
+				}
 
 				if (data.Configuration != null)
 				{
@@ -185,6 +206,11 @@ <h1>MyService V3.1.0</h1>
 				<td><div id="bootStatus"></div></td>
 				<td><input disabled id="toggleBoot" type="button" value="toggle"/></td>
 			</tr>
+			<tr>
+				<th>Listen</th>
+				<td><div id="listenStatus"></div></td>
+				<td><input disabled id="toggleListen" type="button" value="toggle"/></td>
+			</tr>
 
 			<tr>
 				<th colspan=3 align="center">Configuration</th>

diff --git a/README.md b/README.md
@@ -30,6 +30,8 @@ Over time I will no longer maintain older versions.  These will be listed here.
 
 ## Change Log ##
 
+* 9th November 2013 - Added ability to listen for doWork() updates using registerForUpdates/ deregisterForUpdates.  See individual version README for support info (rolling out version by version.  For more info see https://github.com/Red-Folder/Cordova-Plugin-BackgroundService/issues/17
+* 20th September 2013 - Added runOnce support (see https://github.com/Red-Folder/Cordova-Plugin-BackgroundService/issues/14)
 * 4th September 2013 - Fixes for NullPointerException (see https://github.com/Red-Folder/Cordova-Plugin-BackgroundService/issues/7)
 * 27th August 2013 - Added TimerMilliseconds to returned JSONObject (see Issue 5)
 * 12th May 2013 - Updated to handle service being restarted by OS (version 2.2+)