View Source

Class MigrationEventArgs

Inheritance
object
EventArgs
CancellableEventArgs
CancellableObjectEventArgs
CancellableObjectEventArgs<IList<Type>>
Namespace: Umbraco.Cms.Core.Events
Assembly: Umbraco.Infrastructure.dll
Syntax
public class MigrationEventArgs : CancellableObjectEventArgs<IList<Type>>

Constructors

View Source

MigrationEventArgs(IList<Type>, SemVersion, SemVersion, string)

Declaration
public MigrationEventArgs(IList<Type> migrationTypes, SemVersion configuredVersion, SemVersion targetVersion, string productName)
Parameters
Type Name Description
IList<Type> migrationTypes
SemVersion configuredVersion
SemVersion targetVersion
string productName
View Source

MigrationEventArgs(IList<Type>, SemVersion, SemVersion, string, bool)

Declaration
public MigrationEventArgs(IList<Type> migrationTypes, SemVersion configuredVersion, SemVersion targetVersion, string productName, bool canCancel)
Parameters
Type Name Description
IList<Type> migrationTypes
SemVersion configuredVersion
SemVersion targetVersion
string productName
bool canCancel

Properties

View Source

ConfiguredSemVersion

Gets the origin version of the migration, i.e. the one that is currently installed.

Declaration
public SemVersion ConfiguredSemVersion { get; }
Property Value
Type Description
SemVersion
View Source

MigrationsTypes

Returns all migrations that were used in the migration runner

Declaration
public IList<Type>? MigrationsTypes { get; }
Property Value
Type Description
IList<Type>
View Source

ProductName

Gets the product name.

Declaration
public string ProductName { get; }
Property Value
Type Description
string
View Source

TargetSemVersion

Gets the target version of the migration.

Declaration
public SemVersion TargetSemVersion { get; }
Property Value
Type Description
SemVersion

Methods

View Source

Equals(object?)

Determines whether the specified object is equal to the current object.

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
object obj

The object to compare with the current object.
Returns
Type Description
bool

true if the specified object is equal to the current object; otherwise, false.
View Source

Equals(MigrationEventArgs?)

Indicates whether the current object is equal to another object of the same type.

Declaration
public bool Equals(MigrationEventArgs? other)
Parameters
Type Name Description
MigrationEventArgs other

An object to compare with this object.
Returns
Type Description
bool

true if the current object is equal to the other parameter; otherwise, false.
View Source

GetHashCode()

Serves as the default hash function.

Declaration
public override int GetHashCode()
Returns
Type Description
int

A hash code for the current object.

Operators

View Source

operator ==(MigrationEventArgs, MigrationEventArgs)

Declaration
public static bool operator ==(MigrationEventArgs left, MigrationEventArgs right)
Parameters
Type Name Description
MigrationEventArgs left
MigrationEventArgs right
Returns
Type Description
bool
View Source

operator !=(MigrationEventArgs, MigrationEventArgs)

Declaration
public static bool operator !=(MigrationEventArgs left, MigrationEventArgs right)
Parameters
Type Name Description
MigrationEventArgs left
MigrationEventArgs right
Returns
Type Description
bool