Event
[ Interface ]
Version 1.10
export interface Event {
type: Type;
severity: Severity;
domain: string;
name: string;
text: string;
timeRaised: Date;
params: Dictionary<any>;
}
Version 1.12
export type Event<TPayload = any, TParams extends Dictionary<any> = Dictionary<any>> = Message<TParams> | Alarm<TParams> | PayloadEvent<TPayload>;
From version 1.12, an event is modeled such that it is either a Message, Alarm or PayloadEvent.
Properties
Name | Type | Description |
---|---|---|
type From version 1.12 no longer in this hierarchy. | The type of event | |
Severity From version 1.12 no longer in this hierarchy. | The severity of the event | |
domain From version 1.12 no longer in this hierarchy. | In version 1.10: In version 1.12: | |
name From version 1.12 no longer in this hierarchy. | The name of the event | |
text From version 1.12 no longer in this hierarchy. | The localized text of the event | |
timeRaised From version 1.12 no longer in this hierarchy. | The time at which the event was triggered | |
params From version 1.12 no longer in this hierarchy. | Parameters set by the trigger of the event |
Available from version 1.10 |