cookies.remove()
Die remove()
Methode der cookies
API löscht ein Cookie, basierend auf seinem Namen und der URL.
Um diese Methode zu verwenden, muss eine Erweiterung die Berechtigung "cookies"
und relevante Host-Berechtigungen besitzen. Weitere Details finden Sie unter cookie
Berechtigungen.
Wenn es mehr als ein Cookie mit demselben Namen für eine URL gibt, wird das Cookie mit dem längsten Pfad gelöscht. Bei Cookies mit derselben Pfadlänge wird das Cookie mit der frühesten Erstellungszeit gelöscht. Wenn kein passendes Cookie gefunden wird, wird null
zurückgegeben.
Hinweis: Vor Firefox 133 wurde, wenn es mehr als ein Cookie mit demselben Namen gab, von Firefox das Cookie mit der frühesten Erstellungszeit gelöscht.
Dies ist eine asynchrone Funktion, die ein Promise
zurückgibt.
Syntax
let removing = browser.cookies.remove(
details // object
)
Parameter
details
-
Ein
object
, das Informationen enthält, um das zu löschende Cookie zu identifizieren. Es enthält folgende Eigenschaften:firstPartyDomain
Optional-
Ein
string
, der die mit dem zu löschenden Cookie assoziierte first-party Domain darstellt. Diese Eigenschaft muss angegeben werden, wenn der Browser First-Party Isolation aktiviert hat. Siehe First-party Isolation. name
-
Ein
string
, der den Namen des zu löschenden Cookies darstellt. partitionKey
Optional-
Ein
object
, das die Storage-Partition enthält, die das Cookie enthält. Dieses Objekt muss angegeben werden, um ein Cookie aus partitioniertem Speicher zu entfernen. Dieses Objekt enthält:topLevelSite
Optional-
Ein
string
, das die first-party URL der obersten Speicherpartition, die das Cookie enthält, darstellt.
storeId
Optional-
Ein
string
, das die ID des Cookie-Speichers, in dem das Cookie gefunden werden soll, darstellt. Wenn nicht angegeben, wird das Cookie im Cookie-Speicher des aktuellen Ausführungskontexts gesucht. url
-
Ein
string
, der die mit dem Cookie assoziierte URL darstellt. Der API-Aufruf schlägt fehl, wenn die Erweiterung keine Host-Berechtigungen für diese URL hat.
Rückgabewert
Ein Promise
, das mit einem cookies.Cookie
Objekt erfüllt wird, das Details über das entfernte Cookie enthält. Wenn ein Cookie, das dem details
-Parameter entspricht, nicht gefunden wird, wird das Versprechen mit null
erfüllt. Wenn der Aufruf fehlschlägt, wird das Versprechen mit einer Fehlermeldung abgelehnt.
Beispiele
Dieses Beispiel versucht, das Cookie mit dem Namen "favorite-color" zu entfernen, dessen URL mit der URL des Dokuments übereinstimmt, das vom aktiven Tab gehostet wird:
function onRemoved(cookie) {
console.log(`Removed: ${cookie}`);
}
function onError(error) {
console.log(`Error removing cookie: ${error}`);
}
function removeCookie(tabs) {
let removing = browser.cookies.remove({
url: tabs[0].url,
name: "favorite-color",
});
removing.then(onRemoved, onError);
}
let getActive = browser.tabs.query({ active: true, currentWindow: true });
getActive.then(removeCookie);
Beispielerweiterungen
Browser-Kompatibilität
Hinweis:
Diese API basiert auf Chromiums chrome.cookies
API. Diese Dokumentation ist abgeleitet von cookies.json
im Chromium Code.