chrome.idle

Beschreibung

Verwenden Sie die chrome.idle API, um zu erkennen, wenn sich der Inaktivitätsstatus der Maschine ändert.

Berechtigungen

idle

Du musst die Berechtigung „"idle"“ im Manifest deiner Erweiterung deklarieren, um die inaktive API verwenden zu können. Beispiel:

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

Typen

IdleState

Chrome 44 und höher

Enum

Methoden

getAutoLockDelay()

Versprechen Chrome 73 und höher Nur ChromeOS 
chrome.idle.getAutoLockDelay(
  callback?: function,
)

Ruft die Zeit in Sekunden ab, die es dauert, bis das Display bei Inaktivität automatisch gesperrt wird. Gibt eine Dauer von null zurück, wenn der Bildschirm nie automatisch gesperrt wird. Wird derzeit nur unter ChromeOS unterstützt.

Parameters

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (delay: number)=>void

    • delay

      Zahl

      Zeit in Sekunden, bis das Display bei Inaktivität automatisch gesperrt wird. Der Wert ist null, wenn der Bildschirm nie automatisch gesperrt wird.

Rückgaben

  • Versprechen<Zahl>

    Chrome 116 oder höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

queryState()

Versprechen 
chrome.idle.queryState(
  detectionIntervalInSeconds: number,
  callback?: function,
)

Gibt „locked“ zurück, wenn das System gesperrt ist, „idle“, wenn der Nutzer für eine bestimmte Anzahl von Sekunden keine Eingabe generiert hat, andernfalls „active“.

Parameters

  • detectionIntervalInSeconds

    Zahl

    Das System gilt als inaktiv, wenn seit der letzten erkannten Nutzereingabe Sekunden in Sekundenbruchteilen vergangen sind.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (newState: IdleState)=>void

Rückgaben

  • Promise<IdleState>

    Chrome 116 oder höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

setDetectionInterval()

chrome.idle.setDetectionInterval(
  intervalInSeconds: number,
)

Legt das Intervall in Sekunden fest, mit dem bestimmt wird, wann das System für onStateChanged-Ereignisse inaktiv ist. Das Standardintervall beträgt 60 Sekunden.

Parameters

  • intervalInSeconds

    Zahl

    Grenzwert in Sekunden, der angibt, wann das System inaktiv ist.

Veranstaltungen

onStateChanged

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

Wird ausgelöst, wenn das System in einen aktiven, inaktiven oder gesperrten Status wechselt. Das Ereignis wird mit „Gesperrt“ ausgelöst, wenn der Bildschirm gesperrt oder der Bildschirmschoner aktiviert wird, „Inaktiv“, wenn das System entsperrt ist und der Nutzer eine bestimmte Anzahl von Sekunden lang keine Eingabe generiert hat, und „Aktiv“, wenn der Nutzer bei einem inaktiven System eine Eingabe generiert.

Parameters

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    (newState: IdleState)=>void