Removes a value previously stored by a call to sessions.setWindowValue
.
This is an asynchronous function that returns a Promise
.
var removing = browser.sessions.removeWindowValue( windowId, // integer key // string )
windowId
integer
. ID of the window whose data you are trying to remove. Error is thrown if ID is invalid.key
string
. Key identifying the particular value to remove. This needs to match the key previously given in sessions.setWindowValue
.A Promise
that will be resolved no arguments if the item was successfully removed. If the call failed (for example, because the window ID could not be found) then the promise will be rejected with an error message.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
removeWindowValue |
No |
No |
57 |
? |
No |
No |
? |
? |
No |
? |
? |
? |
This code adds two context menu items: one stores a value associated with the current window, the other one removes it:
async function setOnActiveWindow() { let currentWindow = await browser.windows.getLastFocused(); await browser.sessions.setWindowValue(currentWindow.id, "my-key", "my-value"); } async function removeFromActiveWindow() { let currentWindow = await browser.windows.getLastFocused(); await browser.sessions.removeWindowValue(currentWindow.id, "my-key"); } browser.menus.create({ id: "add-my-item", title: "add item", contexts: ["all"] }); browser.menus.create({ id: "remove-my-item", title: "remove item", contexts: ["all"] }); browser.menus.onClicked.addListener((info) => { if (info.menuItemId === "add-my-item") { setOnActiveWindow(); } else { removeFromActiveWindow(); } });
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/sessions/removeWindowValue