chrome.sessions

說明

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

權限

sessions

類型

Device

屬性

• deviceName

  字串

  外國裝置的名稱。

• sessions

  工作階段[]

  外國裝置目前開啟的視窗工作階段清單，從最新到最近修改的工作階段排序。

Filter

屬性

• maxResults

  編號 選填

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

Session

屬性

• lastModified

  數字

  視窗或分頁關閉或修改的時間，以 Epoch 紀元時間起算的毫秒數表示。

• 分頁

  Tab 鍵 選用

  如果此項目說明分頁，則為 tabs.Tab。系統會設定這個項目或 sessions.Session.window。

• 窗戶

  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 以上版本

  Promise 適用於 Manifest V3 及以上版本，但系統會為 回溯相容性您無法在同一函式呼叫中同時使用兩者。 保證會以傳遞至回呼的相同類型來解析。

getRecentlyClosed()

Promise

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

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

參數

• 篩選器

  篩選器 選用

• 回呼

  函式 選用

  callback 參數如下所示：

  (sessions: Session[]) => void

  • sessions

    工作階段[]

    列出已關閉項目的清單，按倒序排序 (最近關閉的分頁或視窗會位於索引 0)。這些項目可能包含分頁或視窗。

傳回

• Promise<Session[]>

  Chrome 96 以上版本

  Promise 適用於 Manifest V3 及以上版本，但系統會為 回溯相容性您無法在同一函式呼叫中同時使用兩者。 保證會以傳遞至回呼的相同類型來解析。

restore()

Promise

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

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

參數

• sessionId

  string optional

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

• 回呼

  函式 選用

  callback 參數如下所示：

  (restoredSession: Session) => void

  • restoredSession

    工作階段

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

傳回

• Promise&lt;Session&gt;

  Chrome 96 以上版本

  Promise 適用於 Manifest V3 及以上版本，但系統會為 回溯相容性您無法在同一函式呼叫中同時使用兩者。 保證會以傳遞至回呼的相同類型來解析。

活動

onChanged

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

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

參數

• 回呼

  函式

  callback 參數如下所示：

  () => void