Class PluginDiagnosticReference
Namespace: DotBoxD.Plugins.Runtime.Diagnostics
Assembly: DotBoxD.Plugins.dll
Public reference entry for a single runtime plugin diagnostic
DotBoxD.Kernels.Model.SandboxDiagnostic.Code emitted by the DotBoxD.Plugins package.
public sealed record PluginDiagnosticReference : IEquatable<PluginDiagnosticReference>Inheritance
Section titled “Inheritance”object ← PluginDiagnosticReference
Implements
Section titled “Implements”IEquatable<PluginDiagnosticReference>
Inherited Members
Section titled “Inherited Members”object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()
Constructors
Section titled “Constructors”PluginDiagnosticReference(string, PluginDiagnosticPhase, PluginDiagnosticAudience, string, string, string)
Section titled “ PluginDiagnosticReference(string, PluginDiagnosticPhase, PluginDiagnosticAudience, string, string, string)”Public reference entry for a single runtime plugin diagnostic
DotBoxD.Kernels.Model.SandboxDiagnostic.Code emitted by the DotBoxD.Plugins package.
public PluginDiagnosticReference(string Code, PluginDiagnosticPhase Phase, PluginDiagnosticAudience Audience, string Meaning, string LikelyCause, string Remediation)Parameters
Section titled “Parameters”Code string
The stable DBXK* diagnostic code.
Phase PluginDiagnosticPhase
The runtime phase that emits the code.
Audience PluginDiagnosticAudience
Who must act on the diagnostic.
Meaning string
A short human-readable description of the rule that was violated.
LikelyCause string
The most common reason this code is emitted.
Remediation string
Guidance for the plugin author or host operator investigating the code.
Properties
Section titled “Properties”Audience
Section titled “ Audience”Who must act on the diagnostic.
public PluginDiagnosticAudience Audience { get; init; }Property Value
Section titled “Property Value”The stable DBXK* diagnostic code.
public string Code { get; init; }Property Value
Section titled “Property Value”LikelyCause
Section titled “ LikelyCause”The most common reason this code is emitted.
public string LikelyCause { get; init; }Property Value
Section titled “Property Value”Meaning
Section titled “ Meaning”A short human-readable description of the rule that was violated.
public string Meaning { get; init; }Property Value
Section titled “Property Value”The runtime phase that emits the code.
public PluginDiagnosticPhase Phase { get; init; }Property Value
Section titled “Property Value”Remediation
Section titled “ Remediation”Guidance for the plugin author or host operator investigating the code.
public string Remediation { get; init; }