IMessage

[ Interface ]

Version 1.8

export interface IMessage {
    apiVersion?: string;
    requestType: TcHmi.Server.IRequestType;
    id?: number;
    intervalTime?: number | null;
    sessionId?: string;
    error?: TcHmi.IErrorDetails;
    customerData?: string;
    commands?: TcHmi.Server.ICommand[];
};

Version 1.12

export interface IMessage<W = any, R = any> = IReadWriteMessage<W, R> | ISubscriptionMessage<W, R> | IEventMessage<W, R>;

Ab Version 1.12 wird diese Nachricht so modelliert, dass sie entweder ReadWrite, Subscription oder Event ist.

Eigenschaften

Name

Typ

Beschreibung

apiVersion [ Optional ]

string

Versionsnummer der API

requestType

TcHmi.Server.IRequestType

Art des Zugriffes

id [ Optional ]

number

Eineindeutige Nummer der Nachricht

intervalTime [ Optional ]

number, null

Minimale Zeit in der ein Subscription-Update (subscription tick) geschickt wird.

sessionId [ Optional ]

string

sessionID der Nachricht

error [ Optional ]

TcHmi.IErrorDetails

Fehlercode der Nachricht

customerData [ Optional ]

string

Zusatzinformationen, welche aus der Anfrage in die Antwort übernommen wird

commands [ Optional ]

TcHmi.Server.ICommand[]

Liste der Kommandos dieser Nachricht

IMessage 1:

Verfügbar ab Version 1.8

IMessage 2:

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