chrome.idle

Description

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

Autorisations

idle

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

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

Types

IdleState

Chrome (version 44 ou ultérieure)

Énumération

"actif"

"inactif"

"verrouillée"

Méthodes

getAutoLockDelay()

<ph type="x-smartling-placeholder"></ph> Promesse Chrome 73 et versions ultérieures ChromeOS uniquement 
chrome.idle.getAutoLockDelay(
  callback?: function,
)

Récupère le temps, en secondes, nécessaire pour que l'écran se verrouille automatiquement en cas d'inactivité. Renvoie une durée de zéro si l'écran n'est jamais verrouillé automatiquement. Actuellement disponible sur ChromeOS uniquement.

Paramètres

  • rappel

    function facultatif

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

    (delay: number) => void

    • delay

      Nombre

      Délai, en secondes, jusqu'au verrouillage automatique de l'écran en cas d'inactivité. Cette valeur est zéro si l'écran ne se verrouille jamais automatiquement.

Renvoie

  • Promise&lt;number&gt;

    Chrome 116 et versions ultérieures

    Les promesses sont prises en charge dans Manifest V3 et versions ultérieures, mais les rappels sont fournis pour rétrocompatibilité. Vous ne pouvez pas utiliser les deux sur le même appel de fonction. La la promesse est résolue avec le même type que celui transmis au rappel.

queryState()

<ph type="x-smartling-placeholder"></ph> Promesse 
chrome.idle.queryState(
  detectionIntervalInSeconds: number,
  callback?: function,
)

Affiche "verrouillée" si le système est verrouillé, "inactif" Si l'utilisateur n'a pas généré d'entrée pendant un certain nombre de secondes, ou "active" sinon.

Paramètres

  • detectionIntervalInSeconds

    Nombre

    Le système est considéré comme inactif si la détectionIntervalInSeconds de secondes s'est écoulée depuis la dernière entrée utilisateur détectée.

  • rappel

    function facultatif

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

    (newState: IdleState) => void

Renvoie

  • Promise&lt;IdleState&gt;

    Chrome 116 et versions ultérieures

    Les promesses sont prises en charge dans Manifest V3 et versions ultérieures, mais les rappels sont fournis pour rétrocompatibilité. Vous ne pouvez pas utiliser les deux sur le même appel de fonction. La la promesse est résolue avec le même type que celui transmis au rappel.

setDetectionInterval()

chrome.idle.setDetectionInterval(
  intervalInSeconds: number,
)

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

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

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

Paramètres

  • rappel

    fonction

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

    (newState: IdleState) => void