IBundleUI Interface

BundleUI interface.

Methods

Method	Description
CreateWindow()	Create (but do not show) the BundleUI window to return the window’s handle to the bootstrapper application.
OnCompleteCancel(bool, bool)	Callback when the bundle application is canceled.
OnCompleteFailure(bool, int, bool)	Callback when the bundle application fails.
OnCompleteSuccess(bool, bool)	Callback when the bundle application succeeds.
OnConditionFailure(BundleCondition, string)	Callback when a condition fails.
OnDowngradeAllowed(string, bool)	Callback when a newer bundle is detected.
OnError(BundleErrorType, string, int, string, int, BundleResult)	Callback when an overall bundle appliation error occurs.
OnForceReboot(int, bool)	Callback when the Burn engine forces a restart.
OnInitializeHelp()	Callback before help will be started.
OnInitializeInstall(bool)	Callback before install will be started.
OnInitializeLayout()	Callback before layout will be started.
OnInitializeModify(bool)	Callback before modify will be started.
OnInitializeRepair(bool)	Callback before repair will be started.
OnInitializeUninstall(bool)	Callback before uninstall will be started.
OnMsiMessage(BundlePackage, BundleInstallMessage, string, int, string[], bool)	Callback when Windows Installer send an message.
OnPackageComplete(BundlePackage, BundleProgressAction, int)	Callback when action on package is complete.
OnPackageProgress(BundlePackageProgress)	Callback on overall package progress update.
OnProgress(BundleOverallProgress)	Callback on overall progress update.
OnResolveSource(string, string, string[], BundleResolveSourceLocation)	Callback when payload or container cannot be located.
OnSameVersionInstalled(string, string, bool, WixToolset.Versioning.WixVersion)	Callback when a bundle with the same version is detected.
OnStartHelp(bool)	Callback when help should be displayed.
OnStartInstall(bool)	Callback when layout preparation should begin.
OnStartLayout(bool)	Callback when installation preparation should begin.
OnStartModify(bool)	Callback when modify preparation should begin.
OnStartProgressInstall(bool)	Callback when layout progress should begin.
OnStartProgressLayout(bool)	Callback when installation progress should begin.
OnStartProgressModify(bool)	Callback when modify progress should begin.
OnStartProgressRepair(bool)	Callback when repair progress should begin.
OnStartProgressUninstall(bool)	Callback when uninstall progress should begin.
OnStartProgressUpdateReplace(bool)	Callback when update progress should begin.
OnStartRepair(bool)	Callback when repair preparation should begin.
OnStartUninstall(bool)	Callback when uninstall preparation should begin.
OnStartUpdateReplace(bool)	Callback when update preparation should begin.
OnUpdateAvailable(string, string)	Callback to determine if update should be executed.
PromptCancel()	Prompt the user to cancel the bundle.
Run()	Runs the BundleUI until Stop().
Stop()	Called to stop the running of the BundleUI.
UpdateCheckAllowed(string)	Callback to determine whether update check can be attempted at updateLocation.

FireGiant.BundleApplicationFramework v6.0.1

CreateWindow() Method

Create (but do not show) the BundleUI window to return the window’s handle to the bootstrapper application.

Declaration

public BundleUIWindowContext CreateWindow()

Return value

BundleUIWindowContext BundleUI window context with the windows handle and optional synchronization context.

OnCompleteCancel(bool restartRequired, bool fullUI) Method

Callback when the bundle application is canceled.

Declaration

public void OnCompleteCancel(
  bool restartRequired,
  bool fullUI
)

Parameters

Parameter	Type	Description
restartRequired	bool	Indicates whether restart is required.
fullUI	bool	Indicates whether UI should be displayed.

OnCompleteFailure(bool restartRequired, int errorCode, bool fullUI) Method

Callback when the bundle application fails.

Declaration

public void OnCompleteFailure(
  bool restartRequired,
  int errorCode,
  bool fullUI
)

Parameters

Parameter	Type	Description
restartRequired	bool	Indicates whether restart is required.
errorCode	int	Error code for the failure.
fullUI	bool	Indicates whether UI should be displayed.

OnCompleteSuccess(bool restartRequired, bool fullUI) Method

Callback when the bundle application succeeds.

Declaration

public void OnCompleteSuccess(
  bool restartRequired,
  bool fullUI
)

Parameters

Parameter	Type	Description
restartRequired	bool	Indicates whether restart is required.
fullUI	bool	Indicates whether UI should be displayed.

OnConditionFailure(BundleCondition condition, string message) Method

Callback when a condition fails.

Declaration

public bool OnConditionFailure(
  BundleCondition condition,
  string message
)

Parameters

Parameter	Type	Description
condition	BundleCondition	Failed condition.
message	string	Formatted message that can be displayed to the user.

Return value

bool False to fail the bundle application.

OnDowngradeAllowed(string bundleId, bool perMachine) Method

Callback when a newer bundle is detected.

Declaration

public bool OnDowngradeAllowed(
  string bundleId,
  bool perMachine
)

Parameters

Parameter	Type	Description
bundleId	string	Id of the new bundle already installed.
perMachine	bool	Indicates wither the newer bundle is per-machine.

Return value

bool True if this bundle should downgrade the newer bundle.

OnError(BundleErrorType type, string packageId, int code, string message, int uIHint, BundleResult recommendation) Method

Callback when an overall bundle appliation error occurs.

Declaration

public BundleResult? OnError(
  BundleErrorType type,
  string packageId,
  int code,
  string message,
  int uIHint,
  BundleResult recommendation
)

Parameters

Parameter	Type	Description
type	BundleErrorType	Type of error.
packageId	string	Optional identifier of package involved in the error.
code	int	Error code.
message	string	Error message.
uIHint	int	Flags for use if displaying a message box.
recommendation	BundleResult	Result recommended by the bundle application for this class of error.

OnForceReboot(int status, bool fullUI) Method

Callback when the Burn engine forces a restart.

Declaration

public bool OnForceReboot(
  int status,
  bool fullUI
)

Parameters

Parameter	Type	Description
status	int	Error code before the force restart.
fullUI	bool	Indicates whether UI should be displayed.

OnInitializeHelp() Method

Callback before help will be started.

Declaration

public void OnInitializeHelp()

OnInitializeInstall(bool fullUI) Method

Callback before install will be started.

Declaration

public void OnInitializeInstall(
  bool fullUI
)

Parameters

Parameter	Type	Description
fullUI	bool	Indicates whether UI should be displayed.

OnInitializeLayout() Method

Callback before layout will be started.

Declaration

public void OnInitializeLayout()

OnInitializeModify(bool fullUI) Method

Callback before modify will be started.

Declaration

public void OnInitializeModify(
  bool fullUI
)

Parameters

Parameter	Type	Description
fullUI	bool	Indicates whether UI should be displayed.

OnInitializeRepair(bool fullUI) Method

Callback before repair will be started.

Declaration

public void OnInitializeRepair(
  bool fullUI
)

Parameters

Parameter	Type	Description
fullUI	bool	Indicates whether UI should be displayed.

OnInitializeUninstall(bool fullUI) Method

Callback before uninstall will be started.

Declaration

public void OnInitializeUninstall(
  bool fullUI
)

Parameters

Parameter	Type	Description
fullUI	bool	Indicates whether UI should be displayed.

OnMsiMessage(BundlePackage package, BundleInstallMessage messageType, string message, int displayParameters, string[] data, bool fullUI) Method

Callback when Windows Installer send an message.

Declaration

public BundleResult? OnMsiMessage(
  BundlePackage package,
  BundleInstallMessage messageType,
  string message,
  int displayParameters,
  string[] data,
  bool fullUI
)

Parameters

Parameter	Type	Description
package	BundlePackage	MSI package that sent the message.
messageType	BundleInstallMessage	Type of message from the Windows Installer.
message	string	Formatted message from the Windows Installer
displayParameters	int	Flags for use if displaying a message box.
data	string[]	Optional data specific to the message provided by the Windows Installer.
fullUI	bool	Indicates whether UI should be displayed.

Return value

BundleResult? Result of the message handling.

OnPackageComplete(BundlePackage package, BundleProgressAction action, int errorCode) Method

Callback when action on package is complete.

Declaration

public void OnPackageComplete(
  BundlePackage package,
  BundleProgressAction action,
  int errorCode
)

Parameters

Parameter	Type	Description
package	BundlePackage	Package completed.
action	BundleProgressAction	Action completed.
errorCode	int	Error encountered during action. 0 indicates success.

OnPackageProgress(BundlePackageProgress packageProgress) Method

Callback on overall package progress update.

Declaration

public void OnPackageProgress(
  BundlePackageProgress packageProgress
)

Parameters

Parameter	Type	Description
packageProgress	BundlePackageProgress	Overall progress.

OnProgress(BundleOverallProgress progress) Method

Callback on overall progress update.

Declaration

public void OnProgress(
  BundleOverallProgress progress
)

Parameters

Parameter	Type	Description
progress	BundleOverallProgress	Overall progress.

OnResolveSource(string packageOrContainerId, string payloadId, string[] sources, BundleResolveSourceLocation locations) Method

Callback when payload or container cannot be located.

Declaration

public bool OnResolveSource(
  string packageOrContainerId,
  string payloadId,
  string[] sources,
  BundleResolveSourceLocation locations
)

Parameters

Parameter	Type	Description
packageOrContainerId	string	Package or container identifier for payload that cannot be found.
payloadId	string	Payload that cannot be found.
sources	string[]	Possible sources where payload was not found.
locations	BundleResolveSourceLocation	New resource source locations to find the payload.

Return value

bool True to retry with new locations, otherwise false to fail the installation.

OnSameVersionInstalled(string bundleId, string bundleTag, bool perMachine, WixToolset.Versioning.WixVersion version) Method

Callback when a bundle with the same version is detected.

Declaration

public BundleSameVersionAction OnSameVersionInstalled(
  string bundleId,
  string bundleTag,
  bool perMachine,
  WixToolset.Versioning.WixVersion version
)

Parameters

Parameter	Type	Description
bundleId	string	Id of the already installed bundle.
bundleTag	string	Tag of the already installed bundle.
perMachine	bool	Indicates wither the newer bundle is per-machine.
version	WixToolset.Versioning.WixVersion	Version of the already installed bundle.

Return value

BundleSameVersionAction Action to handle same version.

OnStartHelp(bool fullUI) Method

Callback when help should be displayed.

Declaration

public bool OnStartHelp(
  bool fullUI
)

Parameters

Parameter	Type	Description
fullUI	bool	Indicates whether UI should be displayed.

Return value

bool True if the BundleUI handles the callback, otherwise bootstrapper application will exit.

OnStartInstall(bool fullUI) Method

Callback when layout preparation should begin.

Declaration

public bool OnStartInstall(
  bool fullUI
)

Parameters

Parameter	Type	Description
fullUI	bool	Indicates whether UI should be displayed.

Return value

bool True if the BundleUI handles the callback, otherwise bootstrapper application will continue on to progress phase.

OnStartLayout(bool fullUI) Method

Callback when installation preparation should begin.

Declaration

public bool OnStartLayout(
  bool fullUI
)

Parameters

Parameter	Type	Description
fullUI	bool	Indicates whether UI should be displayed.

Return value

bool True if the BundleUI handles the callback, otherwise bootstrapper application will continue on to progress phase.

OnStartModify(bool fullUI) Method

Callback when modify preparation should begin.

Declaration

public bool OnStartModify(
  bool fullUI
)

Parameters

Parameter	Type	Description
fullUI	bool	Indicates whether UI should be displayed.

Return value

bool True if the BundleUI handles the callback, otherwise bootstrapper application will continue on to progress phase.

OnStartProgressInstall(bool showUI) Method

Callback when layout progress should begin.

Declaration

public void OnStartProgressInstall(
  bool showUI
)

Parameters

Parameter	Type	Description
showUI	bool	Indicates whether UI should be displayed.

OnStartProgressLayout(bool showUI) Method

Callback when installation progress should begin.

Declaration

public void OnStartProgressLayout(
  bool showUI
)

Parameters

Parameter	Type	Description
showUI	bool	Indicates whether UI should be displayed.

OnStartProgressModify(bool showUI) Method

Callback when modify progress should begin.

Declaration

public void OnStartProgressModify(
  bool showUI
)

Parameters

Parameter	Type	Description
showUI	bool	Indicates whether UI should be displayed.

OnStartProgressRepair(bool showUI) Method

Callback when repair progress should begin.

Declaration

public void OnStartProgressRepair(
  bool showUI
)

Parameters

Parameter	Type	Description
showUI	bool	Indicates whether UI should be displayed.

OnStartProgressUninstall(bool showUI) Method

Callback when uninstall progress should begin.

Declaration

public void OnStartProgressUninstall(
  bool showUI
)

Parameters

Parameter	Type	Description
showUI	bool	Indicates whether UI should be displayed.

OnStartProgressUpdateReplace(bool showUI) Method

Callback when update progress should begin.

Declaration

public void OnStartProgressUpdateReplace(
  bool showUI
)

Parameters

Parameter	Type	Description
showUI	bool	Indicates whether UI should be displayed.

OnStartRepair(bool fullUI) Method

Callback when repair preparation should begin.

Declaration

public bool OnStartRepair(
  bool fullUI
)

Parameters

Parameter	Type	Description
fullUI	bool	Indicates whether UI should be displayed.

Return value

bool True if the BundleUI handles the callback, otherwise bootstrapper application will continue on to progress phase.

OnStartUninstall(bool fullUI) Method

Callback when uninstall preparation should begin.

Declaration

public bool OnStartUninstall(
  bool fullUI
)

Parameters

Parameter	Type	Description
fullUI	bool	Indicates whether UI should be displayed.

Return value

bool True if the BundleUI handles the callback, otherwise bootstrapper application will continue on to progress phase.

OnStartUpdateReplace(bool fullUI) Method

Callback when update preparation should begin.

Declaration

public bool OnStartUpdateReplace(
  bool fullUI
)

Parameters

Parameter	Type	Description
fullUI	bool	Indicates whether UI should be displayed.

Return value

bool True if the BundleUI handles the callback, otherwise bootstrapper application will continue on to progress phase.

OnUpdateAvailable(string updateLocation, string title) Method

Callback to determine if update should be executed.

Declaration

public bool OnUpdateAvailable(
  string updateLocation,
  string title
)

Parameters

Parameter	Type	Description
updateLocation	string	Location where update was found.
title	string	Title of found update.

Return value

bool True if update should be executed.

PromptCancel() Method

Prompt the user to cancel the bundle.

Declaration

public bool PromptCancel()

Return value

bool True if the user allowed the cancel.

Run() Method

Runs the BundleUI until Stop().

Declaration

public void Run()

Stop() Method

Called to stop the running of the BundleUI.

Declaration

public void Stop()

UpdateCheckAllowed(string updateLocation) Method

Callback to determine whether update check can be attempted at updateLocation.

Declaration

public bool UpdateCheckAllowed(
  string updateLocation
)

Parameters

Parameter	Type	Description
updateLocation	string	Location to check for updates.

Return value

bool True to allow check for update.