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

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxOperaFirefox for Android
IdleStateChrome Full support YesEdge No support NoFirefox Full support 45Opera Full support YesFirefox Android Full support 48
onStateChangedChrome Full support YesEdge No support NoFirefox Full support 51Opera Full support YesFirefox Android Full support 51
queryStateChrome Full support YesEdge Full support 15Firefox Full support 45
Notes
Full support 45
Notes
Notes Before version 51, Firefox always reports 'active'. After version 51, Firefox reports 'active' or 'idle' as appropriate.
Opera Full support YesFirefox Android Full support 48
Notes
Full support 48
Notes
Notes Before version 51, Firefox always reports 'active'. After version 51, Firefox reports 'active' or 'idle' as appropriate.
setDetectionIntervalChrome Full support YesEdge Full support 15Firefox Full support 51Opera Full support YesFirefox Android Full support 51

Legend

Full support  
Full support
No support  
No support
See implementation notes.
See implementation notes.

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,