WebKitAuthenticationRequest.html 50.6 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">
5
<title>WebKitAuthenticationRequest: WebKit2GTK+ Reference Manual</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7 8 9 10
<link rel="home" href="index.html" title="WebKit2GTK+ Reference Manual">
<link rel="up" href="ch01.html" title="Class Overview">
<link rel="prev" href="WebKitWebView.html" title="WebKitWebView">
<link rel="next" href="WebKitBackForwardList.html" title="WebKitBackForwardList">
Alberto Garcia's avatar
Alberto Garcia committed
11
<meta name="generator" content="GTK-Doc V1.26.1 (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="#WebKitAuthenticationRequest.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#WebKitAuthenticationRequest.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_signals">  <span class="dim">|</span> 
20
                  <a href="#WebKitAuthenticationRequest.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="WebKitWebView.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="WebKitBackForwardList.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="WebKitAuthenticationRequest"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="WebKitAuthenticationRequest.top_of_page"></a>WebKitAuthenticationRequest</span></h2>
Alberto Garcia's avatar
Alberto Garcia committed
32
<p>WebKitAuthenticationRequest — Represents an authentication request</p>
33
</td>
34
<td class="gallery_image" valign="top" align="right"></td>
35 36
</tr></table></div>
<div class="refsect1">
37
<a name="WebKitAuthenticationRequest.functions"></a><h2>Functions</h2>
38
<div class="informaltable"><table class="informaltable" width="100%" border="0">
39
<colgroup>
40 41
<col width="150px" class="functions_return">
<col class="functions_name">
42 43 44
</colgroup>
<tbody>
<tr>
45 46 47 48 49
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="WebKitAuthenticationRequest.html#webkit-authentication-request-authenticate" title="webkit_authentication_request_authenticate ()">webkit_authentication_request_authenticate</a> <span class="c_punctuation">()</span>
50 51 52
</td>
</tr>
<tr>
53 54 55 56 57
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="WebKitAuthenticationRequest.html#webkit-authentication-request-cancel" title="webkit_authentication_request_cancel ()">webkit_authentication_request_cancel</a> <span class="c_punctuation">()</span>
58 59 60
</td>
</tr>
<tr>
61 62 63 64 65
<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="WebKitAuthenticationRequest.html#webkit-authentication-request-can-save-credentials" title="webkit_authentication_request_can_save_credentials ()">webkit_authentication_request_can_save_credentials</a> <span class="c_punctuation">()</span>
66 67 68
</td>
</tr>
<tr>
69 70 71 72
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="WebKitAuthenticationRequest.html#webkit-authentication-request-get-host" title="webkit_authentication_request_get_host ()">webkit_authentication_request_get_host</a> <span class="c_punctuation">()</span>
73 74 75
</td>
</tr>
<tr>
76 77 78 79 80
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
</td>
<td class="function_name">
<a class="link" href="WebKitAuthenticationRequest.html#webkit-authentication-request-get-port" title="webkit_authentication_request_get_port ()">webkit_authentication_request_get_port</a> <span class="c_punctuation">()</span>
81 82 83
</td>
</tr>
<tr>
84 85 86 87 88
<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="WebKitAuthenticationRequest.html#webkit-authentication-request-is-retry" title="webkit_authentication_request_is_retry ()">webkit_authentication_request_is_retry</a> <span class="c_punctuation">()</span>
89 90 91
</td>
</tr>
<tr>
92 93 94 95 96
<td class="function_type">
<a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="returnvalue">WebKitCredential</span></a> *
</td>
<td class="function_name">
<a class="link" href="WebKitAuthenticationRequest.html#webkit-authentication-request-get-proposed-credential" title="webkit_authentication_request_get_proposed_credential ()">webkit_authentication_request_get_proposed_credential</a> <span class="c_punctuation">()</span>
97 98 99
</td>
</tr>
<tr>
100 101 102 103
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="WebKitAuthenticationRequest.html#webkit-authentication-request-get-realm" title="webkit_authentication_request_get_realm ()">webkit_authentication_request_get_realm</a> <span class="c_punctuation">()</span>
104 105 106
</td>
</tr>
<tr>
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 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
<td class="function_type">
<a class="link" href="WebKitAuthenticationRequest.html#WebKitAuthenticationScheme" title="enum WebKitAuthenticationScheme"><span class="returnvalue">WebKitAuthenticationScheme</span></a>
</td>
<td class="function_name">
<a class="link" href="WebKitAuthenticationRequest.html#webkit-authentication-request-get-scheme" title="webkit_authentication_request_get_scheme ()">webkit_authentication_request_get_scheme</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="WebKitAuthenticationRequest.html#webkit-authentication-request-is-for-proxy" title="webkit_authentication_request_is_for_proxy ()">webkit_authentication_request_is_for_proxy</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="returnvalue">WebKitCredential</span></a> *
</td>
<td class="function_name">
<a class="link" href="WebKitAuthenticationRequest.html#webkit-credential-new" title="webkit_credential_new ()">webkit_credential_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="returnvalue">WebKitCredential</span></a> *
</td>
<td class="function_name">
<a class="link" href="WebKitAuthenticationRequest.html#webkit-credential-copy" title="webkit_credential_copy ()">webkit_credential_copy</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="WebKitAuthenticationRequest.html#webkit-credential-free" title="webkit_credential_free ()">webkit_credential_free</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="WebKitAuthenticationRequest.html#webkit-credential-get-password" title="webkit_credential_get_password ()">webkit_credential_get_password</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="WebKitAuthenticationRequest.html#WebKitCredentialPersistence" title="enum WebKitCredentialPersistence"><span class="returnvalue">WebKitCredentialPersistence</span></a>
</td>
<td class="function_name">
<a class="link" href="WebKitAuthenticationRequest.html#webkit-credential-get-persistence" title="webkit_credential_get_persistence ()">webkit_credential_get_persistence</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="WebKitAuthenticationRequest.html#webkit-credential-get-username" title="webkit_credential_get_username ()">webkit_credential_get_username</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="WebKitAuthenticationRequest.html#webkit-credential-has-password" title="webkit_credential_has_password ()">webkit_credential_has_password</a> <span class="c_punctuation">()</span>
174 175 176 177 178
</td>
</tr>
</tbody>
</table></div>
</div>
179 180
<div class="refsect1">
<a name="WebKitAuthenticationRequest.signals"></a><h2>Signals</h2>
181
<div class="informaltable"><table class="informaltable" border="0">
182 183 184 185 186 187 188 189
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="WebKitAuthenticationRequest.html#WebKitAuthenticationRequest-cancelled" title="The “cancelled” signal">cancelled</a></td>
Alberto Garcia's avatar
Alberto Garcia committed
190
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
191 192 193 194 195
</tr></tbody>
</table></div>
</div>
<a name="WebKitCredential"></a><div class="refsect1">
<a name="WebKitAuthenticationRequest.other"></a><h2>Types and Values</h2>
196
<div class="informaltable"><table class="informaltable" width="100%" border="0">
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="WebKitAuthenticationRequest.html#WebKitAuthenticationRequest-struct" title="struct WebKitAuthenticationRequest">WebKitAuthenticationRequest</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="WebKitAuthenticationRequest.html#WebKitAuthenticationScheme" title="enum WebKitAuthenticationScheme">WebKitAuthenticationScheme</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential-struct" title="WebKitCredential">WebKitCredential</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="WebKitAuthenticationRequest.html#WebKitCredentialPersistence" title="enum WebKitCredentialPersistence">WebKitCredentialPersistence</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="WebKitAuthenticationRequest.object-hierarchy"></a><h2>Object Hierarchy</h2>
223
<pre class="screen">    <a href="/home/cgarcia/gnome/share/gtk-doc/html/gobject/gobject-Boxed-Types.html">GBoxed</a>
224
    <span class="lineart">╰──</span> WebKitCredential
225
    <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
226 227 228 229 230
    <span class="lineart">╰──</span> WebKitAuthenticationRequest
</pre>
</div>
<div class="refsect1">
<a name="WebKitAuthenticationRequest.description"></a><h2>Description</h2>
Alberto Garcia's avatar
Alberto Garcia committed
231 232 233 234 235 236 237 238 239 240 241
<p>Whenever a client attempts to load a page protected by HTTP
authentication, credentials will need to be provided to authorize access.
To allow the client to decide how it wishes to handle authentication,
WebKit will fire a <a class="link" href="WebKitWebView.html#WebKitWebView-authenticate" title="The “authenticate” signal"><span class="type">“authenticate”</span></a> signal with a
WebKitAuthenticationRequest object to provide client side
authentication support. Credentials are exposed through the
<a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="type">WebKitCredential</span></a> object.</p>
<p>In case the client application does not wish
to handle this signal WebKit will provide a default handler. To handle
authentication asynchronously, simply increase the reference count of the
WebKitAuthenticationRequest object.</p>
242 243 244
</div>
<div class="refsect1">
<a name="WebKitAuthenticationRequest.functions_details"></a><h2>Functions</h2>
245
<div class="refsect2">
246 247 248 249 250
<a name="webkit-authentication-request-authenticate"></a><h3>webkit_authentication_request_authenticate ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
webkit_authentication_request_authenticate
                               (<em class="parameter"><code><a class="link" href="WebKitAuthenticationRequest.html" title="WebKitAuthenticationRequest"><span class="type">WebKitAuthenticationRequest</span></a> *request</code></em>,
                                <em class="parameter"><code><a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="type">WebKitCredential</span></a> *credential</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
<p>Authenticate the <a class="link" href="WebKitAuthenticationRequest.html" title="WebKitAuthenticationRequest"><span class="type">WebKitAuthenticationRequest</span></a> using the <a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="type">WebKitCredential</span></a>
supplied. To continue without credentials, pass <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> as <em class="parameter"><code>credential</code></em>
.</p>
<div class="refsect3">
<a name="webkit-authentication-request-authenticate.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>request</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitAuthenticationRequest.html" title="WebKitAuthenticationRequest"><span class="type">WebKitAuthenticationRequest</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>credential</p></td>
<td class="parameter_description"><p>A <a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="type">WebKitCredential</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
277 278 279
</div>
<hr>
<div class="refsect2">
280 281 282
<a name="webkit-authentication-request-cancel"></a><h3>webkit_authentication_request_cancel ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
webkit_authentication_request_cancel (<em class="parameter"><code><a class="link" href="WebKitAuthenticationRequest.html" title="WebKitAuthenticationRequest"><span class="type">WebKitAuthenticationRequest</span></a> *request</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
<p>Cancel the authentication challenge. This will also cancel the page loading and result in a
<a class="link" href="WebKitWebView.html#WebKitWebView-load-failed" title="The “load-failed” signal"><span class="type">“load-failed”</span></a> signal with a <a class="link" href="webkit2gtk-4.0-WebKitError.html#WebKitNetworkError" title="enum WebKitNetworkError"><span class="type">WebKitNetworkError</span></a> of type <a class="link" href="webkit2gtk-4.0-WebKitError.html#WEBKIT-NETWORK-ERROR-CANCELLED:CAPS"><code class="literal">WEBKIT_NETWORK_ERROR_CANCELLED</code></a> being emitted.</p>
<div class="refsect3">
<a name="webkit-authentication-request-cancel.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>request</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitAuthenticationRequest.html" title="WebKitAuthenticationRequest"><span class="type">WebKitAuthenticationRequest</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
301 302 303
</div>
<hr>
<div class="refsect2">
304 305 306 307
<a name="webkit-authentication-request-can-save-credentials"></a><h3>webkit_authentication_request_can_save_credentials ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
webkit_authentication_request_can_save_credentials
                               (<em class="parameter"><code><a class="link" href="WebKitAuthenticationRequest.html" title="WebKitAuthenticationRequest"><span class="type">WebKitAuthenticationRequest</span></a> *request</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
<p>Determine whether the authentication method associated with this
<a class="link" href="WebKitAuthenticationRequest.html" title="WebKitAuthenticationRequest"><span class="type">WebKitAuthenticationRequest</span></a> should allow the storage of credentials.
This will return <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if WebKit doesn't support credential storing
or if private browsing is enabled.</p>
<div class="refsect3">
<a name="webkit-authentication-request-can-save-credentials.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>request</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitAuthenticationRequest.html" title="WebKitAuthenticationRequest"><span class="type">WebKitAuthenticationRequest</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-authentication-request-can-save-credentials.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if WebKit can store credentials or <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
332 333 334
</div>
<hr>
<div class="refsect2">
335 336 337 338
<a name="webkit-authentication-request-get-host"></a><h3>webkit_authentication_request_get_host ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
webkit_authentication_request_get_host
                               (<em class="parameter"><code><a class="link" href="WebKitAuthenticationRequest.html" title="WebKitAuthenticationRequest"><span class="type">WebKitAuthenticationRequest</span></a> *request</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
<p>Get the host that this authentication challenge is applicable to.</p>
<div class="refsect3">
<a name="webkit-authentication-request-get-host.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>request</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitAuthenticationRequest.html" title="WebKitAuthenticationRequest"><span class="type">WebKitAuthenticationRequest</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-authentication-request-get-host.returns"></a><h4>Returns</h4>
<p> The host of <em class="parameter"><code>request</code></em>
.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
361 362 363
</div>
<hr>
<div class="refsect2">
364 365 366 367
<a name="webkit-authentication-request-get-port"></a><h3>webkit_authentication_request_get_port ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
webkit_authentication_request_get_port
                               (<em class="parameter"><code><a class="link" href="WebKitAuthenticationRequest.html" title="WebKitAuthenticationRequest"><span class="type">WebKitAuthenticationRequest</span></a> *request</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
<p>Get the port that this authentication challenge is applicable to.</p>
<div class="refsect3">
<a name="webkit-authentication-request-get-port.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>request</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitAuthenticationRequest.html" title="WebKitAuthenticationRequest"><span class="type">WebKitAuthenticationRequest</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-authentication-request-get-port.returns"></a><h4>Returns</h4>
<p> The port of <em class="parameter"><code>request</code></em>
.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
390 391 392
</div>
<hr>
<div class="refsect2">
393 394 395 396
<a name="webkit-authentication-request-is-retry"></a><h3>webkit_authentication_request_is_retry ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
webkit_authentication_request_is_retry
                               (<em class="parameter"><code><a class="link" href="WebKitAuthenticationRequest.html" title="WebKitAuthenticationRequest"><span class="type">WebKitAuthenticationRequest</span></a> *request</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417
<p>Determine whether this this is a first attempt or a retry for this authentication challenge.</p>
<div class="refsect3">
<a name="webkit-authentication-request-is-retry.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>request</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitAuthenticationRequest.html" title="WebKitAuthenticationRequest"><span class="type">WebKitAuthenticationRequest</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-authentication-request-is-retry.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if authentication attempt is a retry or <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
418 419 420
</div>
<hr>
<div class="refsect2">
421 422 423 424
<a name="webkit-authentication-request-get-proposed-credential"></a><h3>webkit_authentication_request_get_proposed_credential ()</h3>
<pre class="programlisting"><a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="returnvalue">WebKitCredential</span></a> *
webkit_authentication_request_get_proposed_credential
                               (<em class="parameter"><code><a class="link" href="WebKitAuthenticationRequest.html" title="WebKitAuthenticationRequest"><span class="type">WebKitAuthenticationRequest</span></a> *request</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
<p>Get the <a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="type">WebKitCredential</span></a> of the proposed authentication challenge that was
stored from a previous session. The client can use this directly for
authentication or construct their own <a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="type">WebKitCredential</span></a>.</p>
<div class="refsect3">
<a name="webkit-authentication-request-get-proposed-credential.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>request</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitAuthenticationRequest.html" title="WebKitAuthenticationRequest"><span class="type">WebKitAuthenticationRequest</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-authentication-request-get-proposed-credential.returns"></a><h4>Returns</h4>
<p>A <a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="type">WebKitCredential</span></a> encapsulating credential details
or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if there is no stored credential. </p>
<p><span class="annotation">[<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-2.html#api-index-2.2">2.2</a></p>
450 451 452
</div>
<hr>
<div class="refsect2">
453 454 455 456
<a name="webkit-authentication-request-get-realm"></a><h3>webkit_authentication_request_get_realm ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
webkit_authentication_request_get_realm
                               (<em class="parameter"><code><a class="link" href="WebKitAuthenticationRequest.html" title="WebKitAuthenticationRequest"><span class="type">WebKitAuthenticationRequest</span></a> *request</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
<p>Get the realm that this authentication challenge is applicable to.</p>
<div class="refsect3">
<a name="webkit-authentication-request-get-realm.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>request</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitAuthenticationRequest.html" title="WebKitAuthenticationRequest"><span class="type">WebKitAuthenticationRequest</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-authentication-request-get-realm.returns"></a><h4>Returns</h4>
<p> The realm of <em class="parameter"><code>request</code></em>
.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
479 480 481
</div>
<hr>
<div class="refsect2">
482 483 484 485
<a name="webkit-authentication-request-get-scheme"></a><h3>webkit_authentication_request_get_scheme ()</h3>
<pre class="programlisting"><a class="link" href="WebKitAuthenticationRequest.html#WebKitAuthenticationScheme" title="enum WebKitAuthenticationScheme"><span class="returnvalue">WebKitAuthenticationScheme</span></a>
webkit_authentication_request_get_scheme
                               (<em class="parameter"><code><a class="link" href="WebKitAuthenticationRequest.html" title="WebKitAuthenticationRequest"><span class="type">WebKitAuthenticationRequest</span></a> *request</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
<p>Get the authentication scheme of the authentication challenge.</p>
<div class="refsect3">
<a name="webkit-authentication-request-get-scheme.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>request</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitAuthenticationRequest.html" title="WebKitAuthenticationRequest"><span class="type">WebKitAuthenticationRequest</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-authentication-request-get-scheme.returns"></a><h4>Returns</h4>
<p> The <a class="link" href="WebKitAuthenticationRequest.html#WebKitAuthenticationScheme" title="enum WebKitAuthenticationScheme"><span class="type">WebKitAuthenticationScheme</span></a> of <em class="parameter"><code>request</code></em>
.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
508 509 510
</div>
<hr>
<div class="refsect2">
511 512 513 514
<a name="webkit-authentication-request-is-for-proxy"></a><h3>webkit_authentication_request_is_for_proxy ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
webkit_authentication_request_is_for_proxy
                               (<em class="parameter"><code><a class="link" href="WebKitAuthenticationRequest.html" title="WebKitAuthenticationRequest"><span class="type">WebKitAuthenticationRequest</span></a> *request</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
<p>Determine whether the authentication challenge is associated with a proxy server rather than an "origin" server.</p>
<div class="refsect3">
<a name="webkit-authentication-request-is-for-proxy.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>request</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitAuthenticationRequest.html" title="WebKitAuthenticationRequest"><span class="type">WebKitAuthenticationRequest</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-authentication-request-is-for-proxy.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if authentication is for a proxy or <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
536 537 538
</div>
<hr>
<div class="refsect2">
539 540 541 542 543
<a name="webkit-credential-new"></a><h3>webkit_credential_new ()</h3>
<pre class="programlisting"><a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="returnvalue">WebKitCredential</span></a> *
webkit_credential_new (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *username</code></em>,
                       <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *password</code></em>,
                       <em class="parameter"><code><a class="link" href="WebKitAuthenticationRequest.html#WebKitCredentialPersistence" title="enum WebKitCredentialPersistence"><span class="type">WebKitCredentialPersistence</span></a> persistence</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
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
<p>Create a new credential from the provided username, password and persistence mode.</p>
<div class="refsect3">
<a name="webkit-credential-new.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>username</p></td>
<td class="parameter_description"><p>The username for the new credential</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>password</p></td>
<td class="parameter_description"><p>The password for the new credential</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>persistence</p></td>
<td class="parameter_description"><p>The <a class="link" href="WebKitAuthenticationRequest.html#WebKitCredentialPersistence" title="enum WebKitCredentialPersistence"><span class="type">WebKitCredentialPersistence</span></a> of the new credential</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-credential-new.returns"></a><h4>Returns</h4>
<p>A <a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="type">WebKitCredential</span></a>. </p>
<p><span class="annotation">[<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-2.html#api-index-2.2">2.2</a></p>
578 579 580
</div>
<hr>
<div class="refsect2">
581 582 583
<a name="webkit-credential-copy"></a><h3>webkit_credential_copy ()</h3>
<pre class="programlisting"><a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="returnvalue">WebKitCredential</span></a> *
webkit_credential_copy (<em class="parameter"><code><a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="type">WebKitCredential</span></a> *credential</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605
<p>Make a copy of the <a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="type">WebKitCredential</span></a>.</p>
<div class="refsect3">
<a name="webkit-credential-copy.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>credential</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="type">WebKitCredential</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-credential-copy.returns"></a><h4>Returns</h4>
<p>A copy of passed in <a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="type">WebKitCredential</span></a>. </p>
<p><span class="annotation">[<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-2.html#api-index-2.2">2.2</a></p>
606 607 608
</div>
<hr>
<div class="refsect2">
609 610 611
<a name="webkit-credential-free"></a><h3>webkit_credential_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
webkit_credential_free (<em class="parameter"><code><a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="type">WebKitCredential</span></a> *credential</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
<p>Free the <a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="type">WebKitCredential</span></a>.</p>
<div class="refsect3">
<a name="webkit-credential-free.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>credential</p></td>
<td class="parameter_description"><p>A <a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="type">WebKitCredential</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
629 630 631
</div>
<hr>
<div class="refsect2">
632 633 634
<a name="webkit-credential-get-password"></a><h3>webkit_credential_get_password ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
webkit_credential_get_password (<em class="parameter"><code><a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="type">WebKitCredential</span></a> *credential</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655
<p>Get the password currently held by this <a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="type">WebKitCredential</span></a>.</p>
<div class="refsect3">
<a name="webkit-credential-get-password.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>credential</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="type">WebKitCredential</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-credential-get-password.returns"></a><h4>Returns</h4>
<p> The password stored in the <a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="type">WebKitCredential</span></a>.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
656 657 658
</div>
<hr>
<div class="refsect2">
659 660 661
<a name="webkit-credential-get-persistence"></a><h3>webkit_credential_get_persistence ()</h3>
<pre class="programlisting"><a class="link" href="WebKitAuthenticationRequest.html#WebKitCredentialPersistence" title="enum WebKitCredentialPersistence"><span class="returnvalue">WebKitCredentialPersistence</span></a>
webkit_credential_get_persistence (<em class="parameter"><code><a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="type">WebKitCredential</span></a> *credential</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682
<p>Get the persistence mode currently held by this <a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="type">WebKitCredential</span></a>.</p>
<div class="refsect3">
<a name="webkit-credential-get-persistence.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>credential</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="type">WebKitCredential</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-credential-get-persistence.returns"></a><h4>Returns</h4>
<p> The <a class="link" href="WebKitAuthenticationRequest.html#WebKitCredentialPersistence" title="enum WebKitCredentialPersistence"><span class="type">WebKitCredentialPersistence</span></a> stored in the <a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="type">WebKitCredential</span></a>.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
683 684 685
</div>
<hr>
<div class="refsect2">
686 687 688
<a name="webkit-credential-get-username"></a><h3>webkit_credential_get_username ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
webkit_credential_get_username (<em class="parameter"><code><a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="type">WebKitCredential</span></a> *credential</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709
<p>Get the username currently held by this <a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="type">WebKitCredential</span></a>.</p>
<div class="refsect3">
<a name="webkit-credential-get-username.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>credential</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="type">WebKitCredential</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-credential-get-username.returns"></a><h4>Returns</h4>
<p> The username stored in the <a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="type">WebKitCredential</span></a>.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
710 711 712
</div>
<hr>
<div class="refsect2">
713 714 715
<a name="webkit-credential-has-password"></a><h3>webkit_credential_has_password ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
webkit_credential_has_password (<em class="parameter"><code><a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="type">WebKitCredential</span></a> *credential</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736
<p>Determine whether this credential has a password stored.</p>
<div class="refsect3">
<a name="webkit-credential-has-password.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>credential</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitAuthenticationRequest.html#WebKitCredential"><span class="type">WebKitCredential</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-credential-has-password.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the credential has a password or <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
737 738 739 740 741 742 743 744 745 746 747 748 749
</div>
</div>
<div class="refsect1">
<a name="WebKitAuthenticationRequest.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="WebKitAuthenticationRequest-struct"></a><h3>struct WebKitAuthenticationRequest</h3>
<pre class="programlisting">struct WebKitAuthenticationRequest;</pre>
</div>
<hr>
<div class="refsect2">
<a name="WebKitAuthenticationScheme"></a><h3>enum WebKitAuthenticationScheme</h3>
<p>Enum values representing the authentication scheme.</p>
<div class="refsect3">
750
<a name="WebKitAuthenticationScheme.members"></a><h4>Members</h4>
751
<div class="informaltable"><table class="informaltable" width="100%" border="0">
752
<colgroup>
753 754 755
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
756 757 758
</colgroup>
<tbody>
<tr>
759 760 761 762 763 764 765 766 767 768
<td class="enum_member_name"><p><a name="WEBKIT-AUTHENTICATION-SCHEME-DEFAULT:CAPS"></a>WEBKIT_AUTHENTICATION_SCHEME_DEFAULT</p></td>
<td class="enum_member_description">
<p>The default authentication scheme of WebKit.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="WEBKIT-AUTHENTICATION-SCHEME-HTTP-BASIC:CAPS"></a>WEBKIT_AUTHENTICATION_SCHEME_HTTP_BASIC</p></td>
<td class="enum_member_description">
<p>Basic authentication scheme as defined in RFC 2617.</p>
769
</td>
770
<td class="enum_member_annotations"> </td>
771 772
</tr>
<tr>
773 774 775 776 777 778 779 780 781 782 783 784 785 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 815 816 817 818 819
<td class="enum_member_name"><p><a name="WEBKIT-AUTHENTICATION-SCHEME-HTTP-DIGEST:CAPS"></a>WEBKIT_AUTHENTICATION_SCHEME_HTTP_DIGEST</p></td>
<td class="enum_member_description">
<p>Digest authentication scheme as defined in RFC 2617.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="WEBKIT-AUTHENTICATION-SCHEME-HTML-FORM:CAPS"></a>WEBKIT_AUTHENTICATION_SCHEME_HTML_FORM</p></td>
<td class="enum_member_description">
<p>HTML Form authentication.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="WEBKIT-AUTHENTICATION-SCHEME-NTLM:CAPS"></a>WEBKIT_AUTHENTICATION_SCHEME_NTLM</p></td>
<td class="enum_member_description">
<p>NTLM Microsoft proprietary authentication scheme.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="WEBKIT-AUTHENTICATION-SCHEME-NEGOTIATE:CAPS"></a>WEBKIT_AUTHENTICATION_SCHEME_NEGOTIATE</p></td>
<td class="enum_member_description">
<p>Negotiate (or SPNEGO) authentication scheme as defined in RFC 4559.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="WEBKIT-AUTHENTICATION-SCHEME-CLIENT-CERTIFICATE-REQUESTED:CAPS"></a>WEBKIT_AUTHENTICATION_SCHEME_CLIENT_CERTIFICATE_REQUESTED</p></td>
<td class="enum_member_description">
<p>Client Certificate Authentication (see RFC 2246).</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="WEBKIT-AUTHENTICATION-SCHEME-SERVER-TRUST-EVALUATION-REQUESTED:CAPS"></a>WEBKIT_AUTHENTICATION_SCHEME_SERVER_TRUST_EVALUATION_REQUESTED</p></td>
<td class="enum_member_description">
<p>Server Trust Authentication.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="WEBKIT-AUTHENTICATION-SCHEME-UNKNOWN:CAPS"></a>WEBKIT_AUTHENTICATION_SCHEME_UNKNOWN</p></td>
<td class="enum_member_description">
<p>Authentication scheme unknown.</p>
</td>
<td class="enum_member_annotations"> </td>
820 821 822
</tr>
</tbody>
</table></div>
823
</div>
824
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
825 826 827
</div>
<hr>
<div class="refsect2">
828 829 830 831 832 833 834 835
<a name="WebKitCredential-struct"></a><h3>WebKitCredential</h3>
<pre class="programlisting">typedef struct _WebKitCredential WebKitCredential;</pre>
</div>
<hr>
<div class="refsect2">
<a name="WebKitCredentialPersistence"></a><h3>enum WebKitCredentialPersistence</h3>
<p>Enum values representing the duration for which a credential persists.</p>
<div class="refsect3">
836
<a name="WebKitCredentialPersistence.members"></a><h4>Members</h4>
837
<div class="informaltable"><table class="informaltable" width="100%" border="0">
838
<colgroup>
839 840 841
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
842 843 844
</colgroup>
<tbody>
<tr>
845 846 847 848 849 850 851 852 853 854
<td class="enum_member_name"><p><a name="WEBKIT-CREDENTIAL-PERSISTENCE-NONE:CAPS"></a>WEBKIT_CREDENTIAL_PERSISTENCE_NONE</p></td>
<td class="enum_member_description">
<p>Credential does not persist</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="WEBKIT-CREDENTIAL-PERSISTENCE-FOR-SESSION:CAPS"></a>WEBKIT_CREDENTIAL_PERSISTENCE_FOR_SESSION</p></td>
<td class="enum_member_description">
<p>Credential persists for session only</p>
855
</td>
856
<td class="enum_member_annotations"> </td>
857 858
</tr>
<tr>
859 860 861 862 863
<td class="enum_member_name"><p><a name="WEBKIT-CREDENTIAL-PERSISTENCE-PERMANENT:CAPS"></a>WEBKIT_CREDENTIAL_PERSISTENCE_PERMANENT</p></td>
<td class="enum_member_description">
<p>Credential persists permanently</p>
</td>
<td class="enum_member_annotations"> </td>
864 865 866
</tr>
</tbody>
</table></div>
867
</div>
868
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
869 870 871
</div>
</div>
<div class="refsect1">
872 873
<a name="WebKitAuthenticationRequest.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
874 875
<a name="WebKitAuthenticationRequest-cancelled"></a><h3>The <code class="literal">“cancelled”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
Alberto Garcia's avatar
Alberto Garcia committed
876
user_function (<a class="link" href="WebKitAuthenticationRequest.html" title="WebKitAuthenticationRequest"><span class="type">WebKitAuthenticationRequest</span></a> *request,
877
               <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>                     user_data)</pre>
Alberto Garcia's avatar
Alberto Garcia committed
878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902
<p>This signal is emitted when the user authentication request is
cancelled. It allows the application to dismiss its authentication
dialog in case of page load failure for example.</p>
<div class="refsect3">
<a name="WebKitAuthenticationRequest-cancelled.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>request</p></td>
<td class="parameter_description"><p>the <a class="link" href="WebKitAuthenticationRequest.html" title="WebKitAuthenticationRequest"><span class="type">WebKitAuthenticationRequest</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
903
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
Alberto Garcia's avatar
Alberto Garcia committed
904 905
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
906
</div>
Alberto Garcia's avatar
Alberto Garcia committed
907 908 909
<div class="refsect1">
<a name="WebKitAuthenticationRequest.see-also"></a><h2>See Also</h2>
<p><a class="link" href="WebKitWebView.html" title="WebKitWebView"><span class="type">WebKitWebView</span></a></p>
910 911 912
</div>
</div>
<div class="footer">
Alberto Garcia's avatar
Alberto Garcia committed
913
<hr>Generated by GTK-Doc V1.26.1</div>
914 915
</body>
</html>