aboutsummaryrefslogtreecommitdiff
path: root/src/api/burn/WixToolset.BootstrapperApplicationApi/IPackageInfo.cs
diff options
context:
space:
mode:
Diffstat (limited to 'src/api/burn/WixToolset.BootstrapperApplicationApi/IPackageInfo.cs')
-rw-r--r--src/api/burn/WixToolset.BootstrapperApplicationApi/IPackageInfo.cs100
1 files changed, 100 insertions, 0 deletions
diff --git a/src/api/burn/WixToolset.BootstrapperApplicationApi/IPackageInfo.cs b/src/api/burn/WixToolset.BootstrapperApplicationApi/IPackageInfo.cs
new file mode 100644
index 00000000..e2512584
--- /dev/null
+++ b/src/api/burn/WixToolset.BootstrapperApplicationApi/IPackageInfo.cs
@@ -0,0 +1,100 @@
1// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information.
2
3namespace WixToolset.BootstrapperApplicationApi
4{
5 /// <summary>
6 /// Package information from the BA manifest.
7 /// </summary>
8 public interface IPackageInfo
9 {
10 /// <summary>
11 /// The authored cache strategy for this package.
12 /// </summary>
13 BOOTSTRAPPER_CACHE_TYPE CacheType { get; }
14
15 /// <summary>
16 /// Place for the BA to store it's own custom data for this package.
17 /// </summary>
18 object CustomData { get; set; }
19
20 /// <summary>
21 /// The package's description.
22 /// </summary>
23 string Description { get; }
24
25 /// <summary>
26 /// The authored bal:DisplayInternalUICondition.
27 /// </summary>
28 string DisplayInternalUICondition { get; }
29
30 /// <summary>
31 /// The package's display name.
32 /// </summary>
33 string DisplayName { get; }
34
35 /// <summary>
36 /// The package's Id.
37 /// </summary>
38 string Id { get; }
39
40 /// <summary>
41 /// The authored InstallCondition.
42 /// </summary>
43 string InstallCondition { get; }
44
45 /// <summary>
46 /// The authored RepairCondition.
47 /// </summary>
48 string RepairCondition { get; }
49
50 /// <summary>
51 /// Whether the bundle should ever recommend the package to be uninstalled.
52 /// </summary>
53 bool Permanent { get; }
54
55 /// <summary>
56 /// Whether the package should be installed by the prereq BA for managed bootstrapper applications.
57 /// </summary>
58 bool PrereqPackage { get; }
59
60 /// <summary>
61 /// The file name of the license file to be shown by the prereq BA.
62 /// </summary>
63 string PrereqLicenseFile { get; }
64
65 /// <summary>
66 /// The URL of the license to be shown by the prereq BA.
67 /// </summary>
68 string PrereqLicenseUrl { get; }
69
70 /// <summary>
71 /// See <see cref="WixToolset.BootstrapperApplicationApi.PrimaryPackageType"/>
72 /// </summary>
73 PrimaryPackageType PrimaryPackageType { get; }
74
75 /// <summary>
76 /// The package's ProductCode.
77 /// </summary>
78 string ProductCode { get; }
79
80 /// <summary>
81 /// The type of the package.
82 /// </summary>
83 PackageType Type { get; }
84
85 /// <summary>
86 /// The package's UpgradeCode.
87 /// </summary>
88 string UpgradeCode { get; }
89
90 /// <summary>
91 /// The package's version.
92 /// </summary>
93 string Version { get; }
94
95 /// <summary>
96 /// Whether the package's failure can be ignored while executing the chain.
97 /// </summary>
98 bool Vital { get; }
99 }
100}