View Source

Interface IAuditService

Represents a service for handling audit.

Namespace: Umbraco.Cms.Core.Services

Assembly: Umbraco.Core.dll

Syntax

public interface IAuditService : IService

Methods

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

CleanLogs(Int32)

Declaration

void CleanLogs(int maximumAgeOfLogsInMinutes)

Parameters

Type	Name	Description
System.Int32	maximumAgeOfLogsInMinutes

GetItemsByKeyAsync(Guid, UmbracoObjectTypes, Int32, Int32, Direction, Nullable<DateTimeOffset>, AuditType[])

Returns paged items in the audit trail for a given entity

Declaration

virtual Task<PagedModel<IAuditItem>> GetItemsByKeyAsync(Guid entityKey, UmbracoObjectTypes entityType, int skip, int take, Direction orderDirection = Direction.Descending, DateTimeOffset? sinceDate = null, AuditType[] auditTypeFilter = null)

Parameters

Type	Name	Description
Guid	entityKey	The key of the entity
UmbracoObjectTypes	entityType	The entity type
System.Int32	skip	The amount of audit trail entries to skip
System.Int32	take	The amount of audit trail entries to take
Direction	orderDirection	By default this will always be ordered descending (newest first)
System.Nullable<DateTimeOffset>	sinceDate	If populated, will only return entries after this time.
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

Returns

Type	Description
Task<PagedModel<IAuditItem>>

GetLogs(Int32)

Declaration

IEnumerable<IAuditItem> GetLogs(int objectId)

Parameters

Type	Name	Description
System.Int32	objectId

Returns

Type	Description
IEnumerable<IAuditItem>

GetLogs(AuditType, Nullable<DateTime>)

Declaration

IEnumerable<IAuditItem> GetLogs(AuditType type, DateTime? sinceDate = null)

Parameters

Type	Name	Description
AuditType	type
System.Nullable<DateTime>	sinceDate

Returns

Type	Description
IEnumerable<IAuditItem>

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
IEnumerable<IAuditItem>

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
IEnumerable<IAuditItem>

GetPagedItemsByUserAsync(Guid, Int32, Int32, Direction, AuditType[], Nullable<DateTime>)

Returns paged items in the audit trail for a given user

Declaration

virtual Task<PagedModel<IAuditItem>> GetPagedItemsByUserAsync(Guid userKey, int skip, int take, Direction orderDirection = Direction.Descending, AuditType[] auditTypeFilter = null, DateTime? sinceDate = null)

Parameters

Type	Name	Description
Guid	userKey
System.Int32	skip
System.Int32	take
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
System.Nullable<DateTime>	sinceDate

Returns

Type	Description
Task<PagedModel<IAuditItem>>

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<DateTime>	sinceDate

Returns

Type	Description
IEnumerable<IAuditItem>

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.
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