onConnectivityAvailable
Fires when the captive portal service determines that the user can connect to the internet.
Syntax
js
browser.captivePortal.onConnectivityAvailable.addListener(listener)
browser.captivePortal.onConnectivityAvailable.removeListener(listener)
browser.captivePortal.onConnectivityAvailable.hasListener(listener)
Events have three functions:
addListener(listener)
-
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
listener
-
The function called when this event occurs. The function is passed this argument:
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:
js
function handleConnectivity(connectivityInfo) {
console.log(`The captive portal status: ${connectivityInfo.status}`);
}
browser.captivePortal.onConnectivityAvailable.addListener(handleConnectivity);
Browser compatibility
BCD tables only load in the browser