chrome.sessions
- Description
Use the
chrome.sessionsAPI to query and restore tabs and windows from a browsing session. - Permissions
sessions
Summary
- Types
- Properties
- Methods
- Events
Types
Device
Properties
- deviceName
string
The name of the foreign device.
- sessions
Session[]
A list of open window sessions for the foreign device, sorted from most recently to least recently modified session.
Filter
Properties
- maxResults
number optional
The maximum number of entries to be fetched in the requested list. Omit this parameter to fetch the maximum number of entries (
sessions.MAX_SESSION_RESULTS).
Session
Properties
- lastModified
number
The time when the window or tab was closed or modified, represented in milliseconds since the epoch.
- tab
Tab optional
The
tabs.Tab, if this entry describes a tab. Either this orsessions.Session.windowwill be set. - window
Window optional
The
windows.Window, if this entry describes a window. Either this orsessions.Session.tabwill be set.
Properties
MAX_SESSION_RESULTS
The maximum number of sessions.Session that will be included in a requested list.
Value
25
Methods
getDevices
chrome.sessions.getDevices(
filter?:
Filter,
callback?:
function,
)
Retrieves all devices with synced sessions.
Parameters
- filter
Filter optional
- callback
function optional
The
callbackparameter looks like:(devices: Device[]) => void- devices
Device[]
The list of
sessions.Deviceobjects for each synced session, sorted in order from device with most recently modified session to device with least recently modified session.tabs.Tabobjects are sorted by recency in thewindows.Windowof thesessions.Sessionobjects.
Returns
Promise<Device[]>
Chrome 96+Promises are supported in Manifest V3 and later, but callbacks are provided for backward compatibility. You cannot use both on the same function call. The promise resolves with the same type that is passed to the callback.
getRecentlyClosed
chrome.sessions.getRecentlyClosed(
filter?:
Filter,
callback?:
function,
)
Gets the list of recently closed tabs and/or windows.
Parameters
- filter
Filter optional
- callback
function optional
The
callbackparameter looks like:(sessions: Session[]) => void- sessions
Session[]
The list of closed entries in reverse order that they were closed (the most recently closed tab or window will be at index
0). The entries may contain either tabs or windows.
Returns
Promise<Session[]>
Chrome 96+Promises are supported in Manifest V3 and later, but callbacks are provided for backward compatibility. You cannot use both on the same function call. The promise resolves with the same type that is passed to the callback.
restore
chrome.sessions.restore(
sessionId?:
string,
callback?:
function,
)
Reopens a windows.Window or tabs.Tab, with an optional callback to run when the entry has been restored.
Parameters
- sessionId
string optional
The
windows.Window.sessionId, ortabs.Tab.sessionIdto restore. If this parameter is not specified, the most recently closed session is restored. - callback
function optional
The
callbackparameter looks like:(restoredSession: Session) => void- restoredSession
A
sessions.Sessioncontaining the restoredwindows.Windowortabs.Tabobject.
Returns
Promise<Session>
Chrome 96+Promises are supported in Manifest V3 and later, but callbacks are provided for backward compatibility. You cannot use both on the same function call. The promise resolves with the same type that is passed to the callback.
Events
onChanged
chrome.sessions.onChanged.addListener(
callback:
function,
)
Fired when recently closed tabs and/or windows are changed. This event does not monitor synced sessions changes.
Parameters
- callback
function
The
callbackparameter looks like:() => void