Class EventLogHelper

Namespace

CMS.EventLog

Assembly

CMS.EventLog.dll

Class for event helper methods

public class EventLogHelper : AbstractHelper<EventLogHelper>

Inheritance

object

AbstractHelper

AbstractHelper<EventLogHelper>

EventLogHelper

Inherited Members

AbstractHelper<EventLogHelper>.SetAsDefaultHelper()

AbstractHelper<EventLogHelper>.HelperObject

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

EventLogHelper()

public EventLogHelper()

Properties

LogEventsToFile

Indicates if events are logged to the file.

public static bool LogEventsToFile { get; set; }

Property Value

bool

LogEventsToFileInternal

Indicates if events are logged to the file.

protected virtual bool LogEventsToFileInternal { get; set; }

Property Value

bool

LogFile

Physical path to the log file.

public static string LogFile { get; }

Property Value

string

LogFileInternal

Physical path to the log file.

protected virtual string LogFileInternal { get; }

Property Value

string

LogFolder

Physical path to folder where log file is saved.

public static string LogFolder { get; set; }

Property Value

string

LogFolderInternal

Physical path to folder where log file is saved.

protected virtual string LogFolderInternal { get; set; }

Property Value

string

ReadOnlyModeProvider

Gets the read-only mode provider instance.

protected virtual IReadOnlyModeProvider ReadOnlyModeProvider { get; }

Property Value

IReadOnlyModeProvider

Methods

ClearEventLog(int, string, string)

Clears entire event log and writes new event record with information about this action and the user who performed it.

[Obsolete("The method is deprecated will be removed in a future version.")]
public static void ClearEventLog(int userId, string userName, string ipAddress)

Parameters

userId int

User ID for logging purposes

userName string

User name for logging purposes

ipAddress string

IP address for logging purposes

ClearEventLogInternal(int, string, string)

Clears entire event log and writes new event record with information about this action and the user who performed it.

protected virtual void ClearEventLogInternal(int userId, string userName, string ipAddress)

Parameters

userId int

User ID for logging purposes

userName string

User name for logging purposes

ipAddress string

IP address for logging purposes

LogDelete(GeneralizedInfo)

Logs deletion of an object.

[Obsolete("The method will be removed in a future version. Use IInfoObjectEventHandler to handle info object events and log custom messages using ILogger.")]
public static void LogDelete(GeneralizedInfo infoObj)

Parameters

infoObj GeneralizedInfo

Main info object

LogDeleteInternal(GeneralizedInfo)

Logs deletion of an object.

[Obsolete("The method will be removed in a future version. The logic has been moved to IInfoObjectEventHandler service. Customization can be done by registering a custom implementation of it.")]
protected virtual void LogDeleteInternal(GeneralizedInfo infoObj)

Parameters

infoObj GeneralizedInfo

Main info object

LogEventToFile(EventLogInfo)

Logs the log object to file.

public static void LogEventToFile(EventLogInfo eventLogInfo)

Parameters

eventLogInfo EventLogInfo

Event info object

LogEventToFileInternal(EventLogInfo)

Logs the log object to file.

protected virtual void LogEventToFileInternal(EventLogInfo eventLogInfo)

Parameters

eventLogInfo EventLogInfo

Event info object

LogInsert(GeneralizedInfo)

Logs insertion of an object.

[Obsolete("The method will be removed in a future version. Use IInfoObjectEventHandler to handle info object events and log custom messages using ILogger.")]
public static void LogInsert(GeneralizedInfo infoObj)

Parameters

infoObj GeneralizedInfo

Main info object

LogInsertInternal(GeneralizedInfo)

Logs insertion of an object.

[Obsolete("The method will be removed in a future version. The logic has been moved to IInfoObjectEventHandler service. Customization can be done by registering a custom implementation of it.")]
protected virtual void LogInsertInternal(GeneralizedInfo infoObj)

Parameters

infoObj GeneralizedInfo

Main info object

LogUpdate(GeneralizedInfo)

Logs update of an object.

[Obsolete("The method will be removed in a future version. Use IInfoObjectEventHandler to handle info object events and log custom messages using ILogger.")]
public static void LogUpdate(GeneralizedInfo infoObj)

Parameters

infoObj GeneralizedInfo

Main info object

LogUpdateInternal(GeneralizedInfo)

Logs update of an object.

[Obsolete("The method will be removed in a future version. The logic has been moved to IInfoObjectEventHandler service. Customization can be done by registering a custom implementation of it.")]
protected virtual void LogUpdateInternal(GeneralizedInfo infoObj)

Parameters

infoObj GeneralizedInfo

Main info object