Mercurial > libervia-backend

comparison src/bridge/bridge_constructor/bridge_template.ini @ 1830:74676624ad5d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
bridge (template): fixed docstrings
author Goffi <goffi@goffi.org>
date Sat, 23 Jan 2016 19:56:25 +0100
parents 98a2eb768bb0
children 633b5c21aefd
comparison
equal deleted inserted replaced
1829:6079752ffeae 1830:74676624ad5d
124 - meta_type: type of the request, can be one of: 124 - meta_type: type of the request, can be one of:
125 - C.META_TYPE_FILE: a file transfer request validation 125 - C.META_TYPE_FILE: a file transfer request validation
126 - C.META_TYPE_OVERWRITE: a file overwriting confirmation 126 - C.META_TYPE_OVERWRITE: a file overwriting confirmation
127 - meta_progress_id: progress id linked to this action 127 - meta_progress_id: progress id linked to this action
128 doc_param_1=id: action id 128 doc_param_1=id: action id
129 This id can be used later by frontends to announce to other ones 129 This id can be used later by frontends to announce to other ones that the action is managed and can now be ignored.
130 That the action is managed and can now be ignored.
131 doc_param_2=%(doc_security_limit)s 130 doc_param_2=%(doc_security_limit)s
132 doc_param_3=%(doc_profile)s 131 doc_param_3=%(doc_profile)s
133 132
134 [actionResult] 133 [actionResult]
135 deprecated= 134 deprecated=
199 type=signal 198 type=signal
200 category=core 199 category=core
201 sig_in=sss 200 sig_in=sss
202 doc=There was an error during progressing operation 201 doc=There was an error during progressing operation
203 doc_param_0=id: id of the progression operation 202 doc_param_0=id: id of the progression operation
204 doc_param_0=error: error message 203 doc_param_1=error: error message
205 doc_param_1=%(doc_profile)s 204 doc_param_2=%(doc_profile)s
206 205
207 ;methods 206 ;methods
208 207
209 [getReady] 208 [getReady]
210 async= 209 async=
674 doc=Get progress information for an action 673 doc=Get progress information for an action
675 doc_param_0=id: id of the progression status 674 doc_param_0=id: id of the progression status
676 doc_param_1=%(doc_profile)s 675 doc_param_1=%(doc_profile)s
677 doc_return=dict with progress informations: 676 doc_return=dict with progress informations:
678 - position: current position 677 - position: current position
679 - size: end position 678 - size: end position (optional if not known)
679 other metadata may be present
680 680
681 [progressGetAllMetadata] 681 [progressGetAllMetadata]
682 type=method 682 type=method
683 category=core 683 category=core
684 sig_in=s 684 sig_in=s