StopUserLocationTrackingRequest RPC
Stop tracking user's location.
Description
The request is used to deactivate StartUserLocationRequest.
Parameters
(* means the parameter is required)
| Name | Type | Description | Default value |
|---|---|---|---|
| options | Object | Parameters for options-object are listed in the next table |
Parameters for options-object:
| Name | Type | Description | Default value |
|---|---|---|---|
| clearMap | Boolean | If true, removes user location or path from the map. Does nothing if StartUserLocationRequest didn't have option addToMap. | true |
| removePath | Boolean | If true, removes user location coordinates. | false |
Examples
Stop tracking user's location and clear location from map:
var sb = Oskari.getSandbox();
sb.postRequestByName('StopUserLocationTrackingRequest');Related api
- StartUserLocationTrackinRequest
- UserLocationEvent
- RemoveFeaturesFromMapRequest