Class adobeDPS-PositionOptions
- Platforms:
- iOS
This class represents the options passed to the geolocation API
This is compatible with the WebKit PositionOptions interface
Constructor
[inner]
Create a geolocation PositionOptions object.
Fields
| Field | Defined By | |
|---|---|---|
|
enableHighAccuracy
: boolean
A boolean indicating that best possible results are required.
|
PositionOptions
|
|
|
maximumAge
: Number
The maximum time (milliseconds) allowed to retrieve a cached position whose age is not greater than the time specified
|
PositionOptions
|
|
|
timeout
: Number
The time (milliseconds) allowed to pass from the call to getCurrentPosition() or watchPosition() until the corresponding successCallback is invoked.
|
PositionOptions
|
Field Details
enableHighAccuracy
: boolean
A boolean indicating that best possible results are required.
A value of true may result in slower response times or increased power consumption.
- Platforms:
- iOS
maximumAge
: Number
The maximum time (milliseconds) allowed to retrieve a cached position whose age is not greater than the time specified
- Platforms:
- iOS
timeout
: Number
The time (milliseconds) allowed to pass from the call to getCurrentPosition() or watchPosition() until the corresponding successCallback is invoked.
If the implementation is unable to successfully acquire a new Position before the given timeout elapses, and no other errors have occurred in this interval, then the corresponding errorCallback must be invoked with a adobeDPS-PositionError object whose code attribute is set to TIMEOUT
- Platforms:
- iOS
©2012-2013 Adobe Systems, inc
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Aug 31 2015 09:23:40 GMT-0700 (PDT)
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Aug 31 2015 09:23:40 GMT-0700 (PDT)