CookieStoreManager: subscribe() 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.

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

Die subscribe()-Methode der CookieStoreManager Schnittstelle abonniert eine ServiceWorkerRegistration für Cookie-Änderungsereignisse.

Syntax

subscribe(subscriptions)

Parameter

subscriptions

Ein Array von Objekten, von denen jedes die folgenden Eigenschaften hat:

name: Ein String mit dem Namen eines Cookies.
url: Ein String mit der URL eines Cookie-Bereichs. Dieser kann enger sein als der Bereich der Service-Worker-Registrierung.

Rückgabewert

Ein Promise, das mit undefined aufgelöst wird, wenn das Abonnement abgeschlossen ist.

Ausnahmen

TypeError: Wird ausgelöst, wenn die in subscriptions übergebene URL nicht mit dem scope der Service-Worker-Registrierung übereinstimmt.

Beispiele

In diesem Beispiel abonniert die ServiceWorkerRegistration, die durch registration dargestellt wird, die Änderungsevents für das Cookie mit dem Namen "cookie1" mit einem Bereich von "/path1".

const subscriptions = [{ name: "cookie1", url: `/path1` }];
await registration.cookies.subscribe(subscriptions);

Die an die subscribe()-Methode übergebene URL kann enger sein als der Bereich der Service-Worker-Registrierung. Im folgenden Beispiel ist das Abonnement für /path/one/, sodass es Änderungsereignisse für Änderungen am ersten Cookie empfängt, aber nicht am zweiten.

registration.cookies.subscribe([{ name: "cookie1", url: "/path/one/" }]); // subscription
cookieStore.set({ name: "cookie1", value: "cookie-value", path: "/path/one/" }); // receives a change event
cookieStore.set({ name: "cookie1", value: "cookie-value", path: "/path/two/" }); // does not receive a change event

Spezifikationen

Specification
Cookie Store API # dom-cookiestoremanager-subscribe