Skip to content

Commit

Permalink
docs(background-geolocation): config method, example fix (#478)
Browse files Browse the repository at this point in the history
  • Loading branch information
justinschuldt authored and ihadeed committed Aug 26, 2016
1 parent efa222f commit 6171646
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions src/plugins/background-geolocation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -188,13 +188,11 @@ export interface Config {
* }, (error) => {
* console.log('BackgroundGeolocation error');
* }, {
* //options
* });
* }, config);
*
* // Turn ON the background-geolocation system. The user will be tracked whenever they suspend the app.
* BackgroundGeolocation.start();
* }
* })
*
* // If you wish to turn OFF background-tracking, call the #stop method.
* BackgroundGeolocation.stop();
Expand All @@ -211,13 +209,14 @@ export class BackgroundGeolocation {

/**
* Configure the plugin.
* Success callback will be called with one argument - Location object, which tries to mimic w3c Coordinates interface.
*
* @param {Function} Success callback will be called when background location is determined.
* @param {Function} Fail callback to be executed every time a geolocation error occurs.
* @param {Object} An object of type Config
*
* @return Location object, which tries to mimic w3c Coordinates interface.
* See http://dev.w3.org/geo/api/spec-source.html#coordinates_interface
* Callback to be executed every time a geolocation is recorded in the background.
*
* Fail callback to be executed every time a geolocation error occurs.
*
* Options a json object of type Config
*/
@Cordova({
sync: true
Expand Down

0 comments on commit 6171646

Please sign in to comment.