aboutsummaryrefslogtreecommitdiff
path: root/src/api/burn/WixToolset.Mba.Core/IPackageInfo.cs
blob: b1036143eb150377dc8efcbc65445990c723f16e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
// 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.

namespace WixToolset.Mba.Core
{
    /// <summary>
    /// Package information from the BA manifest.
    /// </summary>
    public interface IPackageInfo
    {
        /// <summary>
        /// The authored cache strategy for this package.
        /// </summary>
        BOOTSTRAPPER_CACHE_TYPE CacheType { get; }

        /// <summary>
        /// Place for the BA to store it's own custom data for this package.
        /// </summary>
        object CustomData { get; set; }

        /// <summary>
        /// The package's description.
        /// </summary>
        string Description { get; }

        /// <summary>
        /// The authored bal:DisplayInternalUICondition.
        /// </summary>
        string DisplayInternalUICondition { get; }

        /// <summary>
        /// The package's display name.
        /// </summary>
        string DisplayName { get; }

        /// <summary>
        /// The package's Id.
        /// </summary>
        string Id { get; }

        /// <summary>
        /// The authored InstallCondition.
        /// </summary>
        string InstallCondition { get; }

        /// <summary>
        /// The authored RepairCondition.
        /// </summary>
        string RepairCondition { get; }

        /// <summary>
        /// Whether the bundle should ever recommend the package to be uninstalled.
        /// </summary>
        bool Permanent { get; }

        /// <summary>
        /// Whether the package should be installed by the prereq BA for managed bootstrapper applications.
        /// </summary>
        bool PrereqPackage { get; }

        /// <summary>
        /// The file name of the license file to be shown by the prereq BA.
        /// </summary>
        string PrereqLicenseFile { get; }

        /// <summary>
        /// The URL of the license to be shown by the prereq BA.
        /// </summary>
        string PrereqLicenseUrl { get; }

        /// <summary>
        /// See <see cref="WixToolset.Mba.Core.PrimaryPackageType"/>
        /// </summary>
        PrimaryPackageType PrimaryPackageType { get; }

        /// <summary>
        /// The package's ProductCode.
        /// </summary>
        string ProductCode { get; }

        /// <summary>
        /// The type of the package.
        /// </summary>
        PackageType Type { get; }

        /// <summary>
        /// The package's UpgradeCode.
        /// </summary>
        string UpgradeCode { get; }

        /// <summary>
        /// The package's version.
        /// </summary>
        string Version { get; }

        /// <summary>
        /// Whether the package's failure can be ignored while executing the chain.
        /// </summary>
        bool Vital { get; }
    }
}