chrome.sessions

說明

使用 chrome.sessions API 查詢及還原瀏覽工作階段中的分頁和視窗。

權限

sessions

類型

Device

屬性

• deviceName

  字串

  外國裝置的名稱。

• 工作階段

  工作階段[]

  列出外國裝置開啟的視窗工作階段，依最近修改到最低的工作階段排序。

Filter

屬性

• maxResults

  數字 選填

  要求清單中要擷取的項目數量上限。省略這個參數即可擷取項目數量上限 (sessions.MAX_SESSION_RESULTS)。

Session

屬性

• lastModified

  號碼

  關閉或修改視窗或分頁的時間，以自 Epoch 紀元時間起算的毫秒為單位。

• 分頁

  Tab 選用

  如果這個項目描述的是分頁，則為 tabs.Tab。系統會設定這個項目或 sessions.Session.window。

• 窗戶

  視窗 選用

  如果這個項目描述視窗，則為 windows.Window。系統會設定這個項目或 sessions.Session.tab。

屬性

MAX_SESSION_RESULTS

要求清單中要包含的 sessions.Session 數量上限。

值

25

方法

getDevices()

Promise

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

擷取已同步工作階段的所有裝置。

參數

• 過濾器

  篩選器 選用

• 回呼

  函式選用

  callback 參數如下所示：

  (devices: Device[])=>void

  • 裝置

    裝置[]

    每個已同步工作階段的 sessions.Device 物件清單，由最近修改過的工作階段與最近修改過的工作階段的裝置排序。tabs.Tab 物件會依 sessions.Session 物件 windows.Window 中的回訪率排序。

傳回

• Promise<裝置[]>

  Chrome 96 以上版本

  Manifest V3 以上版本支援 Promise，但是為了提供回溯相容性而提供的回呼。您無法在同一個函式呼叫中同時使用這兩者。承諾會用傳遞至回呼的同類型解析。

getRecentlyClosed()

Promise

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

取得最近關閉的分頁和/或視窗清單。

參數

• 過濾器

  篩選器 選用

• 回呼

  函式選用

  callback 參數如下所示：

  (sessions: Session[])=>void

  • 工作階段

    工作階段[]

    關閉項目清單，順序與關閉的相反順序 (最近關閉的分頁或視窗位於索引 0)。這些項目可能會包含分頁或視窗。

傳回

• Promise<Session[]>

  Chrome 96 以上版本

  Manifest V3 以上版本支援 Promise，但是為了提供回溯相容性而提供的回呼。您無法在同一個函式呼叫中同時使用這兩者。承諾會用傳遞至回呼的同類型解析。

restore()

Promise

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

重新開啟 windows.Window 或 tabs.Tab，並提供選用的回呼，在項目還原時執行。

參數

• sessionId

  字串 選用

  要還原的 windows.Window.sessionId 或 tabs.Tab.sessionId。如果未指定這個參數，系統會還原最近關閉的工作階段。

• 回呼

  函式選用

  callback 參數如下所示：

  (restoredSession: Session)=>void

  • restoredSession

    工作階段

    sessions.Session，包含已還原的 windows.Window 或 tabs.Tab 物件。

傳回

• Promise<工作階段>

  Chrome 96 以上版本

  Manifest V3 以上版本支援 Promise，但是為了提供回溯相容性而提供的回呼。您無法在同一個函式呼叫中同時使用這兩者。承諾會用傳遞至回呼的同類型解析。

活動

onChanged

chrome.sessions.onChanged.addListener(
  callback: function,
)

最近關閉的分頁和/或視窗變更時觸發。這個事件不會監控已同步處理的工作階段變更。

參數

• 回呼

  功能

  callback 參數如下所示：

  ()=>void