chrome.idle

Description

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

Autorisations

idle

Fichier manifeste

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 et versions ultérieures

Énumération

"active"

"idle"

"locked"

Méthodes

getAutoLockDelay()

Promise Chrome 73 et versions ultérieures ChromeOS uniquement 
chrome.idle.getAutoLockDelay(
  callback?: function,
): Promise<number>

Obtient le temps, en secondes, avant que l'écran ne se verrouille automatiquement en cas d'inactivité. Renvoie une durée nulle si l'écran n'est jamais verrouillé automatiquement. Actuellement disponible uniquement sur ChromeOS.

Paramètres

  • callback

    function facultatif

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

    (delay: number) => void

    • delay

      Total

      Délai en secondes avant le verrouillage automatique de l'écran en cas d'inactivité. Cette valeur est nulle si l'écran ne se verrouille jamais automatiquement.

Renvoie

  • Promise<number>

    Chrome 116 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

queryState()

Promise 
chrome.idle.queryState(
  detectionIntervalInSeconds: number,
  callback?: function,
): 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

    Total

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

  • callback

    function facultatif

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

    (newState: IdleState) => void

Renvoie

  • Promise<IdleState>

    Chrome 116 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

setDetectionInterval()

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

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

Paramètres

  • intervalInSeconds

    Total

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

Événements

onStateChanged

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

Déclenché lorsque le système passe à l'état actif, inactif ou verrouillé. L'événement est déclenché avec la valeur "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 certain nombre de secondes, 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