Mercurial > libervia-backend

diff src/bridge/bridge_constructor/bridge_template.ini @ 777:5642939d254e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
core, bridge: new method paramsRegisterApp to register frontend's specific parameters
author souliane <souliane@mailoo.org>
date Fri, 27 Dec 2013 13:28:26 +0100
parents eac23b1aad90
children bfafed251b40
line wrap: on
line diff
--- a/src/bridge/bridge_constructor/bridge_template.ini	Fri Jan 03 21:25:07 2014 +0100
+++ b/src/bridge/bridge_constructor/bridge_template.ini	Fri Dec 27 13:28:26 2013 +0100
@@ -447,38 +447,44 @@
 async=
 type=method
 category=core
-sig_in=is
+sig_in=iss
 sig_out=s
 param_0_default=-1
-param_1_default="@DEFAULT@"
-doc=Return a SàT XMLUI for parameters
+param_1_default=''
+param_2_default="@DEFAULT@"
+doc=Return a SàT XMLUI for parameters, eventually restrict the result to the parameters concerning a given frontend
 doc_param_0=%(doc_security_limit)s
-doc_param_1=%(doc_profile_key)s
+doc_param_1=app: name of the frontend requesting the parameters, or '' to get all parameters
+doc_param_2=%(doc_profile_key)s
 
 [getParams]
 async=
 type=method
 category=core
-sig_in=is
+sig_in=iss
 sig_out=s
 param_0_default=-1
-param_1_default="@DEFAULT@"
-doc=Return XML of parameters
+param_1_default=''
+param_2_default="@DEFAULT@"
+doc=Return XML of parameters, eventually restrict the result to the parameters concerning a given frontend
 doc_param_0=%(doc_security_limit)s
-doc_param_1=%(doc_profile_key)s
+doc_param_1=app: name of the frontend requesting the parameters, or '' to get all parameters
+doc_param_2=%(doc_profile_key)s
 
 [getParamsForCategory]
 async=
 type=method
 category=core
-sig_in=sis
+sig_in=siss
 sig_out=s
 param_1_default=-1
-param_2_default="@DEFAULT@"
-doc=Return a xml of all params in a category
+param_2_default=''
+param_3_default="@DEFAULT@"
+doc=Return a xml of all params in a category, eventually restrict the result to the parameters concerning a given frontend
 doc_param_0=category: Category to get
 doc_param_1=%(doc_security_limit)s
-doc_param_2=%(doc_profile_key)s
+doc_param_2=app: name of the frontend requesting the parameters, or '' to get all parameters
+doc_param_3=%(doc_profile_key)s
 
 [getParamsCategories]
 type=method
@@ -488,6 +494,18 @@
 doc=Get all categories currently existing in parameters
 doc_return=list of categories
 
+[paramsRegisterApp]
+type=method
+category=core
+sig_in=sis
+sig_out=
+param_1_default=-1
+param_2_default=''
+doc=Register frontend's specific parameters
+doc_param_0=xml: XML definition of the parameters to be added
+doc_param_1=%(doc_security_limit)s
+doc_param_2=app: name of the frontend registering the parameters
+
 [getHistory]
 async=
 type=method