Domain Detective

API Reference

Class

InternalLogger

Namespace DomainDetective
Assembly DomainDetective

Internal logger that allows to write to console, error or wherever else is needed

Inheritance

  • Object
  • InternalLogger

Remarks

Consumers subscribe to events to integrate logging with other systems while optional console output aids troubleshooting during development.

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters

Constructors

public InternalLogger(Boolean isVerbose = false) #

Initialize logger

Parameters

isVerbose System.Boolean = false optionalposition: 0

Methods

public Void ClearLoggedMessages() #
Returns: Void

Clears cached messages to allow duplicates to be logged again.

public Void WriteDebug(String message, params Object[] args) #
Returns: Void

Executes the write debug operation.

Parameters

message System.String requiredposition: 0
args System.Object[] requiredposition: 1
WriteError 2 overloads
public Void WriteError(String message) #
Returns: Void

Executes the write error operation.

Parameters

message System.String requiredposition: 0
public Void WriteError(String message, params Object[] args) #
Returns: Void

Executes the write error operation.

Parameters

message System.String requiredposition: 0
args System.Object[] requiredposition: 1
public Void WriteErrorCode(String code, String message, params Object[] args) #
Returns: Void

Writes an error with a structured code.

Parameters

code System.String requiredposition: 0
message System.String requiredposition: 1
args System.Object[] requiredposition: 2
public Void WriteInformation(String message, params Object[] args) #
Returns: Void

Executes the write information operation.

Parameters

message System.String requiredposition: 0
args System.Object[] requiredposition: 1
public Void WriteInformationCode(String code, String message, params Object[] args) #
Returns: Void

Writes an information message with a structured code.

Parameters

code System.String requiredposition: 0
message System.String requiredposition: 1
args System.Object[] requiredposition: 2
public Void WriteProgress(String activity, String currentOperation, Double percentCompleted, Nullable<Int32> currentSteps = null, Nullable<Int32> totalSteps = null) #
Returns: Void

Executes the write progress operation.

Parameters

activity System.String requiredposition: 0
currentOperation System.String requiredposition: 1
percentCompleted System.Double requiredposition: 2
currentSteps System.Nullable{System.Int32} = null optionalposition: 3
totalSteps System.Nullable{System.Int32} = null optionalposition: 4
WriteVerbose 2 overloads
public Void WriteVerbose(String message) #
Returns: Void

Executes the write verbose operation.

Parameters

message System.String requiredposition: 0
public Void WriteVerbose(String message, params Object[] args) #
Returns: Void

Executes the write verbose operation.

Parameters

message System.String requiredposition: 0
args System.Object[] requiredposition: 1
WriteWarning 2 overloads
public Void WriteWarning(String message) #
Returns: Void

Executes the write warning operation.

Parameters

message System.String requiredposition: 0
public Void WriteWarning(String message, params Object[] args) #
Returns: Void

Executes the write warning operation.

Parameters

message System.String requiredposition: 0
args System.Object[] requiredposition: 1
public Void WriteWarningCode(String code, String message, params Object[] args) #
Returns: Void

Writes a warning with a structured code.

Parameters

code System.String requiredposition: 0
message System.String requiredposition: 1
args System.Object[] requiredposition: 2

Properties

public Boolean IsVerbose { get; set; } #

If true, will write verbose messages to console

public Boolean IsError { get; set; } #

If true, will write error messages to console

public Boolean IsWarning { get; set; } #

If true, will write warning messages to console

public Boolean IsDebug { get; set; } #

If true, will write debug messages to console

public Boolean IsInformation { get; set; } #

If true, will write information messages to console

public Boolean IsProgress { get; set; } #

if true, will write progress messages to console

Events

public event EventHandler<LogEventArgs> OnVerboseMessage #

Define Verbose message event

public event EventHandler<LogEventArgs> OnWarningMessage #

Define Warning message event

public event EventHandler<LogEventArgs> OnErrorMessage #

Define Error message event

public event EventHandler<LogEventArgs> OnDebugMessage #

Define Debug message event

public event EventHandler<LogEventArgs> OnProgressMessage #

Define Progress message event

public event EventHandler<LogEventArgs> OnInformationMessage #

Define Information message event

{{ include "footer" }}