cookies.getAll()

Die getAll() Methode der cookies API ruft alle Cookies aus einem Cookie-Speicher ab, die den bereitgestellten Details entsprechen.

Um diese Methode zu verwenden, muss eine Erweiterung die Berechtigung "cookies" und relevante Host-Berechtigungen haben. Siehe Cookie-Berechtigungen für weitere Details.

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 zu abzufragende Cookies zuzuordnen. Die enthaltenen Eigenschaften sind wie folgt (siehe Cookie-Typ für weitere Informationen dazu):

domain Optional

Ein string, das eine Domäne repräsentiert, mit der Cookies verknüpft sein müssen (sie können mit dieser genauen Domäne oder einer ihrer Subdomänen verknüpft sein).

firstPartyDomain Optional

Ein string, das die Erstanbieter-Domäne repräsentiert, mit der das abzurufende Cookie verknüpft ist.

Diese Eigenschaft muss angegeben werden, wenn der Browser die Erstanbieter-Isolation aktiviert hat. Wenn Sie null übergeben, werden Cookies mit jedem Wert für firstPartyDomain und Cookies, die firstPartyDomain nicht gesetzt haben, in die Ergebnisse eingeschlossen. Siehe Erstanbieter-Isolation.

name Optional

Ein string, der einen Namen repräsentiert, den die Cookies haben müssen.

partitionKey Optional

Ein object, das definiert, aus welchen Speicherpartitionen 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 mit dem spezifizierten topLevelSite enthalten, werden Cookies aus dem spezifizierten Partitionsspeicher zurückgegeben.

Dieses Objekt enthält:

topLevelSite Optional

Ein string, der die Erstanbieter-URL der Top-Level-Website-Speicherpartition repräsentiert, 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 ihrer secure Eigenschaft, sodass Sie sichere oder nicht sichere Cookies filtern können.

session Optional

Ein boolean — filtert die Cookies nach ihrer session Eigenschaft, sodass Sie Sitzungscookies oder persistente Cookies filtern können.

storeId Optional

Ein string, das den Cookie-Speicher repräsentiert, aus dem Cookies abgerufen werden sollen. Wenn weggelassen, wird der Cookie-Speicher 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 den im Parameter details angegebenen Eigenschaften entsprechen. Es werden nur unverfallene 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, sind 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 war.

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.