« back to all changes in this revision
Viewing changes to doc/grilo/html/GrlConfig.html
- browse files at revision 3
- compare with another revision
- download diff
- download tarball
- view history from revision 3
- Committer: Bazaar Package Importer
- Author(s): Alberto Garcia
- Date: 2011-07-02 13:48:46 UTC
- mfrom: (1.1.1 upstream)
- Revision ID: james.westby@ubuntu.com-20110702134846-u10hi90nwf6wf3v0
Tags: 0.1.16-1
* New upstream release.
* debian/{grl-inspect.1,libgrilo-0.1-0.manpages,libgrilo-0.1-0.install}:
use manpage shipped by upstream.
* debian/libgrilo-0.1-0.shlibs: new API, bump shlibs to 0.1.16.
* debian/copyright: Author(s) => Authors.
* debian/{grl-inspect.1,libgrilo-0.1-0.manpages,libgrilo-0.1-0.install}:
use manpage shipped by upstream.
* debian/libgrilo-0.1-0.shlibs: new API, bump shlibs to 0.1.16.
* debian/copyright: Author(s) => Authors.
- files added:
- doc/grilo/environment-setup.xml
- examples
- files removed:
- debian/grl-inspect.1
- files modified:
- ChangeLog
added
removed
doc/grilo/html/GrlConfig.html
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
<html>
3
<head>
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>GrlConfig</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
<link rel="home" href="index.html" title="Grilo Reference Manual">
8
<link rel="up" href="configure.html" title="Configuring plug-ins">
9
<link rel="prev" href="configure.html" title="Configuring plug-ins">
10
<link rel="next" href="data.html" title="Media data">
11
<meta name="generator" content="GTK-Doc V1.17.1 (XML mode)">
12
<link rel="stylesheet" href="style.css" type="text/css">
13
</head>
14
<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="2">
16
<tr valign="middle">
17
<td><a accesskey="p" href="configure.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
<td><a accesskey="u" href="configure.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
<th width="100%" align="center">Grilo Reference Manual</th>
21
<td><a accesskey="n" href="data.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22
</tr>
23
<tr><td colspan="5" class="shortcuts">
24
<a href="#GrlConfig.synopsis" class="shortcut">Top</a>
25
|
26
<a href="#GrlConfig.description" class="shortcut">Description</a>
27
|
28
<a href="#GrlConfig.object-hierarchy" class="shortcut">Object Hierarchy</a>
29
</td></tr>
30
</table>
31
<div class="refentry">
32
<a name="GrlConfig"></a><div class="titlepage"></div>
33
<div class="refnamediv"><table width="100%"><tr>
34
<td valign="top">
35
<h2><span class="refentrytitle"><a name="GrlConfig.top_of_page"></a>GrlConfig</span></h2>
36
<p>GrlConfig — Configuration data storage</p>
37
</td>
38
<td valign="top" align="right"></td>
39
</tr></table></div>
40
<div class="refsynopsisdiv">
41
<a name="GrlConfig.synopsis"></a><h2>Synopsis</h2>
42
<pre class="synopsis">
43
#include <grilo.h>
44
45
#define <a class="link" href="GrlConfig.html#GRL-CONFIG-KEY-PLUGIN:CAPS" title="GRL_CONFIG_KEY_PLUGIN">GRL_CONFIG_KEY_PLUGIN</a>
46
#define <a class="link" href="GrlConfig.html#GRL-CONFIG-KEY-SOURCE:CAPS" title="GRL_CONFIG_KEY_SOURCE">GRL_CONFIG_KEY_SOURCE</a>
47
#define <a class="link" href="GrlConfig.html#GRL-CONFIG-KEY-APIKEY:CAPS" title="GRL_CONFIG_KEY_APIKEY">GRL_CONFIG_KEY_APIKEY</a>
48
#define <a class="link" href="GrlConfig.html#GRL-CONFIG-KEY-APIKEY-BLOB:CAPS" title="GRL_CONFIG_KEY_APIKEY_BLOB">GRL_CONFIG_KEY_APIKEY_BLOB</a>
49
#define <a class="link" href="GrlConfig.html#GRL-CONFIG-KEY-APITOKEN:CAPS" title="GRL_CONFIG_KEY_APITOKEN">GRL_CONFIG_KEY_APITOKEN</a>
50
#define <a class="link" href="GrlConfig.html#GRL-CONFIG-KEY-APISECRET:CAPS" title="GRL_CONFIG_KEY_APISECRET">GRL_CONFIG_KEY_APISECRET</a>
51
#define <a class="link" href="GrlConfig.html#GRL-CONFIG-KEY-USERNAME:CAPS" title="GRL_CONFIG_KEY_USERNAME">GRL_CONFIG_KEY_USERNAME</a>
52
#define <a class="link" href="GrlConfig.html#GRL-CONFIG-KEY-PASSWORD:CAPS" title="GRL_CONFIG_KEY_PASSWORD">GRL_CONFIG_KEY_PASSWORD</a>
53
struct <a class="link" href="GrlConfig.html#GrlConfig-struct" title="struct GrlConfig">GrlConfig</a>;
54
struct <a class="link" href="GrlConfig.html#GrlConfigClass" title="struct GrlConfigClass">GrlConfigClass</a>;
55
<span class="returnvalue">void</span> <a class="link" href="GrlConfig.html#grl-config-set-plugin" title="grl_config_set_plugin ()">grl_config_set_plugin</a> (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
56
<em class="parameter"><code>const <span class="type">gchar</span> *plugin</code></em>);
57
<span class="returnvalue">void</span> <a class="link" href="GrlConfig.html#grl-config-set-source" title="grl_config_set_source ()">grl_config_set_source</a> (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
58
<em class="parameter"><code>const <span class="type">gchar</span> *source</code></em>);
59
<span class="returnvalue">void</span> <a class="link" href="GrlConfig.html#grl-config-set-api-key" title="grl_config_set_api_key ()">grl_config_set_api_key</a> (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
60
<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>);
61
<span class="returnvalue">void</span> <a class="link" href="GrlConfig.html#grl-config-set-api-key-blob" title="grl_config_set_api_key_blob ()">grl_config_set_api_key_blob</a> (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
62
<em class="parameter"><code>const <span class="type">guint8</span> *blob</code></em>,
63
<em class="parameter"><code><span class="type">gsize</span> size</code></em>);
64
<span class="returnvalue">void</span> <a class="link" href="GrlConfig.html#grl-config-set-api-token" title="grl_config_set_api_token ()">grl_config_set_api_token</a> (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
65
<em class="parameter"><code>const <span class="type">gchar</span> *token</code></em>);
66
<span class="returnvalue">void</span> <a class="link" href="GrlConfig.html#grl-config-set-api-secret" title="grl_config_set_api_secret ()">grl_config_set_api_secret</a> (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
67
<em class="parameter"><code>const <span class="type">gchar</span> *secret</code></em>);
68
<span class="returnvalue">void</span> <a class="link" href="GrlConfig.html#grl-config-set-username" title="grl_config_set_username ()">grl_config_set_username</a> (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
69
<em class="parameter"><code>const <span class="type">gchar</span> *username</code></em>);
70
<span class="returnvalue">void</span> <a class="link" href="GrlConfig.html#grl-config-set-password" title="grl_config_set_password ()">grl_config_set_password</a> (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
71
<em class="parameter"><code>const <span class="type">gchar</span> *password</code></em>);
72
<span class="returnvalue">gchar</span> * <a class="link" href="GrlConfig.html#grl-config-get-plugin" title="grl_config_get_plugin ()">grl_config_get_plugin</a> (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>);
73
<span class="returnvalue">gchar</span> * <a class="link" href="GrlConfig.html#grl-config-get-api-key" title="grl_config_get_api_key ()">grl_config_get_api_key</a> (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>);
74
<span class="returnvalue">guint8</span> * <a class="link" href="GrlConfig.html#grl-config-get-api-key-blob" title="grl_config_get_api_key_blob ()">grl_config_get_api_key_blob</a> (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
75
<em class="parameter"><code><span class="type">gsize</span> *size</code></em>);
76
<span class="returnvalue">gchar</span> * <a class="link" href="GrlConfig.html#grl-config-get-api-token" title="grl_config_get_api_token ()">grl_config_get_api_token</a> (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>);
77
<span class="returnvalue">gchar</span> * <a class="link" href="GrlConfig.html#grl-config-get-api-secret" title="grl_config_get_api_secret ()">grl_config_get_api_secret</a> (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>);
78
<span class="returnvalue">gchar</span> * <a class="link" href="GrlConfig.html#grl-config-get-username" title="grl_config_get_username ()">grl_config_get_username</a> (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>);
79
<span class="returnvalue">gchar</span> * <a class="link" href="GrlConfig.html#grl-config-get-password" title="grl_config_get_password ()">grl_config_get_password</a> (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>);
80
<a class="link" href="GrlConfig.html" title="GrlConfig"><span class="returnvalue">GrlConfig</span></a> * <a class="link" href="GrlConfig.html#grl-config-new" title="grl_config_new ()">grl_config_new</a> (<em class="parameter"><code>const <span class="type">gchar</span> *plugin</code></em>,
81
<em class="parameter"><code>const <span class="type">gchar</span> *source</code></em>);
82
<span class="returnvalue">void</span> <a class="link" href="GrlConfig.html#grl-config-set" title="grl_config_set ()">grl_config_set</a> (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
83
<em class="parameter"><code>const <span class="type">gchar</span> *param</code></em>,
84
<em class="parameter"><code>const <span class="type">GValue</span> *value</code></em>);
85
<span class="returnvalue">void</span> <a class="link" href="GrlConfig.html#grl-config-set-string" title="grl_config_set_string ()">grl_config_set_string</a> (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
86
<em class="parameter"><code>const <span class="type">gchar</span> *param</code></em>,
87
<em class="parameter"><code>const <span class="type">gchar</span> *value</code></em>);
88
<span class="returnvalue">void</span> <a class="link" href="GrlConfig.html#grl-config-set-int" title="grl_config_set_int ()">grl_config_set_int</a> (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
89
<em class="parameter"><code>const <span class="type">gchar</span> *param</code></em>,
90
<em class="parameter"><code><span class="type">gint</span> value</code></em>);
91
<span class="returnvalue">void</span> <a class="link" href="GrlConfig.html#grl-config-set-float" title="grl_config_set_float ()">grl_config_set_float</a> (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
92
<em class="parameter"><code>const <span class="type">gchar</span> *param</code></em>,
93
<em class="parameter"><code><span class="type">gfloat</span> value</code></em>);
94
<span class="returnvalue">void</span> <a class="link" href="GrlConfig.html#grl-config-set-boolean" title="grl_config_set_boolean ()">grl_config_set_boolean</a> (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
95
<em class="parameter"><code>const <span class="type">gchar</span> *param</code></em>,
96
<em class="parameter"><code><span class="type">gboolean</span> value</code></em>);
97
<span class="returnvalue">void</span> <a class="link" href="GrlConfig.html#grl-config-set-binary" title="grl_config_set_binary ()">grl_config_set_binary</a> (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
98
<em class="parameter"><code>const <span class="type">gchar</span> *param</code></em>,
99
<em class="parameter"><code>const <span class="type">guint8</span> *blob</code></em>,
100
<em class="parameter"><code><span class="type">gsize</span> size</code></em>);
101
<span class="returnvalue">gchar</span> * <a class="link" href="GrlConfig.html#grl-config-get-string" title="grl_config_get_string ()">grl_config_get_string</a> (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
102
<em class="parameter"><code>const <span class="type">gchar</span> *param</code></em>);
103
<span class="returnvalue">gint</span> <a class="link" href="GrlConfig.html#grl-config-get-int" title="grl_config_get_int ()">grl_config_get_int</a> (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
104
<em class="parameter"><code>const <span class="type">gchar</span> *param</code></em>);
105
<span class="returnvalue">gfloat</span> <a class="link" href="GrlConfig.html#grl-config-get-float" title="grl_config_get_float ()">grl_config_get_float</a> (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
106
<em class="parameter"><code>const <span class="type">gchar</span> *param</code></em>);
107
<span class="returnvalue">gboolean</span> <a class="link" href="GrlConfig.html#grl-config-get-boolean" title="grl_config_get_boolean ()">grl_config_get_boolean</a> (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
108
<em class="parameter"><code>const <span class="type">gchar</span> *param</code></em>);
109
<span class="returnvalue">guint8</span> * <a class="link" href="GrlConfig.html#grl-config-get-binary" title="grl_config_get_binary ()">grl_config_get_binary</a> (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
110
<em class="parameter"><code>const <span class="type">gchar</span> *param</code></em>,
111
<em class="parameter"><code><span class="type">gsize</span> *size</code></em>);
112
<span class="returnvalue">gboolean</span> <a class="link" href="GrlConfig.html#grl-config-has-param" title="grl_config_has_param ()">grl_config_has_param</a> (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
113
<em class="parameter"><code>const <span class="type">gchar</span> *param</code></em>);
114
</pre>
115
</div>
116
<div class="refsect1">
117
<a name="GrlConfig.object-hierarchy"></a><h2>Object Hierarchy</h2>
118
<pre class="synopsis">
119
GObject
120
+----GrlConfig
121
</pre>
122
</div>
123
<div class="refsect1">
124
<a name="GrlConfig.description"></a><h2>Description</h2>
125
<p>
126
This class is used to store configuration settings used by plugins.
127
</p>
128
</div>
129
<div class="refsect1">
130
<a name="GrlConfig.details"></a><h2>Details</h2>
131
<div class="refsect2">
132
<a name="GRL-CONFIG-KEY-PLUGIN:CAPS"></a><h3>GRL_CONFIG_KEY_PLUGIN</h3>
133
<pre class="programlisting">#define GRL_CONFIG_KEY_PLUGIN "target-plugin"
134
</pre>
135
</div>
136
<hr>
137
<div class="refsect2">
138
<a name="GRL-CONFIG-KEY-SOURCE:CAPS"></a><h3>GRL_CONFIG_KEY_SOURCE</h3>
139
<pre class="programlisting">#define GRL_CONFIG_KEY_SOURCE "target-source"
140
</pre>
141
</div>
142
<hr>
143
<div class="refsect2">
144
<a name="GRL-CONFIG-KEY-APIKEY:CAPS"></a><h3>GRL_CONFIG_KEY_APIKEY</h3>
145
<pre class="programlisting">#define GRL_CONFIG_KEY_APIKEY "api-key"
146
</pre>
147
</div>
148
<hr>
149
<div class="refsect2">
150
<a name="GRL-CONFIG-KEY-APIKEY-BLOB:CAPS"></a><h3>GRL_CONFIG_KEY_APIKEY_BLOB</h3>
151
<pre class="programlisting">#define GRL_CONFIG_KEY_APIKEY_BLOB "api-key-blob"
152
</pre>
153
</div>
154
<hr>
155
<div class="refsect2">
156
<a name="GRL-CONFIG-KEY-APITOKEN:CAPS"></a><h3>GRL_CONFIG_KEY_APITOKEN</h3>
157
<pre class="programlisting">#define GRL_CONFIG_KEY_APITOKEN "api-token"
158
</pre>
159
</div>
160
<hr>
161
<div class="refsect2">
162
<a name="GRL-CONFIG-KEY-APISECRET:CAPS"></a><h3>GRL_CONFIG_KEY_APISECRET</h3>
163
<pre class="programlisting">#define GRL_CONFIG_KEY_APISECRET "api-secret"
164
</pre>
165
</div>
166
<hr>
167
<div class="refsect2">
168
<a name="GRL-CONFIG-KEY-USERNAME:CAPS"></a><h3>GRL_CONFIG_KEY_USERNAME</h3>
169
<pre class="programlisting">#define GRL_CONFIG_KEY_USERNAME "username"
170
</pre>
171
</div>
172
<hr>
173
<div class="refsect2">
174
<a name="GRL-CONFIG-KEY-PASSWORD:CAPS"></a><h3>GRL_CONFIG_KEY_PASSWORD</h3>
175
<pre class="programlisting">#define GRL_CONFIG_KEY_PASSWORD "password"
176
</pre>
177
</div>
178
<hr>
179
<div class="refsect2">
180
<a name="GrlConfig-struct"></a><h3>struct GrlConfig</h3>
181
<pre class="programlisting">struct GrlConfig;</pre>
182
</div>
183
<hr>
184
<div class="refsect2">
185
<a name="GrlConfigClass"></a><h3>struct GrlConfigClass</h3>
186
<pre class="programlisting">struct GrlConfigClass {
187
GObjectClass parent_class;
188
};
189
</pre>
190
<p>
191
Grilo Config Class
192
</p>
193
<div class="variablelist"><table border="0">
194
<col align="left" valign="top">
195
<tbody><tr>
196
<td><p><span class="term"><span class="type">GObjectClass</span> <em class="structfield"><code><a name="GrlConfigClass.parent-class"></a>parent_class</code></em>;</span></p></td>
197
<td>the parent class structure</td>
198
</tr></tbody>
199
</table></div>
200
</div>
201
<hr>
202
<div class="refsect2">
203
<a name="grl-config-set-plugin"></a><h3>grl_config_set_plugin ()</h3>
204
<pre class="programlisting"><span class="returnvalue">void</span> grl_config_set_plugin (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
205
<em class="parameter"><code>const <span class="type">gchar</span> *plugin</code></em>);</pre>
206
<p>
207
Set the plugin key in the configuration
208
</p>
209
<div class="variablelist"><table border="0">
210
<col align="left" valign="top">
211
<tbody>
212
<tr>
213
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
214
<td>the config instance</td>
215
</tr>
216
<tr>
217
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
218
<td>the plugin id</td>
219
</tr>
220
</tbody>
221
</table></div>
222
<p class="since">Since 0.1.4</p>
223
</div>
224
<hr>
225
<div class="refsect2">
226
<a name="grl-config-set-source"></a><h3>grl_config_set_source ()</h3>
227
<pre class="programlisting"><span class="returnvalue">void</span> grl_config_set_source (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
228
<em class="parameter"><code>const <span class="type">gchar</span> *source</code></em>);</pre>
229
<p>
230
Set the plugin key in the configuration
231
</p>
232
<div class="variablelist"><table border="0">
233
<col align="left" valign="top">
234
<tbody>
235
<tr>
236
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
237
<td>the config instance</td>
238
</tr>
239
<tr>
240
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
241
<td>the source id</td>
242
</tr>
243
</tbody>
244
</table></div>
245
<p class="since">Since 0.1.4</p>
246
</div>
247
<hr>
248
<div class="refsect2">
249
<a name="grl-config-set-api-key"></a><h3>grl_config_set_api_key ()</h3>
250
<pre class="programlisting"><span class="returnvalue">void</span> grl_config_set_api_key (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
251
<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>);</pre>
252
<p>
253
Set the webservice API key in the configuration
254
</p>
255
<div class="variablelist"><table border="0">
256
<col align="left" valign="top">
257
<tbody>
258
<tr>
259
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
260
<td>the config instance</td>
261
</tr>
262
<tr>
263
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
264
<td>the API key</td>
265
</tr>
266
</tbody>
267
</table></div>
268
<p class="since">Since 0.1.4</p>
269
</div>
270
<hr>
271
<div class="refsect2">
272
<a name="grl-config-set-api-key-blob"></a><h3>grl_config_set_api_key_blob ()</h3>
273
<pre class="programlisting"><span class="returnvalue">void</span> grl_config_set_api_key_blob (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
274
<em class="parameter"><code>const <span class="type">guint8</span> *blob</code></em>,
275
<em class="parameter"><code><span class="type">gsize</span> size</code></em>);</pre>
276
<p>
277
Set the binary API key in the configuration
278
</p>
279
<div class="variablelist"><table border="0">
280
<col align="left" valign="top">
281
<tbody>
282
<tr>
283
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
284
<td>the config instance</td>
285
</tr>
286
<tr>
287
<td><p><span class="term"><em class="parameter"><code>blob</code></em> :</span></p></td>
288
<td>the binary API key blob</td>
289
</tr>
290
<tr>
291
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
292
<td>the size of the blob</td>
293
</tr>
294
</tbody>
295
</table></div>
296
<p class="since">Since 0.1.9</p>
297
</div>
298
<hr>
299
<div class="refsect2">
300
<a name="grl-config-set-api-token"></a><h3>grl_config_set_api_token ()</h3>
301
<pre class="programlisting"><span class="returnvalue">void</span> grl_config_set_api_token (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
302
<em class="parameter"><code>const <span class="type">gchar</span> *token</code></em>);</pre>
303
<p>
304
Set the webservice API token in the configuration
305
</p>
306
<div class="variablelist"><table border="0">
307
<col align="left" valign="top">
308
<tbody>
309
<tr>
310
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
311
<td>the config instance</td>
312
</tr>
313
<tr>
314
<td><p><span class="term"><em class="parameter"><code>token</code></em> :</span></p></td>
315
<td>the API token</td>
316
</tr>
317
</tbody>
318
</table></div>
319
<p class="since">Since 0.1.4</p>
320
</div>
321
<hr>
322
<div class="refsect2">
323
<a name="grl-config-set-api-secret"></a><h3>grl_config_set_api_secret ()</h3>
324
<pre class="programlisting"><span class="returnvalue">void</span> grl_config_set_api_secret (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
325
<em class="parameter"><code>const <span class="type">gchar</span> *secret</code></em>);</pre>
326
<p>
327
Set the webservice passphrase in the configuration
328
</p>
329
<div class="variablelist"><table border="0">
330
<col align="left" valign="top">
331
<tbody>
332
<tr>
333
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
334
<td>the config instance</td>
335
</tr>
336
<tr>
337
<td><p><span class="term"><em class="parameter"><code>secret</code></em> :</span></p></td>
338
<td>the webservice passphrase</td>
339
</tr>
340
</tbody>
341
</table></div>
342
<p class="since">Since 0.1.4</p>
343
</div>
344
<hr>
345
<div class="refsect2">
346
<a name="grl-config-set-username"></a><h3>grl_config_set_username ()</h3>
347
<pre class="programlisting"><span class="returnvalue">void</span> grl_config_set_username (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
348
<em class="parameter"><code>const <span class="type">gchar</span> *username</code></em>);</pre>
349
<p>
350
Set the username in the configuration
351
</p>
352
<div class="variablelist"><table border="0">
353
<col align="left" valign="top">
354
<tbody>
355
<tr>
356
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
357
<td>the config instance</td>
358
</tr>
359
<tr>
360
<td><p><span class="term"><em class="parameter"><code>username</code></em> :</span></p></td>
361
<td>the username</td>
362
</tr>
363
</tbody>
364
</table></div>
365
<p class="since">Since 0.1.8</p>
366
</div>
367
<hr>
368
<div class="refsect2">
369
<a name="grl-config-set-password"></a><h3>grl_config_set_password ()</h3>
370
<pre class="programlisting"><span class="returnvalue">void</span> grl_config_set_password (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
371
<em class="parameter"><code>const <span class="type">gchar</span> *password</code></em>);</pre>
372
<p>
373
Set the password in the configuration
374
</p>
375
<div class="variablelist"><table border="0">
376
<col align="left" valign="top">
377
<tbody>
378
<tr>
379
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
380
<td>the config instance</td>
381
</tr>
382
<tr>
383
<td><p><span class="term"><em class="parameter"><code>password</code></em> :</span></p></td>
384
<td>the password</td>
385
</tr>
386
</tbody>
387
</table></div>
388
<p class="since">Since 0.1.8</p>
389
</div>
390
<hr>
391
<div class="refsect2">
392
<a name="grl-config-get-plugin"></a><h3>grl_config_get_plugin ()</h3>
393
<pre class="programlisting"><span class="returnvalue">gchar</span> * grl_config_get_plugin (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>);</pre>
394
<div class="variablelist"><table border="0">
395
<col align="left" valign="top">
396
<tbody>
397
<tr>
398
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
399
<td>the config instance</td>
400
</tr>
401
<tr>
402
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
403
<td>the plugin id</td>
404
</tr>
405
</tbody>
406
</table></div>
407
<p class="since">Since 0.1.4</p>
408
</div>
409
<hr>
410
<div class="refsect2">
411
<a name="grl-config-get-api-key"></a><h3>grl_config_get_api_key ()</h3>
412
<pre class="programlisting"><span class="returnvalue">gchar</span> * grl_config_get_api_key (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>);</pre>
413
<div class="variablelist"><table border="0">
414
<col align="left" valign="top">
415
<tbody>
416
<tr>
417
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
418
<td>the config instance</td>
419
</tr>
420
<tr>
421
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
422
<td>the webservice API key</td>
423
</tr>
424
</tbody>
425
</table></div>
426
<p class="since">Since 0.1.4</p>
427
</div>
428
<hr>
429
<div class="refsect2">
430
<a name="grl-config-get-api-key-blob"></a><h3>grl_config_get_api_key_blob ()</h3>
431
<pre class="programlisting"><span class="returnvalue">guint8</span> * grl_config_get_api_key_blob (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
432
<em class="parameter"><code><span class="type">gsize</span> *size</code></em>);</pre>
433
<div class="variablelist"><table border="0">
434
<col align="left" valign="top">
435
<tbody>
436
<tr>
437
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
438
<td>the config instance</td>
439
</tr>
440
<tr>
441
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
442
<td>pointer to size of data</td>
443
</tr>
444
<tr>
445
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
446
<td>the binary API key, size will reflect the size of the buffer</td>
447
</tr>
448
</tbody>
449
</table></div>
450
<p class="since">Since 0.1.9</p>
451
</div>
452
<hr>
453
<div class="refsect2">
454
<a name="grl-config-get-api-token"></a><h3>grl_config_get_api_token ()</h3>
455
<pre class="programlisting"><span class="returnvalue">gchar</span> * grl_config_get_api_token (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>);</pre>
456
<div class="variablelist"><table border="0">
457
<col align="left" valign="top">
458
<tbody>
459
<tr>
460
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
461
<td>the config instance</td>
462
</tr>
463
<tr>
464
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
465
<td>the webservice API token</td>
466
</tr>
467
</tbody>
468
</table></div>
469
<p class="since">Since 0.1.4</p>
470
</div>
471
<hr>
472
<div class="refsect2">
473
<a name="grl-config-get-api-secret"></a><h3>grl_config_get_api_secret ()</h3>
474
<pre class="programlisting"><span class="returnvalue">gchar</span> * grl_config_get_api_secret (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>);</pre>
475
<div class="variablelist"><table border="0">
476
<col align="left" valign="top">
477
<tbody>
478
<tr>
479
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
480
<td>the config instance</td>
481
</tr>
482
<tr>
483
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
484
<td>the webservice API passphrase</td>
485
</tr>
486
</tbody>
487
</table></div>
488
<p class="since">Since 0.1.4</p>
489
</div>
490
<hr>
491
<div class="refsect2">
492
<a name="grl-config-get-username"></a><h3>grl_config_get_username ()</h3>
493
<pre class="programlisting"><span class="returnvalue">gchar</span> * grl_config_get_username (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>);</pre>
494
<div class="variablelist"><table border="0">
495
<col align="left" valign="top">
496
<tbody>
497
<tr>
498
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
499
<td>the config instance</td>
500
</tr>
501
<tr>
502
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
503
<td>the username</td>
504
</tr>
505
</tbody>
506
</table></div>
507
<p class="since">Since 0.1.8</p>
508
</div>
509
<hr>
510
<div class="refsect2">
511
<a name="grl-config-get-password"></a><h3>grl_config_get_password ()</h3>
512
<pre class="programlisting"><span class="returnvalue">gchar</span> * grl_config_get_password (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>);</pre>
513
<div class="variablelist"><table border="0">
514
<col align="left" valign="top">
515
<tbody>
516
<tr>
517
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
518
<td>the config instance</td>
519
</tr>
520
<tr>
521
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
522
<td>the password</td>
523
</tr>
524
</tbody>
525
</table></div>
526
<p class="since">Since 0.1.8</p>
527
</div>
528
<hr>
529
<div class="refsect2">
530
<a name="grl-config-new"></a><h3>grl_config_new ()</h3>
531
<pre class="programlisting"><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="returnvalue">GrlConfig</span></a> * grl_config_new (<em class="parameter"><code>const <span class="type">gchar</span> *plugin</code></em>,
532
<em class="parameter"><code>const <span class="type">gchar</span> *source</code></em>);</pre>
533
<p>
534
Creates a new data config object that will be associated with a plugin
535
(if <em class="parameter"><code>source</code></em> is NULL), or a specific source spawned from a plugin (if
536
<em class="parameter"><code>source</code></em> is not NULL). The latter may be useful for plugins
537
spawning various sources, each one needing a different configuration.
538
</p>
539
<div class="variablelist"><table border="0">
540
<col align="left" valign="top">
541
<tbody>
542
<tr>
543
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
544
<td>plugin id for this configuration</td>
545
</tr>
546
<tr>
547
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
548
<td>source id for this configuration. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
549
</td>
550
</tr>
551
<tr>
552
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
553
<td>a newly-allocated data config. The data
554
config associated with the plugin should not be freed until the plugin
555
has been unloaded. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
556
</td>
557
</tr>
558
</tbody>
559
</table></div>
560
<p class="since">Since 0.1.4</p>
561
</div>
562
<hr>
563
<div class="refsect2">
564
<a name="grl-config-set"></a><h3>grl_config_set ()</h3>
565
<pre class="programlisting"><span class="returnvalue">void</span> grl_config_set (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
566
<em class="parameter"><code>const <span class="type">gchar</span> *param</code></em>,
567
<em class="parameter"><code>const <span class="type">GValue</span> *value</code></em>);</pre>
568
</div>
569
<hr>
570
<div class="refsect2">
571
<a name="grl-config-set-string"></a><h3>grl_config_set_string ()</h3>
572
<pre class="programlisting"><span class="returnvalue">void</span> grl_config_set_string (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
573
<em class="parameter"><code>const <span class="type">gchar</span> *param</code></em>,
574
<em class="parameter"><code>const <span class="type">gchar</span> *value</code></em>);</pre>
575
</div>
576
<hr>
577
<div class="refsect2">
578
<a name="grl-config-set-int"></a><h3>grl_config_set_int ()</h3>
579
<pre class="programlisting"><span class="returnvalue">void</span> grl_config_set_int (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
580
<em class="parameter"><code>const <span class="type">gchar</span> *param</code></em>,
581
<em class="parameter"><code><span class="type">gint</span> value</code></em>);</pre>
582
</div>
583
<hr>
584
<div class="refsect2">
585
<a name="grl-config-set-float"></a><h3>grl_config_set_float ()</h3>
586
<pre class="programlisting"><span class="returnvalue">void</span> grl_config_set_float (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
587
<em class="parameter"><code>const <span class="type">gchar</span> *param</code></em>,
588
<em class="parameter"><code><span class="type">gfloat</span> value</code></em>);</pre>
589
</div>
590
<hr>
591
<div class="refsect2">
592
<a name="grl-config-set-boolean"></a><h3>grl_config_set_boolean ()</h3>
593
<pre class="programlisting"><span class="returnvalue">void</span> grl_config_set_boolean (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
594
<em class="parameter"><code>const <span class="type">gchar</span> *param</code></em>,
595
<em class="parameter"><code><span class="type">gboolean</span> value</code></em>);</pre>
596
</div>
597
<hr>
598
<div class="refsect2">
599
<a name="grl-config-set-binary"></a><h3>grl_config_set_binary ()</h3>
600
<pre class="programlisting"><span class="returnvalue">void</span> grl_config_set_binary (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
601
<em class="parameter"><code>const <span class="type">gchar</span> *param</code></em>,
602
<em class="parameter"><code>const <span class="type">guint8</span> *blob</code></em>,
603
<em class="parameter"><code><span class="type">gsize</span> size</code></em>);</pre>
604
</div>
605
<hr>
606
<div class="refsect2">
607
<a name="grl-config-get-string"></a><h3>grl_config_get_string ()</h3>
608
<pre class="programlisting"><span class="returnvalue">gchar</span> * grl_config_get_string (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
609
<em class="parameter"><code>const <span class="type">gchar</span> *param</code></em>);</pre>
610
</div>
611
<hr>
612
<div class="refsect2">
613
<a name="grl-config-get-int"></a><h3>grl_config_get_int ()</h3>
614
<pre class="programlisting"><span class="returnvalue">gint</span> grl_config_get_int (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
615
<em class="parameter"><code>const <span class="type">gchar</span> *param</code></em>);</pre>
616
</div>
617
<hr>
618
<div class="refsect2">
619
<a name="grl-config-get-float"></a><h3>grl_config_get_float ()</h3>
620
<pre class="programlisting"><span class="returnvalue">gfloat</span> grl_config_get_float (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
621
<em class="parameter"><code>const <span class="type">gchar</span> *param</code></em>);</pre>
622
</div>
623
<hr>
624
<div class="refsect2">
625
<a name="grl-config-get-boolean"></a><h3>grl_config_get_boolean ()</h3>
626
<pre class="programlisting"><span class="returnvalue">gboolean</span> grl_config_get_boolean (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
627
<em class="parameter"><code>const <span class="type">gchar</span> *param</code></em>);</pre>
628
</div>
629
<hr>
630
<div class="refsect2">
631
<a name="grl-config-get-binary"></a><h3>grl_config_get_binary ()</h3>
632
<pre class="programlisting"><span class="returnvalue">guint8</span> * grl_config_get_binary (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
633
<em class="parameter"><code>const <span class="type">gchar</span> *param</code></em>,
634
<em class="parameter"><code><span class="type">gsize</span> *size</code></em>);</pre>
635
</div>
636
<hr>
637
<div class="refsect2">
638
<a name="grl-config-has-param"></a><h3>grl_config_has_param ()</h3>
639
<pre class="programlisting"><span class="returnvalue">gboolean</span> grl_config_has_param (<em class="parameter"><code><a class="link" href="GrlConfig.html" title="GrlConfig"><span class="type">GrlConfig</span></a> *config</code></em>,
640
<em class="parameter"><code>const <span class="type">gchar</span> *param</code></em>);</pre>
641
<div class="variablelist"><table border="0">
642
<col align="left" valign="top">
643
<tbody>
644
<tr>
645
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
646
<td>the config instance</td>
647
</tr>
648
<tr>
649
<td><p><span class="term"><em class="parameter"><code>param</code></em> :</span></p></td>
650
<td>the param</td>
651
</tr>
652
<tr>
653
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
654
<td>TRUE if <em class="parameter"><code>params</code></em> has a defined value within <em class="parameter"><code>config</code></em>, FALSE
655
otherwise.</td>
656
</tr>
657
</tbody>
658
</table></div>
659
<p class="since">Since 0.1.8</p>
660
</div>
661
</div>
662
</div>
663
<div class="footer">
664
<hr>
665
Generated by GTK-Doc V1.17.1</div>
666
</body>
667
</html>
b'\\ No newline at end of file'
Loggerhead is a web-based interface for Breezy
Version: 2.0.1