Class AuditService

Namespace

Dynamicweb.Auditing

Assembly

Dynamicweb.Core.dll

Provides methods for querying and persisting audit information.

public class AuditService

Inheritance

object

AuditService

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Disabled

Gets or sets possibility to add audit event.

public virtual bool Disabled { get; set; }

Property Value

bool

Methods

CountByQuery(AuditQuery)

Get audit events list by query

public virtual int CountByQuery(AuditQuery query)

Parameters

query AuditQuery

Returns

int

Delete(int)

Delete audit event by identifier

public virtual bool Delete(int autoId)

Parameters

autoId int

Returns

bool

DeleteByQuery(AuditQuery)

Delete audit events by query

public virtual int DeleteByQuery(AuditQuery query)

Parameters

query AuditQuery

Returns

int

GetById(int)

Gets audit event by identifier

public virtual Audit? GetById(int autoId)

Parameters

autoId int

Returns

Audit

GetByIds(IEnumerable<int>)

Gets audits events by identifiers

public virtual IEnumerable<Audit> GetByIds(IEnumerable<int> autoIds)

Parameters

autoIds IEnumerable<int>

Returns

IEnumerable<Audit>

GetByIds(IEnumerable<int>, AuditQuery)

Gets audits events by identifiers

public virtual IEnumerable<Audit> GetByIds(IEnumerable<int> autoIds, AuditQuery additionalQuery)

Parameters

autoIds IEnumerable<int>

additionalQuery AuditQuery

Returns

IEnumerable<Audit>

GetByQuery(AuditQuery)

Get audit events list by query

public virtual IEnumerable<Audit> GetByQuery(AuditQuery query)

Parameters

query AuditQuery

Returns

IEnumerable<Audit>

GetDetails(Audit)

Get all audit details by audit identifier

public virtual IEnumerable<AuditDetail> GetDetails(Audit auditEvent)

Parameters

auditEvent Audit

Returns

IEnumerable<AuditDetail>

GetDetails(IEnumerable<Audit>)

Get audits details by audits identifiers

public virtual IEnumerable<AuditDetail> GetDetails(IEnumerable<Audit> auditEvents)

Parameters

auditEvents IEnumerable<Audit>

Returns

IEnumerable<AuditDetail>

GetUniqueActions(AuditQuery)

Get unique event actions by query

public virtual IEnumerable<string> GetUniqueActions(AuditQuery query)

Parameters

query AuditQuery

Returns

IEnumerable<string>

GetUniqueTypes(AuditQuery)

Get unique event types by query

public virtual IEnumerable<string> GetUniqueTypes(AuditQuery query)

Parameters

query AuditQuery

Returns

IEnumerable<string>

HasAnyAudits()

public virtual bool HasAnyAudits()

Returns

bool

MoveAudits(IEnumerable<AuditMoveSetting>)

public virtual void MoveAudits(IEnumerable<AuditMoveSetting> auditsMoveSettings)

Parameters

auditsMoveSettings IEnumerable<AuditMoveSetting>

Save(Audit)

Add new audit event

public virtual void Save(Audit audit)

Parameters

audit Audit

The audit event

Save(Audit, IEnumerable<AuditDetail>)

Add new audit event if it is new and create audit details for it.

public virtual void Save(Audit audit, IEnumerable<AuditDetail> details)

Parameters

audit Audit

The audit

details IEnumerable<AuditDetail>

List of the audit details

Save(Audit, string)

Add new audit event about deleted object.

public virtual void Save(Audit audit, string deletedObjectInfo)

Parameters

audit Audit

The audit

deletedObjectInfo string

Information about deleted object

Remarks

Use this method to inform that audited object has been deleted