MDN self-hosted library · e01.org

onStateChanged

Fires when the captive portal state changes.

Fires when the captive portal state changes.

Syntax

browser.captivePortal.onStateChanged.addListener(listener)
browser.captivePortal.onStateChanged.removeListener(listener)
browser.captivePortal.onStateChanged.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. Returns true if it is listening, false otherwise.

addListener syntax

Parameters

  • listener
  • : The function called when this event occurs. The function is passed this argument:
    • details
    • : string The captive portal state, being one of unknown, not_captive, unlocked_portal, or locked_portal.

Examples

Handle a change in captive portal status:

function handlePortalStatus(portalStatusInfo) {
  console.log(`The portal status is now: ${portalStatusInfo.details}`);
}

browser.captivePortal.onStateChanged.addListener(handlePortalStatus);

Browser compatibility