Archived
deploy webservice static-file routing for docsite folder URLs, per-instance step-cache db, and constant-height panel title bars.
This commit is contained in:
@@ -118,13 +118,68 @@ and invokes the handler synchronously on the caller's thread.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Common.Messages.MultiTagMessage.html">MultiTagMessage</a></dt>
|
||||
<dd><p>Represents a message with multiple tags for categorization and filtering.</p>
|
||||
<dt><a class="xref" href="Hi.Common.Messages.MessageCollector.html">MessageCollector</a></dt>
|
||||
<dd><p>A minimal <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress<T></a> of <a class="xref" href="Hi.Common.Messages.IMessage.html">IMessage</a> that buffers every
|
||||
reported message into <a class="xref" href="Hi.Common.Messages.MessageCollector.html#Hi_Common_Messages_MessageCollector_Messages">Messages</a>. Intended as a per-call / per-request
|
||||
sink: a caller injects it into a have-both function (one that takes an
|
||||
<code>IProgress<IMessage> messageProgress</code>), runs the operation, then reads the
|
||||
collected messages back — e.g. to return them in an HTTP response so a REST / AI
|
||||
caller sees progress, success, and error notifications inline.</p>
|
||||
<p>Unlike the session / strip sinks (<code>SessionProgress</code>, <code>StepDiagnosticProgress</code>) it
|
||||
fires no events and holds no session or pipeline state; it is cheap to create and
|
||||
discard for the lifetime of a single call.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Common.Messages.MultiTagMessageUtil.html">MultiTagMessageUtil</a></dt>
|
||||
<dd><p>Utility methods for working with IProgress implementations.</p>
|
||||
<dt><a class="xref" href="Hi.Common.Messages.MessageUtil.html">MessageUtil</a></dt>
|
||||
<dd><p>Extension helpers for reporting <a class="xref" href="Hi.Common.Messages.SimpleMessage.html">SimpleMessage</a> records onto an
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress<T></a> of <a class="xref" href="Hi.Common.Messages.IMessage.html">IMessage</a> sink — the <a class="xref" href="Hi.Common.Messages.IMessage.html">IMessage</a>-channel
|
||||
counterpart of <code>NcDiagnosticProgress</code>'s shorthand methods. Every helper is named
|
||||
<code>{Category}{Severity}</code> and is id-first; the structured <code>id</code> is used for
|
||||
filtering / suppression. All overloads are null-safe on <code>host</code>.</p>
|
||||
<p>
|
||||
Each helper has a <code>{Category}{Severity}Fmt</code> sibling taking a
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.formattablestring">FormattableString</a>: it keeps the interpolated template and values
|
||||
(<a class="xref" href="Hi.Common.Messages.SimpleMessage.html#Hi_Common_Messages_SimpleMessage_Format">Format</a> / <a class="xref" href="Hi.Common.Messages.SimpleMessage.html#Hi_Common_Messages_SimpleMessage_Args">Args</a>) so a client can
|
||||
re-render the message in another language, while the notification stays the invariant
|
||||
English rendering. The sibling must be opted into by name — an interpolated string literal
|
||||
passed to the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a> helper binds to <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a> and is not captured.
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Common.Messages.SimpleMessage.html">SimpleMessage</a></dt>
|
||||
<dd><p>A plain <a class="xref" href="Hi.Common.Messages.IMessage.html">IMessage</a> with no anchor: severity, category, id, notification text and
|
||||
optional detail. This is the default carrier for ad-hoc messages that have no other home.
|
||||
When step context is available, a step-anchored decorator wraps a <a class="xref" href="Hi.Common.Messages.SimpleMessage.html">SimpleMessage</a>
|
||||
to add the <code>StepIndex</code> / <code>SentenceCarrier</code> without the producer needing to know it.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<h3 id="interfaces">
|
||||
Interfaces
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Common.Messages.IMessage.html">IMessage</a></dt>
|
||||
<dd><p>Common contract for a single reportable item on an <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress<T></a>
|
||||
channel — an NC diagnostic, a step-anchored notice, a simple message, or a progress
|
||||
fraction. Consumers (GUI / log) treat every kind uniformly through this view, while each
|
||||
concrete kind is still stored by its own owner (e.g. <code>NcDiagnostic</code> by
|
||||
<code>NcDiagnosticProgress</code>, <code>ClStripPos</code> by <code>ClStrip</code>) rather than being mixed
|
||||
into one shared collection.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Common.Messages.IProgressMessage.html">IProgressMessage</a></dt>
|
||||
<dd><p>Marker for an <a class="xref" href="Hi.Common.Messages.IMessage.html">IMessage</a> that is itself a <b>container</b> of messages (a batch
|
||||
produced over the course of some scoped work) rather than a single leaf notice. A sink may give
|
||||
it special treatment — unrolling its accumulated children, in order, instead of storing the
|
||||
composite object itself.</p>
|
||||
<p>
|
||||
Empty by design: the contract is purely the marker. The children are exposed by the concrete
|
||||
type (e.g. <code>StepScopedProgress.MessageList</code>) and drained at the point that owns the
|
||||
ordering guarantee, so a consumer that does not recognize <a class="xref" href="Hi.Common.Messages.IProgressMessage.html">IProgressMessage</a> simply
|
||||
treats the composite as an opaque <a class="xref" href="Hi.Common.Messages.IMessage.html">IMessage</a>.
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<h3 id="enums">
|
||||
@@ -133,11 +188,27 @@ Enums
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Common.Messages.BootstrapTheme.html">BootstrapTheme</a></dt>
|
||||
<dd><p>Bootstrap theme colors for UI styling.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Common.Messages.Category.html">Category</a></dt>
|
||||
<dd><p>Classification of an <a class="xref" href="Hi.Common.Messages.IMessage.html">IMessage</a> — the “what kind of concern” axis, orthogonal to the
|
||||
<a class="xref" href="Hi.Common.Messages.Severity.html">Severity</a> importance axis it pairs with. Applies to every <a class="xref" href="Hi.Common.Messages.IMessage.html">IMessage</a> on
|
||||
the channel (lifecycle / progress notices, configuration checks, NC-pipeline diagnostics, …),
|
||||
not only NC messages.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Common.Messages.MessageFlag.html">MessageFlag</a></dt>
|
||||
<dd><p>Enumeration of common message types used for system notifications.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="Hi.Common.Messages.Severity.html">Severity</a></dt>
|
||||
<dd><p>Importance level of an <a class="xref" href="Hi.Common.Messages.IMessage.html">IMessage</a>. Combined with <a class="xref" href="Hi.Common.Messages.Category.html">Category</a> to form
|
||||
the full meaning (e.g. <code>Validation + Warning</code>). Promoted from the former
|
||||
<code>NcDiagnosticSeverity</code> so non-NC messages (simple notices, progress fractions) share a
|
||||
single scale.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<h3 id="delegates">
|
||||
|
||||
Reference in New Issue
Block a user