background-location

background-location

The plugin to capture geolocation in background (Only Android Support)

Install

npm install background-location --save
npx cap sync

Release History

• 1.1.6
  • CHANGE: initial
  • NOTE: (Current to Capacitor 2)
• 2.0.x
  • CHANGE: Migrate to capacitor 3
  • NOTE: Is no necesarty init plugin in MainActivity.java
• 2.1.x
  • CHANGE: Stable Version for apps below capacitor 3
  • NOTE: Is no necesarty init plugin in MainActivity.java
• 2.2.x
  • CHANGE: Stable Version for apps below capacitor 6
  • NOTE: Is no necesarty init plugin in MainActivity.java
• 2.3.x
  • CHANGE: Stable Version for apps below capacitor 7
  • NOTE: Is no necesarty init plugin in MainActivity.java

Android

For version 1.x add line in MainActivity.java:

add(T2BackgroundLocation.class);

For version 2.x this is not necessary.

Example

import { T2BackgroundLocation } from 'background-location';

const backgroundLocation = async () => {
  const image = await T2BackgroundLocation.startBackgroundService({
    driverId: <value>,
    driverName: <value>,
    pin: <value>,
    token: <value>,
    url: <value>,
    socketUrl: <value>,
    socketActive: <value>,
    updateInternal: <value>,
    tenant: <value>
  });
};

---

API

• startBackgroundService(...)
• stopBackgroundService(...)
• Interfaces

---

startbackgroundservice(...)

startBackgroundService(options: T2BackgroundLocationOptions): Promise<any>;

Init service in background

Param	Type
options	T2BackgroundLocationOptions

Returns: Promise<any>

---

stopbackgroundservice()

stopBackgroundService(): Promise<any>;

Stop service in background

Returns: Promise<any>

---

Interfaces

T2BackgroundLocationOptions

Prop	Type	Description	Since
driverId	number		1.0.0
driverName	string		1.0.0
pin	number		1.0.0
token	string		1.0.0
url	string		1.0.0
socketUrl	string		1.0.0
socketActive	boolean		1.0.0
updateInternal	number		1.0.0
tenant	string		2.3.0

---