chrome.idle

説明

chrome.idle API を使用して、マシンのアイドル状態の変化を検出します。

権限

idle

アイドル状態の API を使用するには、拡張機能のマニフェストで "idle" 権限を宣言する必要があります。次に例を示します。

{
  "name": "My extension",
  ...
  "permissions": [
    "idle"
  ],
  ...
}

型

IdleState

Chrome 44 以降

列挙型

「有効」

"アイドル状態"

「ロック中」

メソッド

getAutoLockDelay()

<ph type="x-smartling-placeholder"></ph> 約束 Chrome 73 以降 ChromeOS のみ 
chrome.idle.getAutoLockDelay(
  callback?: function,
)

アイドル状態のときに画面が自動的にロックされるまでの時間を秒単位で取得します。画面が自動的にロックされない場合は、期間 0 を返します。現在、ChromeOS でのみサポートされています。

パラメータ

  • callback

    関数（省略可）

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

    (delay: number) => void

    • delay

      数値

      アイドル状態のときに画面が自動的にロックされるまでの時間（秒）。画面が自動的にロックされない場合、この値はゼロになります。

戻り値

  • Promise&lt;number&gt;

    Chrome 116 以降

    Promise は Manifest V3 以降でサポートされていますが、 下位互換性が確保されます同じ関数呼び出しで両方を使用することはできません。「 Promise はコールバックに渡された型と同じ型で解決されます。

queryState()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.idle.queryState(
  detectionIntervalInSeconds: number,
  callback?: function,
)

「locked」を返します。システムがロックされている場合は指定した秒数の間にユーザーが入力を生成しなかった場合、つまり「アクティブ」状態できません。

パラメータ

  • detectionIntervalInSeconds

    数値

    最後のユーザー入力を検出してから DetectionIntervalInSeconds 秒が経過すると、システムはアイドル状態とみなされます。

  • callback

    関数（省略可）

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

    (newState: IdleState) => void

戻り値

  • Promise&lt;IdleState&gt;

    Chrome 116 以降

    Promise は Manifest V3 以降でサポートされていますが、 下位互換性が確保されます同じ関数呼び出しで両方を使用することはできません。「 Promise はコールバックに渡された型と同じ型で解決されます。

setDetectionInterval()

chrome.idle.setDetectionInterval(
  intervalInSeconds: number,
)

onStateChanged イベントでシステムがアイドル状態にあるかどうかを判断するための間隔を秒単位で設定します。デフォルトの間隔は 60 秒です。

パラメータ

  • intervalInSeconds

    数値

    システムがアイドル状態にあるかどうかを判断するためのしきい値（秒単位）。

イベント

onStateChanged

chrome.idle.onStateChanged.addListener(
  callback: function,
)

システムがアクティブ、アイドル状態、またはロック状態に変わったときに呼び出されます。イベントは「ロック」で起動します。画面がロックされている、またはスクリーンセーバーが有効になっている場合は「アイドル状態」システムがロック解除されていて、指定された秒数の間ユーザーが入力を何も行わず、「アクティブ」である場合ユーザーがアイドル状態のシステムで入力を生成したとき。

パラメータ

  • callback

    関数

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

    (newState: IdleState) => void