← 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-request.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-request.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>request</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="ch03.html" title="Channel requests">
 
9
<link rel="prev" href="mission-control-plugins-request-policy.html" title="request-policy">
 
10
<link rel="next" href="ch04.html" title="Channel dispatch operations">
 
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="mission-control-plugins-request-policy.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="ch03.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="ch04.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-request.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#mission-control-plugins-request.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#mission-control-plugins-request.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
                   | 
 
30
                  <a href="#mission-control-plugins-request.prerequisites" class="shortcut">Prerequisites</a>
 
31
</td></tr>
 
32
</table>
 
33
<div class="refentry" title="request">
 
34
<a name="mission-control-plugins-request"></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-request.top_of_page"></a>request</span></h2>
 
38
<p>request</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-request.synopsis"></a><h2>Synopsis</h2>
 
44
<a name="McpRequest"></a><pre class="synopsis">                    <a class="link" href="mission-control-plugins-request.html#McpRequest-struct" title="McpRequest">McpRequest</a>;
 
45
                    <a class="link" href="mission-control-plugins-request.html#McpRequestIface" title="McpRequestIface">McpRequestIface</a>;
 
46
                    <a class="link" href="mission-control-plugins-request.html#McpRequestDelay" title="McpRequestDelay">McpRequestDelay</a>;
 
47
<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-request.html#mcp-request-find-request-by-type" title="mcp_request_find_request_by_type ()">mcp_request_find_request_by_type</a>    (<em class="parameter"><code><a class="link" href="mission-control-plugins-request.html#McpRequest"><span class="type">McpRequest</span></a> *self</code></em>,
 
48
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> start_from</code></em>,
 
49
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> channel_type</code></em>,
 
50
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *ret_index</code></em>,
 
51
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> **ret_ref_requested_properties</code></em>);
 
52
const <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-request.html#mcp-request-get-account-path" title="mcp_request_get_account_path ()">mcp_request_get_account_path</a>        (<em class="parameter"><code><a class="link" href="mission-control-plugins-request.html#McpRequest"><span class="type">McpRequest</span></a> *self</code></em>);
 
53
const <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-request.html#mcp-request-get-protocol" title="mcp_request_get_protocol ()">mcp_request_get_protocol</a>            (<em class="parameter"><code><a class="link" href="mission-control-plugins-request.html#McpRequest"><span class="type">McpRequest</span></a> *self</code></em>);
 
54
const <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-request.html#mcp-request-get-cm-name" title="mcp_request_get_cm_name ()">mcp_request_get_cm_name</a>             (<em class="parameter"><code><a class="link" href="mission-control-plugins-request.html#McpRequest"><span class="type">McpRequest</span></a> *self</code></em>);
 
55
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="returnvalue">gint64</span></a>              <a class="link" href="mission-control-plugins-request.html#mcp-request-get-user-action-time" title="mcp_request_get_user_action_time ()">mcp_request_get_user_action_time</a>    (<em class="parameter"><code><a class="link" href="mission-control-plugins-request.html#McpRequest"><span class="type">McpRequest</span></a> *self</code></em>);
 
56
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="mission-control-plugins-request.html#mcp-request-get-n-requests" title="mcp_request_get_n_requests ()">mcp_request_get_n_requests</a>          (<em class="parameter"><code><a class="link" href="mission-control-plugins-request.html#McpRequest"><span class="type">McpRequest</span></a> *self</code></em>);
 
57
<a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> *        <a class="link" href="mission-control-plugins-request.html#mcp-request-ref-nth-request" title="mcp_request_ref_nth_request ()">mcp_request_ref_nth_request</a>         (<em class="parameter"><code><a class="link" href="mission-control-plugins-request.html#McpRequest"><span class="type">McpRequest</span></a> *self</code></em>,
 
58
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> n</code></em>);
 
59
<span class="returnvalue">void</span>                <a class="link" href="mission-control-plugins-request.html#mcp-request-deny" title="mcp_request_deny ()">mcp_request_deny</a>                    (<em class="parameter"><code><a class="link" href="mission-control-plugins-request.html#McpRequest"><span class="type">McpRequest</span></a> *self</code></em>,
 
60
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> domain</code></em>,
 
61
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> code</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> *message</code></em>);
 
63
</pre>
 
64
</div>
 
65
<div class="refsect1" title="Object Hierarchy">
 
66
<a name="mission-control-plugins-request.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
67
<pre class="synopsis">
 
68
  GInterface
 
69
   +----McpRequest
 
70
</pre>
 
71
</div>
 
72
<div class="refsect1" title="Prerequisites">
 
73
<a name="mission-control-plugins-request.prerequisites"></a><h2>Prerequisites</h2>
 
74
<p>
 
75
McpRequest requires
 
76
 <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p>
 
77
</div>
 
78
<div class="refsect1" title="Description">
 
79
<a name="mission-control-plugins-request.description"></a><h2>Description</h2>
 
80
<p>
 
81
</p>
 
82
</div>
 
83
<div class="refsect1" title="Details">
 
84
<a name="mission-control-plugins-request.details"></a><h2>Details</h2>
 
85
<div class="refsect2" title="McpRequest">
 
86
<a name="McpRequest-struct"></a><h3>McpRequest</h3>
 
87
<pre class="programlisting">typedef struct _McpRequest McpRequest;</pre>
 
88
<p>
 
89
</p>
 
90
</div>
 
91
<hr>
 
92
<div class="refsect2" title="McpRequestIface">
 
93
<a name="McpRequestIface"></a><h3>McpRequestIface</h3>
 
94
<pre class="programlisting">typedef struct _McpRequestIface McpRequestIface;</pre>
 
95
<p>
 
96
</p>
 
97
</div>
 
98
<hr>
 
99
<div class="refsect2" title="McpRequestDelay">
 
100
<a name="McpRequestDelay"></a><h3>McpRequestDelay</h3>
 
101
<pre class="programlisting">typedef struct _McpRequestDelay McpRequestDelay;</pre>
 
102
<p>
 
103
</p>
 
104
</div>
 
105
<hr>
 
106
<div class="refsect2" title="mcp_request_find_request_by_type ()">
 
107
<a name="mcp-request-find-request-by-type"></a><h3>mcp_request_find_request_by_type ()</h3>
 
108
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            mcp_request_find_request_by_type    (<em class="parameter"><code><a class="link" href="mission-control-plugins-request.html#McpRequest"><span class="type">McpRequest</span></a> *self</code></em>,
 
109
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> start_from</code></em>,
 
110
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> channel_type</code></em>,
 
111
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *ret_index</code></em>,
 
112
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> **ret_ref_requested_properties</code></em>);</pre>
 
113
<p>
 
114
</p>
 
115
<div class="variablelist"><table border="0">
 
116
<col align="left" valign="top">
 
117
<tbody>
 
118
<tr>
 
119
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 
120
<td>
 
121
</td>
 
122
</tr>
 
123
<tr>
 
124
<td><p><span class="term"><em class="parameter"><code>start_from</code></em> :</span></p></td>
 
125
<td>
 
126
</td>
 
127
</tr>
 
128
<tr>
 
129
<td><p><span class="term"><em class="parameter"><code>channel_type</code></em> :</span></p></td>
 
130
<td>
 
131
</td>
 
132
</tr>
 
133
<tr>
 
134
<td><p><span class="term"><em class="parameter"><code>ret_index</code></em> :</span></p></td>
 
135
<td>
 
136
</td>
 
137
</tr>
 
138
<tr>
 
139
<td><p><span class="term"><em class="parameter"><code>ret_ref_requested_properties</code></em> :</span></p></td>
 
140
<td>
 
141
</td>
 
142
</tr>
 
143
<tr>
 
144
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
145
<td>
 
146
</td>
 
147
</tr>
 
148
</tbody>
 
149
</table></div>
 
150
</div>
 
151
<hr>
 
152
<div class="refsect2" title="mcp_request_get_account_path ()">
 
153
<a name="mcp-request-get-account-path"></a><h3>mcp_request_get_account_path ()</h3>
 
154
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       mcp_request_get_account_path        (<em class="parameter"><code><a class="link" href="mission-control-plugins-request.html#McpRequest"><span class="type">McpRequest</span></a> *self</code></em>);</pre>
 
155
<p>
 
156
</p>
 
157
<div class="variablelist"><table border="0">
 
158
<col align="left" valign="top">
 
159
<tbody>
 
160
<tr>
 
161
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 
162
<td>
 
163
</td>
 
164
</tr>
 
165
<tr>
 
166
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
167
<td>
 
168
</td>
 
169
</tr>
 
170
</tbody>
 
171
</table></div>
 
172
</div>
 
173
<hr>
 
174
<div class="refsect2" title="mcp_request_get_protocol ()">
 
175
<a name="mcp-request-get-protocol"></a><h3>mcp_request_get_protocol ()</h3>
 
176
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       mcp_request_get_protocol            (<em class="parameter"><code><a class="link" href="mission-control-plugins-request.html#McpRequest"><span class="type">McpRequest</span></a> *self</code></em>);</pre>
 
177
<p>
 
178
</p>
 
179
<div class="variablelist"><table border="0">
 
180
<col align="left" valign="top">
 
181
<tbody>
 
182
<tr>
 
183
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 
184
<td>
 
185
</td>
 
186
</tr>
 
187
<tr>
 
188
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
189
<td>
 
190
</td>
 
191
</tr>
 
192
</tbody>
 
193
</table></div>
 
194
</div>
 
195
<hr>
 
196
<div class="refsect2" title="mcp_request_get_cm_name ()">
 
197
<a name="mcp-request-get-cm-name"></a><h3>mcp_request_get_cm_name ()</h3>
 
198
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       mcp_request_get_cm_name             (<em class="parameter"><code><a class="link" href="mission-control-plugins-request.html#McpRequest"><span class="type">McpRequest</span></a> *self</code></em>);</pre>
 
199
<p>
 
200
</p>
 
201
<div class="variablelist"><table border="0">
 
202
<col align="left" valign="top">
 
203
<tbody>
 
204
<tr>
 
205
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 
206
<td>
 
207
</td>
 
208
</tr>
 
209
<tr>
 
210
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
211
<td>
 
212
</td>
 
213
</tr>
 
214
</tbody>
 
215
</table></div>
 
216
</div>
 
217
<hr>
 
218
<div class="refsect2" title="mcp_request_get_user_action_time ()">
 
219
<a name="mcp-request-get-user-action-time"></a><h3>mcp_request_get_user_action_time ()</h3>
 
220
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="returnvalue">gint64</span></a>              mcp_request_get_user_action_time    (<em class="parameter"><code><a class="link" href="mission-control-plugins-request.html#McpRequest"><span class="type">McpRequest</span></a> *self</code></em>);</pre>
 
221
<p>
 
222
</p>
 
223
<div class="variablelist"><table border="0">
 
224
<col align="left" valign="top">
 
225
<tbody>
 
226
<tr>
 
227
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 
228
<td>
 
229
</td>
 
230
</tr>
 
231
<tr>
 
232
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
233
<td>
 
234
</td>
 
235
</tr>
 
236
</tbody>
 
237
</table></div>
 
238
</div>
 
239
<hr>
 
240
<div class="refsect2" title="mcp_request_get_n_requests ()">
 
241
<a name="mcp-request-get-n-requests"></a><h3>mcp_request_get_n_requests ()</h3>
 
242
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               mcp_request_get_n_requests          (<em class="parameter"><code><a class="link" href="mission-control-plugins-request.html#McpRequest"><span class="type">McpRequest</span></a> *self</code></em>);</pre>
 
243
<p>
 
244
</p>
 
245
<div class="variablelist"><table border="0">
 
246
<col align="left" valign="top">
 
247
<tbody>
 
248
<tr>
 
249
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 
250
<td>
 
251
</td>
 
252
</tr>
 
253
<tr>
 
254
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
255
<td>
 
256
</td>
 
257
</tr>
 
258
</tbody>
 
259
</table></div>
 
260
</div>
 
261
<hr>
 
262
<div class="refsect2" title="mcp_request_ref_nth_request ()">
 
263
<a name="mcp-request-ref-nth-request"></a><h3>mcp_request_ref_nth_request ()</h3>
 
264
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> *        mcp_request_ref_nth_request         (<em class="parameter"><code><a class="link" href="mission-control-plugins-request.html#McpRequest"><span class="type">McpRequest</span></a> *self</code></em>,
 
265
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> n</code></em>);</pre>
 
266
<p>
 
267
</p>
 
268
<div class="variablelist"><table border="0">
 
269
<col align="left" valign="top">
 
270
<tbody>
 
271
<tr>
 
272
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 
273
<td>
 
274
</td>
 
275
</tr>
 
276
<tr>
 
277
<td><p><span class="term"><em class="parameter"><code>n</code></em> :</span></p></td>
 
278
<td>
 
279
</td>
 
280
</tr>
 
281
<tr>
 
282
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
283
<td>
 
284
</td>
 
285
</tr>
 
286
</tbody>
 
287
</table></div>
 
288
</div>
 
289
<hr>
 
290
<div class="refsect2" title="mcp_request_deny ()">
 
291
<a name="mcp-request-deny"></a><h3>mcp_request_deny ()</h3>
 
292
<pre class="programlisting"><span class="returnvalue">void</span>                mcp_request_deny                    (<em class="parameter"><code><a class="link" href="mission-control-plugins-request.html#McpRequest"><span class="type">McpRequest</span></a> *self</code></em>,
 
293
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> domain</code></em>,
 
294
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> code</code></em>,
 
295
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *message</code></em>);</pre>
 
296
<p>
 
297
</p>
 
298
<div class="variablelist"><table border="0">
 
299
<col align="left" valign="top">
 
300
<tbody>
 
301
<tr>
 
302
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 
303
<td>
 
304
</td>
 
305
</tr>
 
306
<tr>
 
307
<td><p><span class="term"><em class="parameter"><code>domain</code></em> :</span></p></td>
 
308
<td>
 
309
</td>
 
310
</tr>
 
311
<tr>
 
312
<td><p><span class="term"><em class="parameter"><code>code</code></em> :</span></p></td>
 
313
<td>
 
314
</td>
 
315
</tr>
 
316
<tr>
 
317
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
 
318
<td>
 
319
</td>
 
320
</tr>
 
321
</tbody>
 
322
</table></div>
 
323
</div>
 
324
</div>
 
325
</div>
 
326
<div class="footer">
 
327
<hr>
 
328
          Generated by GTK-Doc V1.15</div>
 
329
</body>
 
330
</html>
 
 
b'\\ No newline at end of file'