diff options
Diffstat (limited to 'Documentation/webkit2gtk-4.0/html/WebKitWebResource.html')
-rw-r--r-- | Documentation/webkit2gtk-4.0/html/WebKitWebResource.html | 587 |
1 files changed, 587 insertions, 0 deletions
diff --git a/Documentation/webkit2gtk-4.0/html/WebKitWebResource.html b/Documentation/webkit2gtk-4.0/html/WebKitWebResource.html new file mode 100644 index 000000000..b1c6cad7b --- /dev/null +++ b/Documentation/webkit2gtk-4.0/html/WebKitWebResource.html @@ -0,0 +1,587 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>WebKitWebResource: WebKit2GTK+ Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="index.html" title="WebKit2GTK+ Reference Manual"> +<link rel="up" href="ch01.html" title="Class Overview"> +<link rel="prev" href="WebKitPrintOperation.html" title="WebKitPrintOperation"> +<link rel="next" href="webkit2gtk-4.0-WebKitError.html" title="WebKitError"> +<meta name="generator" content="GTK-Doc V1.25.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#WebKitWebResource.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#WebKitWebResource.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#WebKitWebResource.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> + <a href="#WebKitWebResource.signals" class="shortcut">Signals</a></span> +</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="WebKitPrintOperation.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="webkit2gtk-4.0-WebKitError.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="WebKitWebResource"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="WebKitWebResource.top_of_page"></a>WebKitWebResource</span></h2> +<p>WebKitWebResource — Represents a resource at the end of a URI</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="WebKitWebResource.functions"></a><h2>Functions</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<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="WebKitWebResource.html#webkit-web-resource-get-uri" title="webkit_web_resource_get_uri ()">webkit_web_resource_get_uri</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="WebKitURIResponse.html" title="WebKitURIResponse"><span class="returnvalue">WebKitURIResponse</span></a> * +</td> +<td class="function_name"> +<a class="link" href="WebKitWebResource.html#webkit-web-resource-get-response" title="webkit_web_resource_get_response ()">webkit_web_resource_get_response</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="WebKitWebResource.html#webkit-web-resource-get-data" title="webkit_web_resource_get_data ()">webkit_web_resource_get_data</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../glib/glib-Basic-Types.html#guchar"><span class="returnvalue">guchar</span></a> * +</td> +<td class="function_name"> +<a class="link" href="WebKitWebResource.html#webkit-web-resource-get-data-finish" title="webkit_web_resource_get_data_finish ()">webkit_web_resource_get_data_finish</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="WebKitWebResource.properties"></a><h2>Properties</h2> +<div class="informaltable"><table class="informaltable" border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody> +<tr> +<td class="property_type"> +<a class="link" href="WebKitURIResponse.html" title="WebKitURIResponse"><span class="type">WebKitURIResponse</span></a> *</td> +<td class="property_name"><a class="link" href="WebKitWebResource.html#WebKitWebResource--response" title="The “response” property">response</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"> +<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<td class="property_name"><a class="link" href="WebKitWebResource.html#WebKitWebResource--uri" title="The “uri” property">uri</a></td> +<td class="property_flags">Read</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="WebKitWebResource.signals"></a><h2>Signals</h2> +<div class="informaltable"><table class="informaltable" border="0"> +<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="WebKitWebResource.html#WebKitWebResource-failed" title="The “failed” signal">failed</a></td> +<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="WebKitWebResource.html#WebKitWebResource-failed-with-tls-errors" title="The “failed-with-tls-errors” signal">failed-with-tls-errors</a></td> +<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="WebKitWebResource.html#WebKitWebResource-finished" title="The “finished” signal">finished</a></td> +<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="WebKitWebResource.html#WebKitWebResource-received-data" title="The “received-data” signal">received-data</a></td> +<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="WebKitWebResource.html#WebKitWebResource-sent-request" title="The “sent-request” signal">sent-request</a></td> +<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="WebKitWebResource.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<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="WebKitWebResource.html#WebKitWebResource-struct" title="struct WebKitWebResource">WebKitWebResource</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="WebKitWebResource.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> + <span class="lineart">╰──</span> WebKitWebResource +</pre> +</div> +<div class="refsect1"> +<a name="WebKitWebResource.description"></a><h2>Description</h2> +<p>A <a class="link" href="WebKitWebResource.html" title="WebKitWebResource"><span class="type">WebKitWebResource</span></a> encapsulates content for each resource at the +end of a particular URI. For example, one <a class="link" href="WebKitWebResource.html" title="WebKitWebResource"><span class="type">WebKitWebResource</span></a> will +be created for each separate image and stylesheet when a page is +loaded.</p> +<p>You can access the response and the URI for a given +<a class="link" href="WebKitWebResource.html" title="WebKitWebResource"><span class="type">WebKitWebResource</span></a>, using <a class="link" href="WebKitWebResource.html#webkit-web-resource-get-uri" title="webkit_web_resource_get_uri ()"><code class="function">webkit_web_resource_get_uri()</code></a> and +<a class="link" href="WebKitWebResource.html#webkit-web-resource-get-response" title="webkit_web_resource_get_response ()"><code class="function">webkit_web_resource_get_response()</code></a>, as well as the raw data, using +<a class="link" href="WebKitWebResource.html#webkit-web-resource-get-data" title="webkit_web_resource_get_data ()"><code class="function">webkit_web_resource_get_data()</code></a>.</p> +</div> +<div class="refsect1"> +<a name="WebKitWebResource.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="webkit-web-resource-get-uri"></a><h3>webkit_web_resource_get_uri ()</h3> +<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * +webkit_web_resource_get_uri (<em class="parameter"><code><a class="link" href="WebKitWebResource.html" title="WebKitWebResource"><span class="type">WebKitWebResource</span></a> *resource</code></em>);</pre> +<p>Returns the current active URI of <em class="parameter"><code>resource</code></em> +. The active URI might change during +a load operation:</p> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"><p> + When the resource load starts, the active URI is the requested URI +</p></li> +<li class="listitem"><p> + When the initial request is sent to the server, <a class="link" href="WebKitWebResource.html#WebKitWebResource-sent-request" title="The “sent-request” signal"><span class="type">“sent-request”</span></a> + signal is emitted without a redirected response, the active URI is the URI of + the request sent to the server. +</p></li> +<li class="listitem"><p> + In case of a server redirection, <a class="link" href="WebKitWebResource.html#WebKitWebResource-sent-request" title="The “sent-request” signal"><span class="type">“sent-request”</span></a> signal + is emitted again with a redirected response, the active URI is the URI the request + was redirected to. +</p></li> +<li class="listitem"><p> + When the response is received from the server, the active URI is the final + one and it will not change again. +</p></li> +</ol></div> +<p>You can monitor the active URI by connecting to the notify::uri +signal of <em class="parameter"><code>resource</code></em> +.</p> +<div class="refsect3"> +<a name="webkit-web-resource-get-uri.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>resource</p></td> +<td class="parameter_description"><p>a <a class="link" href="WebKitWebResource.html" title="WebKitWebResource"><span class="type">WebKitWebResource</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="webkit-web-resource-get-uri.returns"></a><h4>Returns</h4> +<p> the current active URI of <em class="parameter"><code>resource</code></em> +</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="webkit-web-resource-get-response"></a><h3>webkit_web_resource_get_response ()</h3> +<pre class="programlisting"><a class="link" href="WebKitURIResponse.html" title="WebKitURIResponse"><span class="returnvalue">WebKitURIResponse</span></a> * +webkit_web_resource_get_response (<em class="parameter"><code><a class="link" href="WebKitWebResource.html" title="WebKitWebResource"><span class="type">WebKitWebResource</span></a> *resource</code></em>);</pre> +<p>Retrieves the <a class="link" href="WebKitURIResponse.html" title="WebKitURIResponse"><span class="type">WebKitURIResponse</span></a> of the resource load operation. +This method returns <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if called before the response +is received from the server. You can connect to notify::response +signal to be notified when the response is received.</p> +<div class="refsect3"> +<a name="webkit-web-resource-get-response.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>resource</p></td> +<td class="parameter_description"><p>a <a class="link" href="WebKitWebResource.html" title="WebKitWebResource"><span class="type">WebKitWebResource</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="webkit-web-resource-get-response.returns"></a><h4>Returns</h4> +<p> the <a class="link" href="WebKitURIResponse.html" title="WebKitURIResponse"><span class="type">WebKitURIResponse</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if +the response hasn't been received yet. </p> +<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="webkit-web-resource-get-data"></a><h3>webkit_web_resource_get_data ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +webkit_web_resource_get_data (<em class="parameter"><code><a class="link" href="WebKitWebResource.html" title="WebKitWebResource"><span class="type">WebKitWebResource</span></a> *resource</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> +<p>Asynchronously get the raw data for <em class="parameter"><code>resource</code></em> +.</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="WebKitWebResource.html#webkit-web-resource-get-data-finish" title="webkit_web_resource_get_data_finish ()"><code class="function">webkit_web_resource_get_data_finish()</code></a> to get the result of the operation.</p> +<div class="refsect3"> +<a name="webkit-web-resource-get-data.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>resource</p></td> +<td class="parameter_description"><p>a <a class="link" href="WebKitWebResource.html" title="WebKitWebResource"><span class="type">WebKitWebResource</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> +</div> +<hr> +<div class="refsect2"> +<a name="webkit-web-resource-get-data-finish"></a><h3>webkit_web_resource_get_data_finish ()</h3> +<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guchar"><span class="returnvalue">guchar</span></a> * +webkit_web_resource_get_data_finish (<em class="parameter"><code><a class="link" href="WebKitWebResource.html" title="WebKitWebResource"><span class="type">WebKitWebResource</span></a> *resource</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-Basic-Types.html#gsize"><span class="type">gsize</span></a> *length</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="WebKitWebResource.html#webkit-web-resource-get-data" title="webkit_web_resource_get_data ()"><code class="function">webkit_web_resource_get_data()</code></a>.</p> +<div class="refsect3"> +<a name="webkit-web-resource-get-data-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>resource</p></td> +<td class="parameter_description"><p>a <a class="link" href="WebKitWebResource.html" title="WebKitWebResource"><span class="type">WebKitWebResource</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>length</p></td> +<td class="parameter_description"><p> return location for the length of the resource data. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<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>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-web-resource-get-data-finish.returns"></a><h4>Returns</h4> +<p> a +string with the data of <em class="parameter"><code>resource</code></em> +, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> in case of error. if <em class="parameter"><code>length</code></em> +is not <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the size of the data will be assigned to it. </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> length=length][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint8]</span></p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="WebKitWebResource.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="WebKitWebResource-struct"></a><h3>struct WebKitWebResource</h3> +<pre class="programlisting">struct WebKitWebResource;</pre> +</div> +</div> +<div class="refsect1"> +<a name="WebKitWebResource.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="WebKitWebResource--response"></a><h3>The <code class="literal">“response”</code> property</h3> +<pre class="programlisting"> “response” <a class="link" href="WebKitURIResponse.html" title="WebKitURIResponse"><span class="type">WebKitURIResponse</span></a> *</pre> +<p>The <a class="link" href="WebKitURIResponse.html" title="WebKitURIResponse"><span class="type">WebKitURIResponse</span></a> associated with this resource.</p> +<p>Flags: Read</p> +</div> +<hr> +<div class="refsect2"> +<a name="WebKitWebResource--uri"></a><h3>The <code class="literal">“uri”</code> property</h3> +<pre class="programlisting"> “uri” <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<p>The current active URI of the <a class="link" href="WebKitWebResource.html" title="WebKitWebResource"><span class="type">WebKitWebResource</span></a>. +See <a class="link" href="WebKitWebResource.html#webkit-web-resource-get-uri" title="webkit_web_resource_get_uri ()"><code class="function">webkit_web_resource_get_uri()</code></a> for more details.</p> +<p>Flags: Read</p> +<p>Default value: NULL</p> +</div> +</div> +<div class="refsect1"> +<a name="WebKitWebResource.signal-details"></a><h2>Signal Details</h2> +<div class="refsect2"> +<a name="WebKitWebResource-failed"></a><h3>The <code class="literal">“failed”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="WebKitWebResource.html" title="WebKitWebResource"><span class="type">WebKitWebResource</span></a> *resource, + <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error, + <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>This signal is emitted when an error occurs during the resource +load operation.</p> +<div class="refsect3"> +<a name="WebKitWebResource-failed.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>resource</p></td> +<td class="parameter_description"><p>the <a class="link" href="WebKitWebResource.html" title="WebKitWebResource"><span class="type">WebKitWebResource</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>the <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> that was triggered</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> +<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="WebKitWebResource-failed-with-tls-errors"></a><h3>The <code class="literal">“failed-with-tls-errors”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="WebKitWebResource.html" title="WebKitWebResource"><span class="type">WebKitWebResource</span></a> *resource, + <a href="../gio/GTlsCertificate.html#GTlsCertificate-struct"><span class="type">GTlsCertificate</span></a> *certificate, + <a href="../gio/gio-TLS-Overview.html#GTlsCertificateFlags"><span class="type">GTlsCertificateFlags</span></a> errors, + <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>This signal is emitted when a TLS error occurs during the resource load operation.</p> +<div class="refsect3"> +<a name="WebKitWebResource-failed-with-tls-errors.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>resource</p></td> +<td class="parameter_description"><p>the <a class="link" href="WebKitWebResource.html" title="WebKitWebResource"><span class="type">WebKitWebResource</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>certificate</p></td> +<td class="parameter_description"><p>a <a href="../gio/GTlsCertificate.html#GTlsCertificate-struct"><span class="type">GTlsCertificate</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>errors</p></td> +<td class="parameter_description"><p>a <a href="../gio/gio-TLS-Overview.html#GTlsCertificateFlags"><span class="type">GTlsCertificateFlags</span></a> with the verification status of <em class="parameter"><code>certificate</code></em> +</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> +<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="WebKitWebResource-finished"></a><h3>The <code class="literal">“finished”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="WebKitWebResource.html" title="WebKitWebResource"><span class="type">WebKitWebResource</span></a> *resource, + <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>This signal is emitted when the resource load finishes successfully +or due to an error. In case of errors <a class="link" href="WebKitWebResource.html#WebKitWebResource-failed" title="The “failed” signal"><span class="type">“failed”</span></a> signal +is emitted before this one.</p> +<div class="refsect3"> +<a name="WebKitWebResource-finished.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>resource</p></td> +<td class="parameter_description"><p>the <a class="link" href="WebKitWebResource.html" title="WebKitWebResource"><span class="type">WebKitWebResource</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> +<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="WebKitWebResource-received-data"></a><h3>The <code class="literal">“received-data”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="WebKitWebResource.html" title="WebKitWebResource"><span class="type">WebKitWebResource</span></a> *resource, + <a href="../glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> data_length, + <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>This signal is emitted after response is received, +every time new data has been received. It's +useful to know the progress of the resource load operation.</p> +<div class="refsect3"> +<a name="WebKitWebResource-received-data.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>resource</p></td> +<td class="parameter_description"><p>the <a class="link" href="WebKitWebResource.html" title="WebKitWebResource"><span class="type">WebKitWebResource</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>data_length</p></td> +<td class="parameter_description"><p>the length of data received in bytes</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> +<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="WebKitWebResource-sent-request"></a><h3>The <code class="literal">“sent-request”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="WebKitWebResource.html" title="WebKitWebResource"><span class="type">WebKitWebResource</span></a> *resource, + <a class="link" href="WebKitURIRequest.html" title="WebKitURIRequest"><span class="type">WebKitURIRequest</span></a> *request, + <a class="link" href="WebKitURIResponse.html" title="WebKitURIResponse"><span class="type">WebKitURIResponse</span></a> *redirected_response, + <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>This signal is emitted when <em class="parameter"><code>request</code></em> + has been sent to the +server. In case of a server redirection this signal is +emitted again with the <em class="parameter"><code>request</code></em> + argument containing the new +request sent to the server due to the redirection and the +<em class="parameter"><code>redirected_response</code></em> + parameter containing the response +received by the server for the initial request.</p> +<div class="refsect3"> +<a name="WebKitWebResource-sent-request.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>resource</p></td> +<td class="parameter_description"><p>the <a class="link" href="WebKitWebResource.html" title="WebKitWebResource"><span class="type">WebKitWebResource</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>request</p></td> +<td class="parameter_description"><p>a <a class="link" href="WebKitURIRequest.html" title="WebKitURIRequest"><span class="type">WebKitURIRequest</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>redirected_response</p></td> +<td class="parameter_description"><p>a <a class="link" href="WebKitURIResponse.html" title="WebKitURIResponse"><span class="type">WebKitURIResponse</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></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> +<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.25.1</div> +</body> +</html>
\ No newline at end of file |