ServiceWorkerRegistration: showNotification() Methode

title

Definiert einen Titel für die Benachrichtigung, der oben im Benachrichtigungsfenster angezeigt wird.

options Optional

Ein Optionsobjekt, das benutzerdefinierte Einstellungen enthält, die Sie auf die Benachrichtigung anwenden möchten. Die möglichen Optionen sind:

actions Optional Experimentell

Ein Array von Aktionen, die in der Benachrichtigung angezeigt werden sollen, wobei das Standardwert ein leeres Array ist. Jedes Element im Array kann ein Objekt mit den folgenden Mitgliedern sein:

action

Ein String, der eine Benutzeraktion identifiziert, die in der Benachrichtigung angezeigt werden soll.

title

Ein String, der den Aktions-Text enthält, der dem Benutzer angezeigt werden soll.

icon Optional

Ein String, der die URL eines Symbols enthält, das mit der Aktion angezeigt werden soll.

Angemessene Reaktionen werden unter Verwendung von event.action innerhalb des notificationclick-Ereignisses erstellt.

badge Optional Experimentell

Ein String, der die URL des Bildes enthält, das die Benachrichtigung repräsentiert, wenn nicht genügend Platz vorhanden ist, um die Benachrichtigung selbst anzuzeigen; beispielsweise die Android-Benachrichtigungsleiste. Auf Android-Geräten sollte das Abzeichen für Geräte bis zu einer 4x-Auflösung, etwa 96x96px, geeignet sein, und das Bild wird automatisch maskiert werden.

body Optional

Ein String, der den Textkörper der Benachrichtigung darstellt, der unter dem Titel angezeigt wird. Der Standard ist der leere String.

data Optional Experimentell

Beliebige Daten, die Sie mit der Benachrichtigung verknüpfen möchten. Dies kann jeder strukturklonbare Datentyp sein. Der Standard ist null.

dir Optional

Die Richtung, in der die Benachrichtigung angezeigt werden soll. Der Standard ist auto, was einfach das Spracheinstellungsverhalten des Browsers übernimmt, aber Sie können dieses Verhalten überschreiben, indem Sie die Werte ltr und rtl einstellen (obwohl die meisten Browser diese Einstellungen zu ignorieren scheinen).

icon Optional

Ein String, der die URL eines Symbols enthält, das in der Benachrichtigung angezeigt werden soll.

image Optional Experimentell

Ein String, der die URL eines Bildes enthält, das in der Benachrichtigung angezeigt werden soll.

lang Optional

Die Sprache der Benachrichtigung, wie sie durch einen String festgelegt wird, der ein Sprach-Tag gemäß RFC 5646: Tags for Identifying Languages (auch bekannt als BCP 47) darstellt. Siehe die Sitepoint-Seite ISO 2 letter language codes für eine einfache Referenz. Der Standard ist der leere String.

renotify Optional Experimentell

Ein boolescher Wert, der angibt, ob der Benutzer benachrichtigt werden soll, nachdem eine neue Benachrichtigung eine alte ersetzt hat. Der Standard ist false, was bedeutet, dass sie nicht benachrichtigt werden. Wenn true, muss auch tag gesetzt sein.

requireInteraction Optional Experimentell

Gibt an, dass eine Benachrichtigung aktiv bleiben soll, bis der Benutzer sie anklickt oder ablehnt, anstatt automatisch zu schließen. Der Standardwert ist false.

silent Optional

Ein boolescher Wert, der angibt, ob die Benachrichtigung stumm (keine Töne oder Vibrationen werden ausgegeben), unabhängig von den Geräteeinstellungen, ist. Der Standard null bedeutet, die Gerätestandards zu respektieren. Wenn true, darf vibrate nicht vorhanden sein.

tag Optional

Ein String, der ein identifizierendes Tag für die Benachrichtigung darstellt. Der Standard ist der leere String.

timestamp Optional

Ein Zeitstempel, der als Unix-Zeit in Millisekunden angegeben ist und die mit der Benachrichtigung verknüpfte Zeit darstellt. Dies könnte in der Vergangenheit liegen, wenn eine Benachrichtigung für eine Nachricht verwendet wird, die nicht sofort zugestellt werden konnte, weil das Gerät offline war, oder in der Zukunft für ein Meeting, das gleich beginnt.

vibrate Optional Experimentell

Ein Vibrationsmuster für die Vibrationshardware des Geräts zur Ausgabe mit der Benachrichtigung. Wenn angegeben, darf silent nicht true sein.

Ein Promise das sich auf undefined auflöst.

TypeError

Wird ausgelöst, wenn:

• Der aktuelle Status des Service Workers nicht activating oder activated ist.
• Der Benutzer die Anfrage des Browsers, die API zu verwenden, ausdrücklich abgelehnt hat.
• Die silent Option true ist und die vibrate Option angegeben ist.
• Die renotify Option true ist, aber die tag Option leer ist.

DataCloneError DOMException

Wird ausgelöst, wenn die Serialisierung der Option data aus irgendeinem Grund fehlgeschlagen ist.

navigator.serviceWorker.register("sw.js");

function showNotification() {
  Notification.requestPermission().then((result) => {
    if (result === "granted") {
      navigator.serviceWorker.ready.then((registration) => {
        registration.showNotification("Vibration Sample", {
          body: "Buzz! Buzz!",
          icon: "../images/touch/chrome-touch-icon-192x192.png",
          vibrate: [200, 100, 200, 100, 200, 100, 200],
          tag: "vibration-sample",
        });
      });
    }
  });
}

Um die obige Funktion zu einem geeigneten Zeitpunkt aufzurufen, könnten Sie das notificationclick-Ereignis anhören.

Sie können auch Details zu den Notifications abrufen, die vom aktuellen Service Worker ausgelöst wurden, indem Sie ServiceWorkerRegistration.getNotifications() verwenden.