Skip to content

Latest commit

 

History

History
296 lines (238 loc) · 9.49 KB

README.md

File metadata and controls

296 lines (238 loc) · 9.49 KB
Raw

background-location-update

A Capacitor plugin which lets you receive location updates even while the app is backgrounded.

Install

npm install background-location-update
npx cap sync

Usage

import { BackgroundLocation, Location } from 'background-location-update';

iOS

Add the following keys to Info.plist.:

<dict>
  ...
  <key>NSLocationWhenInUseUsageDescription</key>
  <string>We need to track your location</string>
  <key>NSLocationAlwaysAndWhenInUseUsageDescription</key>
  <string>We need to track your location while your device is locked.</string>
  <key>UIBackgroundModes</key>
  <array>
    <string>location</string>
  </array>
  ...
</dict>

Android

Configure AndroidManifest.xml:

<manifest>
    <application>
        <service
            android:name="com.viewtrak.plugins.backgroundlocation.BackgroundLoctionService"
            android:enabled="true"
            android:exported="true"
            android:foregroundServiceType="location" />
    </application>

    <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
    <uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
    <uses-feature android:name="android.hardware.location.gps" />
</manifest>

Configration specific to Android can be made in strings.xml:

<resources>
    <!--
        The channel name for the background notification. This will be visible
        when the user presses & holds the notification. It defaults to
        "Background Tracking".
    -->
    <string name="capacitor_background_location_notification_channel_name">
        Background Tracking
    </string>

    <!--
        The icon to use for the background notification. Note the absence of a
        leading "@". It defaults to "mipmap/ic_launcher", the app's launch icon.

        If a raster image is used to generate the icon (as opposed to a vector
        image), it must have a transparent background. To make sure your image
        is compatible, select "Notification Icons" as the Icon Type when
        creating the image asset in Android Studio.
    -->
    <string name="capacitor_background_location_notification_icon">
        drawable/ic_tracking
    </string>
</resources>

API

addWatcher(...)

addWatcher(options: WatcherOptions, callback: (position?: Location | undefined, error?: CallbackError | undefined) => void) => Promise<string>

// To start listening for changes in the device's location, add a new watcher.
// You do this by calling 'addWatcher' with an options object and a callback. A
// Promise is returned, which resolves to the callback ID used to remove the
// watcher in the future. The callback will be called every time a new location
// is available. Watchers can not be paused, only removed. Multiple watchers may
// exist simultaneously.
await BackgroundLocation.addWatcher(
    // If the "backgroundMessage" option is defined, the watcher will
    // provide location updates whether the app is in the background or the
    // foreground. If it is not defined, location updates are only
    // guaranteed in the foreground. This is true on both platforms.

    // On Android, a notification must be shown to continue receiving
    // location updates in the background. This option specifies the text of
    // that notification.
    backgroundMessage: "Cancel to prevent battery drain.",

    // The title of the notification mentioned above. Defaults to "Using
    // your location".
    backgroundTitle: "Tracking You.",

    // Whether permissions should be requested from the user automatically,
    // if they are not already granted. Defaults to "true".
    requestPermissions: true,

    // If "true", stale locations may be delivered while the device
    // obtains a GPS fix. You are responsible for checking the "time"
    // property. If "false", locations are guaranteed to be up to date.
    // Defaults to "false".
    stale: false,

    // The minimum number of metres between subsequent locations. Defaults
    // to 0.
    distanceFilter: 50,
    // To add notification action for android platform only. Defaults
    // to false.
    onlineNotificationAction: false,
    // set User current online active state
    isOnline: false,
    // Notification Action string for mark online. Defaults to Mark Online
    actionOnline: "Mark Online"
    // Notification Action string for mark offline. Defaults to Mark Offline
    actionOffline: "Mark Offline"
    },
    (location, error) => watcher_callback(location, error),
);

watcher_callback(location, error) {
    if (error) {
        if (error.code === "NOT_AUTHORIZED") {
            if (window.confirm(
                "This app needs your location, " +
                "but does not have permission.\n\n" +
                "Open settings now?"
            )) {
                // It can be useful to direct the user to their device's
                // settings when location permissions have been denied. The
                // plugin provides the 'openSettings' method to do exactly
                // this.
                BackgroundGeolocation.openSettings();
            }
        }
        return console.error(error);
    }

    return console.log(location);
}
Param Type
options WatcherOptions
callback (position?: Location, error?: CallbackError) => void

Returns: Promise<string>

removeWatcher(...)

removeWatcher(options: { id: string; }) => Promise<void>

// When a watcher is no longer needed, it should be removed by calling
// 'removeWatcher' with an object containing its ID.
BackgroundGeolocation.removeWatcher({
    id: watcher_id
});
Param Type
options { id: string; }

openSettings()

openSettings() => Promise<void>

// It can be useful to direct the user to their device's
// settings when location permissions have been denied. The
// plugin provides the 'openSettings' method to do exactly
// this.
BackgroundGeolocation.openSettings();

addlisteneronlinenotificationaction(...)

  /**
   * Called when onlineNotificationAction set to true in addWatcher() and result received
   *
   * Provides onlineNotificationAction result.
   *
   * To remove the listener listener.remove() can be used.
   *
   * @since 2.0.2
   */
  addListener(
    eventName: 'onlineNotificationAction',
    listenerFunc: (data: { isOnline: boolean }) => void,
  ): Promise<PluginListenerHandle> & PluginListenerHandle;

Interfaces

WatcherOptions

Prop Type
backgroundMessage string
backgroundTitle string
requestPermissions boolean
stale boolean
distanceFilter number
onlineNotificationAction boolean
isOnline boolean
actionOnline boolean
actionOffline boolean

Location

Prop Type
latitude number
longitude number
accuracy number
altitude number | null
altitudeAccuracy number | null
simulated boolean
bearing number | null
speed number | null
time number | null

{ // Longitude in degrees. longitude: 131.723423719132, // Latitude in degrees. latitude: -22.40106297456, // Radius of horizontal uncertainty in metres, with 68% confidence. accuracy: 11, // Metres above sea level (or null). altitude: 65, // Vertical uncertainty in metres, with 68% confidence (or null). altitudeAccuracy: 4, // Deviation from true north in degrees (or null). bearing: 159.60000610351562, // True if the location was simulated by software, rather than GPS. simulated: false, // Speed in metres per second (or null). speed: 23.51068878173828, // Time the location was produced, in milliseconds since the unix epoch. time: 1562731602000 }

CallbackError

Prop Type
code string