MDN self-hosted library · e01.org

idle

Find out when the user's system is idle, locked, or active.

no runnable cells webextension-api upstream source

Find out when the user's system is idle, locked, or active.

To use this API you need to have the "idle" permission.

Types

  • idle.IdleState
  • : String describing the device's idle state.

Functions

  • idle.queryState()
  • : Returns "locked" if the system is locked, "idle" if the user has not generated any input for a specified number of seconds, or "active" otherwise.
  • idle.setDetectionInterval()
  • : Sets the interval used to determine when the system is in an idle state for idle.onStateChanged events.

Events

  • idle.onStateChanged
  • : Fired when the system changes state.

h2

Browser compatibility

[!NOTE] This API is based on Chromium's chrome.idle API. This documentation is derived from idle.json in the Chromium code.