cookies.getAll()
Метод getAll() API cookies извлекает все cookie из одного хранилища cookie, которые соответствуют заданной информации.
Это асинхронная функция, которая возвращает Promise.
Синтаксис
let getting = browser.cookies.getAll( details // object )
Параметры
details-
Объект
objectсодержащий детали, которые могут быть использованы для сопоставления cookie для извлечения. Включаемые свойства следующие (см. Тип Cookie для получения дополнительной информации):-
domainНеобязательно -
Строка
stringпредставляющая домен, с которым должны быть связаны cookie (они могут быть связаны либо с этим доменом, либо с одним из его поддоменов). -
firstPartyDomainНеобязательно -
Строка
stringпредставляющая домен первого уровня, с которым связана извлекаемая cookie.Это свойство должно быть предоставлено, если в браузере включена изоляция первого уровня. Однако вы можете передать
nullв этой ситуации. Если вы это сделаете, cookie с любым значением дляfirstPartyDomain, а также cookie, у которыхfirstPartyDomainне задано вообще, будут включены в результаты. См. Изоляция первого уровня. -
nameНеобязательно -
Строка
stringпредставляющая имя, которое должны иметь cookie. -
partitionKeyНеобязательно -
Объект
objectопределяющий, из каких разделов хранилища извлекать cookie:- если опущено, возвращает только cookie из неопределенного хранилища.
- если указано без
topLevelSite, возвращает все cookie из разделенных и неразделенных хранилищ. - если указано с
topLevelSite, возвращает cookie из указанного раздела хранилища.
Этот объект содержит:
-
topLevelSiteНеобязательно -
Строка
stringпредставляющая URL-адрес сайта верхнего уровня, в разделе хранилища которого содержатся cookie.
-
pathНеобязательно -
Строка
stringпредставляющая путь — путь cookie должен быть идентичен этому. -
secureНеобязательно -
Булевое значение
boolean— фильтрует cookie по их свойствуsecure, позволяя фильтровать защищенные cookie по сравнению с незащищенными cookie. -
sessionНеобязательно -
Булевое значение
boolean— фильтрует cookie по их свойствуsession, позволяя фильтровать cookie сессии по сравнению с постоянными cookie. -
storeIdНеобязательно -
Строка
stringпредставляющая хранилище cookie, из которого необходимо извлечь cookie. Если опущено, будет использоваться хранилище cookie текущего контекста выполнения. -
urlНеобязательно -
Строка
stringпредставляющая URL-адрес, с которым должны быть связаны извлеченные cookie.
-
Возвращаемое значение
Объект Promise, который будет выполнен с массивом объектов, которые соответствуют свойствам, указанным в параметре cookies.Cookiedetails. Возвращаются только неистекшие cookie. Возвращаемые cookie будут отсортированы по длине пути, от длинного к короткому. Если у нескольких cookie длина пути одинаковая, первыми будут те, которые были созданы раньше.
Совместимость с браузерами
| Рабочий стол | Мобильные устройства | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari на IOS | Samsung Internet | |
getAll |
Да | 14Если URL не указан, cookie извлекаются только для URL-адресов в открытых вкладки. В Chrome это извлекает все cookie на компьютере пользователя. |
45До версии 52 список 'tabIds' был пустым, и возвращались только cookie из хранилища cookie по умолчанию. Начиная с версии 52, это было исправлено, и результат включает cookie из режима приватного просмотра и вкладок контейнеров. |
? | Да | 14["Только cookie в хранилище cookie по умолчанию извлекаются.", "HTTPOnly cookie не извлекаются."] |
? | ? | 48 | ? | 15["Только cookie в хранилище cookie по умолчанию извлекаются.", "HTTPOnly cookie не извлекаются."] |
? |
firstPartyDomain |
Нет | Нет | 59 | ? | Нет | Нет | ? | ? | 59 | ? | Нет | ? |
partitionKey |
Нет | Нет | 94 | ? | Нет | Нет | ? | ? | 94 | ? | Нет | ? |
Примеры
В следующем фрагменте мы вызываем функцию для получения всех cookie, которые в данный момент хранятся в браузере и имеют имя "favorite-color". При возврате результата мы выводим значение каждого результата в консоль.
function logCookies(cookies) { for (const cookie of cookies) { console.log(cookie.value); } } browser.cookies .getAll({ name: "favorite-color", }) .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/getAll