chrome.idle

Beschreibung

Verwenden Sie die chrome.idle API, um zu erkennen, wenn sich der Leerlaufstatus des Geräts ändert.

Berechtigungen

idle

Manifest

Sie müssen die Berechtigung „idle“ im Manifest Ihrer Erweiterung deklarieren, um die Idle API verwenden zu können. Beispiel:

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

Typen

IdleState

Chrome 44 und höher

Enum

"active"

"idle"

"locked"

Methoden

getAutoLockDelay()

Promise Chrome 73 oder höher Nur ChromeOS 
chrome.idle.getAutoLockDelay(
  callback?: function,
): Promise<number>

Gibt die Zeit in Sekunden zurück, nach der der Bildschirm im Leerlauf automatisch gesperrt wird. Gibt eine Dauer von null zurück, wenn der Bildschirm nie automatisch gesperrt wird. Derzeit wird die Funktion nur unter ChromeOS unterstützt.

Parameter

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (delay: number) => void

    • delay

      Zahl

      Zeit in Sekunden, bis der Bildschirm im Leerlauf automatisch gesperrt wird. Dieser Wert ist null, wenn der Bildschirm nie automatisch gesperrt wird.

Ausgabe

  • Promise<number>

    Chrome 116 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

queryState()

Promise 
chrome.idle.queryState(
  detectionIntervalInSeconds: number,
  callback?: function,
): Promise<IdleState>

Gibt „locked“ zurück, wenn das System gesperrt ist, „idle“, wenn der Nutzer für eine bestimmte Anzahl von Sekunden keine Eingaben gemacht hat, und „active“ in allen anderen Fällen.

Parameter

  • detectionIntervalInSeconds

    Zahl

    Das System gilt als inaktiv, wenn seit der letzten erkannten Nutzereingabe „detectionIntervalInSeconds“ Sekunden vergangen sind.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (newState: IdleState) => void

Ausgabe

  • Promise<IdleState>

    Chrome 116 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

setDetectionInterval()

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

Legt das Intervall in Sekunden fest, das verwendet wird, um zu bestimmen, wann sich das System für onStateChanged-Ereignisse im Leerlauf befindet. Das Standardintervall beträgt 60 Sekunden.

Parameter

  • intervalInSeconds

    Zahl

    Der Schwellenwert in Sekunden, der verwendet wird, um zu bestimmen, wann sich das System im Leerlauf befindet.

Ereignisse

onStateChanged

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

Wird ausgelöst, wenn das System in den Status „Aktiv“, „Inaktiv“ oder „Gesperrt“ wechselt. Das Ereignis wird mit „locked“ ausgelöst, wenn der Bildschirm gesperrt ist oder der Bildschirmschoner aktiviert wird, mit „idle“, wenn das System entsperrt ist und der Nutzer für eine bestimmte Anzahl von Sekunden keine Eingabe vorgenommen hat, und mit „active“, wenn der Nutzer Eingaben in einem inaktiven System vornimmt.

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    (newState: IdleState) => void