cookies.remove()
Die remove()
Methode des cookies
API löscht ein Cookie, basierend auf dessen Namen und URL.
Um diese Methode zu nutzen, muss eine Erweiterung die Berechtigung "cookies"
und die entsprechenden Hostberechtigungen besitzen. Lesen Sie „cookie“-Berechtigungen für mehr Details.
Wenn mehr als ein Cookie mit demselben Namen für eine URL existiert, wird das Cookie mit dem längsten Pfad gelöscht. Bei Cookies mit gleicher Pfadlänge wird das Cookie mit der frühesten Erstellungszeit gelöscht. Wenn kein übereinstimmendes Cookie gefunden wird, wird null
zurückgegeben.
Hinweis: Vor Firefox 133 wurde, wenn es mehr als ein Cookie mit demselben Namen gab, das Cookie mit der frühesten Erstellungszeit von Firefox 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 First-Party-Domain repräsentiert, mit der das zu löschende Cookie verknüpft ist. Diese Eigenschaft muss angegeben werden, wenn der Browser die First-Party-Isolation aktiviert hat. Siehe First-Party-Isolierung. name
-
Ein
string
, der den Namen des zu löschenden Cookies repräsentiert. partitionKey
Optional-
Ein
object
, das die Speicherpartition enthält, in der sich das Cookie befindet. Dieses Objekt anzugeben, um ein Cookie aus partitioniertem Speicher zu löschen. Dieses Objekt enthält:topLevelSite
Optional-
Ein
string
, der die First-Party-URL der obersten Site-Speicherpartition repräsentiert, die das Cookie enthält.
storeId
Optional-
Ein
string
, der die ID des Cookie-Speichers repräsentiert, in dem das Cookie gefunden werden soll. Wenn nicht angegeben, wird das Cookie im Cookie-Speicher des aktuellen Ausführungskontextes gesucht. url
-
Ein
string
, der die URL repräsentiert, die mit dem Cookie verknüpft ist. Der API-Aufruf schlägt fehl, wenn die Erweiterung keine Hostberechtigungen 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 kein Cookie gefunden wird, das dem details
-Parameter entspricht, wird das Promise mit null
erfüllt. Wenn der Aufruf fehlschlägt, wird das Promise mit einer Fehlermeldung abgelehnt.
Beispiele
Dieses Beispiel versucht, das Cookie mit dem Namen "favorite-color" zu entfernen, dessen URL mit der URL des Dokuments im aktiven Tab übereinstimmt:
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 Chromium's chrome.cookies
API. Diese Dokumentation ist abgeleitet von cookies.json
im Chromium-Code.