cookies.getAll()
Die getAll()
Methode der cookies
API ruft alle Cookies aus einem Cookie-Store ab, die den angegebenen Details entsprechen.
Um diese Methode zu nutzen, muss eine Erweiterung die Berechtigung "cookies"
und relevante Host-Berechtigungen besitzen. Sehen Sie für weitere Details die Cookie-Berechtigungen ein.
Dies ist eine asynchrone Funktion, die ein Promise
zurückgibt.
Syntax
let getting = browser.cookies.getAll(
details // object
)
Parameter
details
-
Ein
object
, das Details enthält, die verwendet werden, um die abzurufenden Cookies zu identifizieren. Die enthaltenen Eigenschaften sind wie folgt (siehe Cookie-Typ für weitere Informationen hierzu):domain
Optional-
Ein
string
, das eine Domain darstellt, mit der die Cookies verbunden sein müssen (sie können entweder mit dieser genauen Domain oder einem ihrer Subdomains verbunden sein). firstPartyDomain
Optional-
Ein
string
, das die Erstparteien-Domain darstellt, mit der das abzurufende Cookie verbunden ist.Diese Eigenschaft muss angegeben werden, wenn der Browser die Isolierung der Erstpartei aktiviert hat. Wenn Sie
null
übergeben, sind Cookies mit jedem Wert fürfirstPartyDomain
und Cookies, die keinfirstPartyDomain
gesetzt haben, in den Ergebnissen enthalten. Sehen Sie Isolation der Erstpartei. name
Optional-
Ein
string
, das einen Namen darstellt, den die Cookies haben müssen. partitionKey
Optional-
Ein
object
, das definiert, aus welchen Speicherpartitionen Cookies zurückgegeben werden sollen:- Falls weggelassen, werden nur Cookies aus unpartitioniertem Speicher zurückgegeben.
- Falls enthalten ohne
topLevelSite
, werden alle Cookies aus partitioniertem und unpartitioniertem Speicher zurückgegeben. - Falls enthalten mit der angegebenen
topLevelSite
, werden Cookies aus dem angegebenen Partitionsspeicher zurückgegeben.
Dieses Objekt enthält:
topLevelSite
Optional-
Ein
string
, das die Erstparteien-URL der Top-Level-Site-Speicherpartition darstellt, die die Cookies enthält.
path
Optional-
Ein
string
, das einen Pfad darstellt — der Pfad der Cookies muss mit diesem übereinstimmen. secure
Optional-
Ein
boolean
— filtert Cookies nach ihrersecure
Eigenschaft, sodass Sie sichere oder nicht sichere Cookies filtern können. session
Optional-
Ein
boolean
— filtert die Cookies nach ihrersession
Eigenschaft, sodass Sie Session- oder persistente Cookies filtern können. storeId
Optional-
Ein
string
, der den Cookie-Store darstellt, aus dem Cookies abgerufen werden sollen. Falls weggelassen, wird der Cookie-Store des aktuellen Ausführungskontextes verwendet. url
Optional-
Ein
string
, das eine URL darstellt, mit der die abgerufenen Cookies verbunden sein müssen.
Rückgabewert
Ein Promise
, das mit einem Array von cookies.Cookie
Objekten erfüllt wird, die den im Parameter details
angegebenen Eigenschaften entsprechen. Es werden nur nicht abgelaufene Cookies zurückgegeben. Die zurückgegebenen Cookies sind nach Pfadlänge sortiert, von der längsten zur kürzesten. Wenn mehrere Cookies die gleiche Pfadlänge haben, werden die mit der frühesten Erstellungszeit zuerst zurückgegeben.
Hinweis: Vor Firefox 133 gab Firefox die Cookies nach Erstellungszeit sortiert zurück, mit der frühesten Erstellungszeit zuerst.
Beispiele
Dieses Beispiel ruft alle Cookies ab, die der Browser mit dem Namen "favorite-color" gespeichert hat. Wenn das Ergebnis zurückgegeben wird, gibt der Code den Wert jedes Ergebnisses in die Konsole aus.
function logCookies(cookies) {
for (const cookie of cookies) {
console.log(cookie.value);
}
}
browser.cookies
.getAll({
name: "favorite-color",
})
.then(logCookies);
Beispielerweiterungen
Browser-Kompatibilität
Loading…
Hinweis:
Diese API basiert auf Chromiums chrome.cookies
API. Diese Dokumentation basiert auf cookies.json
im Chromium-Code.