Mercurial > libervia-backend

comparison sat/bridge/bridge_constructor/bridge_template.ini @ 2562:26edcf3a30eb

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
core, setup: huge cleaning: - moved directories from src and frontends/src to sat and sat_frontends, which is the recommanded naming convention - move twisted directory to root - removed all hacks from setup.py, and added missing dependencies, it is now clean - use https URL for website in setup.py - removed "Environment :: X11 Applications :: GTK", as wix is deprecated and removed - renamed sat.sh to sat and fixed its installation - added python_requires to specify Python version needed - replaced glib2reactor which use deprecated code by gtk3reactor sat can now be installed directly from virtualenv without using --system-site-packages anymore \o/
author Goffi <goffi@goffi.org>
date Mon, 02 Apr 2018 19:44:50 +0200
parents src/bridge/bridge_constructor/bridge_template.ini@27539029a662
children 973d4551ffae
comparison
equal deleted inserted replaced
2561:bd30dc3ffe5a 2562:26edcf3a30eb
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 doc_security_limit=security_limit: -1 means no security, 0 is the maximum security then the higher the less secure
5
6 ;signals
7
8 [connected]
9 type=signal
10 category=core
11 sig_in=ss
12 doc=Connection is done
13 doc_param_0=%(doc_profile)s
14 doc_param_1=jid_s: the JID that we were assigned by the server, as the resource might differ from the JID we asked for.
15
16 [disconnected]
17 type=signal
18 category=core
19 sig_in=s
20 doc=Connection is finished or lost
21 doc_param_0=%(doc_profile)s
22
23 [newContact]
24 type=signal
25 category=core
26 sig_in=sa{ss}ass
27 doc=New contact received in roster
28 doc_param_0=contact_jid: JID which has just been added
29 doc_param_1=attributes: Dictionary of attributes where keys are:
30 - name: name of the contact
31 - to: "True" if the contact give its presence information to us
32 - from: "True" if contact is registred to our presence information
33 - ask: "True" is subscription is pending
34 doc_param_2=groups: Roster's groups where the contact is
35 doc_param_3=%(doc_profile)s
36
37 [messageNew]
38 type=signal
39 category=core
40 sig_in=sdssa{ss}a{ss}sa{ss}s
41 doc=A message has been received
42 doc_param_0=uid: unique ID of the message (id specific to SàT, this it *NOT* an XMPP id)
43 doc_param_1=timestamp: when the message was sent (or declared sent for delayed messages)
44 doc_param_2=from_jid: JID where the message is comming from
45 doc_param_3=to_jid: JID where the message must be sent
46 doc_param_4=message: message itself, can be in several languages (key is language code or '' for default)
47 doc_param_5=subject: subject of the message, can be in several languages (key is language code or '' for default)
48 doc_param_6=mess_type: Type of the message (cf RFC 6121 §5.2.2) + C.MESS_TYPE_INFO (system info)
49 doc_param_7=extra: extra message information, can have data added by plugins and/or:
50 - thread: id of the thread
51 - thread_parent: id of the parent of the current thread
52 - received_timestamp: date of receiption for delayed messages
53 - delay_sender: entity which has originally sent or which has delayed the message
54 - info_type: subtype for info messages
55 doc_param_8=%(doc_profile)s
56
57 [presenceUpdate]
58 type=signal
59 category=core
60 sig_in=ssia{ss}s
61 doc=Somebody changed his presence information.
62 doc_param_0=entity_jid: JID from which we have presence informatios
63 doc_param_1=show: availability status (see RFC 6121 §4.7.2.1)
64 doc_param_2=priority: Priority level of the ressource (see RFC 6121 §4.7.2.3)
65 doc_param_3=statuses: Natural language description of the availability status (see RFC 6121 §4.7.2.2)
66 doc_param_4=%(doc_profile)s
67
68 [subscribe]
69 type=signal
70 category=core
71 sig_in=sss
72 doc=Somebody wants to be added in roster
73 doc_param_0=sub_type: Subscription states (see RFC 6121 §3)
74 doc_param_1=entity_jid: JID from which the subscription is coming
75 doc_param_2=%(doc_profile)s
76
77 [paramUpdate]
78 type=signal
79 category=core
80 sig_in=ssss
81 doc=A parameter has been changed
82 doc_param_0=name: Name of the updated parameter
83 doc_param_1=value: New value of the parameter
84 doc_param_2=category: Category of the updated parameter
85 doc_param_3=%(doc_profile)s
86
87 [contactDeleted]
88 type=signal
89 category=core
90 sig_in=ss
91 doc=A contact has been supressed from roster
92 doc_param_0=entity_jid: JID of the contact removed from roster
93 doc_param_1=%(doc_profile)s
94
95 [actionNew]
96 type=signal
97 category=core
98 sig_in=a{ss}sis
99 doc=A frontend action is requested
100 doc_param_0=action_data: a dict where key can be:
101 - xmlui: a XMLUI need to be displayed
102 - progress: a progress id
103 - meta_*: meta information on the action, used to make automation more easy,
104 some are defined below
105 - meta_from_jid: origin of the request
106 - meta_type: type of the request, can be one of:
107 - C.META_TYPE_FILE: a file transfer request validation
108 - C.META_TYPE_OVERWRITE: a file overwriting confirmation
109 - meta_progress_id: progress id linked to this action
110 doc_param_1=id: action id
111 This id can be used later by frontends to announce to other ones that the action is managed and can now be ignored.
112 doc_param_2=%(doc_security_limit)s
113 doc_param_3=%(doc_profile)s
114
115 [entityDataUpdated]
116 type=signal
117 category=core
118 sig_in=ssss
119 doc=An entity's data has been updated
120 doc_param_0=jid: entity's bare jid
121 doc_param_1=name: Name of the updated value
122 doc_param_2=value: New value
123 doc_param_3=%(doc_profile)s
124
125 [progressStarted]
126 type=signal
127 category=core
128 sig_in=sa{ss}s
129 doc=A progressing operation has just started
130 doc_param_0=id: id of the progression operation
131 doc_param_1=metadata: dict of progress metadata, key can be:
132 - name: name of the progression, full path for a file
133 - direction: "in" for incoming data, "out" else
134 - type: type of the progression:
135 C.META_TYPE_FILE: file transfer
136 doc_param_2=%(doc_profile)s
137
138 [progressFinished]
139 type=signal
140 category=core
141 sig_in=sa{ss}s
142 doc=A progressing operation is finished
143 doc_param_0=id: id of the progression operation
144 doc_param_1=metadata: dict of progress status metadata, key can be:
145 - hash: value of the computed hash
146 - hash_algo: alrorithm used to compute hash
147 - hash_verified: C.BOOL_TRUE if hash is verified and OK
148 C.BOOL_FALSE if hash was not received ([progressError] will be used if there is a mismatch)
149 - url: url linked to the progression (e.g. download url after a file upload)
150 doc_param_2=%(doc_profile)s
151
152 [progressError]
153 type=signal
154 category=core
155 sig_in=sss
156 doc=There was an error during progressing operation
157 doc_param_0=id: id of the progression operation
158 doc_param_1=error: error message
159 doc_param_2=%(doc_profile)s
160
161 ;methods
162
163 [getReady]
164 async=
165 type=method
166 category=core
167 sig_in=
168 sig_out=
169 doc=Return when backend is initialised
170
171 [getVersion]
172 type=method
173 category=core
174 sig_in=
175 sig_out=s
176 doc=Get "Salut à Toi" full version
177
178 [getFeatures]
179 type=method
180 category=core
181 sig_in=s
182 sig_out=a{sa{ss}}
183 doc=Get available features and plugins
184 features can changes for differents profiles, e.g. because of differents server capabilities
185 doc_param_0=%(doc_profile_key)s
186 doc_return=dictionary of available features:
187 plugin import name is used as key, data is an other dict managed by the plugin
188 async=
189
190 [profileNameGet]
191 type=method
192 category=core
193 sig_in=s
194 sig_out=s
195 param_0_default="@DEFAULT@"
196 doc=Get real profile name from profile key
197 doc_param_0=%(doc_profile_key)s
198 doc_return=Real profile name
199
200 [profilesListGet]
201 type=method
202 category=core
203 sig_in=bb
204 sig_out=as
205 param_0_default=True
206 param_1_default=False
207 doc_param_0=clients: get clients profiles
208 doc_param_1=components: get components profiles
209 doc=Get list of profiles
210
211 [profileSetDefault]
212 type=method
213 category=core
214 sig_in=s
215 sig_out=
216 doc_param_0=%(doc_profile)s
217 doc=Set default profile
218
219 [getEntityData]
220 type=method
221 category=core
222 sig_in=sass
223 sig_out=a{ss}
224 doc=Get data in cache for an entity
225 doc_param_0=jid: entity's bare jid
226 doc_param_1=keys: list of keys to get
227 doc_param_2=%(doc_profile)s
228 doc_return=dictionary of asked key,
229 if key doesn't exist, the resulting dictionary will not have the key
230
231 [getEntitiesData]
232 type=method
233 category=core
234 sig_in=asass
235 sig_out=a{sa{ss}}
236 doc=Get data in cache for several entities at once
237 doc_param_0=jids: list of entities bare jid, or empty list to have all jids in cache
238 doc_param_1=keys: list of keys to get
239 doc_param_2=%(doc_profile)s
240 doc_return=dictionary with jids as keys and dictionary of asked key as values
241 if key doesn't exist for a jid, the resulting dictionary will not have it
242
243 [profileCreate]
244 async=
245 type=method
246 category=core
247 sig_in=sss
248 sig_out=
249 param_1_default=''
250 param_2_default=''
251 doc=Create a new profile
252 doc_param_0=%(doc_profile)s
253 doc_param_1=password: password of the profile
254 doc_param_2=component: set to component entry point if it is a component, else use empty string
255 doc_return=callback is called when profile actually exists in database and memory
256 errback is called with error constant as parameter:
257 - ConflictError: the profile name already exists
258 - CancelError: profile creation canceled
259 - NotFound: component entry point is not available
260
261 [asyncDeleteProfile]
262 async=
263 type=method
264 category=core
265 sig_in=s
266 sig_out=
267 doc=Delete a profile
268 doc_param_0=%(doc_profile)s
269 doc_return=callback is called when profile has been deleted from database and memory
270 errback is called with error constant as parameter:
271 - ProfileUnknownError: the profile name is unknown
272 - ConnectedProfileError: a connected profile would not be deleted
273
274 [connect]
275 async=
276 type=method
277 category=core
278 sig_in=ssa{ss}
279 sig_out=b
280 param_0_default="@DEFAULT@"
281 param_1_default=''
282 param_2_default={}
283 doc=Connect a profile
284 doc_param_0=%(doc_profile_key)s
285 doc_param_1=password: the SàT profile password
286 doc_param_2=options: connection options
287 doc_return=a deferred boolean or failure:
288 - boolean if the profile authentication succeed:
289 - True if the XMPP connection was already established
290 - False if the XMPP connection has been initiated (it may still fail)
291 - failure if the profile authentication failed
292
293 [profileStartSession]
294 async=
295 type=method
296 category=core
297 sig_in=ss
298 sig_out=b
299 param_0_default=''
300 param_1_default="@DEFAULT@"
301 doc=Start a profile session without connecting it (if it's not already the case)
302 doc_param_0=password: the SàT profile password
303 doc_param_1=%(doc_profile_key)s
304 doc_return=D(bool):
305 - True if the profile session was already started
306 - False else
307
308 [profileIsSessionStarted]
309 type=method
310 category=core
311 sig_in=s
312 sig_out=b
313 param_0_default="@DEFAULT@"
314 doc=Tell if a profile session is loaded
315 doc_param_0=%(doc_profile_key)s
316
317 [disconnect]
318 async=
319 type=method
320 category=core
321 sig_in=s
322 sig_out=
323 param_0_default="@DEFAULT@"
324 doc=Disconnect a profile
325 doc_param_0=%(doc_profile_key)s
326
327 [isConnected]
328 type=method
329 category=core
330 sig_in=s
331 sig_out=b
332 param_0_default="@DEFAULT@"
333 doc=Tell if a profile is connected
334 doc_param_0=%(doc_profile_key)s
335
336 [getContacts]
337 async=
338 type=method
339 category=core
340 sig_in=s
341 sig_out=a(sa{ss}as)
342 param_0_default="@DEFAULT@"
343 doc=Return information about all contacts (the roster)
344 doc_param_0=%(doc_profile_key)s
345 doc_return=array of tuples with the following values:
346 - JID of the contact
347 - list of attributes as in [newContact]
348 - groups where the contact is
349
350 [getContactsFromGroup]
351 type=method
352 category=core
353 sig_in=ss
354 sig_out=as
355 param_1_default="@DEFAULT@"
356 doc=Return information about all contacts
357 doc_param_0=group: name of the group to check
358 doc_param_1=%(doc_profile_key)s
359 doc_return=array of jids
360
361 [getMainResource]
362 type=method
363 category=core
364 sig_in=ss
365 sig_out=s
366 param_1_default="@DEFAULT@"
367 doc=Return the last resource connected for a contact
368 doc_param_0=contact_jid: jid of the contact
369 doc_param_1=%(doc_profile_key)s
370 doc_return=the resource connected of the contact with highest priority, or ""
371
372 [getPresenceStatuses]
373 type=method
374 category=core
375 sig_in=s
376 sig_out=a{sa{s(sia{ss})}}
377 param_0_default="@DEFAULT@"
378 doc=Return presence information of all contacts
379 doc_param_0=%(doc_profile_key)s
380 doc_return=Dict of presence with bare JID of contact as key, and value as follow:
381 A dict where key is the resource and the value is a tuple with (show, priority, statuses) as for [presenceUpdate]
382
383 [getWaitingSub]
384 type=method
385 category=core
386 sig_in=s
387 sig_out=a{ss}
388 param_0_default="@DEFAULT@"
389 doc=Get subscription requests in queue
390 doc_param_0=%(doc_profile_key)s
391 doc_return=Dict where contact JID is the key, and value is the subscription type
392
393 [messageSend]
394 async=
395 type=method
396 category=core
397 sig_in=sa{ss}a{ss}sa{ss}s
398 sig_out=
399 param_2_default={}
400 param_3_default="auto"
401 param_4_default={}
402 param_5_default="@NONE@"
403 doc=Send a message
404 doc_param_0=to_jid: JID of the recipient
405 doc_param_1=message: body of the message:
406 key is the language of the body, use '' when unknown
407 doc_param_2=subject: Subject of the message
408 key is the language of the subject, use '' when unknown
409 doc_param_3=mess_type: Type of the message (cf RFC 6121 §5.2.2) or "auto" for automatic type detection
410 doc_param_4=extra: optional data that can be used by a plugin to build more specific messages
411 doc_param_5=%(doc_profile_key)s
412
413 [setPresence]
414 type=method
415 category=core
416 sig_in=ssa{ss}s
417 sig_out=
418 param_0_default=''
419 param_1_default=''
420 param_2_default={}
421 param_3_default="@DEFAULT@"
422 doc=Set presence information for the profile
423 doc_param_0=to_jid: the JID to who we send the presence data (emtpy string for broadcast)
424 doc_param_1=show: as for [presenceUpdate]
425 doc_param_2=statuses: as for [presenceUpdate]
426 doc_param_3=%(doc_profile_key)s
427
428 [subscription]
429 type=method
430 category=core
431 sig_in=sss
432 sig_out=
433 param_2_default="@DEFAULT@"
434 doc=Send subscription request/answer to a contact
435 doc_param_0=sub_type: as for [subscribe]
436 doc_param_1=entity: as for [subscribe]
437 doc_param_2=%(doc_profile_key)s
438
439 [getConfig]
440 type=method
441 category=core
442 sig_in=ss
443 sig_out=s
444 doc=get main configuration option
445 doc_param_0=section: section of the configuration file (empty string for DEFAULT)
446 doc_param_1=name: name of the option
447
448 [setParam]
449 type=method
450 category=core
451 sig_in=sssis
452 sig_out=
453 param_3_default=-1
454 param_4_default="@DEFAULT@"
455 doc=Change a parameter
456 doc_param_0=name: Name of the parameter to change
457 doc_param_1=value: New Value of the parameter
458 doc_param_2=category: Category of the parameter to change
459 doc_param_3=%(doc_security_limit)s
460 doc_param_4=%(doc_profile_key)s
461
462 [getParamA]
463 type=method
464 category=core
465 sig_in=ssss
466 sig_out=s
467 param_2_default="value"
468 param_3_default="@DEFAULT@"
469 doc=Helper method to get a parameter's attribute *when profile is connected*
470 doc_param_0=name: as for [setParam]
471 doc_param_1=category: as for [setParam]
472 doc_param_2=attribute: Name of the attribute
473 doc_param_3=%(doc_profile_key)s
474
475 [asyncGetParamA]
476 async=
477 type=method
478 category=core
479 sig_in=sssis
480 sig_out=s
481 param_2_default="value"
482 param_3_default=-1
483 param_4_default="@DEFAULT@"
484 doc=Helper method to get a parameter's attribute
485 doc_param_0=name: as for [setParam]
486 doc_param_1=category: as for [setParam]
487 doc_param_2=attribute: Name of the attribute
488 doc_param_3=%(doc_security_limit)s
489 doc_param_4=%(doc_profile_key)s
490
491 [asyncGetParamsValuesFromCategory]
492 async=
493 type=method
494 category=code
495 sig_in=sis
496 sig_out=a{ss}
497 param_1_default=-1
498 param_2_default="@DEFAULT@"
499 doc=Get "attribute" for all params of a category
500 doc_param_0=category: as for [setParam]
501 doc_param_1=%(doc_security_limit)s
502 doc_param_2=%(doc_profile_key)s
503
504 [getParamsUI]
505 async=
506 type=method
507 category=core
508 sig_in=iss
509 sig_out=s
510 param_0_default=-1
511 param_1_default=''
512 param_2_default="@DEFAULT@"
513 doc=Return a SàT XMLUI for parameters, eventually restrict the result to the parameters concerning a given frontend
514 doc_param_0=%(doc_security_limit)s
515 doc_param_1=app: name of the frontend requesting the parameters, or '' to get all parameters
516 doc_param_2=%(doc_profile_key)s
517
518 [getParamsCategories]
519 type=method
520 category=core
521 sig_in=
522 sig_out=as
523 doc=Get all categories currently existing in parameters
524 doc_return=list of categories
525
526 [paramsRegisterApp]
527 type=method
528 category=core
529 sig_in=sis
530 sig_out=
531 param_1_default=-1
532 param_2_default=''
533 doc=Register frontend's specific parameters
534 doc_param_0=xml: XML definition of the parameters to be added
535 doc_param_1=%(doc_security_limit)s
536 doc_param_2=app: name of the frontend registering the parameters
537
538 [historyGet]
539 async=
540 type=method
541 category=core
542 sig_in=ssiba{ss}s
543 sig_out=a(sdssa{ss}a{ss}sa{ss})
544 param_3_default=True
545 param_4_default=''
546 param_5_default="@NONE@"
547 doc=Get history of a communication between two entities
548 doc_param_0=from_jid: source JID (bare jid for catch all, full jid else)
549 doc_param_1=to_jid: dest JID (bare jid for catch all, full jid else)
550 doc_param_2=limit: max number of history elements to get (0 for the whole history)
551 doc_param_3=between: True if we want history between the two jids (in both direction), False if we only want messages from from_jid to to_jid
552 doc_param_4=filters: patterns to filter the history results, can be:
553 - body: pattern must be in message body
554 - search: pattern must be in message body or source resource
555 - types: type must one of those, values are separated by spaces
556 - not_types: type must not be one of those, values are separated by spaces
557 doc_param_5=%(doc_profile)s
558 doc_return=Ordered list (by timestamp) of data as in [messageNew] (without final profile)
559
560 [addContact]
561 type=method
562 category=core
563 sig_in=ss
564 sig_out=
565 param_1_default="@DEFAULT@"
566 doc=Add a contact to profile's roster
567 doc_param_0=entity_jid: JID to add to roster
568 doc_param_1=%(doc_profile_key)s
569
570 [updateContact]
571 async=
572 type=method
573 category=core
574 sig_in=ssass
575 sig_out=
576 param_3_default="@DEFAULT@"
577 doc=update a contact in profile's roster
578 doc_param_0=entity_jid: JID update in roster
579 doc_param_1=name: roster's name for the entity
580 doc_param_2=groups: list of group where the entity is
581 doc_param_3=%(doc_profile_key)s
582
583 [delContact]
584 async=
585 type=method
586 category=core
587 sig_in=ss
588 sig_out=
589 param_1_default="@DEFAULT@"
590 doc=Remove a contact from profile's roster
591 doc_param_0=entity_jid: JID to remove from roster
592 doc_param_1=%(doc_profile_key)s
593
594 [launchAction]
595 async=
596 type=method
597 category=core
598 sig_in=sa{ss}s
599 sig_out=a{ss}
600 param_2_default="@DEFAULT@"
601 doc=Launch a registred action
602 doc_param_0=callback_id: id of the registred callback
603 doc_param_1=data: optional data
604 doc_param_2=%(doc_profile_key)s
605 doc_return=dict where key can be:
606 - xmlui: a XMLUI need to be displayed
607
608 [actionsGet]
609 type=method
610 category=core
611 sig_in=s
612 sig_out=a(a{ss}si)
613 param_0_default="@DEFAULT@"
614 doc=Get all not yet answered actions
615 doc_param_0=%(doc_profile_key)s
616 doc_return=list of data as for [actionNew] (without the profile)
617
618 [progressGet]
619 type=method
620 category=core
621 sig_in=ss
622 sig_out=a{ss}
623 doc=Get progress information for an action
624 doc_param_0=id: id of the progression status
625 doc_param_1=%(doc_profile)s
626 doc_return=dict with progress informations:
627 - position: current position
628 - size: end position (optional if not known)
629 other metadata may be present
630
631 [progressGetAllMetadata]
632 type=method
633 category=core
634 sig_in=s
635 sig_out=a{sa{sa{ss}}}
636 doc=Get all active progress informations
637 doc_param_0=%(doc_profile)s or C.PROF_KEY_ALL for all profiles
638 doc_return= a dict which map profile to progress_dict
639 progress_dict map progress_id to progress_metadata
640 progress_metadata is the same dict as sent by [progressStarted]
641
642 [progressGetAll]
643 type=method
644 category=core
645 sig_in=s
646 sig_out=a{sa{sa{ss}}}
647 doc=Get all active progress informations
648 doc_param_0=%(doc_profile)s or C.PROF_KEY_ALL for all profiles
649 doc_return= a dict which map profile to progress_dict
650 progress_dict map progress_id to progress_data
651 progress_data is the same dict as returned by [progressGet]
652
653 [menusGet]
654 type=method
655 category=core
656 sig_in=si
657 sig_out=a(ssasasa{ss})
658 doc=Get all additional menus
659 doc_param_0=language: language in which the menu should be translated (empty string for default)
660 doc_param_1=security_limit: %(doc_security_limit)s
661 doc_return=list of tuple with the following value:
662 - menu_id: menu id (same as callback id)
663 - menu_type: Type which can be:
664 * NORMAL: Classical application menu
665 - menu_path: raw path of the menu
666 - menu_path_i18n: translated path of the menu
667 - extra: extra data, like icon name
668
669 [menuLaunch]
670 async=
671 type=method
672 category=core
673 sig_in=sasa{ss}is
674 sig_out=a{ss}
675 doc=Launch a registred menu
676 doc_param_0=menu_type: type of the menu (C.MENU_*)
677 doc_param_1=path: canonical (untranslated) path of the menu
678 doc_param_2=data: optional data
679 doc_param_3=%(doc_security_limit)s
680 doc_param_4=%(doc_profile_key)s
681 doc_return=dict where key can be:
682 - xmlui: a XMLUI need to be displayed
683
684 [menuHelpGet]
685 type=method
686 category=core
687 sig_in=ss
688 sig_out=s
689 param_2="NORMAL"
690 doc=Get help information for a menu
691 doc_param_0=menu_id: id of the menu (same as callback_id)
692 doc_param_1=language: language in which the menu should be translated (empty string for default)
693 doc_return=Translated help string
694
695 [discoInfos]
696 async=
697 type=method
698 category=core
699 sig_in=ssbs
700 sig_out=(asa(sss)a{sa(a{ss}as)})
701 param_1_default=u''
702 param_2_default=True
703 param_3_default=u"@DEFAULT@"
704 doc=Discover infos on an entity
705 doc_param_0=entity_jid: JID to discover
706 doc_param_1=node: node to use
707 doc_param_2=use_cache: use cached data if available
708 doc_param_3=%(doc_profile_key)s
709 doc_return=discovery data:
710 - list of features
711 - list of identities (category, type, name)
712 - dictionary of extensions (FORM_TYPE as key), with value of:
713 - list of field which are:
714 - dictionary key/value where key can be:
715 * var
716 * label
717 * type
718 * desc
719 - list of values
720
721 [discoItems]
722 async=
723 type=method
724 category=core
725 sig_in=ssbs
726 sig_out=a(sss)
727 param_1_default=u''
728 param_2_default=True
729 param_3_default=u"@DEFAULT@"
730 doc=Discover items of an entity
731 doc_param_0=entity_jid: JID to discover
732 doc_param_1=node: node to use
733 doc_param_2=use_cache: use cached data if available
734 doc_param_3=%(doc_profile_key)s
735 doc_return=array of tuple (entity, node identifier, name)
736
737 [discoFindByFeatures]
738 async=
739 type=method
740 category=core
741 sig_in=asa(ss)bbbbs
742 sig_out=(a{sa(sss)}a{sa(sss)}a{sa(sss)})
743 param_2_default=False
744 param_3_default=True
745 param_4_default=True
746 param_5_default=True
747 param_6_default=u"@DEFAULT@"
748 doc=Discover items of an entity
749 doc_param_0=namespaces: namespaces of the features to check
750 doc_param_1=identities: identities to filter
751 doc_param_2=bare_jid: if True only retrieve bare jids
752 if False, retrieve full jids of connected resources
753 doc_param_3=service: True to check server's services
754 doc_param_4=roster: True to check connected devices from people in roster
755 doc_param_5=own_jid: True to check profile's jid
756 doc_param_6=%(doc_profile_key)s
757 doc_return=tuple of maps of found entities full jids to their identities. Maps are in this order:
758 - services entities
759 - own entities (i.e. entities linked to profile's jid)
760 - roster entities
761
762 [saveParamsTemplate]
763 type=method
764 category=core
765 sig_in=s
766 sig_out=b
767 doc=Save parameters template to xml file
768 doc_param_0=filename: output filename
769 doc_return=boolean (True in case of success)
770
771 [loadParamsTemplate]
772 type=method
773 category=core
774 sig_in=s
775 sig_out=b
776 doc=Load parameters template from xml file
777 doc_param_0=filename: input filename
778 doc_return=boolean (True in case of success)
779
780 [sessionInfosGet]
781 async=
782 type=method
783 category=core
784 sig_in=s
785 sig_out=a{ss}
786 doc=Get various informations on current profile session
787 doc_param_0=%(doc_profile_key)s
788 doc_return=session informations, with at least the following keys:
789 jid: current full jid
790 started: date of creation of the session (Epoch time)
791
792 [namespacesGet]
793 type=method
794 category=core
795 sig_in=
796 sig_out=a{ss}
797 doc=Get a dict to short name => whole namespaces
798 doc_return=namespaces mapping