cookies.getAll()

La méthode getAll() de l'API cookies récupère tous les cookies d'un seul cookie store qui correspondent aux informations fournies.

C'est une fonction asynchrone qui renvoie une Promise.

Syntaxe

js
var getting = browser.cookies.getAll(
  details, // object
);

Paramètres

details

Un object contenant des détails pouvant être utilisés pour faire correspondre les cookies à extraire. Les propriétés incluses sont les suivantes (voir type de cookie pour plus d'informations sur celles-ci ) :

domainFacultatif

Une chaîne représentant un domaine auquel les cookies doivent être associés (ils peuvent être associés soit à ce domaine exact, soit à l'un de ses sous-domaines).

firstPartyDomainFacultatif

Une chaîne représentant le domaine de première partie avec lequel le cookie à récupérer est associé. Cette propriété doit être fournie si l'isolation de la première partie est activée sur le navigateur. Vous pouvez cependant passer null dans cette situation. Si vous faites cela, alors les cookies avec n'importe quelle valeur pour firstPartyDomain, ainsi que les cookies qui n'ont pas de set firstPartyDomain , seront inclus dans les résultats. Voir Isolement de la première partie.

nameFacultatif

Une chaîne représentant un nom que les cookies devraient avoir.

pathFacultatif

Une chaîne représentant un chemin - le chemin des cookies doit être identique à celui-ci.

secureFacultatif

Un booléen — filtre les cookies par leur propriété sécurisée, vous permettant de filtrer les cookies sécurisés contre les cookies non sécurisés.

sessionFacultatif

Un booléen — filtre les cookies en fonction de leur propriété de session, ce qui vous permet de filtrer les cookies de session par rapport aux cookies persistants.

storeIdFacultatif

Une chaîne représentant le magasin de cookies pour récupérer les cookies. S'il est omi, le cookie store du contexte d'exécution actuel sera utilisé.

urlFacultatif

Une chaîne représentant une URL à laquelle les cookies récupérés doivent être associés.

Valeur retournée

Une Promise qui sera remplie avec un tableau d'objets cookies.Cookie correspondant aux propriétés données dans le paramètre details. Seuls les cookies non expirés sont renvoyés. Les cookies retournés seront triés par longueur de chemin, du plus long au plus court. Si plusieurs cookies ont la même longueur de chemin, ceux dont l'heure de création est la plus proche seront les premiers.

Compatibilité des navigateurs

BCD tables only load in the browser

Exemples

Dans l'extrait suivant, nous appelons pour obtenir tous les cookies que le navigateur a actuellement stockés qui ont un nom de "favourite-colour". Lorsque le résultat est renvoyé, nous imprimons la valeur de chaque résultat à la console.

js
function logCookies(cookies) {
  for (let cookie of cookies) {
    console.log(cookie.value);
  }
}

var gettingAll = browser.cookies.getAll({
  name: "favourite-colour",
});
gettingAll.then(logCookies);

Example extensions

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.