summaryrefslogtreecommitdiff
path: root/doc/reference/tmpl/mission-control.sgml
blob: 034ae43331d7f9ecae43c1f76deff0bd4e130cde (plain)
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
314
315
316
<!-- ##### SECTION Title ##### -->
mission-control

<!-- ##### SECTION Short_Description ##### -->
mission-control service API

<!-- ##### SECTION Long_Description ##### -->
<para>

</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### TYPEDEF MissionControl ##### -->
<para>

</para>


<!-- ##### SIGNAL MissionControl::Error ##### -->
<para>

</para>

@missioncontrol: the object which received the signal.
@arg1: 
@arg2: 

<!-- ##### SIGNAL MissionControl::ServiceEnded ##### -->
<para>

</para>

@missioncontrol: the object which received the signal.

<!-- ##### TYPEDEF MissionControlClass ##### -->
<para>

</para>


<!-- ##### ENUM MCError ##### -->
<para>

</para>

@MC_DISCONNECTED_ERROR: 
@MC_INVALID_HANDLE_ERROR: 
@MC_NO_MATCHING_CONNECTION_ERROR: 
@MC_INVALID_ACCOUNT_ERROR: 
@MC_PRESENCE_FAILURE_ERROR: 
@MC_NO_ACCOUNTS_ERROR: 
@MC_NETWORK_ERROR: 
@MC_CONTACT_DOES_NOT_SUPPORT_VOICE_ERROR: 
@MC_LOWMEM_ERROR: 
@MC_CHANNEL_REQUEST_GENERIC_ERROR: 
@MC_CHANNEL_BANNED_ERROR: 
@MC_CHANNEL_FULL_ERROR: 
@MC_CHANNEL_INVITE_ONLY_ERROR: 
@MC_LAST_ERROR: 

<!-- ##### ENUM McPresence ##### -->
<para>

</para>

@MC_PRESENCE_UNSET: 
@MC_PRESENCE_OFFLINE: 
@MC_PRESENCE_AVAILABLE: 
@MC_PRESENCE_AWAY: 
@MC_PRESENCE_EXTENDED_AWAY: 
@MC_PRESENCE_HIDDEN: 
@MC_PRESENCE_DO_NOT_DISTURB: 
@LAST_MC_PRESENCE: 

<!-- ##### ENUM McStatus ##### -->
<para>

</para>

@MC_STATUS_DISCONNECTED: 
@MC_STATUS_CONNECTING: 
@MC_STATUS_CONNECTED: 

<!-- ##### STRUCT McAccountStatus ##### -->
<para>

</para>

@unique_name: 
@status: 
@presence: 
@reason: 

<!-- ##### USER_FUNCTION McCallback ##### -->
<para>
Callback used for reporting errors from various #MissionControl calls.
</para>

@mc: the #MissionControl object.
@error: if set, some error occurred. Must be freed.
@user_data: user data specified when making the call request.


<!-- ##### USER_FUNCTION McGetCurrentStatusCallback ##### -->
<para>
This callback is called in response to the #mission_control_get_current_status call, and carries in its parameters the information on #MissionControl status.
</para>

@mc: the #MissionControl object.
@status: global connection status.
@presence: global presence.
@requested_presence: global requested presence.
@accounts: array of #McAccountStatus structs which hold information about the status (connection and presence) of all enabled accounts. The callback is responsible to free this array by calling #mission_control_free_account_statuses.
@n_accounts: number of accounts in the @accounts array.
@error: if this is not %NULL, then some error occurred and all the status information is invalid. In that case, the callback has to free @error.
@user_data: the user data specified when calling #mission_control_get_current_status.


<!-- ##### STRUCT missioncontrol ##### -->
<para>

</para>

@parent: 
@first_run: 

<!-- ##### STRUCT missioncontrolclass ##### -->
<para>

</para>

@parent_class: 

<!-- ##### FUNCTION mission_control_new ##### -->
<para>

</para>

@connection: 
@Returns: 


<!-- ##### FUNCTION mission_control_set_presence ##### -->
<para>

</para>

@self: 
@presence: 
@message: 
@callback: 
@user_data: 


<!-- ##### FUNCTION mission_control_get_presence ##### -->
<para>

</para>

@self: 
@error: 
@Returns: 


<!-- ##### FUNCTION mission_control_get_presence_actual ##### -->
<para>

</para>

@self: 
@error: 
@Returns: 


<!-- ##### FUNCTION mission_control_request_channel ##### -->
<para>

</para>

@self: 
@account: 
@type: 
@handle: 
@handle_type: 
@callback: 
@user_data: 
@Returns: 


<!-- ##### FUNCTION mission_control_request_channel_with_string_handle ##### -->
<para>

</para>

@self: 
@account: 
@type: 
@handle: 
@handle_type: 
@callback: 
@user_data: 
@Returns: 
<!-- # Unused Parameters # -->
@Handle_type: 


<!-- ##### FUNCTION mission_control_cancel_channel_request ##### -->
<para>

</para>

@self: 
@operation_id: 
@error: 
@Returns: 


<!-- ##### FUNCTION mission_control_connect_all_with_default_presence ##### -->
<para>

</para>

@self: 
@callback: 
@user_data: 


<!-- ##### FUNCTION mission_control_get_connection_status ##### -->
<para>

</para>

@self: 
@account: 
@error: 
@Returns: 


<!-- ##### FUNCTION mission_control_get_online_connections ##### -->
<para>

</para>

@self: 
@error: 
@Returns: 


<!-- ##### FUNCTION mission_control_get_connection ##### -->
<para>

</para>

@self: 
@account: 
@error: 
@Returns: 


<!-- ##### FUNCTION mission_control_get_account_for_connection ##### -->
<para>

</para>

@self: 
@connection: 
@error: 
@Returns: 


<!-- ##### FUNCTION mission_control_get_used_channels_count ##### -->
<para>

</para>

@self: 
@type: 
@error: 
@Returns: 


<!-- ##### FUNCTION mission_control_get_current_status ##### -->
<para>

</para>

@self: 
@callback: 
@user_data: 


<!-- ##### FUNCTION mission_control_free_account_statuses ##### -->
<para>

</para>

@accounts: 


<!-- ##### FUNCTION mission_control_remote_avatar_changed ##### -->
<para>

</para>

@self: 
@connection: 
@contact_id: 
@token: 
@error: 
@Returns: