evolution-data-server-doc 3.18.5-1ubuntu1 / usr / share / gtk-doc / html / eds / eds-ESoupAuthBearer.html

This file is indexed.

/usr/share/gtk-doc/html/eds/eds-ESoupAuthBearer.html is in evolution-data-server-doc 3.18.5-1ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ESoupAuthBearer: Evolution-Data-Server Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Reference Manual">
<link rel="up" href="ch11.html" title="Available only for backends">
<link rel="prev" href="eds-Berkeley-DB-utilities.html" title="Berkeley DB utilities">
<link rel="next" href="eds-SQLite-vfs.html" title="SQLite vfs">
<meta name="generator" content="GTK-Doc V1.24 (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="#eds-ESoupAuthBearer.description" class="shortcut">Description</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="ch11.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="eds-Berkeley-DB-utilities.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="eds-SQLite-vfs.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="eds-ESoupAuthBearer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="eds-ESoupAuthBearer.top_of_page"></a>ESoupAuthBearer</span></h2>
<p>ESoupAuthBearer — OAuth 2.0 support for libsoup</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="eds-ESoupAuthBearer.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">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="eds-ESoupAuthBearer.html#e-soup-auth-bearer-set-access-token" title="e_soup_auth_bearer_set_access_token ()">e_soup_auth_bearer_set_access_token</a> <span class="c_punctuation">()</span>
</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="eds-ESoupAuthBearer.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="eds-ESoupAuthBearer.html#ESoupAuthBearer" title="struct ESoupAuthBearer">ESoupAuthBearer</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="eds-ESoupAuthBearer.html#ESoupAuthBearerClass" title="struct ESoupAuthBearerClass">ESoupAuthBearerClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="eds-ESoupAuthBearer.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libedataserver/libedataserver.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="eds-ESoupAuthBearer.description"></a><h2>Description</h2>
<p><a class="link" href="eds-ESoupAuthBearer.html#ESoupAuthBearer" title="struct ESoupAuthBearer"><span class="type">ESoupAuthBearer</span></a> adds libsoup support for the use of bearer tokens in
HTTP requests to access OAuth 2.0 protected resources, as defined in</p>
<a class="ulink" href="http://tools.ietf.org/html/rfc6750" target="_top">RFC 6750</a>.
<p>An <a class="link" href="eds-EBackend.html#EBackend" title="struct EBackend"><span class="type">EBackend</span></a> should integrate <a class="link" href="eds-ESoupAuthBearer.html#ESoupAuthBearer" title="struct ESoupAuthBearer"><span class="type">ESoupAuthBearer</span></a> first by adding it as a
feature to a <span class="type">SoupSession</span>'s <span class="type">SoupAuthManager</span>, then from a <span class="type">SoupSession</span>
<span class="type">“authenticate”</span> handler call <a class="link" href="eds-ESource.html#e-source-get-oauth2-access-token" title="e_source_get_oauth2_access_token ()"><code class="function">e_source_get_oauth2_access_token()</code></a>
and pass the results to <a class="link" href="eds-ESoupAuthBearer.html#e-soup-auth-bearer-set-access-token" title="e_soup_auth_bearer_set_access_token ()"><code class="function">e_soup_auth_bearer_set_access_token()</code></a>.</p>
</div>
<div class="refsect1">
<a name="eds-ESoupAuthBearer.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-soup-auth-bearer-set-access-token"></a><h3>e_soup_auth_bearer_set_access_token ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_soup_auth_bearer_set_access_token (<em class="parameter"><code><a class="link" href="eds-ESoupAuthBearer.html#ESoupAuthBearer" title="struct ESoupAuthBearer"><span class="type">ESoupAuthBearer</span></a> *bearer</code></em>,
                                     <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *access_token</code></em>,
                                     <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> expires_in_seconds</code></em>);</pre>
<p>This function is analogous to <code class="function">soup_auth_authenticate()</code> for "Basic" HTTP
authentication, except it takes an OAuth 2.0 access token instead of a
username and password.</p>
<p>If <em class="parameter"><code>expires_in_seconds</code></em>
 is greater than zero, <code class="function">soup_auth_is_authenticated()</code>
will return <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> after the given number of seconds have elapsed.</p>
<div class="refsect3">
<a name="id-1.5.3.4.7.2.6"></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>bearer</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-ESoupAuthBearer.html#ESoupAuthBearer" title="struct ESoupAuthBearer"><span class="type">ESoupAuthBearer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>access_token</p></td>
<td class="parameter_description"><p>an OAuth 2.0 access token</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>expires_in_seconds</p></td>
<td class="parameter_description"><p>expiry for <em class="parameter"><code>access_token</code></em>
, or 0 if unknown</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.10.html" title="Index of new symbols in 3.10">3.10</a></p>
</div>
</div>
<div class="refsect1">
<a name="eds-ESoupAuthBearer.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ESoupAuthBearer"></a><h3>struct ESoupAuthBearer</h3>
<pre class="programlisting">struct ESoupAuthBearer {
	SoupAuth parent;
	ESoupAuthBearerPrivate *priv;
};
</pre>
<p>Contains only private data that should be read and manipulated using the
functions below.</p>
<p class="since">Since: <a class="link" href="api-index-3.10.html" title="Index of new symbols in 3.10">3.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ESoupAuthBearerClass"></a><h3>struct ESoupAuthBearerClass</h3>
<pre class="programlisting">struct ESoupAuthBearerClass {
	SoupAuthClass parent_class;
};
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.