Alarm

[ Interface ]

Version 1.10

export interface Alarm extends Event {
    type: Type.Alarm;
    id: number | string;
    timeCleared: Date;
    timeConfirmed: Date;
    confirmationState: ConfirmationState;
}

This interface extends Event.

Version 1.12

export interface Alarm<T extends Dictionary<any> = Dictionary<any>> extends MessageOrAlarm<T> {
    type: Type.Alarm;
    id: number;
    timeCleared: Date | null;
    timeConfirmed: Date | null;
    alarmState: AlarmState;
    confirmationState: ConfirmationState;
}

This interface extends MessageOrAlarm.

Properties

Name	Type	Description
type	Type.Alarm	Ensures that instances of this interface have always set the type Alarm.
id	number, string	A unique value with which this alarm can be identified
timeCleared	Date	The time at which the alarm was confirmed by the trigger as no longer acute
timeConfirmed	Date	The time at which the alarm was acknowledged by the user
confirmationState	ConfirmationState	The current confirmation status
alarmState From version 1.12	AlarmState

	Available from version 1.10