Back to Seed Clases

Soup

Classes

Interfaces

Structs

Unions

Enums

Struct Soup.Cookie

Import line:	Soup = imports.gi.Soup;
GIR File:	Soup-2.4.gir
C documentation:	SoupCookie
Struct :	Cookie

An HTTP cookie.
generated from a string that appears to have no name, then name
will be the empty string.
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" attribute, or the "max-age" attribute specified in RFC
2109. 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.

Properties
Properties		Defined By
	domain : String	Soup.Cookie
	expires : Soup.Date	Soup.Cookie
	http_only : gboolean	Soup.Cookie
	name : String	Soup.Cookie
	path : String	Soup.Cookie
	secure : gboolean	Soup.Cookie
	value : String	Soup.Cookie

Methods / Constructors
Method / Constructor		Defined By
	new Soup.Cookie () Create a new Soup.Cookie Create a new Soup.Cookie
	new Soup.Cookie.c_new (String *name, String value, String domain, String path, gint32 max_age) : Soup.Cookie Create a new Soup.Cookie Create a new Soup.Cookie Parameters: String name* Required (not null) cookie name String value Required (not null) cookie value String domain Required (not null) cookie domain or hostname String path Required (not null) cookie path, or NULL gint32 max_age Required (not null) max age of the cookie, or -1 for a session cookie Returns: Soup.Cookie a new SoupCookie.
	applies_to_uri (URI *uri) : gboolean Tests if cookie* should be sent to uri. Tests if cookie should be sent to uri. (At the moment, this does not check that cookie's domain matches But don't rely on that; it may change in the future.) not Parameters: Soup.URI uri Required (not null) a SoupURI Returns: gboolean TRUE if cookie should be sent to uri, FALSE if	Soup.Cookie
	copy () : Soup.Cookie Copies cookie. Copies cookie. Returns: Soup.Cookie a copy of cookie	Soup.Cookie
	domain_matches (String *host) : gboolean Checks if the cookie's domain and host* match in the sense that Checks if the cookie's domain and host match in the sense that Parameters: String host Required (not null) a URI Returns: gboolean TRUE if the domains match, FALSE otherwise	Soup.Cookie
	equal (Cookie *cookie2) : gboolean Parameters: Soup.Cookie cookie2* Required (not null) Returns: gboolean	Soup.Cookie
	free () : none Frees cookie Frees cookie Returns: none	Soup.Cookie
	get_domain () : String Gets cookie's domain Gets cookie's domain Returns: String cookie's domain	Soup.Cookie
	get_expires () : Soup.Date Gets cookie's expiration time owned by cookie and should not be modified or freed. Gets cookie's expiration time owned by cookie and should not be modified or freed. Returns: Soup.Date cookie's expiration time, which is	Soup.Cookie
	get_http_only () : gboolean Gets cookie's HttpOnly attribute Gets cookie's HttpOnly attribute Returns: gboolean cookie's HttpOnly attribute	Soup.Cookie
	get_name () : String Gets cookie's name Gets cookie's name Returns: String cookie's name	Soup.Cookie
	get_path () : String Gets cookie's path Gets cookie's path Returns: String cookie's path	Soup.Cookie
	get_secure () : gboolean Gets cookie's secure attribute Gets cookie's secure attribute Returns: gboolean cookie's secure attribute	Soup.Cookie
	get_value () : String Gets cookie's value Gets cookie's value Returns: String cookie's value	Soup.Cookie
	set_domain (String *domain) : none Sets cookie's domain to domain* Sets cookie's domain to domain Parameters: String domain Required (not null) the new domain Returns: none	Soup.Cookie
	set_expires (Date *expires) : none Sets cookie's expiration time to expires. Sets cookie's expiration time to expires. If expires* is NULL, client's session. (This sets the same property as soup_cookie_set_max_age().) Parameters: Soup.Date expires Required (not null) the new expiration time, or NULL Returns: none	Soup.Cookie
	set_http_only (gboolean *http_only) : none Sets cookie's HttpOnly attribute to http_only. Sets cookie's HttpOnly attribute to http_only. If TRUE, cookie* will be marked as "http only", meaning it should not be exposed to web page scripts or other untrusted code. Parameters: gboolean http_only Required (not null) the new value for the HttpOnly attribute Returns: none	Soup.Cookie
	set_max_age (gint32 *max_age) : none Sets cookie's max age to max_age. Sets cookie's max age to max_age. If max_age* is -1, the cookie is a session cookie, and will expire at the end of the client's session. Otherwise, it is the number of seconds until the cookie expires. You can use the constants SOUP_COOKIE_MAX_AGE_ONE_HOUR, SOUP_COOKIE_MAX_AGE_ONE_DAY, SOUP_COOKIE_MAX_AGE_ONE_WEEK and SOUP_COOKIE_MAX_AGE_ONE_YEAR (or multiples thereof) to calculate this value. (A value of 0 indicates that the cookie should be considered already-expired.) (This sets the same property as soup_cookie_set_expires().) Parameters: gint32 max_age Required (not null) the new max age Returns: none	Soup.Cookie
	set_name (String *name) : none Sets cookie's name to name* Sets cookie's name to name Parameters: String name Required (not null) the new name Returns: none	Soup.Cookie
	set_path (String *path) : none Sets cookie's path to path* Sets cookie's path to path Parameters: String path Required (not null) the new path Returns: none	Soup.Cookie
	set_secure (gboolean *secure) : none Sets cookie's secure attribute to secure. Sets cookie's secure attribute to secure. If TRUE, cookie* will only be transmitted from the client to the server over secure (https) connections. Parameters: gboolean secure Required (not null) the new value for the secure attribute Returns: none	Soup.Cookie
	set_value (String *value) : none Sets cookie's value to value* Sets cookie's value to value Parameters: String value Required (not null) the new value Returns: none	Soup.Cookie
	to_cookie_header () : String Serializes cookie in the format used by the Cookie header (ie, for returning a cookie from a SoupSession to a server). Serializes cookie in the format used by the Cookie header (ie, for returning a cookie from a SoupSession to a server). Returns: String the header	Soup.Cookie
	to_set_cookie_header () : String Serializes cookie in the format used by the Set-Cookie header (ie, for sending a cookie from a SoupServer to a client). Serializes cookie in the format used by the Set-Cookie header (ie, for sending a cookie from a SoupServer to a client). Returns: String the header	Soup.Cookie

Events
None

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Soup Method	Soup.cookie_parse (String *header, URI origin) : Soup.Cookie Parses header* and returns a SoupCookie.
Soup.CookieJar Signal	changed (CookieJar *self, Cookie object*, Cookie p0) : none
Soup.CookieJar Method	add_cookie (Cookie *cookie) : none Adds cookie* to jar, emitting the 'changed' signal if we are modifying an existing cookie or adding a valid new cookie ('valid' means that the cookie's expire date is not in the past).
Soup.CookieJar Method	delete_cookie (Cookie *cookie) : none Deletes cookie* from jar, emitting the 'changed' signal.