Class MessageDetail

Namespace

NuvTools.Common.ResultWrapper

Assembly

NuvTools.Common.dll

Represents a detailed message related to an operation result, such as informational, success, warning, or error messages.

public record MessageDetail : IEquatable<MessageDetail>

Inheritance

object

MessageDetail

Implements

IEquatable<MessageDetail>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectExtensions.Clone<T>(T, int)

ObjectExtensions.Serialize<T>(T, int)

ObjectExtensions.GetQueryString<T>(T, string?)

Validator.Validate<T>(T)

Examples

Example usage:

var message = new MessageDetail(
    Title: "Validation failed",
    Detail: "The email address format is invalid.",
    Code: "VAL001",
    Severity: Severity.Warning
);

Remarks

The MessageDetail record is typically used as part of a Result or Result<T> object to provide structured feedback about an operation. It allows developers to capture human-readable messages along with metadata such as message code and severity.

Constructors

MessageDetail(string, string?, string?, Severity?)

Represents a detailed message related to an operation result, such as informational, success, warning, or error messages.

public MessageDetail(string Title, string? Detail = null, string? Code = null, Severity? Severity = null)

Parameters

Title string

The short, human-readable message summarizing the event or result.

Detail string

An optional detailed description that provides more context or technical information about the message.

Code string

An optional identifier that uniquely represents the message type or category, useful for localization, logging, or client-side handling.

Severity Severity?

The severity level of the message (e.g., Information, Warning, Error).

Examples

Example usage:

var message = new MessageDetail(
    Title: "Validation failed",
    Detail: "The email address format is invalid.",
    Code: "VAL001",
    Severity: Severity.Warning
);

Remarks

The MessageDetail record is typically used as part of a Result or Result<T> object to provide structured feedback about an operation. It allows developers to capture human-readable messages along with metadata such as message code and severity.

Properties

Code

An optional identifier that uniquely represents the message type or category, useful for localization, logging, or client-side handling.

public string? Code { get; init; }

Property Value

string

Detail

An optional detailed description that provides more context or technical information about the message.

public string? Detail { get; init; }

Property Value

string

Severity

The severity level of the message (e.g., Information, Warning, Error).

public Severity? Severity { get; init; }

Property Value

Severity?

Title

The short, human-readable message summarizing the event or result.

public string Title { get; init; }

Property Value

string