Spec-Zone.ru › Web Extensions

cookies.remove()

Метод remove() API cookies удаляет cookie, задав её имя и URL.

Вызов выполняется успешно только если вы включили разрешение «cookies» API-разрешение в вашем файле manifest.json, а также разрешения на доступ к хосту для указанного в манифесте URL.

Это асинхронная функция, которая возвращает Promise.

Синтаксис

let removing = browser.cookies.remove(
  details               // object
)

Параметры

details

Объект object содержащий информацию для идентификации cookie для удаления. Он содержит следующие свойства:

firstPartyDomain Необязательно

Строка string представляющая домен первого уровня, с которым связана cookie для удаления. Это свойство необходимо, если в браузере включена изоляция первого уровня. См. Изоляция первого уровня.

name

Строка string представляющая имя cookie для удаления.

partitionKey Необязательно

Объект object представляющий разделение хранилища, содержащее cookie. Включите этот объект, чтобы удалить cookie из разделенного хранилища. Этот объект содержит:

topLevelSite Необязательно

Строка string представляющая URL первого уровня сайта, разделение хранилища которого содержит cookie.

storeId Необязательно

Строка string представляющая идентификатор хранилища cookie, в котором нужно найти cookie. Если не указано, cookie ищется по умолчанию в хранилище cookie текущего контекста выполнения.

url

Строка string представляющая URL, связанный с cookie. Если у расширения нет разрешений доступа к хосту для этого URL, вызов API завершится ошибкой.

Возвращаемое значение

Обещание Promise, которое будет выполнено с объектом cookies.Cookie, содержащим сведения об удаленной cookie. Если cookie, соответствующая параметру details, не найдена, обещание выполняется со значением null. Если вызов завершается ошибкой по какой-либо причине, обещание будет отклонено с сообщением об ошибке.

Совместимость с браузерами

Рабочий стол Мобильные устройства
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari на iOS Samsung Internet
remove Да 14
45В версиях до 56 эта функция не удаляла cookie из режима приватного просмотра. С версии 56 это исправлено.
? Да 14 ? ?
48В версиях до 56 эта функция не удаляла cookie из режима приватного просмотра. С версии 56 это исправлено.
? 15 ?
firstPartyDomain Нет Нет 59 ? Нет Нет ? ? 59 ? Нет ?
partitionKey Нет Нет 94 ? Нет Нет ? ? 94 ? Нет ?

Примеры

В этом примере пытаются удалить cookie с именем «favorite-color», чей URL соответствует URL документа, размещенного в текущей вкладке:

function onRemoved(cookie) {
  console.log(`Removed: ${cookie}`);
}

function onError(error) {
  console.log(`Error removing cookie: ${error}`);
}

function removeCookie(tabs) {
  let removing = browser.cookies.remove({
    url: tabs[0].url,
    name: "favorite-color"
  });
  removing.then(onRemoved, onError);
}

let getActive = browser.tabs.query({active: true, currentWindow: true});
getActive.then(removeCookie);

Примеры расширений

  • cookie-bg-picker

Примечание: Этот API основан на API chrome.cookies Chromium. Данная документация получена из cookies.json в коде Chromium.

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/cookies/remove

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API