@josuelmm/cordova-background-geolocation 3.1.0 → 3.2.0

package/www/BackgroundGeolocation.d.ts

@@ -214,6 +214,24 @@ export interface ConfigureOptions {
    */
   notificationText?: string;
 
+  /**
+   * When true, the foreground notification shows a live elapsed time (HH:mm:ss) since the session started.
+   * Requires startForeground. Updates every second.
+   *
+   * Platform: Android
+   * @default false
+   */
+  showTime?: boolean;
+
+  /**
+   * When true, the foreground notification shows accumulated distance (km) since the session started.
+   * Requires startForeground. Updates when each new location is received.
+   *
+   * Platform: Android
+   * @default false
+   */
+  showDistance?: boolean;
+
   /**
    * Title shown in the notification while locations are syncing to the server.
    * Use this (and notificationSyncText, etc.) to localize sync notifications.
@@ -786,6 +804,48 @@ export interface BackgroundGeolocationPlugin {
     fail?: (error: BackgroundGeolocationError) => void
   ): Promise<number>;
 
+  /**
+   * Start recording session: clear session table and store all new locations in it.
+   * Call when user starts a route. Session locations are independent of sync (not cleared when sync succeeds).
+   *
+   * Platform: Android, iOS
+   */
+  startSession(
+    success?: () => void,
+    fail?: (error: BackgroundGeolocationError) => void
+  ): Promise<void>;
+
+  /**
+   * Return all locations stored in the current session (ordered by time).
+   * Same format as Location (latitude, longitude, time, speed, altitude, bearing, accuracy).
+   *
+   * Platform: Android, iOS
+   */
+  getSessionLocations(
+    success?: (locations: Location[]) => void,
+    fail?: (error: BackgroundGeolocationError) => void
+  ): Promise<Location[]>;
+
+  /**
+   * Clear the session table and stop storing. Call when route is finished and sync OK.
+   *
+   * Platform: Android, iOS
+   */
+  clearSession(
+    success?: () => void,
+    fail?: (error: BackgroundGeolocationError) => void
+  ): Promise<void>;
+
+  /**
+   * Get the number of locations in the current session.
+   *
+   * Platform: Android, iOS
+   */
+  getSessionLocationsCount(
+    success?: (count: number) => void,
+    fail?: (error: BackgroundGeolocationError) => void
+  ): Promise<number>;
+
   /**
    * Get stored configuration options.
    *

package/www/BackgroundGeolocation.js

@@ -233,6 +233,30 @@ var BackgroundGeolocation = {
       'getPendingSyncCount');
   },
 
+  startSession: function (success, failure) {
+    return execWithPromise(success,
+      failure,
+      'startSession');
+  },
+
+  getSessionLocations: function (success, failure) {
+    return execWithPromise(success,
+      failure,
+      'getSessionLocations');
+  },
+
+  clearSession: function (success, failure) {
+    return execWithPromise(success,
+      failure,
+      'clearSession');
+  },
+
+  getSessionLocationsCount: function (success, failure) {
+    return execWithPromise(success,
+      failure,
+      'getSessionLocationsCount');
+  },
+
   on: function (event, callbackFn) {
     assert(this.events.indexOf(event) > -1, [TAG, '#on unknown event "' + event + '"']);
     if (!callbackFn) {

package/www/cordova-channel-stub.js

@@ -0,0 +1,27 @@
+/**
+ * Stub for cordova/channel so the plugin can be bundled by webpack (ng serve / browser).
+ * When running inside Cordova (native), uses the real cordova channel.
+ * When running in browser, provides deviceready.subscribe() that runs the callback on load.
+ */
+function getChannel() {
+  if (typeof window !== 'undefined' && window.cordova && typeof window.cordova.require === 'function') {
+    try {
+      return window.cordova.require('cordova/channel');
+    } catch (e) {}
+  }
+  return {
+    deviceready: {
+      subscribe: function (cb) {
+        if (typeof window !== 'undefined') {
+          if (document.readyState === 'complete') {
+            setTimeout(cb, 0);
+          } else {
+            window.addEventListener('load', cb);
+          }
+        }
+      }
+    }
+  };
+}
+
+module.exports = getChannel();

package/www/cordova-exec-stub.js

@@ -0,0 +1,15 @@
+/**
+ * Stub for cordova/exec so the plugin can be bundled by webpack (ng serve / browser).
+ * When running inside Cordova (native), delegates to the real cordova.exec.
+ * When running in browser, calls the failure callback so the app does not break.
+ */
+function exec(success, fail, service, method, args) {
+  if (typeof window !== 'undefined' && window.cordova && typeof window.cordova.exec === 'function') {
+    return window.cordova.exec(success, fail, service, method, args || []);
+  }
+  if (typeof fail === 'function') {
+    fail({ message: 'Cordova is not available. Run on a device or emulator.' });
+  }
+}
+
+module.exports = exec;