soup/org.gtkkn.bindings.soup/Cookie

Cookie

class Cookie(pointer: <Error class: unknown class><<Error class: unknown class>>)

Implements HTTP cookies, as described by RFC 6265.

To have a class@Session handle cookies for your appliction automatically, use a class@CookieJar.

Constructors

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

soupCookiePointer

val soupCookiePointer: <Error class: unknown class><<Error class: unknown class>>

Functions

appliesToUri

fun appliesToUri(uri: <Error class: unknown class>): Boolean

Tests if @cookie should be sent to @uri.

copy

fun copy(): Cookie

Copies @cookie.

domainMatches

fun domainMatches(host: String): Boolean

Checks if the @cookie's domain and @host match.

equal

fun equal(cookie2: Cookie): Boolean

Tests if @cookie1 and @cookie2 are equal.

free

fun free()

Frees @cookie.

getDomain

fun getDomain(): String

Gets @cookie's domain.

getExpires

fun getExpires(): <Error class: unknown class>?

Gets @cookie's expiration time.

getHttpOnly

fun getHttpOnly(): Boolean

Gets @cookie's HttpOnly attribute.

getName

fun getName(): String

Gets @cookie's name.

getPath

fun getPath(): String

Gets @cookie's path.

getSameSitePolicy

fun getSameSitePolicy(): SameSitePolicy

Returns the same-site policy for this cookie.

getSecure

fun getSecure(): Boolean

Gets @cookie's secure attribute.

getValue

fun getValue(): String

Gets @cookie's value.

setDomain

fun setDomain(domain: String)

Sets @cookie's domain to @domain.

setExpires

fun setExpires(expires: <Error class: unknown class>)

Sets @cookie's expiration time to @expires.

setHttpOnly

fun setHttpOnly(httpOnly: Boolean)

Sets @cookie's HttpOnly attribute to @http_only.

setMaxAge

fun setMaxAge(maxAge: <Error class: unknown class>)

Sets @cookie's max age to @max_age.

setName

fun setName(name: String)

Sets @cookie's name to @name.

setPath

fun setPath(path: String)

Sets @cookie's path to @path.

setSameSitePolicy

fun setSameSitePolicy(policy: SameSitePolicy)

When used in conjunction with method@CookieJar.get_cookie_list_with_same_site_info this sets the policy of when this cookie should be exposed.

setSecure

fun setSecure(secure: Boolean)

Sets @cookie's secure attribute to @secure.

setValue

fun setValue(value: String)

Sets @cookie's value to @value.

toCookieHeader

fun toCookieHeader(): String

Serializes @cookie in the format used by the Cookie header (ie, for returning a cookie from a class@Session to a server).

toSetCookieHeader

fun toSetCookieHeader(): String

Serializes @cookie in the format used by the Set-Cookie header.