Class SerenityRecipeImportFlow

What the Project Recipe importer window does when its buttons are pressed: validate, dry-run, or import the chosen recipe file, keeping the last report for the window to draw. An import is never run straight from its button: the button resolves the plan and stages it behind an in-window confirmation that shows the plan's counts and the assets it writes, and the confirmation runs the import only if the plan is still the one that was shown.

Inheritance

object

SerenityRecipeImportFlow

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Namespace: Serenity.ProjectRecipe.Infrastructure.Editor

Assembly: Serenity.UnityProjectRecipe.Infrastructure.Editor.dll

Syntax

public sealed class SerenityRecipeImportFlow

Constructors

SerenityRecipeImportFlow()

Declaration

public SerenityRecipeImportFlow()

Properties

Notice

The notice the window shows above its report.

Declaration

public SerenityWizardInlineNotice Notice { get; }

Property Value

Type	Description
SerenityWizardInlineNotice

OutputRootOverride

An output root that overrides the recipe's own; empty uses the recipe's.

Declaration

public string OutputRootOverride { get; set; }

Property Value

Type	Description
string

PendingImport

The import waiting for the author's confirmation.

Declaration

public SerenityWizardPendingConfirmation PendingImport { get; }

Property Value

Type	Description
SerenityWizardPendingConfirmation

RecipePath

The recipe file to run.

Declaration

public string RecipePath { get; set; }

Property Value

Type	Description
string

Report

The last run's report, or null before the first run.

Declaration

public SerenityRecipeReport Report { get; }

Property Value

Type	Description
SerenityRecipeReport

Methods

DryRun()

Resolves what an import would do without writing.

Declaration

public void DryRun()

RequestImport()

Resolves the import's plan and stages it behind the in-window confirmation; writes nothing.

Declaration

public void RequestImport()

Validate()

Validates the recipe without writing.

Declaration

public void Validate()