← Back to branch summary

~ubuntu-branches/ubuntu/precise/telepathy-mission-control-5/precise

« back to all changes in this revision

Viewing changes to doc/reference/mission-control-plugins/html/mission-control-plugins-account.html

Tags: upstream-5.5.0
Import upstream version 5.5.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/mission-control-plugins/html/mission-control-plugins-account.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>account</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
7
<link rel="home" href="index.html" title="Mission Control Plugins Reference Manual">
 
8
<link rel="up" href="ch02.html" title="Account storage">
 
9
<link rel="prev" href="McpAccountStorage.html" title="McpAccountStorage">
 
10
<link rel="next" href="ch03.html" title="Channel requests">
 
11
<meta name="generator" content="GTK-Doc V1.15 (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="McpAccountStorage.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="ch02.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">Mission Control Plugins Reference Manual</th>
 
21
<td><a accesskey="n" href="ch03.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="#mission-control-plugins-account.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#mission-control-plugins-account.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#mission-control-plugins-account.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
                   | 
 
30
                  <a href="#mission-control-plugins-account.prerequisites" class="shortcut">Prerequisites</a>
 
31
</td></tr>
 
32
</table>
 
33
<div class="refentry" title="account">
 
34
<a name="mission-control-plugins-account"></a><div class="titlepage"></div>
 
35
<div class="refnamediv"><table width="100%"><tr>
 
36
<td valign="top">
 
37
<h2><span class="refentrytitle"><a name="mission-control-plugins-account.top_of_page"></a>account</span></h2>
 
38
<p>account</p>
 
39
</td>
 
40
<td valign="top" align="right"></td>
 
41
</tr></table></div>
 
42
<div class="refsynopsisdiv" title="Synopsis">
 
43
<a name="mission-control-plugins-account.synopsis"></a><h2>Synopsis</h2>
 
44
<a name="McpAccountManager"></a><pre class="synopsis">                    <a class="link" href="mission-control-plugins-account.html#McpAccountManager-struct" title="McpAccountManager">McpAccountManager</a>;
 
45
                    <a class="link" href="mission-control-plugins-account.html#McpAccountManagerIface" title="McpAccountManagerIface">McpAccountManagerIface</a>;
 
46
<span class="returnvalue">void</span>                <a class="link" href="mission-control-plugins-account.html#mcp-account-manager-set-value" title="mcp_account_manager_set_value ()">mcp_account_manager_set_value</a>       (<em class="parameter"><code>const <a class="link" href="mission-control-plugins-account.html#McpAccountManager"><span class="type">McpAccountManager</span></a> *mcpa</code></em>,
 
47
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *acct</code></em>,
 
48
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
 
49
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>);
 
50
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="mission-control-plugins-account.html#mcp-account-manager-get-value" title="mcp_account_manager_get_value ()">mcp_account_manager_get_value</a>       (<em class="parameter"><code>const <a class="link" href="mission-control-plugins-account.html#McpAccountManager"><span class="type">McpAccountManager</span></a> *mcpa</code></em>,
 
51
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *acct</code></em>,
 
52
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);
 
53
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="mission-control-plugins-account.html#mcp-account-manager-parameter-is-secret" title="mcp_account_manager_parameter_is_secret ()">mcp_account_manager_parameter_is_secret</a>
 
54
                                                        (<em class="parameter"><code>const <a class="link" href="mission-control-plugins-account.html#McpAccountManager"><span class="type">McpAccountManager</span></a> *mcpa</code></em>,
 
55
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *acct</code></em>,
 
56
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);
 
57
<span class="returnvalue">void</span>                <a class="link" href="mission-control-plugins-account.html#mcp-account-manager-parameter-make-secret" title="mcp_account_manager_parameter_make_secret ()">mcp_account_manager_parameter_make_secret</a>
 
58
                                                        (<em class="parameter"><code>const <a class="link" href="mission-control-plugins-account.html#McpAccountManager"><span class="type">McpAccountManager</span></a> *mcpa</code></em>,
 
59
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *acct</code></em>,
 
60
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);
 
61
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="mission-control-plugins-account.html#mcp-account-manager-get-unique-name" title="mcp_account_manager_get_unique_name ()">mcp_account_manager_get_unique_name</a> (<em class="parameter"><code><a class="link" href="mission-control-plugins-account.html#McpAccountManager"><span class="type">McpAccountManager</span></a> *mcpa</code></em>,
 
62
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *manager</code></em>,
 
63
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *protocol</code></em>,
 
64
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *params</code></em>);
 
65
</pre>
 
66
</div>
 
67
<div class="refsect1" title="Object Hierarchy">
 
68
<a name="mission-control-plugins-account.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
69
<pre class="synopsis">
 
70
  GInterface
 
71
   +----McpAccountManager
 
72
</pre>
 
73
</div>
 
74
<div class="refsect1" title="Prerequisites">
 
75
<a name="mission-control-plugins-account.prerequisites"></a><h2>Prerequisites</h2>
 
76
<p>
 
77
McpAccountManager requires
 
78
 <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p>
 
79
</div>
 
80
<div class="refsect1" title="Description">
 
81
<a name="mission-control-plugins-account.description"></a><h2>Description</h2>
 
82
<p>
 
83
</p>
 
84
</div>
 
85
<div class="refsect1" title="Details">
 
86
<a name="mission-control-plugins-account.details"></a><h2>Details</h2>
 
87
<div class="refsect2" title="McpAccountManager">
 
88
<a name="McpAccountManager-struct"></a><h3>McpAccountManager</h3>
 
89
<pre class="programlisting">typedef struct _McpAccountManager McpAccountManager;</pre>
 
90
<p>
 
91
</p>
 
92
</div>
 
93
<hr>
 
94
<div class="refsect2" title="McpAccountManagerIface">
 
95
<a name="McpAccountManagerIface"></a><h3>McpAccountManagerIface</h3>
 
96
<pre class="programlisting">typedef struct _McpAccountManagerIface McpAccountManagerIface;</pre>
 
97
<p>
 
98
</p>
 
99
</div>
 
100
<hr>
 
101
<div class="refsect2" title="mcp_account_manager_set_value ()">
 
102
<a name="mcp-account-manager-set-value"></a><h3>mcp_account_manager_set_value ()</h3>
 
103
<pre class="programlisting"><span class="returnvalue">void</span>                mcp_account_manager_set_value       (<em class="parameter"><code>const <a class="link" href="mission-control-plugins-account.html#McpAccountManager"><span class="type">McpAccountManager</span></a> *mcpa</code></em>,
 
104
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *acct</code></em>,
 
105
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
 
106
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>);</pre>
 
107
<p>
 
108
</p>
 
109
<div class="variablelist"><table border="0">
 
110
<col align="left" valign="top">
 
111
<tbody>
 
112
<tr>
 
113
<td><p><span class="term"><em class="parameter"><code>mcpa</code></em> :</span></p></td>
 
114
<td>
 
115
</td>
 
116
</tr>
 
117
<tr>
 
118
<td><p><span class="term"><em class="parameter"><code>acct</code></em> :</span></p></td>
 
119
<td>
 
120
</td>
 
121
</tr>
 
122
<tr>
 
123
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 
124
<td>
 
125
</td>
 
126
</tr>
 
127
<tr>
 
128
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 
129
<td>
 
130
</td>
 
131
</tr>
 
132
</tbody>
 
133
</table></div>
 
134
</div>
 
135
<hr>
 
136
<div class="refsect2" title="mcp_account_manager_get_value ()">
 
137
<a name="mcp-account-manager-get-value"></a><h3>mcp_account_manager_get_value ()</h3>
 
138
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             mcp_account_manager_get_value       (<em class="parameter"><code>const <a class="link" href="mission-control-plugins-account.html#McpAccountManager"><span class="type">McpAccountManager</span></a> *mcpa</code></em>,
 
139
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *acct</code></em>,
 
140
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);</pre>
 
141
<p>
 
142
Fetch a copy of the current value of an account setting held by
 
143
the <span class="type">McdAccountManager</span>.
 
144
</p>
 
145
<div class="variablelist"><table border="0">
 
146
<col align="left" valign="top">
 
147
<tbody>
 
148
<tr>
 
149
<td><p><span class="term"><em class="parameter"><code>mcpa</code></em> :</span></p></td>
 
150
<td>an <a class="link" href="mission-control-plugins-account.html#McpAccountManager"><span class="type">McpAccountManager</span></a> instance
 
151
</td>
 
152
</tr>
 
153
<tr>
 
154
<td><p><span class="term"><em class="parameter"><code>acct</code></em> :</span></p></td>
 
155
<td>the unique name of an account
 
156
</td>
 
157
</tr>
 
158
<tr>
 
159
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 
160
<td>the setting whose value we want to retrieve
 
161
</td>
 
162
</tr>
 
163
<tr>
 
164
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
165
<td> a <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* which should be freed when the caller is done with it.
 
166
</td>
 
167
</tr>
 
168
</tbody>
 
169
</table></div>
 
170
</div>
 
171
<hr>
 
172
<div class="refsect2" title="mcp_account_manager_parameter_is_secret ()">
 
173
<a name="mcp-account-manager-parameter-is-secret"></a><h3>mcp_account_manager_parameter_is_secret ()</h3>
 
174
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            mcp_account_manager_parameter_is_secret
 
175
                                                        (<em class="parameter"><code>const <a class="link" href="mission-control-plugins-account.html#McpAccountManager"><span class="type">McpAccountManager</span></a> *mcpa</code></em>,
 
176
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *acct</code></em>,
 
177
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);</pre>
 
178
<p>
 
179
Determine whether a given account parameter is secret.
 
180
generally this is determined by MC and passed down to us,
 
181
but any <a class="link" href="McpAccountStorage.html" title="McpAccountStorage"><span class="type">McpAccountStorage</span></a> plugin may decide a setting is
 
182
secret, in which case the return value for this call will
 
183
indicate that fact.
 
184
</p>
 
185
<div class="variablelist"><table border="0">
 
186
<col align="left" valign="top">
 
187
<tbody>
 
188
<tr>
 
189
<td><p><span class="term"><em class="parameter"><code>mcpa</code></em> :</span></p></td>
 
190
<td>an <a class="link" href="mission-control-plugins-account.html#McpAccountManager"><span class="type">McpAccountManager</span></a> instance
 
191
</td>
 
192
</tr>
 
193
<tr>
 
194
<td><p><span class="term"><em class="parameter"><code>acct</code></em> :</span></p></td>
 
195
<td>the unique name of an account
 
196
</td>
 
197
</tr>
 
198
<tr>
 
199
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 
200
<td>the setting whose value we want to retrieve
 
201
</td>
 
202
</tr>
 
203
<tr>
 
204
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
205
<td> a <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> for secret settings, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise
 
206
</td>
 
207
</tr>
 
208
</tbody>
 
209
</table></div>
 
210
</div>
 
211
<hr>
 
212
<div class="refsect2" title="mcp_account_manager_parameter_make_secret ()">
 
213
<a name="mcp-account-manager-parameter-make-secret"></a><h3>mcp_account_manager_parameter_make_secret ()</h3>
 
214
<pre class="programlisting"><span class="returnvalue">void</span>                mcp_account_manager_parameter_make_secret
 
215
                                                        (<em class="parameter"><code>const <a class="link" href="mission-control-plugins-account.html#McpAccountManager"><span class="type">McpAccountManager</span></a> *mcpa</code></em>,
 
216
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *acct</code></em>,
 
217
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);</pre>
 
218
<p>
 
219
Flag an account setting as secret for the lifetime of this
 
220
<a class="link" href="mission-control-plugins-account.html#McpAccountManager"><span class="type">McpAccountManager</span></a> and its corresponding <span class="type">McdAccountManager</span>
 
221
</p>
 
222
<div class="variablelist"><table border="0">
 
223
<col align="left" valign="top">
 
224
<tbody>
 
225
<tr>
 
226
<td><p><span class="term"><em class="parameter"><code>mcpa</code></em> :</span></p></td>
 
227
<td>an <a class="link" href="mission-control-plugins-account.html#McpAccountManager"><span class="type">McpAccountManager</span></a> instance
 
228
</td>
 
229
</tr>
 
230
<tr>
 
231
<td><p><span class="term"><em class="parameter"><code>acct</code></em> :</span></p></td>
 
232
<td>the unique name of an account
 
233
</td>
 
234
</tr>
 
235
<tr>
 
236
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 
237
<td>the setting whose value we want to retrieve
 
238
</td>
 
239
</tr>
 
240
</tbody>
 
241
</table></div>
 
242
</div>
 
243
<hr>
 
244
<div class="refsect2" title="mcp_account_manager_get_unique_name ()">
 
245
<a name="mcp-account-manager-get-unique-name"></a><h3>mcp_account_manager_get_unique_name ()</h3>
 
246
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             mcp_account_manager_get_unique_name (<em class="parameter"><code><a class="link" href="mission-control-plugins-account.html#McpAccountManager"><span class="type">McpAccountManager</span></a> *mcpa</code></em>,
 
247
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *manager</code></em>,
 
248
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *protocol</code></em>,
 
249
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *params</code></em>);</pre>
 
250
<p>
 
251
Generate and return the canonical unique name of this [new] account.
 
252
Should not be called for accounts which have already had a name
 
253
assigned: Intended for use when a plugin encounters an account which
 
254
MC has not previously seen before (ie one created by a 3rd party
 
255
in the back-end that the plugin in question provides an interface to).
 
256
</p>
 
257
<div class="variablelist"><table border="0">
 
258
<col align="left" valign="top">
 
259
<tbody>
 
260
<tr>
 
261
<td><p><span class="term"><em class="parameter"><code>mcpa</code></em> :</span></p></td>
 
262
<td>an <a class="link" href="mission-control-plugins-account.html#McpAccountManager"><span class="type">McpAccountManager</span></a> instance
 
263
</td>
 
264
</tr>
 
265
<tr>
 
266
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
 
267
<td>the name of the manager
 
268
</td>
 
269
</tr>
 
270
<tr>
 
271
<td><p><span class="term"><em class="parameter"><code>protocol</code></em> :</span></p></td>
 
272
<td>the name of the protocol
 
273
</td>
 
274
</tr>
 
275
<tr>
 
276
<td><p><span class="term"><em class="parameter"><code>params</code></em> :</span></p></td>
 
277
<td>A gchar * / GValue * hash table of account parameters.
 
278
</td>
 
279
</tr>
 
280
<tr>
 
281
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
282
<td> the newly allocated account name, which should be freed
 
283
once the caller is done with it.
 
284
</td>
 
285
</tr>
 
286
</tbody>
 
287
</table></div>
 
288
</div>
 
289
</div>
 
290
</div>
 
291
<div class="footer">
 
292
<hr>
 
293
          Generated by GTK-Doc V1.15</div>
 
294
</body>
 
295
</html>
 
 
b'\\ No newline at end of file'