CookieJar

Object Hierarchy:

Description:

[ CCode ( type_id = "soup_cookie_jar_get_type ()" ) ]
public class CookieJar : Object, SessionFeature

Automatic cookie handling for SoupSession.

A [class@CookieJar] stores [struct@Cookie]s and arrange for them to be sent with the appropriate [class@Message]s. [class@CookieJar] implements [iface@SessionFeature], so you can add a cookie jar to a session with [method@Session.add_feature] or [ method@Session.add_feature_by_type].

Note that the base [class@CookieJar] class does not support any form of long-term cookie persistence.

All known sub-classes:

CookieJarDB

CookieJarText

Namespace: Soup

Package: libsoup-3.0

Content:

Properties:

public CookieJarAcceptPolicy accept_policy { get; set; }
The policy the jar should follow to accept or reject cookies.
public bool read_only { get; construct; }
Whether or not the cookie jar is read-only.

Creation methods:

public CookieJar ()
Creates a new [class@CookieJar].

Methods:

public void add_cookie (owned Cookie cookie)
Adds cookie to this.
public void add_cookie_full (owned Cookie cookie, Uri? uri, Uri? first_party)
Adds cookie to this.
public void add_cookie_with_first_party (Uri first_party, owned Cookie cookie)
Adds cookie to this.
public SList<Cookie> all_cookies ()
Constructs a [struct@GLib.
public void delete_cookie (Cookie cookie)
Deletes cookie from this .
public CookieJarAcceptPolicy get_accept_policy ()
Gets this's [ enum@CookieJarAcceptPolicy].
public SList<Cookie> get_cookie_list (Uri uri, bool for_http)
Retrieves the list of cookies that would be sent with a request to uri as a [struct@GLib.
public SList<Cookie> get_cookie_list_with_same_site_info (Uri uri, Uri? top_level, Uri? site_for_cookies, bool for_http, bool is_safe_method, bool is_top_level_navigation)
This is an extended version of [method@CookieJar.
public string? get_cookies (Uri uri, bool for_http)
Retrieves (in Cookie-header form) the list of cookies that would be sent with a request to uri.
public virtual bool is_persistent ()
Gets whether this stores cookies persistenly.
public virtual void save ()
This function exists for backward compatibility, but does not do anything any more; cookie jars are saved automatically when they are changed.
public void set_accept_policy (CookieJarAcceptPolicy policy)
Sets policy as the cookie acceptance policy for this.
public void set_cookie (Uri uri, string cookie)
Adds cookie to this, exactly as though it had appeared in a Set-Cookie header returned from a request to uri.
public void set_cookie_with_first_party (Uri uri, Uri first_party, string cookie)
Adds cookie to this, exactly as though it had appeared in a Set-Cookie header returned from a request to uri.

Signals:

public virtual signal void changed (Cookie? old_cookie, Cookie? new_cookie)
Emitted when jar changes.

Inherited Members:

All known members inherited from class GLib.Object