Cookie

class Cookie

An RFC 6265 Cookie.

This class doesn't support additional attributes on cookies, like Chromium's Priority=HIGH extension.

Types

Link copied to clipboard
class Builder

Builds a cookie. The name, value, and domain values must all be set before calling build.

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
@get:JvmName(name = "domain")
val domain: String

Returns the cookie's domain. If hostOnly returns true this is the only domain that matches this cookie; otherwise it matches this domain and all subdomains.

Link copied to clipboard
@get:JvmName(name = "expiresAt")
val expiresAt: Long

Returns the time that this cookie expires, in the same format as System.currentTimeMillis. This is December 31, 9999 if the cookie is not persistent, in which case it will expire at the end of the current session.

Link copied to clipboard
@get:JvmName(name = "hostOnly")
val hostOnly: Boolean

Returns true if this cookie's domain should be interpreted as a single host name, or false if it should be interpreted as a pattern. This flag will be false if its Set-Cookie header included a domain attribute.

Link copied to clipboard
@get:JvmName(name = "httpOnly")
val httpOnly: Boolean

Returns true if this cookie should be limited to only HTTP APIs. In web browsers this prevents the cookie from being accessible to scripts.

Link copied to clipboard
@get:JvmName(name = "name")
val name: String

Returns a non-empty string with this cookie's name.

Link copied to clipboard
@get:JvmName(name = "path")
val path: String

Returns this cookie's path. This cookie matches URLs prefixed with path segments that match this path's segments. For example, if this path is /foo this cookie matches requests to /foo and /foo/bar, but not / or /football.

Link copied to clipboard
@get:JvmName(name = "persistent")
val persistent: Boolean

Returns true if this cookie does not expire at the end of the current session.

Link copied to clipboard
@get:JvmName(name = "sameSite")
val sameSite: String?

Returns a string describing whether this cookie is sent for cross-site calls.

Link copied to clipboard
@get:JvmName(name = "secure")
val secure: Boolean

Returns true if this cookie should be limited to only HTTPS requests.

Link copied to clipboard
@get:JvmName(name = "value")
val value: String

Returns a possibly-empty string with this cookie's value.

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
@IgnoreJRERequirement
open override fun hashCode(): Int
Link copied to clipboard

Returns true if this cookie should be included on a request to url. In addition to this check callers should also confirm that this cookie has not expired.

Link copied to clipboard
Link copied to clipboard
open override fun toString(): String