Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

@coreo/ionic-background-tracking

0.0.5 • Public • Published

@coreo/ionic-background-tracking

Ionic 2+ module for tracking a users location.

Installation

cordova plugin add https://github.com/transistorsoft/cordova-background-geolocation.git#2.11.0 --save
yarn add @coreo/ionic-background-tracking

Usage

Import the module in your app.module.ts;

import { CoreoBackgroundTrackingModule } from '@coreo/ionic-background-tracking';
...
@NgModule({
  imports: [
    ...
    CoreoBackgroundTrackingModule
    ...
  ]
})
export class AppModule {}

CoreoBackgroundTracking service

Inject the service into your component;

import { CoreoBackgroundTracking } from '@coreo/ionic-background-tracking';
 
@Component()
export class MyComponent() {
  constructor(private geoService: CoreoBackgroundTracking) {}
}
 

Methods

  • startTracking() - Enables location tracking. Returns an observable which emits the position of the device. Emitted position objects conform to the CoreoBackgroundTrackingPosition interface.
  • stopTracking() - Disables location tracking.
  • getCurrentLocation - Retrieves the current position of the device using maximum power and accuracy. Returns a promise which is resolved with an object conforming to the CoreoBackgroundTrackingPosition interface.
  • setConfig(config: ConfigurationOptions) - Sets the config to be used by the cordova-background-geolocation plugin. See the cordova-background-geolocation API documentation for a list of config options that can be set.
  • setCurrentPositionOptions(opts: CurrentPositionOptions) - Sets the options to be used by getCurrentPosition() function included in the cordova-background-geolocation plugin. See the cordova-background-geolocation API documentation for a list of options that can be set.

Properties

  • isTracking: boolean - Flag indicating whether location tracking is currently enabled.

Interfaces

  • CoreoBackgroundTrackingPosition
  • CurrentPositionOptions
  • ConfigurationOptions

Keywords

none

Install

npm i @coreo/ionic-background-tracking

DownloadsWeekly Downloads

2

Version

0.0.5

License

MIT

Unpacked Size

30.5 kB

Total Files

35

Last publish

Collaborators

  • avatar
  • avatar