contextualIdentities.remove()

Removes a contextual identity, given its cookie store ID.

This is an asynchronous function that returns a Promise.

Syntax

var removeContext = browser.contextualIdentities.remove(
  cookieStoreId                  // string
)

Parameters

cookieStoreId

string. The ID of the contextual identity's cookie store. Because contextual identities each have their own cookie store, this serves as an identifier for the contextual identity itself.

Return value

A Promise that will be fulfilled with a ContextualIdentity that describes the identity that was removed. If the identity could not be found, the promise is fulfilled with null.

Browser compatibility

Chrome Edge Firefox Firefox for Android Opera
Basic support No No 53.0 53.0 No

Examples

This example tries to remove the contextual identity whose ID is "firefox-container-1":

function onRemoved(context) {
  if (!context) {
    console.error("Context not found");
  } else {
    console.log(`Removed identity: ${context.cookieStoreId}.`);
  }
}

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

browser.contextualIdentities.remove("firefox-container-1").
  then(onRemoved, onError);

Document Tags and Contributors

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