AuditTrailService Members
The service that the Audit Trail Module uses to monitor object changes and log this information. In .NET Framework applications, you can use the static Instance property to access this service and customize its behavior. In .NET 6+ applications, use Dependency Injection to access this service.Properties
| Name | Description |
|---|---|
| Application | For internal use. |
| AuditDataStore | Inherited from AuditTrailServiceBase. |
| AuditTrailServiceRoot | |
| Instance static | Obsolete. Provides access to the instance of the AuditTrailService. Use this property in .NET Framework applications to access AuditTrailService settings. |
| IsAuditTrailXpoServicesRegistered static | |
| ObjectAuditingMode | Inherited from AuditTrailServiceBase. |
| ObjectAuditProcessorsFactory | Inherited from AuditTrailServiceBase. |
| Options | Inherited from AuditTrailServiceBase. |
| OptionsLegacy static | |
| SaveInAsyncMode | For internal use. |
| Settings | Inherited from AuditTrailServiceBase. |
| TimestampStrategy | Inherited from AuditTrailServiceBase. |
Methods
| Name | Description |
|---|---|
| AddCustomAuditData(Session, AuditDataItem) | Inherited from AuditTrailServiceBase. |
| ApplyOptions(AuditTrailOptions) static | |
| BeginObjectsAudit(Session, ObjectAuditingMode, Object[]) | Starts auditing the specified objects according to auditingMode. Inherited from AuditTrailServiceBase. |
| BeginObjectsAudit(Session, Object[]) | Starts auditing the specified objects in Full object auditing mode. Inherited from AuditTrailServiceBase. |
| BeginSessionAudit(Session, AuditTrailStrategy, ObjectAuditingMode) | Starts auditing object changes made within the specified session. Inherited from AuditTrailServiceBase. |
| BeginSessionAudit(Session, AuditTrailStrategy) | Starts auditing object changes made within the specified session. Inherited from AuditTrailServiceBase. |
| Dispose() | Inherited from AuditTrailServiceBase. |
| EndSessionAudit(Session) | Stops auditing object changes made within the specified session. Inherited from AuditTrailServiceBase. |
| Equals(Object, Object) static | Determines whether the specified object instances are considered equal. Inherited from Object. |
| Equals(Object) | Determines whether the specified object is equal to the current object. Inherited from Object. |
| GetHashCode() | Serves as the default hash function. Inherited from Object. |
| GetService(IServiceProvider) static | |
| GetStrategy(Session) | Gets the audit strategy for the specified session. Inherited from AuditTrailServiceBase. |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| IsSessionAudited(Session) | Indicates whether the Audit Trail Module audits object changes within the specified session. Inherited from AuditTrailServiceBase. |
| ListenToObjectSpace(XPObjectSpace) | Inherited from AuditTrailServiceBase. |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| SaveAuditData(Session) | Saves AuditDataItem objects to the database. Call this method when you add custom audit data to the log. Inherited from AuditTrailServiceBase. |
| SetXPDictionaries(IList<XPDictionary>) | Inherited from AuditTrailServiceBase. |
| SetXPDictionary(XPDictionary) | Inherited from AuditTrailServiceBase. |
| ToString() | Returns a string that represents the current object. Inherited from Object. |
Events
| Name | Description |
|---|---|
| CustomCreateObjectAuditProcessorsFactory | Inherited from AuditTrailServiceBase. |
| CustomizeAuditOperationTypeFilter | Occurs after a business object is changed and before the corresponding AuditDataItem object is saved. Inherited from AuditTrailServiceBase. |
| CustomizeAuditTrailSettings | This event is raised when an application’s setup is complete. Handle this event to use the default settings for the Audit Trail Module. Inherited from AuditTrailServiceBase. |
| CustomizeSessionAuditingOptions | For internal use. Inherited from AuditTrailServiceBase. |
| QueryCurrentUserName | Occurs before AuditDataItem objects are saved. Handle this event to get the current user name in applications that do not use the Security System. Inherited from AuditTrailServiceBase. |
| SaveAuditTrailData | Occurs before new AuditDataItem objects are saved to the database. Handle this event to configure how the Audit Trail Module saves information. Inherited from AuditTrailServiceBase. |
See Also