Cookie

Object Hierarchy:

Description:

[ CCode ( copy_function = "g_boxed_copy" , free_function = "g_boxed_free" , type_id = "soup_cookie_get_type ()" ) ]
[ Compact ]
public class Cookie

Implements HTTP cookies, as described by RFC 6265.

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

name and value will be set for all cookies. If the cookie is generated from a string that appears to have no name, then name will be the empty string.

domain and path give the host or domain, and path within that host/domain, to restrict this cookie to. If domain starts with ".", that indicates a domain (which matches the string after the ".", or any hostname that has domain as a suffix). Otherwise, it is a hostname and must match exactly.

expires will be non-null if the cookie uses either the original "expires" attribute, or the newer "max-age" attribute. If expires is null, it indicates that neither "expires" nor "max-age" was specified, and the cookie expires at the end of the session.

If http_only is set, the cookie should not be exposed to untrusted code (eg, javascript), so as to minimize the danger posed by cross-site scripting attacks.

Namespace: Soup

Package: libsoup-3.0

Content:

Static methods:

public static Cookie? parse (string header, Uri? origin)

Creation methods:

public Cookie (string name, string value, string domain, string path, int max_age)
Creates a new Cookie with the given attributes.

Methods:

public bool applies_to_uri (Uri uri)
Tests if this should be sent to uri.
public Cookie copy ()
Copies this.
public bool domain_matches (string host)
Checks if the this's domain and host match.
public bool equal (Cookie cookie2)
Tests if this and cookie2 are equal.
public void free ()
Frees this.
public unowned string get_domain ()
Gets this's domain.
public unowned DateTime? get_expires ()
Gets this's expiration time.
public bool get_http_only ()
Gets this's HttpOnly attribute.
public unowned string get_name ()
Gets this's name.
public unowned string get_path ()
Gets this's path.
public SameSitePolicy get_same_site_policy ()
Returns the same-site policy for this cookie.
public bool get_secure ()
Gets this's secure attribute.
public unowned string get_value ()
Gets this's value.
public void set_domain (string domain)
Sets this's domain to domain.
public void set_expires (DateTime expires)
Sets this's expiration time to expires.
public void set_http_only (bool http_only)
Sets this's HttpOnly attribute to http_only.
public void set_max_age (int max_age)
Sets this's max age to max_age.
public void set_name (string name)
Sets this's name to name.
public void set_path (string path)
Sets this's path to path.
public void set_same_site_policy (SameSitePolicy policy)
When used in conjunction with [method@CookieJar.
public void set_secure (bool secure)
Sets this's secure attribute to secure.
public void set_value (string value)
Sets this's value to value.
public string to_cookie_header ()
Serializes this in the format used by the Cookie header (ie, for returning a cookie from a [class@Session] to a server).
public string to_set_cookie_header ()
Serializes this in the format used by the Set-Cookie header.