cookies.Cookie
Der Cookie
-Typ der cookies
-API repräsentiert Informationen über ein HTTP-Cookie.
Typ
Werte dieses Typs sind Objekte, die folgende Eigenschaften enthalten können:
domain
-
Ein
string
, der die Domäne angibt, zu der das Cookie gehört (z. B. "www.google.com" oder "example.com"). expirationDate
Optional-
Eine
number
, die das Ablaufdatum des Cookies als Anzahl der Sekunden seit dem UNIX-Epoch darstellt. Nicht bei Sitzungscookies angegeben. firstPartyDomain
-
Ein
string
, der die Erstanbieterdomäne angibt, die mit dem Cookie verknüpft ist. Dies ist ein leerer String, wenn das Cookie gesetzt wurde, während die Erstanbieter-Isolation deaktiviert war. Siehe First-party isolation. hostOnly
-
Ein
boolean
,true
, wenn das Cookie ein Host-Only-Cookie ist (d. h. der Host der Anfrage muss genau mit der Domäne des Cookies übereinstimmen), oderfalse
andernfalls. httpOnly
-
Ein
boolean
,true
, wenn das Cookie als HttpOnly markiert ist (d. h. das Cookie ist für clientseitige Skripte unzugänglich), oderfalse
andernfalls. name
-
Ein
string
, der den Namen des Cookies darstellt. partitionKey
Optional-
Ein
object
, das die Beschreibung der Speicherpartition enthält, die das Cookie enthält. Dieses Objekt wird weggelassen (null), wenn das Cookie nicht in partitioniertem Speicher ist. Dieses Objekt enthält die folgenden Eigenschaften:topLevelSite
-
Ein
string
, der die Erstanbieter-URL der Speicherpartition des Cookies darstellt, falls das Cookie in einem Speicher ist, der nach Top-Level-Sites partitioniert ist.
path
-
Ein
string
, der den Pfad des Cookies darstellt. secure
-
Ein
boolean
,true
, wenn das Cookie als sicher markiert ist (d. h. sein Anwendungsbereich ist auf sichere Kanäle, typischerweise HTTPS, beschränkt), oderfalse
andernfalls. session
-
Ein
boolean
,true
, wenn das Cookie ein Sitzungscookie ist, oderfalse
, wenn es ein dauerhaftes Cookie mit einem Ablaufdatum ist. sameSite
-
Ein
cookies.SameSiteStatus
-Wert, der den SameSite-Zustand des Cookies angibt. storeId
-
Ein
string
, das die ID des Cookie-Speichers darstellt, der dieses Cookie enthält, wie voncookies.getAllCookieStores()
bereitgestellt. value
-
Ein
string
, der den Wert des Cookies darstellt.
Beispiele
Die meisten Methoden in der Cookies-API beinhalten ein Cookie
-Objekt als Eingabeparameter oder als Teil des Rückgabewerts. Zum Beispiel gibt ein Aufruf von cookies.getAll()
ein Array von Cookie
-Objekten zurück.
Dieses Beispiel fragt nach allen Cookies und protokolliert dann einige der Werte aus jedem der resultierenden Cookie
-Objekte:
function logCookies(cookies) {
for (cookie of cookies) {
console.log(`Domain: ${cookie.domain}`);
console.log(`Name: ${cookie.name}`);
console.log(`Value: ${cookie.value}`);
console.log(`Persistent: ${!cookie.session}`);
}
}
let gettingAll = browser.cookies.getAll({});
gettingAll.then(logCookies);
Browser-Kompatibilität
BCD tables only load in the browser
Hinweis: Diese API basiert auf Chromium's chrome.cookies
API. Diese Dokumentation stammt aus cookies.json
im Chromium-Code.