chrome.sessions

Description

Use the chrome.sessions API to query and restore tabs and windows from a browsing session.

Permissions

sessions

Types

Device

Properties

  • deviceName

    string

    The name of the foreign device.

  • sessions

    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

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,
)
: Promise<Device[]>

Retrieves all devices with synced sessions.

Parameters

Returns

  • Promise<Device[]>

    Chrome 96+

getRecentlyClosed()

chrome.sessions.getRecentlyClosed(
  filter?: Filter,
)
: Promise<Session[]>

Gets the list of recently closed tabs and/or windows.

Parameters

Returns

restore()

chrome.sessions.restore(
  sessionId?: string,
)
: Promise<Session>

Reopens a windows.Window or tabs.Tab, with an optional callback to run when the entry has been restored.

Parameters

Returns

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 callback parameter looks like:

    () => void