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 vor der Verwendung auf produktiven Webseiten.

Hinweis: Diese Funktion ist in Dedicated Web Workers verfügbar.

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

Syntax

js
start()
start(options)

Parameter

options Optional

Ein Objekt mit den folgenden Eigenschaften:

threshold

Die minimale Anzahl von Ruhemillisekunden, bevor die Berichterstattung beginnen sollte.

signal

Eine Referenz zu einer AbortSignal Instanz, die es Ihnen ermöglicht, die Ruheerkennung abzubrechen.

Rückgabewert

Ein Promise.

Ausnahmen

NotAllowedError DOMException

Die Verwendung dieser Funktion wurde durch eine Permissions Policy blockiert.

Beispiele

Das folgende Beispiel zeigt, wie die Ruheerkennung mit dem options Argument gestartet wird. Es ruft eine Instanz von AbortSignal von einer Instanz von AbortController ab.

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