1. Mozilla
  2. Add-ons
  3. Browser extensions
  4. JavaScript APIs
  5. captivePortal
  6. getState

getState

Returns the portal state as one of unknown, not_captive, unlocked_portal, or locked_portal.

Syntax

js
let state = browser.captivePortal.getState()

Return value

A Promise that is fulfilled with a string containing one of unknown, not_captive, unlocked_portal, or locked_portal.

Browser compatibility

Chrome
Edge
Firefox
Opera
Safari
Firefox for Android
Safari on iOS
getState
Chrome – No support
Chrome
footnote No support
Edge – No support
Edge
footnote No support
Firefox – Full support
Firefox 68 (Release date: 2019-07-09)
footnote Full support
Opera – No support
Opera
footnote No support
Safari – No support
Safari
footnote No support
Firefox for Android – No support
Firefox for Android
footnote No support
Safari on iOS – No support
Safari on iOS
footnote No support

Tip: you can click/tap on a cell for more information.

Full support
No support

This page was last modified on by MDN contributors.

Visit Mozilla Corporation’s not-for-profit parent, the Mozilla Foundation.
Portions of this content are ©1998–2026 by individual mozilla.org contributors. Content available under a Creative Commons license.