browser.idle

Description

Utilisez l'API chrome.idle pour détecter les changements d'état d'inactivité de l'ordinateur.

Autorisations

idle

Vous devez déclarer l'autorisation "idle" dans le fichier manifeste de votre extension pour utiliser l'API Idle. Exemple :

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

Types

IdleState

Chrome 44+ browser.* depuis Chrome 148

Énumération

"active"

"idle"

"locked"

Méthodes

getAutoLockDelay()

Chrome 73 ou version ultérieure browser.* depuis Chrome 148 ChromeOS uniquement
browser.idle.getAutoLockDelay(): Promise<number>

Récupère le délai, en secondes, avant que l'écran ne se verrouille automatiquement lorsqu'il est inactif. Renvoie une durée nulle si l'écran n'est jamais verrouillé automatiquement. Actuellement compatible avec ChromeOS uniquement.

Renvoie

  • Promise<number>

    Chrome 116+ browser.* depuis Chrome 148

queryState()

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

Renvoie "locked" si le système est verrouillé, "idle" si l'utilisateur n'a généré aucune entrée pendant un nombre de secondes spécifié, ou "active" dans le cas contraire.

Paramètres

  • detectionIntervalInSeconds

    nombre

    Le système est considéré comme inactif si detectionIntervalInSeconds secondes se sont écoulées depuis la dernière entrée utilisateur détectée.

Renvoie

  • Promise<IdleState>

    Chrome 116+ browser.* depuis Chrome 148

setDetectionInterval()

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

Définit l'intervalle, en secondes, utilisé pour déterminer quand le système est inactif pour les événements onStateChanged. L'intervalle par défaut est de 60 secondes.

Paramètres

  • intervalInSeconds

    nombre

    Seuil, en secondes, utilisé pour déterminer quand le système est inactif.

Événements

onStateChanged

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

Se déclenche lorsque le système passe à l'état actif, inactif ou verrouillé. L'événement se déclenche avec "locked" si l'écran est verrouillé ou si l'économiseur d'écran s'active, "idle" si le système est déverrouillé et que l'utilisateur n'a généré aucune entrée pendant un nombre de secondes spécifié, et "active" lorsque l'utilisateur génère une entrée sur un système inactif.

Paramètres

  • callback

    fonction

    Le paramètre callback se présente comme suit :

    (newState: IdleState) => void