LaunchBoxContributors
On this page

Diagnostic14.1

Class in Unbroken.LaunchBox.Plugins.Models.Diagnostics

C#
public sealed class Diagnostic
Describes a technical diagnostic associated with a plugin operation or game.

Constructors

  • DiagnosticInitializes a new instance of the Diagnostic class.

Diagnostic

C#
public Diagnostic(
    string code,
    DiagnosticSeverity severity,
    string logMessage,
    string? gameId = null
)
Initializes a new instance of the Diagnostic class.
code
The stable provider-defined diagnostic code.
severity
The diagnostic severity.
logMessage
The nonblank literal diagnostic detail for logs. Use Diagnostic.Help for user-facing guidance.
gameId
The related provider-local game ID, or null.

Properties

  • CodeGets the stable provider-defined diagnostic code.
  • GameIdGets the related provider-local game ID, if any.
  • HelpGets optional localizable user-facing guidance and a help link associated with this diagnostic.
  • LogMessageGets literal diagnostic detail for logs. This text is not localized or intended for direct UI display.
  • SeverityGets the diagnostic severity.

Code

C#
public string Code { get; }
Gets the stable provider-defined diagnostic code.

GameId

C#
public string? GameId { get; }
Gets the related provider-local game ID, if any.

Help

C#
public DiagnosticHelp? Help { get; init; }
Gets optional localizable user-facing guidance and a help link associated with this diagnostic.

LogMessage

C#
public string LogMessage { get; }
Gets literal diagnostic detail for logs. This text is not localized or intended for direct UI display.

Severity

C#
public DiagnosticSeverity Severity { get; }
Gets the diagnostic severity.