WakeLock: request() 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.

Die request()-Methode der WakeLock-Schnittstelle gibt ein Promise zurück, das mit einem WakeLockSentinel-Objekt erfüllt wird, wenn das System-Screen-Wake-Lock gewährt wird.

Das Screen-Wake-Lock verhindert, dass sich Gerätebildschirme dimmen oder sperren, wenn eine Anwendung weiter ausgeführt werden muss.

Syntax

js
request(type)

Parameter

type Optional

Ein String, der den Typ des Screen-Wake-Locks angibt. Folgende enumerierte Typen sind möglich:

screen

Verhindert, dass der Bildschirm abschaltet. Nur sichtbare Dokumente können das Screen-Wake-Lock erwerben.

Wenn kein type-Parameter explizit angegeben wird, verwendet die request()-Methode standardmäßig den screen-Typ.

Rückgabewert

Ein Promise, das mit einem WakeLockSentinel-Objekt erfüllt wird.

Ausnahmen

NotAllowedError DOMException

Wird ausgelöst, wenn das Wake-Lock nicht verfügbar ist, was aus folgenden Gründen passieren kann:

  • Die Nutzung dieser Funktion wird durch eine Permissions Policy blockiert.
  • Das Dokument ist nicht vollständig aktiv.
  • Der Sichtbarkeitsstatus des Dokuments ist hidden.
  • Der User Agent konnte das plattformspezifische Wake-Lock nicht erwerben. Dies kann zum Beispiel passieren, wenn das Gerät wenig Akkulaufzeit hat.

Beispiele

Die folgende asynchrone Funktion fordert ein WakeLockSentinel-Objekt an. Die request()-Methode ist in eine try...catch-Anweisung eingebettet, um Fälle zu behandeln, in denen der Browser die Anfrage aus irgendeinem Grund ablehnt.

js
const requestWakeLock = async () => {
  try {
    const wakeLock = await navigator.wakeLock.request("screen");
  } catch (err) {
    // The wake lock request fails - usually system-related, such as low battery.

    console.log(`${err.name}, ${err.message}`);
  }
};

requestWakeLock();

Das Screen-Wake-Lock kann vom Gerät widerrufen werden, nachdem es gewährt wurde. Das zurückgegebene WakeLockSentinel kann verwendet werden, um den Status des Locks zu überprüfen und/oder das gehaltene Screen-Wake-Lock manuell zu beenden.

Spezifikationen

Specification
Screen Wake Lock API
# the-request-method

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch