Revision 1043502 of windows

<div>{{AddonSidebar}}</div>

<div id="api-summary">
<div>
<p>Interact with browser windows. You can use this API to get information about open windows, to open modify, and close windows. You can also listen for window open, close, and activate events.</p>
</div>
</div>

<h2 id="Types">Types</h2>

<dl>
 <dt>{{WebExtAPIRef("windows.WindowType")}}</dt>
 <dd>The type of browser window this is. Under some circumstances a Window may not be assigned type property, for example when querying closed windows from the {{WebExtAPIRef('sessions')}} API.</dd>
 <dt>{{WebExtAPIRef("windows.WindowState")}}</dt>
 <dd>The state of this browser window. Under some circumstances a Window may not be assigned state property, for example when querying closed windows from the {{WebExtAPIRef('sessions')}} API.</dd>
 <dt>{{WebExtAPIRef("windows.Window")}}</dt>
 <dd>This is an actual browser window.</dd>
 <dt>{{WebExtAPIRef("windows.CreateType")}}</dt>
 <dd>Specifies what type of browser window to create. The 'panel' and 'detached_panel' types create a popup unless the '--enable-panels' flag is set.</dd>
</dl>

<h2 id="Properties">Properties</h2>

<dl>
 <dt>{{WebExtAPIRef("windows.WINDOW_ID_NONE")}}</dt>
 <dd>The windowId value that represents the absence of a browser window.</dd>
 <dt>{{WebExtAPIRef("windows.WINDOW_ID_CURRENT")}}</dt>
 <dd>The windowId value that represents the current window.</dd>
</dl>

<h2 id="Functions">Functions</h2>

<dl>
 <dt>{{WebExtAPIRef("windows.get()")}}</dt>
 <dd>Gets details about a window.</dd>
 <dt>{{WebExtAPIRef("windows.getCurrent()")}}</dt>
 <dd>Gets the current window.</dd>
 <dt>{{WebExtAPIRef("windows.getLastFocused()")}}</dt>
 <dd>Gets the window that was most recently focused — typically the window 'on top'.</dd>
 <dt>{{WebExtAPIRef("windows.getAll()")}}</dt>
 <dd>Gets all windows.</dd>
 <dt>{{WebExtAPIRef("windows.create()")}}</dt>
 <dd>Creates (opens) a new browser with any optional sizing, position or default URL provided.</dd>
 <dt>{{WebExtAPIRef("windows.update()")}}</dt>
 <dd>Updates the properties of a window. Specify only the properties that you want to change; unspecified properties will be left unchanged.</dd>
 <dt>{{WebExtAPIRef("windows.remove()")}}</dt>
 <dd>Removes (closes) a window, and all the tabs inside it.</dd>
</dl>

<h2 id="Events">Events</h2>

<dl>
 <dt>{{WebExtAPIRef("windows.onCreated")}}</dt>
 <dd>Fired when a window is created.</dd>
 <dt>{{WebExtAPIRef("windows.onRemoved")}}</dt>
 <dd>Fired when a window is removed (closed).</dd>
 <dt>{{WebExtAPIRef("windows.onFocusChanged")}}</dt>
 <dd>Fired when the currently focused window changes. Will be {{WebExtAPIRef('windows.WINDOW_ID_NONE')}} if all browser windows have lost focus. Note: On some Linux window managers, WINDOW_ID_NONE will always be sent immediately preceding a switch from one browser window to another.</dd>
</dl>

<h2 id="Browser_compatibility">Browser compatibility</h2>
{{WebExtBrowserCompat}}
<div class="hidden note">
<p>The "Chrome incompatibilities" section is included from <a href="https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities"> https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities</a> using the <a href="/en-US/docs/Template:WebExtChromeCompat">WebExtChromeCompat</a> macro.</p>

<p>If you need to update this content, edit <a href="https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities">https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities</a>, then shift-refresh this page to see your changes.</p>
</div>

<p>{{WebExtChromeCompat}} {{WebExtExamples("h2")}}</p>

<div class="note"><strong>Acknowledgements</strong>

<p>This API is based on Chromium's <a href="https://developer.chrome.com/extensions/windows"><code>chrome.windows</code></a> API. This documentation is derived from <a href="https://chromium.googlesource.com/chromium/src/+/master/chrome/common/extensions/api/windows.json"><code>windows.json</code></a> in the Chromium code.</p>
</div>

<div class="hidden">
<pre>
// Copyright 2015 The Chromium Authors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//    * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//    * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
</pre>
</div>