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
|
<html>
<head>
<title>MissionControl</title>
<style type="text/css">
.interface:before {
content: "Interface ";
}
.interface {
margin-top: 1em;
margin-bottom: 1em;
padding-left: 1em;
font-size: 1.6em;
background: #ccf;
}
.methods:before {
content: "Methods";
font-size: 1.5em;
margin-top: 1em;
margin-bottom: 1em;
padding-left: 1em;
background: #ccf;
display: block;
}
.signals:before {
content: "Signals";
font-size: 1.5em;
margin-top: 1em;
margin-bottom: 1em;
padding-left: 1em;
background: #ccf;
display: block;
}
.method H3, .signal H3 {
margin-top: 1em;
margin-bottom: 1em;
padding-left: 1em;
font-size: 1.3em;
background: #ccf;
}
.parameters:before {
content: "Parameters:";
display: block;
padding-bottom: 0.5em;
}
.parameters, .return {
padding: 1em;
}
.return:before {
content: "Return value(s):";
display: block;
padding-bottom: 0.5em;
}
.enum {
display: block;
font-family: monospace;
padding-left: 1cm;
}
.enum P {
padding: 0;
margin: 0;
padding-left: 1em;
font-family: serif;
}
</style>
</head>
<body>
<h1>Mission Control specifications</h1>
<div class="interface">com.nokia.chavo.mission_control</div>
<p>This is the DBus interface used by mission-control.
<div class="methods">
<div class="method">
<h3>SetPresence ( i: presence, s: message ) -> None </h3>
<p>Request a presence
<div class="parameters">
presence - any of the following values:
<div class="enum">
0 - MC_PRESENCE_UNSET<br>
1 - MC_PRESENCE_OFFLINE<br>
2 - MC_PRESENCE_AVAILABLE<br>
3 - MC_PRESENCE_AWAY<br>
4 - MC_PRESENCE_EXTENDED_AWAY<br>
5 - MC_PRESENCE_HIDDEN<br>
6 - MC_PRESENCE_DO_NOT_DISTURB<br>
</div>
message - NULL or a message string to specify along with the presence (typically with away presence).
</div>
</div>
<div class="method">
<h3>GetPresence ( ) -> i </h3>
<p>Get the last requested presence.
</div>
<div class="method">
<h3>GetPresenceActual ( ) -> i </h3>
<p>Get the current presence (which could be different from the last requested presence).
</div>
<div class="method">
<h3>RequestChannel ( s: account_name, s: type, u: handle, i: handle_type ) -> None </h3>
<p>Request a channel for a given numeric handle.</p>
<div class="parameters">
account_name - the name of the account requesting the channel<br>
type - a D-Bus interface name representing base channel type<br>
handle - an integer handle representing a contact, room or list<br>
handle_type - an integer representing the handle type<br>
</div>
</div>
<div class="method">
<h3>RequestChannelWithStringHandle ( s: account_name, s: type, s: handle, i: handle_type ) -> None </h3>
<p>Request a channel for a given string handle.</p>
<div class="parameters">
account_name - the name of the account requesting the channel<br>
type - a D-Bus interface name representing base channel type<br>
handle - a string representing a contact, room or list<br>
handle_type - an integer representing the handle type<br>
</div>
</div>
<div class="method">
<h3>CancelChannelRequest ( u: operation_id ) -> None </h3>
<p>Cancel a channel request; if the channel has already been created, it will be destroyed.</p>
<div class="parameters">
operation_id - the unique id of the channel request operation. (<em>this is the <code>serial</code> parameter of the RequestChannelWithStringHandle call — specs are going to change soon, though</em>)<br>
</div>
</div>
<div class="method">
<h3>ConnectAllWithDefaultPresence ( ) -> None </h3>
<p>Connect all accounts with the default online presence.
</div>
<div class="method">
<h3>GetConnectionStatus ( s: account_name ) -> u </h3>
<p>Get the connection status for the specified account.</p>
<div class="parameters">
account_name - the account to retrieve the status from<br>
</div>
<div class="return">
A unsigned integer as defined in Telepathy:
<div class="enum">
0 - CONNECTION_STATUS_CONNECTED<br>
1 - CONNECTION_STATUS_CONNECTING<br>
2 - CONNECTION_STATUS_DISCONNECTED<br>
</div>
</div>
</div>
<div class="method">
<h3>GetOnlineConnections ( ) -> as </h3>
<p>Get the online connections.</p>
<div class="return">
An array of the names of the online accounts.
</div>
</div>
<div class="method">
<h3>GetConnection ( s: account_name ) -> s, o </h3>
<p>Get the connection status for the specified account.</p>
<div class="parameters">
account_name - the account to retrieve the connection from<br>
</div>
<div class="return">
s: the connection bus name<br>
o: the connection object path
</div>
</div>
<div class="method">
<h3>GetAccountForConnection ( s: object_path ) -> s </h3>
<p>Get the connection's account.</p>
<div class="parameters">
object_path - the connection's object path<br>
</div>
<div class="return">
s: the account name<br>
</div>
</div>
<div class="method">
<h3>GetUsedChannelsCount ( s: type ) -> u </h3>
<p>Get the number of channels of the specified type.</p>
<div class="parameters">
type - the channel type<br>
</div>
<div class="return">
u: the number of existing channels of this type<br>
</div>
</div>
</div>
<div class="signals">
<div class="signal">
<h3>AccountStatusChanged ( u: status, u: presence, u: reason, s: account_id )</h3>
<p>Emitted when the status of some account changes.
<div class="parameters">
status - the connection status of the account<br>
presence - the presence status of the account</br>
reason - the reason why the status change happened. Can be any of the following:
<div class="enum">
0 - TP_CONN_STATUS_REASON_NONE_SPECIFIED<br>
1 - TP_CONN_STATUS_REASON_REQUESTED<br>
2 - TP_CONN_STATUS_REASON_NETWORK_ERROR<br>
3 - TP_CONN_STATUS_REASON_AUTHENTICATION_FAILED<br>
4 - TP_CONN_STATUS_REASON_ENCRYPTION_ERROR<br>
5 - TP_CONN_STATUS_REASON_NAME_IN_USE<br>
6 - TP_CONN_STATUS_REASON_CERT_NOT_PROVIDED<br>
7 - TP_CONN_STATUS_REASON_CERT_UNTRUSTED<br>
8 - TP_CONN_STATUS_REASON_CERT_EXPIRED<br>
9 - TP_CONN_STATUS_REASON_CERT_NOT_ACTIVATED<br>
10 - TP_CONN_STATUS_REASON_CERT_HOSTNAME_MISMATCH<br>
11 - TP_CONN_STATUS_REASON_CERT_FINGERPRINT_MISMATCH<br>
12 - TP_CONN_STATUS_REASON_CERT_SELF_SIGNED<br>
13 - TP_CONN_STATUS_REASON_CERT_OTHER_ERROR
</div>
account_id - the account whose status has changed
</div>
</div>
<div class="signal">
<h3>McdError ( u: serial, s: client_id, u: error_id )</h3>
<p>Emitted on some error.
<div class="parameters">
serial - <em>operation ID, maybe it will get removed from the specs soon</em><br>
client_id - the d-bus unique name of the client whose this error is meant to</br>
error_id - the error code:
<div class="enum">
0 - MC_DISCONNECTED_ERROR<br>
1 - MC_INVALID_HANDLE_ERROR<br>
2 - MC_NO_MATCHING_CONNECTION_ERROR<br>
3 - MC_INVALID_ACCOUNT_ERROR<br>
4 - MC_PRESENCE_FAILURE_ERROR<br>
5 - MC_NO_ACCOUNTS_ERROR<br>
6 - MC_NETWORK_ERROR<br>
7 - MC_CONTACT_DOES_NOT_SUPPORT_VOICE_ERROR<br>
8 - MC_LOWMEM_ERROR<br>
9 - MC_CHANNEL_REQUEST_GENERIC_ERROR<br>
10 - MC_CHANNEL_BANNED_ERROR<br>
11 - MC_CHANNEL_FULL_ERROR<br>
12 - MC_CHANNEL_INVITE_ONLY_ERROR<br>
13 - MC_LAST_ERROR
</div>
</div>
</div>
<div class="signal">
<h3>PresenceStatusRequested ( u: presence )</h3>
<p>Emitted when a presence has been requested.
<div class="parameters">
presence - the requested presence.
</div>
</div>
<div class="signal">
<h3>PresenceStatusActual ( u: presence )</h3>
<p>Emitted when the actual presence changes.
<div class="parameters">
presence - the actual presence.
</div>
</div>
<div class="signal">
<h3>UsedChannelsCountChanged ( s: type, u: count )</h3>
<p>Emitted when the actual presence changes.
<div class="parameters">
type - the type of the channels<br>
count - the new number of the channels of this type
</div>
</div>
<div class="signal">
<h3>StatusActual ( u: status, u: presence )</h3>
<p>Emitted when the accounts' status changes.
<div class="parameters">
status - Can be one of these values:<br>
<div class="enum">
0 - MC_STATUS_DISCONNECTED
<p>When all accounts are disconnected.</p>
1 - MC_STATUS_CONNECTING
<p>When at least one account is connecting.</p>
2 - MC_STATUS_CONNECTED
<p>When at least one account is connected <em>and</em> none is connecting.</p>
</div>
presence - the last requested presence.
</div>
</div>
</div>
</body>
</html>
|
