awesome-cordova-plugins/src/plugins/background-geolocation.ts

import {Cordova, Plugin} from './plugin';

declare var window;

export interface BackgroundGeolocationResponse {

  /**
   * ID of location as stored in DB (or null)
   */
  locationId: number;

  /**
   * Service provider
   */
  serviceProvider: string;

  /**
   * true if location recorded as part of debug
   */
  debug: boolean;

  /**
   * UTC time of this fix, in milliseconds since January 1, 1970.
   */
  time: number;

  /**
   * latitude, in degrees.
   */
  latitude: number;

  /**
   * longitude, in degrees.
   */
  longitude: number;

  /**
   * estimated accuracy of this location, in meters.
   */
  accuracy: number;

  /**
   * speed if it is available, in meters/second over ground.
   */
  speed: number;

  /**
   * altitude if available, in meters above the WGS 84 reference ellipsoid.
   */
  altitude: number;

  /**
    * accuracy of the altitude if available.
    */
  altitudeAccuracy: number;

  /**
   * bearing, in degrees.
   */
  bearing: number;

  /**
   * A Coordinates object defining the current location
   */
  coords: Coordinates;

  /**
   * A timestamp representing the time at which the location was retrieved.
   */
  timestamp: number;
}

export interface BackgroundGeolocationConfig {

  /**
   * Desired accuracy in meters. Possible values [0, 10, 100, 1000]. The lower
   * the number, the more power devoted to GeoLocation resulting in higher
   * accuracy readings. 1000 results in lowest power drain and least accurate
   * readings. @see Apple docs (https://developer.apple.com/library/ios/documentation/CoreLocation/Reference/CLLocationManager_Class/index.html#//apple_ref/occ/instp/CLLocationManager/desiredAccuracy)
   */
  desiredAccuracy: number;

  /**
   * Stationary radius in meters. When stopped, the minimum distance the device
   * must move beyond the stationary location for aggressive background-tracking
   * to engage.
   */
  stationaryRadius: number;

  /**
   * When enabled, the plugin will emit sounds for life-cycle events of
   * background-geolocation! See debugging sounds table.
   */
  debug?: boolean;

  /**
   * The minimum distance (measured in meters) a device must move horizontally
   * before an update event is generated. @see Apple docs. (https://developer.apple.com/library/ios/documentation/CoreLocation/Reference/CLLocationManager_Class/CLLocationManager/CLLocationManager.html#//apple_ref/occ/instp/CLLocationManager/distanceFilter)
   */
  distanceFilter: number;

  /**
   * IOS, ANDROID ONLY
   * Enable this in order to force a stop() when the application terminated
   * (e.g. on iOS, double-tap home button, swipe away the app).o
   *
   * Defaults to true
   */
  stopOnTerminate?: boolean;

  /**

   * ANDROID ONLY

   * Start background service on device boot.

   *
   * Defaults to false

   */
  startOnBoot?: boolean;

  /**

   * ANDROID ONLY

   * If false location service will not be started in foreground and no notification will be shown.
   *
   * Defaults to true

   */
  startForeground?: boolean;

  /**
   * ANDROID, WP8 ONLY
   * When using BackgroundGeolocation.LocationProvider.ANDROID_DISTANCE_FILTER_PROVIDER:
   * The minimum time interval between location updates in milliseconds.
   * @see Android docs (http://developer.android.com/reference/android/location/LocationManager.html#requestLocationUpdates(long,%20float,%20android.location.Criteria,%20android.app.PendingIntent))
   * and the MS doc (http://msdn.microsoft.com/en-us/library/windows/apps/windows.devices.geolocation.geolocator.reportinterval)
   * for more information
   * When using BackgroundGeolocation.LocationProvider.ANDROID_ACTIVITY_PROVIDER:
   * Rate in milliseconds at which your app prefers to receive location updates.
   * @see Android docs (https://developers.google.com/android/reference/com/google/android/gms/location/LocationRequest.html#getInterval())
   */
  interval?: number;

  /**
   * ANDROID ONLY
   * Custom notification title in the drawer.
   */
  notificationTitle?: string;

  /**
   * ANDROID ONLY
   * Custom notification text in the drawer.
   */
  notificationText?: string;

  /**
   * ANDROID ONLY
   * The accent color to use for notification. Eg. #4CAF50.
   */
  notificationIconColor?: string;

  /**

   * ANDROID ONLY

   * The filename of a custom notification icon. See android quirks.

   * NOTE: Only available for API Level >=21.

   */
  notificationIconLarge?: string;

  /**

   * ANDROID ONLY

   * The filename of a custom notification icon. See android quirks.

   * NOTE: Only available for API Level >=21.

   */
  notificationIconSmall?: string;

  /**
   * ANDROID ONLY
   * Set location service provider @see wiki (https://github.com/mauron85/cordova-plugin-background-geolocation/wiki/Android-providers)
   */
  locationProvider?: number;

  /**
   * IOS ONLY
   * [AutomotiveNavigation, OtherNavigation, Fitness, Other] Presumably,
   * this affects iOS GPS algorithm. @see Apple docs for more information
   * (https://developer.apple.com/library/ios/documentation/CoreLocation/Reference/CLLocationManager_Class/CLLocationManager/CLLocationManager.html#//apple_ref/occ/instp/CLLocationManager/activityType)
   */
  activityType?: string;

  /**

   * IOS ONLY

   * Pauses location updates when app is paused

   *
   * Defaults to true

   */
  pauseLocationUpdates?: boolean;

  /**

   * Server url where to send HTTP POST with recorded locations

   * @see https://github.com/mauron85/cordova-plugin-background-geolocation#http-locations-posting

   */
  url?: string;

  /**

   * Server url where to send fail to post locations

   * @see https://github.com/mauron85/cordova-plugin-background-geolocation#http-locations-posting

   */
  syncUrl?: string;

  /**
   * Specifies how many previously failed locations will be sent to server at once

   *
   * Defaults to 100

   */
  syncThreshold?: number;

  /**

   * Optional HTTP headers sent along in HTTP request

   */
  httpHeaders?: any;

  /**
   * IOS ONLY

   * Switch to less accurate significant changes and region monitory when in background (default)
   *
   * Defaults to 100

   */
  saveBatteryOnBackground?: boolean;

  /**

   * Limit maximum number of locations stored into db

   *
   * Defaults to 10000

   */
  maxLocations?: number;

  /**
   * ANDROID ONLY with BackgroundGeolocation.LocationProvider.ANDROID_ACTIVITY_PROVIDER
   *
   * Fastest rate in milliseconds at which your app can handle location updates.
   * @see Android docs (https://developers.google.com/android/reference/com/google/android/gms/location/LocationRequest.html#getFastestInterval())
   */
  fastestInterval?: number;

  /**
   * ANDROID ONLY with BackgroundGeolocation.LocationProvider.ANDROID_ACTIVITY_PROVIDER
   *
   * Rate in milliseconds at which activity recognition occurs. Larger values will result in fewer activity detections while improving battery life.
   */
  activitiesInterval?: number;

  /**
   * ANDROID ONLY with BackgroundGeolocation.LocationProvider.ANDROID_ACTIVITY_PROVIDER
   *
   * stop() is forced, when the STILL activity is detected (default is true)
   */
  stopOnStillActivity?: boolean;
}

/**
 * @name BackgroundGeolocation
 * @description
 * This plugin provides foreground and background geolocation with battery-saving "circular region monitoring" and "stop detection". For
 * more detail, please see https://github.com/mauron85/cordova-plugin-background-geolocation
 *
 * @usage
 *
 * ```typescript
 * import { BackgroundGeolocation } from 'ionic-native';
 *
 *
 * // When device is ready :
 * platform.ready().then(() => {
 *     // IMPORTANT: BackgroundGeolocation must be called within app.ts and or before Geolocation. Otherwise the platform will not ask you for background tracking permission.
 *
 *     // BackgroundGeolocation is highly configurable. See platform specific configuration options
 *     let config = {
 *             desiredAccuracy: 10,
 *             stationaryRadius: 20,
 *             distanceFilter: 30,
 *             debug: true, //  enable this hear sounds for background-geolocation life-cycle.
 *             stopOnTerminate: false, // enable this to clear background location settings when the app terminates
 *     };
 *
 *     BackgroundGeolocation.configure((location) => {
         console.log('[js] BackgroundGeolocation callback:  ' + location.latitude + ',' + location.longitude);

          // IMPORTANT:  You must execute the finish method here to inform the native plugin that you're finished,
          // and the background-task may be completed.  You must do this regardless if your HTTP request is successful or not.
          // IF YOU DON'T, ios will CRASH YOUR APP for spending too much time in the background.
          BackgroundGeolocation.finish(); // FOR IOS ONLY

 *      }, (error) => {
 *        console.log('BackgroundGeolocation error');
 *      }, config);
 *
 *     // Turn ON the background-geolocation system.  The user will be tracked whenever they suspend the app.
 *     BackgroundGeolocation.start();
 * })
 *
 * // If you wish to turn OFF background-tracking, call the #stop method.
 * BackgroundGeolocation.stop();
 *
 * ```
 * @interfaces
 * BackgroundGeolocationResponse
 * BackgroundGeolocationConfig
 */
@Plugin({
  pluginName: 'BackgroundGeolocation',
  plugin: 'cordova-plugin-mauron85-background-geolocation',
  pluginRef: 'backgroundGeolocation',
  repo: 'https://github.com/mauron85/cordova-plugin-background-geolocation',
  platforms: ['iOS', 'Android', 'Windows Phone 8']
})
export class BackgroundGeolocation {

  /**

   * Set location service provider @see https://github.com/mauron85/cordova-plugin-background-geolocation/wiki/Android-providers

   *
   * Possible values:
   *  ANDROID_DISTANCE_FILTER_PROVIDER: 0,

   *  ANDROID_ACTIVITY_PROVIDER: 1

   *
   * @enum {number}

   */
  static LocationProvider: any = {
    ANDROID_DISTANCE_FILTER_PROVIDER: 0,
    ANDROID_ACTIVITY_PROVIDER: 1
  };

  /**
   * Desired accuracy in meters. Possible values [0, 10, 100, 1000].

   * The lower the number, the more power devoted to GeoLocation resulting in higher accuracy readings.

   * 1000 results in lowest power drain and least accurate readings.

   *
   * Possible values:
   *  HIGH: 0

   *  MEDIUM: 10

   *  LOW: 100

   *  PASSIVE: 1000
   *
   * enum {number}

   */
  static Accuracy: any = {
    HIGH: 0,
    MEDIUM: 10,
    LOW: 100,
    PASSIVE: 1000
  };

  /**

   * Used in the switchMode function

   *
   * Possible values:
   *  BACKGROUND: 0
   *  FOREGROUND: 1

   *
   * @enum {number}

   */
  static Mode: any = {
    BACKGROUND: 0,
    FOREGROUND: 1
  };

  /**
   * Configure the plugin.
   *
   * @param {Function} callback callback will be called when background location is determined.
   * @param {Function} errorCallback callback to be executed every time a geolocation error occurs.
   * @param {Config} options An object of type Config
   * @return {Promise<any>}
   */
  @Cordova({
    callbackOrder: 'reverse'
  })
  static configure(options: BackgroundGeolocationConfig): Promise<any> { return; }

  /**
   * Turn ON the background-geolocation system.
   * The user will be tracked whenever they suspend the app.
   * @returns {Promise<any>}
   */
  @Cordova()
  static start(): Promise<any> { return; }

  /**
   * Turn OFF background-tracking
   * @returns {Promise<any>}
   */
  @Cordova()
  static stop(): Promise<any> { return; }

  /**
   * Inform the native plugin that you're finished, the background-task may be completed
   * NOTE: IOS, WP only
   * @returns {Promise<any>}
   */
  @Cordova()
  static finish(): Promise<any> { }

  /**
   * Force the plugin to enter "moving" or "stationary" state
   * NOTE: IOS, WP only
   */
  @Cordova()
  static changePace(isMoving: boolean) { }

  /**
   * Setup configuration
   * @returns {Promise<any>}
   */
  @Cordova({
    callbackOrder: 'reverse'
  })
  static setConfig(options: BackgroundGeolocationConfig): Promise<any> { return; }

  /**
   * Returns current stationaryLocation if available. null if not
   * NOTE: IOS, WP only
   * @returns {Promise<Location>}
   */
  @Cordova()
  static getStationaryLocation(): Promise<BackgroundGeolocationResponse> { return; }

  /**
   * Add a stationary-region listener. Whenever the devices enters "stationary-mode",
   * your #success callback will be executed with #location param containing #radius of region
   * NOTE: IOS, WP only
   * @returns {Promise<any>}
   */
  @Cordova()
  static onStationary(): Promise<any> { return; }

  /**
   * Check if location is enabled on the device
   * @returns {Promise<number>} Returns a promise with int argument that takes values 0, 1 (true).
   * NOTE: ANDROID only
   */
  @Cordova()
  static isLocationEnabled(): Promise<number> { return; }

  /**
   * Display app settings to change permissions
   */
  @Cordova({sync: true})
  static showAppSettings(): void { }

  /**
   * Display device location settings
   */
  @Cordova({sync: true})
  static showLocationSettings(): void { }

  /**
   * Method can be used to detect user changes in location services settings.
   * If user enable or disable location services then success callback will be executed.
   * In case or error (SettingNotFoundException) fail callback will be executed.
   * NOTE: ANDROID only
   * @returns {Promise<boolean>}
   */
  @Cordova()
  static watchLocationMode(): Promise<boolean> { return; }

  /**
   * Stop watching for location mode changes.
   * NOTE: ANDROID only
   */
  @Cordova()
  static stopWatchingLocationMode() { }

  /**
   * Method will return all stored locations.
   * Locations are stored when:
   *  - config.stopOnTerminate is false and main activity was killed
   *    by the system
   *  or
   *  - option.debug is true
   * NOTE: ANDROID only
   * @returns {Promise<any>}
   */
  @Cordova()
  static getLocations(): Promise<any> { return; }

  /**

   * Method will return locations, which has not been yet posted to server. NOTE: Locations does contain locationId.

   * @returns {Promise<any>}
   */
  @Cordova()
  static getValidLocations(): Promise<any> { return; }

  /**
   * Delete stored location by given locationId.
   * NOTE: ANDROID only
   * @returns {Promise<any>}
   */
  @Cordova()
  static deleteLocation(locationId: number): Promise<any> { return; }

  /**
   * Delete all stored locations.
   * NOTE: ANDROID only
   * @returns {Promise<any>}
   */
  @Cordova()
  static deleteAllLocations(): Promise<any> { return; }

  /**
   * Normally plugin will handle switching between BACKGROUND and FOREGROUND mode itself.
   * Calling switchMode you can override plugin behavior and force plugin to switch into other mode.
   *
   * In FOREGROUND mode plugin uses iOS local manager to receive locations and behavior is affected by option.desiredAccuracy and option.distanceFilter.
   * In BACKGROUND mode plugin uses significant changes and region monitoring to receive locations and uses option.stationaryRadius only.

   *
   * BackgroundGeolocation.Mode.FOREGROUND
   * BackgroundGeolocation.Mode.BACKGROUND

   *
   * NOTE: iOS only
   *
   * @param {number} See above.

   * @returns {Promise<any>}
   */
  @Cordova()
  static switchMode(modeId: number): Promise<any> { return; }

  /**

   * Return all logged events. Useful for plugin debugging. Parameter limit limits number of returned entries.

   * @see https://github.com/mauron85/cordova-plugin-background-geolocation/tree/v2.2.1#debugging for more information.

   *
   * @param {number} Limits the number of entries

   * @returns {Promise<any>}
   */
  @Cordova()
  static getLogEntries(limit: number): Promise<any> { return; }

}