cookies.get()
Die get()
-Methode der cookies
API ruft Informationen über ein Cookie ab, basierend auf dem Namen und der URL des Cookies.
Um diese Methode zu nutzen, muss eine Erweiterung die Berechtigung "cookies"
und die entsprechenden Host-Berechtigungen haben. Weitere Informationen 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 zurückgegeben. Bei Cookies mit gleicher Pfadlänge wird das Cookie mit der frühesten Erstellungszeit ausgegeben. Wenn kein passendes Cookie gefunden wird, wird null
zurückgegeben.
Hinweis: Vor Firefox 133 wurde bei mehr als einem Cookie mit demselben Namen das Cookie mit der frühesten Erstellungszeit zurückgegeben.
Dies ist eine asynchrone Funktion, die ein Promise
zurückgibt.
Syntax
let getting = browser.cookies.get(
details // object
)
Parameter
details
-
Ein
object
, das Details enthält, die verwendet werden, um ein abzurufendes Cookie zu identifizieren. Es kann folgende Eigenschaften enthalten:firstPartyDomain
Optional-
Ein
string
, der die Erstanbieterdomäne repräsentiert, mit der das abzurufende Cookie verbunden ist. Diese Eigenschaft muss angegeben werden, wenn der Browser die Isolation für Erstanbieter aktiviert hat. Siehe Erstanbieter-Isolierung. name
-
Ein
string
, der den Namen des abzurufenden Cookies repräsentiert. partitionKey
Optional-
Ein
object
, das die Speicherpartition repräsentiert, die das Cookie enthält. Schließen Sie dieses Objekt mittopLevelSite
ein, um ein Cookie aus partitioniertem Speicher zu erhalten. Andernfalls wird das Cookie aus nicht partitioniertem Speicher zurückgegeben. Dieses Objekt enthält:topLevelSite
Optional-
Ein
string
, der die Erstanbieter-URL des Top-Level-Site-Speicherbereichs repräsentiert, der das Cookie enthält.
storeId
Optional-
Ein
string
, der die ID des Cookie-Speichers repräsentiert, in dem nach dem Cookie gesucht werden soll (wie voncookies.getAllCookieStores()
zurückgegeben). Standardmäßig wird der Cookie-Speicher des aktuellen Ausführungskontexts verwendet. url
-
Ein
string
, der die URL repräsentiert, mit der das abzurufende Cookie verbunden ist. Dieses Argument kann eine vollständige URL sein, wobei alle Daten nach dem URL-Pfad (z. B. die Abfragezeichenkette) ignoriert werden. Wenn Host-Berechtigungen für diese URL nicht in der Manifestdatei der Erweiterung angegeben sind, schlägt der API-Aufruf fehl.
Rückgabewert
Beispiele
Dieses Beispiel versucht, das Cookie mit dem Namen "favorite-color", das mit der URL des aktiven Tabs verbunden ist, abzurufen:
function logCookie(cookie) {
if (cookie) {
console.log(cookie.value);
}
}
function getCookie(tabs) {
let getting = browser.cookies.get({
url: tabs[0].url,
name: "favorite-color",
});
getting.then(logCookie);
}
let getActive = browser.tabs.query({
active: true,
currentWindow: true,
});
getActive.then(getCookie);
Beispielerweiterungen
Browser-Kompatibilität
Hinweis:
Diese API basiert auf der chrome.cookies
API von Chromium. Diese Dokumentation stammt aus cookies.json
im Chromium-Code.