ICommand

[ Schnittstelle ]

Version 1.8

export interface ICommand {
    symbol: string;
    customerData?: string;
    readValue?: any;
    writeValue?: any;
    error?: TcHmi.IErrorDetails;
    commandOptions?: TcHmi.Server.ICommandOptions[];
};

Version 1.12

export interface ICommand<W = any, R = W> {
    symbol: string;
    customerData?: string;
    readValue?: R;
    writeValue?: W;
    error?: TcHmi.IErrorDetails;
    commandOptions?: TcHmi.Server.ICommandOptions[];
    processedStart?: string;
    processedEnd?: string; filter?: Filter | string;
    filterMap?: number[];
    orderBy?: string;
    limit?: number;
    offset?: number;
    maxEntries?: number;
};

Wird die API in TypeScript-Code benutzt, so kann dem TypeScript-Compiler mitgeteilt werden, welchen Typ das Server-Symbol hat. Hierbei wird zuerst der Typ des Wertes beim Schreiben (Write) angegeben und danach optional der Typ des zu lesenden Wertes (Read).

Eigenschaften

Name	Typ	Beschreibung
symbol	string	Symbol welches bearbeitet werden soll
customerData [ Optional ]	string	Zusatzinformationen, welche aus der Anfrage in die Antwort übernommen wird
readValue [ Optional ]	any	Wert der gelesen wurde
writeValue [ Optional ]	any	Wert der geschrieben werden soll
error [ Optional ]	TcHmi.IErrorDetails	Fehlercode des Kommandos
commandOptions [ Optional ]	TcHmi.Server.ICommandOptions[]	Parameter des Kommandos
processedStart [ Optional ] Unterstützung ab Version 1.12	string	Die Zeit (als ISO 8601 Zeichenkette) in der begonnen wurde das Kommando auf Serverseite zu verarbeiten.
processedEnd [ Optional ]: Unterstützung ab Version 1.12	string	Die Zeit (als ISO 8601 Zeichenkette) in der das Kommando auf Serverseite fertig verarbeitet wurde.
filter [ Optional ] Unterstützung ab Version 1.12	Filter, string	Filter für Arrays and Map-Objecte.
filterMap [ Optional ] Unterstützung ab Version 1.12	number[]	Erlaubt eine Zuordnung von gefilterten, sortierten und paginierten Werten zu den Original-Werten
orderBy [ Optional ] Unterstützung ab Version 1.12	string	Angabe der Sortierreihenfolge. Diese wird verarbeitet, bevor die Werte potenziell per `limit` und `offset` reduziert werden.
limit [ Optional ] Unterstützung ab Version 1.12	number	Reduziert die Anzahl der gelieferten Ergebnisse in einem Array. Die Zahl 0 deaktiviert dieses Feature.
offset [ Optional ] Unterstützung ab Version 1.12	number	Startet die gelieferten Ergebnisse in einem Array mit einem Offset. Die Zählung beginnt bei 0.
maxEntries [ Optional ]: Unterstützung ab Version 1.12	number	Die Antwort enthält diese Anzahl von Gesamtwerten.

	Verfügbar ab Version 1.8

	Ab Version 1.10.1018.48 ist die Eigenschaft „error“ vom Typ „TcHmi.IErrorDetails“ anstatt „TcHmi.Server.ICommandError“.