Mercurial > libervia-backend

diff 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
line wrap: on
line diff
--- a/src/bridge/bridge_constructor/bridge_template.ini	Fri Sep 25 19:19:12 2015 +0200
+++ b/src/bridge/bridge_constructor/bridge_template.ini	Fri Sep 25 19:19:12 2015 +0200
@@ -158,6 +158,31 @@
 doc_param_2=value: New value
 doc_param_3=%(doc_profile)s
 
+[progressStarted]
+type=signal
+category=core
+sig_in=ss
+doc=A progressing operation has just started
+doc_param_0=id: id of the progression operation
+doc_param_1=%(doc_profile)s
+
+[progressFinished]
+type=signal
+category=core
+sig_in=ss
+doc=A progressing operation is finished
+doc_param_0=id: id of the progression operation
+doc_param_1=%(doc_profile)s
+
+[progressError]
+type=signal
+category=core
+sig_in=sss
+doc=There was an error during progressing operation
+doc_param_0=id: id of the progression operation
+doc_param_0=error: error message
+doc_param_1=%(doc_profile)s
+
 ;methods
 
 [getReady]
@@ -595,7 +620,7 @@
 doc_param_2=data: action specific data
 doc_param_3=%(doc_profile)s
 
-[getProgress]
+[progressGet]
 type=method
 category=core
 sig_in=ss
@@ -603,10 +628,21 @@
 doc=Get progress information for an action
 doc_param_0=id: id of the progression status
 doc_param_1=%(doc_profile)s
-doc_return=dict with progress information:
+doc_return=dict with progress informations:
  - position: current position
  - size: end position
 
+[progressGetAll]
+type=method
+category=core
+sig_in=s
+sig_out=a{sa{sa{ss}}}
+doc=Get all active progress informations
+doc_param_0=%(doc_profile)s or C.PROF_KEY_ALL for all profiles
+doc_return= a dict which map profile to progress_dict
+    progress_dict map progress_id to progress_data
+    progress_data is the same dict as returned by [progressGet]
+
 [getMenus]
 type=method
 category=core