Commit 96cb6f5d authored by Chris Scott's avatar Chris Scott

Docs

parent 2b1c467b
...@@ -260,6 +260,9 @@ bgGeo.changePace(false); // <-- Disable aggressive GPS monitoring. Engages stat ...@@ -260,6 +260,9 @@ bgGeo.changePace(false); // <-- Disable aggressive GPS monitoring. Engages stat
####`onStationary(callbackFn, failureFn)` ####`onStationary(callbackFn, failureFn)`
Your ```callbackFn``` will be executed each time the device has entered stationary-monitoring mode. The ```callbackFn``` will be provided with a ```Location``` object as the 1st param, with the usual params (```latitude, longitude, accuracy, speed, bearing, altitude```), in addition to a ```taskId``` used to signal that your callback is finished. Your ```callbackFn``` will be executed each time the device has entered stationary-monitoring mode. The ```callbackFn``` will be provided with a ```Location``` object as the 1st param, with the usual params (```latitude, longitude, accuracy, speed, bearing, altitude```), in addition to a ```taskId``` used to signal that your callback is finished.
######`@param {Object} location` The Location data
######`@param {Integer} taskId` The taskId used to send to bgGeo.finish(taskId) in order to signal completion of your callbackFn
``` ```
bgGeo.onStationary(function(location, taskId) { bgGeo.onStationary(function(location, taskId) {
console.log('- Device is stopped: ', location.latitude, location.longitude); console.log('- Device is stopped: ', location.latitude, location.longitude);
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment