CookieStoreManager: unsubscribe() method

可用性有限

此特性不是基线特性,因为它在一些最广泛使用的浏览器中不起作用。

安全上下文: 此功能仅在安全上下文(HTTPS)中可用,且支持此功能的浏览器数量有限。

注意:此功能在 Service Workers 中可用。

CookieStoreManager 接口的 unsubscribe() 方法会阻止 ServiceWorkerRegistration 接收先前已订阅的事件。

语法

js
unsubscribe(subscriptions)

参数

subscriptions

一个对象列表,每个对象包含:

name

一个包含 cookie 名称的字符串。

url

用于订阅此 cookie 的范围的 URL 字符串。

返回值

当 service worker 取消订阅时,解析为 undefinedPromise

异常

TypeError

如果 subscriptions 中传入的 URL 与 service worker 注册的 scope 不匹配,则会抛出此错误。

示例

在此示例中,由 registration 表示的 ServiceWorkerRegistration 正在取消订阅范围为 "/path1" 的名为 "cookie1" 的 cookie 上的更改事件。

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

规范

规范
Cookie Store API
# dom-cookiestoremanager-unsubscribe

浏览器兼容性