EventItem Type
The EventItem data type represents an event and it is returned by the getEventsSync, getEvents and subscribeEvents functions.
Properties
Property | Type | Description |
eventId | Integer | Numeric event identifier. |
id | String | Event identifier. |
sourcePoint | Point | Point representing the event source. |
sourceState | The source state. | |
property | PropertyValue | The PropertyValue object representing the property generating the alarm. |
browserObjects | The BrowserObject objects related to the event sourcePoint. | |
cause | Localizable String | The event cause. |
interventionText | Localizable String | The intervention text associated to the event. |
eventText | Localizable String | The custom text configured for normal and off-normal conditions of the object in alarm. |
informationalText | Localizable String | Technical text or instructions for operators or intervention forces relevant to the off-normal and normal conditions of system objects. |
category | The event category. | |
iconPath | String | The icon path. |
alias | String | The alias of the object generating the event. |
state | The event state. | |
commands | Collection of the available commands. | |
direction | The event direction. | |
creationTime | DateTime | The event creation time. |
observedObject | BrowserObject | In case of event enrollment, the observed source. |
inProcessBy | String | Indication that the event is handled by the operators. |
maintenance | Boolean | Indicates whether the event source is in maintenance state. |
visible | Boolean | Indicates whether the event will display on Desigo CC clients. |
messageTexts | Collection of the messages provided by the field device. | |
timerExpiration | DateTime | In case a timer is associated to the event, it provides the timer expiration time. |
timerStatus | In case a timer is associated to the event, it provides the timer status. |
