chrome.idle

Descripción

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

Permisos

idle

Manifiesto

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

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

Tipos

IdleState

Chrome 44 y versiones posteriores

Enum

"active"

"idle"

"locked"

Métodos

getAutoLockDelay()

Promise Chrome 73 y versiones posteriores Solo ChromeOS 
chrome.idle.getAutoLockDelay(
  callback?: function,
): Promise<number>

Obtiene el tiempo, en segundos, que transcurre hasta que la pantalla se bloquea automáticamente mientras está inactiva. Devuelve una duración de cero si la pantalla nunca se bloquea automáticamente. Actualmente, solo se admite en 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 cuando está inactiva. Este valor es cero si la pantalla nunca se bloquea automáticamente.

Muestra

  • Promise<number>

    Chrome 116 y versiones posteriores

    Las promesas solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

queryState()

Promesa 
chrome.idle.queryState(
  detectionIntervalInSeconds: number,
  callback?: function,
): Promise<IdleState>

Devuelve "locked" si el sistema está bloqueado, "idle" si el usuario no generó ninguna entrada durante una cantidad específica de segundos o "active" en cualquier otro caso.

Parámetros

  • detectionIntervalInSeconds

    número

    El sistema se considera inactivo si transcurrieron detectionIntervalInSeconds segundos desde la última entrada del usuario detectada.

  • callback

    función opcional

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

    (newState: IdleState) => void

Muestra

  • Promise<IdleState>

    Chrome 116 y versiones posteriores

    Las promesas solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

setDetectionInterval()

chrome.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 de inactividad.

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 "locked" si la pantalla está bloqueada o se activa el protector de pantalla, con "idle" si el sistema está desbloqueado y el usuario no generó ninguna entrada durante una cantidad específica de segundos, y con "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