Adobe DPS - Library and Store SDK 2.27

Class adobeDPS-PositionOptions

This class represents the options passed to the geolocation API
This is compatible with the WebKit PositionOptions interface

Constructor

adobeDPS-PositionOptions()
[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
Class Detail
adobeDPS-PositionOptions()
[inner] Create a geolocation PositionOptions object.
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.
maximumAge : Number
The maximum time (milliseconds) allowed to retrieve a cached position whose age is not greater than the time specified
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
©2012-2013 Adobe Systems, inc
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Jun 24 2013 16:54:20 GMT-0700 (PDT)