chrome-devtools-kotlin/org.hildan.chrome.devtools.domains.network/SetCookieRequest

SetCookieRequest

@Serializable

data class SetCookieRequest(val name: String, val value: String, val url: String? = null, val domain: String? = null, val path: String? = null, val secure: Boolean? = null, val httpOnly: Boolean? = null, val sameSite: CookieSameSite? = null, val expires: TimeSinceEpoch? = null, val priority: CookiePriority? = null, val sameParty: Boolean? = null, val sourceScheme: CookieSourceScheme? = null, val sourcePort: Int? = null, val partitionKey: String? = null)

Request object containing input parameters for the NetworkDomain.setCookie command.

Constructors

SetCookieRequest

constructor(name: String, value: String, url: String? = null, domain: String? = null, path: String? = null, secure: Boolean? = null, httpOnly: Boolean? = null, sameSite: CookieSameSite? = null, expires: TimeSinceEpoch? = null, priority: CookiePriority? = null, sameParty: Boolean? = null, sourceScheme: CookieSourceScheme? = null, sourcePort: Int? = null, partitionKey: String? = null)

Types

Builder

class Builder(val name: String, val value: String)

A builder for SetCookieRequest, which allows setting the optional parameters of the NetworkDomain.setCookie command via a lambda.

Properties

domain

val domain: String? = null

Cookie domain.

expires

val expires: TimeSinceEpoch? = null

Cookie expiration date, session cookie if not set

httpOnly

val httpOnly: Boolean? = null

True if cookie is http-only.

name

val name: String

Cookie name.

partitionKey

val partitionKey: String? = null

Cookie partition key. The site of the top-level URL the browser was visiting at the start of the request to the endpoint that set the cookie. If not set, the cookie will be set as not partitioned.

path

val path: String? = null

Cookie path.

priority

val priority: CookiePriority? = null

Cookie Priority type.

sameParty

val sameParty: Boolean? = null

True if cookie is SameParty.

sameSite

val sameSite: CookieSameSite? = null

Cookie SameSite type.

secure

val secure: Boolean? = null

True if cookie is secure.

sourcePort

val sourcePort: Int? = null

Cookie source port. Valid values are {-1, 1, 65535}, -1 indicates an unspecified port. An unspecified port value allows protocol clients to emulate legacy cookie scope for the port. This is a temporary ability and it will be removed in the future.

sourceScheme

val sourceScheme: CookieSourceScheme? = null

Cookie source scheme type.

url

val url: String? = null

The request-URI to associate with the setting of the cookie. This value can affect the default domain, path, source port, and source scheme values of the created cookie.

value

val value: String

Cookie value.