chrome.idle

Descripción

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

Permisos

idle

Manifiesto

Debes declarar el estado "inactivo" permiso 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

“activo”

“idle”

“bloqueado”

Métodos

getAutoLockDelay()

Promesa Chrome 73 y versiones posteriores Solo en 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 en cero si la pantalla nunca se bloquea automáticamente. Por el momento, solo es compatible con el Sistema operativo Chrome.

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 bloquee automáticamente mientras esté inactiva. Este valor será cero si la pantalla nunca se bloquea automáticamente.

Muestra

  • Promise<number>

    Chrome 116 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

queryState()

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

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

Parámetros

  • detectionIntervalInSeconds

    número

    Se considera que el sistema está inactivo si existen segundos de DetectionIntervalInSeconds transcurridos desde que se detectó la última entrada del usuario.

  • 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 son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

setDetectionInterval()

chrome.idle.setDetectionInterval(
  intervalInSeconds: number,
)

Establece el intervalo, en segundos, que se utiliza 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

    Umbral, en segundos, que se usa para determinar cuando 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 se activa el protector de pantalla, aparece "inactivo" si el sistema está desbloqueado y el usuario no generó ninguna entrada durante un número específico de segundos, y está “activo” Cuando el usuario genera entradas en un sistema inactivo.

Parámetros

  • callback

    función

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

    (newState: IdleState) => void