View Source

Class MigrationEventArgs

Inheritance
System.Object
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
System.String productName
View Source

MigrationEventArgs(IList<Type>, SemVersion, SemVersion, String, Boolean)

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
System.String productName
System.Boolean 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
System.Nullable<IList<Type>>
View Source

ProductName

Gets the product name.

Declaration
public string ProductName { get; }
Property Value
Type Description
System.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)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Boolean
View Source

Equals(MigrationEventArgs)

Declaration
public bool Equals(MigrationEventArgs other)
Parameters
Type Name Description
MigrationEventArgs other
Returns
Type Description
System.Boolean
View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32

Operators

View Source

Equality(MigrationEventArgs, MigrationEventArgs)

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

Inequality(MigrationEventArgs, MigrationEventArgs)

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