Add contextualIdentities.move

[rebloor]

Description

Documentation and release note in support of Bug 1333395 Consider support for containers sort order.

[github-actions]

Preview URLs

• /en-US/docs/Mozilla/Add-ons/WebExtensions/API/contextualIdentities/move
• /en-US/docs/Mozilla/Add-ons/WebExtensions/API/contextualIdentities
• /en-US/docs/Mozilla/Firefox/Releases/123

Flaws (1)

Note! 2 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Mozilla/Add-ons/WebExtensions/API/contextualIdentities/move
Title: contextualIdentities.move()
Flaw count: 1

• bad_bcd_queries:
  • No BCD data for query: webextensions.api.contextualIdentities.move

External URLs (1)

URL: /en-US/docs/Mozilla/Firefox/Releases/123
Title: Firefox 123 for developers

• https://bugzil.la/1333395 (1 time) (Note! This may be a new URL 👀)

(comment last updated: 2024-01-05 16:56:57)

[Rob--W]

I guess that these were based on the testcase. In there, id0, id1, etc are variable names referring to the actual IDs. The examples below are unclear and not working.

I would simplify this section by showing how one can query identities, then choose the identity to move. For example, the scenario of moving the last identity to the start, and then back to the end. And another one where multiple identities are moved.

let identities = await browser.contextualIdentities.query({});
let firstId = identities[0].cookieStoreId;

// Moves first identity to the end.
await browser.contextualIdentities.move(firstId, -1);

// Move identity to the start again.
await browser.contextualIdentities.move(firstId, 0);

Alternative way of moving the first identity to the end: by moving all other identities to the start we get the same effect:

let identities = await browser.contextualIdentities.query({});
let ids = identities.map(identity => identity.cookieStoreId);
// Create array without the first item:
let otherIds = ids.slice(1);

// Moves other identities to the start,
// effectively putting the first identity to the end.
await browser.contextualIdentities.move(otherIds, 0);

Another example, move "Personal" identity before "Work". Important note: this example assumes containers with these names to exist. This is often not the case in customized or localized (non-English) Firefox instances.

let identities = await browser.contextualIdentities.query({});

// Find cookieStoreId of container with name "Personal".
let personalId = identities.find(ci => ci.name === "Personal")?.cookieStoreId;
if (!personalId) {
  throw new Error("Personal container not found");
}

// Find index of container with name "Work".
let workIndex = identities.findIndex(identity => identity.name === "Work");
if (workIndex === -1) {
  throw new Error("Work container not found!");
}
await browser.contextualIdentities.move(personalId, workIndex);

[rebloor]

Thanks for the suggestions @Rob--W

[Rob--W]

Please apply the suggested edits before merging.