windows.get()
Gets details about a window, given its ID. The details are passed into a callback.
This is an asynchronous function that returns a Promise
.
Syntax
let getting = browser.windows.get(
windowId, // integer
getInfo // optional object
)
Parameters
windowId
-
integer
. The ID of the window object you want returned. getInfo
Optional-
object
. Contains options to filter the type of window.populate
Optional-
boolean
. Iftrue
, thewindows.Window
object will have atabs
property that contains a list oftabs.Tab
objects representing the tabs open in the window. TheTab
objects only contain theurl
,title
andfavIconUrl
properties if the extension's manifest file includes the"tabs"
permission or a matching host permission. windowTypes
Optional-
array
ofwindows.WindowType
objects. If set, thewindows.Window
returned will be filtered based on its type. If unset the default filter is set to['normal', 'panel', 'popup']
, with'panel'
window types limited to the extension's own windows.
Note: If supplied, the windowTypes
component of getInfo
is ignored. The use of windowTypes
has been deprecated as of Firefox 62.
Return value
A Promise
that will be fulfilled with a windows.Window
object containing the details of the window. If any error occurs, the promise will be rejected with an error message.
Browser compatibility
BCD tables only load in the browser
Examples
This example gets the current window and logs the URLs of the tabs it contains. Note that you'll need the "tabs" permission or matching host permissions to access tab URLs.
Note: This example is a bit unrealistic: in this situation you would more probably use windows.getCurrent()
.
function logTabs(windowInfo) {
for (tabInfo of windowInfo.tabs) {
console.log(tabInfo.url);
}
}
function onError(error) {
console.log(`Error: ${error}`);
}
browser.browserAction.onClicked.addListener((tab) => {
let getting = browser.windows.get(tab.windowId, {populate: true});
getting.then(logTabs, onError);
});
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.