dom/webidl/Reporting.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  * https://w3c.github.io/reporting/#interface-reporting-observer
   8  */
   9
  10 [Pref="dom.reporting.enabled",
  11  Exposed=Window]
  12 interface ReportBody {
  13 };
  14
  15 [Pref="dom.reporting.enabled",
  16  Exposed=Window]
  17 interface Report {
  18   readonly attribute DOMString type;
  19   readonly attribute DOMString url;
  20   readonly attribute ReportBody? body;
  21 };
  22
  23 [Pref="dom.reporting.enabled",
  24  Exposed=Window]
  25 interface ReportingObserver {
  26   [Throws]
  27   constructor(ReportingObserverCallback callback,
  28               optional ReportingObserverOptions options = {});
  29
  30   void observe();
  31   void disconnect();
  32   ReportList takeRecords();
  33 };
  34
  35 callback ReportingObserverCallback = void (sequence<Report> reports, ReportingObserver observer);
  36
  37 dictionary ReportingObserverOptions {
  38   sequence<DOMString> types;
  39   boolean buffered = false;
  40 };
  41
  42 typedef sequence<Report> ReportList;
  43
  44 [Pref="dom.reporting.enabled",
  45  Exposed=Window]
  46 interface DeprecationReportBody : ReportBody {
  47   readonly attribute DOMString id;
  48   // The spec currently has Date, but that's not a type that exists in Web IDL.
  49   // In any case, we always return null, so we just need _some_ nullable type
  50   // here.
  51   readonly attribute DOMTimeStamp? anticipatedRemoval;
  52   readonly attribute DOMString message;
  53   readonly attribute DOMString? sourceFile;
  54   readonly attribute unsigned long? lineNumber;
  55   readonly attribute unsigned long? columnNumber;
  56 };
  57
  58 [Deprecated="DeprecatedTestingInterface",
  59  Pref="dom.reporting.testing.enabled",
  60  Exposed=(Window,DedicatedWorker)]
  61 interface TestingDeprecatedInterface {
  62   constructor();
  63
  64   [Deprecated="DeprecatedTestingMethod"]
  65   void deprecatedMethod();
  66
  67   [Deprecated="DeprecatedTestingAttribute"]
  68   readonly attribute boolean deprecatedAttribute;
  69 };
  70
  71 // Used internally to process the JSON
  72 [GenerateInit]
  73 dictionary ReportingHeaderValue {
  74   sequence<ReportingItem> items;
  75 };
  76
  77 // Used internally to process the JSON
  78 dictionary ReportingItem {
  79   // This is a long.
  80   any max_age;
  81   // This is a sequence of ReportingEndpoint.
  82   any endpoints;
  83   // This is a string. If missing, the value is 'default'.
  84   any group;
  85   boolean include_subdomains = false;
  86 };
  87
  88 // Used internally to process the JSON
  89 [GenerateInit]
  90 dictionary ReportingEndpoint {
  91   // This is a string.
  92   any url;
  93   // This is an unsigned long.
  94   any priority;
  95   // This is an unsigned long.
  96   any weight;
  97 };