contextualIdentities.query()

Gets information about all contextual identities, or about those contextual identities that match a given filter argument.

This is an asynchronous function that returns a Promise.

Syntax

js
let getContext = browser.contextualIdentities.query(
  details                  // object
)

Parameters

details

object. An object that can be used to filter the contextual identities returned. This may contain any of the following properties:

name Optional

string. Return only contextual identities with this name.

Return value

A Promise that will be fulfilled with an array of ContextualIdentity objects, each describing a single identity. If the contextual identities feature is not enabled, the promise is rejected.

Examples

Retrieve all contextual identities, and log their names:

js
function onGot(contexts) {
  for (const context of contexts) {
    console.log(`Name: ${context.name}`);
  }
}

function onError(error) {
  console.error(error);
}

browser.contextualIdentities.query({}).then(onGot, onError);

Retrieve all contextual identities whose names are "my-thing", and log their names:

js
function onGot(contexts) {
  for (const context of contexts) {
    console.log(`Name: ${context.name}`);
  }
}

function onError(error) {
  console.error(error);
}

browser.contextualIdentities
  .query({
    name: "my-thing",
  })
  .then(onGot, onError);

Example extensions

Browser compatibility

desktop mobile
Chrome
Edge
Firefox
Opera
Safari
Firefox for Android
Safari on iOS
query
Chrome – No support
Chrome
footnote No support
Edge – No support
Edge
footnote No support
Firefox – Full support
Firefox 53 (Release date: 2017-04-19)
footnote
footnote Before version 57, this method resolves its promise with false if the contextual identities feature is disabled.
Opera – No support
Opera
footnote No support
Safari – No support
Safari
footnote No support
Firefox for Android – No support
Firefox for Android
footnote
footnote Until Firefox for Android 137 contextualIdentities is defined but not functional. From Firefox for Android 138 contextualIdentities is inaccessible.
footnote See bug 1638878
Safari on iOS – No support
Safari on iOS
footnote No support

Legend

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

Full support
Full support
No support
No support
See implementation notes.