cookies.set()

Syntax

let setting = browser.cookies.set(
  details               // object
)

Parameter

details

Ein object, das die Details des Cookies enthält, das Sie setzen möchten. Es kann diese Eigenschaften haben:

domain Optional

Ein string, das die Domäne des Cookies darstellt. Wenn weggelassen, wird das Cookie zu einem Host-spezifischen Cookie.

expirationDate Optional

Eine number, die das Ablaufdatum des Cookies als Anzahl der Sekunden seit dem UNIX-Epoch darstellt. Wenn weggelassen, wird das Cookie zu einem Sitzungs-Cookie.

firstPartyDomain Optional

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

httpOnly Optional

Ein boolean, der angibt, ob das Cookie als HttpOnly (true) markiert ist oder nicht (false). Wenn weggelassen, ist der Standardwert false.

name Optional

Ein string, der den Namen des Cookies darstellt. Wenn weggelassen, ist dieser Wert standardmäßig leer.

partitionKey Optional

Ein object, das die Storage-Partition darstellt, in der das Cookie gesetzt wird. Dieses Objekt ist einzuschließen, um ein Cookie in partitioniertem Speicher zu setzen. Dieses Objekt enthält:

topLevelSite Optional

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

path Optional

Ein string, der den Pfad des Cookies darstellt. Wenn weggelassen, ist der Standardwert der Pfadanteil des URL-Parameters.

sameSite Optional

Ein cookies.SameSiteStatus Wert, der den SameSite-Zustand des Cookies angibt. Wenn weggelassen, ist der Standardwert unspecified.

secure Optional

Ein boolean, der angibt, ob das Cookie als sicher (true) markiert ist oder nicht (false). Wenn weggelassen, ist der Standardwert false.

storeId Optional

Ein string, das die ID des Cookie-Stores darstellt, in dem das Cookie gesetzt wird. Wenn weggelassen, wird das Cookie im Cookie-Store des aktuellen Ausführungskontexts gesetzt.

url

Ein string, das die Request-URI darstellt, die mit dem Cookie verknüpft ist. Dieser Wert kann die Standard-Domäne und die Pfadwerte des erstellten Cookies beeinflussen. Wenn für diese URL keine Host-Berechtigungen in der Manifestdatei angegeben sind, schlägt der Methodenaufruf fehl.

value Optional

Ein string, der den Wert des Cookies darstellt. Wenn weggelassen, ist dieser Wert standardmäßig leer.

Rückgabewert

Ein Promise, das mit einem cookies.Cookie Objekt erfüllt wird, das Details über das gesetzte Cookie enthält.

Wenn für eine URL mehr als ein Cookie mit demselben Namen vorhanden ist, wird das Cookie mit dem längsten Pfad zurückgegeben. Für Cookies mit derselben Pfadlänge wird das Cookie mit der frühesten Erstellungszeit zurückgegeben.

Wenn der Anruf fehlschlägt, wird das Promise mit einer Fehlermeldung abgelehnt.

Beispiele

Dieses Beispiel setzt ein Cookie für das Dokument, das im aktiven Tab gehostet wird:

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

function setCookie(tabs) {
  browser.cookies.set({
    url: tabs[0].url,
    name: "favorite-color",
    value: "red",
  });
}

Beispielerweiterungen

• cookie-bg-picker

Browser-Kompatibilität