IdleDetector: start()-Methode

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig, bevor Sie diese produktiv verwenden.

Hinweis: Dieses Feature ist verfügbar in Dedicated Web Workers.

Die start()-Methode der IdleDetector-Schnittstelle gibt ein Promise zurück, das aufgelöst wird, wenn der Detektor mit dem Lauschen auf Änderungen des Leerlaufzustands des Benutzers beginnt. Diese Methode nimmt ein optionales options-Objekt mit dem threshold in Millisekunden, bei dem Inaktivität gemeldet werden soll, und signal für ein AbortSignal, um den Leerlaufdetektor abzubrechen.

Syntax

js
start()
start(options)

Parameter

options Optional

Ein Objekt mit den folgenden Eigenschaften:

threshold

Die minimale Anzahl von Leerlauf-Millisekunden, bevor die Meldung beginnen soll.

signal

Eine Referenz auf eine AbortSignal-Instanz, die es Ihnen ermöglicht, die Leerlauferkennung abzubrechen.

Rückgabewert

Ein Promise.

Ausnahmen

NotAllowedError DOMException

Die Verwendung dieser Funktion wurde durch eine Berechtigungsrichtlinie blockiert.

Beispiele

Das folgende Beispiel zeigt, wie man die Leerlauferkennung mit dem options-Argument startet. Es wird eine Instanz von AbortSignal von einer Instanz von AbortController abgerufen.

js
const controller = new AbortController();
const signal = controller.signal;

await idleDetector.start({
  threshold: 60_000,
  signal,
});
console.log("IdleDetector is active.");

Spezifikationen

Specification
Idle Detection API
# api-idledetector-start

Browser-Kompatibilität

BCD tables only load in the browser