View Source

Interface IAuditService

Represents a service for handling audit.

Namespace: Umbraco.Core.Services
Assembly: Umbraco.Core.dll
Syntax
public interface IAuditService : IService

Methods

View Source

Add(AuditType, Int32, Int32, String, String, String)

Declaration
void Add(AuditType type, int userId, int objectId, string entityType, string comment, string parameters = null)
Parameters
Type Name Description
AuditType type
System.Int32 userId
System.Int32 objectId
System.String entityType
System.String comment
System.String parameters
View Source

CleanLogs(Int32)

Declaration
void CleanLogs(int maximumAgeOfLogsInMinutes)
Parameters
Type Name Description
System.Int32 maximumAgeOfLogsInMinutes
View Source

GetLogs(Int32)

Declaration
IEnumerable<IAuditItem> GetLogs(int objectId)
Parameters
Type Name Description
System.Int32 objectId
Returns
Type Description
System.Collections.Generic.IEnumerable<IAuditItem>
View Source

GetLogs(AuditType, Nullable<DateTime>)

Declaration
IEnumerable<IAuditItem> GetLogs(AuditType type, DateTime? sinceDate = null)
Parameters
Type Name Description
AuditType type
System.Nullable<System.DateTime> sinceDate
Returns
Type Description
System.Collections.Generic.IEnumerable<IAuditItem>
View Source

GetPagedItemsByEntity(Int32, Int64, Int32, out Int64, Direction, AuditType[], IQuery<IAuditItem>)

Returns paged items in the audit trail for a given entity

Declaration
IEnumerable<IAuditItem> GetPagedItemsByEntity(int entityId, long pageIndex, int pageSize, out long totalRecords, Direction orderDirection = Direction.Descending, AuditType[] auditTypeFilter = null, IQuery<IAuditItem> customFilter = null)
Parameters
Type Name Description
System.Int32 entityId
System.Int64 pageIndex
System.Int32 pageSize
System.Int64 totalRecords
Direction orderDirection

By default this will always be ordered descending (newest first)
AuditType[] auditTypeFilter

Since we currently do not have enum support with our expression parser, we cannot query on AuditType in the query or the custom filter so we need to do that here
IQuery<IAuditItem> customFilter

Optional filter to be applied
Returns
Type Description
System.Collections.Generic.IEnumerable<IAuditItem>
View Source

GetPagedItemsByUser(Int32, Int64, Int32, out Int64, Direction, AuditType[], IQuery<IAuditItem>)

Returns paged items in the audit trail for a given user

Declaration
IEnumerable<IAuditItem> GetPagedItemsByUser(int userId, long pageIndex, int pageSize, out long totalRecords, Direction orderDirection = Direction.Descending, AuditType[] auditTypeFilter = null, IQuery<IAuditItem> customFilter = null)
Parameters
Type Name Description
System.Int32 userId
System.Int64 pageIndex
System.Int32 pageSize
System.Int64 totalRecords
Direction orderDirection

By default this will always be ordered descending (newest first)
AuditType[] auditTypeFilter

Since we currently do not have enum support with our expression parser, we cannot query on AuditType in the query or the custom filter so we need to do that here
IQuery<IAuditItem> customFilter

Optional filter to be applied
Returns
Type Description
System.Collections.Generic.IEnumerable<IAuditItem>
View Source

GetUserLogs(Int32, AuditType, Nullable<DateTime>)

Declaration
IEnumerable<IAuditItem> GetUserLogs(int userId, AuditType type, DateTime? sinceDate = null)
Parameters
Type Name Description
System.Int32 userId
AuditType type
System.Nullable<System.DateTime> sinceDate
Returns
Type Description
System.Collections.Generic.IEnumerable<IAuditItem>
View Source

Write(Int32, String, String, DateTime, Int32, String, String, String)

Writes an audit entry for an audited event.

Declaration
IAuditEntry Write(int performingUserId, string perfomingDetails, string performingIp, DateTime eventDateUtc, int affectedUserId, string affectedDetails, string eventType, string eventDetails)
Parameters
Type Name Description
System.Int32 performingUserId

The identifier of the user triggering the audited event.
System.String perfomingDetails

Free-form details about the user triggering the audited event.
System.String performingIp

The IP address or the request triggering the audited event.
System.DateTime eventDateUtc

The date and time of the audited event.
System.Int32 affectedUserId

The identifier of the user affected by the audited event.
System.String affectedDetails

Free-form details about the entity affected by the audited event.
System.String eventType

The type of the audited event - must contain only alphanumeric chars and hyphens with forward slashes separating categories. The eventType will generally be formatted like: {application}/{entity-type}/{category}/{sub-category} Example: umbraco/user/sign-in/failed

System.String eventDetails

Free-form details about the audited event.
Returns
Type Description
IAuditEntry