Class MigrationEventArgs
Inheritance
System.Object
System.EventArgs
Namespace:System.Dynamic.ExpandoObject
Assembly:Umbraco.Core.dll
Syntax
public class MigrationEventArgs : CancellableObjectEventArgs<IList<IMigration>>, IEquatable<CancellableEventArgs>, IEquatable<CancellableObjectEventArgs<IList<IMigration>>>, IEquatable<MigrationEventArgs>
Constructors
MigrationEventArgs(IList<IMigration>, SemVersion, SemVersion)
Constructor accepting multiple migrations that are used in the migration runner
Declaration
[Obsolete("Use constructor accepting a product name instead.")]
public MigrationEventArgs(IList<IMigration> eventObject, SemVersion configuredVersion, SemVersion targetVersion)
Parameters
Type |
Name |
Description |
System.Collections.Generic.IList<IMigration> |
eventObject |
|
Semver.SemVersion |
configuredVersion |
|
Semver.SemVersion |
targetVersion |
|
MigrationEventArgs(IList<IMigration>, SemVersion, SemVersion, Boolean)
Constructor accepting multiple migrations that are used in the migration runner
Declaration
[Obsolete("Use constructor accepting a product name instead.")]
public MigrationEventArgs(IList<IMigration> eventObject, SemVersion configuredVersion, SemVersion targetVersion, bool canCancel)
Parameters
Type |
Name |
Description |
System.Collections.Generic.IList<IMigration> |
eventObject |
|
Semver.SemVersion |
configuredVersion |
|
Semver.SemVersion |
targetVersion |
|
System.Boolean |
canCancel |
|
MigrationEventArgs(IList<IMigration>, SemVersion, SemVersion, String)
Constructor accepting multiple migrations that are used in the migration runner
Declaration
public MigrationEventArgs(IList<IMigration> eventObject, SemVersion configuredVersion, SemVersion targetVersion, string productName)
Parameters
Type |
Name |
Description |
System.Collections.Generic.IList<IMigration> |
eventObject |
|
Semver.SemVersion |
configuredVersion |
|
Semver.SemVersion |
targetVersion |
|
System.String |
productName |
|
MigrationEventArgs(IList<IMigration>, SemVersion, SemVersion, String, Boolean)
Constructor accepting multiple migrations that are used in the migration runner
Declaration
public MigrationEventArgs(IList<IMigration> eventObject, SemVersion configuredVersion, SemVersion targetVersion, string productName, bool canCancel)
Parameters
Type |
Name |
Description |
System.Collections.Generic.IList<IMigration> |
eventObject |
|
Semver.SemVersion |
configuredVersion |
|
Semver.SemVersion |
targetVersion |
|
System.String |
productName |
|
System.Boolean |
canCancel |
|
MigrationEventArgs(IList<IMigration>, Version, Version)
Declaration
[Obsolete("Use constructor accepting SemVersion instances and a product name instead.")]
public MigrationEventArgs(IList<IMigration> eventObject, Version configuredVersion, Version targetVersion)
Parameters
Type |
Name |
Description |
System.Collections.Generic.IList<IMigration> |
eventObject |
|
System.Version |
configuredVersion |
|
System.Version |
targetVersion |
|
MigrationEventArgs(IList<IMigration>, Version, Version, Boolean)
Declaration
[Obsolete("Use constructor accepting SemVersion instances and a product name instead.")]
public MigrationEventArgs(IList<IMigration> eventObject, Version configuredVersion, Version targetVersion, bool canCancel)
Parameters
Type |
Name |
Description |
System.Collections.Generic.IList<IMigration> |
eventObject |
|
System.Version |
configuredVersion |
|
System.Version |
targetVersion |
|
System.Boolean |
canCancel |
|
Properties
Gets the origin version of the migration, i.e. the one that is currently installed.
Declaration
public SemVersion ConfiguredSemVersion { get; }
Property Value
Type |
Description |
Semver.SemVersion |
|
Declaration
[Obsolete("Use ConfiguredSemVersion instead")]
public Version ConfiguredVersion { get; }
Property Value
Type |
Description |
System.Version |
|
Migrations
Returns all migrations that were used in the migration runner
Declaration
public IList<IMigration> Migrations { get; }
Property Value
Type |
Description |
System.Collections.Generic.IList<IMigration> |
|
ProductName
Declaration
public string ProductName { get; }
Property Value
Type |
Description |
System.String |
|
TargetSemVersion
Gets the target version of the migration.
Declaration
public SemVersion TargetSemVersion { get; }
Property Value
Type |
Description |
Semver.SemVersion |
|
TargetVersion
Declaration
[Obsolete("Use TargetUmbracoVersion instead")]
public Version TargetVersion { get; }
Property Value
Type |
Description |
System.Version |
|
Methods
Equals(Object)
Declaration
public override bool Equals(object obj)
Parameters
Type |
Name |
Description |
System.Object |
obj |
|
Returns
Type |
Description |
System.Boolean |
|
Equals(MigrationEventArgs)
Declaration
public bool Equals(MigrationEventArgs other)
Parameters
Returns
Type |
Description |
System.Boolean |
|
GetHashCode()
Declaration
public override int GetHashCode()
Returns
Type |
Description |
System.Int32 |
|
Operators
Equality(MigrationEventArgs, MigrationEventArgs)
Declaration
public static bool operator ==(MigrationEventArgs left, MigrationEventArgs right)
Parameters
Returns
Type |
Description |
System.Boolean |
|
Inequality(MigrationEventArgs, MigrationEventArgs)
Declaration
public static bool operator !=(MigrationEventArgs left, MigrationEventArgs right)
Parameters
Returns
Type |
Description |
System.Boolean |
|