react-native-background-geolocation 4.8.2 → 4.9.3

package/src/declarations/interfaces/Config.d.ts

@@ -1203,6 +1203,26 @@ declare module "react-native-background-geolocation" {
     *
     */
     disableAutoSyncOnCellular?: boolean;
+    /**
+     * __`[Android-only]`__ Disables the automatic insert of a location record into the SDK's SQLite database and subsequent HTTP upload if configured with [[Config.url]].
+     * When a [[onProviderChange]] event fires, the Android SDK has traditionally recorded a location to show exactly *when* and *where* the state of location-services was changed (eg: Location-services disabled).
+     *
+     * Android has done this *automatically* due to the difficulty with some platforms' implementation of *Headless Tasks* ([[enableHeadless]]), where *Cordova* and *Capacitor* require implementations using *Java* code, which is often difficult for most developers.
+     *
+     * Some developers' servers have strict HTTP JSON payloads and possibly using [[locationTemplate]], where it's impossible to template the automatically appended `provider` key in the payload.
+     *
+     * ![](https://www.dropbox.com/s/ljacoquuuv5sd5r/disableProviderChangeRecord.png?dl=1)
+     *
+     *  Set `true` to disable this default behaviour.
+     *
+     * @example
+     * ```
+     * BackgroundGeolocation.ready({
+     *   disableProviderChangeRecord: true
+     * })
+     * ```
+     */
+     disableProviderChangeRecord?: boolean;
 
     /**
     * Configures the SDK for [[Authorization]] with your server (eg: [JSON Web Token](https://jwt.io/)).

package/src/declarations/interfaces/Location.d.ts

@@ -25,10 +25,17 @@ declare module "react-native-background-geolocation" {
     */
     accuracy: number;
     /**
-    * Altitude above sea-level in meters.
+    * [iOS] Altitude above sea-level in meters.
+    * [Android] The altitude of this location in meters above the WGS84 reference ellipsoid.
+    * - See [[ellipsoidal_altitude]]
+    *
     */
     altitude?: number;
     /**
+    * The altitude of this location in meters above the WGS84 reference ellipsoid.
+    */
+    ellipsoidal_altitude?: number;
+    /**
     * Altitude accuracy in meters.
     *
     * If this location does not have `altitude_accuracy`, then `-1` is returned.
@@ -101,6 +108,7 @@ declare module "react-native-background-geolocation" {
    *        "speed":     [Double],
    *        "heading":   [Double],
    *        "altitude":  [Double]
+   *        "ellipsoidal_altitude":  [Double]
    *    },
    *    "activity": {
    *        "type": [still|on_foot|walking|running|in_vehicle|on_bicycle],
@@ -127,7 +135,8 @@ declare module "react-native-background-geolocation" {
    *             "accuracy":   [Double],
    *             "speed":      [Double],
    *             "heading":    [Double],
-   *             "altitude":   [Double]
+   *             "altitude":   [Double],
+   *             "ellipsoidal_altitude": [Double]
    *         },
    *         "extras": {   // <-- optional meta-data
    *             "foo": "bar"
@@ -180,7 +189,7 @@ declare module "react-native-background-geolocation" {
     */
     event?: string;
     /**
-    * __[Android only]__.  Present (and `true`) if the location was generated by a "Fake Location" application.
+    * Present (and `true`) if the location was generated by a "Fake Location" application or simulator.
     */
     mock?: boolean;
     /**

package/src/declarations/interfaces/Notification.d.ts

@@ -480,5 +480,12 @@ declare module "react-native-background-geolocation" {
     */
     channelName?: string;
 
+    /**
+     * Customize the notification channel ID.
+     * Defaults to `your.package.name.TSLocationManager`
+     *
+     * __NOTE__:  It is not typically required to change this.  Typical use-cases are for users who use an existing Android foreground-service who wish the SDK to share an existing notification and channel.
+     */
+     channelId?: string;
   }
 }