summaryrefslogtreecommitdiffstats
path: root/dom/webidl/MozNetworkStats.webidl
diff options
context:
space:
mode:
authorMatt A. Tobin <mattatobin@localhost.localdomain>2018-02-02 04:16:08 -0500
committerMatt A. Tobin <mattatobin@localhost.localdomain>2018-02-02 04:16:08 -0500
commit5f8de423f190bbb79a62f804151bc24824fa32d8 (patch)
tree10027f336435511475e392454359edea8e25895d /dom/webidl/MozNetworkStats.webidl
parent49ee0794b5d912db1f95dce6eb52d781dc210db5 (diff)
downloadUXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.gz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.lz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.xz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.zip
Add m-esr52 at 52.6.0
Diffstat (limited to 'dom/webidl/MozNetworkStats.webidl')
-rw-r--r--dom/webidl/MozNetworkStats.webidl73
1 files changed, 73 insertions, 0 deletions
diff --git a/dom/webidl/MozNetworkStats.webidl b/dom/webidl/MozNetworkStats.webidl
new file mode 100644
index 000000000..dc8635b87
--- /dev/null
+++ b/dom/webidl/MozNetworkStats.webidl
@@ -0,0 +1,73 @@
+/* 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/. */
+
+/**
+ * Provide the detailed options for specifying different kinds of data filtering
+ * in getSamples function.
+ */
+dictionary NetworkStatsGetOptions
+{
+ /**
+ * App manifest URL is used to filter network stats by app, while service type
+ * is used to filter stats by system service.
+ * Note that, these two options cannot be specified at the same time for now;
+ * others, an NS_ERROR_NOT_IMPLMENTED exception will be thrown.
+ */
+ DOMString? appManifestURL = null;
+ DOMString serviceType = "";
+ /**
+ * If it is set as true, only the browsing traffic, which is generated from
+ * the mozbrowser iframe element within an app, is returned in result.
+ * If it is set as false or not set, the total traffic, which is generated
+ * from both the mozapp and mozbrowser iframe elements, is returned.
+ */
+ boolean browsingTrafficOnly = false;
+};
+
+dictionary NetworkStatsAlarmOptions
+{
+ Date startTime;
+ Date data;
+};
+
+[JSImplementation="@mozilla.org/networkstats;1",
+ ChromeOnly,
+ Pref="dom.mozNetworkStats.enabled"]
+interface MozNetworkStats {
+ /**
+ * App manifest URL of an application for specifying the per-app stats of the
+ * specified app.
+ */
+ readonly attribute DOMString appManifestURL;
+
+ /**
+ * True if this stats is the browsing traffic of an app (the traffic generated
+ * by a mozbrowser iframe element).
+ * Otherwise this stats represents the total traffic of an app.
+ */
+ readonly attribute boolean browsingTrafficOnly;
+
+ /**
+ * Service type is used to retrieve the corresponding "system-only" stats.
+ * E.g., "Tethering", "OTA", etc.
+ */
+ readonly attribute DOMString serviceType;
+
+ /**
+ * Network the returned data belongs to.
+ */
+ readonly attribute MozNetworkStatsInterface network;
+
+ /**
+ * Stats for a network.
+ */
+ [Cached, Pure]
+ readonly attribute sequence<MozNetworkStatsData> data;
+
+ /**
+ * Dates
+ */
+ readonly attribute object start;
+ readonly attribute object end;
+};