PushSubscription

Baseline 2023

Newly available

Since March 2023, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

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

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

Das PushSubscription-Interface der Push API bietet die URL-Endpunkt einer Subscription und ermöglicht das Abmelden von einem Push-Dienst.

Eine Instanz dieses Interfaces kann serialisiert werden.

Instanzeigenschaften

PushSubscription.endpoint Schreibgeschützt

Eine Zeichenkette, die den mit der Push-Subscription verknüpften Endpunkt enthält.

PushSubscription.expirationTime Schreibgeschützt

Ein DOMHighResTimeStamp der Ablaufzeit der Subscription, wenn vorhanden, oder null andernfalls.

PushSubscription.options Schreibgeschützt

Ein Objekt mit den Optionen, die zum Erstellen der Subscription verwendet wurden.

PushSubscription.subscriptionId Schreibgeschützt

Eine Zeichenkette, die die mit der Push-Subscription verknüpfte Subscription-ID enthält.

Instanzmethoden

PushSubscription.getKey()

Gibt einen ArrayBuffer zurück, der den öffentlichen Schlüssel des Clients enthält, der dann an einen Server gesendet und zur Verschlüsselung von Push-Nachrichtendaten verwendet werden kann.

PushSubscription.toJSON()

Standard-Serializer — gibt eine JSON-Darstellung der Subscription-Eigenschaften zurück.

PushSubscription.unsubscribe()

Startet den asynchronen Prozess des Abmeldens vom Push-Dienst und gibt ein Promise zurück, das sich zu einem booleschen Wert auflöst, wenn die aktuelle Subscription erfolgreich abgemeldet wurde.

Beispiel

js
navigator.serviceWorker.ready.then((reg) => {
  reg.pushManager.getSubscription().then((subscription) => {
    subscription
      .unsubscribe()
      .then((successful) => {
        // You've successfully unsubscribed
      })
      .catch((e) => {
        // Unsubscribing failed
      });
  });
});

Spezifikationen

Specification
Push API
# pushsubscription-interface

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch