IEventMonitor
This topic describes the properties and methods of the IEventMonitor interface.
Methods
- EndEvent
-
Stops the event specified by the
progressIdand updates the progress information of the event. -
- progressId
- The unique identifier of an event.
- progressStatus
-
Setting the final progress status using one of the value of the ProgressStatus enumeration.
Note: When this parameter is set to
Calculate, the final status is the event is calculated by using the status on its actions/details, in case the event is not the main event of a cluster of smaller events. The statusCalculateis set byEventMonitor.EndEventon main events that cluster a set of related events. Related events are clustered by using theParentProgressIdfield on the events. The final status of the main event will be calculated using the status of its child events upon request. A main event itself cannot be clustered within another main event. - currentProgress
- The current position within the progress range.
- maximumProgress
-
The maximum value of the progress range, so this parameter defines the upper limit of the
currentProgressparameter. Typically, the value of this parameter is set to the total number of objects that need to be processed. When using a positive value, the value of this parameter overwrites the maximum progress value of the event. The parameter is ignored when using a negative value. The lower limit of the range is always 0.
- AddEventDetail
-
Adds a new action/detail to the event specified by the
progressIdparameter. Custom data comes from a string. -
- progressId
- The unique identifier of the event containing the action/detail.
- level
- One of the enumeration values of EventLevel that specifies the event level for the event action/detail.
- action
- The name for the action/detail.
- description
- A description for the action/detail.
- status
- One of the enumeration values of DetailStatus indicating the status for the action/detail.
- eventDataType
-
One of the enumeration values of EventDataType indicating the type of data stored in
data. - data
- A string containing custom data for the action/detail. This parameter lets users attach their own data to the event action/detail.
- AddEventDetail
-
Adds a new action/detail to the event specified by the
progressIdparameter. Custom data comes from aStream. -
- progressId
- The unique identifier of the event containing the action/detail.
- level
- One of the enumeration values of EventLevel that specifies the event level for the event action/detail.
- action
- The name for the action/detail.
- description
- A description for the action/detail.
- status
- One of the enumeration values of DetailStatus indicating the status for the action/detail.
- eventDataType
-
One of the enumeration values of EventDataType indicating the type of data stored in
data. - data
-
A
Streamcontaining custom data for the action/detail. This parameter lets users attach their own data to the event action/detail.
- AddEventDetail
- Adds the event detail record without additional event data.
-
- progressId
- The unique identifier of the event containing the action/detail.
- level
- One of the enumeration values of EventLevel that specifies the event level for the event action/detail.
- action
- The name for the action/detail.
- description
- A description for the action/detail.
- status
- One of the enumeration values of DetailStatus indicating the status for the action/detail.
- AddEventDetailWithProgress
-
Adds a new action/detail to the event specified by the
progressIdparameter and updates the progress information of the event. Custom data comes from a string. -
- progressId
- The unique identifier of the event containing the action/detail.
- level
- One of the enumeration values of EventLevel that specifies the event level for the event action/detail.
- action
- The name for the action/detail.
- description
- A description for the action/detail.
- status
- One of the enumeration values of DetailStatus indicating the status for the action/detail.
- eventDataType
-
One of the enumeration values of EventDataType indicating the type of data stored in
data. - data
- A string containing custom data for the action/detail.
- currentProgress
- The current position within the progress range.
- maximumProgress
-
The maximum value of the progress range, so this parameter defines the upper limit of the
currentProgressparameter. Typically, the value of this parameter is set to the total number of objects that need to be processed. When using a positive value, the value of this parameter overwrites the maximum progress value of the event. The parameter is ignored when using a negative value. The lower limit of the range is always 0.
- AddEventDetailWithProgress
-
Adds a new action/detail to the event specified by the
progressIdparameter and updates the progress information of the event. Custom data comes from aStream. -
- progressId
- The unique identifier of the event containing the action/detail.
- level
- One of the enumeration values of EventLevel that specifies the event level for the event action/detail.
- action
- The name for the action/detail.
- description
- A description for the action/detail.
- status
- One of the enumeration values of DetailStatus indicating the status for the action/detail.
- eventDataType
-
One of the enumeration values of EventDataType indicating the type of data stored in
data. - data
-
A
Streamcontaining custom data for the action/detail. - currentProgress
- The current position within the progress range.
- maximumProgress
-
The maximum value of the progress range, so this parameter defines the upper limit of the
currentProgressparameter. Typically, the value of this parameter is set to the total number of objects that need to be processed. When using a positive value, the value of this parameter overwrites the maximum progress value of the event. The parameter is ignored when using a negative value. The lower limit of the range is always 0.
- AddEventDetailWithProgress
- Adds the event detail record with progress without additional event data.
-
- progressId
- The unique identifier of the event containing the action/detail.
- level
- One of the enumeration values of EventLevel that specifies the event level for the event action/detail.
- action
- The name for the action/detail.
- description
- A description for the action/detail.
- status
- One of the enumeration values of DetailStatus indicating the status for the action/detail.
- currentProgress
- The current position within the progress range.
- maximumProgress
-
The maximum value of the progress range, so this parameter defines the upper limit of the
currentProgressparameter. Typically, the value of this parameter is set to the total number of objects that need to be processed. When using a positive value, the value of this parameter overwrites the maximum progress value of the event. The parameter is ignored when using a negative value. The lower limit of the range is always 0.