Fires when the captive portal service determines that the user can connect to the internet.
On this page
onConnectivityAvailable
Syntax
browser.captivePortal.onConnectivityAvailable.addListener(callback)
browser.captivePortal.onConnectivityAvailable.removeListener(listener)
browser.captivePortal.onConnectivityAvailable.hasListener(listener)
Events have three functions:
-
addListener(callback)
-
Adds a listener to this event.
-
removeListener(listener)
-
Stop listening to this event. The
listener
argument is the listener to remove. -
hasListener(listener)
-
Check whether
listener
is registered for this event. Returnstrue
if it is listening,false
otherwise.
addListener syntax
Parameters
-
callback
-
Function that is called when this event occurs. The function is passed the following arguments:
-
status
-
string
The status of the service, being one ofcaptive
if there is an unlocked captive portal present orclear
if no captive portal is detected.
-
Examples
Handle a change user's ability to connect to the internet:
function handleConnectivity(connectivityInfo) {
console.log(`The captive portal status: ${connectivityInfo.status}`);
}
browser.captivePortal.onConnectivityAvailable.addListener(handleConnectivity);
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
onConnectivityAvailable |
No | No | 68 | ? | No | No | ? | ? | No | ? | No | ? |
© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/captivePortal/onConnectivityAvailable