LoggingAliases Class

Summary

Contains functionality related to logging.
Namespace
Cake.Common.Diagnostics
Base Types
  • object
graph BT Type-->Base0["object"] Type["LoggingAliases"] class Type type-node

Syntax

[CakeAliasCategory("Logging")]
public static class LoggingAliases

Attributes

Type Description
CakeAliasCategoryAttribute An attribute used for documentation of alias methods/properties.

Methods

Name Value Summary
Debug(ICakeContext, LogAction) void
Writes a debug message to the log using the specified log message action. Evaluation message only if verbosity same or more verbose.
static
Debug(ICakeContext, object) void
Writes a debug message to the log using the specified value.
static
Debug(ICakeContext, string, object[]) void
Writes a debug message to the log using the specified format information.
static
Debug(ICakeContext, string) void
Writes a debug message to the log using the specified string value.
static
DiagnosticVerbosity(ICakeContext) IDisposable
Sets the log verbosity to diagnostic and returns a disposable that restores the log verbosity on dispose.
static
Error(ICakeContext, LogAction) void
Writes an error message to the log using the specified log message action. Evaluation message only if verbosity same or more verbose.
static
Error(ICakeContext, object) void
Writes an error message to the log using the specified value.
static
Error(ICakeContext, string, object[]) void
Writes an error message to the log using the specified format information.
static
Error(ICakeContext, string) void
Writes an error message to the log using the specified string value.
static
Information(ICakeContext, LogAction) void
Writes an informational message to the log using the specified log message action. Evaluation message only if verbosity same or more verbose.
static
Information(ICakeContext, object) void
Writes an informational message to the log using the specified value.
static
Information(ICakeContext, string, object[]) void
Writes an informational message to the log using the specified format information.
static
Information(ICakeContext, string) void
Writes an informational message to the log using the specified string value.
static
MinimalVerbosity(ICakeContext) IDisposable
Sets the log verbosity to minimal and returns a disposable that restores the log verbosity on dispose.
static
NormalVerbosity(ICakeContext) IDisposable
Sets the log verbosity to normal and returns a disposable that restores the log verbosity on dispose.
static
QuietVerbosity(ICakeContext) IDisposable
Sets the log verbosity to quiet and returns a disposable that restores the log verbosity on dispose.
static
Verbose(ICakeContext, LogAction) void
Writes a verbose message to the log using the specified log message action. Evaluation message only if verbosity same or more verbose.
static
Verbose(ICakeContext, object) void
Writes a verbose message to the log using the specified value.
static
Verbose(ICakeContext, string, object[]) void
Writes a verbose message to the log using the specified format information.
static
Verbose(ICakeContext, string) void
Writes a verbose message to the log using the specified string value.
static
VerboseVerbosity(ICakeContext) IDisposable
Sets the log verbosity to verbose and returns a disposable that restores the log verbosity on dispose.
static
Warning(ICakeContext, LogAction) void
Writes a warning message to the log using the specified log message action. Evaluation message only if verbosity same or more verbose.
static
Warning(ICakeContext, object) void
Writes an warning message to the log using the specified value.
static
Warning(ICakeContext, string, object[]) void
Writes a warning message to the log using the specified format information.
static
Warning(ICakeContext, string) void
Writes an warning message to the log using the specified string value.
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin