Mercurial > libervia-backend

comparison src/bridge/bridge_constructor/bridge_template.ini @ 267:bdcd535e179e

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