Class BotBrainLogger

An ILogger class which logs to bot brain's forwarder.

Inheritance

object

BotBrainLogger

BotBrainUILogger

Implements

ILogger

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Phoenix.BotBrain.Logging

Assembly: Phoenix.Plugin.BotBrain.Logging.dll

Syntax

public class BotBrainLogger : ILogger

Remarks

Initializes a new instance of the BotBrainUILogger class.

Constructors

BotBrainLogger(BotBrainLogForwarder?)

An ILogger class which logs to bot brain's forwarder.

Declaration

public BotBrainLogger(BotBrainLogForwarder? logForwarder = null)

Parameters

Type	Name	Description
BotBrainLogForwarder	logForwarder	The log forwarder.

Remarks

Initializes a new instance of the BotBrainUILogger class.

Methods

BeginScope<TState>(TState)

Begins a logical operation scope.

Declaration

public IDisposable BeginScope<TState>(TState state) where TState : notnull

Parameters

Type	Name	Description
TState	state	The identifier for the scope.

Returns

Type	Description
IDisposable	An IDisposable that ends the logical operation scope on dispose.

Type Parameters

Name	Description
TState	The type of the state to begin scope for.

IsEnabled(LogLevel)

Checks if the given logLevel is enabled.

Declaration

public bool IsEnabled(LogLevel logLevel)

Parameters

Type	Name	Description
LogLevel	logLevel	Level to be checked.

Returns

Type	Description
bool	true if enabled.

Log<TState>(LogLevel, EventId, TState, Exception?, Func<TState, Exception, string>)

Writes a log entry.

Declaration

public virtual void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception? exception, Func<TState, Exception, string> formatter)

Parameters

Type	Name	Description
LogLevel	logLevel	Entry will be written on this level.
EventId	eventId	Id of the event.
TState	state	The entry to be written. Can be also an object.
Exception	exception	The exception related to this entry.
Func<TState, Exception, string>	formatter	Function to create a string message of the state and exception.

Type Parameters

Name	Description
TState	The type of the object to be written.

Implements

ILogger

Extension Methods

ILoggerExtensions.LogEventDebug(ILogger, LogEventArgs, EventId?, Exception?)

ILoggerExtensions.LogEventError(ILogger, LogEventArgs, EventId?, Exception?)

ILoggerExtensions.LogEventInformation(ILogger, LogEventArgs, EventId?, Exception?)

ILoggerExtensions.LogEventWarning(ILogger, LogEventArgs, EventId?, Exception?)