soup_cookie_jar_new ()

SoupCookieJar *
soup_cookie_jar_new (void);

Creates a new SoupCookieJar. The base SoupCookieJar class does not support persistent storage of cookies; use a subclass for that.

Since 2.24

soup_cookie_jar_get_cookies ()

char *
soup_cookie_jar_get_cookies (SoupCookieJar *jar,
                             SoupURI *uri,
                             gboolean for_http);

Retrieves (in Cookie-header form) the list of cookies that would be sent with a request to uri .

If for_http is TRUE, the return value will include cookies marked "HttpOnly" (that is, cookies that the server wishes to keep hidden from client-side scripting operations such as the JavaScript document.cookies property). Since SoupCookieJar sets the Cookie header itself when making the actual HTTP request, you should almost certainly be setting for_http to FALSE if you are calling this.

Since 2.24

soup_cookie_jar_get_cookie_list ()

GSList *
soup_cookie_jar_get_cookie_list (SoupCookieJar *jar,
                                 SoupURI *uri,
                                 gboolean for_http);

Retrieves the list of cookies that would be sent with a request to uri as a GSList of SoupCookie objects.

If for_http is TRUE, the return value will include cookies marked "HttpOnly" (that is, cookies that the server wishes to keep hidden from client-side scripting operations such as the JavaScript document.cookies property). Since SoupCookieJar sets the Cookie header itself when making the actual HTTP request, you should almost certainly be setting for_http to FALSE if you are calling this.

Since 2.40

soup_cookie_jar_set_cookie ()

void
soup_cookie_jar_set_cookie (SoupCookieJar *jar,
                            SoupURI *uri,
                            const char *cookie);

Adds cookie to jar , exactly as though it had appeared in a Set-Cookie header returned from a request to uri .

Keep in mind that if the SoupCookieJarAcceptPolicy SOUP_COOKIE_JAR_ACCEPT_NO_THIRD_PARTY is set you'll need to use soup_cookie_jar_set_cookie_with_first_party(), otherwise the jar will have no way of knowing if the cookie is being set by a third party or not.

Since 2.24

soup_cookie_jar_set_cookie_with_first_party ()

void
soup_cookie_jar_set_cookie_with_first_party
                               (SoupCookieJar *jar,
                                SoupURI *uri,
                                SoupURI *first_party,
                                const char *cookie);

Adds cookie to jar , exactly as though it had appeared in a Set-Cookie header returned from a request to uri . first_party will be used to reject cookies coming from third party resources in case such a security policy is set in the jar .

Since 2.30

soup_cookie_jar_add_cookie ()

void
soup_cookie_jar_add_cookie (SoupCookieJar *jar,
                            SoupCookie *cookie);

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).

cookie will be 'stolen' by the jar, so don't free it afterwards.

Since 2.26

soup_cookie_jar_add_cookie_with_first_party ()

void
soup_cookie_jar_add_cookie_with_first_party
                               (SoupCookieJar *jar,
                                SoupURI *first_party,
                                SoupCookie *cookie);

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).

first_party will be used to reject cookies coming from third party resources in case such a security policy is set in the jar .

cookie will be 'stolen' by the jar, so don't free it afterwards.

Since 2.40

soup_cookie_jar_delete_cookie ()

void
soup_cookie_jar_delete_cookie (SoupCookieJar *jar,
                               SoupCookie *cookie);

Deletes cookie from jar , emitting the 'changed' signal.

Since 2.26

soup_cookie_jar_all_cookies ()

GSList *
soup_cookie_jar_all_cookies (SoupCookieJar *jar);

Constructs a GSList with every cookie inside the jar . The cookies in the list are a copy of the original, so you have to free them when you are done with them.

Since 2.26

soup_cookie_jar_get_accept_policy ()

SoupCookieJarAcceptPolicy
soup_cookie_jar_get_accept_policy (SoupCookieJar *jar);

Gets jar 's SoupCookieJarAcceptPolicy

Since 2.30

soup_cookie_jar_set_accept_policy ()

void
soup_cookie_jar_set_accept_policy (SoupCookieJar *jar,
                                   SoupCookieJarAcceptPolicy policy);

Sets policy as the cookie acceptance policy for jar .

Since 2.30

soup_cookie_jar_is_persistent ()

gboolean
soup_cookie_jar_is_persistent (SoupCookieJar *jar);

Gets whether jar stores cookies persistenly.

Since 2.40

SoupCookieJar

typedef struct _SoupCookieJar SoupCookieJar;

enum SoupCookieJarAcceptPolicy

The policy for accepting or rejecting cookies returned in responses.

Since 2.30

SOUP_COOKIE_JAR_READ_ONLY

#define SOUP_COOKIE_JAR_READ_ONLY "read-only"

Alias for the “read-only” property. (Whether or not the cookie jar is read-only.)

SOUP_COOKIE_JAR_ACCEPT_POLICY

#define SOUP_COOKIE_JAR_ACCEPT_POLICY "accept-policy"

Alias for the “accept-policy” property.

Since 2.30

The “accept-policy” property

  “accept-policy”            SoupCookieJarAcceptPolicy

The policy the jar should follow to accept or reject cookies

Flags: Read / Write

Default value: SOUP_COOKIE_JAR_ACCEPT_ALWAYS

Since 2.30

The “read-only” property

  “read-only”                gboolean

Whether or not the cookie jar is read-only.

Flags: Read / Write / Construct Only

Default value: FALSE

The “changed” signal

void
user_function (SoupCookieJar *jar,
               SoupCookie    *old_cookie,
               SoupCookie    *new_cookie,
               gpointer       user_data)

Emitted when jar changes. If a cookie has been added, new_cookie will contain the newly-added cookie and old_cookie will be NULL. If a cookie has been deleted, old_cookie will contain the to-be-deleted cookie and new_cookie will be NULL. If a cookie has been changed, old_cookie will contain its old value, and new_cookie its new value.

Flags: Run First