Verfügbare API-Funktionen

init(): Promise<boolean>;

Initialisiert die Verbindung zur übergeordneten Custom Control Component.

Rückgabewert:

• Promise mit einem booleschen Wert, der angibt, ob JavaScript API von der aktuellen Version der Web App unterstützt wird

getPropertyDefinitions(): Promise<any[]>;

Rückgabewert:

• Promise mit einem Array-Wert von Eigenschaftsdefinitionen

subscribeToDataModelChanges(func: (v: any) => void): string;

Mit dieser Funktion können Entwickler auf Modelländerungen reagieren, indem sie die Funktion so konfigurieren, dass eingehende Änderungen verarbeitet werden.

Rückgabewert:

• ID, die zu einem späteren Zeitpunkt für die Unsubscribe-Funktion verwendet werden kann

subscribeToPropertyChanges(propertyName: string, func: (v: object[]) => void): string;

Mit dieser Funktion können Entwickler auf Eigenschaftsänderungen reagieren, indem sie die Funktion so konfigurieren, dass eingehende Änderungen verarbeitet werden.

Rückgabewert:

• ID, die zu einem späteren Zeitpunkt für die Unsubscribe-Funktion verwendet werden kann

getPropertyValue(v: string): Promise<string>;

Rückgabewert:

• Promise mit einer String-Darstellung eines Eigenschaftswerts

getPropertyValidationErrors(v: string): Promise<string[]>;

Rückgabewert:

• Promise mit einem Array von Validierungsmeldungen (wenn keine Fehler vorliegen, ist das Array leer)

setPropertyValue(n: string, v: string): void;

Legt den Eigenschaftswert nach Namen fest.

unsubscribeDataModelChanges(sid: string): void;

Beendet die Subscription von Modelländerungen anhand der Subscription-ID.

getAllPropertyValues(): Promise<any>;

Rückgabewert:

• Promise mit allen Eigenschaften, die in der Component verfügbar sind

unsubscribePropertyValueChanges(sid: string): void;

Beendet die Subscription von Modelländerungen anhand der Subscription-ID.

setControlWidth(value: string): void;

Legt die gewünschte Breite des Controls fest.

Mögliche Werte:

• CSS-Werte für Breite/Höhe (z. B. 150px, 33%, 73vw)

setControlHeight(value: string): void;

Legt die gewünschte Höhe des Controls fest.

Mögliche Werte:

• CSS-Werte für Breite/Höhe (z. B. 150px, 33%, 73vw)

getControlWidth(): Promise<any>;

Rückgabewert:

• Promise mit der Höhe des Controls

getControlHeight(): Promise<any>;

Rückgabewert:

• Promise mit der Breite des Controls

getActions(): Promise<any>;

Rückgabewert:

• Promise mit dem Action-Namen

executeAction(name: string, parameters?: any): Promise<any>;

Akzeptiert den Action-Namen und ein optionales benutzerdefiniertes Parameter-Array vom Typ [ {key:'test', value:'test'}, ......  ].

Rückgabewert:

• Promise mit Action Response