Files
EnvelopeGenerator/EnvelopeGenerator.Application/Envelopes/Queries/Read/ReadEnvelopeResponse.cs

70 lines
2.0 KiB
C#

using EnvelopeGenerator.Domain;
namespace EnvelopeGenerator.Application.Envelopes.Queries.Read;
/// <summary>
/// Repräsentiert die Antwort für das Lesen eines Umschlags.
/// </summary>
public record ReadEnvelopeResponse
{
/// <summary>
/// Die eindeutige Kennung des Umschlags.
/// </summary>
public int Id { get; init; }
/// <summary>
/// Die Kennung des Benutzers, der den Umschlag erstellt hat.
/// </summary>
public int UserId { get; init; }
/// <summary>
/// Der Status des Umschlags als numerischer Wert.
/// </summary>
public int Status { get; init; }
/// <summary>
/// Die universelle eindeutige Kennung (UUID) des Umschlags.
/// </summary>
public string Uuid { get; init; } = default!;
/// <summary>
/// Eine optionale Nachricht, die mit dem Umschlag verknüpft ist.
/// </summary>
public string? Message { get; init; }
/// <summary>
/// Das Datum und die Uhrzeit, wann der Umschlag hinzugefügt wurde.
/// </summary>
public DateTime AddedWhen { get; init; }
/// <summary>
/// Das Datum und die Uhrzeit, wann der Umschlag zuletzt geändert wurde (falls vorhanden).
/// </summary>
public DateTime? ChangedWhen { get; init; }
/// <summary>
/// Ein optionaler Titel des Umschlags.
/// </summary>
public string? Title { get; init; }
/// <summary>
/// Die Sprache, die mit dem Umschlag verknüpft ist.
/// </summary>
public string Language { get; init; } = default!;
/// <summary>
/// Gibt an, ob die Zwei-Faktor-Authentifizierung (TFA) aktiviert ist.
/// </summary>
public bool TFAEnabled { get; init; }
/// <summary>
/// Das Benutzerobjekt, das mit dem Umschlag verknüpft ist.
/// </summary>
public DigitalData.UserManager.Domain.Entities.User User { get; init; } = default!;
/// <summary>
/// Gibt den Namen des Status zurück, der dem numerischen Statuswert entspricht.
/// </summary>
public string StatusName => ((Constants.EnvelopeStatus)Status).ToString();
}