Skip to content

Class MoveReport

Namespace: Apogee.Content.Assets
Assembly: Apogee.Content.dll

What did, or in a preview would do.

public sealed record MoveReport : IEquatable<MoveReport>

Inheritance

object ← MoveReport

Implements

IEquatable<MoveReport>

Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()

Constructors

MoveReport(string, string, IReadOnlyList<string>, RewriteReport, IReadOnlyList<string>, bool)

What did, or in a preview would do.

public MoveReport(string From, string To, IReadOnlyList<string> Files, RewriteReport References, IReadOnlyList<string> Warnings, bool Applied)

Parameters

From string

The asset's old path.

To string

Its new path.

Files IReadOnlyList<string>

The files that moved (or would): the asset, its .import.xml and its imported artifact, each by its new path.

References RewriteReport

The documents whose references were rewritten, and the ones that could not be.

Warnings IReadOnlyList<string>

Things a person should look at: another asset reads this one by relative path, or the import data could not be updated.

Applied bool

False for a preview: nothing was moved or written.

Properties

Applied

False for a preview: nothing was moved or written.

public bool Applied { get; init; }

Property Value

bool

Files

The files that moved (or would): the asset, its .import.xml and its imported artifact, each by its new path.

public IReadOnlyList<string> Files { get; init; }

Property Value

IReadOnlyList<string>

From

The asset's old path.

public string From { get; init; }

Property Value

string

References

The documents whose references were rewritten, and the ones that could not be.

public RewriteReport References { get; init; }

Property Value

RewriteReport

To

Its new path.

public string To { get; init; }

Property Value

string

Warnings

Things a person should look at: another asset reads this one by relative path, or the import data could not be updated.

public IReadOnlyList<string> Warnings { get; init; }

Property Value

IReadOnlyList<string>