@transistorsoft/capacitor-background-geolocation 4.9.4 → 4.10.0

package/dist/declarations/State.d.ts

@@ -1,51 +0,0 @@
-/// <reference path="./Config.d.ts" />
-
-declare module "@transistorsoft/capacitor-background-geolocation" {
-	/**
-	* This `State` object contains all the provided [[Config]] options in addition to:
-	* - [[enabled]].
-	* - [[schedulerEnabled]].
-	* - [[trackingMode]].
-	* - [[odometer]].
-  * - [[didLaunchInBackground]].
-  * - [[didDeviceReboot]]
-	*/
-  interface State extends Config {
-  	/**
-  	* `true` when the SDK has been enabled via methods [[start]] or [[startGeofences]].  When `false`, the
-  	* SDK is completely __OFF__.  No tracking of any kind will occur.  The SDK will consume no energy.
-  	*/
-    enabled: boolean;
-    /**
-    * `true` when the SDK is currently configured with a [[schedule]] and [[startSchedule]] has been executed.
-    * [[stopSchedule]] will set this to `false`.
-    */
-    schedulerEnabled: boolean;
-    /**
-    | Value      | Description                       |
-  	|------------|-----------------------------------|
-  	| __`0`__    | Monitoring geofences only         |
-  	| __`1`__    | Monitoring location + geofences   |
-    */
-    trackingMode: TrackingMode;
-    /**
-    * The current distance-traveled.
-    * ### ℹ️ See also:
-    * - [[resetOdometer]], [[setOdometer]]
-    * - [[getOdometer]]
-    */
-    odometer: number;
-    /**
-    * `true` when the iOS app was launched in the background.  Always `false` for Android.
-    * iOS apps can be launched in the background due to a background-fetch event, geofence events or exiting the [[Config.stationaryRadius]].
-    *
-    * One might use this flag to choose to load only minimal resources until the iOS app is determined to have launched into the foreground.
-    *
-    */
-    didLaunchInBackground: boolean;
-    /**
-    * Indicates if the app was launched after the device was rebooted.
-    */
-    didDeviceReboot: boolean;
-  }
-}

package/dist/declarations/Subscription.d.ts

@@ -1,104 +0,0 @@
-declare module "@transistorsoft/capacitor-background-geolocation" {
-  /**
-  * Object returned by BackgroundGeolocation event-listeners.  `Subscription` contains just a single method [[remove]], used for removing an event-listener.
-  *
-  * - [[BackgroundGeolocation.onLocation]]
-  * - [[BackgroundGeolocation.onMotionChange]]
-  * - [[BackgroundGeolocation.onHttp]]
-  * - [[BackgroundGeolocation.onHeartbeat]]
-  * - [[BackgroundGeolocation.onProviderChange]]
-  * - [[BackgroundGeolocation.onActivityChange]]
-  * - [[BackgroundGeolocation.onGeofence]]
-  * - [[BackgroundGeolocation.onGeofencesChange]]
-  * - [[BackgroundGeolocation.onEnabledChange]]
-  * - [[BackgroundGeolocation.onConnectivityChange]]
-  * - [[BackgroundGeolocation.onSchedule]]
-  * - [[BackgroundGeolocation.onPowerSaveChange]]
-  * - [[BackgroundGeolocation.onNotificationAction]]
-  * - [[BackgroundGeolocation.onAuthorization]]
-  *
-  * In the past, one would remove event-listeners using the __now-deprectated__ [[BackgroundGeolocation.removeListener]].
-  *
-  * ## Removing an event-listener:
-  *
-  * @example
-  * ```typescript
-  * // Event-listeners return a Subscription instance, containing a .remove() method.
-  * const subscription = BackgroundGeolocation.onLocation(location => {
-  *   console.log("[onLocation] ", location);
-  * });
-  * .
-  * .
-  * .
-  * // Later, to remove the event-listener:
-  * subscription.remove();
-  * ```
-  *
-  * One might typically manage a collection of `Subscription` instances
-  *
-  * @example
-  * ```typescript
-  * import BackgroundGeolocation, {
-  *   Location,
-  *   Subscription
-  * } from ...
-  *
-  * // Your custom Collection of Subscription instances.
-  * const SUBSCRIPTIONS = [];
-  *
-  * // Your custom method to push a Subscription instance.
-  * const subscribe = (subscription:Subscription) => {
-  *   SUBSCRIPTIONS.push(subscription);
-  * }
-  *
-  * // Your custom method to interate your SUBSCRIPTIONS and .remove each.
-  * const unsubscribe = () => {
-  *   SUBSCRIPTIONS.forEach((subscription:Subscription) => subscription.remove());
-  * }
-  *
-  * const initBackgroundGeolocation = () {
-  *   // Create event-listeners as usual, feeding the returned Subscription into
-  *   // your custom  subscribe() method.
-  *   subscribe(BackgroundGeolocation.onLocation((location:Location) => {
-  *     console.log('[onLocation]', location);
-  *   });
-  *
-  *   subscribe(BackgroundGeolocation.onMotionChange((location:Location) => {
-  *     console.log('[onMotionChange]', location);
-  *   });
-  *
-  *   subscribe(BackgroundGeolocation.onEnabledChange((enabled:boolean) => {
-  *     console.log('[onEnabledChange]', enabled);
-  *   });
-  * }
-  *
-  * const onDestroyView = () => {
-  *   // Call your custom unsubscribe method
-  *   unsubscribe();
-  * }
-  *
-  * ```
-  */
-  interface Subscription {
-    /**
-     * Removes a `BackgroundGeolocation` event-listener.
-     * @example
-     * ```typescript
-     * // Event-listeners return a Subscription instance, containing a .remove() method.
-     * const onLocationSubscription = BackgroundGeolocation.onLocation(location => {
-     *   console.log("[onLocation] ", location);
-     * });
-     *
-     * const onGeofenceSubscription = BackgroundGeolocation.onGeofence(event => {
-     *   console.log("[onGeofence] ", event);
-     * });
-     * .
-     * .
-     * .
-     * // Later, removing event-listeners.
-     * onLocationSubscription.remove();
-     * onGeofenceSubscription.remove();
-     */
-    remove():void;
-  }
-}

package/dist/declarations/TransistorAuthorizationToken.d.ts

@@ -1,63 +0,0 @@
-declare module "@transistorsoft/capacitor-background-geolocation" {
-  /**
-  * Response object returned by [[BackgroundGeolocation.findOrCreateTransistorAuthorizationToken]] for configuring the SDK's [[Authorization]] with Transistor Software's Demo Server at [http://tracker.transistorsoft.com](http://tracker.transistorsoft.com).
-  *
-  * You may also run your own instance of Demo Server locally.  See [background-geolocation-console](https://github.com/transistorsoft/background-geolocation-console)
-  *
-  * The test server is a great way to debug location problems or evalute the SDK's behaviour, since the results can easily be shared with *Transistor Software* when requesting support.
-  *
-  * ![](https://dl.dropboxusercontent.com/s/3abuyyhioyypk8c/screenshot-tracker-transistorsoft.png?dl=1)
-  *
-  *
-  * @example
-  * ```typescript
-  * // Url to demo server.
-  * let url = "http://tracker.transistorsoft.com";
-  * let orgname = "my-company-name";
-  * let username = "my-username";
-  *
-  * // Fetch an authoriztion token from server.  The SDK will cache the received token.
-  * let token = await
-  *   BackgroundGeolocation.findOrCreateTransistorAuthorizationToken(orgname, username, url);
-  *
-  * BackgroundGeolocation.ready({
-  *   transistorAuthorizationToken: token
-  * })
-  * ```
-  *
-  * ## Viewing Your Tracking Results
-  *
-  * To *view* your tracking results in the browser, use your configured "Organization Name" and visit:
-  *
-  * http://tracker.transistorsoft.com/my-organization-name
-  *
-  */
-  interface TransistorAuthorizationToken {
-  	/**
-  	* The authorization token to provide to [[Authorization.accessToken]]
-    *
-    * @example
-    * ```typescript
-    * BackgroundGeolocation.ready({
-    *  authorization: {
-    *    accessToken:
-    *  }
-    * });
-    * ```
-  	*/
-  	accessToken:string;
-  	/**
-  	* The token used to request to provide to [[Authorization.refreshToken]]
-  	*/
-  	refreshToken:string;
-  	/**
-  	* The expiry time of the [[Authorization.accessToken]]
-  	*/
-  	expires:number;
-    /**
-    * The url to the Transistor Demo server where this token came from.
-    * __Read only__
-    */
-    url?: string;
-  }
-}

package/dist/declarations/WatchPositionRequest.d.ts

@@ -1,45 +0,0 @@
-declare module "@transistorsoft/capacitor-background-geolocation" {
-	/**
-  * Options provided to [[BackgroundGeolocation.watchPosition]].
-  *
-  * @example
-  * ```typescript
-  * BackgroundGeolocation.watchPosition((location) => {
-	*   console.log("[watchPosition] -", location);
-  * }, (errorCode) => {
-	*   console.log("[watchPosition] ERROR -", errorCode);
-  * }, {
-	*   interval: 1000,
-	*   desiredAccuracy: BackgroundGeolocation.DESIRED_ACCURACY_HIGH,
-	*   persist: true,
-	*   extras: {foo: "bar"},
-	*   timeout: 60000
-  * });
-  * ```
-  */
-	interface WatchPositionRequest {
-		/**
-		* Location update interval in `milliseconds`.  Defaults to `1000`.
-		*/
-    interval?: number;
-    /**
-    * Specifies the accuracy required.  See [[Config.desiredAccuracy]].  Only [[BackgroundGeolocation.DESIRED_ACCURACY_HIGH]] uses GPS.
-    * Defaults to [[DESIRED_ACCURACY_HIGH]].
-    */
-    desiredAccuracy?: LocationAccuracy;
-    /**
-    * Set `true` to persist each recorded location to the plugin's database.
-    * Defaults to `true` when [[State.enabled]], `false` otherwise.
-    */
-    persist?: boolean;
-    /**
-    * Arbitrary key/values to append to each recorded location.
-    */
-    extras?: Extras;
-    /**
-    * Time in `milliseconds` to wait before firing error callback when location fails to arrive.
-    * Defaults to `60000`.
-    */
-    timeout?: number;
-  }
-}