Top |
WebKitCookieManagerWebKitCookieManager — Defines how to handle cookies in a WebKitWebContext |
struct | WebKitCookieManager |
enum | WebKitCookiePersistentStorage |
enum | WebKitCookieAcceptPolicy |
The WebKitCookieManager defines how to set up and handle cookies.
You can get it from a WebKitWebsiteDataManager with
webkit_website_data_manager_get_cookie_manager()
, and use it to set where to
store cookies with webkit_cookie_manager_set_persistent_storage()
,
or to set the acceptance policy, with webkit_cookie_manager_get_accept_policy()
.
void webkit_cookie_manager_set_persistent_storage (WebKitCookieManager *cookie_manager
,const gchar *filename
,WebKitCookiePersistentStorage storage
);
Set the filename
where non-session cookies are stored persistently using
storage
as the format to read/write the cookies.
Cookies are initially read from filename
to create an initial set of cookies.
Then, non-session cookies will be written to filename
when the WebKitCookieManager::changed
signal is emitted.
By default, cookie_manager
doesn't store the cookies persistently, so you need to call this
method to keep cookies saved across sessions.
This method should never be called on a WebKitCookieManager associated to an ephemeral WebKitWebsiteDataManager.
void webkit_cookie_manager_set_accept_policy (WebKitCookieManager *cookie_manager
,WebKitCookieAcceptPolicy policy
);
Set the cookie acceptance policy of cookie_manager
as policy
.
Note that ITP has its own way to handle third-party cookies, so when it's enabled,
and policy
is set to WEBKIT_COOKIE_POLICY_ACCEPT_NO_THIRD_PARTY
, WEBKIT_COOKIE_POLICY_ACCEPT_ALWAYS
will be used instead. Once disabled, the policy will be set back to WEBKIT_COOKIE_POLICY_ACCEPT_NO_THIRD_PARTY
.
See also webkit_website_data_manager_set_itp_enabled()
.
void webkit_cookie_manager_get_accept_policy (WebKitCookieManager *cookie_manager
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously get the cookie acceptance policy of cookie_manager
.
Note that when policy was set to WEBKIT_COOKIE_POLICY_ACCEPT_NO_THIRD_PARTY
and
ITP is enabled, this will return WEBKIT_COOKIE_POLICY_ACCEPT_ALWAYS
.
See also webkit_website_data_manager_set_itp_enabled()
.
When the operation is finished, callback
will be called. You can then call
webkit_cookie_manager_get_accept_policy_finish()
to get the result of the operation.
cookie_manager |
||
cancellable |
a GCancellable or |
[allow-none] |
callback |
a GAsyncReadyCallback to call when the request is satisfied. |
[scope async] |
user_data |
the data to pass to callback function. |
[closure] |
WebKitCookieAcceptPolicy webkit_cookie_manager_get_accept_policy_finish (WebKitCookieManager *cookie_manager
,GAsyncResult *result
,GError **error
);
Finish an asynchronous operation started with webkit_cookie_manager_get_accept_policy()
.
void webkit_cookie_manager_get_domains_with_cookies (WebKitCookieManager *cookie_manager
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
webkit_cookie_manager_get_domains_with_cookies
has been deprecated since version 2.16 and should not be used in newly-written code.
Use webkit_website_data_manager_fetch()
instead.
Asynchronously get the list of domains for which cookie_manager
contains cookies.
When the operation is finished, callback
will be called. You can then call
webkit_cookie_manager_get_domains_with_cookies_finish()
to get the result of the operation.
cookie_manager |
||
cancellable |
a GCancellable or |
[allow-none] |
callback |
a GAsyncReadyCallback to call when the request is satisfied. |
[scope async] |
user_data |
the data to pass to callback function. |
[closure] |
gchar ** webkit_cookie_manager_get_domains_with_cookies_finish (WebKitCookieManager *cookie_manager
,GAsyncResult *result
,GError **error
);
webkit_cookie_manager_get_domains_with_cookies_finish
has been deprecated since version 2.16 and should not be used in newly-written code.
Use webkit_website_data_manager_fetch_finish()
instead.
Finish an asynchronous operation started with webkit_cookie_manager_get_domains_with_cookies()
.
The return value is a NULL
terminated list of strings which should
be released with g_strfreev()
.
void webkit_cookie_manager_add_cookie (WebKitCookieManager *cookie_manager
,SoupCookie *cookie
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously add a SoupCookie to the underlying storage.
When the operation is finished, callback
will be called. You can then call
webkit_cookie_manager_add_cookie_finish()
to get the result of the operation.
cookie_manager |
||
cookie |
the SoupCookie to be added |
|
cancellable |
a GCancellable or |
[allow-none] |
callback |
a GAsyncReadyCallback to call when the request is satisfied. |
[scope async] |
user_data |
the data to pass to callback function. |
[closure] |
Since: 2.20
gboolean webkit_cookie_manager_add_cookie_finish (WebKitCookieManager *cookie_manager
,GAsyncResult *result
,GError **error
);
Finish an asynchronous operation started with webkit_cookie_manager_add_cookie()
.
Since: 2.20
void webkit_cookie_manager_get_cookies (WebKitCookieManager *cookie_manager
,const gchar *uri
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously get a list of SoupCookie from cookie_manager
associated with uri
, which
must be either an HTTP or an HTTPS URL.
When the operation is finished, callback
will be called. You can then call
webkit_cookie_manager_get_cookies_finish()
to get the result of the operation.
cookie_manager |
||
uri |
the URI associated to the cookies to be retrieved |
|
cancellable |
a GCancellable or |
[allow-none] |
callback |
a GAsyncReadyCallback to call when the request is satisfied. |
[scope async] |
user_data |
the data to pass to callback function. |
[closure] |
Since: 2.20
GList * webkit_cookie_manager_get_cookies_finish (WebKitCookieManager *cookie_manager
,GAsyncResult *result
,GError **error
);
Finish an asynchronous operation started with webkit_cookie_manager_get_cookies()
.
The return value is a GSList of SoupCookie instances which should be released
with g_list_free_full()
and soup_cookie_free()
.
Since: 2.20
void webkit_cookie_manager_delete_cookie (WebKitCookieManager *cookie_manager
,SoupCookie *cookie
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously delete a SoupCookie from the current session.
When the operation is finished, callback
will be called. You can then call
webkit_cookie_manager_delete_cookie_finish()
to get the result of the operation.
cookie_manager |
||
cookie |
the SoupCookie to be deleted |
|
cancellable |
a GCancellable or |
[allow-none] |
callback |
a GAsyncReadyCallback to call when the request is satisfied. |
[scope async] |
user_data |
the data to pass to callback function. |
[closure] |
Since: 2.20
gboolean webkit_cookie_manager_delete_cookie_finish (WebKitCookieManager *cookie_manager
,GAsyncResult *result
,GError **error
);
Finish an asynchronous operation started with webkit_cookie_manager_delete_cookie()
.
Since: 2.20
void webkit_cookie_manager_delete_cookies_for_domain (WebKitCookieManager *cookie_manager
,const gchar *domain
);
webkit_cookie_manager_delete_cookies_for_domain
has been deprecated since version 2.16 and should not be used in newly-written code.
Use webkit_website_data_manager_remove()
instead.
Remove all cookies of cookie_manager
for the given domain
.
void
webkit_cookie_manager_delete_all_cookies
(WebKitCookieManager *cookie_manager
);
webkit_cookie_manager_delete_all_cookies
has been deprecated since version 2.16 and should not be used in newly-written code.
Use webkit_website_data_manager_clear()
instead.
Delete all cookies of cookie_manager
“changed”
signalvoid user_function (WebKitCookieManager *cookie_manager, gpointer user_data)
This signal is emitted when cookies are added, removed or modified.
Flags: Run Last