cookies.remove()
Die remove()
Methode der cookies
API löscht ein Cookie, basierend auf dessen Namen und URL.
Der Aufruf ist nur erfolgreich, wenn Sie die "cookies" API-Berechtigung in Ihrer manifest.json Datei einbinden sowie Host-Berechtigungen für die in ihrem Manifest angegebene URL.
Dies ist eine asynchrone Funktion, die ein Promise
zurückgibt.
Syntax
let removing = browser.cookies.remove(
details // object
)
Parameter
details
-
Ein
object
, das Informationen zur Identifizierung des zu entfernenden Cookies enthält. Es enthält die folgenden Eigenschaften:firstPartyDomain
Optional-
Ein
string
, der die First-Party-Domain darstellt, mit der das zu entfernende Cookie verknüpft ist. 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 entfernenden Cookies darstellt. partitionKey
Optional-
Ein
object
, das die Speicherpartition enthält, die das Cookie enthält. Schließen Sie dieses Objekt ein, um ein Cookie aus partitioniertem Speicher zu entfernen. Dieses Objekt enthält:topLevelSite
Optional-
Ein
string
, der die First-Party-URL der obersten Site-Speicherpartition darstellt, die das Cookie enthält.
storeId
Optional-
Ein
string
, der die ID des Cookie-Speichers darstellt, in dem das Cookie gefunden werden soll. Wenn nicht angegeben, wird standardmäßig im Cookie-Speicher des aktuellen Ausführungskontextes nach dem Cookie gesucht. url
-
Ein
string
, der die URL darstellt, die mit dem Cookie verknüpft ist. Wenn die Erweiterung keine Host-Berechtigungen für diese URL hat, schlägt der API-Aufruf fehl.
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 werden kann, wird das Promise mit null
erfüllt. Wenn der Aufruf aus irgendeinem Grund fehlschlägt, wird das Promise mit einer Fehlermeldung abgelehnt.
Browser-Kompatibilität
BCD tables only load in the browser
Beispiele
Dieses Beispiel versucht, das Cookie mit dem Namen "favorite-color" zu entfernen, dessen URL mit der URL des Dokuments des derzeit aktiven Tabs ü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
Hinweis:
Diese API basiert auf Chromiums chrome.cookies
API. Diese Dokumentation ist abgeleitet von cookies.json
im Chromium-Code.