cookies.get()

Syntax

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

Parameter

details

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

firstPartyDomain Optional

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

name

Ein string, der den Namen des abzurufenden Cookies repräsentiert.

partitionKey Optional

Ein object, das die storage partition beschreibt, die das Cookie enthält. Schließen Sie dieses Objekt mit topLevelSite ein, um ein Cookie aus partitioniertem Speicher zu erhalten. Ansonsten wird das Cookie aus nicht partitioniertem Speicher zurückgegeben. Dieses Objekt enthält:

topLevelSite Optional

Ein string, der die First-Party-URL der obersten Site-Speicherpartition enthält, die das Cookie enthält.

storeId Optional

Ein string, der die ID des cookie store repräsentiert, in dem das Cookie gesucht werden soll (wie von cookies.getAllCookieStores() zurückgegeben). Standardmäßig wird der Cookie-Speicher des aktuellen Ausführungskontexts verwendet.

url

Ein string, das die URL repräsentiert, 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. der Abfrage-String) 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, der 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" zu erhalten, das mit der URL des aktiven Tabs verknüpft ist:

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);

Beispielerweiterungen

• cookie-bg-picker

Browser-Kompatibilität