1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
---
title: windows
slug: Mozilla/Add-ons/WebExtensions/API/windows
tags:
- API
- Add-ons
- Extensions
- Interface
- NeedsTranslation
- Non-standard
- Reference
- TopicStub
- WebExtensions
- Windows
translation_of: Mozilla/Add-ons/WebExtensions/API/windows
---
<div>{{AddonSidebar}}</div>
<p>Interact with browser windows. You can use this API to get information about open windows and to open, modify, and close windows. You can also listen for window open, close, and activate events.</p>
<h2 id="Types">Types</h2>
<dl>
<dt>{{WebExtAPIRef("windows.WindowType")}}</dt>
<dd>The type of browser window this is.</dd>
<dt>{{WebExtAPIRef("windows.WindowState")}}</dt>
<dd>The state of this browser window.</dd>
<dt>{{WebExtAPIRef("windows.Window")}}</dt>
<dd>Contains information about a browser window.</dd>
<dt>{{WebExtAPIRef("windows.CreateType")}}</dt>
<dd>Specifies the type of browser window to create.</dd>
</dl>
<h2 id="Properties">Properties</h2>
<dl>
<dt>{{WebExtAPIRef("windows.WINDOW_ID_NONE")}}</dt>
<dd>The <code>windowId</code> value that represents the absence of a browser window.</dd>
<dt>{{WebExtAPIRef("windows.WINDOW_ID_CURRENT")}}</dt>
<dd>The <code>windowId</code> 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, given its ID.</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>
<p>Creates a new window.</p>
</dd>
<dt>{{WebExtAPIRef("windows.update()")}}</dt>
<dd>Updates the properties of a window. Use this to move, resize, and (un)focus a window, etc.</dd>
<dt>{{WebExtAPIRef("windows.remove()")}}</dt>
<dd>Closes a window, and all its tabs.</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 closed.</dd>
<dt>{{WebExtAPIRef("windows.onFocusChanged")}}</dt>
<dd>Fired when the currently focused window changes.</dd>
</dl>
<h2 id="Browser_compatibility">Browser compatibility</h2>
<p>{{Compat("webextensions.api.windows")}}</p>
<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>
<h3 id="Edge_incompatibilities">Edge incompatibilities</h3>
<p>Promises are not supported in Edge. Use callbacks instead.</p>
<p>{{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>
<p>Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.</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>
|
