cookies.get()

La méthode get() de l'API cookies  récupère des informations sur un seul cookie, compte tenu de son nom et de son URL.

Si plus d'un cookie portant le même nom existe pour une URL donnée, celui contenant le chemin le plus long sera retourné. Pour les cookies ayant la même longueur de chemin, le cookie avec la première heure sera retourné. Si aucun cookie correspondant n'a pu être trouvé, null sera retourné.

C'est une fonction asynchrome qui renvoie une Promise.

Syntaxe

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

Paramètres

details
Un objet contenant des détails pouvant être utilisés pour faire correspondre un cookie à extraire. Il peut inclure les propriétés suivantes :
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. Voir Isolement de la première partie.
name
Une chaîne représentant le nom du cookie  à récupérer.
storeIdFacultatif
Une chaîne représentant l'ID du cookie store dans lequel rechercher le cookie (tel que renvoyé par  cookies.getAllCookieStores()). Par défault, le cookie store du contexte d'exécution actuel sera utilisé.
url
Une chaîne représentant l'URL avec laquelle le cookie à récupérer est associé. Cet argument peut être une URL complète, auquel cas toute donnée suivant le chemin d'URL (par exemple la chaîne de requête) est simplement ignorée. Si les   permissions d'hote pour cette URL ne sont pas spécifiées dans le fichier manifest de l'extension, l'appel de l'API échouera.

Valeur retournée

Une Promise qui sera remplie avec un objet Cookie contenant des détails sur le cookie, ou null si le cookie n'a pas été trouvé.

Compatibilité du navigateur

Update compatibility data on GitHub
OrdinateurMobile
ChromeEdgeFirefoxOperaFirefox pour Android
Support simpleChrome Support complet OuiEdge Support complet 14Firefox Support complet 45
Notes
Support complet 45
Notes
Notes Provides access to cookies from private browsing mode and container tabs since version 52.
Opera Support complet OuiFirefox Android Support complet 48
firstPartyDomainChrome Aucun support NonEdge Aucun support NonFirefox Support complet 59Opera Aucun support NonFirefox Android Support complet 59

Légende

Support complet  
Support complet
Aucun support  
Aucun support
Voir les notes d'implémentation.
Voir les notes d'implémentation.

Exemples

Cette exemple tente d'obtenir le cookie nommé "favourite-colour", associé à l'URL de l'onglet actuellement actif :

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

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

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

Example extensions

Remerciements :

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.

Étiquettes et contributeurs liés au document

Contributeurs à cette page : hellosct1
Dernière mise à jour par : hellosct1,