IServerWatchResultObject

[ Interface ]

Version 1.10

export interface IServerWatchResultObject extends IWatchesultObject {
    response?: TcHmi.Server.IMessage;
}

Version 1.12

export interface IServerWatchResultObject<T = any> extends IWatchesultObject<T> {
    response?: TcHmi.Server.IMessage<T>;
}

Properties

Name	Type	Description
error	Errors	Cause of the fault
details [ optional ]	IErrorDetails	Optional details about error. Content depends on the function used and the error.
value [ optional ]	Version 1.10 any Version 1.12 T	Contains the value that was read if no error occurred.
processedStart [ optional ] Available from version 1.12	string	It is set by the TwinCAT HMI server when a corresponding request from the TwinCAT HMI server contains a timestamp in ISO 8601 format indicating the time when the operation on the server started.
processedEnd [ optional ] Available from version 1.12	string	It is set by the TwinCAT HMI server when a corresponding request from the TwinCAT HMI server contains a timestamp in ISO 8601 format indicating the time when the operation on the server was complete.
dirtyPaths [ optional ] Available from version 1.12	string[]	Only relevant if value is an object. Contains a list of paths to object properties that have changed. If empty or not set, it is assumed that everything has changed.
destroy	DestroyFunction	When this function is called, monitoring for this symbol is deactivated and all associated resources are released.
response [ optional ]	Version 1.10 TcHmi.Server.IMessage Version 1.12 TcHmi.Server.IMessage<T>	Contains the response object of the server, if available.

	Available from version 1.10