comparison src/bridge/bridge_constructor/bridge_template.ini @ 2050:046449cc2bff

core, bridge, frontends: removed deprecated bridge method askConfirmation, confirmationAnswer, actionResult, actionResultExt and getWaitingConf
author Goffi <goffi@goffi.org>
date Sun, 28 Aug 2016 19:23:58 +0200
parents c0ff84243650
children 24827e550991
comparison
equal deleted inserted replaced
2049:b67aece4a667 2050:046449cc2bff
52 - received_timestamp: date of receiption for delayed messages 52 - received_timestamp: date of receiption for delayed messages
53 - delay_sender: entity which has originally sent or which has delayed the message 53 - delay_sender: entity which has originally sent or which has delayed the message
54 - info_type: subtype for info messages 54 - info_type: subtype for info messages
55 doc_param_8=%(doc_profile)s 55 doc_param_8=%(doc_profile)s
56 56
57 [newAlert]
58 deprecated=
59 type=signal
60 category=core
61 sig_in=ssss
62 doc=A new alert happened
63 doc_param_0=message: Body of the alert
64 doc_param_1=title: Title of the alert
65 doc_param_2=alert_type: Type of the alert, can be:
66 - INFO: Informative message
67 - ERROR: something went wrong
68 doc_param_3=%(doc_profile)s
69
70 [presenceUpdate] 57 [presenceUpdate]
71 type=signal 58 type=signal
72 category=core 59 category=core
73 sig_in=ssia{ss}s 60 sig_in=ssia{ss}s
74 doc=Somebody changed his presence information. 61 doc=Somebody changed his presence information.
102 category=core 89 category=core
103 sig_in=ss 90 sig_in=ss
104 doc=A contact has been supressed from roster 91 doc=A contact has been supressed from roster
105 doc_param_0=entity_jid: JID of the contact removed from roster 92 doc_param_0=entity_jid: JID of the contact removed from roster
106 doc_param_1=%(doc_profile)s 93 doc_param_1=%(doc_profile)s
107
108 [askConfirmation]
109 deprecated=
110 type=signal
111 category=core
112 sig_in=ssa{ss}s
113 doc=A confirmation is needed for an action
114 doc_param_0=id: Id of the confirmation query
115 doc_param_1=conf_type: Type of the confirmation, can be:
116 - YES/NO: A question which need a yes or no answer
117 - FILE_TRANSFER: A confirmation is needed before transfering a file
118 doc_param_2=data: conf_type dependent data
119 doc_param_3=%(doc_profile)s
120 94
121 [actionNew] 95 [actionNew]
122 type=signal 96 type=signal
123 category=core 97 category=core
124 sig_in=a{ss}sis 98 sig_in=a{ss}sis
136 doc_param_1=id: action id 110 doc_param_1=id: action id
137 This id can be used later by frontends to announce to other ones that the action is managed and can now be ignored. 111 This id can be used later by frontends to announce to other ones that the action is managed and can now be ignored.
138 doc_param_2=%(doc_security_limit)s 112 doc_param_2=%(doc_security_limit)s
139 doc_param_3=%(doc_profile)s 113 doc_param_3=%(doc_profile)s
140 114
141 [actionResult]
142 deprecated=
143 type=signal
144 category=core
145 sig_in=ssa{ss}s
146 doc=Requested result of an action
147 doc_param_0=answer_type: Type of the answer, can be:
148 - SUPPRESS: The action is managed, the id MUST be removed from queue
149 - XMLUI: A SàT XMLUI interface is sent
150 - ERROR: Something went wrong when doing the action
151 - RESULT: General result, interpretation depend of the action
152 doc_param_1=id: Id of the action
153 doc_param_2=data: answer_type specific data
154 doc_param_3=%(doc_profile)s
155
156 [actionResultExt]
157 deprecated=
158 type=signal
159 category=core
160 sig_in=ssa{sa{ss}}s
161 doc=Requested result of an action (Extended)
162 doc_param_0=answer_type: Same as for [actionResult] but with the following additional one:
163 - DICT_DICT: As RESULT, but returned as a dictionary of dictionary
164 doc_param_1=id: Id of the action
165 doc_param_2=data: answer_type specific data
166 doc_param_3=%(doc_profile)s
167
168 [entityDataUpdated] 115 [entityDataUpdated]
169 type=signal 116 type=signal
170 category=core 117 category=core
171 sig_in=ssss 118 sig_in=ssss
172 doc=An entity's data has been updated 119 doc=An entity's data has been updated
429 sig_out=a{ss} 376 sig_out=a{ss}
430 param_0_default="@DEFAULT@" 377 param_0_default="@DEFAULT@"
431 doc=Get subscription requests in queue 378 doc=Get subscription requests in queue
432 doc_param_0=%(doc_profile_key)s 379 doc_param_0=%(doc_profile_key)s
433 doc_return=Dict where contact JID is the key, and value is the subscription type 380 doc_return=Dict where contact JID is the key, and value is the subscription type
434
435 [getWaitingConf]
436 type=method
437 category=core
438 sig_in=s
439 sig_out=a(ssa{ss})
440 doc=Get confirmations requests in queue
441 doc_param_0=%(doc_profile_key)s
442 doc_return=List of confirmation request data, same as for [askConfirmation]
443
444 381
445 [messageSend] 382 [messageSend]
446 async= 383 async=
447 type=method 384 type=method
448 category=core 385 category=core
665 param_0_default="@DEFAULT@" 602 param_0_default="@DEFAULT@"
666 doc=Get all not yet answered actions 603 doc=Get all not yet answered actions
667 doc_param_0=%(doc_profile_key)s 604 doc_param_0=%(doc_profile_key)s
668 doc_return=list of data as for [actionNew] (without the profile) 605 doc_return=list of data as for [actionNew] (without the profile)
669 606
670 [confirmationAnswer]
671 deprecated=
672 type=method
673 category=core
674 sig_in=sba{ss}s
675 sig_out=
676 doc=Give answer to a confirmation request
677 doc_param_0=id: id of the confirmation request
678 doc_param_1=accepted: True if the action is confirmed
679 doc_param_2=data: action specific data
680 doc_param_3=%(doc_profile)s
681
682 [progressGet] 607 [progressGet]
683 type=method 608 type=method
684 category=core 609 category=core
685 sig_in=ss 610 sig_in=ss
686 sig_out=a{ss} 611 sig_out=a{ss}