Skip to main content
Version: 4.62

stopLocationTracking

Terminates the continuous location tracking with the specified key.

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 1: Stop tracking the device's location

Show ExampleHide Example

Stop the location tracking that uses the corresponding form data keys.

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