cookies.get()

Die get() Methode der cookies API ruft Informationen über ein Cookie ab, basierend auf dem Namen des Cookies und der URL.

Um diese Methode zu verwenden, muss eine Erweiterung die Berechtigung "cookies" und relevante Host-Berechtigungen haben. Weitere Details finden Sie unter cookie permissions.

Wenn es mehr als ein Cookie mit demselben Namen für eine URL gibt, wird das Cookie mit dem längsten Pfad zurückgegeben. Für Cookies mit gleicher Pfadlänge wird das Cookie mit der frühesten Erstellungszeit zurückgegeben. Wenn kein entsprechendes Cookie gefunden wird, wird null zurückgegeben.

Hinweis: Vor Firefox 133 gab Firefox bei mehreren Cookies mit demselben Namen das Cookie mit der frühesten Erstellungszeit zurück.

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

Syntax

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

Parameter

details

Ein object, das Details enthält, die verwendet werden, um ein Cookie zu identifizieren. Es kann diese Eigenschaften umfassen:

firstPartyDomain Optional

Ein string, der die Erstanbieter-Domain darstellt, mit der das abzurufende Cookie verknüpft ist. Diese Eigenschaft muss angegeben werden, wenn der Browser die First-Party-Isolation aktiviert hat. Siehe First-party isolation.

name

Ein string, der den Namen des abzurufenden Cookies darstellt.

partitionKey Optional

Ein object, das die Speicherpartition darstellt, die das Cookie enthält. Fügen Sie dieses Objekt mit topLevelSite hinzu, um ein Cookie aus partitioniertem Speicher zu erhalten. Andernfalls wird das Cookie aus dem nicht partitionierten Speicher zurückgegeben. Dieses Objekt enthält:

topLevelSite Optional

Ein string, der die Erstanbieter-URL der übergeordneten Site-Speicherpartition darstellt, die das Cookie enthält.

storeId Optional

Ein string, der die ID des Cookie-Stores darstellt, in dem nach dem Cookie gesucht werden soll (wie zurückgegeben von cookies.getAllCookieStores()). Standardmäßig wird der Cookie-Store des aktuellen Ausführungskontextes verwendet.

url

Ein string, der die URL darstellt, mit der das abzurufende Cookie verknüpft ist. Dieses Argument kann eine vollständige URL sein, wobei alle Daten nach dem URL-Pfad (z.B. die Abfragezeichenfolge) ignoriert werden. Wenn Host-Berechtigungen für diese URL nicht in der Manifestdatei der Erweiterung angegeben sind, schlägt der API-Aufruf fehl.

Rückgabewert

Ein Promise, das mit einem Cookie-Objekt erfüllt wird, das Details über das Cookie enthält, oder null, wenn das Cookie nicht gefunden wird.

Beispiele

Dieses Beispiel versucht, das Cookie mit dem Namen "favorite-color" abzurufen, das mit der URL des aktiven Tabs verknüpft ist:

js
function logCookie(cookie) {
  if (cookie) {
    console.log(cookie.value);
  }
}

function getCookie(tabs) {
  let getting = browser.cookies.get({
    url: tabs[0].url,
    name: "favorite-color",
  });
  getting.then(logCookie);
}

let getActive = browser.tabs.query({
  active: true,
  currentWindow: true,
});
getActive.then(getCookie);

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 stammt aus cookies.json im Chromium-Code.