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 relevante Host-Berechtigungen haben. Siehe cookie-Berechtigungen für weitere Informationen.

Dies ist eine asynchrone Funktion, die ein Promise zurückgibt.

Syntax

js
let getting = browser.cookies.getAll(
  details                // object
)

Parameter

details

Ein object, das Details enthält, die verwendet werden, um passende Cookies abzurufen. Die enthaltenen Eigenschaften sind wie folgt (siehe Cookie-Typ für weitere Informationen dazu):

domain Optional

Ein string, welches eine Domain repräsentiert, mit der die Cookies assoziiert sein müssen (sie können entweder mit dieser genauen Domain oder einer ihrer Subdomains assoziiert sein).

firstPartyDomain Optional

Ein string, das die First-Party-Domain darstellt, mit der das abzurufende Cookie assoziiert ist.

Diese Eigenschaft muss bereitgestellt werden, wenn der Browser die First-Party-Isolation aktiviert hat. Wenn Sie null übergeben, werden Cookies mit jedem Wert für firstPartyDomain und Cookies, die kein firstPartyDomain gesetzt haben, in die Ergebnisse einbezogen. Siehe First-Party-Isolation.

name Optional

Ein string, das einen Namen darstellt, den die Cookies haben müssen.

partitionKey Optional

Ein object, das definiert, welche Speicherpartitionen zur Cookie-Rückgabe verwendet werden sollen:

  • Wenn weggelassen, werden nur Cookies aus unpartitioniertem Speicher zurückgegeben.
  • Wenn enthalten ohne topLevelSite, werden alle Cookies aus partitioniertem und unpartitioniertem Speicher zurückgegeben.
  • Wenn enthalten mit dem angegebenen topLevelSite, werden Cookies aus dem angegebenen Partition-Speicher zurückgegeben.

Dieses Objekt enthält:

topLevelSite Optional

Ein string, das die First-Party-URL der obersten Website beschreibt, die Speicher partitioniert und die Cookies enthält.

path Optional

Ein string, das einen Pfad repräsentiert — der Pfad der Cookies muss mit diesem identisch sein.

secure Optional

Ein boolean — filtert Cookies nach ihrer secure-Eigenschaft und ermöglicht das Filtern nach sicheren oder nicht sicheren Cookies.

session Optional

Ein boolean — filtert Cookies nach ihrer session-Eigenschaft und ermöglicht das Filtern nach Sitzungs- oder persistenten Cookies.

storeId Optional

Ein string, welches den Cookie-Store repräsentiert, aus dem die Cookies abgerufen werden sollen. Wenn nicht angegeben, wird der Cookie-Store des aktuellen Ausführungskontexts verwendet.

url Optional

Ein string, das eine URL repräsentiert, mit der die abgerufenen Cookies assoziiert sein müssen.

Rückgabewert

Ein Promise, das mit einem Array von cookies.Cookie Objekten erfüllt wird, die die in dem Parameter details angegebenen Eigenschaften erfüllen. 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 gab Firefox die Cookies sortiert nach Erstellungszeit zurück, 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, gibt der Code den Wert jedes Ergebnisses in der Konsole aus.

js
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 der chrome.cookies API von Chromium. Diese Dokumentation ist abgeleitet von cookies.json im Chromium-Code.