Commit b5109b54 authored by Chris Scott's avatar Chris Scott

Docs

parent 830fa039
...@@ -287,6 +287,18 @@ Enable this in order to force a stop() when the application terminated (e.g. on ...@@ -287,6 +287,18 @@ Enable this in order to force a stop() when the application terminated (e.g. on
#### HTTP Features #### HTTP Features
#####`@param {String} url`
By configuring an ```#url```, the plugin will always attempt to HTTP POST the location to your server.
#####`@param {Object} params`
Optional HTTP params sent along in HTTP request to above ```#url```.
#####`@param {Object} headers`
Optional HTTP params sent along in HTTP request to above ```#url```.
Both iOS and Android can send the Geolocation to your server simply by configuring an ```#url``` in addition to optional ```#headers``` and ```#params```. This is the preferred way to send the Geolocation to your server, rather than doing it yourself with Ajax in your javascript. Both iOS and Android can send the Geolocation to your server simply by configuring an ```#url``` in addition to optional ```#headers``` and ```#params```. This is the preferred way to send the Geolocation to your server, rather than doing it yourself with Ajax in your javascript.
##### In-Plugin SQLite Storage ##### In-Plugin SQLite Storage
...@@ -338,18 +350,6 @@ Upload contains PUT data: ...@@ -338,18 +350,6 @@ Upload contains PUT data:
{"auth_token":"maybe_your_server_authenticates_via_token_YES?","location":{"latitude":45.5192875,"longitude":-73.6169281,"accuracy":25.42799949645996,"speed":0,"bearing":0,"altitude":0,"timestamp":1429198882716},"android_id":"39dbac67e2c9d80"} {"auth_token":"maybe_your_server_authenticates_via_token_YES?","location":{"latitude":45.5192875,"longitude":-73.6169281,"accuracy":25.42799949645996,"speed":0,"bearing":0,"altitude":0,"timestamp":1429198882716},"android_id":"39dbac67e2c9d80"}
``` ```
#####`@param {String} url`
By configuring an ```#url```, the plugin will always attempt to HTTP POST the location to your server.
#####`@param {Object} params`
Optional HTTP params sent along in HTTP request to above ```#url```.
#####`@param {Object} headers`
Optional HTTP params sent along in HTTP request to above ```#url```.
### Android Config ### Android Config
#####`@param {Integer millis} locationUpdateInterval` #####`@param {Integer millis} locationUpdateInterval`
......
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