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>;

From version 1.12, this message is modeled to be either ReadWrite, Subscription or Event.

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

IMessage 1:

Available from 1.8

IMessage 2:

From version 1.10.1018.48 the property "error" is of type "TcHmi.IErrorDetails" instead of "TcHmi.Server.IError".