Merge pull request #74 from NativeScript/ios-background-flags

[rebased] iOS: Adding options to use in long-running background tasks

Author: Dimitar Tachev

README.md

@@ -74,6 +74,16 @@ geolocation.getCurrentLocation({ desiredAccuracy: Accuracy.high, maximumAge: 500
 | minimumUpdateTime | 5 secs | Minimum time interval between location updates, in milliseconds (ignored on iOS). |
 | maximumAge | - | How old locations to receive in ms.  |
 | timeout | 5 minutes | How long to wait for a location in ms.  |
+| iosAllowsBackgroundLocationUpdates | false |  If enabled, UIBackgroundModes key in info.plist is required (check the hint below). Allow the application to receive location updates in background (ignored on Android) |
+| iosPausesLocationUpdatesAutomatically | true | Allow deactivation of the automatic pause of location updates (ignored on Android) |
+
+> If iosAllowsBackgroundLocationUpdates is set to true, the following code is required in the info.plist file:
+>```
+><key>UIBackgroundModes</key>
+><array>
+>    <string>location</string>
+></array>
+>```
 
 ### Methods
 

src/geolocation.ios.ts

@@ -11,6 +11,7 @@ import {
     successCallbackType,
     errorCallbackType
 } from "./location-monitor";
+import * as Platform from "platform";
 
 const locationManagers = {};
 const locationListeners = {};
@@ -329,6 +330,14 @@ export class LocationMonitor {
         iosLocManager.distanceFilter = options ? options.updateDistance : minRangeUpdate;
         locationManagers[locListener.id] = iosLocManager;
         locationListeners[locListener.id] = locListener;
+        if (parseInt(Platform.device.osVersion.split(".")[0]) >= 9) {
+            iosLocManager.allowsBackgroundLocationUpdates =
+                options && options.iosAllowsBackgroundLocationUpdates != null ?
+                options.iosAllowsBackgroundLocationUpdates : false;
+        }
+        iosLocManager.pausesLocationUpdatesAutomatically =
+            options && options.iosPausesLocationUpdatesAutomatically != null ?
+            options.iosPausesLocationUpdatesAutomatically : true;
         return iosLocManager;
     }
 }

src/location-monitor.d.ts

@@ -33,6 +33,22 @@ export interface Options {
      * How long to wait for a location in ms.
      */
     timeout?: number;
+
+    /**
+     * A Boolean value which has to be set to true on iOS versions > 9.0 to allow the application to receive location updates in
+     * background in combination with the UIBackgroundModes key 'location' in the Info.plist. An exception is thrown if the
+     * property is enabled without the UIBackgroundModes key set to true. The value is ignored on Android.
+     * @see {@link https://developer.apple.com/reference/corelocation/cllocationmanager/1620568-allowsbackgroundlocationupdates|allowsBackgroundLocationUpdates}
+     */
+    iosAllowsBackgroundLocationUpdates?: boolean;
+
+    /**
+     * A Boolean value which has to be set to false on iOS to deactivate the automatic pause of location updates. The location manager might pause
+     * location updates for a period of time to improve battery life. This behavior may stop a long-running background task. Set this flag to false
+     * to prevent this behavior. The value is ignored on Android.
+     * @see {@link https://developer.apple.com/reference/corelocation/cllocationmanager/1620553-pauseslocationupdatesautomatical|pausesLocationUpdatesAutomatically}
+     */
+    iosPausesLocationUpdatesAutomatically?: boolean;
 }
 
 declare type successCallbackType = (location: Location) => void;

src/package.json

@@ -1,6 +1,6 @@
 {
     "name": "nativescript-geolocation",
-    "version": "4.0.0",
+    "version": "4.1.0",
     "description": "Provides API for getting and monitoring location for NativeScript app.",
     "main": "geolocation",
     "nativescript": {