该 API 还在 beta 测试中,仅对 beta 分支dev 分支的 Chrome 用户可用。

chrome.sessions

描述 使用 chrome.sessions API 查询和恢复浏览器会话中的标签页和窗口。
可用版本 从 Chrome 37 开始支持。警告:目前为 Beta 分支。了解更多内容
权限 "sessions"

摘要

类型
Filter
Session
Device
属性
MAX_SESSION_RESULTS
方法
getRecentlyClosed chrome.sessions.getRecentlyClosed( Filter filter, function callback)
getDevices chrome.sessions.getDevices( Filter filter, function callback)
restore chrome.sessions.restore(string sessionId, function callback)
事件
onChanged

类型

Filter

属性
integer (可选)
maxResults

在请求的列表中获取项目的最大数目,省略该参数获取最大数目的项目(sessions.MAX_SESSION_RESULTS)。

Session

属性
integer lastModified

窗口或标签页关闭或修改的时间,表示为 1970 年 1 月 1 日以来经过的毫秒数。

tabs.Tab (可选)
tab

如果该项目描述标签页的话则为 tabs.Tab 对象。该属性或 sessions.Session.window 中的某一个将会设置。

windows.Window (可选)
window

如果该项目描述窗口的话则为 windows.Window 对象。该属性或 sessions.Session.tab 中的某一个将会设置。

Device

属性
string deviceName

外来设备的名称。

array of Session sessions

外来设备打开的窗口会话列表,会话按照最近修改到最早修改的顺序排列。

属性

25 chrome.sessions.MAX_SESSION_RESULTS 在请求的列表中获取项目的最大数目,省略该参数获取最大数目的项目(sessions.MAX_SESSION_RESULTS)。

方法

getRecentlyClosed

chrome.sessions.getRecentlyClosed( Filter filter, function callback)

获取最近关闭的标签页和/或窗口列表。

参数
Filter (可选)
filter
function callback

callback 参数应该是一个如下形式的函数:

function(array of Session sessions) {...};
array of Session sessions

关闭的项目列表,按照与关闭相反的顺序排列(最近关闭的标签页或窗口位于索引 0)。项目既可能包含标签页,也可能包含窗口。

getDevices

chrome.sessions.getDevices( Filter filter, function callback)

获取包含已同步会话的所有设备。

参数
Filter (可选)
filter
function callback

callback 参数应该是一个如下形式的函数:

function(array of Device devices) {...};
array of Device devices

每一个同步会话的 sessions.Device 对象列表,具有最近修改的会话的设备在前,具有最早修改的会话的设备在后,依次排列。sessions.Session 对象的 windows.Window 中,tabs.Tab 对象按照最近修改时间排列。

restore

chrome.sessions.restore(string sessionId, function callback)

重新打开 windows.Window(窗口)或 tabs.Tab(标签页),可以传递一个可选的回调函数,在项目恢复后调用。

参数
string (可选)
sessionId

要恢复的 windows.Window.sessionIdtabs.Tab.sessionId。如果未指定该参数,则恢复最近关闭的会话。

function (可选)
callback

如果您指定了 callback 参数,它应该是一个如下形式的函数:

function( Session restoredSession) {...};
Session restoredSession

包含恢复后的 windows.Windowtabs.Tab 对象的 sessions.Session(会话)。

事件

onChanged

最近关闭的标签页和/或窗口更改时产生。不能使用该事件监控同步会话更改。

addListener

chrome.sessions.onChanged.addListener(function callback)
参数
function callback

callback 参数应该是一个如下形式的函数:

function() {...};