chrome.sessions

説明

chrome.sessions API を使用すると、閲覧中のセッションからタブとウィンドウの問い合わせや復元を行うことができます。

権限

sessions

Device

プロパティ

  • deviceName

    文字列

    外部デバイスの名前。

  • sessions

    外部デバイスの開いているウィンドウ セッションのリスト(最近変更されたセッションから最近変更されていないセッションの順に並べ替えられます)。

Filter

プロパティ

  • maxResults

    number(省略可)

    リクエストされたリストでフェッチするエントリの最大数。最大数のエントリ(sessions.MAX_SESSION_RESULTS)を取得するには、このパラメータを省略します。

Session

プロパティ

  • lastModified

    数値

    ウィンドウまたはタブが閉じられたか変更された時刻(エポックからの経過秒数)。

  • タブ

    タブ 省略可

    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

    function 省略可

    callback パラメータは次のようになります。

    (devices: Device[]) => void

    • デバイス

      同期された各セッションの sessions.Device オブジェクトのリスト。最後に変更されたセッションのデバイスから最後に変更されたセッションのデバイスの順に並べ替えられます。tabs.Tab オブジェクトは、sessions.Session オブジェクトの windows.Window で最近の順に並べ替えられます。

戻り値

  • Promise<Device[]>

    Chrome 96 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

getRecentlyClosed()

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

最近閉じたタブまたはウィンドウのリストを取得します。

パラメータ

  • フィルタ

    フィルタ 省略可

  • 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 を再オープンします。エントリが復元されたときに実行されるコールバックは省略可能です。

パラメータ

戻り値

  • Promise<Session>

    Chrome 96 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

イベント

onChanged

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

最近閉じたタブやウィンドウが変更されたときに発生します。このイベントは、同期されたセッションの変更をモニタリングしません。

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。

    () => void