cookies.get()

Метод get() API cookies извлекает информацию об одном cookie, заданном по имени и URL.

Если для данного URL существует более одного cookie с одинаковым именем, будет возвращено cookie с самым длинным путем. Для cookie с одинаковой длиной пути будет возвращено cookie с самой ранней датой создания. Если соответствующий cookie не найден, возвращается null.

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

Синтаксис

let getting = browser.cookies.get(
  details                // object
)

Параметры

details

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

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

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

name

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

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

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

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

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

Значение string представляющее идентификатор cookie store, в котором следует искать cookie (как возвращается cookies.getAllCookieStores()). По умолчанию используется cookie-хранилище текущего контекста выполнения.

url

Строка string представляющая URL, с которым связано извлекаемое cookie. Этот аргумент может быть полным URL, в этом случае любая информация, следующая за путем URL (например, строка запроса), игнорируется. Если разрешения на хостинг для этого URL не указаны в файле манифеста расширения, вызов API завершится ошибкой.

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

Объект Promise, который будет выполнен с объектом Cookie, содержащим информацию о cookie, или null если cookie не найден.

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

	Рабочий стол						Мобильный
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	WebView Android	Chrome Android	Firefox for Android	Opera Android	Safari на IOS	Samsung Internet
`get`	Да	14	45 Предоставляет доступ к cookie из режима инкогнито и контейнерных вкладок с версии 52.	?	Да	14 HTTPOnly cookie не извлекаются.	?	?	48	?	15 HTTPOnly cookie не извлекаются.	?
`firstPartyDomain`	Нет	Нет	59	?	Нет	Нет	?	?	59	?	Нет	?
`partitionKey`	Нет	Нет	94	?	Нет	Нет	?	?	94	?	Нет	?

Примеры

Этот пример пытается получить cookie с именем "favorite-color", связанный с URL текущей активной вкладки:

function logCookie(cookie) {
  if (cookie) {
    console.log(cookie.value);
  }
}

function getCookie(tabs) {
  let getting = browser.cookies.get({
    url: tabs[0].url,
    name: "favorite-color"
  });
  getting.then(logCookie);
}

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

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

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/get