elemental.dom

Interface Geolocation

All Known Implementing Classes:

JsGeolocation

public interface Geolocation

Method Summary

Methods

Modifier and Type	Method and Description
void	clearWatch(int watchId) When the clearWatch() method is called, the watch() process stops calling for new position identifiers and cease invoking callbacks.
void	getCurrentPosition(PositionCallback successCallback) Acquires the user's current position via a new position object.
void	getCurrentPosition(PositionCallback successCallback, PositionErrorCallback errorCallback) Acquires the user's current position via a new position object.
int	watchPosition(PositionCallback successCallback) Similar to getCurrentPosition(), except it continues to call the callback with updated position information periodically until clearWatch() is called.
int	watchPosition(PositionCallback successCallback, PositionErrorCallback errorCallback) Similar to getCurrentPosition(), except it continues to call the callback with updated position information periodically until clearWatch() is called.

Method Detail

clearWatch

void clearWatch(int watchId)

When the clearWatch() method is called, the watch() process stops calling for new position identifiers and cease invoking callbacks.

getCurrentPosition

void getCurrentPosition(PositionCallback successCallback)

Acquires the user's current position via a new position object. If this fails, errorCallback is invoked with an nsIDOMGeoPositionError argument.

Parameters

successCallback

An nsIDOMGeoPositionCallback to be called when the current position is available.

errorCallback

An nsIDOMGeoPositionErrorCallback that is called if an error occurs while retrieving the position; this parameter is optional.

options

An nsIDOMGeoPositionOptions object specifying options; this parameter is optional.

getCurrentPosition

void getCurrentPosition(PositionCallback successCallback,
                      PositionErrorCallback errorCallback)

Acquires the user's current position via a new position object. If this fails, errorCallback is invoked with an nsIDOMGeoPositionError argument.

Parameters

successCallback

An nsIDOMGeoPositionCallback to be called when the current position is available.

errorCallback

An nsIDOMGeoPositionErrorCallback that is called if an error occurs while retrieving the position; this parameter is optional.

options

An nsIDOMGeoPositionOptions object specifying options; this parameter is optional.

watchPosition

int watchPosition(PositionCallback successCallback)

Similar to getCurrentPosition(), except it continues to call the callback with updated position information periodically until clearWatch() is called.

Parameters

successCallback

An nsIDOMGeoPositionCallback that is to be called whenever new position information is available.

errorCallback

An nsIDOMGeoPositionErrorCallback to call when an error occurs; this is an optional parameter.

options

An nsIDOMGeoPositionOptions object specifying options; this parameter is optional.

Return value

An ID number that can be used to reference the watcher in the future when calling clearWatch().

watchPosition

int watchPosition(PositionCallback successCallback,
                PositionErrorCallback errorCallback)

Similar to getCurrentPosition(), except it continues to call the callback with updated position information periodically until clearWatch() is called.

Parameters

successCallback

An nsIDOMGeoPositionCallback that is to be called whenever new position information is available.

errorCallback

An nsIDOMGeoPositionErrorCallback to call when an error occurs; this is an optional parameter.

options

An nsIDOMGeoPositionOptions object specifying options; this parameter is optional.

Return value

An ID number that can be used to reference the watcher in the future when calling clearWatch().