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>[];
};

Properties

Name	Type	Description
apiVersion [ optional ]	string	Version number of the API
requestType	TcHmi.Server.IRequestType	Type of access
id [ Optional ]	number	Unique message number
intervalTime [ optional ]	number, null	Minimum time in which a subscription update (subscription tick) is sent.
sessionId [ optional ]	string	sessionID of the message
error [ optional ]	TcHmi.IErrorDetails	Error code of the message
customerData [ optional ]	string	Additional information that is applied from the query to the response
commands [ Optional ]	TcHmi.Server.ICommand[]	List of commands for this message

	Available from version 1.12