Class nokia.maps.positioning.Manager
Class Summary
This class provides a function set based on the specification of the W3C geolocation API. The API reference can be found here.
Extends
nokia.maps.util.OObject.
Method Summary
addObserver
(key, callback, [context])
: nokia.maps.util.OObject
This method registers an observer for the property named by the caller.
clearWatch
(watchId)
Clears and stops the specified position watch.
get
(key)
: Variant
This method retrieves the value of the property with the name provided by the caller.
getCurrentPosition
(successCallback, errorCallback, options)
Get current position, if available.
remove
(key)
: nokia.maps.util.OObject
This method removes the property with the name provided by the caller.
removeObserver
(key, callback, context)
: nokia.maps.util.OObject
This method removes the observer for the property named by the caller.
set
(nameOrObject, [value, [force]])
: nokia.maps.util.OObject
This method sets property values, using the property names and values supplied by the caller.
watchPosition
(successCallback, errorCallback, options)
: Number
Starts periodically watching the positioning sensor and fires events containing the data, if there are changes ocurring
Direct Inheritance
Constructor Detail
Method Detail
clearWatch
(watchId)
Clears and stops the specified position watch.
Parameters:
| {Number} | watchId | represents the watcher ID returned from nokia.maps.positioning.Manager#watchPosition. |
getCurrentPosition
(successCallback, errorCallback, options)
Get current position, if available. Fires an event containing the data.
Parameters:
| {Function} | successCallback | represents a function to call when the position data is available. |
| {Function} | errorCallback | represents a function to call when there is an error getting the position data. |
| {Object} | options | contains an anonymous object containing options for getting the position data. |
watchPosition
(successCallback, errorCallback, options)
: Number
Starts periodically watching the positioning sensor and fires events
containing the data, if there are changes ocurring
Parameters:
| {Function} | successCallback | represents a function to call when the position data is available. |
| {Function} | errorCallback | represents a function to call when there is an error getting the position data. |
| {Object} | options | contains an anonymous object containing options for getting the position data. |
Returns:
| {Number} | the watcher ID |