backend, bridge, frontends: actionNew has now a security_limit argument + added some docstring to explain data argument

This commit is contained in:
Goffi 2015-11-14 19:21:56 +01:00
commit fbbb081425

View file

@ -112,14 +112,23 @@ doc_param_3=%(doc_profile)s
[actionNew]
type=signal
category=core
sig_in=a{ss}ss
sig_in=a{ss}sis
doc=A frontend action is requested
doc_param_0=action_data: a dict where key can be:
- xmlui: a XMLUI need to be displayed
- progress: a progress id
- meta_*: meta information on the action, used to make automation more easy,
some are defined below
- meta_from_jid: origin of the request
- meta_type: type of the request, can be one of:
- C.META_TYPE_FILE: a file transfer request validation
- C.META_TYPE_OVERWRITE: a file overwriting confirmation
- meta_progress_id: progress id linked to this action
doc_param_1=id: action id
This id can be used later by frontends to announce to other ones
That the action is managed and can now be ignored.
doc_param_2=%(doc_profile)s
doc_param_2=%(doc_security_limit)s
doc_param_3=%(doc_profile)s
[actionResult]
deprecated=