@transistorsoft/capacitor-background-geolocation 4.3.0 → 4.4.3

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Chris Scott
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/README.md

@@ -29,6 +29,7 @@ The **[Android module](http://www.transistorsoft.com/shop/products/capacitor-bac
 ![Settings](https://dl.dropboxusercontent.com/s/8oad228siog49kt/settings-framed-350.png?dl=1)
 
 # Contents
+- ### 😫 [Help!](../../wiki/Help)
 - ### :books: [API Documentation](https://transistorsoft.github.io/capacitor-background-geolocation)
 - ### [Installing the Plugin](#large_blue_diamond-installing-the-plugin)
 - ### [Setup Guides](#large_blue_diamond-setup-guides)
@@ -109,92 +110,285 @@ There are three main steps to using `BackgroundGeolocation`
 2. `#ready` the plugin.
 3. `#start` the plugin.
 
+:warning: Do not execute *any* API method which will require accessing location-services until the callback to **`#ready`** executes (eg: `#getCurrentPosition`, `#watchPosition`, `#start`).
+
+
 ```javascript
-// Import BackgroundGeolocation + any optional interfaces
-import BackgroundGeolocation from "@transistorsoft/capacitor-background-geolocation";
+// NO!  .ready() has not resolved.
+BackgroundGeolocation.getCurrentPosition(options);
+BackgroundGeolocation.start();
+
+BackgroundGeolocation.ready(config).then((state) => {
+  // YES -- .ready() has now resolved.
+  BackgroundGeolocation.getCurrentPosition(options);
+  BackgroundGeolocation.start();  
+});
+
+// NO!  .ready() has not resolved.
+BackgroundGeolocation.getCurrentPosition(options);
+BackgroundGeolocation.start();
+```
+---------------------------------------------------------------------------------------------
+
+### Example 1. — *React*
+
+<img alt="alt_text" width="50px" src="https://hackr.io/tutorials/react/logo-react.svg?ver=1610114789" />
+
+<details>
+  <summary>View Source</summary>
+
+```typescript
+import {
+  IonContent,
+  IonHeader,
+  IonPage,
+  IonTitle,
+  IonToolbar,
+  IonButtons,
+  IonToggle,
+  IonItemDivider,
+  IonLabel
+} from '@ionic/react';
+
+import React from "react";
+
+import BackgroundGeolocation, {
+  Subscription
+} from "@transistorsoft/capacitor-background-geolocation";
+
+const HelloWorld: React.FC = () => {
+  const [ready, setReady] = React.useState(false);
+  const [enabled, setEnabled] = React.useState(false);
+  const [events, setEvents] = React.useState<any[]>([]);
+
+  const addEvent = (name: string, event:any) => {
+    setEvents(previous => [...previous, {
+      name: name,
+      json: JSON.stringify(event, null, 2)
+    }]);
+  }
 
-export class HomePage {
-
-  /// WARNING:  DO NOT Use ionViewWillEnter to configure the SDK -- use ngAfterContentInit.  ionViewWillEnter only executes when the
-  /// app is brought to the foreground.  It will NOT execute when the app is launched in the background,
-  /// as the BackgroundGeolocation SDK will often do.
-  ///
-  async ngAfterContentInit() {
-    ////
-    // 1.  Wire up event-listeners
-    //
-
-    // This handler fires whenever bgGeo receives a location update.
-    BackgroundGeolocation.onLocation((location) => {
-      console.log('[onLocation]', location);
-    }, ((error) => {  // <-- Location errors
-      console.log('[onLocation] ERROR:', error);
-    });
+  React.useEffect(() => {
+    /// 1.  Subscribe to events.
+    const onLocation:Subscription = BackgroundGeolocation.onLocation((location) => {
+      addEvent('onLocation', location);
+    })
 
-    // This handler fires when movement states changes (stationary->moving; moving->stationary)
-    BackgroundGeolocation.onMotionChange((location) => {
-      console.log('[onMotionChange]', location);
+    const onMotionChange:Subscription = BackgroundGeolocation.onMotionChange((event) => {
+      addEvent('onMotionChange', event);
     });
 
-    // This event fires when a change in motion activity is detected
-    BackgroundGeolocation.onActivityChange((event) => {
-      console.log('[onActivityChange]', event);
-    });
+    const onActivityChange:Subscription = BackgroundGeolocation.onActivityChange((event) => {
+      addEvent('onActivityChange', event);
+    })
 
-    // This event fires when the user toggles location-services authorization
-    BackgroundGeolocation.onProviderChange((event) => {
-      console.log('[onProviderChange]', event);
+    const onProviderChange:Subscription = BackgroundGeolocation.onProviderChange((event) => {
+      addEvent('onProviderChange', event);
+    })
+
+    /// 2. ready the plugin.
+    BackgroundGeolocation.ready({
+      // Geolocation Config
+      desiredAccuracy: BackgroundGeolocation.DESIRED_ACCURACY_HIGH,
+      distanceFilter: 10,
+      // Activity Recognition
+      stopTimeout: 5,
+      // Application config
+      debug: true, // <-- enable this hear sounds for background-geolocation life-cycle.
+      logLevel: BackgroundGeolocation.LOG_LEVEL_VERBOSE,
+      stopOnTerminate: false,   // <-- Allow the background-service to continue tracking when user closes the app.
+      startOnBoot: true,        // <-- Auto start tracking when device is powered-up.
+    }).then((state) => {
+      setReady(true);
+      setEnabled(state.enabled)
+      addEvent('State', state);
     });
 
-    // See the API docs for a list of all available events -- there are a total of 13 events.
+    return () => {
+      // Remove BackgroundGeolocation event-subscribers when the View is removed or refreshed
+      // during development live-reload.  Without this, event-listeners will accumulate with
+      // each refresh during live-reload.
+      onLocation.remove();
+      onMotionChange.remove();
+      onActivityChange.remove();
+      onProviderChange.remove();
+    }
+  }, []);
+
+  /// 3. start / stop BackgroundGeolocation
+  React.useEffect(() => {
+    if (!ready) { return }
+
+    if (enabled) {
+      BackgroundGeolocation.start();
+    } else {
+      BackgroundGeolocation.stop();
+      setEvents([]);
+    }
+  }, [enabled]);
+
+  return (
+    <IonPage>
+      <IonHeader>
+        <IonToolbar>
+          <IonButtons slot="end">
+            <IonLabel>Toggle to <code>{(enabled ? 'stop()' : 'start()')}</code> &mdash;&gt;</IonLabel>
+            <IonToggle checked={enabled} onIonChange={e => setEnabled(e.detail.checked)}/>
+          </IonButtons>
+        </IonToolbar>
+      </IonHeader>
+      <IonContent fullscreen>
+        <div style={{padding:10}}>
+        { events.slice().reverse().map((event, i) => (
+          <div key={i}>
+            <p><strong>{event.name}</strong></p>
+            <small><pre><code>{event.json}</code></pre></small>
+            <IonItemDivider />
+          </div>
+        ))}
+        </div>
+      </IonContent>
+    </IonPage>
+  )
+}
+```
 
-    ////
-    // 2.  Execute #ready method (required)
-    //
+</details>
+
+---------------------------------------------------------------------------------------------
+
+### Example 2. &mdash; *Angular*
+
+<img alt="alt_text" width="55px" src="https://dl.dropbox.com/s/w4hw88clxqmlis2/angular-logo.svg?dl=1" />
+
+<details>
+  <summary>View Source</summary>
+
+```typescript
+import {
+  Component, 
+  NgZone,
+  OnDestroy
+} from '@angular/core'
+
+import BackgroundGeolocation, {
+  Location,
+  Subscription
+} from "@transistorsoft/capacitor-background-geolocation";
+
+@Component({
+  selector: 'hello-world',
+  template: `
+    <ion-header>
+      <ion-toolbar>
+        <ion-buttons slot="end">
+          <ion-label>Toggle to <code>{{(enabled ? 'stop()' : 'start()')}}</code> &mdash;&gt;</ion-label>
+          <ion-toggle [(ngModel)]="enabled" (ionChange)="onToggleEnabled()" style="display:block;"></ion-toggle>
+        </ion-buttons>
+      </ion-toolbar>
+    </ion-header>
+    <ion-content fullscreen>
+      <div *ngFor="let event of events.slice().reverse()" style="padding:10px">
+        <div>
+          <p><strong>{{event.name}}</strong></p>
+          <small><pre><code>{{event.json}}</code></pre></small>
+          <ion-item-divider></ion-item-divider>
+        </div>
+      </div>
+    </ion-content>
+  `,
+  styles: []
+})
+
+export class HelloWorldPage implements OnDestroy {
+  ready:boolean = false;
+  enabled:boolean = false;
+  events:any = [];
+  subscriptions:Subscription[] = [];
+
+  constructor(private zone:NgZone) {}
+
+  /// WARNING:  DO NOT Use ionViewWillEnter to configure the SDK -- use ngAfterContentInit.  
+  /// ionViewWillEnter only executes when the app is brought to the foreground.  
+  /// It will NOT execute when the app is launched in the background, as the SDK will often do.
+  /// 
+  ngAfterContentInit() {
+    /// Step 1:  Subscribe to BackgroundGeolocation events.
+    this.subscriptions.push(BackgroundGeolocation.onLocation((location) => {
+      this.addEvent('onLocation', location);
+    }))
+
+    this.subscriptions.push(BackgroundGeolocation.onMotionChange((event) => {
+      this.addEvent('onMotionChange', event);
+    }))
+
+    this.subscriptions.push(BackgroundGeolocation.onActivityChange((event) => {
+      this.addEvent('onActivityChange', event);
+    }))
+
+    this.subscriptions.push(BackgroundGeolocation.onProviderChange((event) => {
+      this.addEvent('onProviderChange', event);
+    }))
+
+    /// Step 2:  Ready the plugin.
     BackgroundGeolocation.ready({
       // Geolocation Config
       desiredAccuracy: BackgroundGeolocation.DESIRED_ACCURACY_HIGH,
       distanceFilter: 10,
       // Activity Recognition
-      stopTimeout: 1,
+      stopTimeout: 5,
       // Application config
       debug: true, // <-- enable this hear sounds for background-geolocation life-cycle.
       logLevel: BackgroundGeolocation.LOG_LEVEL_VERBOSE,
       stopOnTerminate: false,   // <-- Allow the background-service to continue tracking when user closes the app.
       startOnBoot: true,        // <-- Auto start tracking when device is powered-up.
-      // HTTP / SQLite config
-      url: 'http://yourserver.com/locations',
-      batchSync: false,       // <-- [Default: false] Set true to sync locations to server in a single HTTP request.
-      autoSync: true,         // <-- [Default: true] Set true to sync each location to server as it arrives.
-      headers: {              // <-- Optional HTTP headers
-        "X-FOO": "bar"
-      },
-      params: {               // <-- Optional HTTP params append to each HTTP request
-        "auth_token": "maybe_your_server_authenticates_via_token_YES?"
-      },
-      extras: {               // <-- Optional meta-data appended to each recorded location.
-        "foo": "bar"
-      }
     }).then((state) => {
-      console.log("BackgroundGeolocation is configured and ready to use ", state.enabled);
-
-      if (!state.enabled) {
-        ////
-        // 3. Start tracking!
-        //
-        BackgroundGeolocation.start().then(() => {
-          console.log("[start] success");
-        });
-      }
-    }).catch((error) => {
-      console.warn('[BackgroundGeolocation ready] ERROR: ', error);
+      // BackgroundGeolocation is now ready to use.
+      this.ready = true;
+      this.enabled = state.enabled;
+      this.addEvent('State', state);
     });
   }
-}
 
+  /// When view is destroyed, be sure to .remove() all BackgroundGeolocation
+  /// event-subscriptions.
+  ngOnDestroy() {
+    this.subscriptions.forEach((subscription:Subscription) => {
+      subscription.remove();
+    })
+  }
+
+  /// Add an event to the view.
+  addEvent(name:string, event:any) {
+    this.zone.run(() => {
+      this.events.push({
+        name: name, 
+        json: JSON.stringify(event, null, 2)
+      })  
+    })    
+  }
+
+  /// Toggle the plugin on/off.
+  onToggleEnabled() {
+    if (!this.ready) { return }
+
+    this.events = [];
+    if (this.enabled) {
+      BackgroundGeolocation.start().then((state) => {
+        this.addEvent('State', state);
+      })
+    } else {
+      BackgroundGeolocation.stop().then((state) => {
+        this.addEvent('State', state);
+      })
+    }
+  }
+}
 ```
 
-:warning: Do not execute *any* API method which will require accessing location-services until the callback to **`#ready`** executes (eg: `#getCurrentPosition`, `#watchPosition`, `#start`).
+</details>
+
+---------------------------------------------------------------------------------------------
 
 ### Promise API
 
@@ -203,7 +397,7 @@ The `BackgroundGeolocation` Javascript API supports [Promises](https://developer
 
 ## :large_blue_diamond: [Demo Application](./example)
 
-A fully-featured [Demo App](./example) is available in this repo.  After first cloning this repo, follow the installation instructions in the [README](./example/README.md) there.  This demo-app includes an advanced settings-screen allowing you to quickly experiment with all the different settings available for each platform.
+A fully-featured [Demo App](./example) is available in this repo, for both *React* and *Angular*.  After first cloning this repo, follow the installation instructions in the [README](./example/README.md) there.  This demo-app includes an advanced settings-screen allowing you to quickly experiment with all the different settings available for each platform.
 
 ![Home](https://dl.dropboxusercontent.com/s/wa43w1n3xhkjn0i/home-framed-350.png?dl=1)
 ![Settings](https://dl.dropboxusercontent.com/s/8oad228siog49kt/settings-framed-350.png?dl=1)
@@ -217,28 +411,3 @@ A simple Node-based [web-application](https://github.com/transistorsoft/backgrou
 
 ![](https://dl.dropboxusercontent.com/s/tiy5b2oivt0np2y/background-geolocation-console-grid.png?dl=1)
 
-# License
-
-The MIT License (MIT)
-
-Copyright (c) 2018 Chris Scott, Transistor Software
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
-

package/android/libs/com/transistorsoft/tslocationmanager/3.1.35/tslocationmanager-3.1.35.aar.md5

@@ -0,0 +1 @@
+3a9143ce4479579c135bbf7f1ca80e9c

package/android/libs/com/transistorsoft/tslocationmanager/3.1.35/tslocationmanager-3.1.35.aar.sha1

@@ -0,0 +1 @@
+c16850b24271032c3ccb10349ba0774069a67819

package/android/libs/com/transistorsoft/tslocationmanager/3.1.35/tslocationmanager-3.1.35.aar.sha256

@@ -0,0 +1 @@
+e18fc8dd9d37cd2ee00c64e8e1a78ebc0839cf8515cf52463cfdd0761aa580f9

package/android/libs/com/transistorsoft/tslocationmanager/3.1.35/tslocationmanager-3.1.35.aar.sha512

@@ -0,0 +1 @@
+566d4327d7b1b9ab3b271dc61d6d661ac1f4c8c89557de1d11c52928a4af5682c702a315e76f2cf46dc882d405fe3c4d6a958c7f0a885a228b3d0b2a735d8305

package/android/libs/com/transistorsoft/tslocationmanager/{3.1.33/tslocationmanager-3.1.33.pom → 3.1.35/tslocationmanager-3.1.35.pom}

@@ -4,6 +4,6 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.transistorsoft</groupId>
   <artifactId>tslocationmanager</artifactId>
-  <version>3.1.33</version>
+  <version>3.1.35</version>
   <packaging>aar</packaging>
 </project>

package/android/libs/com/transistorsoft/tslocationmanager/3.1.35/tslocationmanager-3.1.35.pom.md5

@@ -0,0 +1 @@
+007e6f97f3eef0a29312b614881094d5

package/android/libs/com/transistorsoft/tslocationmanager/3.1.35/tslocationmanager-3.1.35.pom.sha1

@@ -0,0 +1 @@
+a558cd1eb103134e207932ea7af8c6cf48cc97d7

package/android/libs/com/transistorsoft/tslocationmanager/3.1.35/tslocationmanager-3.1.35.pom.sha256

@@ -0,0 +1 @@
+f11bf76c75d7d586ceef2978d3bb789deceee30b6c06032edf57647333f98efe

package/android/libs/com/transistorsoft/tslocationmanager/3.1.35/tslocationmanager-3.1.35.pom.sha512

@@ -0,0 +1 @@
+d7d2120c48292dc74e273daacad40b19ebfa0617aed7f8fa3b9a8eeb4a10b0ab85e2cc702394f9d1aaf0619b3fdcef728db223c76ffca66288033eb867787acb

package/android/libs/com/transistorsoft/tslocationmanager/maven-metadata.xml

@@ -3,12 +3,11 @@
   <groupId>com.transistorsoft</groupId>
   <artifactId>tslocationmanager</artifactId>
   <versioning>
-    <latest>3.1.33</latest>
-    <release>3.1.33</release>
+    <latest>3.1.35</latest>
+    <release>3.1.35</release>
     <versions>
-      <version>3.1.32</version>
-      <version>3.1.33</version>
+      <version>3.1.35</version>
     </versions>
-    <lastUpdated>20210914133755</lastUpdated>
+    <lastUpdated>20211124132853</lastUpdated>
   </versioning>
 </metadata>

package/android/libs/com/transistorsoft/tslocationmanager-reverse/3.1.35/tslocationmanager-reverse-3.1.35.aar.md5

@@ -0,0 +1 @@
+3274c38b08952f9ce16633d384a270b9

package/android/libs/com/transistorsoft/tslocationmanager-reverse/3.1.35/tslocationmanager-reverse-3.1.35.aar.sha1

@@ -0,0 +1 @@
+4a7a11ed224e24d82121fdf1cfd9627db89db059

package/android/libs/com/transistorsoft/tslocationmanager-reverse/3.1.35/tslocationmanager-reverse-3.1.35.aar.sha256

@@ -0,0 +1 @@
+11d78cd48003bc32dc68a1fa87198884c1ca18ed9780167ec1598464c3466ea9

package/android/libs/com/transistorsoft/tslocationmanager-reverse/3.1.35/tslocationmanager-reverse-3.1.35.aar.sha512

@@ -0,0 +1 @@
+0027097d529ca8a970aa003eed2bf32ebcb45d662d40b3f99d1ec4ccc37067ea4393737ed169ffaa7c8b7709ac1d934cf1d316eaa01acbe662eb86f414bae3db

package/android/libs/com/transistorsoft/tslocationmanager-reverse/{3.1.33/tslocationmanager-reverse-3.1.33.pom → 3.1.35/tslocationmanager-reverse-3.1.35.pom}

@@ -4,6 +4,6 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.transistorsoft</groupId>
   <artifactId>tslocationmanager-reverse</artifactId>
-  <version>3.1.33</version>
+  <version>3.1.35</version>
   <packaging>aar</packaging>
 </project>

package/android/libs/com/transistorsoft/tslocationmanager-reverse/3.1.35/tslocationmanager-reverse-3.1.35.pom.md5

@@ -0,0 +1 @@
+00b43ef20d3f14d733a05d82c4435aaf

package/android/libs/com/transistorsoft/tslocationmanager-reverse/3.1.35/tslocationmanager-reverse-3.1.35.pom.sha1

@@ -0,0 +1 @@
+28d26ba8a4044945fd457d033dbdd457dde4144d

package/android/libs/com/transistorsoft/tslocationmanager-reverse/3.1.35/tslocationmanager-reverse-3.1.35.pom.sha256

@@ -0,0 +1 @@
+5ee1b9a1bf97d7ea8e005f108f18ec78e2410dfdc45a6e29755a28e5df15daf1

package/android/libs/com/transistorsoft/tslocationmanager-reverse/3.1.35/tslocationmanager-reverse-3.1.35.pom.sha512

@@ -0,0 +1 @@
+db1bf3fe2779d75145bcf1929692b5a87e24f9d4046d783a40d903eb7ef0a780f26062c03be017b2a9bb759778b9969eebda9b952abde90ac9e0dd37912d728f

package/android/libs/com/transistorsoft/tslocationmanager-reverse/maven-metadata.xml

@@ -3,12 +3,11 @@
   <groupId>com.transistorsoft</groupId>
   <artifactId>tslocationmanager-reverse</artifactId>
   <versioning>
-    <latest>3.1.33</latest>
-    <release>3.1.33</release>
+    <latest>3.1.35</latest>
+    <release>3.1.35</release>
     <versions>
-      <version>3.1.32</version>
-      <version>3.1.33</version>
+      <version>3.1.35</version>
     </versions>
-    <lastUpdated>20210914133755</lastUpdated>
+    <lastUpdated>20211124132853</lastUpdated>
   </versioning>
 </metadata>

package/android/src/main/java/com/transistorsoft/bggeo/capacitor/BackgroundGeolocationPlugin.java

@@ -96,7 +96,6 @@ public class BackgroundGeolocationPlugin extends Plugin {
         if (activity != null) {
             bgGeo.setActivity(activity);
         }
-        registerEventListeners();
     }
 
     private void handlePlayServicesConnectError(Integer errorCode) {
@@ -132,7 +131,7 @@ public class BackgroundGeolocationPlugin extends Plugin {
             return;
         }
         mReady = true;
-
+        registerEventListeners();
         BackgroundGeolocation adapter = BackgroundGeolocation.getInstance(getContext());
 
         if (config.isFirstBoot()) {
@@ -227,7 +226,12 @@ public class BackgroundGeolocationPlugin extends Plugin {
     @PluginMethod()
     public void stopSchedule(PluginCall call) {
         getAdapter().stopSchedule();
-        call.resolve();
+        TSConfig config = TSConfig.getInstance(getContext());
+        try {
+            call.resolve(JSObject.fromJSONObject(config.toJson()));
+        } catch (JSONException e) {
+            call.reject(e.getMessage());
+        }
     }
 
     private class StartGeofencesCallback implements TSCallback {