Namespace: onStateChanged

idle.onStateChanged

An event that fires when the browser's idle state changes. This event supports multiple idle detection intervals, unlike the WebExtensions idle.onStateChanged event.

Source:

Methods

(static) addListener(listener, options)

Add a listener for the onStateChanged event.

Parameters:
Name Type Description
listener idleStateChangeListener

The listener to add.
options Object

Options for the listener.

Properties
Name Type Description
detectionInterval number

The idle state detection interval for the listener, in seconds.
Source:

(static) hasAnyListeners() → {boolean}

Whether the onStateChanged event has any listeners.

Source:
Returns:

Whether the event has any listeners.

Type
boolean

(static) hasListener(listener) → {boolean}

Whether a specified listener for the onStateChanged event has been added.

Parameters:
Name Type Description
listener idleStateChangeListener

The listener to check.
Source:
Returns:

Whether the listener has been added for the event.

Type
boolean

(static) removeListener(listener)

Remove a listener for the onStateChanged event.

Parameters:
Name Type Description
listener idleStateChangeListener

The listener to remove.
Source:

Type Definitions

idleStateChangeListener(idleState)

A listener for the onStateChanged event.

Parameters:
Name Type Description
idleState string

The current idle state: "idle" or "active".
Source: