ControlApiFunction
[ Interface ]
export interface ControlApiFunction extends baseAction {
objectType: 'ControlApiFunction';
control: string;
fn: string;
fnParams: IFunction.Value[];
}Extends baseAction
Defines an action of type ControlApiFunction.
An action that is used to call a function of a specific control instance.
Properties
Name | Type | Description |
|---|---|---|
active [ optional ] | Defines whether the action is active or inactive. | |
collapsed [ optional ] | Defines whether the action is collapsed or expanded in the Actions & Conditions Editor. | |
asyncWait | Defines whether or not asynchronous actions should wait until the end of the action is signaled before the following action is executed. | |
success | Action[] | A list of actions to be performed in case of success. |
error | Action[] | A list of actions to be performed in case of an error. |
objectType | 'ControlApiFunction' | Defines the relevant parser. |
control | Name of the control | |
fn | Name of the control API function | |
fnParams | A list of parameters to be transferred to the function defined in fn. |
 | Available from version 1.12 |