CookieStoreManager

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

安全なコンテキスト用: この機能は一部またはすべての対応しているブラウザーにおいて、安全なコンテキスト (HTTPS) でのみ利用できます。

Experimental: これは実験的な機能です。
本番で使用する前にブラウザー互換性一覧表をチェックしてください。

「Cookie Store API」の CookieStoreManager インターフェイスは、サービスワーカーが Cookie 変更イベントを購読できるようにします。変更イベントを受け取るには、特定のサービスワーカーの登録で subscribe() を呼びます。

CookieStoreManager には、関連づいた ServiceWorkerRegistration があります。それぞれのサービスワーカーの登録には、Cookie 変更購読リストがあります。これは、それぞれが名前と URL を持つ Cookie 変更購読のリストです。このインターフェイスのメソッドにより、サービスワーカーはこのリストに購読を追加したり、リストから購読を削除したり、すべての購読のリストを取得したりできます。

CookieStoreManager を得るには、ServiceWorkerRegistration.cookies を参照します。

インスタンスメソッド

CookieStoreManager.getSubscriptions()

このサービスワーカーの登録の Cookie 変更購読のリストで解決する promise を返します。

CookieStoreManager.subscribe()

Cookie の変更を購読します。購読に成功したら解決する promise を返します。

CookieStoreManager.unsubscribe()

このサービスワーカーの登録の Cookie の変更の購読を解除します。操作に成功したら解決する promise を返します。

例

この例では、registration で表される ServiceWorkerRegistration が、名前が "cookie1" でスコープが "/path1" である Cookie の変更イベントを購読します。

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

ServiceWorkerRegistration が既に何か Cookie を購読している場合は、getSubscriptions() はもとの購読で用いるのと同じ形式のオブジェクトで表された Cookie のリストを返します。

js
const subscriptions = await registration.cookies.getSubscriptions();

仕様書

Specification
Cookie Store API
# cookiestoremanager

ブラウザーの互換性

BCD tables only load in the browser