summaryrefslogtreecommitdiffstats
path: root/toolkit/components/extensions/schemas/network_status.json
diff options
context:
space:
mode:
Diffstat (limited to 'toolkit/components/extensions/schemas/network_status.json')
-rw-r--r--toolkit/components/extensions/schemas/network_status.json66
1 files changed, 66 insertions, 0 deletions
diff --git a/toolkit/components/extensions/schemas/network_status.json b/toolkit/components/extensions/schemas/network_status.json
new file mode 100644
index 0000000000..bf2c9cb494
--- /dev/null
+++ b/toolkit/components/extensions/schemas/network_status.json
@@ -0,0 +1,66 @@
+[
+ {
+ "namespace": "manifest",
+ "types": [
+ {
+ "$extend": "PermissionPrivileged",
+ "choices": [
+ {
+ "type": "string",
+ "enum": ["networkStatus"]
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "namespace": "networkStatus",
+ "description": "This API provides the ability to determine the status of and detect changes in the network connection. This API can only be used in privileged extensions.",
+ "permissions": ["networkStatus"],
+ "types": [
+ {
+ "id": "NetworkLinkInfo",
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "enum": ["unknown", "up", "down"],
+ "description": "Status of the network link, if \"unknown\" then link is usually assumed to be \"up\""
+ },
+ "type": {
+ "type": "string",
+ "enum": ["unknown", "ethernet", "usb", "wifi", "wimax", "mobile"],
+ "description": "If known, the type of network connection that is avialable."
+ },
+ "id": {
+ "type": "string",
+ "optional": true,
+ "description": "If known, the network id or name."
+ }
+ }
+ }
+ ],
+ "functions": [
+ {
+ "name": "getLinkInfo",
+ "type": "function",
+ "description": "Returns the $(ref:NetworkLinkInfo} of the current network connection.",
+ "async": true,
+ "parameters": []
+ }
+ ],
+ "events": [
+ {
+ "name": "onConnectionChanged",
+ "type": "function",
+ "description": "Fired when the network connection state changes.",
+ "parameters": [
+ {
+ "name": "details",
+ "$ref": "NetworkLinkInfo"
+ }
+ ]
+ }
+ ]
+ }
+]