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 verwenden, muss eine Erweiterung die Berechtigung "cookies"
und die relevanten Hostberechtigungen haben. Weitere Informationen finden Sie unter cookie
permissions.
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 zuzuordnen. Eingeschlossene Eigenschaften sind wie folgt (siehe Cookie-Typ für weitere Informationen):domain
Optional-
Ein
string
, das eine Domain darstellt, der die Cookies zugeordnet sein müssen (sie können entweder mit dieser genauen Domain oder einer ihrer Subdomains verknüpft sein). firstPartyDomain
Optional-
Ein
string
, das die erste Partei-Domain darstellt, mit der das abzurufende Cookie verknüpft ist.Diese Eigenschaft muss angegeben werden, wenn der Browser die Isolation der ersten Partei aktiviert hat. Wenn Sie
null
übergeben, werden Cookies mit jedem Wert fürfirstPartyDomain
und Cookies ohne gesetztesfirstPartyDomain
in die Ergebnisse aufgenommen. Siehe Isolation der ersten Partei. name
Optional-
Ein
string
, das einen Namen darstellt, den die Cookies haben müssen. partitionKey
Optional-
Ein
object
, das definiert, aus welchen Speicherpartitionen die Cookies zurückgegeben werden sollen:- Wenn weggelassen, werden nur Cookies aus nicht partitioniertem Speicher zurückgegeben.
- Wenn enthalten ohne
topLevelSite
, werden alle Cookies aus partitioniertem und nicht partitioniertem Speicher zurückgegeben. - Wenn enthalten mit dem spezifizierten
topLevelSite
, werden Cookies aus der angegebenen Partitionspeicherung zurückgegeben.
Dieses Objekt enthält:
topLevelSite
Optional-
Ein
string
, das die URL der ersten Partei des Top-Level-Speichers angibt, der die Cookies enthält.
path
Optional-
Ein
string
, das einen Pfad darstellt – der Cookie-Pfad muss mit diesem identisch sein. secure
Optional-
Ein
boolean
– filtert Cookies nach ihrersecure
-Eigenschaft und ermöglicht es Ihnen, sichere oder nicht sichere Cookies zu filtern. session
Optional-
Ein
boolean
– filtert die Cookies nach ihrersession
-Eigenschaft und ermöglicht es Ihnen, Sitzungs- oder dauerhafte Cookies zu filtern. storeId
Optional-
Ein
string
, das den Cookie-Store darstellt, aus dem Cookies abgerufen werden sollen. Wenn weggelassen, wird der Cookie-Store des aktuellen Ausführungskontexts verwendet. url
Optional-
Ein
string
, das eine URL darstellt, mit der die abgerufenen Cookies verknüpft sein müssen.
Rückgabewert
Ein Promise
, das mit einem Array von cookies.Cookie
-Objekten erfüllt wird, die zu den in den details
-Parametern angegebenen Eigenschaften passen. Nur nicht abgelaufene Cookies werden 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 wurden die Cookies in Firefox nach der Erstellungszeit sortiert, wobei die früheste Erstellungszeit zuerst kam.
Beispiele
Dieses Beispiel ruft alle Cookies im Browser ab, die den Namen "favorite-color" haben. 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);
Beispielerweiterungen
Browser-Kompatibilität
Hinweis:
Diese API basiert auf Chromiums chrome.cookies
API. Diese Dokumentation ist abgeleitet von cookies.json
im Chromium-Code.