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

var getting = browser.windows.get(
  windowId,              // integer
  getInfo                // optional object
)

Parameters

windowId
integer. The ID of the window object you want returned.
getInfoOptional
object. Contains options to filter the type of window.
populateOptional
boolean. If true, the windows.Window object will have a tabs property that contains a list of tabs.Tab objects representing the tabs open in the window. The Tab objects only contain the url, title and favIconUrl properties if the extension's manifest file includes the "tabs" permission.
windowTypesOptional
array of windows.WindowType objects. If set, the windows.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

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxOperaFirefox for Android
Basic supportChrome Full support YesEdge Full support 14Firefox Full support 45Opera Full support YesFirefox Android No support No
getInfoChrome Full support 18Edge Full support 14Firefox Full support 45Opera Full support 15Firefox Android No support No
getInfo.windowTypes
DeprecatedNon-standard
Chrome Full support 46Edge Full support 14Firefox No support NoOpera Full support 33Firefox Android No support No

Legend

Full support  
Full support
No support  
No support
Non-standard. Expect poor cross-browser support.
Non-standard. Expect poor cross-browser support.
Deprecated. Not for use in new websites.
Deprecated. Not for use in new websites.

Examples

This example gets the current window and logs the URLs of the tabs it contains. Note that you'll need the "tabs" permission 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) => {
  var getting = browser.windows.get(tab.windowId, {populate: true});
  getting.then(logTabs, onError);
});

Acknowledgements

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.

Document Tags and Contributors

Contributors to this page: Loirooriol, chrisdavidmills, irenesmith, wbamberg, Makyen
Last updated by: Loirooriol,