cookies.get()
La méthode get()
de l'API cookies
récupère les informations d'un seul cookie, par son nom et son URL.
Si plus d'un cookie portant le même nom existent 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 plus ancien cookie sera retourné. Si aucun cookie ne correspond alors null
est retourné.
C'est une fonction asynchrone qui renvoie une Promise
.
Syntaxe
var getting = browser.cookies.get(
details, // object
);
Paramètres
details
-
Un
objet
contenant les informations pouvant être utilisées pour récupérer un cookie. Il peut inclure les propriétés suivantes :firstPartyDomain
Facultatif-
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. storeId
Facultatif-
Une
chaîne
représentant l'ID ducookie store
dans lequel rechercher le cookie (tel que renvoyé parcookies.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'hôte pour cette URL ne sont pas spécifiées dans le fichier manifeste de l'extension, l'appel de l'API échouera.
Valeur retournée
Compatibilité des navigateurs
BCD tables only load in the browser
Exemples
Cet 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
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.