├── LICENSE ├── README.md ├── package.json ├── plugin.xml ├── sample ├── CreateBackgroundSyncDemo ├── config.xml └── www │ ├── css │ └── index.css │ ├── index.html │ ├── js │ └── index.js │ └── sw.js ├── src └── ios │ └── CDVBackgroundSync.m ├── tests ├── plugin.xml ├── sw.js └── tests.js └── www ├── PeriodicSyncManager.js ├── PeriodicSyncRegistration.js ├── SyncManager.js ├── SyncRegistration.js └── sw_assets └── syncevents.js /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Cordova Background Sync 2 | Background Sync enables service worker applications to perform actions when certain conditions are achieved. For example, if you want your app to delay an action until a device has a wifi connection, you can use background sync to accomplish this. Here is an [explainer document](https://github.com/slightlyoff/BackgroundSync/blob/master/explainer.md) that goes into more detail about the purpose and usage of background sync. 3 | 4 | ## Plugin Status 5 | Supported Platforms: iOS 6 | 7 | ## Installation 8 | To add this plugin to your project, you can use the following cordova cli command 9 | ``` 10 | cordova plugin add https://github.com/MobileChromeApps/cordova-plugin-service-worker-background-sync.git 11 | ``` 12 | 13 | or, to install from npm: 14 | ``` 15 | cordova plugin add cordova-plugin-service-worker-background-sync 16 | ``` 17 | 18 | To remove this plugin, use the following command 19 | ``` 20 | cordova plugin rm cordova-plugin-service-worker-background-sync 21 | ``` 22 | 23 | Note: For background sync to work properly, you must first install the cordova [service worker plugin](https://github.com/MobileChromeApps/cordova-plugin-service-worker) before installing the background sync plugin. 24 | 25 | ## Preferences 26 | You can specify custom plugin preferences in your project's config.xml. This is similar to how you specify your service worker script. 27 | 28 | ```xml 29 | // Default: 1 hour 30 | // Default: 5 minutes 31 | // Default: 2 hours 32 | ``` 33 | All three times are given in miliseconds. 34 | - `minperiod` specifies the minimum amount of time between repetitions of a periodic sync. Registration of a periodic sync will fail if the `minPeriod` property of the registration is less than this preference value. In the background sync spec, this value is known as `minPossiblePeriod` and is accessible in JavaScript as a property of the `PeriodicSyncManager`. 35 | - `syncpushback` is the minimum amount of time a viable one-off or periodic sync will wait after failing before being reassessed. 36 | - `syncmaxwaittime` is the maximum amount of time past the expiration of its minimum period that a periodic sync event will wait to be batched with other periodic sync events. This can prevent a periodic sync meant to happen daily from waiting for a periodic sync scheduled to take place weekly. 37 | 38 | ## Examples 39 | Here are a few examples that outline the basic usage of background sync. 40 | ### Getting Service Worker Registration 41 | ```javascript 42 | navigator.serviceWorker.ready.then(function (serviceWorkerRegistration) { 43 | ... //Most of your background sync related code should go in here 44 | } 45 | ``` 46 | ### Checking Permission 47 | In the iOS implementation of background sync, permission defaults to granted. However, the user can disable background refresh capabilities manually. If permission is denied, sync events can still be executed in the foreground, but no sync events will be executed while the app is idle or in the background. 48 | ```javascript 49 | serviceWorkerRegistration.sync.permissionState().then(function(permissionState) { 50 | if (permissionState === "granted") { 51 | // We have permission to use background sync! 52 | } 53 | if (permissionState === "denied") { 54 | // We don't have permission to use background sync, 55 | // You can try and prompt the user to turn iOS's background referesh back on 56 | } 57 | }); 58 | ``` 59 | ### Registering Sync Events 60 | You can register sync events from both the page and the service worker context. Check out [this explainer](https://github.com/slightlyoff/BackgroundSync/blob/master/explainer.md) for details about the registration options. 61 | 62 | #### For One-off Sync Events 63 | ```javascript 64 | serviceWorkerRegistration.sync.register( 65 | { 66 | tag: "exampleSync" // A name used for retrieving or updating sync events, default: empty string 67 | }).then(function() { // Success 68 | // A sync event was successfully registered 69 | }, 70 | function() { // Failure 71 | // There was a problem while registering a sync event 72 | }); 73 | ``` 74 | #### For Periodic Sync Events 75 | ```javascript 76 | serviceWorkerRegistration.periodicSync.register( 77 | { 78 | tag: "examplePeriodicSync", // A name used for retrieving or updating sync events, default: empty string 79 | minPeriod: 50000, // Delay between sync events repetition 80 | networkState: "avoid-cellular", // The minimum required network type for your sync event 81 | powerState: "avoid-draining" // Whether or not to fire sync events while on battery 82 | }).then(function() { // Success 83 | // A sync event was successfully registered 84 | }, 85 | function() { // Failure 86 | // There was a problem while registering a sync event 87 | }); 88 | ``` 89 | 90 | ### Looking Up Sync Event Registrations 91 | ```javascript 92 | // Get all sync event registrations 93 | serviceWorkerRegistration.sync.getRegistrations().then(function(regs){ 94 | regs.forEach(function(reg) { 95 | // Do something with the registrations 96 | ... 97 | 98 | // You can also unregister sync events 99 | reg.unregister(); 100 | }); 101 | }); 102 | 103 | serviceWorkerRegistration.periodicSync.getRegistrations().then(function(regs){ 104 | regs.forEach(function(reg) { 105 | // Do something with the registrations 106 | ... 107 | 108 | // You can also unregister sync events 109 | reg.unregister(); 110 | }); 111 | }); 112 | ``` 113 | ```javascript 114 | // Get a specific sync event registration by its Tag 115 | serviceWorkerRegistration.sync.getRegistration("exampleSync").then(function(reg) { 116 | // Do something with the registration 117 | console.log(reg.minDelay); 118 | }, 119 | function(err) { 120 | // This id hasn't been registered 121 | console.log(err); 122 | }); 123 | 124 | serviceWorkerRegistration.periodicSync.getRegistration("examplePeriodicSync").then(function(reg) { 125 | // Do something with the registration 126 | console.log(reg.minDelay); 127 | }, 128 | function(err) { 129 | // This id hasn't been registered 130 | console.log(err); 131 | }); 132 | ``` 133 | ### Handling Sync Events 134 | All sync events will be dispatched to the same ```onsync``` event handler in your service worker script. All periodic sync events will be dispatched to the same ```onperiodicsync``` event handler. These event handlers are passed an event object which has a registration property that contains all of the registration options of the sync registration that triggered this event. 135 | #### One-off Sync Event 136 | ```javascript 137 | this.onsync = function(event) { 138 | if (event.registration.id === "exampleSync") { 139 | event.waitUntil(new Promise(function(resolve, reject) { 140 | var asyncCallback = function () { 141 | // This is asynchronous 142 | resolve(); 143 | } 144 | someAsyncFunction(event.registration.id, asyncCallback); 145 | // One-off sync events are automatically unregistered after completion 146 | })); 147 | } 148 | }; 149 | ``` 150 | #### Periodic Sync Event 151 | ```javascript 152 | this.onperiodicsync = function(event) { 153 | if (event.registration.id === "examplePeriodicSync") { 154 | event.waitUntil(new Promise(function(resolve, reject) { 155 | var asyncCallback = function () { 156 | // This is asynchronous 157 | resolve(); 158 | } 159 | someAsyncFunction(event.registration.id, asyncCallback); 160 | if (somethingHappened()) { 161 | // You can unregister a periodic sync from within its event handler 162 | // Otherwise, the sync event will be rescheduled after completion 163 | event.registration.unregister(); 164 | } 165 | })); 166 | } 167 | }; 168 | ``` 169 | When you need to perform an asynchronous action inside the sync event handler, use ```event.waitUntil```. If a sync event is dispatched while your app is in the background, ```event.waitUntil``` will preserve your service worker until the promise it was given has been settled. If the promise is resolved, then the sync event is unregistered (unless it is periodic). If the promise is rejected, then the sync event is rescheduled with a pushback. 170 | 171 | iOS limits background execution runtime to 30 seconds. So even when using ```event.waitUntil``` you should be aware that your process will be terminated if it takes too long. 172 | 173 | ## Sample App 174 | To see this plugin in action, execute the CreateBackgroundSyncDemo script in a directory of your choice or run the following commands to create the sample app 175 | ```bash 176 | cordova create BackgroundSyncDemo io.cordova.backgroundsyncdemo BackgroundSyncDemo 177 | cd BackgroundSyncDemo 178 | cordova platform add ios 179 | cordova plugin add cordova-plugin-service-worker 180 | cordova plugin add cordova-plugin-service-worker-background-sync 181 | mv 'plugins/cordova-plugin-service-worker-background-sync/sample/config.xml' 'config.xml' 182 | mv 'plugins/cordova-plugin-service-worker-background-sync/sample/www/sw.js' 'www/sw.js' 183 | mv 'plugins/cordova-plugin-service-worker-background-sync/sample/www/index.html' 'www/index.html' 184 | mv 'plugins/cordova-plugin-service-worker-background-sync/sample/www/js/index.js' 'www/js/index.js' 185 | mv 'plugins/cordova-plugin-service-worker-background-sync/sample/www/css/index.css' 'www/css/index.css' 186 | cordova prepare 187 | ``` 188 | 189 | ## 1.0.1 (April 30, 2015) 190 | * Updated installation instructions 191 | 192 | ## 1.0.0 (April 29, 2015) 193 | * Initial release 194 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "cordova-plugin-service-worker-background-sync", 3 | "version": "1.0.1", 4 | "description": "Background Sync Plugin", 5 | "cordova": { 6 | "id": "cordova-plugin-service-worker-background-sync", 7 | "platforms": [ 8 | "ios" 9 | ] 10 | }, 11 | "repository": { 12 | "type": "git", 13 | "url": "git+https://github.com/MobileChromeApps/cordova-plugin-service-worker-background-sync.git" 14 | }, 15 | "keywords": [ 16 | "cordova", 17 | "backgroundsync", 18 | "service", 19 | "worker", 20 | "ecosystem:cordova", 21 | "cordova-ios" 22 | ], 23 | "author": "The Chrome Team", 24 | "license": "Apache 2.0", 25 | "bugs": { 26 | "url": "https://github.com/MobileChromeApps/cordova-plugin-service-worker-background-sync/issues" 27 | }, 28 | "homepage": "https://github.com/MobileChromeApps/cordova-plugin-service-worker-background-sync#readme" 29 | } 30 | -------------------------------------------------------------------------------- /plugin.xml: -------------------------------------------------------------------------------- 1 | 2 | 20 | 21 | 24 | BackgroundSync 25 | BackgroundSync Plugin 26 | Apache 2.0 27 | cordova,backgroundsync,service,worker 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | fetch 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | -------------------------------------------------------------------------------- /sample/CreateBackgroundSyncDemo: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | cordova create BackgroundSyncDemo io.cordova.backgroundsyncdemo BackgroundSyncDemo 3 | cd BackgroundSyncDemo 4 | cordova platform add ios 5 | cordova plugin add cordova-plugin-service-worker 6 | cordova plugin add cordova-plugin-service-worker-background-sync 7 | mv 'plugins/cordova-plugin-service-worker-background-sync/sample/config.xml' 'config.xml' 8 | mv 'plugins/cordova-plugin-service-worker-background-sync/sample/www/sw.js' 'www/sw.js' 9 | mv 'plugins/cordova-plugin-service-worker-background-sync/sample/www/index.html' 'www/index.html' 10 | mv 'plugins/cordova-plugin-service-worker-background-sync/sample/www/js/index.js' 'www/js/index.js' 11 | mv 'plugins/cordova-plugin-service-worker-background-sync/sample/www/css/index.css' 'www/css/index.css' 12 | cordova prepare 13 | -------------------------------------------------------------------------------- /sample/config.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | BackgroundSyncDemo 7 | 8 | A sample Apache Cordova application that responds to the deviceready event. 9 | 10 | 11 | Apache Cordova Team 12 | 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /sample/www/css/index.css: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | * { 20 | -webkit-tap-highlight-color: rgba(0,0,0,0); /* make transparent link selection, adjust last value opacity 0 to 1.0 */ 21 | } 22 | 23 | body { 24 | overflow:hidden; 25 | width:100%; 26 | -webkit-touch-callout: none; /* prevent callout to copy image, etc when tap to hold */ 27 | -webkit-text-size-adjust: none; /* prevent webkit from resizing text to fit */ 28 | -webkit-user-select: none; /* prevent copy paste, to allow, change 'none' to 'text' */ 29 | background-color:#E4E4E4; 30 | background-image:linear-gradient(top, #A7A7A7 0%, #E4E4E4 51%); 31 | background-image:-webkit-linear-gradient(top, #A7A7A7 0%, #E4E4E4 51%); 32 | background-image:-ms-linear-gradient(top, #A7A7A7 0%, #E4E4E4 51%); 33 | background-image:-webkit-gradient( 34 | linear, 35 | left top, 36 | left bottom, 37 | color-stop(0, #A7A7A7), 38 | color-stop(0.51, #E4E4E4) 39 | ); 40 | background-attachment:fixed; 41 | font-family:'HelveticaNeue-Light', 'HelveticaNeue', Helvetica, Arial, sans-serif; 42 | font-size:12px; 43 | height:100%; 44 | margin:0px; 45 | padding:0px; 46 | width:100%; 47 | } 48 | 49 | /* Portrait layout (default) */ 50 | .app { 51 | position: absolute; 52 | height:100%; /* text area height */ 53 | width:100%; /* text area width */ 54 | text-align:center; 55 | padding:20px 0px 0px 0px; 56 | display: flex; 57 | display: -webkit-flex; 58 | -webkit-flex-direction: column; 59 | flex-direction: column; 60 | -webkit-justify-content: center; 61 | justify-content: center; 62 | -webkit-box-sizing: border-box; 63 | } 64 | 65 | h1 { 66 | width:100%; 67 | font-size:24px; 68 | font-weight:normal; 69 | margin:0px; 70 | overflow:visible; 71 | padding:0px; 72 | } 73 | 74 | .heading { 75 | -webkit-flex: 0 1 auto; 76 | flex: 0 1 auto; 77 | } 78 | 79 | .event { 80 | border-radius:4px; 81 | -webkit-border-radius:4px; 82 | color:#FFFFFF; 83 | font-size:12px; 84 | margin:0px 30px; 85 | padding:2px 0px; 86 | } 87 | 88 | .event.listening { 89 | background-color:#333333; 90 | display:block; 91 | } 92 | 93 | .event.received { 94 | background-color:#4B946A; 95 | display:none; 96 | } 97 | 98 | @keyframes fade { 99 | from { opacity: 1.0; } 100 | 50% { opacity: 0.4; } 101 | to { opacity: 1.0; } 102 | } 103 | 104 | @-webkit-keyframes fade { 105 | from { opacity: 1.0; } 106 | 50% { opacity: 0.4; } 107 | to { opacity: 1.0; } 108 | } 109 | 110 | .blink { 111 | padding-left:25%; 112 | width:50%; 113 | animation:fade 3000ms infinite; 114 | -webkit-animation:fade 3000ms infinite; 115 | } 116 | 117 | .output { 118 | -webkit-flex: 1 1 auto; 119 | flex: 1 1 auto; 120 | padding: 10px; 121 | display: flex; 122 | display: -webkit-flex; 123 | -webkit-flex-direction: column; 124 | } 125 | 126 | #mainPage { 127 | -webkit-flex: 0 1 auto; 128 | flex: 0 1 auto; 129 | } 130 | 131 | #console { 132 | -webkit-flex: 1 1 auto; 133 | } 134 | 135 | .PSync { 136 | display: -webkit-box; 137 | -webkit-box-pack:center; 138 | -webkit-box-aligh:center; 139 | } 140 | .PSyncInner { 141 | text-align: left; 142 | } 143 | -------------------------------------------------------------------------------- /sample/www/index.html: -------------------------------------------------------------------------------- 1 | 2 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | Background Sync Demo 29 | 30 | 31 |
32 |
33 |

BackgroundSync Demo

34 | 38 |
39 |
40 |

One Off Sync Events

41 |
42 | 43 | 44 |
45 | 46 | 47 | 48 |
49 |
50 |

Periodic Sync Events

51 |
52 |
53 |
54 | 55 | 56 |
57 |
58 | 59 | 60 |
61 |
62 | 63 | 68 |
69 |
70 | 71 | 75 |
76 |
77 |
78 |
79 | 80 | 81 | 82 |
83 |
84 |
85 |

Output Console

86 | 87 |
88 |
89 | 90 | 91 | 92 | 93 | -------------------------------------------------------------------------------- /sample/www/js/index.js: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | var app = { 20 | // Application Constructor 21 | initialize: function() { 22 | this.bindEvents(); 23 | }, 24 | // Bind Event Listeners 25 | // 26 | // Bind any events that are required on startup. Common events are: 27 | // 'load', 'deviceready', 'offline', and 'online'. 28 | bindEvents: function() { 29 | document.addEventListener('deviceready', this.onDeviceReady, false); 30 | }, 31 | // deviceready Event Handler 32 | // 33 | // The scope of 'this' is the event. In order to call the 'receivedEvent' 34 | // function, we must explicitly call 'app.receivedEvent(...);' 35 | onDeviceReady: function() { 36 | app.receivedEvent('deviceready'); 37 | clobberlog(); 38 | navigator.serviceWorker.ready.then(function(swreg) { 39 | document.getElementById('OOTagInput').oninput = function () { updateButtonText('OO'); }; 40 | document.getElementById('PTagInput').oninput = function () { updateButtonText('P'); }; 41 | document.getElementById('OORegister').onclick = function () { register('OO'); }; 42 | document.getElementById('OOUnregister').onclick = function () { unregister('OO'); }; 43 | document.getElementById('OOGet').onclick = function () { getRegistrations('OO'); }; 44 | document.getElementById('PRegister').onclick = function () { register('P'); }; 45 | document.getElementById('PUnregister').onclick = function () { unregister('P'); }; 46 | document.getElementById('PGet').onclick = function () { getRegistrations('P'); }; 47 | window.addEventListener('message', function (event) { 48 | if (event.data.type === 'one-off') { 49 | console.log('Sync Event ' + event.data.tag); 50 | } 51 | if (event.data.type === 'one-off-success') { 52 | console.log('Unregistering ' + event.data.tag); 53 | } 54 | if (event.data.type === 'one-off-fail') { 55 | console.log('Failed to sync ' + event.data.tag); 56 | } 57 | if (event.data.type === 'periodic'){ 58 | console.log('Periodic Sync Event ' + event.data.tag); 59 | console.log('Reregistering ' + event.data.tag + ' with minPeriod ' + event.data.minPeriod); 60 | } 61 | }); 62 | }); 63 | }, 64 | // Update DOM on a Received Event 65 | receivedEvent: function(id) { 66 | var parentElement = document.getElementById(id); 67 | var listeningElement = parentElement.querySelector('.listening'); 68 | var receivedElement = parentElement.querySelector('.received'); 69 | 70 | listeningElement.setAttribute('style', 'display:none;'); 71 | receivedElement.setAttribute('style', 'display:block;'); 72 | 73 | console.log('Received Event: ' + id); 74 | } 75 | }; 76 | 77 | function register (prefix) { 78 | var tag = document.getElementById(prefix + 'TagInput').value; 79 | // When registering one-off syncs, these properties have no effect 80 | var minPeriod = document.getElementById('minPeriod').value; 81 | var networkState = document.getElementById('networkState').value; 82 | var powerState = document.getElementById('powerState').value; 83 | navigator.serviceWorker.ready.then(function (swreg) { 84 | var manager = prefix === 'OO' ? swreg.sync : swreg.periodicSync; 85 | manager.register({ 86 | tag: tag, 87 | minPeriod: minPeriod, 88 | networkState: networkState, 89 | powerState: powerState 90 | }).then( 91 | function(reg) { 92 | console.log('Registered ' + reg.tag); 93 | }, function (err) { 94 | console.log(err); 95 | }); 96 | document.getElementById(prefix + 'TagInput').value = ''; 97 | updateButtonText(prefix); 98 | }); 99 | } 100 | 101 | function unregister (prefix) { 102 | var tag = document.getElementById(prefix + 'TagInput').value; 103 | navigator.serviceWorker.ready.then(function (swreg) { 104 | var manager = prefix === 'OO' ? swreg.sync : swreg.periodicSync; 105 | if (tag !== '') { 106 | manager.getRegistration(tag).then(function (reg) { 107 | console.log('Unregistering ' + reg.tag); 108 | reg.unregister(); 109 | }, function (err) { 110 | console.log(err); 111 | }); 112 | } else { 113 | manager.getRegistrations().then(function(regs) { 114 | if (regs.length === 0) { 115 | console.log('No registrations to unregister'); 116 | } 117 | regs.forEach(function(reg) { 118 | console.log('Unregistering ' + reg.tag); 119 | reg.unregister(); 120 | }); 121 | }); 122 | } 123 | document.getElementById(prefix + 'TagInput').value = ''; 124 | updateButtonText(prefix); 125 | }); 126 | } 127 | 128 | function getRegistrations (prefix) { 129 | var tag = document.getElementById(prefix + 'TagInput').value; 130 | navigator.serviceWorker.ready.then(function (swreg) { 131 | var manager = prefix === 'OO' ? swreg.sync : swreg.periodicSync; 132 | if (tag !== '') { 133 | manager.getRegistration(tag).then(function (reg) { 134 | console.log(tag + ': ' + objectToString(reg)); 135 | }, function (err) { 136 | console.log(err); 137 | }); 138 | } else { 139 | manager.getRegistrations().then(function (regs) { 140 | if (regs.length === 0) { 141 | console.log('No registrations to get'); 142 | } 143 | regs.forEach(function (reg) { 144 | console.log(reg.tag + ': ' + objectToString(reg)); 145 | }); 146 | }); 147 | } 148 | document.getElementById(prefix + 'TagInput').value = ''; 149 | updateButtonText(prefix); 150 | }); 151 | } 152 | 153 | function newLog (arg) { 154 | var textArea = document.getElementById('console'); 155 | textArea.value = timestamp() + ': ' + arg + '\n' + textArea.value; 156 | } 157 | 158 | function clobberlog (arg) { 159 | var oldLog = Function.prototype.bind.call(console.log, console); 160 | console.log = function (arg) { 161 | oldLog(arg); 162 | newLog(arg); 163 | }; 164 | } 165 | 166 | function timestamp () { 167 | var date = new Date(); 168 | var ms = date.getMilliseconds(); 169 | var s = date.getSeconds(); 170 | var mi = date.getMinutes(); 171 | var h = date.getHours(); 172 | var d = date.getDate(); 173 | var mo = date.getMonth() + 1; 174 | var y = date.getFullYear(); 175 | function z (num) { 176 | return '' + (num < 10 ? '0' : '') + num; 177 | } 178 | return '' + y + ':' + z(mo) + ':' + z(d) + ':' + z(h) + ':' + z(mi) + ':' + z(s) + ':' + (ms < 100 ? '0' : '') + (ms < 10 ? '0' : '') + ms; 179 | } 180 | 181 | function objectToString (object) { 182 | var toPrint = ''; 183 | for (var propertyName in object) { 184 | if (typeof object[propertyName] === 'function') { 185 | continue; 186 | } 187 | if (propertyName[0] === '_') { 188 | continue; 189 | } 190 | toPrint = toPrint + '\n\t' + propertyName + ': ' + object[propertyName]; 191 | } 192 | return toPrint; 193 | } 194 | 195 | function updateButtonText (prefix) { 196 | if (document.getElementById(prefix + 'TagInput').value === '') { 197 | document.getElementById(prefix + 'Unregister').textContent = 'Unregister All'; 198 | document.getElementById(prefix + 'Get').textContent = 'Get Registrations'; 199 | } else { 200 | document.getElementById(prefix + 'Unregister').textContent = 'Unregister'; 201 | document.getElementById(prefix + 'Get').textContent = 'Get Registration'; 202 | } 203 | } 204 | 205 | app.initialize(); 206 | -------------------------------------------------------------------------------- /sample/www/sw.js: -------------------------------------------------------------------------------- 1 | this.onsync = function(event) { 2 | var promise = new Promise(function(resolve, reject) { 3 | if (event.registration.tag === 'fail') { 4 | reject(); 5 | } 6 | var message = {}; 7 | message.tag = event.registration.tag; 8 | message.type = "one-off"; 9 | client.postMessage(message); 10 | resolve(true); 11 | }); 12 | promise.then(function() { 13 | var message = {}; 14 | message.tag = event.registration.tag; 15 | message.type = "one-off-success"; 16 | client.postMessage(message); 17 | }, function() { 18 | var message = {}; 19 | message.tag = event.registration.tag; 20 | message.type = "one-off-fail"; 21 | client.postMessage(message); 22 | }); 23 | event.waitUntil(promise); 24 | }; 25 | 26 | this.onperiodicsync = function(event) { 27 | event.waitUntil(new Promise(function(resolve, reject) { 28 | var message = {}; 29 | message.tag = event.registration.tag; 30 | message.minPeriod = event.registration.minPeriod; 31 | message.networkState = event.registration.networkState; 32 | message.powerState = event.registration.powerState; 33 | message.type = "periodic"; 34 | client.postMessage(message); 35 | resolve(true); 36 | })); 37 | }; 38 | -------------------------------------------------------------------------------- /src/ios/CDVBackgroundSync.m: -------------------------------------------------------------------------------- 1 | /* 2 | Licensed to the Apache Software Foundation (ASF) under one 3 | or more contributor license agreements. See the NOTICE file 4 | distributed with this work for additional information 5 | regarding copyright ownership. The ASF licenses this file 6 | to you under the Apache License, Version 2.0 (the 7 | "License"); you may not use this file except in compliance 8 | with the License. You may obtain a copy of the License at 9 | 10 | http://www.apache.org/licenses/LICENSE-2.0 11 | 12 | Unless required by applicable law or agreed to in writing, 13 | software distributed under the License is distributed on an 14 | "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | KIND, either express or implied. See the License for the 16 | specific language governing permissions and limitations 17 | under the License. 18 | */ 19 | 20 | #import 21 | #import "CDVConnection.h" 22 | #import 23 | #import 24 | #import "CDVServiceWorker.h" 25 | 26 | static NSString * const MIN_POSSIBLE_PERIOD = @"minperiod"; 27 | static NSString * const PUSHBACK = @"syncpushback"; 28 | static NSString * const MAX_WAIT_TIME = @"syncmaxwaittime"; 29 | static NSString * const REGISTRATION_LIST_STORAGE_KEY = @"CDVBackgroundSync_registrationList"; 30 | static NSString * const PERIODIC_REGISTRATION_LIST_STORAGE_KEY = @"CDVBackgroundSync_periodicRegistrationList"; 31 | 32 | static UIBackgroundFetchResult fetchResult = UIBackgroundFetchResultNoData; 33 | 34 | static NSInteger dispatchedSyncs = 0; 35 | static NSInteger completedSyncs = 0; 36 | 37 | static NSInteger minPossiblePeriod; 38 | static NSInteger pushback; // Pushback set for 10 minutes 39 | static NSInteger maxWaitTime; 40 | 41 | @interface CDVBackgroundSync : CDVPlugin {} 42 | 43 | typedef void(^Completion)(UIBackgroundFetchResult); 44 | 45 | @property (nonatomic, copy) NSString *syncCheckCallback; 46 | @property (nonatomic, copy) Completion completionHandler; 47 | @property (nonatomic, strong) CDVServiceWorker *serviceWorker; 48 | @property (nonatomic, strong) NSMutableDictionary *registrationList; 49 | @property (nonatomic, strong) NSMutableDictionary *periodicRegistrationList; 50 | @end 51 | 52 | static CDVBackgroundSync *backgroundSync; 53 | 54 | @implementation CDVBackgroundSync 55 | 56 | @synthesize syncCheckCallback; //Success: Initiate sync check, Failure: scheduleForegroundSync 57 | @synthesize completionHandler; 58 | @synthesize serviceWorker; 59 | @synthesize registrationList; 60 | @synthesize periodicRegistrationList; 61 | 62 | -(void)restoreRegistrations 63 | { 64 | NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults]; 65 | registrationList = [CDVBackgroundSync prepareStoredList:[defaults objectForKey:REGISTRATION_LIST_STORAGE_KEY]]; 66 | periodicRegistrationList = [CDVBackgroundSync prepareStoredList:[defaults objectForKey:PERIODIC_REGISTRATION_LIST_STORAGE_KEY]]; 67 | if ([periodicRegistrationList count] + [registrationList count]) { 68 | [[UIApplication sharedApplication] setMinimumBackgroundFetchInterval:UIApplicationBackgroundFetchIntervalMinimum]; 69 | } 70 | [self scheduleSync]; 71 | } 72 | 73 | - (void)pluginInitialize 74 | { 75 | [self restoreRegistrations]; 76 | self.serviceWorker = [self.commandDelegate getCommandInstance:@"ServiceWorker"]; 77 | [self setupSyncResponse]; 78 | [self setupPeriodicSyncResponse]; 79 | [self setupUnregister]; 80 | [self setupBackgroundFetchHandler]; 81 | [self setupServiceWorkerRegister]; 82 | [self setupServiceWorkerGetRegistrations]; 83 | [self setupServiceWorkerGetRegistration]; 84 | //Get Min Possible Period setting 85 | minPossiblePeriod = [[[self commandDelegate] settings][MIN_POSSIBLE_PERIOD] integerValue]; 86 | minPossiblePeriod = minPossiblePeriod > 1000 ? minPossiblePeriod : 1000*60*60; // If no minPossible period is given, set the default to one hour 87 | pushback = [[[self commandDelegate] settings][PUSHBACK] integerValue]; 88 | pushback = pushback > 1000 ? pushback : 1000*60*5; 89 | maxWaitTime = [[[self commandDelegate] settings][MAX_WAIT_TIME] integerValue]; 90 | maxWaitTime = maxWaitTime > 1000 ? maxWaitTime : 2*3600000; 91 | 92 | [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(networkCheckCallback) name:kReachabilityChangedNotification object:nil]; 93 | [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(batteryStateCallback) name:UIDeviceBatteryStateDidChangeNotification object:nil]; 94 | [[UIDevice currentDevice] setBatteryMonitoringEnabled:YES]; 95 | } 96 | 97 | - (void)setupBackgroundFetchHandler 98 | { 99 | backgroundSync = self; 100 | if ([[[UIApplication sharedApplication] delegate] respondsToSelector:@selector(application:performFetchWithCompletionHandler:)]) { 101 | Method original, swizzled; 102 | original = class_getInstanceMethod([self class], @selector(application:performFetchWithCompletionHandler:)); 103 | swizzled = class_getInstanceMethod([[[UIApplication sharedApplication] delegate] class], @selector(application:performFetchWithCompletionHandler:)); 104 | method_exchangeImplementations(original, swizzled); 105 | } else { 106 | class_addMethod([[[UIApplication sharedApplication] delegate] class], @selector(application:performFetchWithCompletionHandler:), class_getMethodImplementation([self class], @selector(application:performFetchWithCompletionHandler:)), nil); 107 | } 108 | } 109 | 110 | - (void)setupBackgroundSync:(CDVInvokedUrlCommand*)command 111 | { 112 | self.syncCheckCallback = command.callbackId; 113 | CDVPluginResult *result; 114 | if ([registrationList count]) { 115 | result = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsString:@"notIdle"]; 116 | [result setKeepCallback:@(YES)]; 117 | [self.commandDelegate sendPluginResult:result callbackId:syncCheckCallback]; 118 | } 119 | } 120 | 121 | + (void)validateTag:(NSString**)tag 122 | { 123 | //Take null id and turn into empty string 124 | if (*tag == (id)[NSNull null] || *tag == nil || [*tag isEqualToString:@"undefined"]) { 125 | *tag = @""; 126 | } 127 | } 128 | 129 | + (NSMutableDictionary*)prepareStoredList:(NSDictionary*)dictionary 130 | { 131 | NSMutableDictionary *toPrepare = [NSMutableDictionary dictionaryWithDictionary:dictionary]; 132 | NSMutableDictionary *prepared = [NSMutableDictionary dictionary]; 133 | for (NSString *key in toPrepare) { 134 | prepared[key] = [toPrepare[key] mutableCopy]; 135 | } 136 | return prepared; 137 | } 138 | 139 | - (void)getMinPossiblePeriod:(CDVInvokedUrlCommand*)command 140 | { 141 | CDVPluginResult *result = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsDouble:minPossiblePeriod]; 142 | [self.commandDelegate sendPluginResult:result callbackId:command.callbackId]; 143 | } 144 | 145 | - (void)cordovaRegister:(CDVInvokedUrlCommand*)command 146 | { 147 | if ([[command argumentAtIndex:1] isEqualToString:@"periodic"] && [[command argumentAtIndex:0][@"minPeriod"] integerValue] < minPossiblePeriod) { 148 | CDVPluginResult *result = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:@"Invalid minPeriod"]; 149 | [self.commandDelegate sendPluginResult:result callbackId:command.callbackId]; 150 | return; 151 | } 152 | NSMutableDictionary *list = [[command argumentAtIndex:1] isEqualToString:@"periodic"] ? periodicRegistrationList : registrationList; 153 | [self register:[command argumentAtIndex:0] inList:&list]; 154 | CDVPluginResult *result = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK]; 155 | [self.commandDelegate sendPluginResult:result callbackId:command.callbackId]; 156 | } 157 | 158 | - (void)setupServiceWorkerRegister 159 | { 160 | __weak CDVBackgroundSync* weakSelf = self; 161 | serviceWorker.context[@"CDVBackgroundSync_register"] = ^(JSValue *registration, JSValue *syncType, JSValue *successCallback, JSValue *failureCallback) { 162 | if ([[syncType toString] isEqualToString:@"periodic"] && [[registration toDictionary][@"minPeriod"] integerValue] < minPossiblePeriod) { 163 | [failureCallback callWithArguments:nil]; 164 | return; 165 | } 166 | NSMutableDictionary *list = [[syncType toString] isEqualToString:@"periodic"] ? weakSelf.periodicRegistrationList : weakSelf.registrationList; 167 | [weakSelf register:[registration toDictionary] inList:&list]; 168 | [successCallback callWithArguments:nil]; 169 | }; 170 | } 171 | 172 | - (void)register:(NSDictionary *)registration inList:(NSMutableDictionary**)list 173 | { 174 | NSString *tag = registration[@"tag"]; 175 | [CDVBackgroundSync validateTag:&tag]; 176 | [self unregisterSyncByTag: tag fromRegistrationList:*list]; 177 | (*list)[tag] = [NSMutableDictionary dictionaryWithDictionary:registration]; 178 | NSLog(@"Registering %@", tag); 179 | //Save the list 180 | NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults]; 181 | NSString *storageKey = *list == registrationList ? REGISTRATION_LIST_STORAGE_KEY : PERIODIC_REGISTRATION_LIST_STORAGE_KEY; 182 | [defaults setObject:*list forKey:storageKey]; 183 | [[UIApplication sharedApplication] setMinimumBackgroundFetchInterval:UIApplicationBackgroundFetchIntervalMinimum]; 184 | if (*list == registrationList && [self getNetworkStatus]) { 185 | [self fireSyncEventForRegistration:registration]; 186 | return; 187 | } 188 | if (*list == periodicRegistrationList) { 189 | [self scheduleSync]; 190 | } 191 | } 192 | 193 | - (void)getRegistrations:(CDVInvokedUrlCommand*)command 194 | { 195 | NSMutableDictionary *list = [[command argumentAtIndex:0] isEqualToString:@"periodic"] ? periodicRegistrationList : registrationList; 196 | if (list == nil) { 197 | CDVPluginResult *result = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsArray:@[]]; 198 | [self.commandDelegate sendPluginResult:result callbackId:command.callbackId]; 199 | } else { 200 | CDVPluginResult *result = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsArray:[list allValues]]; 201 | [self.commandDelegate sendPluginResult:result callbackId:command.callbackId]; 202 | } 203 | } 204 | 205 | - (void)setupServiceWorkerGetRegistrations 206 | { 207 | __weak CDVBackgroundSync* weakSelf = self; 208 | serviceWorker.context[@"CDVBackgroundSync_getRegistrations"] = ^(JSValue *syncType, JSValue *callback) { 209 | NSMutableDictionary *list = [[syncType toString] isEqualToString:@"periodic"] ? weakSelf.periodicRegistrationList : weakSelf.registrationList; 210 | if (list != nil && [list count]) { 211 | [callback callWithArguments:@[[list allValues]]]; 212 | } else { 213 | [callback callWithArguments:@[@[]]]; 214 | } 215 | }; 216 | } 217 | 218 | - (void)getRegistration:(CDVInvokedUrlCommand*)command 219 | { 220 | NSString *tag = [command argumentAtIndex:0]; 221 | NSMutableDictionary *list = [[command argumentAtIndex:1] isEqualToString:@"periodic"] ? periodicRegistrationList : registrationList; 222 | if (list[tag]) { 223 | CDVPluginResult *result = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsDictionary:list[tag]]; 224 | [self.commandDelegate sendPluginResult:result callbackId:command.callbackId]; 225 | } else { 226 | CDVPluginResult *result = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:[NSString stringWithFormat:@"Could not find %@", tag]]; 227 | [self.commandDelegate sendPluginResult:result callbackId:command.callbackId]; 228 | } 229 | } 230 | 231 | - (void)setupServiceWorkerGetRegistration 232 | { 233 | __weak CDVBackgroundSync* weakSelf = self; 234 | serviceWorker.context[@"CDVBackgroundSync_getRegistration"] = ^(JSValue *tag, JSValue* syncType, JSValue *successCallback, JSValue *failureCallback) { 235 | NSMutableDictionary *list = [[syncType toString] isEqualToString:@"periodic"] ? weakSelf.periodicRegistrationList : weakSelf.registrationList; 236 | if (list[[tag toString]]) { 237 | [successCallback callWithArguments:@[list[[tag toString]]]]; 238 | } else { 239 | [failureCallback callWithArguments:@[@"Could not find %@", [tag toString]]]; 240 | } 241 | }; 242 | } 243 | 244 | - (void)setupUnregister 245 | { 246 | __weak CDVBackgroundSync* weakSelf = self; 247 | 248 | // Set up service worker unregister event 249 | serviceWorker.context[@"CDVBackgroundSync_unregisterSync"] = ^(JSValue *tag, JSValue *syncType) { 250 | NSMutableDictionary *list = [[syncType toString] isEqualToString:@"periodic"] ? weakSelf.periodicRegistrationList : weakSelf.registrationList; 251 | [weakSelf unregisterSyncByTag:[tag toString] fromRegistrationList:list]; 252 | 253 | }; 254 | } 255 | 256 | - (void)unregister:(CDVInvokedUrlCommand*)command 257 | { 258 | NSMutableDictionary *list = [[command argumentAtIndex:1] isEqualToString:@"periodic"] ? periodicRegistrationList : registrationList; 259 | CDVPluginResult *result = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsBool:[self unregisterSyncByTag:[command argumentAtIndex:0] fromRegistrationList:list]]; 260 | [self.commandDelegate sendPluginResult:result callbackId:command.callbackId]; 261 | } 262 | 263 | - (BOOL)unregisterSyncByTag:(NSString*)tag fromRegistrationList:(NSMutableDictionary*)list 264 | { 265 | [CDVBackgroundSync validateTag:&tag]; 266 | if (list[tag]) { 267 | NSLog(@"Unregistering %@", tag); 268 | [list removeObjectForKey:tag]; 269 | 270 | NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults]; 271 | NSString *storageKey = list == registrationList ? REGISTRATION_LIST_STORAGE_KEY : PERIODIC_REGISTRATION_LIST_STORAGE_KEY; 272 | [defaults setObject:list forKey:storageKey]; 273 | return YES; 274 | } else { 275 | NSLog(@"Could not find %@ to unregister", tag); 276 | return NO; 277 | } 278 | } 279 | 280 | - (void)markNoDataCompletion:(CDVInvokedUrlCommand*)command 281 | { 282 | if (completionHandler != nil) { 283 | NSLog(@"Executing No Data Completion Handler"); 284 | completionHandler(UIBackgroundFetchResultNoData); 285 | completionHandler = nil; 286 | } 287 | CDVPluginResult *result = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK]; 288 | [self.commandDelegate sendPluginResult:result callbackId:command.callbackId]; 289 | } 290 | 291 | - (void)setupSyncResponse 292 | { 293 | //create weak reference to self in order to prevent retain cycle in block 294 | __weak CDVBackgroundSync* weakSelf = self; 295 | 296 | //Indicate to OS success or failure and unregister syncs that have been successfully executed and are not periodic 297 | serviceWorker.context[@"sendSyncResponse"] = ^(JSValue *responseType, JSValue *jsTag) { 298 | NSString *tag = [jsTag toString]; 299 | [CDVBackgroundSync validateTag:&tag]; 300 | completedSyncs++; 301 | switch ([responseType toInt32]) { 302 | case 0: 303 | if (fetchResult != UIBackgroundFetchResultFailed) { 304 | fetchResult = UIBackgroundFetchResultNewData; 305 | } 306 | [weakSelf unregisterSyncByTag:tag fromRegistrationList:weakSelf.registrationList]; 307 | break; 308 | case 2: 309 | NSLog(@"Failed to get data"); 310 | fetchResult = UIBackgroundFetchResultFailed; 311 | default: 312 | // Push back the failed registration 313 | if (![weakSelf.periodicRegistrationList count]) { 314 | [weakSelf performSelector:@selector(foregroundSync) withObject:nil afterDelay:pushback/1000]; 315 | } 316 | break; 317 | } 318 | if (completedSyncs == dispatchedSyncs) { 319 | // Reset the sync count 320 | completedSyncs = 0; 321 | dispatchedSyncs = 0; 322 | fetchResult = UIBackgroundFetchResultNoData; 323 | 324 | //If we have no more registrations left, turn off background fetch 325 | if (![weakSelf.registrationList count] && ![weakSelf.periodicRegistrationList count]) { 326 | [[UIApplication sharedApplication] setMinimumBackgroundFetchInterval:UIApplicationBackgroundFetchIntervalNever]; 327 | } 328 | if (weakSelf.completionHandler != nil) { 329 | NSLog(@"Executing Completion Handler"); 330 | weakSelf.completionHandler(fetchResult); 331 | weakSelf.completionHandler = nil; 332 | } 333 | } 334 | 335 | }; 336 | } 337 | 338 | - (void)setupPeriodicSyncResponse 339 | { 340 | //create weak reference to self in order to prevent retain cycle in block 341 | __weak CDVBackgroundSync* weakSelf = self; 342 | 343 | //Indicate to OS success or failure and unregister syncs that have been successfully executed and are not periodic 344 | serviceWorker.context[@"sendPeriodicSyncResponse"] = ^(JSValue *responseType, JSValue *jsTag) { 345 | NSString *tag = [jsTag toString]; 346 | [CDVBackgroundSync validateTag:&tag]; 347 | completedSyncs++; 348 | switch ([responseType toInt32]) { 349 | case 0: 350 | if (fetchResult != UIBackgroundFetchResultFailed) { 351 | fetchResult = UIBackgroundFetchResultNewData; 352 | } 353 | //Reschedule the sync by retimestamping 354 | weakSelf.periodicRegistrationList[tag][@"_timestamp"] = @([NSDate date].timeIntervalSince1970 * 1000); 355 | break; 356 | case 2: 357 | NSLog(@"Failed to get data"); 358 | fetchResult = UIBackgroundFetchResultFailed; 359 | default: 360 | // Pushback failed sync by retimestamping with not current time, but with original timestamp + pushback time 361 | weakSelf.periodicRegistrationList[tag][@"_timestamp"] = @([weakSelf.periodicRegistrationList[tag][@"_timestamp"] integerValue] + pushback); 362 | break; 363 | } 364 | 365 | NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults]; 366 | [defaults setObject:weakSelf.periodicRegistrationList forKey:PERIODIC_REGISTRATION_LIST_STORAGE_KEY]; 367 | 368 | // Make sure we received all the syncs before determining completion 369 | if (completedSyncs == dispatchedSyncs) { 370 | // Reset the sync count 371 | completedSyncs = 0; 372 | dispatchedSyncs = 0; 373 | 374 | fetchResult = UIBackgroundFetchResultNoData; 375 | 376 | //If we have no more registrations left, turn off background fetch 377 | if (![weakSelf.registrationList count] && ![weakSelf.periodicRegistrationList count]) { 378 | [[UIApplication sharedApplication] setMinimumBackgroundFetchInterval:UIApplicationBackgroundFetchIntervalNever]; 379 | } 380 | [weakSelf scheduleSync]; 381 | NSLog(@"Rescheduling %@", tag); 382 | if (weakSelf.completionHandler != nil) { 383 | NSLog(@"Executing Completion Handler"); 384 | weakSelf.completionHandler(fetchResult); 385 | weakSelf.completionHandler = nil; 386 | } 387 | } 388 | }; 389 | } 390 | 391 | - (void)networkCheckCallback 392 | { 393 | if ([self getNetworkStatus]) 394 | { 395 | NSLog(@"Regained network"); 396 | // Dispatch all one off sync events 397 | [self dispatchSyncEvents]; 398 | [self scheduleSync]; 399 | } else { 400 | NSLog(@"Lost Connection"); 401 | } 402 | } 403 | 404 | - (void)evaluateSyncs 405 | { 406 | // Force update reachability status because otherwise network status won't be updated when in background 407 | CDVConnection *connection = [self.commandDelegate getCommandInstance:@"NetworkStatus"]; 408 | [connection performSelector:@selector(updateReachability:) withObject:connection.internetReach]; // Very much declared in CDVConnection 409 | // This should never happen, but just in case there are no registrations and a sync event is initiated 410 | if (![registrationList count] && ![periodicRegistrationList count]) { 411 | if (completionHandler) { 412 | self.completionHandler(UIBackgroundFetchResultNoData); 413 | } 414 | return; 415 | } 416 | NSLog(@"Fetching"); 417 | if ([self getNetworkStatus]) { 418 | [self dispatchSyncEvents]; 419 | } else if ([registrationList count]) { 420 | fetchResult = UIBackgroundFetchResultFailed; 421 | } 422 | [self evaluatePeriodicSyncRegistrations]; 423 | 424 | // If there is no connection during a background fetch but there exist one off registrations 425 | if (![periodicRegistrationList count] && ![self getNetworkStatus]) { 426 | NSLog(@"Failed to sync"); 427 | self.completionHandler(UIBackgroundFetchResultFailed); 428 | self.completionHandler = nil; 429 | } 430 | } 431 | 432 | - (void)application:(UIApplication*)application performFetchWithCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler{ 433 | backgroundSync.completionHandler = completionHandler; 434 | [backgroundSync evaluateSyncs]; 435 | } 436 | 437 | - (void)dispatchSyncEvents 438 | { 439 | for (NSDictionary *registration in [registrationList allValues]) { 440 | //Increment the counter of dispatched syncs 441 | [self fireSyncEventForRegistration:registration]; 442 | } 443 | } 444 | 445 | - (void)fireSyncEventForRegistration:(NSDictionary*)registration 446 | { 447 | dispatchedSyncs++; 448 | NSError *error; 449 | NSData *json = [NSJSONSerialization dataWithJSONObject:registration options:0 error:&error]; 450 | NSString *dispatchCode = [NSString stringWithFormat:@"FireSyncEvent(%@);", [[NSString alloc] initWithData:json encoding:NSUTF8StringEncoding]]; 451 | [serviceWorker.context performSelectorOnMainThread:@selector(evaluateScript:) withObject:dispatchCode waitUntilDone:NO]; 452 | } 453 | 454 | - (void)evaluatePeriodicSyncRegistrations 455 | { 456 | for (NSDictionary *registration in [periodicRegistrationList allValues]) { 457 | if ([registration[@"_timestamp"] integerValue] + [registration[@"minPeriod"] integerValue] > [NSDate date].timeIntervalSince1970 * 1000) { 458 | continue; 459 | } 460 | NSInteger networkStatus = [self getNetworkStatus]; 461 | if (([registration[@"networkState"] isEqualToString:@"online"] && networkStatus < 1) || [registration[@"networkState"] isEqualToString:@"avoid-cellular"] && networkStatus < 2) { 462 | continue; 463 | } 464 | if ([registration[@"powerState"] isEqualToString:@"avoid-draining"] && ![self isCharging]) { 465 | continue; 466 | } 467 | [self dispatchPeriodicSyncEvent:registration]; 468 | } 469 | } 470 | 471 | - (void)dispatchPeriodicSyncEvent:(NSDictionary *)registration 472 | { 473 | //Increment the counter of dispatched syncs 474 | dispatchedSyncs++; 475 | 476 | // If we need all of the object properties 477 | NSError *error; 478 | NSData *json = [NSJSONSerialization dataWithJSONObject:registration options:0 error:&error]; 479 | NSString *dispatchCode = [NSString stringWithFormat:@"FirePeriodicSyncEvent(%@);", [[NSString alloc] initWithData:json encoding:NSUTF8StringEncoding]]; 480 | [serviceWorker.context performSelectorOnMainThread:@selector(evaluateScript:) withObject:dispatchCode waitUntilDone:NO]; 481 | } 482 | 483 | - (NSInteger)getNetworkStatus 484 | { 485 | CDVConnection *connection = [self.commandDelegate getCommandInstance:@"NetworkStatus"]; 486 | // TODO: Recall connection updateReachability so that the connection status is updated when in background 487 | if ([connection.connectionType isEqualToString:@"wifi"]) { 488 | return 2; 489 | } else if ([connection.connectionType isEqualToString:@"cellular"]) { 490 | return 1; 491 | } else { 492 | return 0; 493 | } 494 | } 495 | 496 | - (BOOL)isCharging 497 | { 498 | return [[UIDevice currentDevice] batteryState] == UIDeviceBatteryStateCharging || [[UIDevice currentDevice] batteryState] == UIDeviceBatteryStateFull; 499 | } 500 | 501 | - (void)batteryStateCallback 502 | { 503 | if ([[UIDevice currentDevice] batteryState] == UIDeviceBatteryStateCharging) { 504 | // Device has been plugged in 505 | [self scheduleSync]; 506 | } else { 507 | // Device has been unplugged 508 | } 509 | } 510 | 511 | - (void)hasPermission:(CDVInvokedUrlCommand*)command 512 | { 513 | if ([[UIApplication sharedApplication] backgroundRefreshStatus] == UIBackgroundRefreshStatusAvailable) { 514 | CDVPluginResult *result = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsString:@"granted"]; 515 | [self.commandDelegate sendPluginResult:result callbackId:command.callbackId]; 516 | } else { 517 | CDVPluginResult *result = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsString:@"denied"]; 518 | [self.commandDelegate sendPluginResult:result callbackId:command.callbackId]; 519 | } 520 | } 521 | 522 | - (void)foregroundSync 523 | { 524 | // Prevent duplicate "evaluateSyncs" calls that might happen during background fetch event 525 | if (!completionHandler) { 526 | [self evaluateSyncs]; 527 | } 528 | } 529 | 530 | - (void)scheduleSync 531 | { 532 | if (!periodicRegistrationList || ![periodicRegistrationList count]) { 533 | return; 534 | } 535 | double delay = 0; 536 | double min = 0; 537 | for (NSDictionary *registration in [periodicRegistrationList allValues]) { 538 | double possibleMin = [registration[@"_timestamp"] doubleValue] + [registration[@"minPeriod"] doubleValue]; 539 | if (!min || possibleMin < min) { 540 | min = possibleMin; 541 | } 542 | } 543 | double bestTime = 0; 544 | for (NSDictionary *registration in [periodicRegistrationList allValues]) { 545 | double possibleBestTime = [registration[@"_timestamp"] doubleValue] + [registration[@"minPeriod"] doubleValue]; 546 | if (possibleBestTime < min + maxWaitTime && possibleBestTime > bestTime) { 547 | bestTime = possibleBestTime; 548 | } 549 | } 550 | if (bestTime) { 551 | delay = ceil(bestTime/1000.0 - [NSDate date].timeIntervalSince1970); 552 | } 553 | NSLog(@"Delay: %@", @(delay)); 554 | [NSObject cancelPreviousPerformRequestsWithTarget:self selector:@selector(foregroundSync) object:nil]; 555 | [self performSelector:@selector(foregroundSync) withObject:nil afterDelay:delay]; 556 | } 557 | @end 558 | -------------------------------------------------------------------------------- /tests/plugin.xml: -------------------------------------------------------------------------------- 1 | 2 | 20 | 21 | 24 | Cordova Background Sync Plugin Tests 25 | Apache 2.0 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /tests/sw.js: -------------------------------------------------------------------------------- 1 | this.onsync = function(event) { 2 | event.waitUntil(new Promise(function(resolve, reject) { 3 | var message = { 4 | tag: event.registration.tag || "syncEvent" 5 | }; 6 | client.postMessage(message); 7 | resolve(true); 8 | })); 9 | }; 10 | 11 | this.onperiodicsync = function(event) { 12 | console.log("Sw script onperiodicsync was invoked"); 13 | event.waitUntil(new Promise(function(resolve, reject) { 14 | var message = {}; 15 | message.tag = event.registration.tag; 16 | message.minPeriod = event.registration.minPeriod; 17 | message.networkState = event.registration.networkState; 18 | message.powerState = event.registration.powerState; 19 | client.postMessage(message); 20 | resolve(true); 21 | })); 22 | }; 23 | -------------------------------------------------------------------------------- /tests/tests.js: -------------------------------------------------------------------------------- 1 | /* 2 | * 3 | * Licensed to the Apache Software Foundation (ASF) under one 4 | * or more contributor license agreements. See the NOTICE file 5 | * distributed with this work for additional information 6 | * regarding copyright ownership. The ASF licenses this file 7 | * to you under the Apache License, Version 2.0 (the 8 | * "License"); you may not use this file except in compliance 9 | * with the License. You may obtain a copy of the License at 10 | * 11 | * http://www.apache.org/licenses/LICENSE-2.0 12 | * 13 | * Unless required by applicable law or agreed to in writing, 14 | * software distributed under the License is distributed on an 15 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 | * KIND, either express or implied. See the License for the 17 | * specific language governing permissions and limitations 18 | * under the License. 19 | * 20 | */ 21 | 22 | exports.defineAutoTests = function () { 23 | 24 | describe('Background Sync (SyncManagers)', function () { 25 | it('service worker registration should have a SyncManager', function (done) { 26 | navigator.serviceWorker.ready.then(function (swreg) { 27 | expect(swreg.sync).toBeDefined(); 28 | done(); 29 | }); 30 | }); 31 | it('service worker registration should have a PeriodicSyncManager', function (done) { 32 | navigator.serviceWorker.ready.then(function (swreg) { 33 | expect(swreg.periodicSync).toBeDefined(); 34 | done(); 35 | }); 36 | }); 37 | }); 38 | 39 | describe('Check SyncManager API', function () { 40 | it('sync.register() exists as a function', function (done) { 41 | navigator.serviceWorker.ready.then(function (swreg) { 42 | expect(swreg.sync.register).toBeDefined(); 43 | expect(typeof swreg.sync.register == 'function').toBe(true); 44 | done(); 45 | }); 46 | }); 47 | it('sync.getRegistration() exists as a function', function (done) { 48 | navigator.serviceWorker.ready.then(function (swreg) { 49 | expect(swreg.sync.getRegistration).toBeDefined(); 50 | expect(typeof swreg.sync.getRegistration == 'function').toBe(true); 51 | done(); 52 | }); 53 | }); 54 | it('sync.getRegistrations() exists as a function', function (done) { 55 | navigator.serviceWorker.ready.then(function (swreg) { 56 | expect(swreg.sync.getRegistrations).toBeDefined(); 57 | expect(typeof swreg.sync.getRegistrations == 'function').toBe(true); 58 | done(); 59 | }); 60 | }); 61 | it('sync.permissionState() exists as a function', function (done) { 62 | navigator.serviceWorker.ready.then(function (swreg) { 63 | expect(swreg.sync.permissionState).toBeDefined(); 64 | expect(typeof swreg.sync.permissionState == 'function').toBe(true); 65 | done(); 66 | }); 67 | }); 68 | }); 69 | describe('Check PeriodicSyncManager API', function () { 70 | it('periodicSync.register() exists as a function', function (done) { 71 | navigator.serviceWorker.ready.then(function (swreg) { 72 | expect(swreg.periodicSync.register).toBeDefined(); 73 | expect(typeof swreg.periodicSync.register == 'function').toBe(true); 74 | done(); 75 | }); 76 | }); 77 | it('periodicSync.getRegistration() exists as a function', function (done) { 78 | navigator.serviceWorker.ready.then(function (swreg) { 79 | expect(swreg.periodicSync.getRegistration).toBeDefined(); 80 | expect(typeof swreg.periodicSync.getRegistration == 'function').toBe(true); 81 | done(); 82 | }); 83 | }); 84 | it('periodicSync.getRegistrations() exists as a function', function (done) { 85 | navigator.serviceWorker.ready.then(function (swreg) { 86 | expect(swreg.periodicSync.getRegistrations).toBeDefined(); 87 | expect(typeof swreg.periodicSync.getRegistrations == 'function').toBe(true); 88 | done(); 89 | }); 90 | }); 91 | it('periodicSync.permissionState() exists as a function', function (done) { 92 | navigator.serviceWorker.ready.then(function (swreg) { 93 | expect(swreg.periodicSync.permissionState).toBeDefined(); 94 | expect(typeof swreg.periodicSync.permissionState == 'function').toBe(true); 95 | done(); 96 | }); 97 | }); 98 | it('periodicSync.minPossiblePeriod exists as a number', function (done) { 99 | navigator.serviceWorker.ready.then(function (swreg) { 100 | expect(swreg.periodicSync.minPossiblePeriod).toBeDefined(); 101 | expect(swreg.periodicSync.minPossiblePeriod).toEqual(jasmine.any(Number)); 102 | done(); 103 | }); 104 | }); 105 | }); 106 | 107 | describe('Check SyncManager Functionality', function () { 108 | var messageCallback; 109 | var swreg; 110 | var clearAllRegs = function (done) { 111 | navigator.serviceWorker.ready.then(function (swreg) { 112 | swreg.sync.getRegistrations().then(function (regs) { 113 | regs.forEach(function(reg) { 114 | reg.unregister(); 115 | }); 116 | done(); 117 | }, 118 | function (err) { 119 | done(); 120 | }); 121 | }); 122 | }; 123 | navigator.serviceWorker.ready.then(function (reg) { 124 | swreg = reg; 125 | }); 126 | beforeEach(function(done) { 127 | clearAllRegs(done); 128 | }); 129 | afterEach(function(done) { 130 | clearAllRegs(done); 131 | window.removeEventListener('message', messageCallback); 132 | }); 133 | 134 | it('sync.permissionState returns granted', function (done) { 135 | swreg.sync.permissionState().then(function (status) { 136 | expect(status).toEqual('granted'); 137 | done(); 138 | }, 139 | function (err) { 140 | expect(false).toBe(true); 141 | done(); 142 | }); 143 | }); 144 | it('getRegistrations resolves empty list when nothing has been registered', function (done) { 145 | swreg.sync.getRegistrations().then(function (regs) { 146 | expect(regs.length).toEqual(0); 147 | done(); 148 | }, 149 | function (err) { 150 | expect(false).toBe(true); 151 | done(); 152 | }); 153 | }); 154 | it('getRegistration rejects on empty list', function (done) { 155 | swreg.sync.getRegistration('nonexistent').then(function () { 156 | expect(false).toBe(true); 157 | done(); 158 | }, 159 | function () { 160 | done(); 161 | }); 162 | }); 163 | it('empty registration creates instant sync', function (done) { 164 | messageCallback = function() { 165 | done(); 166 | }; 167 | window.addEventListener('message', messageCallback); 168 | swreg.sync.register().then(function () { 169 | }, 170 | function (err) { 171 | expect(false).toBe(true); 172 | done(); 173 | }); 174 | }); 175 | }); 176 | 177 | describe('Check PeriodicSyncManager Functionality', function () { 178 | var messageCallback; 179 | var swreg; 180 | var clearAllRegs = function (done) { 181 | navigator.serviceWorker.ready.then(function (swreg) { 182 | swreg.periodicSync.getRegistrations().then(function (regs) { 183 | regs.forEach(function(reg) { 184 | reg.unregister(); 185 | }); 186 | done(); 187 | }, 188 | function (err) { 189 | done(); 190 | }); 191 | }); 192 | }; 193 | navigator.serviceWorker.ready.then(function (reg) { 194 | swreg = reg; 195 | }); 196 | beforeEach(function(done) { 197 | clearAllRegs(done); 198 | }); 199 | afterEach(function(done) { 200 | clearAllRegs(done); 201 | window.removeEventListener('message', messageCallback); 202 | }); 203 | 204 | it('periodicSync.permissionState returns granted', function (done) { 205 | swreg.periodicSync.permissionState().then(function (status) { 206 | expect(status).toEqual('granted'); 207 | done(); 208 | }, 209 | function (err) { 210 | expect(false).toBe(true); 211 | done(); 212 | }); 213 | }); 214 | it('getRegistrations with empty list', function (done) { 215 | swreg.periodicSync.getRegistrations().then(function (regs) { 216 | expect(regs.length).toEqual(0); 217 | done(); 218 | }, 219 | function (err) { 220 | expect(false).toBe(true); 221 | done(); 222 | }); 223 | }); 224 | it('getRegistration rejects on empty list', function (done) { 225 | swreg.periodicSync.getRegistration('nonexistent').then(function () { 226 | expect(false).toBe(true); 227 | done(); 228 | }, 229 | function () { 230 | done(); 231 | }); 232 | }); 233 | it('getRegistration rejects for nonexistent tag', function (done) { 234 | swreg.periodicSync.register({tag:'exists', minPeriod: 10000000}).then(function () { 235 | swreg.periodicSync.getRegistration('nonexistent').then(function () { 236 | expect(false).toBe(true); 237 | done(); 238 | }, 239 | function () { 240 | done(); 241 | }); 242 | }, 243 | function () { 244 | expect(false).toBe(true); 245 | done(); 246 | }); 247 | }); 248 | it('Registing empty periodicSync should reject for lack of minPeriod', function (done) { 249 | swreg.periodicSync.register().then(function() { 250 | expect(false).toBe(true); 251 | done(); 252 | }, function (err) { 253 | expect(err).toEqual('Invalid minPeriod'); 254 | done(); 255 | }); 256 | }); 257 | it('register and getRegistrations with one element', function (done) { 258 | swreg.periodicSync.register({'minPeriod':500000000}).then(function (regs) { 259 | swreg.periodicSync.getRegistrations().then(function (regs) { 260 | expect(regs.length).toBe(1); 261 | done(); 262 | }, 263 | function (err) { 264 | expect(false).toBe(true); 265 | done(); 266 | }); 267 | }, 268 | function (err) { 269 | expect(false).toBe(true); 270 | done(); 271 | }); 272 | }); 273 | it('registrations received from getRegistrations .unregister()', function (done) { 274 | swreg.periodicSync.register({'minPeriod':500000000}).then(function () { 275 | swreg.periodicSync.getRegistrations().then(function (regs) { 276 | expect(regs.length).toBe(1); 277 | regs.forEach(function(reg) { 278 | reg.unregister(); 279 | }); 280 | done(); 281 | }, 282 | function (err) { 283 | expect(false).toBe(true); 284 | done(); 285 | }); 286 | }, 287 | function (err) { 288 | expect(false).toBe(true); 289 | done(); 290 | }); 291 | }); 292 | it('getRegistration resolves correct single registration', function (done) { 293 | swreg.periodicSync.register({tag:'1', minPeriod: 10000000}).then(function () { 294 | swreg.periodicSync.register({tag:'2', minPeriod:100000000, networkState:'any', powerState:'avoid-draining'}).then(function () { 295 | swreg.periodicSync.register({tag:'3', minPeriod: 10000000}).then(function () { 296 | swreg.periodicSync.getRegistrations().then(function (regs) { 297 | expect(regs.length).toEqual(3); 298 | swreg.periodicSync.getRegistration('2').then(function (reg) { 299 | expect(reg.tag).toEqual('2'); 300 | expect(reg.minPeriod).toEqual(100000000); 301 | expect(reg.powerState).toEqual('avoid-draining'); 302 | expect(reg.networkState).toEqual('any'); 303 | done(); 304 | }, 305 | function () { 306 | expect(false).toBe(true); 307 | done(); 308 | }); 309 | }, 310 | function () { 311 | expect(false).toBe(true); 312 | done(); 313 | }); 314 | }, 315 | function () { 316 | expect(false).toBe(true); 317 | done(); 318 | }); 319 | }, 320 | function () { 321 | expect(false).toBe(true); 322 | done(); 323 | }); 324 | }, 325 | function () { 326 | expect(false).toBe(true); 327 | done(); 328 | }); 329 | }); 330 | it('same tag registrations get overwritten', function (done) { 331 | messageCallback = function(event) { 332 | expect(event.data.tag).toEqual('test'); 333 | expect(event.data.minPeriod).toEqual(2000); 334 | done(); 335 | }; 336 | window.addEventListener('message', messageCallback); 337 | swreg.periodicSync.register({tag:'test', minPeriod:500000000}).then(function () { 338 | swreg.periodicSync.register({tag:'test', minPeriod:2000}).then(function () { 339 | swreg.periodicSync.getRegistrations().then(function(regs) { 340 | expect(regs.length).toEqual(1); 341 | }, 342 | function (err) { 343 | expect(false).toBe(true); 344 | done(); 345 | }); 346 | }, 347 | function (err) { 348 | expect(false).toBe(true); 349 | done(); 350 | }); 351 | }, 352 | function (err) { 353 | expect(false).toBe(true); 354 | done(); 355 | }); 356 | }); 357 | it('empty tag registrations get overwritten', function (done) { 358 | messageCallback = function(event) { 359 | expect(event.data.tag).toEqual(''); 360 | expect(event.data.minPeriod).toEqual(2000); 361 | done(); 362 | }; 363 | window.addEventListener('message', messageCallback); 364 | swreg.periodicSync.register({minPeriod:5000000000}).then(function () { 365 | swreg.periodicSync.register({minPeriod:2000}).then(function () { 366 | swreg.periodicSync.getRegistrations().then(function(regs) { 367 | expect(regs.length).toEqual(1); 368 | }, 369 | function (err) { 370 | expect(false).toBe(true); 371 | done(); 372 | }); 373 | }, 374 | function (err) { 375 | expect(false).toBe(true); 376 | done(); 377 | }); 378 | }, 379 | function (err) { 380 | expect(false).toBe(true); 381 | done(); 382 | }); 383 | }); 384 | }); 385 | 386 | describe('Verify Syncing and Batching', function () { 387 | var originalTimeout; 388 | var messageCallback; 389 | var swreg; 390 | var clearAllRegs = function (done) { 391 | navigator.serviceWorker.ready.then(function (swreg) { 392 | swreg.periodicSync.getRegistrations().then(function (regs) { 393 | regs.forEach(function(reg) { 394 | reg.unregister(); 395 | }); 396 | done(); 397 | }, 398 | function (err) { 399 | done(); 400 | }); 401 | }); 402 | }; 403 | navigator.serviceWorker.ready.then(function (reg) { 404 | swreg = reg; 405 | }); 406 | beforeEach(function(done) { 407 | originalTimeout = jasmine.DEFAULT_TIMEOUT_INTERVAL; 408 | jasmine.DEFAULT_TIMEOUT_INTERVAL = 10000; 409 | clearAllRegs(done); 410 | }); 411 | afterEach(function(done) { 412 | jasmine.DEFAULT_TIMEOUT_INTERVAL = originalTimeout; 413 | clearAllRegs(done); 414 | window.removeEventListener('message', messageCallback); 415 | }); 416 | it('batch short period periodicSync with longer period periodicSync', function (done) { 417 | var periodicSyncCount = 0; 418 | var instantDispatchTime; 419 | messageCallback = function(event) { 420 | periodicSyncCount++; 421 | if (event.data.tag === 'short') { 422 | expect(Date.now() - instantDispatchTime).toBeGreaterThan(2999); 423 | } 424 | if (event.data.tag === 'long') { 425 | expect(periodicSyncCount).toEqual(2); 426 | done(); 427 | } 428 | }; 429 | window.addEventListener('message', messageCallback); 430 | instantDispatchTime = Date.now(); 431 | swreg.periodicSync.register({tag:'short', minPeriod:2000}).then(function () { 432 | swreg.periodicSync.register({tag:'long', minPeriod:3000}).then(function () { 433 | swreg.periodicSync.getRegistrations().then(function (regs) { 434 | expect(regs.length).toEqual(2); 435 | }, 436 | function () { 437 | expect(false).toBe(true); 438 | }); 439 | }, 440 | function () { 441 | expect(false).toBe(true); 442 | }); 443 | }, 444 | function (err) { 445 | expect(false).toBe(true); 446 | done(); 447 | }); 448 | }); 449 | it('short period periodicSync should fire without waiting for long period sync outside threshold', function (done) { 450 | var periodicSyncCount = 0; 451 | messageCallback = function(event) { 452 | periodicSyncCount++; 453 | expect(event.data.tag).toEqual('short'); 454 | expect(periodicSyncCount).toEqual(1); 455 | done(); 456 | }; 457 | window.addEventListener('message', messageCallback); 458 | swreg.periodicSync.register({tag:'long', minPeriod:24*3600*1000}).then(function (reg) { 459 | swreg.periodicSync.register({tag:'short', minPeriod:2000}).then(function () { 460 | swreg.periodicSync.getRegistrations().then(function(regs) { 461 | expect(regs.length).toEqual(2); 462 | }); 463 | }, 464 | function () { 465 | expect(false).toBe(true); 466 | }); 467 | }, 468 | function (err) { 469 | expect(false).toBe(true); 470 | done(); 471 | }); 472 | }); 473 | it('periodic periodicSync reschedules with correct minPeriod', function (done) { 474 | var periodicSyncCount = 0; 475 | var initTime; 476 | messageCallback = function(event) { 477 | periodicSyncCount++; 478 | if (periodicSyncCount == 1) { 479 | expect(Date.now() - initTime).toBeLessThan(3100); 480 | initTime = Date.now(); 481 | } 482 | if (periodicSyncCount > 1) { 483 | expect(Date.now() - initTime).toBeGreaterThan(3000); 484 | initTime = Date.now(); 485 | } 486 | if (periodicSyncCount == 3) { 487 | swreg.periodicSync.getRegistrations().then(function (regs) { 488 | expect(regs.length).toEqual(1); 489 | done(); 490 | }, 491 | function () { 492 | expect(false).toBe(true); 493 | done(); 494 | }); 495 | } 496 | }; 497 | window.addEventListener('message', messageCallback); 498 | initTime = Date.now(); 499 | swreg.periodicSync.register({tag:'periodic', minPeriod: 2222}).then(function (reg) { 500 | swreg.periodicSync.getRegistrations().then(function (regs) { 501 | expect(regs.length).toEqual(1); 502 | }, 503 | function () { 504 | expect(false).toBe(true); 505 | }); 506 | }, 507 | function (err) { 508 | expect(false).toBe(true); 509 | done(); 510 | }); 511 | }); 512 | }); 513 | }; 514 | 515 | /* Manual Tests */ 516 | 517 | exports.defineManualTests = function (contentEl, createActionButton) { 518 | 519 | }; 520 | -------------------------------------------------------------------------------- /www/PeriodicSyncManager.js: -------------------------------------------------------------------------------- 1 | /* 2 | Licensed to the Apache Software Foundation (ASF) under one 3 | or more contributor license agreements. See the NOTICE file 4 | distributed with this work for additional information 5 | regarding copyright ownership. The ASF licenses this file 6 | to you under the Apache License, Version 2.0 (the 7 | "License"); you may not use this file except in compliance 8 | with the License. You may obtain a copy of the License at 9 | 10 | http://www.apache.org/licenses/LICENSE-2.0 11 | 12 | Unless required by applicable law or agreed to in writing, 13 | software distributed under the License is distributed on an 14 | "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | KIND, either express or implied. See the License for the 16 | specific language governing permissions and limitations 17 | under the License. 18 | */ 19 | 20 | function PeriodicSyncManager() { 21 | var that = this; 22 | if (typeof cordova !== 'undefined') { 23 | cordova.exec(function(data) { that.minPossiblePeriod = data; }, null, 'BackgroundSync', 'getMinPossiblePeriod', []); 24 | } 25 | } 26 | 27 | PeriodicSyncManager.prototype.register = function(syncRegistrationOptions) { 28 | return new Promise(function(resolve,reject) { 29 | syncRegistrationOptions = syncRegistrationOptions || {}; 30 | function success() { 31 | resolve(new PeriodicSyncRegistration(syncRegistrationOptions)); 32 | } 33 | if (typeof cordova !== 'undefined') { 34 | // register dispatches an error when minPeriod is less than minPossiblePeriod 35 | cordova.exec(success, reject, 'BackgroundSync', 'cordovaRegister', [new PeriodicSyncRegistration(syncRegistrationOptions), 'periodic']); 36 | } else { 37 | CDVBackgroundSync_register(new PeriodicSyncRegistration(syncRegistrationOptions), 'periodic', success, reject); 38 | } 39 | }); 40 | }; 41 | 42 | PeriodicSyncManager.prototype.getRegistration = function(tag) { 43 | return new Promise(function(resolve, reject) { 44 | tag = tag || ''; 45 | function success(reg) { 46 | resolve(new PeriodicSyncRegistration(reg)); 47 | } 48 | if (typeof cordova !== 'undefined') { 49 | cordova.exec(success, reject, 'BackgroundSync', 'getRegistration', [tag, 'periodic']); 50 | } else { 51 | CDVBackgroundSync_getRegistration(tag, 'periodic', success, reject); 52 | } 53 | }); 54 | }; 55 | 56 | PeriodicSyncManager.prototype.getRegistrations = function() { 57 | return new Promise(function(resolve, reject) { 58 | function callback(regs) { 59 | var newRegs = regs.map(function (reg) { return new PeriodicSyncRegistration(reg); }); 60 | resolve(newRegs); 61 | } 62 | if (typeof cordova !== 'undefined') { 63 | // getRegistrations does not fail, it returns an empty array when there are no registrations 64 | cordova.exec(callback, null, 'BackgroundSync', 'getRegistrations', ['periodic']); 65 | } else { 66 | CDVBackgroundSync_getRegistrations('periodic', callback); 67 | } 68 | }); 69 | }; 70 | 71 | PeriodicSyncManager.prototype.permissionState = function() { 72 | return new Promise(function(resolve, reject) { 73 | if (typeof cordova !== 'undefined') { 74 | cordova.exec(resolve, null, 'BackgroundSync', 'hasPermission', []); 75 | } else { 76 | //TODO: service worker equivalent 77 | } 78 | }); 79 | }; 80 | 81 | if (typeof cordova !== 'undefined') { 82 | navigator.serviceWorker.ready.then(function(serviceWorkerRegistration) { 83 | serviceWorkerRegistration.periodicSync = new PeriodicSyncManager(); 84 | }); 85 | module.exports = PeriodicSyncManager; 86 | } else { 87 | self.periodicSync = new PeriodicSyncManager(); 88 | } 89 | -------------------------------------------------------------------------------- /www/PeriodicSyncRegistration.js: -------------------------------------------------------------------------------- 1 | /* 2 | Licensed to the Apache Software Foundation (ASF) under one 3 | or more contributor license agreements. See the NOTICE file 4 | distributed with this work for additional information 5 | regarding copyright ownership. The ASF licenses this file 6 | to you under the Apache License, Version 2.0 (the 7 | "License"); you may not use this file except in compliance 8 | with the License. You may obtain a copy of the License at 9 | 10 | http://www.apache.org/licenses/LICENSE-2.0 11 | 12 | Unless required by applicable law or agreed to in writing, 13 | software distributed under the License is distributed on an 14 | "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | KIND, either express or implied. See the License for the 16 | specific language governing permissions and limitations 17 | under the License. 18 | */ 19 | 20 | function PeriodicSyncRegistration(options) { 21 | options = options || {}; 22 | this.tag = options.tag || ''; 23 | this.minPeriod = options.minPeriod || 0; 24 | this.networkState = options.networkState || 'online'; 25 | this.powerState = options.powerState || 'auto'; 26 | this._timestamp = options._timestamp || Date.now(); 27 | } 28 | 29 | PeriodicSyncRegistration.prototype.unregister = function() { 30 | var tag = this.tag; 31 | return new Promise(function(resolve, reject) { 32 | if (typeof cordova !== 'undefined') { 33 | cordova.exec(resolve, null, 'BackgroundSync', 'unregister', [tag, 'periodic']); 34 | } else { 35 | CDVBackgroundSync_unregisterSync(tag, 'periodic'); 36 | resolve(); 37 | } 38 | }); 39 | }; 40 | 41 | if (typeof cordova !== 'undefined') { 42 | module.exports = PeriodicSyncRegistration; 43 | } 44 | -------------------------------------------------------------------------------- /www/SyncManager.js: -------------------------------------------------------------------------------- 1 | /* 2 | Licensed to the Apache Software Foundation (ASF) under one 3 | or more contributor license agreements. See the NOTICE file 4 | distributed with this work for additional information 5 | regarding copyright ownership. The ASF licenses this file 6 | to you under the Apache License, Version 2.0 (the 7 | "License"); you may not use this file except in compliance 8 | with the License. You may obtain a copy of the License at 9 | 10 | http://www.apache.org/licenses/LICENSE-2.0 11 | 12 | Unless required by applicable law or agreed to in writing, 13 | software distributed under the License is distributed on an 14 | "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | KIND, either express or implied. See the License for the 16 | specific language governing permissions and limitations 17 | under the License. 18 | */ 19 | 20 | function SyncManager() {} 21 | 22 | SyncManager.prototype.register = function(syncRegistrationOptions) { 23 | return new Promise(function(resolve,reject) { 24 | function callback() { 25 | resolve(new SyncRegistration(syncRegistrationOptions)); 26 | } 27 | if (typeof cordova !== 'undefined') { 28 | // register does not dispatch an error 29 | cordova.exec(callback, null, 'BackgroundSync', 'cordovaRegister', [new SyncRegistration(syncRegistrationOptions)]); 30 | } else { 31 | CDVBackgroundSync_register(new SyncRegistration(syncRegistrationOptions), 'one-off', callback, null); 32 | } 33 | }); 34 | }; 35 | 36 | SyncManager.prototype.getRegistration = function(tag) { 37 | return new Promise(function(resolve, reject) { 38 | tag = tag || ''; 39 | function success(reg) { 40 | resolve(new SyncRegistration(reg)); 41 | } 42 | if (typeof cordova !== 'undefined') { 43 | cordova.exec(success, reject, 'BackgroundSync', 'getRegistration', [tag]); 44 | } else { 45 | CDVBackgroundSync_getRegistration(tag, 'one-off', success, reject); 46 | } 47 | }); 48 | }; 49 | 50 | SyncManager.prototype.getRegistrations = function() { 51 | return new Promise(function(resolve, reject) { 52 | function callback(regs) { 53 | var newRegs = regs.map(function (reg) { return new SyncRegistration(reg); }); 54 | resolve(newRegs); 55 | } 56 | if (typeof cordova !== 'undefined') { 57 | // getRegistrations does not fail, it returns an empty array when there are no registrations 58 | cordova.exec(callback, null, 'BackgroundSync', 'getRegistrations', []); 59 | } else { 60 | CDVBackgroundSync_getRegistrations('one-off', callback); 61 | } 62 | }); 63 | }; 64 | 65 | SyncManager.prototype.permissionState = function() { 66 | return new Promise(function(resolve, reject) { 67 | if (typeof cordova !== 'undefined') { 68 | cordova.exec(resolve, null, 'BackgroundSync', 'hasPermission', []); 69 | } else { 70 | //TODO: service worker equivalent 71 | } 72 | }); 73 | }; 74 | 75 | if (typeof cordova !== 'undefined') { 76 | navigator.serviceWorker.ready.then(function(serviceWorkerRegistration) { 77 | serviceWorkerRegistration.sync = new SyncManager(); 78 | cordova.exec(null, null, 'BackgroundSync', 'setupBackgroundSync', []); 79 | }); 80 | module.exports = SyncManager; 81 | } else { 82 | self.sync = new SyncManager(); 83 | } 84 | -------------------------------------------------------------------------------- /www/SyncRegistration.js: -------------------------------------------------------------------------------- 1 | /* 2 | Licensed to the Apache Software Foundation (ASF) under one 3 | or more contributor license agreements. See the NOTICE file 4 | distributed with this work for additional information 5 | regarding copyright ownership. The ASF licenses this file 6 | to you under the Apache License, Version 2.0 (the 7 | "License"); you may not use this file except in compliance 8 | with the License. You may obtain a copy of the License at 9 | 10 | http://www.apache.org/licenses/LICENSE-2.0 11 | 12 | Unless required by applicable law or agreed to in writing, 13 | software distributed under the License is distributed on an 14 | "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | KIND, either express or implied. See the License for the 16 | specific language governing permissions and limitations 17 | under the License. 18 | */ 19 | 20 | function SyncRegistration(options) { 21 | options = options || {}; 22 | this.tag = options.tag || ''; 23 | } 24 | 25 | SyncRegistration.prototype.unregister = function() { 26 | var tag = this.tag; 27 | return new Promise(function(resolve, reject) { 28 | if (typeof cordova !== 'undefined') { 29 | cordova.exec(resolve, null, 'BackgroundSync', 'unregister', [tag]); 30 | } else { 31 | CDVBackgroundSync_unregisterSync(tag, 'one-off'); 32 | } 33 | }); 34 | }; 35 | 36 | if (typeof cordova !== 'undefined') { 37 | module.exports = SyncRegistration; 38 | } 39 | -------------------------------------------------------------------------------- /www/sw_assets/syncevents.js: -------------------------------------------------------------------------------- 1 | /* 2 | Licensed to the Apache Software Foundation (ASF) under one 3 | or more contributor license agreements. See the NOTICE file 4 | distributed with this work for additional information 5 | regarding copyright ownership. The ASF licenses this file 6 | to you under the Apache License, Version 2.0 (the 7 | "License"); you may not use this file except in compliance 8 | with the License. You may obtain a copy of the License at 9 | 10 | http://www.apache.org/licenses/LICENSE-2.0 11 | 12 | Unless required by applicable law or agreed to in writing, 13 | software distributed under the License is distributed on an 14 | "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | KIND, either express or implied. See the License for the 16 | specific language governing permissions and limitations 17 | under the License. 18 | */ 19 | 20 | Object.defineProperty(this, 'onsync', { 21 | configurable: false, 22 | enumerable: true, 23 | get: eventGetter('sync'), 24 | set: eventSetter('sync') 25 | }); 26 | 27 | Object.defineProperty(this, 'onperiodicsync', { 28 | configurable: false, 29 | enumerable: true, 30 | get: eventGetter('periodicsync'), 31 | set: eventSetter('periodicsync') 32 | }); 33 | 34 | function SyncEvent() { 35 | ExtendableEvent.call(this, 'sync'); 36 | this.registration = new SyncRegistration(); 37 | } 38 | 39 | function PeriodicSyncEvent() { 40 | ExtendableEvent.call(this, 'periodicsync'); 41 | this.registration = new PeriodicSyncRegistration(); 42 | } 43 | 44 | SyncEvent.prototype = Object.create(ExtendableEvent.prototype); 45 | SyncEvent.constructor = SyncEvent; 46 | 47 | PeriodicSyncEvent.prototype = Object.create(ExtendableEvent.prototype); 48 | PeriodicSyncEvent.constructor = PeriodicSyncEvent; 49 | 50 | function FireSyncEvent(data) { 51 | var ev = new SyncEvent(); 52 | ev.registration.tag = data.tag; 53 | dispatchEvent(ev); 54 | if(Array.isArray(ev._promises)) { 55 | Promise.all(ev._promises).then(function(){ 56 | sendSyncResponse(0, data.tag); 57 | },function(){ 58 | sendSyncResponse(2, data.tag); 59 | }); 60 | } else { 61 | sendSyncResponse(1, data.tag); 62 | } 63 | } 64 | 65 | function FirePeriodicSyncEvent(data) { 66 | var ev = new PeriodicSyncEvent(); 67 | ev.registration.tag = data.tag; 68 | ev.registration.minPeriod = data.minPeriod; 69 | ev.registration.networkState = data.networkState; 70 | ev.registration.powerState = data.powerState; 71 | dispatchEvent(ev); 72 | if(Array.isArray(ev._promises)) { 73 | Promise.all(ev._promises).then(function(){ 74 | sendPeriodicSyncResponse(0, data.tag); 75 | },function(){ 76 | sendPeriodicSyncResponse(2, data.tag); 77 | }); 78 | } else { 79 | sendPeriodicSyncResponse(1, data.tag); 80 | } 81 | } 82 | --------------------------------------------------------------------------------