IMessageBase

[ Interface ]

export interface IMessageBase<W = any, R = W> {
    apiVersion?: string;
    id?: number;
    intervalTime?: number | null;
    sessionId?: string;
    error?: TcHmi.IErrorDetails;
    customerData?: string;
    commands?: TcHmi.Server.ICommand<W, R>[];
};

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

IMessageBase 1:

Verfügbar ab Version 1.12