aboutsummaryrefslogtreecommitdiff
path: root/src/api/burn/WixToolset.Mba.Core/IBootstrapperCommand.cs
diff options
context:
space:
mode:
Diffstat (limited to 'src/api/burn/WixToolset.Mba.Core/IBootstrapperCommand.cs')
-rw-r--r--src/api/burn/WixToolset.Mba.Core/IBootstrapperCommand.cs76
1 files changed, 76 insertions, 0 deletions
diff --git a/src/api/burn/WixToolset.Mba.Core/IBootstrapperCommand.cs b/src/api/burn/WixToolset.Mba.Core/IBootstrapperCommand.cs
new file mode 100644
index 00000000..e861813f
--- /dev/null
+++ b/src/api/burn/WixToolset.Mba.Core/IBootstrapperCommand.cs
@@ -0,0 +1,76 @@
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.Mba.Core
4{
5 using System;
6
7 /// <summary>
8 /// Command information passed from the engine for the BA to perform.
9 /// </summary>
10 public interface IBootstrapperCommand
11 {
12 /// <summary>
13 /// Gets the action for the BA to perform.
14 /// </summary>
15 LaunchAction Action { get; }
16
17 /// <summary>
18 /// Gets the display level for the BA.
19 /// </summary>
20 Display Display { get; }
21
22 /// <summary>
23 /// Gets the action to perform if a reboot is required.
24 /// </summary>
25 Restart Restart { get; }
26
27 /// <summary>
28 /// Gets the command line arguments as a string array.
29 /// </summary>
30 /// <returns>
31 /// Array of command line arguments not handled by the engine.
32 /// </returns>
33 /// <exception type="Win32Exception">The command line could not be parsed into an array.</exception>
34 string[] CommandLineArgs { get; }
35
36 /// <summary>
37 /// Hint for the initial visibility of the window.
38 /// </summary>
39 int CmdShow { get; }
40
41 /// <summary>
42 /// Gets the method of how the engine was resumed from a previous installation step.
43 /// </summary>
44 ResumeType Resume { get; }
45
46 /// <summary>
47 /// Gets the handle to the splash screen window. If no splash screen was displayed this value will be IntPtr.Zero.
48 /// </summary>
49 IntPtr SplashScreen { get; }
50
51 /// <summary>
52 /// If this was run from a related bundle, specifies the relation type.
53 /// </summary>
54 RelationType Relation { get; }
55
56 /// <summary>
57 /// If this was run from a backward compatible bundle.
58 /// </summary>
59 bool Passthrough { get; }
60
61 /// <summary>
62 /// Gets layout directory.
63 /// </summary>
64 string LayoutDirectory { get; }
65
66 /// <summary>
67 /// Gets bootstrapper working folder.
68 /// </summary>
69 string BootstrapperWorkingFolder { get; }
70
71 /// <summary>
72 /// Gets path to BootstrapperApplicationData.xml.
73 /// </summary>
74 string BootstrapperApplicationDataPath { get; }
75 }
76}