summaryrefslogtreecommitdiffstats
path: root/toolkit/components/extensions/schemas/captive_portal.json
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 17:32:43 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 17:32:43 +0000
commit6bf0a5cb5034a7e684dcc3500e841785237ce2dd (patch)
treea68f146d7fa01f0134297619fbe7e33db084e0aa /toolkit/components/extensions/schemas/captive_portal.json
parentInitial commit. (diff)
downloadthunderbird-6bf0a5cb5034a7e684dcc3500e841785237ce2dd.tar.xz
thunderbird-6bf0a5cb5034a7e684dcc3500e841785237ce2dd.zip
Adding upstream version 1:115.7.0.upstream/1%115.7.0upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'toolkit/components/extensions/schemas/captive_portal.json')
-rw-r--r--toolkit/components/extensions/schemas/captive_portal.json80
1 files changed, 80 insertions, 0 deletions
diff --git a/toolkit/components/extensions/schemas/captive_portal.json b/toolkit/components/extensions/schemas/captive_portal.json
new file mode 100644
index 0000000000..fd697c66ae
--- /dev/null
+++ b/toolkit/components/extensions/schemas/captive_portal.json
@@ -0,0 +1,80 @@
+[
+ {
+ "namespace": "manifest",
+ "types": [
+ {
+ "$extend": "PermissionNoPrompt",
+ "choices": [
+ {
+ "type": "string",
+ "enum": ["captivePortal"]
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "namespace": "captivePortal",
+ "description": "This API provides the ability detect the captive portal state of the users connection.",
+ "permissions": ["captivePortal"],
+ "properties": {
+ "canonicalURL": {
+ "$ref": "types.Setting",
+ "description": "Return the canonical captive-portal detection URL. Read-only."
+ }
+ },
+ "functions": [
+ {
+ "name": "getState",
+ "type": "function",
+ "description": "Returns the current portal state, one of `unknown`, `not_captive`, `unlocked_portal`, `locked_portal`.",
+ "async": true,
+ "parameters": []
+ },
+ {
+ "name": "getLastChecked",
+ "type": "function",
+ "description": "Returns the time difference between NOW and the last time a request was completed in milliseconds.",
+ "async": true,
+ "parameters": []
+ }
+ ],
+ "events": [
+ {
+ "name": "onStateChanged",
+ "type": "function",
+ "description": "Fired when the captive portal state changes.",
+ "parameters": [
+ {
+ "type": "object",
+ "name": "details",
+ "properties": {
+ "state": {
+ "type": "string",
+ "enum": [
+ "unknown",
+ "not_captive",
+ "unlocked_portal",
+ "locked_portal"
+ ],
+ "description": "The current captive portal state."
+ }
+ }
+ }
+ ]
+ },
+ {
+ "name": "onConnectivityAvailable",
+ "type": "function",
+ "description": "This notification will be emitted when the captive portal service has determined that we can connect to the internet. The service will pass either `captive` if there is an unlocked captive portal present, or `clear` if no captive portal was detected.",
+ "parameters": [
+ {
+ "name": "status",
+ "enum": ["captive", "clear"],
+ "type": "string"
+ }
+ ]
+ }
+ ]
+ }
+]