diff options
author | Seonah Moon <seonah1.moon@samsung.com> | 2019-12-09 14:52:00 +0900 |
---|---|---|
committer | Seonah Moon <seonah1.moon@samsung.com> | 2019-12-09 14:52:24 +0900 |
commit | 58894334cd3f0b89c865304e8e9d6eea3cd20a55 (patch) | |
tree | 6fdb22df40c774e8db791bc7cd27b39680a12fb0 /docs/reference/html/SoupAuthDomainBasic.html | |
parent | 9f52ffa8b526e717e324fe0835ab794478650f11 (diff) | |
download | libsoup-58894334cd3f0b89c865304e8e9d6eea3cd20a55.tar.gz libsoup-58894334cd3f0b89c865304e8e9d6eea3cd20a55.tar.bz2 libsoup-58894334cd3f0b89c865304e8e9d6eea3cd20a55.zip |
Imported Upstream version 2.62.2upstream/2.62.2
Change-Id: Id151dafaa6ac9f569d76f08282b5c9e4c3b19621
Diffstat (limited to 'docs/reference/html/SoupAuthDomainBasic.html')
-rw-r--r-- | docs/reference/html/SoupAuthDomainBasic.html | 69 |
1 files changed, 32 insertions, 37 deletions
diff --git a/docs/reference/html/SoupAuthDomainBasic.html b/docs/reference/html/SoupAuthDomainBasic.html index ba7874fb..cef727f1 100644 --- a/docs/reference/html/SoupAuthDomainBasic.html +++ b/docs/reference/html/SoupAuthDomainBasic.html @@ -2,21 +2,21 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>libsoup Reference Manual: SoupAuthDomainBasic</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<title>SoupAuthDomainBasic: libsoup Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="index.html" title="libsoup Reference Manual"> <link rel="up" href="ch02.html" title="Core API"> <link rel="prev" href="SoupAuthDomain.html" title="SoupAuthDomain"> <link rel="next" href="SoupAuthDomainDigest.html" title="SoupAuthDomainDigest"> -<meta name="generator" content="GTK-Doc V1.20 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.28.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="10"><tr valign="middle"> +<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="#SoupAuthDomainBasic.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#SoupAuthDomainBasic.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#SoupAuthDomainBasic.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#SoupAuthDomainBasic.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> <a href="#SoupAuthDomainBasic.properties" class="shortcut">Properties</a></span> </td> <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> @@ -35,7 +35,7 @@ </tr></table></div> <div class="refsect1"> <a name="SoupAuthDomainBasic.functions"></a><h2>Functions</h2> -<div class="informaltable"><table width="100%" border="0"> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="functions_return"> <col class="functions_name"> @@ -51,7 +51,7 @@ </tr> <tr> <td class="function_type"> -<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +<span class="returnvalue">gboolean</span> </td> <td class="function_name"> <span class="c_punctuation">(</span><a class="link" href="SoupAuthDomainBasic.html#SoupAuthDomainBasicAuthCallback" title="SoupAuthDomainBasicAuthCallback ()">*SoupAuthDomainBasicAuthCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> @@ -70,7 +70,7 @@ </div> <div class="refsect1"> <a name="SoupAuthDomainBasic.properties"></a><h2>Properties</h2> -<div class="informaltable"><table border="0"> +<div class="informaltable"><table class="informaltable" border="0"> <colgroup> <col width="150px" class="properties_type"> <col width="300px" class="properties_name"> @@ -78,12 +78,12 @@ </colgroup> <tbody> <tr> -<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></td> +<td class="property_type"><span class="type">gpointer</span></td> <td class="property_name"><a class="link" href="SoupAuthDomainBasic.html#SoupAuthDomainBasic--auth-callback" title="The “auth-callback” property">auth-callback</a></td> <td class="property_flags">Read / Write</td> </tr> <tr> -<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></td> +<td class="property_type"><span class="type">gpointer</span></td> <td class="property_name"><a class="link" href="SoupAuthDomainBasic.html#SoupAuthDomainBasic--auth-data" title="The “auth-data” property">auth-data</a></td> <td class="property_flags">Read / Write</td> </tr> @@ -92,7 +92,7 @@ </div> <div class="refsect1"> <a name="SoupAuthDomainBasic.other"></a><h2>Types and Values</h2> -<div class="informaltable"><table width="100%" border="0"> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="name"> <col class="description"> @@ -115,7 +115,7 @@ </div> <div class="refsect1"> <a name="SoupAuthDomainBasic.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> +<pre class="screen"> GObject <span class="lineart">╰──</span> <a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain">SoupAuthDomain</a> <span class="lineart">╰──</span> SoupAuthDomainBasic </pre> @@ -142,8 +142,8 @@ soup_auth_domain_basic_new (<em class="parameter"><code>const <span class="type" returned with the authentication challenge to the client. Other parameters are optional.</p> <div class="refsect3"> -<a name="id-1.3.4.9.2.5"></a><h4>Parameters</h4> -<div class="informaltable"><table width="100%" border="0"> +<a name="soup-auth-domain-basic-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"> @@ -152,7 +152,7 @@ parameters are optional.</p> <tbody> <tr> <td class="parameter_name"><p>optname1</p></td> -<td class="parameter_description"><p>name of first option, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td> +<td class="parameter_description"><p>name of first option, or <code class="literal">NULL</code></p></td> <td class="parameter_annotations"> </td> </tr> <tr> @@ -164,25 +164,24 @@ parameters are optional.</p> </table></div> </div> <div class="refsect3"> -<a name="id-1.3.4.9.2.6"></a><h4>Returns</h4> +<a name="soup-auth-domain-basic-new.returns"></a><h4>Returns</h4> <p> the new <a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a></p> -<p></p> </div> </div> <hr> <div class="refsect2"> <a name="SoupAuthDomainBasicAuthCallback"></a><h3>SoupAuthDomainBasicAuthCallback ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +<pre class="programlisting"><span class="returnvalue">gboolean</span> <span class="c_punctuation">(</span>*SoupAuthDomainBasicAuthCallback<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a> *domain</code></em>, <em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>, <em class="parameter"><code>const <span class="type">char</span> *username</code></em>, <em class="parameter"><code>const <span class="type">char</span> *password</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre> + <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> <p>Callback used by <a class="link" href="SoupAuthDomainBasic.html" title="SoupAuthDomainBasic"><span class="type">SoupAuthDomainBasic</span></a> for authentication purposes. The application should verify that <em class="parameter"><code>username</code></em> and <em class="parameter"><code>password</code></em> and valid -and return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p> +and return <code class="literal">TRUE</code> or <code class="literal">FALSE</code>.</p> <p>If you are maintaining your own password database (rather than using the password to authenticate against some other system like PAM or a remote server), you should make sure you know what you are @@ -194,8 +193,8 @@ compromising any site with a cleartext (or easily-cracked) password database may give attackers access to other more-interesting sites as well.</p> <div class="refsect3"> -<a name="id-1.3.4.9.3.6"></a><h4>Parameters</h4> -<div class="informaltable"><table width="100%" border="0"> +<a name="SoupAuthDomainBasicAuthCallback.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"> @@ -231,11 +230,10 @@ as well.</p> </table></div> </div> <div class="refsect3"> -<a name="id-1.3.4.9.3.7"></a><h4>Returns</h4> -<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>username</code></em> +<a name="SoupAuthDomainBasicAuthCallback.returns"></a><h4>Returns</h4> +<p> <code class="literal">TRUE</code> if <em class="parameter"><code>username</code></em> and <em class="parameter"><code>password</code></em> are valid</p> -<p></p> </div> </div> <hr> @@ -245,8 +243,8 @@ are valid</p> soup_auth_domain_basic_set_auth_callback (<em class="parameter"><code><a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a> *domain</code></em>, <em class="parameter"><code><a class="link" href="SoupAuthDomainBasic.html#SoupAuthDomainBasicAuthCallback" title="SoupAuthDomainBasicAuthCallback ()"><span class="type">SoupAuthDomainBasicAuthCallback</span></a> callback</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> dnotify</code></em>);</pre> + <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>, + <em class="parameter"><code><span class="type">GDestroyNotify</span> dnotify</code></em>);</pre> <p>Sets the callback that <em class="parameter"><code>domain</code></em> will use to authenticate incoming requests. For each request containing authorization, <em class="parameter"><code>domain</code></em> @@ -259,8 +257,8 @@ based on <em class="parameter"><code>callback</code></em> <a class="link" href="SoupAuthDomainBasic.html#SOUP-AUTH-DOMAIN-BASIC-AUTH-DATA:CAPS" title="SOUP_AUTH_DOMAIN_BASIC_AUTH_DATA"><code class="literal">SOUP_AUTH_DOMAIN_BASIC_AUTH_DATA</code></a> properties, which can also be used to set the callback at construct time.</p> <div class="refsect3"> -<a name="id-1.3.4.9.4.6"></a><h4>Parameters</h4> -<div class="informaltable"><table width="100%" border="0"> +<a name="soup-auth-domain-basic-set-auth-callback.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"> @@ -300,8 +298,6 @@ is destroyed</p></td> <div class="refsect2"> <a name="SoupAuthDomainBasic-struct"></a><h3>SoupAuthDomainBasic</h3> <pre class="programlisting">typedef struct _SoupAuthDomainBasic SoupAuthDomainBasic;</pre> -<p> -</p> </div> <hr> <div class="refsect2"> @@ -324,21 +320,20 @@ is destroyed</p></td> <a name="SoupAuthDomainBasic.property-details"></a><h2>Property Details</h2> <div class="refsect2"> <a name="SoupAuthDomainBasic--auth-callback"></a><h3>The <code class="literal">“auth-callback”</code> property</h3> -<pre class="programlisting"> “auth-callback” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></pre> +<pre class="programlisting"> “auth-callback” <span class="type">gpointer</span></pre> <p>Password-checking callback.</p> <p>Flags: Read / Write</p> </div> <hr> <div class="refsect2"> <a name="SoupAuthDomainBasic--auth-data"></a><h3>The <code class="literal">“auth-data”</code> property</h3> -<pre class="programlisting"> “auth-data” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></pre> +<pre class="programlisting"> “auth-data” <span class="type">gpointer</span></pre> <p>Data to pass to authentication callback.</p> <p>Flags: Read / Write</p> </div> </div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.20</div> +<hr>Generated by GTK-Doc V1.28.1</div> </body> </html>
\ No newline at end of file |