SaltObjectEvent Class

  • Article

SaltObjectEvent Class

Abstract:  Yes
Raised by:  Not applicable
Base Class:  SaltInterpreterEvent
Derived Classes:  PromptQueueEvent, SaltElementEvent

The abstract SaltObjectEvent class defines an event type for all events pertaining to SALT objects. These events are then grouped under the derived classes:

  • PromptQueueEvent, for events used when a SALT promptqueue element receives a method call

  • SaltElementEvent, for events used when a SALT element receives a method call, or raises a script event (whether or not the event has a handler).

SaltObjectEvent implements the following properties:

Property

Type

Description

Operation

String

The name of the script event that was raised or method that was called (for example, onreco, start, and onerror).

AttributesAndProperties

String

A string containing all attributes and properties of the element, including XML type information with the XML DOM object and recognition results.
If the property is not an XML type, only strings and numbers are included.

Remarks

Abstract events do not appear directly in the logs. Properties inherited or defined by the abstract class appear in the logs when implemented in derived classes.

See Also

Event Logging Class Hierarchy | Logging and Analyzing Events | CommonEvent | Abstract Events