stopLocationTracking
Terminates the position determination with the specified keys.
Field Configurations
Key | Type | Description | Default Value |
---|---|---|---|
"params" (required) | Object | undefined | null |
Parameters
Key | Type | Description | Default Value |
---|---|---|---|
"addressFormDataKey" | String | The key under which the address is stored. | null |
"async" | Boolean | Specifies whether the action should perform asynchronously. | null |
"background" | Boolean,String | Specifies wether tracking was performed in the background. | null |
"latitudeFormDataKey" | String | The key under which the latitude is stored. | null |
"longitudeFormDataKey" | String | The key under which the longitude is stored. | null |
Inherited
From Base Action
Base Action
Field Configurations
Key | Type | Description | Default Value |
---|---|---|---|
"dynamicParams" | Object | Dynamic params to retrieve data from a specific context e.g. a userSetting. | null |
"leadingDelimiter" | String | The leading mustache delimiter to use. | null |
"params" | Object,Array | Object containing the properties of the action. | null |
"trailingDelimiter" | String | The trailing mustache delimiter to use. | null |
"type" | String | Type 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.