Class DocumentModel

Namespace

Cress.LivingDocs

Assembly

Cress.LivingDocs.dll

Top-level data shape passed to every living doc template.

public sealed record DocumentModel : IEquatable<DocumentModel>

Inheritance

object

DocumentModel

Implements

IEquatable<DocumentModel>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

DocumentModel(DocumentMeta, DocumentBranding, SuiteSummary, IReadOnlyList<FlowSummary>, RunMetrics?, IReadOnlyList<RunHistoryEntry>, IReadOnlyList<ScreenshotEvidence>, IReadOnlyList<DiagnosticEntry>)

Top-level data shape passed to every living doc template.

public DocumentModel(DocumentMeta Meta, DocumentBranding Branding, SuiteSummary Suite, IReadOnlyList<FlowSummary> Flows, RunMetrics? Metrics, IReadOnlyList<RunHistoryEntry> RecentRuns, IReadOnlyList<ScreenshotEvidence> Screenshots, IReadOnlyList<DiagnosticEntry> Diagnostics)

Parameters

Meta DocumentMeta

Branding DocumentBranding

Suite SuiteSummary

Flows IReadOnlyList<FlowSummary>

Metrics RunMetrics

RecentRuns IReadOnlyList<RunHistoryEntry>

Screenshots IReadOnlyList<ScreenshotEvidence>

Diagnostics IReadOnlyList<DiagnosticEntry>

Properties

Branding

public DocumentBranding Branding { get; init; }

Property Value

DocumentBranding

Diagnostics

public IReadOnlyList<DiagnosticEntry> Diagnostics { get; init; }

Property Value

IReadOnlyList<DiagnosticEntry>

Flows

public IReadOnlyList<FlowSummary> Flows { get; init; }

Property Value

IReadOnlyList<FlowSummary>

Meta

public DocumentMeta Meta { get; init; }

Property Value

DocumentMeta

Metrics

public RunMetrics? Metrics { get; init; }

Property Value

RunMetrics

RecentRuns

public IReadOnlyList<RunHistoryEntry> RecentRuns { get; init; }

Property Value

IReadOnlyList<RunHistoryEntry>

Screenshots

public IReadOnlyList<ScreenshotEvidence> Screenshots { get; init; }

Property Value

IReadOnlyList<ScreenshotEvidence>

Suite

public SuiteSummary Suite { get; init; }

Property Value

SuiteSummary