AuditTrailServiceBase.BeginSessionAudit(Session, AuditTrailStrategy, ObjectAuditingMode) Method

Starts auditing object changes made within the specified session.

Namespace: DevExpress.Persistent.BaseImpl.AuditTrail.Services

Assembly: DevExpress.Persistent.BaseImpl.Xpo.v24.1.dll

NuGet Package: DevExpress.Persistent.BaseImpl.Xpo

Declaration

C#

public ObjectAuditProcessor BeginSessionAudit(
    Session session,
    AuditTrailStrategy strategy,
    ObjectAuditingMode auditingMode
)

VB.NET

Public Function BeginSessionAudit(
    session As Session,
    strategy As AuditTrailStrategy,
    auditingMode As ObjectAuditingMode
) As ObjectAuditProcessor

Parameters

Name	Type	Description
session	Session	The Session to be audited.
strategy	DevExpress.Persistent.AuditTrail.AuditTrailStrategy	The AuditTrailStrategy value.
auditingMode	DevExpress.Persistent.AuditTrail.ObjectAuditingMode	The ObjectAuditingMode value that is the object auditing mode. The default value is Full.

Returns

Type	Description
DevExpress.Persistent.AuditTrail.ObjectAuditProcessor	A processor that the Audit Trail Module uses for the specified auditingMode.

Remarks

Note

If you want to disable and enable the Audit Trail Module for a particular scenario, use solutions from the following help topic: Disable the Audit Trail Module.

The following code sample demonstrates how to call this method:

C# (.NET)

using DevExpress.ExpressApp;
using DevExpress.Persistent.AuditTrail;
using DevExpress.Xpo;
using Microsoft.Extensions.DependencyInjection;
// ...
public partial class MyController : ViewController {
    protected override void OnActivated() {
        base.OnActivated();
        var auditTrailService = Application.ServiceProvider.GetRequiredService<AuditTrailService>();
        Session session = ((XPObjectSpace)ObjectSpace).Session;
        auditTrailService.EndSessionAudit(session);
        // ...
        auditTrailService.BeginSessionAudit(session, 
            AuditTrailStrategy.OnObjectChanged, ObjectAuditingMode.Lightweight);
    }
    // ...
}

C# (.NET Framework)

using DevExpress.ExpressApp;
using DevExpress.Persistent.AuditTrail;
using DevExpress.Xpo;
// ...
public partial class MyController : ViewController {
    protected override void OnActivated() {
        base.OnActivated();
        Session session = ((XPObjectSpace)ObjectSpace).Session;
        AuditTrailService.Instance.EndSessionAudit(session);
        // ...
        AuditTrailService.Instance.BeginSessionAudit(session, 
            AuditTrailStrategy.OnObjectChanged, ObjectAuditingMode.Lightweight);
    }
    // ...
}