dom/webidl/Geolocation.webidl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   4  * You can obtain one at http://mozilla.org/MPL/2.0/.
   5  *
   6  * The origin of this IDL file is
   7  * http://www.w3.org/TR/geolocation-API
   8  *
   9  * Copyright © 2012 W3C® (MIT, ERCIM, Keio), All Rights Reserved. W3C
  10  * liability, trademark and document use rules apply.
  11  */
  12
  13 dictionary PositionOptions {
  14   boolean enableHighAccuracy = false;
  15   [Clamp] unsigned long timeout = 0x7fffffff;
  16   [Clamp] unsigned long maximumAge = 0;
  17 };
  18
  19 [Exposed=Window]
  20 interface Geolocation {
  21   [Throws, NeedsCallerType]
  22   void getCurrentPosition(PositionCallback successCallback,
  23                           optional PositionErrorCallback? errorCallback = null,
  24                           optional PositionOptions options = {});
  25
  26   [Throws, NeedsCallerType]
  27   long watchPosition(PositionCallback successCallback,
  28                      optional PositionErrorCallback? errorCallback = null,
  29                      optional PositionOptions options = {});
  30
  31   void clearWatch(long watchId);
  32 };
  33
  34 callback PositionCallback = void (GeolocationPosition position);
  35
  36 callback PositionErrorCallback = void (GeolocationPositionError positionError);