cookies.get()
Die get()
-Methode der cookies
API ruft Informationen über ein einzelnes Cookie ab, basierend auf seinem Namen und der URL.
Wenn mehr als ein Cookie mit demselben Namen für eine gegebene URL existiert, wird das Cookie mit dem längsten Pfad zurückgegeben. Für Cookies mit gleicher Pfadlänge wird das Cookie mit der frühesten Erstellungszeit zurückgegeben. Falls kein passendes Cookie gefunden werden konnte, wird null
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 können, um ein Cookie zum Abrufen zu identifizieren. Es kann die folgenden Eigenschaften enthalten:firstPartyDomain
Optional-
Ein
string
, der die Erstanbieter-Domain darstellt, mit der das abzurufende Cookie verbunden ist. Diese Eigenschaft muss angegeben werden, wenn der Browser über "First-Party Isolation" verfügt. Siehe First-party isolation. name
-
Ein
string
, der den Namen des abzurufenden Cookies darstellt. partitionKey
Optional-
Ein
object
, das die Speicherpartition repräsentiert, die das Cookie enthält. Dieses Objekt mittopLevelSite
enthalten, um ein Cookie aus partitioniertem Speicher abzurufen. Andernfalls wird das Cookie aus unpartitioniertem Speicher zurückgegeben. Dieses Objekt enthält:topLevelSite
Optional-
Ein
string
, der die Erstanbieter-URL der Top-Level-Speicherpartition darstellt, die das Cookie enthält.
storeId
Optional-
Ein
string
, das die ID des Cookie Stores darstellt, in dem nach dem Cookie gesucht werden soll (wie voncookies.getAllCookieStores()
zurückgegeben). Standardmäßig wird der Cookie Store des aktuellen Ausführungskontexts verwendet. url
-
Ein
string
, der die URL darstellt, mit der das abzurufende Cookie verbunden ist. Dieses Argument kann eine vollständige URL sein, wobei alle Daten nach dem URL-Pfad ignoriert werden (z.B. die Abfragezeichenfolge). Wenn Host-Berechtigungen für diese URL nicht in der Manifest-Datei der Erweiterung angegeben sind, scheitert der API-Aufruf.
Rückgabewert
Browser-Kompatibilität
BCD tables only load in the browser
Beispiele
Dieses Beispiel versucht, das Cookie mit dem Namen "favorite-color" zu erhalten, das mit der URL des derzeit aktiven Tabs verbunden ist:
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);
Beispiel-Erweiterungen
Hinweis: Diese API basiert auf Chromium's chrome.cookies
API. Diese Dokumentation ist abgeleitet von cookies.json
im Chromium-Code.