cookies.Cookie
Тип Cookie API cookies представляет информацию об HTTP-cookie.
Тип
Значения этого типа — объекты, которые могут содержать следующие свойства:
domain-
Строка, представляющая домен, к которому относится cookie (например, "www.google.com", "example.com").
-
expirationDateНеобязательно -
Число, представляющее дату истечения срока действия cookie в виде количества секунд с момента эпохи Unix. Не предоставляется для сессионных cookie.
firstPartyDomain-
Строка, представляющая домен первого уровня, связанный с cookie. Будет пустой строкой, если cookie был установлен при отключённой изоляции домена первого уровня. См. Изоляцию домена первого уровня.
hostOnly-
Булево значение,
trueесли cookie является cookie только для хоста (т. е. хост запроса должен точно совпадать с доменом cookie), илиfalseв противном случае. httpOnly-
Булево значение,
trueесли cookie помечен как HttpOnly (т. е. cookie недоступен для скриптов на стороне клиента), илиfalseв противном случае. name-
Строка, представляющая имя cookie.
-
partitionKeyНеобязательно -
Объект, представляющий описание раздела хранилища, содержащего cookie. Этот объект опущен (null), если cookie не находится в разделе хранилища. Этот объект содержит следующие свойства:
topLevelSite-
Строка, представляющая URL первого уровня раздела хранилища cookie, если cookie хранится в разделе, разделяемом сайтом верхнего уровня.
path-
Строка, представляющая путь cookie.
secure-
Булево значение,
trueесли cookie помечен как безопасный (т. е. его область ограничена безопасными каналами, обычно HTTPS), илиfalseв противном случае. session-
Булево значение,
trueесли cookie является сессионным cookie, илиfalseесли это постоянное cookie с датой истечения. sameSite-
Значение
cookies.SameSiteStatus, указывающее состояние SameSite cookie. storeId-
Число, представляющее идентификатор хранилища cookie, содержащего этот cookie, как указано в
cookies.getAllCookieStores(). value-
Строка, представляющая значение cookie.
Совместимость с браузерами
| Рабочие столы | Мобильные устройства | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
Cookie |
Да | 14 | 45 | ? | Да | 14 | ? | ? | 48 | ? | 15 | ? |
firstPartyDomain |
Нет | Нет | 59 | ? | Нет | Нет | ? | ? | 59 | ? | Нет | ? |
partitionKey |
Нет | Нет | 94 | ? | Нет | Нет | ? | ? | 94 | ? | Нет | ? |
sameSite |
Да | 79 | 63 | ? | Нет | 14Поддерживает только явное. |
? | ? | 63 | ? | 15Поддерживает только явное. |
? |
Примеры
Большинство методов API cookies используют объект Cookie в качестве входного параметра или части возвращаемого значения. Например, вызов cookies.getAll() возвращает массив объектов Cookie.
В примере ниже мы запросили все cookie, а затем вывели некоторые значения каждого из полученных объектов Cookie:
function logCookies(cookies) { for (cookie of cookies) { console.log(`Domain: ${cookie.domain}`); console.log(`Name: ${cookie.name}`); console.log(`Value: ${cookie.value}`); console.log(`Persistent: ${!cookie.session}`); } } let gettingAll = browser.cookies.getAll({}); gettingAll.then(logCookies);
Примечание: Этот 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/Cookie