View Source

Interface IAuditEntry

Represents an audited event.

Namespace: Umbraco.Cms.Core.Models

Assembly: Umbraco.Core.dll

Syntax

public interface IAuditEntry : IEntity, IDeepCloneable, IRememberBeingDirty, ICanBeDirty

Remarks

The free-form details properties can be used to capture relevant infos (for example, a user email and identifier) at the time of the audited event, even though they may change later on - but we want to keep a track of their value at that time.

Depending on audit loggers, these properties can be purely free-form text, or contain json serialized objects.

Properties

AffectedDetails

Gets or sets free-form details about the entity affected by the audited event.

Declaration

string? AffectedDetails { get; set; }

Property Value

Type	Description
string

Remarks

The entity affected by the event can be another user, a member...

AffectedUserId

Gets or sets the identifier of the user affected by the audited event.

Declaration

int AffectedUserId { get; set; }

Property Value

Type	Description
int

Remarks

Not used when no single user is affected by the event.

AffectedUserKey

Gets or sets the key of the user affected by the audited event.

Declaration

Guid? AffectedUserKey { get; set; }

Property Value

Type	Description
Guid?

Remarks

Not used when no single user is affected by the event.

EventDate

Gets or sets the date and time of the audited event.

Declaration

DateTime EventDate { get; set; }

Property Value

Type	Description
DateTime

EventDetails

Gets or sets free-form details about the audited event.

Declaration

string? EventDetails { get; set; }

Property Value

Type	Description
string

EventType

Gets or sets the type of the audited event.

Declaration

string? EventType { get; set; }

Property Value

Type	Description
string

PerformingDetails

Gets or sets free-form details about the user triggering the audited event.

Declaration

string? PerformingDetails { get; set; }

Property Value

Type	Description
string

PerformingIp

Gets or sets the IP address or the request triggering the audited event.

Declaration

string? PerformingIp { get; set; }

Property Value

Type	Description
string

PerformingUserId

Gets or sets the identifier of the user triggering the audited event.

Declaration

int PerformingUserId { get; set; }

Property Value

Type	Description
int

PerformingUserKey

Gets or sets the key of the user triggering the audited event.

Declaration

Guid? PerformingUserKey { get; set; }

Property Value

Type	Description
Guid?