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
Report problems with this compatibility data on GitHubwebextensions-desktop | webextensions-mobile | |||||
---|---|---|---|---|---|---|
IdleState | ChromeFull supportYes | EdgeFull support79 | FirefoxFull support45 | OperaFull supportYes | SafariNo supportNo | Firefox for AndroidFull support48 |
onStateChanged | ChromeFull supportYes | EdgeFull support79 | FirefoxFull support51 | OperaFull supportYes | SafariNo supportNo | Firefox for AndroidFull support51 |
onStateChanged.locked | ChromeFull supportYes | EdgeFull support79 | FirefoxNo supportNo | OperaFull supportYes | SafariNo supportNo | Firefox for AndroidNo supportNo |
queryState | ChromeFull supportYes | EdgeFull support15 | FirefoxFull support45
| OperaFull supportYes | SafariNo supportNo | Firefox for AndroidFull support48
|
queryState.locked | ChromeFull supportYes | EdgeFull support79 | FirefoxNo supportNo | OperaFull supportYes | SafariNo supportNo | Firefox for AndroidNo supportNo |
setDetectionInterval | ChromeFull supportYes | EdgeFull support15 | FirefoxFull support51 | OperaFull supportYes | SafariNo supportNo | Firefox for AndroidFull support51 |
Legend
- Full support
- Full support
- No support
- No support
- See implementation notes.
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
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.