idle API
Use the browser.idle API to detect when the machine’s idle state changes.
Functions
queryState(detectionIntervalInSeconds)
Returns “idle” if the user has not generated any input for a specified number of seconds, or “active” otherwise.
Parameters
detectionIntervalInSeconds
(integer)
The system is considered idle if detectionIntervalInSeconds seconds have elapsed since the last user input detected.
Required permissions
setDetectionInterval(intervalInSeconds)
Sets the interval, in seconds, used to determine when the system is in an idle state for onStateChanged events. The default interval is 60 seconds.
Parameters
intervalInSeconds
(integer)
Threshold, in seconds, used to determine when the system is in an idle state.
Required permissions
Events
onStateChanged
Fired when the system changes to an active or idle state. The event fires with “idle” if the the user has not generated any input for a specified number of seconds, and “active” when the user generates input on an idle system.
Parameters for onStateChanged.addListener(listener)
listener(newState)
A function that will be called when this event occurs.
Parameters passed to the listener function
Required permissions
Types
IdleState
string
Supported values:
active
idle