RawServerEvent

[ Interface ]

Version 1.12

export interface RawServerEvent {
    domain: string;
    name: string;
    timeReceived: string;
    payload?: RawServerMessage | RawServerAlarm | any;
    payloadType?: TcHmi.Server.Events.Type;
    localizedString?: string;
    changeType?: ServerAlarmChangeType;
    sessionId?: string;
}

Properties

Name

Type

Description

domain

string

Indicates the domain / extension that triggered the event.

name

string

The name of the event

timeReceived

string

The time at which the event was triggered

Payload [Optional]

RawServerMessage | RawServerAlarm | any

Value that was transferred as payload

payloadType [Optional]

TcHmi.Server.Events.Type

Ensures that instances of this interface that have this property defined, have always set the type Payload.

localizedString [Optional]

string

A localized message

changeType [Optional]

ServerAlarmChangeType

The type of change in the alarm.

RawServerEvent 1:

Available from version 1.12