github/awesome-cordova-plugins
github/awesome-cordova-plugins
3
0
Fork 1
mirror of https://github.com/danielsogl/awesome-cordova-plugins.git synced 2025-04-24 03:40:17 +08:00
Code Issues Projects Releases Wiki Activity

docs(background-geolocation): fix param docs

Browse Source
This commit is contained in:
Ibby 2017-03-04 08:15:21 -05:00
parent 8f1e729f0e
commit b8c8a1aa8d
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/plugins/background-geolocation.ts
View File

@ -362,9 +362,7 @@ export class BackgroundGeolocation {
/** /**
* Configure the plugin. * Configure the plugin.
* *
* @param {Function} callback callback will be called when background location is determined. * @param options {BackgroundGeolocationConfig} options An object of type Config
* @param {Function} errorCallback callback to be executed every time a geolocation error occurs.
* @param {Config} options An object of type Config
* @return {Promise<any>} * @return {Promise<any>}
*/ */
@Cordova({ @Cordova({
@ -398,6 +396,7 @@ export class BackgroundGeolocation {
/** /**
* Force the plugin to enter "moving" or "stationary" state * Force the plugin to enter "moving" or "stationary" state
* @param isMoving {boolean}
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova({ @Cordova({
@ -407,6 +406,7 @@ export class BackgroundGeolocation {
/** /**
* Setup configuration * Setup configuration
* @param options {BackgroundGeolocationConfig}
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova({ @Cordova({
@ -497,6 +497,7 @@ export class BackgroundGeolocation {
/** /**
* Delete stored location by given locationId. * Delete stored location by given locationId.
* @param locationId {number}
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova({ @Cordova({
@ -523,7 +524,7 @@ export class BackgroundGeolocation {
* BackgroundGeolocation.Mode.FOREGROUND * BackgroundGeolocation.Mode.FOREGROUND
* BackgroundGeolocation.Mode.BACKGROUND
 * BackgroundGeolocation.Mode.BACKGROUND

** **
* @param {number} See above.
 * @param modeId {number}
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova({ @Cordova({
@ -535,7 +536,7 @@ export class BackgroundGeolocation {
* Return all logged events. Useful for plugin debugging. Parameter limit limits number of returned entries.
 * Return all logged events. Useful for plugin debugging. Parameter limit limits number of returned entries.

* @see https://github.com/mauron85/cordova-plugin-background-geolocation/tree/v2.2.1#debugging for more information.
 * @see https://github.com/mauron85/cordova-plugin-background-geolocation/tree/v2.2.1#debugging for more information.

* *
* @param {number} Limits the number of entries
 * @param limit {number} Limits the number of entries

* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()