cookies.Cookie
Le type Cookie
de l'API cookies
représente des informations sur un cookie HTTP.
Type
Les valeurs de ce type sont des objets, qui peuvent contenir les propriétés suivantes :
domain
-
Une
chaîne
représentant le domaine auquel appartient le cookie (par exemple "www.google.com", "example.com"). expirationDate
Facultatif-
Un
number
représentant la date d'expiration du cookie en tant que nombre de secondes depuis l'époque UNIX. Non fourni pour les cookies de session. firstPartyDomain
-
Une
chaîne
représentant le domaine de la première partie associé au cookie. Cela sera une chaine vide si le cookie a été défini alors que l'isolation de la première partie est désactivée. Voir Isolement de la première partie. hostOnly
-
Un
booléen
,true
si le cookie est un cookie hôte uniquement (c'est à dire que l'hôte de la requête doit correspondre exactement au domaine du cookie), oufalse
dans la case contraire. httpOnly
-
Un
booléen
,true
si le cookie est marqué comme HttpOnly (c'est à dire le cookie est inaccessible aux scripts côté client), oufalse
dans le cas contraire. name
-
Une
chaîne
représentant le nom du cookie. path
-
Une
chaîne
représentant le chemin du cookie. secure
-
Un
booléen
, true si le cookie est marqué comme sécurisé (c'est à dire que si sa portée est limitée aux canaux sécurisés, généralement HTTPS), oufalse
dans le cas contraire. session
-
Un
boolean
,true
si le cookie est un cookie de session, oufalse
s'il s'agit d'un cookie persistant avec une date expiration. sameSite
-
Une valeur
cookies.SameSiteStatus
qui indique l'état SameSite du cookie. storeId
-
Une
chaine
représentant l'ID du cookie store contenant ce cookie, tel que fourni parcookies.getAllCookieStores()
. value
-
Une
chaîne
représentant la valeur du cookie.
Compatibilité des navigateurs
BCD tables only load in the browser
Exemples
La plupart des méthodes de l'API cookies impliquent qu'un objet Cookie
soit utilisé en tant que paramètre d'entrée ou en tant que partie de la valeur retournée. Par exemple, un appel à cookies.getAll()
retourne un tableau d'objets Cookie
.
Dans l'exemple ci-dessous, nous avons demandé tous les cookies, puis enregistré quelque-unes des valeurs de chacun des objets 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}`);
}
}
var gettingAll = browser.cookies.getAll({});
gettingAll.then(logCookies);
Note :
Cette API est basée sur l'API Chromium chrome.cookies
. Cette documentation est dérivée de cookies.json
dans le code Chromium.
Les données de compatibilité relatives à Microsoft Edge sont fournies par Microsoft Corporation et incluses ici sous la licence Creative Commons Attribution 3.0 pour les États-Unis.