Skip to content
ConsoleMonster
Interface

IConsoleDashboard

ConsoleMonster.Hosting

Edit on GitHub
Namespace
ConsoleMonster.Hosting
Assembly
ConsoleMonster.Hosting
Source
ConsoleDashboardTracker.cs:66
Modifiers
abstract

The dashboard as the application sees it: report entries, write to its log, read the statuses.

Usage

Explore 1 API references to this type

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

Accepted by parameters 1

Methods

public abstract void Log(string message, string level = "info") #

Writes a line to the dashboard's log region while it shows (ignored otherwise; use ILogger for logs that always land).

Parameters

message string required
The message.
level string = "info" optional
info, warn, err, verbose, debug, pass or skip.
public abstract void SetDetail(string name, string? detail) #

Sets an entry's detail, keeping its state (adds it as running when new).

Parameters

name string required
The entry's name.
detail string? required
The detail, or null to clear it.
public abstract void SetStatus(string name, ServiceState state, string? detail = null) #

Sets an entry's state (added when new), with an optional detail.

Parameters

name string required
The entry's name.
state ConsoleMonster.Hosting.ServiceState required
The state.
detail string? = null optional
A detail, or null.
public abstract IReadOnlyList<ServiceStatus> Snapshot() #

The current statuses, in the order they were added.

Returns

IReadOnlyList<ServiceStatus> A copy of the statuses.

Properties

public abstract bool IsShown { get; } #

Whether the live dashboard is showing.