W3cubDocs

/Web Extensions

windows.getAll()

Gets information about all open windows, passing them into a callback.

This is an asynchronous function that returns a Promise.

Syntax

var gettingAll = browser.windows.getAll(
  getInfo                // optional object
)

Parameters

getInfoOptional
object. This controls what windows.Window objects are retrieved.
populateOptional
boolean. Defaults to false. If set to true, each windows.Window object will have a tabs property that contains a list of tabs.Tab objects representing the tabs in that window. The Tab objects will contain the url, title and favIconUrl properties only if the extension's manifest file includes the "tabs" permission or host permissions that match the tab's URL.
windowTypesOptional
An array of windows.WindowType objects. If set, the windows.Window objects returned will be filtered based on their type. If unset the default filter is set to ['normal', 'panel', 'popup'], with 'panel' window types limited to the extension's own windows.

Return value

A Promise that will be fulfilled with an array of windows.Window objects, representing all windows that match the given criteria. If any error occurs, the promise will be rejected with an error message.

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
getAll
Yes
14
45
?
Yes
14
?
?
No
?
?
?
populate
Yes
79
45
?
Yes
14
?
?
No
?
?
?
windowTypes
46
14
58
?
33
14
?
?
No
?
?
?

Examples

Log the URLs for the tabs across all "normal" browser windows. Note that you'll need the "tabs" permission or matching host permissions to access tab URLs.

function logTabsForWindows(windowInfoArray) {
  for (windowInfo of windowInfoArray) {
    console.log(`Window: ${windowInfo.id}`);
    console.log(windowInfo.tabs.map(tab => tab.url));
  }
}

function onError(error) {
  console.log(`Error: ${error}`);
}

browser.browserAction.onClicked.addListener((tab) => {
  var getting = browser.windows.getAll({
    populate: true,
    windowTypes: ["normal"]
  });
  getting.then(logTabsForWindows, onError);
});

Example extensions

Note: This API is based on Chromium's chrome.windows API. This documentation is derived from windows.json in the Chromium code.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

© 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/windows/getAll