Adobe DPS - Library and Store SDK 2.27

Class adobeDPS-GeolocationService

Extends:
adobeDPS-GeolocationService -> adobeDPS-Service -> adobeDPS-Class

Service for accessing geolocation data.
This is compatible with the WebKit Geolocation interface
Accessible from adobeDPS.geolocation

Constructor

adobeDPS-GeolocationService()
[inner] Create an instance of the GeolocationService.

Static Fields

Field Defined By
adobeDPS-GeolocationService.instance
The singleton of the GeolocationService.
GeolocationService

Methods

Method Defined By
getCurrentPosition(successCallback:Function, errorCallback:Function, options:adobeDPS-PositionOptions)
Function used to retrieve the current device location.
GeolocationService
watchPosition(successCallback:Function, errorCallback:Function, options:adobeDPS-PositionOptions)
Function used to monitor the location changes.
GeolocationService
clearWatch(watchId:Number)
Function used to stop monitoring the location changes initiated through watchPosition().
GeolocationService
Inherited from adobeDPS-Class
Gets the string representation of this instance.
Class Detail
adobeDPS-GeolocationService()
[inner] Create an instance of the GeolocationService.
This is an internal constructor and shouldn't be called by regular users.
Static Field Details
adobeDPS-GeolocationService.instance
The singleton of the GeolocationService.
Method Details
getCurrentPosition(successCallback:Function, errorCallback:Function, options:adobeDPS-PositionOptions)
Function used to retrieve the current device location. This is compatible with the WebKit geolocation API.
Parameters
successCallback Function The callback function that handles the location data when operation succeeds.
Callback Signature: successHandler(adobeDPS-Position)
errorCallback Function The callback function that handles the error when operation fails.
Callback Signature: errorHandler(adobeDPS-PositionError)
options adobeDPS-PositionOptions The options considered when retrieving the position.
Throws:
Error If the successCallback is invalid
watchPosition(successCallback:Function, errorCallback:Function, options:adobeDPS-PositionOptions) : Number
Function used to monitor the location changes. This is compatible with the WebKit geolocation API.
Currently this API is not supported. Any attempt to call it will throw an exception.
Parameters
successCallback Function The callback function that handles the location data when operation succeeds.
Callback Signature: successHandler(adobeDPS-Position)
errorCallback Function The callback function that handles the error when operation fails.
Callback Signature: errorHandler(adobeDPS-PositionError)
options adobeDPS-PositionOptions The options considered when retrieving the position.
Throws:
Error If the successCallback is invalid
Returns:
Number A unique ID of the location monitoring operation
clearWatch(watchId:Number)
Function used to stop monitoring the location changes initiated through watchPosition(). This is compatible with the WebKit geolocation API.
Currently this API is not supported. Any attempt to call it will throw an exception.
Parameters
watchId Number The Id of a watchPosition operation to be cancelled.
©2012-2013 Adobe Systems, inc
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Jun 24 2013 16:54:20 GMT-0700 (PDT)