Table of Contents

Interface ISessionAudit

Namespace
XENBIT.ResQueServe.Abstractions.Interfaces
Assembly
RQS.Abstractions.dll

Structure for session audit records in the ResQueServe system. This interface captures who performed an action, what action was taken, on which entity, and additional contextual information related to the audit event.

public interface ISessionAudit

Properties

Action

Gets the type of action performed on the entity (Create, Update, Delete).

AuditAction Action { get; init; }

Property Value

AuditAction

ActionSub

Gets the type of sub action performed on the entity (e.g. dispatch, status change ...).

AuditActionSub? ActionSub { get; init; }

Property Value

AuditActionSub?

ChangedProperties

Gets a dictionary of property names and their new values after the action.

IDictionary<string, string>? ChangedProperties { get; init; }

Property Value

IDictionary<string, string>

Details

Gets the details when the audited action occurred.

IEnumerable<ISessionAuditKeyValueDetail>? Details { get; init; }

Property Value

IEnumerable<ISessionAuditKeyValueDetail>

EntityId

Gets the unique identifier of the specific entity instance that was affected.

object EntityId { get; init; }

Property Value

object

EntityIdType

Gets the type of entity affected by the audit action.

AuditEntityIdType EntityIdType { get; init; }

Property Value

AuditEntityIdType

Id

Guid Id { get; init; }

Property Value

Guid

Text

Gets the text which could contain additional information's (optional).

string? Text { get; init; }

Property Value

string

Timestamp

Gets the date and time when the audited action occurred.

DateTimeOffset Timestamp { get; init; }

Property Value

DateTimeOffset

User

Gets information about the user who performed the audited action.

IUserInfo? User { get; init; }

Property Value

IUserInfo

Version

Gets the platform version with audit entry was created.

string Version { get; init; }

Property Value

string

Methods

Cook(IStringLocalizer)

Returns a user-friendly protocol styled text.

string Cook(IStringLocalizer localizer)

Parameters

localizer IStringLocalizer

Returns

string