Class SerenityRecipeReport

Combined validation result and import report. Accumulates messages (info / warning / error / blocker), asset actions (created / updated / skipped), and deferred-section notices, and renders a readable summary for the console and the importer window.

Inheritance

object

SerenityRecipeReport

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Namespace: Serenity.ProjectRecipe.Infrastructure.Editor.Reporting

Assembly: Serenity.UnityProjectRecipe.Infrastructure.Editor.dll

Syntax

public sealed class SerenityRecipeReport

Constructors

SerenityRecipeReport()

Declaration

public SerenityRecipeReport()

Properties

Actions

Declaration

public IReadOnlyList<RecipeAssetAction> Actions { get; }

Property Value

Type	Description
IReadOnlyList<RecipeAssetAction>	All asset actions, in the order they were recorded.

HasBlockers

Declaration

public bool HasBlockers { get; }

Property Value

Type	Description
bool	True when at least one blocker was reported; no assets are imported in that case.

HasErrors

Declaration

public bool HasErrors { get; }

Property Value

Type	Description
bool	True when at least one error or blocker was reported.

Messages

Declaration

public IReadOnlyList<RecipeReportMessage> Messages { get; }

Property Value

Type	Description
IReadOnlyList<RecipeReportMessage>	All messages, in the order they were reported.

WasDryRun

Declaration

public bool WasDryRun { get; set; }

Property Value

Type	Description
bool	True when the run was a dry run (no assets were written).

WasValidateOnly

Declaration

public bool WasValidateOnly { get; set; }

Property Value

Type	Description
bool	True when the run only validated (no resolution of would-create/update outcomes).

Methods

Add(RecipeReportSeverity, string, string, string)

Adds a message of the given severity.

Declaration

public void Add(RecipeReportSeverity severity, string section, string itemId, string message)

Parameters

Type	Name	Description
RecipeReportSeverity	severity
string	section
string	itemId
string	message

Blocker(string, string, string)

Adds a blocker (no assets are imported in this run).

Declaration

public void Blocker(string section, string itemId, string message)

Parameters

Type	Name	Description
string	section
string	itemId
string	message

Count(RecipeAssetOutcome)

Counts asset actions of a given outcome.

Declaration

public int Count(RecipeAssetOutcome outcome)

Parameters

Type	Name	Description
RecipeAssetOutcome	outcome

Returns

Type	Description
int

Count(RecipeReportSeverity)

Counts messages of a given severity.

Declaration

public int Count(RecipeReportSeverity severity)

Parameters

Type	Name	Description
RecipeReportSeverity	severity

Returns

Type	Description
int

Error(string, string, string)

Adds an error (the related item is skipped; the run continues).

Declaration

public void Error(string section, string itemId, string message)

Parameters

Type	Name	Description
string	section
string	itemId
string	message

Info(string, string, string)

Adds an informational message.

Declaration

public void Info(string section, string itemId, string message)

Parameters

Type	Name	Description
string	section
string	itemId
string	message

MarkOutcome(RecipeAssetOutcome, string, string, string, string)

Records the outcome for a target asset.

Declaration

public void MarkOutcome(RecipeAssetOutcome outcome, string section, string id, string assetPath, string typeName)

Parameters

Type	Name	Description
RecipeAssetOutcome	outcome
string	section
string	id
string	assetPath
string	typeName

Summary()

Builds a one-line summary of counts.

Declaration

public string Summary()

Returns

Type	Description
string

ToConsoleString()

Renders the full report as a multi-line string suitable for the console.

Declaration

public string ToConsoleString()

Returns

Type	Description
string

ToJson()

Renders the report as machine-readable JSON for headless/agent consumption. Counts, flags, messages, and actions are projected into serializable DTOs with enums written as their string names (e.g. "Error", not 3) so an agent can read outcomes and per-item problems and self-correct.

Declaration

public string ToJson()

Returns

Type	Description
string	Pretty-printed JSON.

Warning(string, string, string)

Adds a warning.

Declaration

public void Warning(string section, string itemId, string message)

Parameters

Type	Name	Description
string	section
string	itemId
string	message