contextualIdentities.remove()

Removes a contextual identity, given its cookie store ID.

This is an asynchronous function that returns a Promise.

Syntax

js
let 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 or the contextual identities feature is not enabled, the promise is rejected.

Examples

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

js
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);

Browser compatibility

desktop mobile
Chrome
Edge
Firefox
Opera
Safari
Firefox for Android
Safari on iOS
remove
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.
footnote Before version 57, this method resolves its promise with null if the given identity is not found.
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.