MDN self-hosted library · e01.org

idle.onStateChanged

Fired when the system changes to an active, idle or locked state. The event listener is passed a string that has one of three values:

Fired when the system changes to an active, idle or locked state. The event listener is passed a string that has one of three values:

  • "locked" if the screen is locked or the screensaver activates
  • "idle" if the system is unlocked and the user has not generated any input for a specified number of seconds. This number defaults to 60, but can be set using idle.setDetectionInterval().
  • "active" when the user generates input on an idle system.

Syntax

browser.idle.onStateChanged.addListener(listener)
browser.idle.onStateChanged.removeListener(listener)
browser.idle.onStateChanged.hasListener(listener)

Events have three functions:

  • addListener(listener)
  • : Adds a listener to this event.
  • removeListener(listener)
  • : Stop listening to this event. The listener argument is the listener to remove.
  • hasListener(listener)
  • : Check whether listener is registered for this event. Returns true if it is listening, false otherwise.

addListener syntax

Parameters

  • listener
  • : The function called when this event occurs. The function is passed this argument:
    • newState
    • : idle.IdleState. The new idle state.

Examples

function newState(state) {
  console.log(`New state: ${state}`);
}

browser.idle.onStateChanged.addListener(newState);

Browser compatibility

[!NOTE] This API is based on Chromium's chrome.idle API. This documentation is derived from idle.json in the Chromium code.