Skip to content
ConsoleMonster

API Reference

Class

PhasesHandle

Edit on GitHub
Namespace ConsoleMonster.Widgets
Assembly ConsoleMonster
Source PhasesHandle.cs:10
Base LiveHandle
Modifiers sealed

Thread-safe live handle for a Phases widget.

Inheritance

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.

Returned or exposed by 1

Constructors

public PhasesHandle(ILiveDispatcher dispatcher, String target) #
PhasesHandle.cs:10

Creates a handle.

Parameters

dispatcher ConsoleMonster.Live.ILiveDispatcher requiredposition: 0
The dispatcher.
target System.String requiredposition: 1
The phases name.

Methods

public Void Complete(String key, StatusKind status = Pass, String? detail = null) #
PhasesHandle.cs:21
Returns: Void

Finishes a phase.

Parameters

key System.String requiredposition: 0
The phase.
status ConsoleMonster.Styling.StatusKind = Pass optionalposition: 1
The final status.
detail System.String? = null optionalposition: 2
A detail (default: the measured duration).
public Void Detail(String key, String detail) #
PhasesHandle.cs:26
Returns: Void

Sets a phase's detail (for example a percentage).

Parameters

key System.String requiredposition: 0
The phase.
detail System.String requiredposition: 1
The detail.
public Void Start(String key) #
PhasesHandle.cs:15
Returns: Void

Marks a phase as running (its duration is measured until the next state change).

Parameters

key System.String requiredposition: 0
The phase.