diff options
author | Rob Mensching <rob@firegiant.com> | 2024-12-29 18:01:20 -0800 |
---|---|---|
committer | Rob Mensching <rob@firegiant.com> | 2024-12-30 06:45:49 -0800 |
commit | 523c66a62a619e6aa9f30070173ea33edfb5e328 (patch) | |
tree | 04fa3146250b7eeaa6864b0f71e37905a2d77be1 /src/api/burn/WixToolset.BootstrapperApplicationApi/EventArgs.cs | |
parent | 6edc5d1e2a289eac50c6d59a29e195353bb023cb (diff) | |
download | wix-523c66a62a619e6aa9f30070173ea33edfb5e328.tar.gz wix-523c66a62a619e6aa9f30070173ea33edfb5e328.tar.bz2 wix-523c66a62a619e6aa9f30070173ea33edfb5e328.zip |
Rename "bundle id" concept to "bundle code"
The "bundle id" always had more in common with the PackageCode from the Windows
Installer. With the introduction of an actual Id attribute on the Bundle
element, there is potential for confusion, so there is finally real motivation
to rename "bundle id" to "bundle code".
Diffstat (limited to 'src/api/burn/WixToolset.BootstrapperApplicationApi/EventArgs.cs')
-rw-r--r-- | src/api/burn/WixToolset.BootstrapperApplicationApi/EventArgs.cs | 50 |
1 files changed, 35 insertions, 15 deletions
diff --git a/src/api/burn/WixToolset.BootstrapperApplicationApi/EventArgs.cs b/src/api/burn/WixToolset.BootstrapperApplicationApi/EventArgs.cs index e1649d43..4df07e57 100644 --- a/src/api/burn/WixToolset.BootstrapperApplicationApi/EventArgs.cs +++ b/src/api/burn/WixToolset.BootstrapperApplicationApi/EventArgs.cs | |||
@@ -325,10 +325,10 @@ namespace WixToolset.BootstrapperApplicationApi | |||
325 | /// This class is for events raised by the engine. | 325 | /// This class is for events raised by the engine. |
326 | /// It is not intended to be instantiated by user code. | 326 | /// It is not intended to be instantiated by user code. |
327 | /// </summary> | 327 | /// </summary> |
328 | public DetectForwardCompatibleBundleEventArgs(string bundleId, RelationType relationType, string bundleTag, bool perMachine, string version, bool missingFromCache, bool cancelRecommendation) | 328 | public DetectForwardCompatibleBundleEventArgs(string bundleCode, RelationType relationType, string bundleTag, bool perMachine, string version, bool missingFromCache, bool cancelRecommendation) |
329 | : base(cancelRecommendation) | 329 | : base(cancelRecommendation) |
330 | { | 330 | { |
331 | this.BundleId = bundleId; | 331 | this.BundleCode = bundleCode; |
332 | this.RelationType = relationType; | 332 | this.RelationType = relationType; |
333 | this.BundleTag = bundleTag; | 333 | this.BundleTag = bundleTag; |
334 | this.PerMachine = perMachine; | 334 | this.PerMachine = perMachine; |
@@ -339,7 +339,11 @@ namespace WixToolset.BootstrapperApplicationApi | |||
339 | /// <summary> | 339 | /// <summary> |
340 | /// Gets the identity of the forward compatible bundle detected. | 340 | /// Gets the identity of the forward compatible bundle detected. |
341 | /// </summary> | 341 | /// </summary> |
342 | public string BundleId { get; private set; } | 342 | public string BundleCode { get; private set; } |
343 | |||
344 | /// <inheritdoc cref="BundleCode" /> | ||
345 | [Obsolete("Use BundleCode instead.")] | ||
346 | public string BundleId => this.BundleCode; | ||
343 | 347 | ||
344 | /// <summary> | 348 | /// <summary> |
345 | /// Gets the relationship type of the forward compatible bundle. | 349 | /// Gets the relationship type of the forward compatible bundle. |
@@ -807,10 +811,10 @@ namespace WixToolset.BootstrapperApplicationApi | |||
807 | /// This class is for events raised by the engine. | 811 | /// This class is for events raised by the engine. |
808 | /// It is not intended to be instantiated by user code. | 812 | /// It is not intended to be instantiated by user code. |
809 | /// </summary> | 813 | /// </summary> |
810 | public PlanRelatedBundleEventArgs(string bundleId, RequestState recommendedState, RequestState state, bool cancelRecommendation) | 814 | public PlanRelatedBundleEventArgs(string bundleCode, RequestState recommendedState, RequestState state, bool cancelRecommendation) |
811 | : base(cancelRecommendation) | 815 | : base(cancelRecommendation) |
812 | { | 816 | { |
813 | this.BundleId = bundleId; | 817 | this.BundleCode = bundleCode; |
814 | this.RecommendedState = recommendedState; | 818 | this.RecommendedState = recommendedState; |
815 | this.State = state; | 819 | this.State = state; |
816 | } | 820 | } |
@@ -818,7 +822,11 @@ namespace WixToolset.BootstrapperApplicationApi | |||
818 | /// <summary> | 822 | /// <summary> |
819 | /// Gets the identity of the bundle to plan for. | 823 | /// Gets the identity of the bundle to plan for. |
820 | /// </summary> | 824 | /// </summary> |
821 | public string BundleId { get; private set; } | 825 | public string BundleCode { get; private set; } |
826 | |||
827 | /// <inheritdoc cref="BundleCode" /> | ||
828 | [Obsolete("Use BundleCode instead.")] | ||
829 | public string BundleId => this.BundleCode; | ||
822 | 830 | ||
823 | /// <summary> | 831 | /// <summary> |
824 | /// Gets the recommended requested state for the bundle. | 832 | /// Gets the recommended requested state for the bundle. |
@@ -841,10 +849,10 @@ namespace WixToolset.BootstrapperApplicationApi | |||
841 | /// This class is for events raised by the engine. | 849 | /// This class is for events raised by the engine. |
842 | /// It is not intended to be instantiated by user code. | 850 | /// It is not intended to be instantiated by user code. |
843 | /// </summary> | 851 | /// </summary> |
844 | public PlanRelatedBundleTypeEventArgs(string bundleId, RelatedBundlePlanType recommendedType, RelatedBundlePlanType type, bool cancelRecommendation) | 852 | public PlanRelatedBundleTypeEventArgs(string bundleCode, RelatedBundlePlanType recommendedType, RelatedBundlePlanType type, bool cancelRecommendation) |
845 | : base(cancelRecommendation) | 853 | : base(cancelRecommendation) |
846 | { | 854 | { |
847 | this.BundleId = bundleId; | 855 | this.BundleCode = bundleCode; |
848 | this.RecommendedType = recommendedType; | 856 | this.RecommendedType = recommendedType; |
849 | this.Type = type; | 857 | this.Type = type; |
850 | } | 858 | } |
@@ -852,7 +860,11 @@ namespace WixToolset.BootstrapperApplicationApi | |||
852 | /// <summary> | 860 | /// <summary> |
853 | /// Gets the identity of the bundle to plan for. | 861 | /// Gets the identity of the bundle to plan for. |
854 | /// </summary> | 862 | /// </summary> |
855 | public string BundleId { get; private set; } | 863 | public string BundleCode { get; private set; } |
864 | |||
865 | /// <inheritdoc cref="BundleCode" /> | ||
866 | [Obsolete("Use BundleCode instead.")] | ||
867 | public string BundleId => this.BundleCode; | ||
856 | 868 | ||
857 | /// <summary> | 869 | /// <summary> |
858 | /// Gets the recommended plan type for the bundle. | 870 | /// Gets the recommended plan type for the bundle. |
@@ -1327,10 +1339,10 @@ namespace WixToolset.BootstrapperApplicationApi | |||
1327 | /// This class is for events raised by the engine. | 1339 | /// This class is for events raised by the engine. |
1328 | /// It is not intended to be instantiated by user code. | 1340 | /// It is not intended to be instantiated by user code. |
1329 | /// </summary> | 1341 | /// </summary> |
1330 | public PlanForwardCompatibleBundleEventArgs(string bundleId, RelationType relationType, string bundleTag, bool perMachine, string version, bool recommendedIgnoreBundle, bool cancelRecommendation, bool ignoreBundle) | 1342 | public PlanForwardCompatibleBundleEventArgs(string bundleCode, RelationType relationType, string bundleTag, bool perMachine, string version, bool recommendedIgnoreBundle, bool cancelRecommendation, bool ignoreBundle) |
1331 | : base(cancelRecommendation) | 1343 | : base(cancelRecommendation) |
1332 | { | 1344 | { |
1333 | this.BundleId = bundleId; | 1345 | this.BundleCode = bundleCode; |
1334 | this.RelationType = relationType; | 1346 | this.RelationType = relationType; |
1335 | this.BundleTag = bundleTag; | 1347 | this.BundleTag = bundleTag; |
1336 | this.PerMachine = perMachine; | 1348 | this.PerMachine = perMachine; |
@@ -1342,7 +1354,11 @@ namespace WixToolset.BootstrapperApplicationApi | |||
1342 | /// <summary> | 1354 | /// <summary> |
1343 | /// Gets the identity of the forward compatible bundle detected. | 1355 | /// Gets the identity of the forward compatible bundle detected. |
1344 | /// </summary> | 1356 | /// </summary> |
1345 | public string BundleId { get; private set; } | 1357 | public string BundleCode { get; private set; } |
1358 | |||
1359 | /// <inheritdoc cref="BundleCode" /> | ||
1360 | [Obsolete("Use BundleCode instead.")] | ||
1361 | public string BundleId => this.BundleCode; | ||
1346 | 1362 | ||
1347 | /// <summary> | 1363 | /// <summary> |
1348 | /// Gets the relationship type of the forward compatible bundle. | 1364 | /// Gets the relationship type of the forward compatible bundle. |
@@ -2624,10 +2640,10 @@ namespace WixToolset.BootstrapperApplicationApi | |||
2624 | /// This class is for events raised by the engine. | 2640 | /// This class is for events raised by the engine. |
2625 | /// It is not intended to be instantiated by user code. | 2641 | /// It is not intended to be instantiated by user code. |
2626 | /// </summary> | 2642 | /// </summary> |
2627 | public PlanRestoreRelatedBundleEventArgs(string bundleId, RequestState recommendedState, RequestState state, bool cancelRecommendation) | 2643 | public PlanRestoreRelatedBundleEventArgs(string bundleCode, RequestState recommendedState, RequestState state, bool cancelRecommendation) |
2628 | : base(cancelRecommendation) | 2644 | : base(cancelRecommendation) |
2629 | { | 2645 | { |
2630 | this.BundleId = bundleId; | 2646 | this.BundleCode = bundleCode; |
2631 | this.RecommendedState = recommendedState; | 2647 | this.RecommendedState = recommendedState; |
2632 | this.State = state; | 2648 | this.State = state; |
2633 | } | 2649 | } |
@@ -2635,7 +2651,11 @@ namespace WixToolset.BootstrapperApplicationApi | |||
2635 | /// <summary> | 2651 | /// <summary> |
2636 | /// Gets the identity of the bundle to plan for. | 2652 | /// Gets the identity of the bundle to plan for. |
2637 | /// </summary> | 2653 | /// </summary> |
2638 | public string BundleId { get; private set; } | 2654 | public string BundleCode { get; private set; } |
2655 | |||
2656 | /// <inheritdoc cref="BundleCode" /> | ||
2657 | [Obsolete("Use BundleCode instead.")] | ||
2658 | public string BundleId => this.BundleCode; | ||
2639 | 2659 | ||
2640 | /// <summary> | 2660 | /// <summary> |
2641 | /// Gets the recommended requested state for the bundle. | 2661 | /// Gets the recommended requested state for the bundle. |