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

var 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.

Browser compatibility

ChromeEdgeFirefoxFirefox for AndroidOpera
Basic supportNoNo5353No

Examples

Retrieve all contextual identities, and log their names:

function onGot(contexts) {
  for (let context of contexts) {
    console.log(`Name: ${context.name}`);
  }
}
function onError(e) {
  console.error(e);
}
browser.contextualIdentities.query({}).then(onGot, onError);

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

function onGot(contexts) {
  for (let context of contexts) {
    console.log(`Name: ${context.name}`);
  }
}
function onError(e) {
  console.error(e);
}
browser.contextualIdentities.query({
  name: "my-thing"
}).then(onGot, onError);

Example extensions

Document Tags and Contributors

 Contributors to this page: wbamberg
 Last updated by: wbamberg,