ControlApiFunction

[ Schnittstelle ]

export interface ControlApiFunction extends baseAction {
    objectType: 'ControlApiFunction';
    control: string;
    fn: string;
    fnParams: IFunction.Value[];
}

Erweitert baseAction

Definiert eine Aktion vom Typ ControlApiFunction.

Eine Aktion die dazu verwendet wird eine Funktion einer bestimmten Control-Instanz aufzurufen.

Eigenschaften

Name

Typ

Beschreibung

active [ Optional ]

boolean

Definiert ob die Aktion aktiv oder inaktiv ist.

collapsed [ Optional ]

boolean

Definiert ob die Aktion im Actions & Conditions Editor eingeklappt ist oder nicht.

asyncWait

boolean

Definiert ob bei asynchronen Aktionen gewartet werden soll bis das Ende der Aktion signalisiert wurde bevor die folgende Aktion ausgeführt wird oder nicht.

success

Action[]

Eine Liste von Aktionen die im Erfolgsfall ausgeführt werden soll.

error

Action[]

Eine Liste von Aktionen die im Fehlerfall ausgeführt werden soll.

objectType

'ControlApiFunction'

Definiert den zuständigen Parser.

control

string

Name des Controls

fn

string

Name der Control API Funktion

fnParams

IFunction.Value[]

Eine Liste von Parametern die der in fn definierten Funktion übergeben werden sollen.

ControlApiFunction 1:

Verfügbar ab Version 1.12