milestonexprotectrestpython.xprgenericevent
Module: xprgenericevent.py
Revision History
Date | Version | Description |
---|---|---|
2023/07/11 | 1.0.0.0 | Initial Version. |
Generic Event information.
More information about Generic Event configuration can be found on the vendor documentation page.
Threadsafety:
This class is fully thread-safe.
Date and time (in UTC format) that the entry was last modified.
Returns:
The DateModified property value.
User-friendly display name used in various user-interface displays.
Returns:
The DisplayName property value.
Expression that the system should look out for when analyzing data packages.
Returns:
The Expression property value.
Indicates how particular the system should be when analyzing received data packages.
The options are the following:
- Search: In order for the event to occur, the received data package must contain the text specified in the Expression field, but may also have more content.
- Match: In order for the event to occur, the received data package must contain exactly the text specified in the Expression field, and nothing else.
- Regular expression.
Returns:
The ExpressionType property value.
Priority of the event.
The priority must be specified as a number between 0 (highest priority) and 999999 (lowest priority).
Returns:
The Priority property value.
The same data package may be analyzed for different events. The ability to assign a priority to each event lets you manage which event should be triggered if a received package matches the criteria for several events.