milestonexprotectrestpython.xpranalyticsevent

Module: xpranalyticsevent.py

Revision History

Date Version Description
2023/07/11 1.0.0.0 Initial Version.

@export
class XPRAnalyticsEvent:

Analytics Event information.

More information about Analytics Event configuration can be found on the vendor documentation page.

Threadsafety:

This class is fully thread-safe.

XPRAnalyticsEvent()

Initializes a new instance of the class.

DateModified: datetime.datetime

Date and time (in UTC format) that the entry was last modified.

Returns:

The DateModified property value.

Description: str

Description of the event.

Returns:

The Description property value.

DisplayName: str

User-friendly display name used in various user-interface displays.

Returns:

The DisplayName property value.

Id: str

The globally unique identifier of the item.

Returns:

The Id property value.

Name: str

Name of the event.

Returns:

The Name property value.

SourceArray: list[str]

Source item types.
Contains an array of possible sources of the event.
Can contain Camera, Hardware and other itemtype values.
For MIP plugin events the source itemtype is MIPItem and the filter contains the MIP Kind of source. The actual source is selected in the rule and alarm definition configuration.

Returns:

The SourceArray property value.