chrome.idle

説明

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

権限

idle

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

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

型

IdleState

Chrome 44 以降

Enum

"idle"

Methods

getAutoLockDelay()

Promise Chrome 73 以降 ChromeOS のみ 
chrome.idle.getAutoLockDelay(
  callback?: function,
)

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

パラメータ

  • callback

    関数（省略可）

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

    (delay: number)=>void

    • delay

      数値

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

戻り値

  • Promise<数値>

    Chrome 116 以降

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

queryState()

Promise 
chrome.idle.queryState(
  detectionIntervalInSeconds: number,
  callback?: function,
)

システムがロックされている場合は「locked」を返します。ユーザーが指定された秒数の間入力を生成していない場合は「idle」を返し、それ以外の場合は「active」を返します。

パラメータ

  • detectionIntervalInSeconds

    数値

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

  • callback

    関数（省略可）

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

    (newState: IdleState)=>void

戻り値

  • Promise<IdleState>

    Chrome 116 以降

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

setDetectionInterval()

chrome.idle.setDetectionInterval(
  intervalInSeconds: number,
)

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

パラメータ

  • intervalInSeconds

    数値

    システムがアイドル状態であるかどうかを判断するために使用されるしきい値（秒）。

イベント

onStateChanged

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

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

パラメータ

  • callback

    機能

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

    (newState: IdleState)=>void