chrome.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 inactiva. Por ejemplo:

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

Tipos

IdleState

Chrome 44 y versiones posteriores

Enum

Métodos

getAutoLockDelay()

Promesa Chrome 73 y versiones posteriores Solo para ChromeOS 
chrome.idle.getAutoLockDelay(
  callback?: function,
)

Obtiene el tiempo, en segundos, que tarda la pantalla en bloquearse automáticamente mientras está inactiva. Muestra una duración de cero si la pantalla nunca se bloquea automáticamente. Actualmente, solo es compatible con ChromeOS.

Parámetros

  • callback

    Función opcional

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

    (delay: number)=>void

    • delay

      número

      Tiempo, en segundos, hasta que la pantalla se bloquea automáticamente mientras está inactiva. El valor es cero si la pantalla nunca se bloquea automáticamente.

Devuelve

  • Promesa<number>

    Chrome 116 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

queryState()

Promesa 
chrome.idle.queryState(
  detectionIntervalInSeconds: number,
  callback?: function,
)

Devuelve "bloqueado" si el sistema está bloqueado, "inactivo" si el usuario no generó ninguna entrada durante un número específico de segundos o "activo" si no lo hizo.

Parámetros

  • detectionIntervalInSeconds

    número

    El sistema se considera inactivo si han transcurrido segundos DetectionIntervalInSeconds desde la última entrada del usuario detectada.

  • callback

    Función opcional

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

    (newState: IdleState)=>void

Devuelve

  • Promise<IdleState>

    Chrome 116 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

setDetectionInterval()

chrome.idle.setDetectionInterval(
  intervalInSeconds: number,
)

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

Parámetros

  • intervalInSeconds

    número

    Umbral, en segundos, que se usa para determinar cuándo el sistema se encuentra en estado inactivo.

Eventos

onStateChanged

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

Se activa cuando el sistema cambia a un estado activo, inactivo o bloqueado. El evento se activa con el estado "bloqueado" si la pantalla está bloqueada o el protector de pantalla se activa, "inactivo" si el sistema está desbloqueado y el usuario no generó ninguna entrada durante un número específico de segundos, y "activa" cuando genera entrada en un sistema inactivo.

Parámetros

  • callback

    la función

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

    (newState: IdleState)=>void