browser.idle

Descripción

Usa la API de chrome.idle para detectar cuándo cambia el estado inactivo de la máquina.

Permisos

idle

Debes declarar el permiso "idle" en el manifiesto de tu extensión para usar la API de inactividad. Por ejemplo:

{
  "name": "My extension",
  ...
  "permissions": [
    "idle"
  ],
  ...
}

Tipos

IdleState

Chrome 44 y versiones posteriores browser.* desde Chrome 148

Enum

"active"

"idle"

"locked"

Métodos

getAutoLockDelay()

Chrome 73 y versiones posteriores browser.* desde Chrome 148 Solo para ChromeOS
browser.idle.getAutoLockDelay(): Promise<number>

Obtiene el tiempo, en segundos, que tarda la pantalla en bloquearse automáticamente cuando está inactiva. Devuelve una duración de cero si la pantalla nunca se bloquea automáticamente. Actualmente, solo se admite en ChromeOS.

Muestra

  • Promise<number>

    Chrome 116 y versiones posteriores browser.* desde Chrome 148

queryState()

browser.idle.queryState(
  detectionIntervalInSeconds: number,
)
: Promise<IdleState>

Devuelve "locked" si el sistema está bloqueado, "idle" si el usuario no generó ninguna entrada durante una cantidad de segundos especificada o "active" de lo contrario.

Parámetros

  • detectionIntervalInSeconds

    número

    Se considera que el sistema está inactivo si transcurrieron detectionIntervalInSeconds segundos desde la última entrada del usuario detectada.

Muestra

  • Promise<IdleState>

    Chrome 116 y versiones posteriores browser.* desde Chrome 148

setDetectionInterval()

browser.idle.setDetectionInterval(
  intervalInSeconds: number,
)
: void

Establece el intervalo, en segundos, que se usa para determinar cuándo el sistema está en estado inactivo para los eventos onStateChanged. El intervalo predeterminado es de 60 segundos.

Parámetros

  • intervalInSeconds

    número

    Es el umbral, en segundos, que se usa para determinar cuándo el sistema está en estado inactivo.

Eventos

onStateChanged

browser.idle.onStateChanged.addListener(
  callback: function,
)

Se activa cuando el sistema cambia a un estado activo, inactivo o bloqueado. El evento se activa con "locked" si la pantalla está bloqueada o se activa el protector de pantalla, "idle" si el sistema está desbloqueado y el usuario no generó ninguna entrada durante una cantidad de segundos especificada, y "active" cuando el usuario genera una entrada en un sistema inactivo.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera:

    (newState: IdleState) => void