aboutsummaryrefslogtreecommitdiff
path: root/src/WixToolset.Mba.Core/EventArgs.cs
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/WixToolset.Mba.Core/EventArgs.cs155
1 files changed, 8 insertions, 147 deletions
diff --git a/src/WixToolset.Mba.Core/EventArgs.cs b/src/WixToolset.Mba.Core/EventArgs.cs
index 4e59fd6f..2f21b50e 100644
--- a/src/WixToolset.Mba.Core/EventArgs.cs
+++ b/src/WixToolset.Mba.Core/EventArgs.cs
@@ -489,43 +489,6 @@ namespace WixToolset.Mba.Core
489 } 489 }
490 490
491 /// <summary> 491 /// <summary>
492 /// Additional arguments used when a package was not found but a newer package using the same provider key was.
493 /// </summary>
494 [Serializable]
495 public class DetectCompatibleMsiPackageEventArgs : CancellableHResultEventArgs
496 {
497 /// <summary>
498 /// Creates a new instance of the <see cref="DetectCompatibleMsiPackageEventArgs"/> class.
499 /// </summary>
500 /// <param name="packageId">The identity of the package that was not detected.</param>
501 /// <param name="compatiblePackageId">The identity of the compatible package that was detected.</param>
502 /// <param name="compatiblePackageVersion">The version of the compatible package that was detected.</param>
503 /// <param name="cancelRecommendation">The recommendation from the engine.</param>
504 public DetectCompatibleMsiPackageEventArgs(string packageId, string compatiblePackageId, string compatiblePackageVersion, bool cancelRecommendation)
505 : base(cancelRecommendation)
506 {
507 this.PackageId = packageId;
508 this.CompatiblePackageId = compatiblePackageId;
509 this.CompatiblePackageVersion = compatiblePackageVersion;
510 }
511
512 /// <summary>
513 /// Gets the identity of the package that was not detected.
514 /// </summary>
515 public string PackageId { get; private set; }
516
517 /// <summary>
518 /// Gets the identity of the compatible package that was detected.
519 /// </summary>
520 public string CompatiblePackageId { get; private set; }
521
522 /// <summary>
523 /// Gets the version of the compatible package that was detected.
524 /// </summary>
525 public string CompatiblePackageVersion { get; private set; }
526 }
527
528 /// <summary>
529 /// Additional arguments used when a related MSI package has been detected for a package. 492 /// Additional arguments used when a related MSI package has been detected for a package.
530 /// </summary> 493 /// </summary>
531 [Serializable] 494 [Serializable]
@@ -695,10 +658,17 @@ namespace WixToolset.Mba.Core
695 /// Creates a new instance of the <see cref="DetectCompleteEventArgs"/> class. 658 /// Creates a new instance of the <see cref="DetectCompleteEventArgs"/> class.
696 /// </summary> 659 /// </summary>
697 /// <param name="hrStatus">The return code of the operation.</param> 660 /// <param name="hrStatus">The return code of the operation.</param>
698 public DetectCompleteEventArgs(int hrStatus) 661 /// <param name="eligibleForCleanup"></param>
662 public DetectCompleteEventArgs(int hrStatus, bool eligibleForCleanup)
699 : base(hrStatus) 663 : base(hrStatus)
700 { 664 {
665 this.EligibleForCleanup = eligibleForCleanup;
701 } 666 }
667
668 /// <summary>
669 /// Indicates whether the engine will uninstall the bundle if shutdown without running Apply.
670 /// </summary>
671 public bool EligibleForCleanup { get; private set; }
702 } 672 }
703 673
704 /// <summary> 674 /// <summary>
@@ -799,115 +769,6 @@ namespace WixToolset.Mba.Core
799 } 769 }
800 770
801 /// <summary> 771 /// <summary>
802 /// Additional arguments used when the engine is about to plan a newer package using the same provider key.
803 /// </summary>
804 [Serializable]
805 public class PlanCompatibleMsiPackageBeginEventArgs : CancellableHResultEventArgs
806 {
807 /// <summary>
808 /// Creates a new instance of the <see cref="PlanCompatibleMsiPackageBeginEventArgs"/> class.
809 /// </summary>
810 /// <param name="packageId">The identity of the package that was not detected.</param>
811 /// <param name="compatiblePackageId">The identity of the compatible package that was detected.</param>
812 /// <param name="compatiblePackageVersion">The version of the compatible package that was detected.</param>
813 /// <param name="recommendedState">The recommended request state for the compatible package.</param>
814 /// <param name="state">The requested state for the compatible package.</param>
815 /// <param name="cancelRecommendation">The recommendation from the engine.</param>
816 public PlanCompatibleMsiPackageBeginEventArgs(string packageId, string compatiblePackageId, string compatiblePackageVersion, RequestState recommendedState, RequestState state, bool cancelRecommendation)
817 : base(cancelRecommendation)
818 {
819 this.PackageId = packageId;
820 this.CompatiblePackageId = compatiblePackageId;
821 this.CompatiblePackageVersion = compatiblePackageVersion;
822 this.RecommendedState = recommendedState;
823 this.State = state;
824 }
825
826 /// <summary>
827 /// Gets the identity of the package that was not detected.
828 /// </summary>
829 public string PackageId { get; private set; }
830
831 /// <summary>
832 /// Gets the identity of the compatible package detected.
833 /// </summary>
834 public string CompatiblePackageId { get; private set; }
835
836 /// <summary>
837 /// Gets the version of the compatible package detected.
838 /// </summary>
839 public string CompatiblePackageVersion { get; private set; }
840
841 /// <summary>
842 /// Gets the recommended state to use for the compatible package for planning.
843 /// </summary>
844 public RequestState RecommendedState { get; private set; }
845
846 /// <summary>
847 /// Gets or sets the state to use for the compatible package for planning.
848 /// </summary>
849 public RequestState State { get; set; }
850 }
851
852 /// <summary>
853 /// Additional arguments used when the engine has completed planning the installation of a specific package.
854 /// </summary>
855 [Serializable]
856 public class PlanCompatibleMsiPackageCompleteEventArgs : StatusEventArgs
857 {
858 /// <summary>
859 /// Creates a new instance of the <see cref="PlanCompatibleMsiPackageCompleteEventArgs"/> class.
860 /// </summary>
861 /// <param name="packageId">The identity of the package planned for.</param>
862 /// <param name="compatiblePackageId">The identity of the compatible package that was detected.</param>
863 /// <param name="hrStatus">The return code of the operation.</param>
864 /// <param name="state">The current state of the package.</param>
865 /// <param name="requested">The requested state for the package</param>
866 /// <param name="execute">The execution action to take.</param>
867 /// <param name="rollback">The rollback action to take.</param>
868 public PlanCompatibleMsiPackageCompleteEventArgs(string packageId, string compatiblePackageId, int hrStatus, PackageState state, RequestState requested, ActionState execute, ActionState rollback)
869 : base(hrStatus)
870 {
871 this.PackageId = packageId;
872 this.CompatiblePackageId = compatiblePackageId;
873 this.State = state;
874 this.Requested = requested;
875 this.Execute = execute;
876 this.Rollback = rollback;
877 }
878
879 /// <summary>
880 /// Gets the identity of the package planned for.
881 /// </summary>
882 public string PackageId { get; private set; }
883
884 /// <summary>
885 /// Gets the identity of the compatible package detected.
886 /// </summary>
887 public string CompatiblePackageId { get; private set; }
888
889 /// <summary>
890 /// Gets the current state of the package.
891 /// </summary>
892 public PackageState State { get; private set; }
893
894 /// <summary>
895 /// Gets the requested state for the package.
896 /// </summary>
897 public RequestState Requested { get; private set; }
898
899 /// <summary>
900 /// Gets the execution action to take.
901 /// </summary>
902 public ActionState Execute { get; private set; }
903
904 /// <summary>
905 /// Gets the rollback action to take.
906 /// </summary>
907 public ActionState Rollback { get; private set; }
908 }
909
910 /// <summary>
911 /// Additional arguments used when engine is about to plan a MSP applied to a target MSI package. 772 /// Additional arguments used when engine is about to plan a MSP applied to a target MSI package.
912 /// </summary> 773 /// </summary>
913 [Serializable] 774 [Serializable]