Table of Contents

Class MediaBlocksDiagnostic

Namespace
VisioForge.Core.MediaBlocks.Serialization
Assembly
VisioForge.Core.dll

A single diagnostic produced while loading, migrating or validating a Media Blocks JSON document. Diagnostics identify the exact entity they refer to through optional identifiers.

public class MediaBlocksDiagnostic

Inheritance

Inherited Members

Constructors

MediaBlocksDiagnostic(MediaBlocksDiagnosticSeverity, string, string, Guid?, string)

Initializes a new instance of the VisioForge.Core.MediaBlocks.Serialization.MediaBlocksDiagnostic class.

public MediaBlocksDiagnostic(MediaBlocksDiagnosticSeverity severity, string code, string message, Guid? blockId = null, string padId = null)

Parameters

severity MediaBlocksDiagnosticSeverity

The diagnostic severity.

code string

A stable machine-readable diagnostic code, for example MBS001.

message string

A user-facing English explanation.

blockId Guid?

The identifier of the related block, when applicable.

padId string

The identifier of the related pad, when applicable.

Properties

BlockId

Gets the identifier of the related block, or null when the diagnostic is not block-specific.

public Guid? BlockId { get; }

Property Value

Guid?

Code

Gets the stable machine-readable diagnostic code.

public string Code { get; }

Property Value

string

Message

Gets the user-facing English explanation.

public string Message { get; }

Property Value

string

PadId

Gets the identifier of the related pad, or null when the diagnostic is not pad-specific.

public string PadId { get; }

Property Value

string

Severity

Gets the diagnostic severity.

public MediaBlocksDiagnosticSeverity Severity { get; }

Property Value

MediaBlocksDiagnosticSeverity

Methods

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.