libcouchdb-glib-doc 0.7.4-0ubuntu3 / usr / share / gtk-doc / html / couchdb-glib / CouchdbCredentials.html

This file is indexed.

/usr/share/gtk-doc/html/couchdb-glib/CouchdbCredentials.html is in libcouchdb-glib-doc 0.7.4-0ubuntu3.

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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CouchdbCredentials</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Reference Manual for CouchDB GLib Bindings">
<link rel="up" href="ch01.html" title="Core API">
<link rel="prev" href="couchdb-glib-couchdb-database-info.html" title="couchdb-database-info">
<link rel="next" href="CouchdbDocument.html" title="CouchdbDocument">
<meta name="generator" content="GTK-Doc V1.18 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="couchdb-glib-couchdb-database-info.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Reference Manual for CouchDB GLib Bindings</th>
<td><a accesskey="n" href="CouchdbDocument.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#CouchdbCredentials.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#CouchdbCredentials.description" class="shortcut">Description</a>
                   | 
                  <a href="#CouchdbCredentials.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="CouchdbCredentials"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="CouchdbCredentials.top_of_page"></a>CouchdbCredentials</span></h2>
<p>CouchdbCredentials</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="CouchdbCredentials.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">                    <a class="link" href="CouchdbCredentials.html#CouchdbCredentials-struct" title="CouchdbCredentials">CouchdbCredentials</a>;
                    <a class="link" href="CouchdbCredentials.html#CouchdbCredentialsClass" title="CouchdbCredentialsClass">CouchdbCredentialsClass</a>;
enum                <a class="link" href="CouchdbCredentials.html#CouchdbCredentialsType" title="enum CouchdbCredentialsType">CouchdbCredentialsType</a>;
<a class="link" href="CouchdbCredentials.html" title="CouchdbCredentials"><span class="returnvalue">CouchdbCredentials</span></a> * <a class="link" href="CouchdbCredentials.html#couchdb-credentials-new-with-oauth" title="couchdb_credentials_new_with_oauth ()">couchdb_credentials_new_with_oauth</a> (<em class="parameter"><code>const <span class="type">gchar</span> *consumer_key</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *consumer_secret</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *token_key</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *token_secret</code></em>);
<a class="link" href="CouchdbCredentials.html" title="CouchdbCredentials"><span class="returnvalue">CouchdbCredentials</span></a> * <a class="link" href="CouchdbCredentials.html#couchdb-credentials-new-with-username-and-password" title="couchdb_credentials_new_with_username_and_password ()">couchdb_credentials_new_with_username_and_password</a>
                                                        (<em class="parameter"><code>const <span class="type">gchar</span> *username</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *password</code></em>);
<a class="link" href="CouchdbCredentials.html#CouchdbCredentialsType" title="enum CouchdbCredentialsType"><span class="returnvalue">CouchdbCredentialsType</span></a> <a class="link" href="CouchdbCredentials.html#couchdb-credentials-get-auth-type" title="couchdb_credentials_get_auth_type ()">couchdb_credentials_get_auth_type</a>
                                                        (<em class="parameter"><code><a class="link" href="CouchdbCredentials.html" title="CouchdbCredentials"><span class="type">CouchdbCredentials</span></a> *credentials</code></em>);
#define             <a class="link" href="CouchdbCredentials.html#COUCHDB-CREDENTIALS-ITEM-OAUTH-CONSUMER-KEY:CAPS" title="COUCHDB_CREDENTIALS_ITEM_OAUTH_CONSUMER_KEY">COUCHDB_CREDENTIALS_ITEM_OAUTH_CONSUMER_KEY</a>
#define             <a class="link" href="CouchdbCredentials.html#COUCHDB-CREDENTIALS-ITEM-OAUTH-CONSUMER-SECRET:CAPS" title="COUCHDB_CREDENTIALS_ITEM_OAUTH_CONSUMER_SECRET">COUCHDB_CREDENTIALS_ITEM_OAUTH_CONSUMER_SECRET</a>
#define             <a class="link" href="CouchdbCredentials.html#COUCHDB-CREDENTIALS-ITEM-OAUTH-TOKEN-KEY:CAPS" title="COUCHDB_CREDENTIALS_ITEM_OAUTH_TOKEN_KEY">COUCHDB_CREDENTIALS_ITEM_OAUTH_TOKEN_KEY</a>
#define             <a class="link" href="CouchdbCredentials.html#COUCHDB-CREDENTIALS-ITEM-OAUTH-TOKEN-SECRET:CAPS" title="COUCHDB_CREDENTIALS_ITEM_OAUTH_TOKEN_SECRET">COUCHDB_CREDENTIALS_ITEM_OAUTH_TOKEN_SECRET</a>
#define             <a class="link" href="CouchdbCredentials.html#COUCHDB-CREDENTIALS-ITEM-USERNAME:CAPS" title="COUCHDB_CREDENTIALS_ITEM_USERNAME">COUCHDB_CREDENTIALS_ITEM_USERNAME</a>
#define             <a class="link" href="CouchdbCredentials.html#COUCHDB-CREDENTIALS-ITEM-PASSWORD:CAPS" title="COUCHDB_CREDENTIALS_ITEM_PASSWORD">COUCHDB_CREDENTIALS_ITEM_PASSWORD</a>
const <span class="returnvalue">gchar</span> *       <a class="link" href="CouchdbCredentials.html#couchdb-credentials-get-item" title="couchdb_credentials_get_item ()">couchdb_credentials_get_item</a>        (<em class="parameter"><code><a class="link" href="CouchdbCredentials.html" title="CouchdbCredentials"><span class="type">CouchdbCredentials</span></a> *credentials</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *item</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="CouchdbCredentials.html#couchdb-credentials-set-item" title="couchdb_credentials_set_item ()">couchdb_credentials_set_item</a>        (<em class="parameter"><code><a class="link" href="CouchdbCredentials.html" title="CouchdbCredentials"><span class="type">CouchdbCredentials</span></a> *credentials</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *item</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *value</code></em>);
                    <a class="link" href="CouchdbCredentials.html#CouchdbCredentialsPrivate" title="CouchdbCredentialsPrivate">CouchdbCredentialsPrivate</a>;
</pre>
</div>
<div class="refsect1">
<a name="CouchdbCredentials.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GObject
   +----CouchdbCredentials
</pre>
</div>
<div class="refsect1">
<a name="CouchdbCredentials.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="CouchdbCredentials.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CouchdbCredentials-struct"></a><h3>CouchdbCredentials</h3>
<pre class="programlisting">typedef struct _CouchdbCredentials CouchdbCredentials;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CouchdbCredentialsClass"></a><h3>CouchdbCredentialsClass</h3>
<pre class="programlisting">typedef struct {
	GObjectClass parent_class;
} CouchdbCredentialsClass;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CouchdbCredentialsType"></a><h3>enum CouchdbCredentialsType</h3>
<pre class="programlisting">typedef enum {
	COUCHDB_CREDENTIALS_TYPE_UNKNOWN = -1,
	COUCHDB_CREDENTIALS_TYPE_OAUTH,
	COUCHDB_CREDENTIALS_TYPE_USERNAME_AND_PASSWORD
} CouchdbCredentialsType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="couchdb-credentials-new-with-oauth"></a><h3>couchdb_credentials_new_with_oauth ()</h3>
<pre class="programlisting"><a class="link" href="CouchdbCredentials.html" title="CouchdbCredentials"><span class="returnvalue">CouchdbCredentials</span></a> * couchdb_credentials_new_with_oauth (<em class="parameter"><code>const <span class="type">gchar</span> *consumer_key</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *consumer_secret</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *token_key</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *token_secret</code></em>);</pre>
<p>
Create a new <a class="link" href="CouchdbCredentials.html" title="CouchdbCredentials"><span class="type">CouchdbCredentials</span></a> object to be used for OAuth authentication.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>consumer_key</code></em> :</span></p></td>
<td>OAuth consumer key</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>consumer_secret</code></em> :</span></p></td>
<td>OAuth consumer secret</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>token_key</code></em> :</span></p></td>
<td>OAuth token key</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>token_secret</code></em> :</span></p></td>
<td>OAuth token secret</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A <a class="link" href="CouchdbCredentials.html" title="CouchdbCredentials"><span class="type">CouchdbCredentials</span></a> object.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="couchdb-credentials-new-with-username-and-password"></a><h3>couchdb_credentials_new_with_username_and_password ()</h3>
<pre class="programlisting"><a class="link" href="CouchdbCredentials.html" title="CouchdbCredentials"><span class="returnvalue">CouchdbCredentials</span></a> * couchdb_credentials_new_with_username_and_password
                                                        (<em class="parameter"><code>const <span class="type">gchar</span> *username</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *password</code></em>);</pre>
<p>
Create a new <a class="link" href="CouchdbCredentials.html" title="CouchdbCredentials"><span class="type">CouchdbCredentials</span></a> object to be used for username
and password based HTTP authentication scheme such as Basic or
Digest.
</p>
<p>
Authentication is delegated to LibSoup.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>username</code></em> :</span></p></td>
<td>HTTP Authentication username</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>password</code></em> :</span></p></td>
<td>HTTP Authentication password</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A <a class="link" href="CouchdbCredentials.html" title="CouchdbCredentials"><span class="type">CouchdbCredentials</span></a> object.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="couchdb-credentials-get-auth-type"></a><h3>couchdb_credentials_get_auth_type ()</h3>
<pre class="programlisting"><a class="link" href="CouchdbCredentials.html#CouchdbCredentialsType" title="enum CouchdbCredentialsType"><span class="returnvalue">CouchdbCredentialsType</span></a> couchdb_credentials_get_auth_type
                                                        (<em class="parameter"><code><a class="link" href="CouchdbCredentials.html" title="CouchdbCredentials"><span class="type">CouchdbCredentials</span></a> *credentials</code></em>);</pre>
<p>
Retrieve the type of authentication defined for the given <a class="link" href="CouchdbCredentials.html" title="CouchdbCredentials"><span class="type">CouchdbCredentials</span></a> object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>credentials</code></em> :</span></p></td>
<td>A <a class="link" href="CouchdbCredentials.html" title="CouchdbCredentials"><span class="type">CouchdbCredentials</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A <a class="link" href="CouchdbCredentials.html#CouchdbCredentialsType" title="enum CouchdbCredentialsType"><span class="type">CouchdbCredentialsType</span></a> specifying the type of authentication.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="COUCHDB-CREDENTIALS-ITEM-OAUTH-CONSUMER-KEY:CAPS"></a><h3>COUCHDB_CREDENTIALS_ITEM_OAUTH_CONSUMER_KEY</h3>
<pre class="programlisting">#define COUCHDB_CREDENTIALS_ITEM_OAUTH_CONSUMER_KEY    "oauth_consumer_key"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="COUCHDB-CREDENTIALS-ITEM-OAUTH-CONSUMER-SECRET:CAPS"></a><h3>COUCHDB_CREDENTIALS_ITEM_OAUTH_CONSUMER_SECRET</h3>
<pre class="programlisting">#define COUCHDB_CREDENTIALS_ITEM_OAUTH_CONSUMER_SECRET "oauth_consumer_secret"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="COUCHDB-CREDENTIALS-ITEM-OAUTH-TOKEN-KEY:CAPS"></a><h3>COUCHDB_CREDENTIALS_ITEM_OAUTH_TOKEN_KEY</h3>
<pre class="programlisting">#define COUCHDB_CREDENTIALS_ITEM_OAUTH_TOKEN_KEY       "oauth_token_key"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="COUCHDB-CREDENTIALS-ITEM-OAUTH-TOKEN-SECRET:CAPS"></a><h3>COUCHDB_CREDENTIALS_ITEM_OAUTH_TOKEN_SECRET</h3>
<pre class="programlisting">#define COUCHDB_CREDENTIALS_ITEM_OAUTH_TOKEN_SECRET    "oauth_token_secret"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="COUCHDB-CREDENTIALS-ITEM-USERNAME:CAPS"></a><h3>COUCHDB_CREDENTIALS_ITEM_USERNAME</h3>
<pre class="programlisting">#define COUCHDB_CREDENTIALS_ITEM_USERNAME	       "username"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="COUCHDB-CREDENTIALS-ITEM-PASSWORD:CAPS"></a><h3>COUCHDB_CREDENTIALS_ITEM_PASSWORD</h3>
<pre class="programlisting">#define COUCHDB_CREDENTIALS_ITEM_PASSWORD	       "password"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="couchdb-credentials-get-item"></a><h3>couchdb_credentials_get_item ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       couchdb_credentials_get_item        (<em class="parameter"><code><a class="link" href="CouchdbCredentials.html" title="CouchdbCredentials"><span class="type">CouchdbCredentials</span></a> *credentials</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *item</code></em>);</pre>
<p>
Get the value associated with one authentication item on the given <a class="link" href="CouchdbCredentials.html" title="CouchdbCredentials"><span class="type">CouchdbCredentials</span></a> object.
The valid values are the COUCHDB_CREDENTIALS_ITEM_* values defined in couchdb-credentials.h.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>credentials</code></em> :</span></p></td>
<td>A <a class="link" href="CouchdbCredentials.html" title="CouchdbCredentials"><span class="type">CouchdbCredentials</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td>Name of the item to retrieve</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The value associated with the given item, or NULL if not found.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="couchdb-credentials-set-item"></a><h3>couchdb_credentials_set_item ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                couchdb_credentials_set_item        (<em class="parameter"><code><a class="link" href="CouchdbCredentials.html" title="CouchdbCredentials"><span class="type">CouchdbCredentials</span></a> *credentials</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *item</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *value</code></em>);</pre>
<p>
Set the value associated with one authentication item on the given <a class="link" href="CouchdbCredentials.html" title="CouchdbCredentials"><span class="type">CouchdbCredentials</span></a> object.
The valid values are the COUCHDB_CREDENTIALS_ITEM_* values defined in couchdb-credentials.h.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>credentials</code></em> :</span></p></td>
<td>A <a class="link" href="CouchdbCredentials.html" title="CouchdbCredentials"><span class="type">CouchdbCredentials</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td>Name of the item to set the value of
<span class="type">value</span>: Value of the item</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="CouchdbCredentialsPrivate"></a><h3>CouchdbCredentialsPrivate</h3>
<pre class="programlisting">typedef struct _CouchdbCredentialsPrivate CouchdbCredentialsPrivate;</pre>
<p>
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.