Micro Focus Content Manager SDK 9.3
HP.HPTRIM.SDK.TrimEvent Class Reference

The TrimEvent class represents an event generated by a Trim client. This class is used by event processor add ins and encapsulates the information that is available in a Trim event. More...

Properties

Events EventType [get]
 Gets the Events enumeration value that indicates what type of event occurred. More...
 
TrimDateTime EventDate [get]
 Gets the date and time that this event was generated. More...
 
BaseObjectTypes ObjectType [get]
 Gets the BaseObjectTypes enumeration which identifies which TRIM object the event occurred to. Most events in TRIM are related to a particular TRIM object. More...
 
TrimURI ObjectUri [get]
 Gets the unique identifier of the TRIM object that the event occurred to. Most events in TRIM are related to a particular TRIM object. More...
 
BaseObjectTypes RelatedObjectType [get]
 Gets the BaseObjectTypes enumeration which identifies a related TRIM object that is relevant to this event. (For example, if the Assignee of a record is changed, the ObjectType will be a Record, the RelatedObjectType could be a Location.) More...
 
TrimURI RelatedObjectUri [get]
 Gets the unique identifier of a related TRIM object that is relevant to this event. (For example, if the Assignee of a record is changed, the ObjectUri will be the Record's uri, the RelatedObjectUri could be the Uri of a Location representing the new Assignee.) More...
 
string FromMachine [get]
 Gets the name of the computer that generated the event. More...
 
string ConnectionIPAddress [get]
 Gets the IP address of the machine that generated the event. More...
 
string ClientIPAddress [get]
 Gets the IP address of the client that generated the event. More...
 
int FromTimeZone [get]
 Gets the time zone that the user generating the event was working in. This is the number of minutes from GMT, with a positive number indicating a time zone ahead of GMT. For example Australian Eastern Standard Time = 600, US Pacific Time = -480. More...
 
string LoginName [get]
 Gets a string indicating the login name used by the user generating this event. More...
 
TrimURI LoginUri [get]
 Gets unique identifier of the TRIM Location representing the user who generated this event. More...
 
string ExtraDetails [get]
 Gets a string which details any extra information pertinent to the event. What is contained in this property is largely dependent on the type of event. More...
 

Detailed Description

The TrimEvent class represents an event generated by a Trim client. This class is used by event processor add ins and encapsulates the information that is available in a Trim event.

Property Documentation

string HP.HPTRIM.SDK.TrimEvent.ClientIPAddress
get

Gets the IP address of the client that generated the event.

string HP.HPTRIM.SDK.TrimEvent.ConnectionIPAddress
get

Gets the IP address of the machine that generated the event.

TrimDateTime HP.HPTRIM.SDK.TrimEvent.EventDate
get

Gets the date and time that this event was generated.

Events HP.HPTRIM.SDK.TrimEvent.EventType
get

Gets the Events enumeration value that indicates what type of event occurred.

string HP.HPTRIM.SDK.TrimEvent.ExtraDetails
get

Gets a string which details any extra information pertinent to the event. What is contained in this property is largely dependent on the type of event.

string HP.HPTRIM.SDK.TrimEvent.FromMachine
get

Gets the name of the computer that generated the event.

int HP.HPTRIM.SDK.TrimEvent.FromTimeZone
get

Gets the time zone that the user generating the event was working in. This is the number of minutes from GMT, with a positive number indicating a time zone ahead of GMT. For example Australian Eastern Standard Time = 600, US Pacific Time = -480.

string HP.HPTRIM.SDK.TrimEvent.LoginName
get

Gets a string indicating the login name used by the user generating this event.

TrimURI HP.HPTRIM.SDK.TrimEvent.LoginUri
get

Gets unique identifier of the TRIM Location representing the user who generated this event.

BaseObjectTypes HP.HPTRIM.SDK.TrimEvent.ObjectType
get

Gets the BaseObjectTypes enumeration which identifies which TRIM object the event occurred to. Most events in TRIM are related to a particular TRIM object.

TrimURI HP.HPTRIM.SDK.TrimEvent.ObjectUri
get

Gets the unique identifier of the TRIM object that the event occurred to. Most events in TRIM are related to a particular TRIM object.

BaseObjectTypes HP.HPTRIM.SDK.TrimEvent.RelatedObjectType
get

Gets the BaseObjectTypes enumeration which identifies a related TRIM object that is relevant to this event. (For example, if the Assignee of a record is changed, the ObjectType will be a Record, the RelatedObjectType could be a Location.)

TrimURI HP.HPTRIM.SDK.TrimEvent.RelatedObjectUri
get

Gets the unique identifier of a related TRIM object that is relevant to this event. (For example, if the Assignee of a record is changed, the ObjectUri will be the Record's uri, the RelatedObjectUri could be the Uri of a Location representing the new Assignee.)