Class Cookie

Namespace

WebDriverBiDi.Network

Assembly

WebDriverBiDi.dll

Represents a cookie in a web request or response.

public record Cookie : IEquatable<Cookie>

Inheritance

object

Cookie

Implements

IEquatable<Cookie>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

Cookie(Cookie)

protected Cookie(Cookie original)

Parameters

original Cookie

Properties

AdditionalData

Gets the read-only dictionary containing extra data returned for this cookie.

[JsonIgnore]
public ReceivedDataDictionary AdditionalData { get; }

Property Value

ReceivedDataDictionary

Domain

Gets the domain of the cookie.

[JsonPropertyName("domain")]
[JsonRequired]
[JsonInclude]
public string Domain { get; }

Property Value

string

EpochExpires

Gets the expiration time of the cookie as the total number of seconds elapsed since the start of the Unix epoch (1 January 1970 12:00AM UTC).

[JsonPropertyName("expiry")]
[JsonInclude]
public ulong? EpochExpires { get; }

Property Value

ulong?

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

Expires

Gets the expiration time of the cookie. An EpochExpires value too large to be represented by a DateTime is clamped to MaxValue. The value's Kind is always Utc, including when it is clamped.

[JsonIgnore]
public DateTime? Expires { get; }

Property Value

DateTime?

HttpOnly

Gets a value indicating whether the cookie is only available via HTTP headers (true), or if the cookie can be inspected and manipulated via JavaScript (false).

[JsonPropertyName("httpOnly")]
[JsonRequired]
[JsonInclude]
public bool HttpOnly { get; }

Property Value

bool

Name

Gets the name of the cookie.

[JsonPropertyName("name")]
[JsonRequired]
[JsonInclude]
public string Name { get; }

Property Value

string

Path

Gets the path of the cookie.

[JsonPropertyName("path")]
[JsonRequired]
[JsonInclude]
public string Path { get; }

Property Value

string

SameSite

Gets a value indicating whether the cookie is a same-site cookie.

[JsonPropertyName("sameSite")]
[JsonRequired]
[JsonInclude]
public CookieSameSiteValue SameSite { get; }

Property Value

CookieSameSiteValue

Secure

Gets a value indicating whether the cookie is secure, delivered via an encrypted connection like HTTPS.

[JsonPropertyName("secure")]
[JsonRequired]
[JsonInclude]
public bool Secure { get; }

Property Value

bool

Size

Gets the byte length of the cookie when serialized in an HTTP cookie header.

[JsonPropertyName("size")]
[JsonRequired]
[JsonInclude]
public ulong Size { get; }

Property Value

ulong

Value

Gets the value of the cookie.

[JsonPropertyName("value")]
[JsonRequired]
[JsonInclude]
public BytesValue Value { get; }

Property Value

BytesValue

Methods

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

Equals(Cookie?)

public virtual bool Equals(Cookie? other)

Parameters

other Cookie

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

PrintMembers(StringBuilder)

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToSetCookieHeader()

Converts this cookie to a SetCookieHeader.

public SetCookieHeader ToSetCookieHeader()

Returns

SetCookieHeader

The SetCookieHeader representing this cookie.

ToString()

public override string ToString()

Returns

string

Operators

operator ==(Cookie?, Cookie?)

public static bool operator ==(Cookie? left, Cookie? right)

Parameters

left Cookie

right Cookie

Returns

bool

operator !=(Cookie?, Cookie?)

public static bool operator !=(Cookie? left, Cookie? right)

Parameters

left Cookie

right Cookie

Returns

bool