MDN wants to learn about developers like you: https://qsurvey.mozilla.com/s3/d6d7ff2e2f9c

Add-ons

idle

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.

Browser compatibility

ChromeEdgeFirefoxFirefox for AndroidOpera
IdleState (Yes) No4548 (Yes)
onStateChanged (Yes) No51 *51 * (Yes)
queryState (Yes)15 *45 *48 * (Yes)
setDetectionInterval (Yes)155151 (Yes)

Acknowledgements

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

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

Document Tags and Contributors

 Contributors to this page: wbamberg, abbycar, kmaglione
 Last updated by: wbamberg,