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
128
129
130
131
132
133
134
135
136
|
---
title: sessions
slug: Mozilla/Add-ons/WebExtensions/API/sessions
tags:
- API
- Add-ons
- Extensions
- NeedsTranslation
- Non-standard
- Reference
- TopicStub
- WebExtensions
- sessions
translation_of: Mozilla/Add-ons/WebExtensions/API/sessions
---
<div>{{AddonSidebar}}</div>
<p>Use the sessions API to list, and restore, tabs and windows that have been closed while the browser has been running.</p>
<p>The {{WebExtAPIRef("sessions.getRecentlyClosed()")}} function returns an array of {{WebExtAPIRef("tabs.Tab")}} and {{WebExtAPIRef("windows.Window")}} objects, representing tabs and windows that have been closed since the browser was running, up to the maximum defined in {{WebExtAPIRef("sessions.MAX_SESSION_RESULTS")}}.</p>
<p>You can then restore a window or tab using the {{WebExtAPIRef("sessions.restore()")}} function. Restoring doesn't just reopen the tab: it also restores the tab's navigation history so the back/forward buttons will work.</p>
<p>This API also provides a group of functions that enable an extension to store additional state associated with a tab or a window. Then, if the tab or window is closed and subsequently restored, the extension can retrieve the state. For example, a tab grouping extension might use this to remember which group a tab is in, so as to restore it into the right group if the user restores the tab.</p>
<p>To use the sessions API you must have the "sessions" <a href="https://developer.mozilla.org/en-US/Add-ons/WebExtensions/manifest.json/permissions#API_permissions">API permission</a>.</p>
<h2 id="Types">Types</h2>
<dl>
<dt>{{WebExtAPIRef("sessions.Filter")}}</dt>
<dd>Enables you to restrict the number of {{WebExtAPIRef("sessions.Session", "Session")}} objects returned by a call to {{WebExtAPIRef("sessions.getRecentlyClosed()")}}.</dd>
<dt>{{WebExtAPIRef("sessions.Session")}}</dt>
<dd>
<p>Represents a tab or window that the user has closed in the current browsing session.</p>
</dd>
</dl>
<h2 id="Properties">Properties</h2>
<dl>
<dt>{{WebExtAPIRef("sessions.MAX_SESSION_RESULTS")}}</dt>
<dd>The maximum number of sessions that will be returned by a call to <a href="https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/sessions/getRecentlyClosed" title="Returns an array Session objects, representing windows and tabs that were closed in the current browsing session (that is: the time since the browser was started)."><code>sessions.getRecentlyClosed()</code></a>.</dd>
</dl>
<h2 id="Functions">Functions</h2>
<dl>
<dt>{{WebExtAPIRef("sessions.forgetClosedTab()")}}</dt>
<dd>Removes a closed tab from the browser's list of recently closed tabs.</dd>
<dt>{{WebExtAPIRef("sessions.forgetClosedWindow()")}}</dt>
<dd>Removes a closed window from the browser's list of recently closed windows.</dd>
<dt>{{WebExtAPIRef("sessions.getRecentlyClosed()")}}</dt>
<dd>Returns an array of {{WebExtAPIRef("sessions.Session", "Session")}} objects, representing windows and tabs that were closed in the current browsing session (that is: the time since the browser was started).</dd>
<dt>{{WebExtAPIRef("sessions.restore()")}}</dt>
<dd>
<p>Restores a closed tab or window.</p>
</dd>
<dt>{{WebExtAPIRef("sessions.setTabValue()")}}</dt>
<dd>
<p>Store a key/value pair associated with a given tab.</p>
</dd>
<dt>{{WebExtAPIRef("sessions.getTabValue()")}}</dt>
<dd>
<p>Retrieve a previously stored value for a given tab, given its key.</p>
</dd>
<dt>{{WebExtAPIRef("sessions.removeTabValue()")}}</dt>
<dd>
<p>Remove a key/value pair from a given tab.</p>
</dd>
<dt>{{WebExtAPIRef("sessions.setWindowValue()")}}</dt>
<dd>
<p>Store a key/value pair associated with a given window.</p>
</dd>
<dt>{{WebExtAPIRef("sessions.getWindowValue()")}}</dt>
<dd>
<p>Retrieve a previously stored value for a given window, given its key.</p>
</dd>
<dt>{{WebExtAPIRef("sessions.removeWindowValue()")}}</dt>
<dd>
<p>Remove a key/value pair from a given window.</p>
</dd>
</dl>
<h2 id="Events">Events</h2>
<dl>
<dt>{{WebExtAPIRef("sessions.onChanged")}}</dt>
<dd>
<p>Fired when a tab or window is closed.</p>
</dd>
</dl>
<h2 id="Browser_compatibility">Browser compatibility</h2>
<p>{{Compat("webextensions.api.sessions")}}</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/sessions"><code>chrome.sessions</code></a> API.</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 class="notranslate">// 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>
|
