Mercurial > libervia-backend

comparison src/bridge/bridge_constructor/bridge_template.ini @ 371:3ea41a199b36

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
bridge refactoring: categories are now core and plugin instead of communication and request
author Goffi <goffi@goffi.org>
date Wed, 06 Jul 2011 01:04:24 +0200
parents efbfccfed623
children 502489e17685
comparison
equal deleted inserted replaced
370:68cdaf6d78e3 371:3ea41a199b36
4 4
5 ;signals 5 ;signals
6 6
7 [connected] 7 [connected]
8 type=signal 8 type=signal
9 category=communication 9 category=core
10 sig_in=s 10 sig_in=s
11 doc=Connection is done 11 doc=Connection is done
12 doc_param_0=%(doc_profile)s 12 doc_param_0=%(doc_profile)s
13 13
14 [disconnected] 14 [disconnected]
15 type=signal 15 type=signal
16 category=communication 16 category=core
17 sig_in=s 17 sig_in=s
18 doc=Connection is finished or lost 18 doc=Connection is finished or lost
19 doc_param_0=%(doc_profile)s 19 doc_param_0=%(doc_profile)s
20 20
21 [connectionError] 21 [connectionError]
22 type=signal 22 type=signal
23 category=communication 23 category=core
24 sig_in=ss 24 sig_in=ss
25 doc=Something went wront with the connection 25 doc=Something went wront with the connection
26 doc_param_0=error_type: Why the connection got wrong, can be 26 doc_param_0=error_type: Why the connection got wrong, can be
27 - AUTH_ERROR: Authentification error 27 - AUTH_ERROR: Authentification error
28 doc_param_1=%(doc_profile)s 28 doc_param_1=%(doc_profile)s
29 29
30 [newContact] 30 [newContact]
31 type=signal 31 type=signal
32 category=communication 32 category=core
33 sig_in=sa{ss}ass 33 sig_in=sa{ss}ass
34 doc=New contact received in roster 34 doc=New contact received in roster
35 doc_param_0=contact: JID from who the message is comming 35 doc_param_0=contact: JID from who the message is comming
36 doc_param_1=attributes: Dictionary of attributes where keys are: 36 doc_param_1=attributes: Dictionary of attributes where keys are:
37 - name: name of the contact 37 - name: name of the contact
41 doc_param_2=groups: Roster's groups where the contact is 41 doc_param_2=groups: Roster's groups where the contact is
42 doc_param_3=%(doc_profile)s 42 doc_param_3=%(doc_profile)s
43 43
44 [newMessage] 44 [newMessage]
45 type=signal 45 type=signal
46 category=communication 46 category=core
47 sig_in=sssss 47 sig_in=sssss
48 doc=A message has been received 48 doc=A message has been received
49 doc_param_0=from_jid: JID where the message is comming from 49 doc_param_0=from_jid: JID where the message is comming from
50 doc_param_1=message: Message itself 50 doc_param_1=message: Message itself
51 doc_param_2=mess_type: Type of the message (cf RFC 3921 #2.1.1) 51 doc_param_2=mess_type: Type of the message (cf RFC 3921 #2.1.1)
52 doc_param_3=to_jid: JID where the message must be sent 52 doc_param_3=to_jid: JID where the message must be sent
53 doc_param_4=%(doc_profile)s 53 doc_param_4=%(doc_profile)s
54 54
55 [newAlert] 55 [newAlert]
56 type=signal 56 type=signal
57 category=communication 57 category=core
58 sig_in=ssss 58 sig_in=ssss
59 doc=A new alert happened 59 doc=A new alert happened
60 doc_param_0=message: Body of the alert 60 doc_param_0=message: Body of the alert
61 doc_param_1=title: Title of the alert 61 doc_param_1=title: Title of the alert
62 doc_param_2=alert_type: Type of the alert, can be: 62 doc_param_2=alert_type: Type of the alert, can be:
64 - ERROR: something went wrong 64 - ERROR: something went wrong
65 doc_param_3=%(doc_profile)s 65 doc_param_3=%(doc_profile)s
66 66
67 [presenceUpdate] 67 [presenceUpdate]
68 type=signal 68 type=signal
69 category=communication 69 category=core
70 sig_in=ssia{ss}s 70 sig_in=ssia{ss}s
71 doc=Somebody changed his presence informations. 71 doc=Somebody changed his presence informations.
72 doc_param_0=entity: JID from which we have presence informations 72 doc_param_0=entity: JID from which we have presence informations
73 doc_param_1=show: availability status (see RFC 3921 #2.2.2.1) 73 doc_param_1=show: availability status (see RFC 3921 #2.2.2.1)
74 doc_param_2=priority: Priority level of the ressource (see RFC 3921 #2.2.2.3) 74 doc_param_2=priority: Priority level of the ressource (see RFC 3921 #2.2.2.3)
75 doc_param_3=statuses: Natural language description of the availability status (see RFC 3921 #2.2.2.2) 75 doc_param_3=statuses: Natural language description of the availability status (see RFC 3921 #2.2.2.2)
76 doc_param_4=%(doc_profile)s 76 doc_param_4=%(doc_profile)s
77 77
78 [subscribe] 78 [subscribe]
79 type=signal 79 type=signal
80 category=communication 80 category=core
81 sig_in=sss 81 sig_in=sss
82 doc=Somebody wants to be added in roster 82 doc=Somebody wants to be added in roster
83 doc_param_0=sub_type: Subscription states (see RFC 3921 #9) 83 doc_param_0=sub_type: Subscription states (see RFC 3921 #9)
84 doc_param_1=entity: JID from which the subscription is coming 84 doc_param_1=entity: JID from which the subscription is coming
85 doc_param_2=%(doc_profile)s 85 doc_param_2=%(doc_profile)s
86 86
87 [paramUpdate] 87 [paramUpdate]
88 type=signal 88 type=signal
89 category=communication 89 category=core
90 sig_in=ssss 90 sig_in=ssss
91 doc=A parameter has been changed 91 doc=A parameter has been changed
92 doc_param_0=name: Name of the updated parameter 92 doc_param_0=name: Name of the updated parameter
93 doc_param_1=value: New value of the parameter 93 doc_param_1=value: New value of the parameter
94 doc_param_2=category: Category of the updated parameter 94 doc_param_2=category: Category of the updated parameter
95 doc_param_3=%(doc_profile)s 95 doc_param_3=%(doc_profile)s
96 96
97 [contactDeleted] 97 [contactDeleted]
98 type=signal 98 type=signal
99 category=communication 99 category=core
100 sig_in=ss 100 sig_in=ss
101 doc=A contact has been supressed from roster 101 doc=A contact has been supressed from roster
102 doc_param_0=entity: JID of the contact removed from roster 102 doc_param_0=entity: JID of the contact removed from roster
103 doc_param_1=%(doc_profile)s 103 doc_param_1=%(doc_profile)s
104 104
105 [askConfirmation] 105 [askConfirmation]
106 type=signal 106 type=signal
107 category=request 107 category=core
108 sig_in=ssa{ss} 108 sig_in=ssa{ss}
109 doc=A confirmation is needed for an action 109 doc=A confirmation is needed for an action
110 doc_param_0=conf_type: Type of the confirmation, can be: 110 doc_param_0=conf_type: Type of the confirmation, can be:
111 - YES/NO: A question which need a yes or no answer 111 - YES/NO: A question which need a yes or no answer
112 - FILE_TRANSFERT: A confirmation is needed before transfering a file 112 - FILE_TRANSFERT: A confirmation is needed before transfering a file
113 doc_param_1=id: Id of the confirmation query 113 doc_param_1=id: Id of the confirmation query
114 doc_param_2=data: conf_type dependent data 114 doc_param_2=data: conf_type dependent data
115 115
116 [actionResult] 116 [actionResult]
117 type=signal 117 type=signal
118 category=request 118 category=core
119 sig_in=ssa{ss} 119 sig_in=ssa{ss}
120 doc=Requested result of an action 120 doc=Requested result of an action
121 doc_param_0=answer_type: Type of the answer, can be: 121 doc_param_0=answer_type: Type of the answer, can be:
122 - SUPPRESS: The action is managed, the id MUST be removed from queue 122 - SUPPRESS: The action is managed, the id MUST be removed from queue
123 - XMLUI: A SàT XMLUI interface is sent 123 - XMLUI: A SàT XMLUI interface is sent
126 doc_param_1=id: Id of the action 126 doc_param_1=id: Id of the action
127 doc_param_2=data: answer_type specific data 127 doc_param_2=data: answer_type specific data
128 128
129 [actionResultExt] 129 [actionResultExt]
130 type=signal 130 type=signal
131 category=request 131 category=core
132 sig_in=ssa{sa{ss}} 132 sig_in=ssa{sa{ss}}
133 doc=Requested result of an action (Extended) 133 doc=Requested result of an action (Extended)
134 doc_param_0=answer_type: Same as for [actionResult] but with the following additional one: 134 doc_param_0=answer_type: Same as for [actionResult] but with the following additional one:
135 - DICT_DICT: As RESULT, but returned as a dictionary of dictionary 135 - DICT_DICT: As RESULT, but returned as a dictionary of dictionary
136 doc_param_1=id: Id of the action 136 doc_param_1=id: Id of the action
137 doc_param_2=data: answer_type specific data 137 doc_param_2=data: answer_type specific data
138 138
139 [updatedValue] 139 [updatedValue]
140 type=signal 140 type=signal
141 category=request 141 category=core
142 sig_in=sa{ss} 142 sig_in=sa{ss}s
143 doc=A value has been updated 143 doc=A value has been updated
144 doc_param_0=name: Name of the updated value 144 doc_param_0=name: Name of the updated value
145 doc_param_1=value: New value 145 doc_param_1=value: New value
146 doc_param_2=%(doc_profile)s
146 147
147 ;methods 148 ;methods
148 149
149 [getVersion] 150 [getVersion]
150 type=method 151 type=method
151 category=request 152 category=core
152 sig_in= 153 sig_in=
153 sig_out=s 154 sig_out=s
154 doc=Get "Salut à Toi" version 155 doc=Get "Salut à Toi" version
155 156
156 [getProfileName] 157 [getProfileName]
157 type=method 158 type=method
158 category=request 159 category=core
159 sig_in=s 160 sig_in=s
160 sig_out=s 161 sig_out=s
161 param_0_default="@DEFAULT@" 162 param_0_default="@DEFAULT@"
162 doc=Get real profile name from profile key 163 doc=Get real profile name from profile key
163 doc_param_0=%(doc_profile_key)s 164 doc_param_0=%(doc_profile_key)s
164 doc_return=Real profile name, or empty string if the profile doesn't exist 165 doc_return=Real profile name, or empty string if the profile doesn't exist
165 166
166 [getProfilesList] 167 [getProfilesList]
167 type=method 168 type=method
168 category=request 169 category=core
169 sig_in= 170 sig_in=
170 sig_out=as 171 sig_out=as
171 doc=Get all profiles 172 doc=Get all profiles
172 173
173 [createProfile] 174 [createProfile]
174 type=method 175 type=method
175 category=request 176 category=core
176 sig_in=s 177 sig_in=s
177 sig_out=i 178 sig_out=i
178 doc=Create a new profile 179 doc=Create a new profile
179 doc_param_0=%(doc_profile)s 180 doc_param_0=%(doc_profile)s
180 doc_return=status of the creation: 181 doc_return=status of the creation:
181 - 0: Profile created 182 - 0: Profile created
182 - 1: The profile name already exists 183 - 1: The profile name already exists
183 184
184 [deleteProfile] 185 [deleteProfile]
185 type=method 186 type=method
186 category=request 187 category=core
187 sig_in=s 188 sig_in=s
188 sig_out=i 189 sig_out=i
189 doc=Delete a profile 190 doc=Delete a profile
190 doc_param_0=%(doc_profile)s 191 doc_param_0=%(doc_profile)s
191 doc_return=status of the deletion: 192 doc_return=status of the deletion:
193 - 1: The profile doesn't exists 194 - 1: The profile doesn't exists
194 195
195 [registerNewAccount] 196 [registerNewAccount]
196 deprecated= 197 deprecated=
197 type=method 198 type=method
198 category=communication 199 category=core
199 sig_in=ssssi 200 sig_in=ssssi
200 sig_out=s 201 sig_out=s
201 param_4_default=5222 202 param_4_default=5222
202 doc=Register a new account on a given server 203 doc=Register a new account on a given server
203 doc_param_0=login: login of the account 204 doc_param_0=login: login of the account
206 doc_param_3=host: host of the server to register to 207 doc_param_3=host: host of the server to register to
207 doc_param_4=port: port of the server to register to 208 doc_param_4=port: port of the server to register to
208 209
209 [connect] 210 [connect]
210 type=method 211 type=method
211 category=communication 212 category=core
212 sig_in=s 213 sig_in=s
213 sig_out= 214 sig_out=
214 param_0_default="@DEFAULT@" 215 param_0_default="@DEFAULT@"
215 doc=Connect a profile 216 doc=Connect a profile
216 doc_param_0=%(doc_profile_key)s 217 doc_param_0=%(doc_profile_key)s
217 218
218 [asyncConnect] 219 [asyncConnect]
219 async= 220 async=
220 type=method 221 type=method
221 category=communication 222 category=core
222 sig_in=s 223 sig_in=s
223 sig_out= 224 sig_out=
224 param_0_default="@DEFAULT@" 225 param_0_default="@DEFAULT@"
225 doc=Connect a profile 226 doc=Connect a profile
226 doc_param_0=%(doc_profile_key)s 227 doc_param_0=%(doc_profile_key)s
227 228
228 [disconnect] 229 [disconnect]
229 type=method 230 type=method
230 category=communication 231 category=core
231 sig_in=s 232 sig_in=s
232 sig_out= 233 sig_out=
233 param_0_default="@DEFAULT@" 234 param_0_default="@DEFAULT@"
234 doc=Disconnect a profile 235 doc=Disconnect a profile
235 doc_param_0=%(doc_profile_key)s 236 doc_param_0=%(doc_profile_key)s
236 237
237 [isConnected] 238 [isConnected]
238 type=method 239 type=method
239 category=communication 240 category=core
240 sig_in=s 241 sig_in=s
241 sig_out=b 242 sig_out=b
242 param_0_default="@DEFAULT@" 243 param_0_default="@DEFAULT@"
243 doc=Tell if a profile is connected 244 doc=Tell if a profile is connected
244 doc_param_0=%(doc_profile_key)s 245 doc_param_0=%(doc_profile_key)s
245 246
246 [getContacts] 247 [getContacts]
247 type=method 248 type=method
248 category=communication 249 category=core
249 sig_in=s 250 sig_in=s
250 sig_out=a(sa{ss}as) 251 sig_out=a(sa{ss}as)
251 param_0_default="@DEFAULT@" 252 param_0_default="@DEFAULT@"
252 doc=Return informations about all contacts 253 doc=Return informations about all contacts
253 doc_param_0=%(doc_profile_key)s 254 doc_param_0=%(doc_profile_key)s
256 - list of attributes as in [newContact] 257 - list of attributes as in [newContact]
257 - groups where the contact is 258 - groups where the contact is
258 259
259 [getPresenceStatus] 260 [getPresenceStatus]
260 type=method 261 type=method
261 category=communication 262 category=core
262 sig_in=s 263 sig_in=s
263 sig_out=a{sa{s(sia{ss})}} 264 sig_out=a{sa{s(sia{ss})}}
264 param_0_default="@DEFAULT@" 265 param_0_default="@DEFAULT@"
265 doc=Return presence informations of all contacts 266 doc=Return presence informations of all contacts
266 doc_param_0=%(doc_profile_key)s 267 doc_param_0=%(doc_profile_key)s
267 doc_return=Dict of presence with bare JID of contact as key, and value as follow: 268 doc_return=Dict of presence with bare JID of contact as key, and value as follow:
268 A dict where key is the resource and the value is a tuple with (show, priority, statuses) as for [presenceUpdate] 269 A dict where key is the resource and the value is a tuple with (show, priority, statuses) as for [presenceUpdate]
269 270
270 [getWaitingSub] 271 [getWaitingSub]
271 type=method 272 type=method
272 category=communication 273 category=core
273 sig_in=s 274 sig_in=s
274 sig_out=a{ss} 275 sig_out=a{ss}
275 param_0_default="@DEFAULT@" 276 param_0_default="@DEFAULT@"
276 doc=Get subscription requests in queue 277 doc=Get subscription requests in queue
277 doc_param_0=%(doc_profile_key)s 278 doc_param_0=%(doc_profile_key)s
278 doc_return=Dict where contact JID is the key, and value is the subscription type 279 doc_return=Dict where contact JID is the key, and value is the subscription type
279 280
280 [sendMessage] 281 [sendMessage]
281 type=method 282 type=method
282 category=communication 283 category=core
283 sig_in=sssss 284 sig_in=sssss
284 sig_out= 285 sig_out=
285 param_2_default='' 286 param_2_default=''
286 param_3_default="chat" 287 param_3_default="chat"
287 param_4_default="@DEFAULT@" 288 param_4_default="@DEFAULT@"
292 doc_param_3=mess_type: Type of the message (cf RFC 3921 #2.1.1) 293 doc_param_3=mess_type: Type of the message (cf RFC 3921 #2.1.1)
293 doc_param_4=%(doc_profile_key)s 294 doc_param_4=%(doc_profile_key)s
294 295
295 [setPresence] 296 [setPresence]
296 type=method 297 type=method
297 category=communication 298 category=core
298 sig_in=ssia{ss}s 299 sig_in=ssia{ss}s
299 sig_out= 300 sig_out=
300 param_0_default='' 301 param_0_default=''
301 param_1_default='' 302 param_1_default=''
302 param_2_default=0 303 param_2_default=0
309 doc_param_3=statuses: as for [presenceUpdate] 310 doc_param_3=statuses: as for [presenceUpdate]
310 doc_param_4=%(doc_profile_key)s 311 doc_param_4=%(doc_profile_key)s
311 312
312 [subscription] 313 [subscription]
313 type=method 314 type=method
314 category=communication 315 category=core
315 sig_in=sss 316 sig_in=sss
316 sig_out= 317 sig_out=
317 param_2_default="@DEFAULT@" 318 param_2_default="@DEFAULT@"
318 doc=Send subscription request/answer to a contact 319 doc=Send subscription request/answer to a contact
319 doc_param_0=sub_type: as for [subscribe] 320 doc_param_0=sub_type: as for [subscribe]
320 doc_param_1=entity: as for [subscribe] 321 doc_param_1=entity: as for [subscribe]
321 doc_param_2=%(doc_profile_key)s 322 doc_param_2=%(doc_profile_key)s
322 323
323 [getConfig] 324 [getConfig]
324 type=method 325 type=method
325 category=communication 326 category=core
326 sig_in=ss 327 sig_in=ss
327 sig_out=s 328 sig_out=s
328 doc=get main configuration option 329 doc=get main configuration option
329 doc_param_0=section: section of the configuration file (empty string for DEFAULT) 330 doc_param_0=section: section of the configuration file (empty string for DEFAULT)
330 doc_param_1=name: name of the option 331 doc_param_1=name: name of the option
331 332
332 [setParam] 333 [setParam]
333 type=method 334 type=method
334 category=communication 335 category=core
335 sig_in=ssss 336 sig_in=ssss
336 sig_out= 337 sig_out=
337 param_3_default="@DEFAULT@" 338 param_3_default="@DEFAULT@"
338 doc=Change a parameter 339 doc=Change a parameter
339 doc_param_0=name: Name of the parameter to change 340 doc_param_0=name: Name of the parameter to change
341 doc_param_2=category: Category of the parameter to change 342 doc_param_2=category: Category of the parameter to change
342 doc_param_3=%(doc_profile_key)s 343 doc_param_3=%(doc_profile_key)s
343 344
344 [getParamA] 345 [getParamA]
345 type=method 346 type=method
346 category=communication 347 category=core
347 sig_in=ssss 348 sig_in=ssss
348 sig_out=s 349 sig_out=s
349 param_2_default="value" 350 param_2_default="value"
350 param_3_default="@DEFAULT@" 351 param_3_default="@DEFAULT@"
351 doc=Helper method to get a parameter's attribute 352 doc=Helper method to get a parameter's attribute
354 doc_param_2=attribute: Name of the attribute 355 doc_param_2=attribute: Name of the attribute
355 doc_param_3=%(doc_profile_key)s 356 doc_param_3=%(doc_profile_key)s
356 357
357 [getParamsUI] 358 [getParamsUI]
358 type=method 359 type=method
359 category=communication 360 category=core
360 sig_in=s 361 sig_in=s
361 sig_out=s 362 sig_out=s
362 param_0_default="@DEFAULT@" 363 param_0_default="@DEFAULT@"
363 doc=Return a SàT XMLUI for parameters 364 doc=Return a SàT XMLUI for parameters
364 doc_param_0=%(doc_profile_key)s 365 doc_param_0=%(doc_profile_key)s
365 366
366 [getParams] 367 [getParams]
367 type=method 368 type=method
368 category=communication 369 category=core
369 sig_in=s 370 sig_in=s
370 sig_out=s 371 sig_out=s
371 param_0_default="@DEFAULT@" 372 param_0_default="@DEFAULT@"
372 doc=Return XML of parameters 373 doc=Return XML of parameters
373 doc_param_0=%(doc_profile_key)s 374 doc_param_0=%(doc_profile_key)s
374 375
375 [getParamsForCategory] 376 [getParamsForCategory]
376 type=method 377 type=method
377 category=communication 378 category=core
378 sig_in=ss 379 sig_in=ss
379 sig_out=s 380 sig_out=s
380 param_1_default="@DEFAULT@" 381 param_1_default="@DEFAULT@"
381 doc=Return a xml of all params in a category 382 doc=Return a xml of all params in a category
382 doc_param_0=category: Category to get 383 doc_param_0=category: Category to get
383 doc_param_1=%(doc_profile_key)s 384 doc_param_1=%(doc_profile_key)s
384 385
385 [getParamsCategories] 386 [getParamsCategories]
386 type=method 387 type=method
387 category=communication 388 category=core
388 sig_in= 389 sig_in=
389 sig_out=as 390 sig_out=as
390 doc=Get all categories currently existing in parameters 391 doc=Get all categories currently existing in parameters
391 doc_return=list of categories 392 doc_return=list of categories
392 393
393 [getHistory] 394 [getHistory]
394 type=method 395 type=method
395 category=communication 396 category=core
396 sig_in=ssi 397 sig_in=ssi
397 sig_out=a{i(ss)} 398 sig_out=a{i(ss)}
398 doc=Get history of a communication between two entities 399 doc=Get history of a communication between two entities
399 doc_param_0=from_jid: source JID 400 doc_param_0=from_jid: source JID
400 doc_param_1=to_jid: dest JID 401 doc_param_1=to_jid: dest JID
401 doc_param_2=size: size of the history (0 for the whole history) 402 doc_param_2=size: size of the history (0 for the whole history)
402 doc_return=Dict where key is timestamp (seconds this the Epoch), and value is a tuple (from_jid, to_jid) 403 doc_return=Dict where key is timestamp (seconds this the Epoch), and value is a tuple (from_jid, to_jid)
403 404
404 [addContact] 405 [addContact]
405 type=method 406 type=method
406 category=communication 407 category=core
407 sig_in=ss 408 sig_in=ss
408 sig_out= 409 sig_out=
409 param_1_default="@DEFAULT@" 410 param_1_default="@DEFAULT@"
410 doc=Add a contact to profile's roster 411 doc=Add a contact to profile's roster
411 doc_param_0=entity: JID to add to roster 412 doc_param_0=entity: JID to add to roster
412 doc_param_1=%(doc_profile_key)s 413 doc_param_1=%(doc_profile_key)s
413 414
414 [updateContact] 415 [updateContact]
415 type=method 416 type=method
416 category=communication 417 category=core
417 sig_in=ssass 418 sig_in=ssass
418 sig_out= 419 sig_out=
419 param_3_default="@DEFAULT@" 420 param_3_default="@DEFAULT@"
420 doc=update a contact in profile's roster 421 doc=update a contact in profile's roster
421 doc_param_0=entity: JID update in roster 422 doc_param_0=entity: JID update in roster
423 doc_param_2=groups: list of group where the entity is 424 doc_param_2=groups: list of group where the entity is
424 doc_param_3=%(doc_profile_key)s 425 doc_param_3=%(doc_profile_key)s
425 426
426 [delContact] 427 [delContact]
427 type=method 428 type=method
428 category=communication 429 category=core
429 sig_in=ss 430 sig_in=ss
430 sig_out= 431 sig_out=
431 param_1_default="@DEFAULT@" 432 param_1_default="@DEFAULT@"
432 doc=Remove a contact from profile's roster 433 doc=Remove a contact from profile's roster
433 doc_param_0=entity: JID to remove from roster 434 doc_param_0=entity: JID to remove from roster
434 doc_param_1=%(doc_profile_key)s 435 doc_param_1=%(doc_profile_key)s
435 436
436 [launchAction] 437 [launchAction]
437 type=method 438 type=method
438 category=request 439 category=core
439 sig_in=sa{ss}s 440 sig_in=sa{ss}s
440 sig_out=s 441 sig_out=s
441 param_2_default="@DEFAULT@" 442 param_2_default="@DEFAULT@"
442 doc=Launch a specific action 443 doc=Launch a specific action
443 doc_param_0=action_type: type of the action which can be: 444 doc_param_0=action_type: type of the action which can be:
445 doc_param_1=data: action_type dependant data 446 doc_param_1=data: action_type dependant data
446 doc_param_2=%(doc_profile_key)s 447 doc_param_2=%(doc_profile_key)s
447 448
448 [confirmationAnswer] 449 [confirmationAnswer]
449 type=method 450 type=method
450 category=request 451 category=core
451 sig_in=sba{ss} 452 sig_in=sba{ss}
452 sig_out= 453 sig_out=
453 doc=Give answer to a confirmation request 454 doc=Give answer to a confirmation request
454 doc_param_0=id: id of the confirmation request 455 doc_param_0=id: id of the confirmation request
455 doc_param_1=accepted: True if the action is confirmed 456 doc_param_1=accepted: True if the action is confirmed
456 doc_param_2=data: action specific data 457 doc_param_2=data: action specific data
457 458
458 [getProgress] 459 [getProgress]
459 type=method 460 type=method
460 category=request 461 category=core
461 sig_in=s 462 sig_in=s
462 sig_out=a{ss} 463 sig_out=a{ss}
463 doc=Get progress information for an action 464 doc=Get progress information for an action
464 doc_param_0=id: id of the progression status 465 doc_param_0=id: id of the progression status
465 doc_return=dict with progress information: 466 doc_return=dict with progress information:
466 - position: current position 467 - position: current position
467 - size: end position 468 - size: end position
468 469
469 [getMenus] 470 [getMenus]
470 type=method 471 type=method
471 category=request 472 category=core
472 sig_in= 473 sig_in=
473 sig_out=a(sss) 474 sig_out=a(sss)
474 doc=Get all additional menus 475 doc=Get all additional menus
475 doc_return=list of tuple with the following value: 476 doc_return=list of tuple with the following value:
476 - category: Category of the menu 477 - category: Category of the menu
478 - menu_type: Type which can be: 479 - menu_type: Type which can be:
479 * NORMAL: Classical application menu 480 * NORMAL: Classical application menu
480 481
481 [getMenuHelp] 482 [getMenuHelp]
482 type=method 483 type=method
483 category=request 484 category=core
484 sig_in=sss 485 sig_in=sss
485 sig_out=s 486 sig_out=s
486 param_2="NORMAL" 487 param_2="NORMAL"
487 doc=Get help information for a menu 488 doc=Get help information for a menu
488 doc_param_0=category: Category of the menu 489 doc_param_0=category: Category of the menu
490 doc_param_2=menu_type: Type of the menu as in [getMenus] return value 491 doc_param_2=menu_type: Type of the menu as in [getMenus] return value
491 doc_return=Help string 492 doc_return=Help string
492 493
493 [callMenu] 494 [callMenu]
494 type=method 495 type=method
495 category=request 496 category=core
496 sig_in=ssss 497 sig_in=ssss
497 sig_out=s 498 sig_out=s
498 doc=Execute action associated with a menu 499 doc=Execute action associated with a menu
499 doc_param_0=category: as in [getMenuHelp] 500 doc_param_0=category: as in [getMenuHelp]
500 doc_param_1=name: as in [getMenuHelp] 501 doc_param_1=name: as in [getMenuHelp]