cookies.getAll()

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

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 können, um die abzurufenden Cookies zu filtern. Die enthaltenen Eigenschaften sind wie folgt (siehe Cookie-Typ für weitere Informationen dazu):

domain Optional

Ein string, der eine Domain darstellt, mit der die Cookies verknüpft sein müssen (sie können entweder mit dieser exakten Domain oder einer ihrer Subdomains verknüpft sein).

firstPartyDomain Optional

Ein string, der die zugehörige First-Party-Domain darstellt.

Diese Eigenschaft muss angegeben werden, wenn im Browser die Isolation von First-Parties aktiviert ist. Sie können jedoch in diesem Fall null übergeben. Wenn Sie dies tun, werden Cookies mit jedem Wert für firstPartyDomain, sowie Cookies, die firstPartyDomain überhaupt nicht gesetzt haben, in die Ergebnisse aufgenommen. Siehe First-Party-Isolation.

name Optional

Ein string, der einen Namen darstellt, den die Cookies haben sollten.

partitionKey Optional

Ein object, das definiert, aus welchen Speicherpartitionen Cookies zurückgegeben werden sollen:

  • wenn ausgelassen, werden nur Cookies aus nicht partitionierten Speicher zurückgegeben.
  • wenn ohne topLevelSite eingeschlossen, werden alle Cookies aus partitionierten und nicht partitionierten Speicher zurückgegeben.
  • wenn mit angegebenem topLevelSite eingeschlossen, werden Cookies aus dem angegebenen Partitionsspeicher zurückgegeben.

Dieses Objekt enthält:

topLevelSite Optional

Ein string, der die First-Party-URL der Top-Level-Sitespeicherpartition darstellt, die die Cookies enthält.

path Optional

Ein string, der einen Pfad darstellt — der Pfad des Cookies muss mit diesem identisch sein.

secure Optional

Ein boolean — filtert Cookies nach ihrer secure Eigenschaft, sodass Sie sichere Cookies vs. nicht sichere Cookies filtern können.

session Optional

Ein boolean — filtert die Cookies nach ihrer session Eigenschaft, sodass Sie Sitzungs-Cookies vs. persistente Cookies filtern können.

storeId Optional

Ein string, der den Cookie-Speicher darstellt, aus dem Cookies abgerufen werden sollen. Wenn ausgelassen, wird der Cookie-Speicher des aktuellen Ausführungskontexts verwendet.

url Optional

Ein string, der 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 den im details Parameter angegebenen Eigenschaften entsprechen. Es werden nur nicht abgelaufene Cookies zurückgegeben. Die zurückgegebenen Cookies werden nach der Pfadlänge sortiert, von der längsten zur kürzesten. Wenn mehrere Cookies die gleiche Pfadlänge aufweisen, kommen die mit der frühesten Erstellungszeit zuerst.

Browser-Kompatibilität

BCD tables only load in the browser

Beispiele

Im folgenden Codeausschnitt machen wir einen Aufruf, um alle Cookies abzurufen, die der Browser derzeit gespeichert hat und die den Namen "favorite-color" haben. Wenn das Ergebnis zurückgegeben wird, drucken wir den Wert jedes Ergebnisses auf die Konsole.

js
function logCookies(cookies) {
  for (const cookie of cookies) {
    console.log(cookie.value);
  }
}

browser.cookies
  .getAll({
    name: "favorite-color",
  })
  .then(logCookies);

Beispiel-Erweiterungen

Hinweis: Diese API basiert auf der Chromiums chrome.cookies API. Diese Dokumentation ist abgeleitet von cookies.json im Chromium-Code.