IBundleApplication Interface

Bundle application provided to support the BundleUI.

Methods

Method	Description
Cancel()	Sets the bundle application to be canceled.
CheckCanceled()	Check to see if the bundle application has been canceled.
CheckFailed()	Check to see if the bundle application is in an error state.
CloseSplashScreen()	Directs the Burn engine to dismiss the splash screen.
DetectAgain()	Requests the Burn engine re-execute detection after UIReady() was already called.
DisallowRestart()	Directs the Burn engine to best-effort prevent restarts.
Error(int)	Sets the bundle error state.
EvaluateCondition(string)	Request the Burn engine evalute a condition.
FormatString(string)	Request the Burn engine to resolve a string with variable references (“[VARNAME]”).
GetBundleLogPath()	Get the path to the bundle log file.
GetCommandLineArguments()	Returns the bundle command-line arguments.
GetManifest()	Returns the bundle manifest.
GetNumericVariable(string)	Gets a numeric variable.
GetPackage(int)	Gets a package by index.
GetPackage(string)	Gets a package by identity.
GetStringVariable(string)	Gets a string variable.
GetVersionVariable(string)	Gets a version variable.
Go()	Directs the bundle application to plan with the default PlanAction.
GoWithAction(BundleAction)	Directs the bundle applicaiton to plan a specific action.
LogError(int, string, string[])	Log an error message to the bundle’s log file.
LogMessage(string, string[])	Log a message to the bundle’s log file.
ParseCommandLine()	Parse the bundle command-line for the pattern VARNAME=VALUE to assign variables.
PromptCancel(string, string)	Prompts the user to cancel with a specific cancel message.
SendCancelPrompt()	Requests the bundle application to prompt for cancel.
SendEmbeddedError(int, string, int)	Send message to parent bundle when embedded.
SetPlanFeatureRequestState(string, string, BundleFeatureState)	Sets the requested state for a package’s feature. Must be called before calling Go() or GoWithAction().
SetPlanPackageRequestState(string, BundleRequestState)	Sets the requested state for a package. Must be called before calling Go() or GoWithAction().
SetVariable(string, string)	Sets a string variable.
SetVariable(string, long)	Sets a numeric variable.
SetVersionVariable(string, string)	Sets a version variable.
UIReady()	Obsolete. This method is unused.

Properties

Property	Description
AllowRestart	Indicates whether restarts are allowed.
PackageCount	Count of packages in the bundle.
Packages	Enumerates the packages in the bundle.
PlanAction	The default plan action set via the bundle command-line.
RestartRequired	Indicates whether a restart was required.
ResumeType	Resume type of the bundle.
RollingBack	Indicates if the bundle application is rolling back.

FireGiant.BundleApplicationFramework v6.0.1

Cancel() Method

Sets the bundle application to be canceled.

Declaration

public void Cancel()

CheckCanceled() Method

Check to see if the bundle application has been canceled.

Declaration

public bool CheckCanceled()

Return value

bool True if the bundle application was canceled.

CheckFailed() Method

Check to see if the bundle application is in an error state.

Declaration

public bool CheckFailed()

Return value

bool True if the bundle application is in an error state.

CloseSplashScreen() Method

Directs the Burn engine to dismiss the splash screen.

Declaration

public void CloseSplashScreen()

DetectAgain() Method

Requests the Burn engine re-execute detection after UIReady() was already called.

Declaration

public void DetectAgain()

DisallowRestart() Method

Directs the Burn engine to best-effort prevent restarts.

Declaration

public void DisallowRestart()

Error(int errorCode) Method

Sets the bundle error state.

Declaration

public bool Error(
  int errorCode
)

Parameters

Parameter	Type	Description
errorCode	int	Error code to set.

Return value

bool True if the bundle is in an error state.

EvaluateCondition(string condition) Method

Request the Burn engine evalute a condition.

Declaration

public bool EvaluateCondition(
  string condition
)

Parameters

Parameter	Type	Description
condition	string	Condition to evaluate.

Return value

bool Evaluation of condition.

FormatString(string format) Method

Request the Burn engine to resolve a string with variable references (“[VARNAME]”).

Declaration

public string FormatString(
  string format
)

Parameters

Parameter	Type	Description
format	string	String with variable references to resolve.

Return value

string Formatted string.

GetBundleLogPath() Method

Get the path to the bundle log file.

Declaration

public string GetBundleLogPath()

GetCommandLineArguments() Method

Returns the bundle command-line arguments.

Declaration

public string[] GetCommandLineArguments()

Return value

string[] Array of command-line arguments.

GetManifest() Method

Returns the bundle manifest.

Declaration

public System.Xml.Linq.XDocument GetManifest()

Return value

System.Xml.Linq.XDocument XML document containing the bundle manifest.

GetNumericVariable(string name) Method

Gets a numeric variable.

Declaration

public long? GetNumericVariable(
  string name
)

Parameters

Parameter	Type	Description
name	string	Name of variable to retrieve.

Return value

long? Long or null if the variable is not defined.

GetPackage(int index) Method

Gets a package by index.

Declaration

public BundlePackage GetPackage(
  int index
)

Parameters

Parameter	Type	Description
index	int	Index of package to retrieve.

Return value

BundlePackage Bundle package.

GetPackage(string id) Method

Gets a package by identity.

Declaration

public BundlePackage GetPackage(
  string id
)

Parameters

Parameter	Type	Description
id	string	Identity of package to retrieve.

Return value

BundlePackage Bundle package.

GetStringVariable(string name) Method

Gets a string variable.

Declaration

public string GetStringVariable(
  string name
)

Parameters

Parameter	Type	Description
name	string	Name of variable to retrieve.

Return value

string String or null if the variable is not defined.

GetVersionVariable(string name) Method

Gets a version variable.

Declaration

public string GetVersionVariable(
  string name
)

Parameters

Parameter	Type	Description
name	string	Name of variable to retrieve.

Return value

string Version or null if the variable is not defined.

Go() Method

Directs the bundle application to plan with the default PlanAction.

Declaration

public void Go()

GoWithAction(BundleAction action) Method

Directs the bundle applicaiton to plan a specific action.

Declaration

public void GoWithAction(
  BundleAction action
)

Parameters

Parameter	Type	Description
action	BundleAction

LogError(int errorCode, string format, string[] args) Method

Log an error message to the bundle’s log file.

Declaration

public void LogError(
  int errorCode,
  string format,
  string[] args
)

Parameters

Parameter	Type	Description
errorCode	int	Error code for the message
format	string	Format string for the message.
args	string[]	Data to provide to the format.

LogMessage(string format, string[] args) Method

Log a message to the bundle’s log file.

Declaration

public void LogMessage(
  string format,
  string[] args
)

Parameters

Parameter	Type	Description
format	string	Format string for the message.
args	string[]	Data to provide to the format.

ParseCommandLine() Method

Parse the bundle command-line for the pattern VARNAME=VALUE to assign variables.

Declaration

public void ParseCommandLine()

PromptCancel(string message, string caption) Method

Prompts the user to cancel with a specific cancel message.

Declaration

public bool PromptCancel(
  string message,
  string caption
)

Parameters

Parameter	Type	Description
message	string	Message to display.
caption	string	Caption of the cancel prompt.

Return value

bool True if the user chose to cancel.

SendCancelPrompt() Method

Requests the bundle application to prompt for cancel.

Declaration

public bool SendCancelPrompt()

Return value

bool True if the user chose to cancel.

SendEmbeddedError(int code, string message, int uiHint) Method

Send message to parent bundle when embedded.

Declaration

public int SendEmbeddedError(
  int code,
  string message,
  int uiHint
)

Parameters

Parameter	Type	Description
code	int	Status code to send.
message	string	Message to send.
uiHint	int	Flags to send.

Return value

int Result from parent bundle.

SetPlanFeatureRequestState(string packageId, string featureId, BundleFeatureState requestState) Method

Sets the requested state for a package’s feature. Must be called before calling Go() or GoWithAction().

Declaration

public void SetPlanFeatureRequestState(
  string packageId,
  string featureId,
  BundleFeatureState requestState
)

Parameters

Parameter	Type	Description
packageId	string	Identity of the package containing the feature.
featureId	string	Identity of the feature to set plan state.
requestState	BundleFeatureState	Requested state to assign to feature.

SetPlanPackageRequestState(string packageId, BundleRequestState requestState) Method

Sets the requested state for a package. Must be called before calling Go() or GoWithAction().

Declaration

public void SetPlanPackageRequestState(
  string packageId,
  BundleRequestState requestState
)

Parameters

Parameter	Type	Description
packageId	string	Identity of the package to set plan state.
requestState	BundleRequestState	Requested state to assign to package.

SetVariable(string name, string value) Method

Sets a string variable.

Declaration

public void SetVariable(
  string name,
  string value
)

Parameters

Parameter	Type	Description
name	string	Name of variable to set.
value	string	Value of variable to set.

SetVariable(string name, long value) Method

Sets a numeric variable.

Declaration

public void SetVariable(
  string name,
  long value
)

Parameters

Parameter	Type	Description
name	string	Name of variable to set.
value	long	Value of variable to set.

SetVersionVariable(string name, string value) Method

Sets a version variable.

Declaration

public void SetVersionVariable(
  string name,
  string value
)

Parameters

Parameter	Type	Description
name	string	Name of variable to set.
value	string	Value of variable to set.

UIReady() Method

Obsolete. This method is unused.

Declaration

public void UIReady()

AllowRestart Property

Indicates whether restarts are allowed.

Declaration

public bool AllowRestart { get; set; }

PackageCount Property

Count of packages in the bundle.

Declaration

public int PackageCount { get; set; }

Packages Property

Enumerates the packages in the bundle.

Declaration

public IEnumerable{BundlePackage} Packages { get; set; }

PlanAction Property

The default plan action set via the bundle command-line.

Declaration

public BundleAction PlanAction { get; set; }

RestartRequired Property

Indicates whether a restart was required.

Declaration

public bool RestartRequired { get; set; }

ResumeType Property

Resume type of the bundle.

Declaration

public BundleResumeType ResumeType { get; set; }

RollingBack Property

Indicates if the bundle application is rolling back.

Declaration

public bool RollingBack { get; set; }