Skip to main content

stopLocationTracking

Terminates the position determination with the specified keys.

Field Configurations

KeyTypeDescriptionDefault Value
"params" (required)Objectundefinednull

Parameters

KeyTypeDescriptionDefault Value
"addressFormDataKey"StringThe key under which the address is stored.null
"async"BooleanSpecifies whether the action should perform asynchronously.null
"background"Boolean,StringSpecifies wether tracking was performed in the background.null
"latitudeFormDataKey"StringThe key under which the latitude is stored.null
"longitudeFormDataKey"StringThe key under which the longitude is stored.null

Inherited

From Base Action

Base Action

Field Configurations

KeyTypeDescriptionDefault Value
"dynamicParams"ObjectDynamic params to retrieve data from a specific context e.g. a userSetting.null
"leadingDelimiter"StringThe leading mustache delimiter to use.null
"params"Object,ArrayObject containing the properties of the action.null
"trailingDelimiter"StringThe trailing mustache delimiter to use.null
"type"StringType name of the action.null

Examples

Example: Stop location tracking

Stop the location tracking with the according keys.

{
"type": "stopLocationTracking",
"params": {
"addressFormDataKey": "add",
"latitudeFormDataKey": "lat",
"longitudeFormDataKey": "lon",
"background": false
}
}

The actions to be executed are specified in the actions parameter, in this case a stopLocationTracking action.

Result:

A stopLocation action has been created.