summaryrefslogtreecommitdiffstats
path: root/dom/chrome-webidl/PlacesObservers.webidl
blob: 77c917a3c5217aabfb1e93925c2c2692a2147452 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/.
 */

callback PlacesEventCallback = undefined (sequence<PlacesEvent> events);

[ChromeOnly, Exposed=Window]
interface PlacesWeakCallbackWrapper {
  constructor(PlacesEventCallback callback);
};

// Counters for number of events sent in the current session.
[ChromeOnly, Exposed=Window]
interface PlacesEventCounts {
  readonly maplike<DOMString, unsigned long long>;
};

// Global singleton which should handle all events for places.
[ChromeOnly, Exposed=Window]
namespace PlacesObservers {
  [Throws]
  undefined addListener(sequence<PlacesEventType> eventTypes,
                        PlacesEventCallback listener);
  [Throws]
  undefined addListener(sequence<PlacesEventType> eventTypes,
                        PlacesWeakCallbackWrapper listener);
  [Throws]
  undefined removeListener(sequence<PlacesEventType> eventTypes,
                           PlacesEventCallback listener);
  [Throws]
  undefined removeListener(sequence<PlacesEventType> eventTypes,
                           PlacesWeakCallbackWrapper listener);
  [Throws]
  undefined notifyListeners(sequence<PlacesEvent> events);

  readonly attribute PlacesEventCounts counts;
};