cookies.remove()

La méthode remove() de l'API cookies supprime un cookie, compte tenu de son nom et de son URL.

L'appel réussit uniquement si vous incluez la permission de l'API "cookies" dans votre fichier manifest.json, ainsi que les permissions d'hôte pour l'URL indiquée dans son manifest.

C'est une fonction asynchrone qui renvoie une Promise.

Syntaxe

var removing = browser.cookies.remove(
  details, // object
);

Paramètres

details

Un objet contenant des informations permettant d'identifier le cookie à supprimer. Il contient les propriétés suivantes :

firstPartyDomainFacultatif: Une chaîne représentant le domaine de première partie avec lequel le cookie sera 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ésenant le nom du cookie à supprimer.
storeIdFacultatif: Une chaîne représentant l'ID du cookie store pour trouver le cookie. Si elle n'est pas spécifiée, le cookie est recherché par défaut dans le cookie store du contexte d'exécution actuel.
url: Une chaîne représentant l'URL associée au cookie. Si l'extension n'a pas de permissions d'hôte pour cette URL, l'appel de l'API échouera.

Une Promise qui sera remplie avec un objet cookies.Cookie contenant des détails sur le cookie qui a été supprimé. Si un cookie correspondant au paramètre details n'a pas pu être trouvé, la promesse est remplie avec null. Si l'appel échoue pour une raison quelconque, la promesse sera rejetée avec un message d'erreur.

Compatibilité des navigateurs

Exemples

Cet exemple tente de supprimer le cookie nommé "favourite-colour", dont l'URL correspond à l'URL du document hébergé par l'onglet actuellement actif :

function onRemoved(cookie) {
  console.log(`Removed: ${cookie}`);
}

function onError(error) {
  console.log(`Error removing cookie: ${error}`);
}

function removeCookie(tabs) {
  var removing = browser.cookies.remove({
    url: tabs[0].url,
    name: "favourite-colour",
  });
  removing.then(onRemoved, onError);
}

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