Home Original page

sessions.forgetClosedTab() - Mozilla | MDN

Syntax

js

let forgettingTab = browser.sessions.forgetClosedTab(
  windowId,            // integer
  sessionId            // string
)

Parameters

windowId

Integer. The ID of the window that hosted the tab you want to forget.

sessionId

String. The ID of the session you want to forget.

Return value

A Promise. This will be fulfilled with no arguments when the session has been removed.

If an error occurs, the promise will be rejected with an error message.

Examples

This code forgets the single most recently-closed session, whether it's a tab or a window:

js

function forgetMostRecent(sessionInfos) {
  if (!sessionInfos.length) {
    console.log("No sessions found");
    return;
  }
  let sessionInfo = sessionInfos[0];
  if (sessionInfo.tab) {
    browser.sessions.forgetClosedTab(
      sessionInfo.tab.windowId,
      sessionInfo.tab.sessionId,
    );
  } else {
    browser.sessions.forgetClosedWindow(sessionInfo.window.sessionId);
  }
}

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

browser.sessions
  .getRecentlyClosed({ maxResults: 1 })
  .then(forgetMostRecent, onError);

Browser compatibility

Help improve MDN

Learn how to contribute

This page was last modified on by MDN contributors.