WebKitCookieManager.html 59.7 KB
Newer Older
1 2 3 4
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Alberto Garcia's avatar
Alberto Garcia committed
5
<title>WebKitCookieManager: WebKitGTK Reference Manual</title>
Alberto Garcia's avatar
Alberto Garcia committed
6
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
Alberto Garcia's avatar
Alberto Garcia committed
7
<link rel="home" href="index.html" title="WebKitGTK Reference Manual">
8 9 10
<link rel="up" href="ch01.html" title="Class Overview">
<link rel="prev" href="WebKitFindController.html" title="WebKitFindController">
<link rel="next" href="WebKitPlugin.html" title="WebKitPlugin">
Alberto Garcia's avatar
Alberto Garcia committed
11
<meta name="generator" content="GTK-Doc V1.33.0 (XML mode)">
12 13 14
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16
<td width="100%" align="left" class="shortcuts">
17 18 19
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#WebKitCookieManager.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#WebKitCookieManager.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_signals">  <span class="dim">|</span> 
20
                  <a href="#WebKitCookieManager.signals" class="shortcut">Signals</a></span>
21 22 23 24 25 26
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="WebKitFindController.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="WebKitPlugin.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
27 28 29 30 31
<div class="refentry">
<a name="WebKitCookieManager"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="WebKitCookieManager.top_of_page"></a>WebKitCookieManager</span></h2>
Alberto Garcia's avatar
Alberto Garcia committed
32
<p>WebKitCookieManager — Defines how to handle cookies in a <a class="link" href="WebKitWebContext.html" title="WebKitWebContext"><span class="type">WebKitWebContext</span></a></p>
33
</td>
34
<td class="gallery_image" valign="top" align="right"></td>
35 36
</tr></table></div>
<div class="refsect1">
37
<a name="WebKitCookieManager.functions"></a><h2>Functions</h2>
38
<div class="informaltable"><table class="informaltable" width="100%" border="0">
39
<colgroup>
Alberto Garcia's avatar
Alberto Garcia committed
40 41
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
42
</colgroup>
43 44
<tbody>
<tr>
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="WebKitCookieManager.html#webkit-cookie-manager-set-persistent-storage" title="webkit_cookie_manager_set_persistent_storage ()">webkit_cookie_manager_set_persistent_storage</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="WebKitCookieManager.html#webkit-cookie-manager-set-accept-policy" title="webkit_cookie_manager_set_accept_policy ()">webkit_cookie_manager_set_accept_policy</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="WebKitCookieManager.html#webkit-cookie-manager-get-accept-policy" title="webkit_cookie_manager_get_accept_policy ()">webkit_cookie_manager_get_accept_policy</a> <span class="c_punctuation">()</span>
66 67 68
</td>
</tr>
<tr>
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
<td class="function_type">
<a class="link" href="WebKitCookieManager.html#WebKitCookieAcceptPolicy" title="enum WebKitCookieAcceptPolicy"><span class="returnvalue">WebKitCookieAcceptPolicy</span></a>
</td>
<td class="function_name">
<a class="link" href="WebKitCookieManager.html#webkit-cookie-manager-get-accept-policy-finish" title="webkit_cookie_manager_get_accept_policy_finish ()">webkit_cookie_manager_get_accept_policy_finish</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="WebKitCookieManager.html#webkit-cookie-manager-get-domains-with-cookies" title="webkit_cookie_manager_get_domains_with_cookies ()">webkit_cookie_manager_get_domains_with_cookies</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **
</td>
<td class="function_name">
<a class="link" href="WebKitCookieManager.html#webkit-cookie-manager-get-domains-with-cookies-finish" title="webkit_cookie_manager_get_domains_with_cookies_finish ()">webkit_cookie_manager_get_domains_with_cookies_finish</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
Alberto Garcia's avatar
Alberto Garcia committed
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
<a class="link" href="WebKitCookieManager.html#webkit-cookie-manager-add-cookie" title="webkit_cookie_manager_add_cookie ()">webkit_cookie_manager_add_cookie</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="WebKitCookieManager.html#webkit-cookie-manager-add-cookie-finish" title="webkit_cookie_manager_add_cookie_finish ()">webkit_cookie_manager_add_cookie_finish</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="WebKitCookieManager.html#webkit-cookie-manager-get-cookies" title="webkit_cookie_manager_get_cookies ()">webkit_cookie_manager_get_cookies</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a class="link" href="WebKitCookieManager.html#webkit-cookie-manager-get-cookies-finish" title="webkit_cookie_manager_get_cookies_finish ()">webkit_cookie_manager_get_cookies_finish</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="WebKitCookieManager.html#webkit-cookie-manager-delete-cookie" title="webkit_cookie_manager_delete_cookie ()">webkit_cookie_manager_delete_cookie</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="WebKitCookieManager.html#webkit-cookie-manager-delete-cookie-finish" title="webkit_cookie_manager_delete_cookie_finish ()">webkit_cookie_manager_delete_cookie_finish</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
145 146 147 148 149 150 151 152 153
<a class="link" href="WebKitCookieManager.html#webkit-cookie-manager-delete-cookies-for-domain" title="webkit_cookie_manager_delete_cookies_for_domain ()">webkit_cookie_manager_delete_cookies_for_domain</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="WebKitCookieManager.html#webkit-cookie-manager-delete-all-cookies" title="webkit_cookie_manager_delete_all_cookies ()">webkit_cookie_manager_delete_all_cookies</a> <span class="c_punctuation">()</span>
154 155 156 157 158
</td>
</tr>
</tbody>
</table></div>
</div>
159 160
<div class="refsect1">
<a name="WebKitCookieManager.signals"></a><h2>Signals</h2>
161
<div class="informaltable"><table class="informaltable" border="0">
162
<colgroup>
Alberto Garcia's avatar
Alberto Garcia committed
163 164 165
<col width="150px" class="signal_proto_type">
<col width="300px" class="signal_proto_name">
<col width="200px" class="signal_proto_flags">
166 167 168 169
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="WebKitCookieManager.html#WebKitCookieManager-changed" title="The “changed” signal">changed</a></td>
Alberto Garcia's avatar
Alberto Garcia committed
170
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
171 172 173 174 175
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="WebKitCookieManager.other"></a><h2>Types and Values</h2>
176
<div class="informaltable"><table class="informaltable" width="100%" border="0">
177
<colgroup>
Alberto Garcia's avatar
Alberto Garcia committed
178 179
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
180
</colgroup>
181 182
<tbody>
<tr>
183 184
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="WebKitCookieManager.html#WebKitCookieManager-struct" title="struct WebKitCookieManager">WebKitCookieManager</a></td>
185 186
</tr>
<tr>
187 188
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="WebKitCookieManager.html#WebKitCookiePersistentStorage" title="enum WebKitCookiePersistentStorage">WebKitCookiePersistentStorage</a></td>
189 190
</tr>
<tr>
191 192
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="WebKitCookieManager.html#WebKitCookieAcceptPolicy" title="enum WebKitCookieAcceptPolicy">WebKitCookieAcceptPolicy</a></td>
193 194 195 196
</tr>
</tbody>
</table></div>
</div>
197 198
<div class="refsect1">
<a name="WebKitCookieManager.object-hierarchy"></a><h2>Object Hierarchy</h2>
199
<pre class="screen">    <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
200 201 202 203 204
    <span class="lineart">╰──</span> WebKitCookieManager
</pre>
</div>
<div class="refsect1">
<a name="WebKitCookieManager.description"></a><h2>Description</h2>
Alberto Garcia's avatar
Alberto Garcia committed
205 206 207 208 209
<p>The WebKitCookieManager defines how to set up and handle cookies.
You can get it from a <a class="link" href="WebKitWebsiteDataManager.html" title="WebKitWebsiteDataManager"><span class="type">WebKitWebsiteDataManager</span></a> with
<a class="link" href="WebKitWebsiteDataManager.html#webkit-website-data-manager-get-cookie-manager" title="webkit_website_data_manager_get_cookie_manager ()"><code class="function">webkit_website_data_manager_get_cookie_manager()</code></a>, and use it to set where to
store cookies with <a class="link" href="WebKitCookieManager.html#webkit-cookie-manager-set-persistent-storage" title="webkit_cookie_manager_set_persistent_storage ()"><code class="function">webkit_cookie_manager_set_persistent_storage()</code></a>,
or to set the acceptance policy, with <a class="link" href="WebKitCookieManager.html#webkit-cookie-manager-get-accept-policy" title="webkit_cookie_manager_get_accept_policy ()"><code class="function">webkit_cookie_manager_get_accept_policy()</code></a>.</p>
210 211 212
</div>
<div class="refsect1">
<a name="WebKitCookieManager.functions_details"></a><h2>Functions</h2>
213
<div class="refsect2">
214 215 216 217 218 219
<a name="webkit-cookie-manager-set-persistent-storage"></a><h3>webkit_cookie_manager_set_persistent_storage ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
webkit_cookie_manager_set_persistent_storage
                               (<em class="parameter"><code><a class="link" href="WebKitCookieManager.html" title="WebKitCookieManager"><span class="type">WebKitCookieManager</span></a> *cookie_manager</code></em>,
                                <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
                                <em class="parameter"><code><a class="link" href="WebKitCookieManager.html#WebKitCookiePersistentStorage" title="enum WebKitCookiePersistentStorage"><span class="type">WebKitCookiePersistentStorage</span></a> storage</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
<p>Set the <em class="parameter"><code>filename</code></em>
 where non-session cookies are stored persistently using
<em class="parameter"><code>storage</code></em>
 as the format to read/write the cookies.
Cookies are initially read from <em class="parameter"><code>filename</code></em>
 to create an initial set of cookies.
Then, non-session cookies will be written to <em class="parameter"><code>filename</code></em>
 when the WebKitCookieManager::changed
signal is emitted.
By default, <em class="parameter"><code>cookie_manager</code></em>
 doesn't store the cookies persistently, so you need to call this
method to keep cookies saved across sessions.</p>
<p>This method should never be called on a <a class="link" href="WebKitCookieManager.html" title="WebKitCookieManager"><span class="type">WebKitCookieManager</span></a> associated to an ephemeral <a class="link" href="WebKitWebsiteDataManager.html" title="WebKitWebsiteDataManager"><span class="type">WebKitWebsiteDataManager</span></a>.</p>
<div class="refsect3">
<a name="webkit-cookie-manager-set-persistent-storage.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cookie_manager</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitCookieManager.html" title="WebKitCookieManager"><span class="type">WebKitCookieManager</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>the filename to read to/write from</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>storage</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitCookieManager.html#WebKitCookiePersistentStorage" title="enum WebKitCookiePersistentStorage"><span class="type">WebKitCookiePersistentStorage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
260
</div>
261 262
<hr>
<div class="refsect2">
263 264 265 266 267
<a name="webkit-cookie-manager-set-accept-policy"></a><h3>webkit_cookie_manager_set_accept_policy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
webkit_cookie_manager_set_accept_policy
                               (<em class="parameter"><code><a class="link" href="WebKitCookieManager.html" title="WebKitCookieManager"><span class="type">WebKitCookieManager</span></a> *cookie_manager</code></em>,
                                <em class="parameter"><code><a class="link" href="WebKitCookieManager.html#WebKitCookieAcceptPolicy" title="enum WebKitCookieAcceptPolicy"><span class="type">WebKitCookieAcceptPolicy</span></a> policy</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
268 269
<p>Set the cookie acceptance policy of <em class="parameter"><code>cookie_manager</code></em>
 as <em class="parameter"><code>policy</code></em>
Alberto Garcia's avatar
Alberto Garcia committed
270 271 272 273 274 275
.
Note that ITP has its own way to handle third-party cookies, so when it's enabled,
and <em class="parameter"><code>policy</code></em>
 is set to <a class="link" href="WebKitCookieManager.html#WEBKIT-COOKIE-POLICY-ACCEPT-NO-THIRD-PARTY:CAPS"><code class="literal">WEBKIT_COOKIE_POLICY_ACCEPT_NO_THIRD_PARTY</code></a>, <a class="link" href="WebKitCookieManager.html#WEBKIT-COOKIE-POLICY-ACCEPT-ALWAYS:CAPS"><code class="literal">WEBKIT_COOKIE_POLICY_ACCEPT_ALWAYS</code></a>
will be used instead. Once disabled, the policy will be set back to <a class="link" href="WebKitCookieManager.html#WEBKIT-COOKIE-POLICY-ACCEPT-NO-THIRD-PARTY:CAPS"><code class="literal">WEBKIT_COOKIE_POLICY_ACCEPT_NO_THIRD_PARTY</code></a>.
See also <a class="link" href="WebKitWebsiteDataManager.html#webkit-website-data-manager-set-itp-enabled" title="webkit_website_data_manager_set_itp_enabled ()"><code class="function">webkit_website_data_manager_set_itp_enabled()</code></a>.</p>
Alberto Garcia's avatar
Alberto Garcia committed
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
<div class="refsect3">
<a name="webkit-cookie-manager-set-accept-policy.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cookie_manager</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitCookieManager.html" title="WebKitCookieManager"><span class="type">WebKitCookieManager</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>policy</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitCookieManager.html#WebKitCookieAcceptPolicy" title="enum WebKitCookieAcceptPolicy"><span class="type">WebKitCookieAcceptPolicy</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
298
</div>
299 300
<hr>
<div class="refsect2">
301 302 303 304
<a name="webkit-cookie-manager-get-accept-policy"></a><h3>webkit_cookie_manager_get_accept_policy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
webkit_cookie_manager_get_accept_policy
                               (<em class="parameter"><code><a class="link" href="WebKitCookieManager.html" title="WebKitCookieManager"><span class="type">WebKitCookieManager</span></a> *cookie_manager</code></em>,
305
                                <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>,
306 307
                                <em class="parameter"><code><a href="../gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
                                <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
308
<p>Asynchronously get the cookie acceptance policy of <em class="parameter"><code>cookie_manager</code></em>
Alberto Garcia's avatar
Alberto Garcia committed
309 310 311 312
.
Note that when policy was set to <a class="link" href="WebKitCookieManager.html#WEBKIT-COOKIE-POLICY-ACCEPT-NO-THIRD-PARTY:CAPS"><code class="literal">WEBKIT_COOKIE_POLICY_ACCEPT_NO_THIRD_PARTY</code></a> and
ITP is enabled, this will return <a class="link" href="WebKitCookieManager.html#WEBKIT-COOKIE-POLICY-ACCEPT-ALWAYS:CAPS"><code class="literal">WEBKIT_COOKIE_POLICY_ACCEPT_ALWAYS</code></a>.
See also <a class="link" href="WebKitWebsiteDataManager.html#webkit-website-data-manager-set-itp-enabled" title="webkit_website_data_manager_set_itp_enabled ()"><code class="function">webkit_website_data_manager_set_itp_enabled()</code></a>.</p>
Alberto Garcia's avatar
Alberto Garcia committed
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
<p>When the operation is finished, <em class="parameter"><code>callback</code></em>
 will be called. You can then call
<a class="link" href="WebKitCookieManager.html#webkit-cookie-manager-get-accept-policy-finish" title="webkit_cookie_manager_get_accept_policy_finish ()"><code class="function">webkit_cookie_manager_get_accept_policy_finish()</code></a> to get the result of the operation.</p>
<div class="refsect3">
<a name="webkit-cookie-manager-get-accept-policy.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cookie_manager</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitCookieManager.html" title="WebKitCookieManager"><span class="type">WebKitCookieManager</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>a <a href="../gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> to call when the request is satisfied. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>the data to pass to callback function. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
348
</div>
349 350
<hr>
<div class="refsect2">
351 352 353 354
<a name="webkit-cookie-manager-get-accept-policy-finish"></a><h3>webkit_cookie_manager_get_accept_policy_finish ()</h3>
<pre class="programlisting"><a class="link" href="WebKitCookieManager.html#WebKitCookieAcceptPolicy" title="enum WebKitCookieAcceptPolicy"><span class="returnvalue">WebKitCookieAcceptPolicy</span></a>
webkit_cookie_manager_get_accept_policy_finish
                               (<em class="parameter"><code><a class="link" href="WebKitCookieManager.html" title="WebKitCookieManager"><span class="type">WebKitCookieManager</span></a> *cookie_manager</code></em>,
355
                                <em class="parameter"><code><a href="../gio/GAsyncResult.html#GAsyncResult-struct"><span class="type">GAsyncResult</span></a> *result</code></em>,
356
                                <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
<p>Finish an asynchronous operation started with <a class="link" href="WebKitCookieManager.html#webkit-cookie-manager-get-accept-policy" title="webkit_cookie_manager_get_accept_policy ()"><code class="function">webkit_cookie_manager_get_accept_policy()</code></a>.</p>
<div class="refsect3">
<a name="webkit-cookie-manager-get-accept-policy-finish.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cookie_manager</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitCookieManager.html" title="WebKitCookieManager"><span class="type">WebKitCookieManager</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>result</p></td>
<td class="parameter_description"><p>a <a href="../gio/GAsyncResult.html#GAsyncResult-struct"><span class="type">GAsyncResult</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for error or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-cookie-manager-get-accept-policy-finish.returns"></a><h4>Returns</h4>
<p> the cookie acceptance policy of <em class="parameter"><code>cookie_manager</code></em>
as a <a class="link" href="WebKitCookieManager.html#WebKitCookieAcceptPolicy" title="enum WebKitCookieAcceptPolicy"><span class="type">WebKitCookieAcceptPolicy</span></a>.</p>
</div>
390
</div>
391 392
<hr>
<div class="refsect2">
393 394 395 396
<a name="webkit-cookie-manager-get-domains-with-cookies"></a><h3>webkit_cookie_manager_get_domains_with_cookies ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
webkit_cookie_manager_get_domains_with_cookies
                               (<em class="parameter"><code><a class="link" href="WebKitCookieManager.html" title="WebKitCookieManager"><span class="type">WebKitCookieManager</span></a> *cookie_manager</code></em>,
397
                                <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>,
398 399
                                <em class="parameter"><code><a href="../gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
                                <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
<div class="warning">
<p><code class="literal">webkit_cookie_manager_get_domains_with_cookies</code> has been deprecated since version 2.16 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="WebKitWebsiteDataManager.html#webkit-website-data-manager-fetch" title="webkit_website_data_manager_fetch ()"><code class="function">webkit_website_data_manager_fetch()</code></a> instead.</p>
</div>
<p>Asynchronously get the list of domains for which <em class="parameter"><code>cookie_manager</code></em>
 contains cookies.</p>
<p>When the operation is finished, <em class="parameter"><code>callback</code></em>
 will be called. You can then call
<a class="link" href="WebKitCookieManager.html#webkit-cookie-manager-get-domains-with-cookies-finish" title="webkit_cookie_manager_get_domains_with_cookies_finish ()"><code class="function">webkit_cookie_manager_get_domains_with_cookies_finish()</code></a> to get the result of the operation.</p>
<div class="refsect3">
<a name="webkit-cookie-manager-get-domains-with-cookies.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cookie_manager</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitCookieManager.html" title="WebKitCookieManager"><span class="type">WebKitCookieManager</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>a <a href="../gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> to call when the request is satisfied. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>the data to pass to callback function. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
441
</div>
442 443
<hr>
<div class="refsect2">
444 445 446 447
<a name="webkit-cookie-manager-get-domains-with-cookies-finish"></a><h3>webkit_cookie_manager_get_domains_with_cookies_finish ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **
webkit_cookie_manager_get_domains_with_cookies_finish
                               (<em class="parameter"><code><a class="link" href="WebKitCookieManager.html" title="WebKitCookieManager"><span class="type">WebKitCookieManager</span></a> *cookie_manager</code></em>,
448
                                <em class="parameter"><code><a href="../gio/GAsyncResult.html#GAsyncResult-struct"><span class="type">GAsyncResult</span></a> *result</code></em>,
449
                                <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
<div class="warning">
<p><code class="literal">webkit_cookie_manager_get_domains_with_cookies_finish</code> has been deprecated since version 2.16 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="WebKitWebsiteDataManager.html#webkit-website-data-manager-fetch-finish" title="webkit_website_data_manager_fetch_finish ()"><code class="function">webkit_website_data_manager_fetch_finish()</code></a> instead.</p>
</div>
<p>Finish an asynchronous operation started with <a class="link" href="WebKitCookieManager.html#webkit-cookie-manager-get-domains-with-cookies" title="webkit_cookie_manager_get_domains_with_cookies ()"><code class="function">webkit_cookie_manager_get_domains_with_cookies()</code></a>.
The return value is a <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated list of strings which should
be released with <a href="../glib/glib-String-Utility-Functions.html#g-strfreev"><code class="function">g_strfreev()</code></a>.</p>
<div class="refsect3">
<a name="webkit-cookie-manager-get-domains-with-cookies-finish.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cookie_manager</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitCookieManager.html" title="WebKitCookieManager"><span class="type">WebKitCookieManager</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>result</p></td>
<td class="parameter_description"><p>a <a href="../gio/GAsyncResult.html#GAsyncResult-struct"><span class="type">GAsyncResult</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for error or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-cookie-manager-get-domains-with-cookies-finish.returns"></a><h4>Returns</h4>
<p>A <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated array of domain names
or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> in case of error. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span></p>
</div>
490 491 492
</div>
<hr>
<div class="refsect2">
Alberto Garcia's avatar
Alberto Garcia committed
493 494 495
<a name="webkit-cookie-manager-add-cookie"></a><h3>webkit_cookie_manager_add_cookie ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
webkit_cookie_manager_add_cookie (<em class="parameter"><code><a class="link" href="WebKitCookieManager.html" title="WebKitCookieManager"><span class="type">WebKitCookieManager</span></a> *cookie_manager</code></em>,
Alberto Garcia's avatar
Alberto Garcia committed
496
                                  <em class="parameter"><code><a href="../libsoup-2.4/SoupCookie.html#SoupCookie-struct"><span class="type">SoupCookie</span></a> *cookie</code></em>,
Alberto Garcia's avatar
Alberto Garcia committed
497 498 499
                                  <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>,
                                  <em class="parameter"><code><a href="../gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
                                  <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
500
<p>Asynchronously add a <a href="../libsoup-2.4/SoupCookie.html#SoupCookie-struct"><span class="type">SoupCookie</span></a> to the underlying storage.</p>
Alberto Garcia's avatar
Alberto Garcia committed
501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519
<p>When the operation is finished, <em class="parameter"><code>callback</code></em>
 will be called. You can then call
<a class="link" href="WebKitCookieManager.html#webkit-cookie-manager-add-cookie-finish" title="webkit_cookie_manager_add_cookie_finish ()"><code class="function">webkit_cookie_manager_add_cookie_finish()</code></a> to get the result of the operation.</p>
<div class="refsect3">
<a name="webkit-cookie-manager-add-cookie.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cookie_manager</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitCookieManager.html" title="WebKitCookieManager"><span class="type">WebKitCookieManager</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cookie</p></td>
Alberto Garcia's avatar
Alberto Garcia committed
520
<td class="parameter_description"><p>the <a href="../libsoup-2.4/SoupCookie.html#SoupCookie-struct"><span class="type">SoupCookie</span></a> to be added</p></td>
Alberto Garcia's avatar
Alberto Garcia committed
521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>a <a href="../gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> to call when the request is satisfied. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>the data to pass to callback function. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-20.html#api-index-2.20">2.20</a></p>
</div>
<hr>
<div class="refsect2">
<a name="webkit-cookie-manager-add-cookie-finish"></a><h3>webkit_cookie_manager_add_cookie_finish ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
webkit_cookie_manager_add_cookie_finish
                               (<em class="parameter"><code><a class="link" href="WebKitCookieManager.html" title="WebKitCookieManager"><span class="type">WebKitCookieManager</span></a> *cookie_manager</code></em>,
                                <em class="parameter"><code><a href="../gio/GAsyncResult.html#GAsyncResult-struct"><span class="type">GAsyncResult</span></a> *result</code></em>,
                                <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Finish an asynchronous operation started with <a class="link" href="WebKitCookieManager.html#webkit-cookie-manager-add-cookie" title="webkit_cookie_manager_add_cookie ()"><code class="function">webkit_cookie_manager_add_cookie()</code></a>.</p>
<div class="refsect3">
<a name="webkit-cookie-manager-add-cookie-finish.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cookie_manager</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitCookieManager.html" title="WebKitCookieManager"><span class="type">WebKitCookieManager</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>result</p></td>
<td class="parameter_description"><p>a <a href="../gio/GAsyncResult.html#GAsyncResult-struct"><span class="type">GAsyncResult</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for error or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-cookie-manager-add-cookie-finish.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the cookie was added or <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> in case of error.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-20.html#api-index-2.20">2.20</a></p>
</div>
<hr>
<div class="refsect2">
<a name="webkit-cookie-manager-get-cookies"></a><h3>webkit_cookie_manager_get_cookies ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
webkit_cookie_manager_get_cookies (<em class="parameter"><code><a class="link" href="WebKitCookieManager.html" title="WebKitCookieManager"><span class="type">WebKitCookieManager</span></a> *cookie_manager</code></em>,
                                   <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri</code></em>,
                                   <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>,
                                   <em class="parameter"><code><a href="../gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
                                   <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
594
<p>Asynchronously get a list of <a href="../libsoup-2.4/SoupCookie.html#SoupCookie-struct"><span class="type">SoupCookie</span></a> from <em class="parameter"><code>cookie_manager</code></em>
Alberto Garcia's avatar
Alberto Garcia committed
595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648
 associated with <em class="parameter"><code>uri</code></em>
, which
must be either an HTTP or an HTTPS URL.</p>
<p>When the operation is finished, <em class="parameter"><code>callback</code></em>
 will be called. You can then call
<a class="link" href="WebKitCookieManager.html#webkit-cookie-manager-get-cookies-finish" title="webkit_cookie_manager_get_cookies_finish ()"><code class="function">webkit_cookie_manager_get_cookies_finish()</code></a> to get the result of the operation.</p>
<div class="refsect3">
<a name="webkit-cookie-manager-get-cookies.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cookie_manager</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitCookieManager.html" title="WebKitCookieManager"><span class="type">WebKitCookieManager</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uri</p></td>
<td class="parameter_description"><p>the URI associated to the cookies to be retrieved</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>a <a href="../gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> to call when the request is satisfied. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>the data to pass to callback function. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-20.html#api-index-2.20">2.20</a></p>
</div>
<hr>
<div class="refsect2">
<a name="webkit-cookie-manager-get-cookies-finish"></a><h3>webkit_cookie_manager_get_cookies_finish ()</h3>
<pre class="programlisting"><a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
webkit_cookie_manager_get_cookies_finish
                               (<em class="parameter"><code><a class="link" href="WebKitCookieManager.html" title="WebKitCookieManager"><span class="type">WebKitCookieManager</span></a> *cookie_manager</code></em>,
                                <em class="parameter"><code><a href="../gio/GAsyncResult.html#GAsyncResult-struct"><span class="type">GAsyncResult</span></a> *result</code></em>,
                                <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Finish an asynchronous operation started with <a class="link" href="WebKitCookieManager.html#webkit-cookie-manager-get-cookies" title="webkit_cookie_manager_get_cookies ()"><code class="function">webkit_cookie_manager_get_cookies()</code></a>.
Alberto Garcia's avatar
Alberto Garcia committed
649 650
The return value is a <a href="../glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of <a href="../libsoup-2.4/SoupCookie.html#SoupCookie-struct"><span class="type">SoupCookie</span></a> instances which should be released
with <a href="../glib/glib-Doubly-Linked-Lists.html#g-list-free-full"><code class="function">g_list_free_full()</code></a> and <a href="../libsoup-2.4/SoupCookie.html#soup-cookie-free"><code class="function">soup_cookie_free()</code></a>.</p>
Alberto Garcia's avatar
Alberto Garcia committed
651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
<div class="refsect3">
<a name="webkit-cookie-manager-get-cookies-finish.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cookie_manager</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitCookieManager.html" title="WebKitCookieManager"><span class="type">WebKitCookieManager</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>result</p></td>
<td class="parameter_description"><p>a <a href="../gio/GAsyncResult.html#GAsyncResult-struct"><span class="type">GAsyncResult</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for error or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-cookie-manager-get-cookies-finish.returns"></a><h4>Returns</h4>
Alberto Garcia's avatar
Alberto Garcia committed
680
<p>A <a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of <a href="../libsoup-2.4/SoupCookie.html#SoupCookie-struct"><span class="type">SoupCookie</span></a> instances. </p>
Alberto Garcia's avatar
Alberto Garcia committed
681 682 683 684 685 686 687 688 689
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> SoupCookie][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-20.html#api-index-2.20">2.20</a></p>
</div>
<hr>
<div class="refsect2">
<a name="webkit-cookie-manager-delete-cookie"></a><h3>webkit_cookie_manager_delete_cookie ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
webkit_cookie_manager_delete_cookie (<em class="parameter"><code><a class="link" href="WebKitCookieManager.html" title="WebKitCookieManager"><span class="type">WebKitCookieManager</span></a> *cookie_manager</code></em>,
Alberto Garcia's avatar
Alberto Garcia committed
690
                                     <em class="parameter"><code><a href="../libsoup-2.4/SoupCookie.html#SoupCookie-struct"><span class="type">SoupCookie</span></a> *cookie</code></em>,
Alberto Garcia's avatar
Alberto Garcia committed
691 692 693
                                     <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>,
                                     <em class="parameter"><code><a href="../gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
                                     <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
694
<p>Asynchronously delete a <a href="../libsoup-2.4/SoupCookie.html#SoupCookie-struct"><span class="type">SoupCookie</span></a> from the current session.</p>
Alberto Garcia's avatar
Alberto Garcia committed
695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713
<p>When the operation is finished, <em class="parameter"><code>callback</code></em>
 will be called. You can then call
<a class="link" href="WebKitCookieManager.html#webkit-cookie-manager-delete-cookie-finish" title="webkit_cookie_manager_delete_cookie_finish ()"><code class="function">webkit_cookie_manager_delete_cookie_finish()</code></a> to get the result of the operation.</p>
<div class="refsect3">
<a name="webkit-cookie-manager-delete-cookie.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cookie_manager</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitCookieManager.html" title="WebKitCookieManager"><span class="type">WebKitCookieManager</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cookie</p></td>
Alberto Garcia's avatar
Alberto Garcia committed
714
<td class="parameter_description"><p>the <a href="../libsoup-2.4/SoupCookie.html#SoupCookie-struct"><span class="type">SoupCookie</span></a> to be deleted</p></td>
Alberto Garcia's avatar
Alberto Garcia committed
715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>a <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>a <a href="../gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> to call when the request is satisfied. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>the data to pass to callback function. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-20.html#api-index-2.20">2.20</a></p>
</div>
<hr>
<div class="refsect2">
<a name="webkit-cookie-manager-delete-cookie-finish"></a><h3>webkit_cookie_manager_delete_cookie_finish ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
webkit_cookie_manager_delete_cookie_finish
                               (<em class="parameter"><code><a class="link" href="WebKitCookieManager.html" title="WebKitCookieManager"><span class="type">WebKitCookieManager</span></a> *cookie_manager</code></em>,
                                <em class="parameter"><code><a href="../gio/GAsyncResult.html#GAsyncResult-struct"><span class="type">GAsyncResult</span></a> *result</code></em>,
                                <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Finish an asynchronous operation started with <a class="link" href="WebKitCookieManager.html#webkit-cookie-manager-delete-cookie" title="webkit_cookie_manager_delete_cookie ()"><code class="function">webkit_cookie_manager_delete_cookie()</code></a>.</p>
<div class="refsect3">
<a name="webkit-cookie-manager-delete-cookie-finish.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cookie_manager</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitCookieManager.html" title="WebKitCookieManager"><span class="type">WebKitCookieManager</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>result</p></td>
<td class="parameter_description"><p>a <a href="../gio/GAsyncResult.html#GAsyncResult-struct"><span class="type">GAsyncResult</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for error or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-cookie-manager-delete-cookie-finish.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the cookie was deleted or <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> in case of error.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-20.html#api-index-2.20">2.20</a></p>
</div>
<hr>
<div class="refsect2">
781 782 783 784 785
<a name="webkit-cookie-manager-delete-cookies-for-domain"></a><h3>webkit_cookie_manager_delete_cookies_for_domain ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
webkit_cookie_manager_delete_cookies_for_domain
                               (<em class="parameter"><code><a class="link" href="WebKitCookieManager.html" title="WebKitCookieManager"><span class="type">WebKitCookieManager</span></a> *cookie_manager</code></em>,
                                <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *domain</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814
<div class="warning">
<p><code class="literal">webkit_cookie_manager_delete_cookies_for_domain</code> has been deprecated since version 2.16 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="WebKitWebsiteDataManager.html#webkit-website-data-manager-remove" title="webkit_website_data_manager_remove ()"><code class="function">webkit_website_data_manager_remove()</code></a> instead.</p>
</div>
<p>Remove all cookies of <em class="parameter"><code>cookie_manager</code></em>
 for the given <em class="parameter"><code>domain</code></em>
.</p>
<div class="refsect3">
<a name="webkit-cookie-manager-delete-cookies-for-domain.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cookie_manager</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitCookieManager.html" title="WebKitCookieManager"><span class="type">WebKitCookieManager</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>domain</p></td>
<td class="parameter_description"><p>a domain name</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
815
</div>
816 817
<hr>
<div class="refsect2">
818 819 820 821
<a name="webkit-cookie-manager-delete-all-cookies"></a><h3>webkit_cookie_manager_delete_all_cookies ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
webkit_cookie_manager_delete_all_cookies
                               (<em class="parameter"><code><a class="link" href="WebKitCookieManager.html" title="WebKitCookieManager"><span class="type">WebKitCookieManager</span></a> *cookie_manager</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842
<div class="warning">
<p><code class="literal">webkit_cookie_manager_delete_all_cookies</code> has been deprecated since version 2.16 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="WebKitWebsiteDataManager.html#webkit-website-data-manager-clear" title="webkit_website_data_manager_clear ()"><code class="function">webkit_website_data_manager_clear()</code></a> instead.</p>
</div>
<p>Delete all cookies of <em class="parameter"><code>cookie_manager</code></em>
</p>
<div class="refsect3">
<a name="webkit-cookie-manager-delete-all-cookies.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>cookie_manager</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitCookieManager.html" title="WebKitCookieManager"><span class="type">WebKitCookieManager</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
843 844 845 846 847 848 849 850 851 852 853 854 855
</div>
</div>
<div class="refsect1">
<a name="WebKitCookieManager.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="WebKitCookieManager-struct"></a><h3>struct WebKitCookieManager</h3>
<pre class="programlisting">struct WebKitCookieManager;</pre>
</div>
<hr>
<div class="refsect2">
<a name="WebKitCookiePersistentStorage"></a><h3>enum WebKitCookiePersistentStorage</h3>
<p>Enum values used to denote the cookie persistent storage types.</p>
<div class="refsect3">
856
<a name="WebKitCookiePersistentStorage.members"></a><h4>Members</h4>
857
<div class="informaltable"><table class="informaltable" width="100%" border="0">
858
<colgroup>
859 860 861
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
862
</colgroup>
863 864
<tbody>
<tr>
865 866 867
<td class="enum_member_name"><p><a name="WEBKIT-COOKIE-PERSISTENT-STORAGE-TEXT:CAPS"></a>WEBKIT_COOKIE_PERSISTENT_STORAGE_TEXT</p></td>
<td class="enum_member_description">
<p>Cookies are stored in a text
Alberto Garcia's avatar
Alberto Garcia committed
868
file in the Mozilla "cookies.txt" format.</p>
869
</td>
870
<td class="enum_member_annotations"> </td>
871 872
</tr>
<tr>
873 874 875
<td class="enum_member_name"><p><a name="WEBKIT-COOKIE-PERSISTENT-STORAGE-SQLITE:CAPS"></a>WEBKIT_COOKIE_PERSISTENT_STORAGE_SQLITE</p></td>
<td class="enum_member_description">
<p>Cookies are stored in a SQLite
Alberto Garcia's avatar
Alberto Garcia committed
876
file in the current Mozilla format.</p>
877 878
</td>
<td class="enum_member_annotations"> </td>
879 880 881 882
</tr>
</tbody>
</table></div>
</div>
883
</div>
884 885
<hr>
<div class="refsect2">
886 887 888
<a name="WebKitCookieAcceptPolicy"></a><h3>enum WebKitCookieAcceptPolicy</h3>
<p>Enum values used to denote the cookie acceptance policies.</p>
<div class="refsect3">
889
<a name="WebKitCookieAcceptPolicy.members"></a><h4>Members</h4>
890
<div class="informaltable"><table class="informaltable" width="100%" border="0">
891
<colgroup>
892 893 894
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
895
</colgroup>
896 897 898 899 900
<tbody>
<tr>
<td class="enum_member_name"><p><a name="WEBKIT-COOKIE-POLICY-ACCEPT-ALWAYS:CAPS"></a>WEBKIT_COOKIE_POLICY_ACCEPT_ALWAYS</p></td>
<td class="enum_member_description">
<p>Accept all cookies unconditionally.</p>
901
</td>
902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="WEBKIT-COOKIE-POLICY-ACCEPT-NEVER:CAPS"></a>WEBKIT_COOKIE_POLICY_ACCEPT_NEVER</p></td>
<td class="enum_member_description">
<p>Reject all cookies unconditionally.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="WEBKIT-COOKIE-POLICY-ACCEPT-NO-THIRD-PARTY:CAPS"></a>WEBKIT_COOKIE_POLICY_ACCEPT_NO_THIRD_PARTY</p></td>
<td class="enum_member_description">
<p>Accept only cookies set by the main document loaded.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
919 920 921
</table></div>
</div>
</div>
922
</div>
923 924 925
<div class="refsect1">
<a name="WebKitCookieManager.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
926 927
<a name="WebKitCookieManager-changed"></a><h3>The <code class="literal">“changed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
Alberto Garcia's avatar
Alberto Garcia committed
928
user_function (<a class="link" href="WebKitCookieManager.html" title="WebKitCookieManager"><span class="type">WebKitCookieManager</span></a> *cookie_manager,
929
               <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>             user_data)</pre>
Alberto Garcia's avatar
Alberto Garcia committed
930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952
<p>This signal is emitted when cookies are added, removed or modified.</p>
<div class="refsect3">
<a name="WebKitCookieManager-changed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cookie_manager</p></td>
<td class="parameter_description"><p>the <a class="link" href="WebKitCookieManager.html" title="WebKitCookieManager"><span class="type">WebKitCookieManager</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
Alberto Garcia's avatar
Alberto Garcia committed
953
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
954
</div>
955 956 957
</div>
</div>
<div class="footer">
Alberto Garcia's avatar
Alberto Garcia committed
958
<hr>Generated by GTK-Doc V1.33.0</div>
959 960
</body>
</html>