okhttp / okhttp3 / Cookie

Cookie

data class Cookie

An RFC 6265 Cookie.

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

Types

class Builder

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

Functions

domain	`fun 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.
expiresAt	`fun 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 persistent, in which case it will expire at the end of the current session.
hostOnly	`fun 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.
httpOnly	`fun 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.
matches	`fun matches(url: HttpUrl): Boolean` 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.
name	`fun name(): String` Returns a non-empty string with this cookie's name.
path	`fun 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`.
persistent	`fun persistent(): Boolean` Returns true if this cookie does not expire at the end of the current session.
secure	`fun secure(): Boolean` Returns true if this cookie should be limited to only HTTPS requests.
toString	`fun toString(): String`
value	`fun value(): String` Returns a possibly-empty string with this cookie's value.

Companion Object Functions

parse	`fun parse(url: HttpUrl, setCookie: String): Cookie?` Attempt to parse a `Set-Cookie` HTTP header value `setCookie` as a cookie. Returns null if `setCookie` is not a well-formed cookie.
parseAll	`fun parseAll(url: HttpUrl, headers: Headers): List<Cookie>` Returns all of the cookies from a set of HTTP response headers.