windows.getAll()
Gets information about all open windows, passing them into a callback.
This is an asynchronous function that returns a Promise.
Syntax
let gettingAll = browser.windows.getAll(
getInfo // optional object
)
Parameters
getInfoOptional-
object. This controls whatwindows.Windowobjects are retrieved.populateOptional-
boolean. Defaults tofalse. If set totrue, eachwindows.Windowobject will have atabsproperty that contains a list oftabs.Tabobjects representing the tabs in that window. TheTabobjects will contain theurl,titleandfavIconUrlproperties only if the extension's manifest file includes the"tabs"permission or host permissions that match the tab's URL. windowTypesOptional-
An
arrayofwindows.WindowTypeobjects. If set, thewindows.Windowobjects 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.
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 (const windowInfo of windowInfoArray) {
console.log(`Window: ${windowInfo.id}`);
console.log(windowInfo.tabs.map((tab) => tab.url));
}
}
function onError(error) {
console.error(`Error: ${error}`);
}
browser.browserAction.onClicked.addListener((tab) => {
browser.windows
.getAll({
populate: true,
windowTypes: ["normal"],
})
.then(logTabsForWindows, onError);
});
Example extensions
Browser compatibility
Loading…
Note:
This API is based on Chromium's chrome.windows API. This documentation is derived from windows.json in the Chromium code.