elemental.dom.Geolocation Maven / Gradle / Ivy
/*
* Copyright 2012 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package elemental.dom;
import elemental.events.*;
import elemental.util.*;
import elemental.dom.*;
import elemental.html.*;
import elemental.css.*;
import elemental.stylesheets.*;
import java.util.Date;
/**
*
*/
public interface Geolocation {
/**
* When the clearWatch() method is called, the watch() process stops calling for new position identifiers and cease invoking callbacks.
*/
void clearWatch(int watchId);
/**
* 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.
*/
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.
*/
void getCurrentPosition(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().
*/
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().
*/
int watchPosition(PositionCallback successCallback, PositionErrorCallback errorCallback);
}