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 entsprechende Host-Berechtigungen haben. Siehe Cookie-Berechtigungen für weitere Details.
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 Cookies zu finden, die abgerufen werden sollen. Die enthaltenen Eigenschaften sind wie folgt (siehe Cookie-Typ für weitere Informationen dazu):domain
Optional-
Ein
string
, das eine Domain darstellt, mit der Cookies in Verbindung stehen müssen (sie können entweder mit dieser exakten Domain oder einer ihrer Subdomains verbunden sein). firstPartyDomain
Optional-
Ein
string
, das die First-Party-Domain repräsentiert, mit der das abzurufende Cookie verknüpft ist.Diese Eigenschaft muss angegeben werden, wenn der Browser die First-Party-Isolierung aktiviert hat. Wenn Sie
null
übergeben, werden Cookies mit einem beliebigen Wert fürfirstPartyDomain
und Cookies, diefirstPartyDomain
nicht gesetzt haben, in die Ergebnisse eingeschlossen. Siehe First-Party-Isolierung. name
Optional-
Ein
string
, der einen Namen darstellt, den die Cookies haben müssen. partitionKey
Optional-
Ein
object
, das definiert, welche Speicherpartitionen verwendet werden sollen, um Cookies abzurufen:- Wird dies weggelassen, werden nur Cookies aus nicht partitioniertem Speicher zurückgegeben.
- Wird dies ohne
topLevelSite
einbezogen, werden alle Cookies aus partitioniertem und nicht partitioniertem Speicher zurückgegeben. - Wenn es mit einem angegebenen
topLevelSite
einbezogen wird, werden Cookies aus dem angegebenen Partitionenspeicher zurückgegeben.
Dieses Objekt enthält:
topLevelSite
Optional-
Ein
string
, das die First-Party-URL der Top-Level-Site-Speicherpartition darstellt, die die Cookies enthält.
path
Optional-
Ein
string
, der einen Pfad repräsentiert - der Pfad der Cookies muss mit diesem identisch sein. secure
Optional-
Ein
boolean
— filtert Cookies nach ihrersecure
Eigenschaft und ermöglicht das Filtern von sicheren oder unsicheren Cookies. session
Optional-
Ein
boolean
— filtert die Cookies nach ihrersession
Eigenschaft und ermöglicht das Filtern von Sitzungs- oder persistenten Cookies. storeId
Optional-
Ein
string
, das den Cookie-Store repräsentiert, aus dem Cookies abgerufen werden sollen. Wird er weggelassen, wird der Cookie-Store des aktuellen Ausführungskontexts verwendet. url
Optional-
Ein
string
, das eine URL repräsentiert, mit der die abgerufenen Cookies in Verbindung stehen müssen.
Rückgabewert
Ein Promise
, das mit einem Array von
Objekten erfüllt wird, die den im cookies.Cookie
details
Parameter 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, kommen diejenigen mit der frühesten Erstellungszeit zuerst.
Hinweis: Vor Firefox 133 hat Firefox die Cookies nach der Erstellungszeit sortiert, wobei die früheste Erstellungszeit zuerst kam.
Beispiele
Dieses Beispiel ruft alle Cookies ab, die der Browser mit dem Namen "favorite-color" gespeichert hat. Wenn das Ergebnis zurückgegeben wird, druckt der Code den Wert jedes Ergebnisses in die Konsole.
function logCookies(cookies) {
for (const cookie of cookies) {
console.log(cookie.value);
}
}
browser.cookies
.getAll({
name: "favorite-color",
})
.then(logCookies);
Beispiel-Erweiterungen
Browser-Kompatibilität
BCD tables only load in the browser
Hinweis: Diese API basiert auf der chrome.cookies
API von Chromium. Diese Dokumentation ist von cookies.json
im Chromium-Code abgeleitet.