Mercurial > libervia-backend

comparison src/bridge/bridge_constructor/bridge_template.ini @ 1522:7d7e57a84792

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
core: progression handling improvments: - getProgress has been renamed to progressGet to follown new naming convention - new signals: progressStarted, progressFinished and progressError to indicate state of progressing events - new method progressGetAll to get all progressing events of all profile (or only one profile)
author Goffi <goffi@goffi.org>
date Fri, 25 Sep 2015 19:19:12 +0200
parents 80cd55dd5b04
children 42285d993e68
comparison
equal deleted inserted replaced
1521:d2ab9c62ac3a 1522:7d7e57a84792
155 doc=An entity's data has been updated 155 doc=An entity's data has been updated
156 doc_param_0=jid: entity's bare jid 156 doc_param_0=jid: entity's bare jid
157 doc_param_1=name: Name of the updated value 157 doc_param_1=name: Name of the updated value
158 doc_param_2=value: New value 158 doc_param_2=value: New value
159 doc_param_3=%(doc_profile)s 159 doc_param_3=%(doc_profile)s
160
161 [progressStarted]
162 type=signal
163 category=core
164 sig_in=ss
165 doc=A progressing operation has just started
166 doc_param_0=id: id of the progression operation
167 doc_param_1=%(doc_profile)s
168
169 [progressFinished]
170 type=signal
171 category=core
172 sig_in=ss
173 doc=A progressing operation is finished
174 doc_param_0=id: id of the progression operation
175 doc_param_1=%(doc_profile)s
176
177 [progressError]
178 type=signal
179 category=core
180 sig_in=sss
181 doc=There was an error during progressing operation
182 doc_param_0=id: id of the progression operation
183 doc_param_0=error: error message
184 doc_param_1=%(doc_profile)s
160 185
161 ;methods 186 ;methods
162 187
163 [getReady] 188 [getReady]
164 async= 189 async=
593 doc_param_0=id: id of the confirmation request 618 doc_param_0=id: id of the confirmation request
594 doc_param_1=accepted: True if the action is confirmed 619 doc_param_1=accepted: True if the action is confirmed
595 doc_param_2=data: action specific data 620 doc_param_2=data: action specific data
596 doc_param_3=%(doc_profile)s 621 doc_param_3=%(doc_profile)s
597 622
598 [getProgress] 623 [progressGet]
599 type=method 624 type=method
600 category=core 625 category=core
601 sig_in=ss 626 sig_in=ss
602 sig_out=a{ss} 627 sig_out=a{ss}
603 doc=Get progress information for an action 628 doc=Get progress information for an action
604 doc_param_0=id: id of the progression status 629 doc_param_0=id: id of the progression status
605 doc_param_1=%(doc_profile)s 630 doc_param_1=%(doc_profile)s
606 doc_return=dict with progress information: 631 doc_return=dict with progress informations:
607 - position: current position 632 - position: current position
608 - size: end position 633 - size: end position
634
635 [progressGetAll]
636 type=method
637 category=core
638 sig_in=s
639 sig_out=a{sa{sa{ss}}}
640 doc=Get all active progress informations
641 doc_param_0=%(doc_profile)s or C.PROF_KEY_ALL for all profiles
642 doc_return= a dict which map profile to progress_dict
643 progress_dict map progress_id to progress_data
644 progress_data is the same dict as returned by [progressGet]
609 645
610 [getMenus] 646 [getMenus]
611 type=method 647 type=method
612 category=core 648 category=core
613 sig_in=si 649 sig_in=si