W3cubDocs

/Web Extensions

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

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
IdleState
Yes
79
45
?
Yes
No
?
?
48
?
?
?
onStateChanged
Yes
79
51
?
Yes
No
?
?
51
?
?
?
queryState
Yes
15
45
Before version 51, Firefox always reports 'active'. After version 51, Firefox reports 'active' or 'idle' as appropriate.
?
Yes
No
?
?
48
Before version 51, Firefox always reports 'active'. After version 51, Firefox reports 'active' or 'idle' as appropriate.
?
?
?
setDetectionInterval
Yes
15
51
?
Yes
No
?
?
51
?
?
?

Note: 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.

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/idle