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.onStateChangedevents.
Events
idle.onStateChanged- Fired when the system changes state.
Browser compatibility
| Chrome | Edge | Firefox | Firefox for Android | Opera | |
|---|---|---|---|---|---|
IdleState | Yes | No | 45 | 48 | Yes |
onStateChanged | Yes | No | 51 * | 51 * | Yes |
queryState | Yes | 15 * | 45 * | 48 * | Yes |
setDetectionInterval | Yes | 15 | 51 | 51 | Yes |
The "Chrome incompatibilities" section is included from https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities using the WebExtChromeCompat macro.
If you need to update this content, edit https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities, then shift-refresh this page to see your changes.
Edge incompatibilities
Promises are not supported in Edge. Use callbacks instead.
Chrome incompatibilities
None.
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.
// Copyright 2015 The Chromium Authors. All rights reserved. // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions are // met: // // * Redistributions of source code must retain the above copyright // notice, this list of conditions and the following disclaimer. // * Redistributions in binary form must reproduce the above // copyright notice, this list of conditions and the following disclaimer // in the documentation and/or other materials provided with the // distribution. // * Neither the name of Google Inc. nor the names of its // contributors may be used to endorse or promote products derived from // this software without specific prior written permission. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.