Description
Utilisez l'API chrome.idle
pour détecter tout changement d'état inactif de la machine.
Autorisations
idle
Pour utiliser l'API inactive, vous devez déclarer l'autorisation "idle"
dans le fichier manifeste de votre extension. Exemple :
{
"name": "My extension",
...
"permissions": [
"idle"
],
...
}
Types
IdleState
Enum
"active"
"idle"
Méthodes
getAutoLockDelay()
chrome.idle.getAutoLockDelay(
callback?: function,
)
Récupère le délai, en secondes, qui s'écoule avant que l'écran se verrouille automatiquement en cas d'inactivité. Renvoie une durée nulle si l'écran n'est jamais verrouillé automatiquement. Actuellement compatible avec Chrome OS uniquement.
Paramètres
-
rappel
fonction facultative
Le paramètre
callback
se présente comme suit :(delay: number) => void
-
delay
number
Délai, en secondes, jusqu'au verrouillage automatique de l'écran en cas d'inactivité. Cette valeur est égale à zéro si l'écran ne se verrouille jamais automatiquement.
-
Renvoie
-
Promesse<number>
Chrome 116 et versions ultérieuresLes promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.
queryState()
chrome.idle.queryState(
detectionIntervalInSeconds: number,
callback?: function,
)
Renvoie "verrouillé" si le système est verrouillé, "inactif" 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
number
Le système est considéré comme inactif si la détection d'intervalle dans la mesure du nombre de secondes est écoulée depuis la dernière entrée utilisateur détectée.
-
rappel
fonction facultative
Le paramètre
callback
se présente comme suit :(newState: IdleState) => void
-
newState
-
Renvoie
-
Promise<IdleState>
Chrome 116 et versions ultérieuresLes promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. 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 à quel moment le système est inactif pour les événements onStateChanged. L'intervalle par défaut est de 60 secondes.
Paramètres
-
intervalInSeconds
number
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 se déclenche avec la mention "verrouillé" si l'écran est verrouillé ou l'économiseur d'écran s'active, "inactif" 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 "actif" lorsque l'utilisateur génère des données sur un système inactif.