Skip to content

Commit 66f194e

Browse files
FireGiantDocsFireGiantDocs
committed
Add the FireGiant Bundle Application Framework API Reference
1 parent 8f520c4 commit 66f194e

32 files changed

+2524
-1
lines changed

‎astro.config.mjs‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,10 @@ export default defineConfig({
116116
] },
117117
] },
118118

119-
{ label: 'API Reference', collapsed: true, autogenerate: { directory: '/wix/api' } },
119+
{ label: 'API Reference', collapsed: true, items: [
120+
{ label: 'FireGiant Bundle Application Framework API', collapsed: true, autogenerate: { directory: '/firegiant/api/firegiantbundleapplicationframework' } },
121+
{ label: 'WiX Toolset API', collapsed: true, autogenerate: { directory: '/wix/api' } },
122+
] },
120123
{ label: 'Schema Reference', collapsed: true, items: [
121124
{ label: 'WiX Core Schema', collapsed: true, autogenerate: { directory: '/wix/schema/wxs' } },
122125
{ label: 'Localization Schema', collapsed: true, autogenerate: { directory: '/wix/schema/wxl' } },

‎src/content/docs/firegiant/api/firegiantbundleapplicationframework/bundleaction.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: BundleAction Enumeration
3+
pagefind: false
4+
---
5+
Bundle actions.
6+
## Members
7+
| Member | Description |
8+
| ------ | ----------- |
9+
| Cache | Cache bundle action. |
10+
| Help | Help bundle action. |
11+
| Install | Install bundle action. |
12+
| Layout | Layout bundle action. |
13+
| Modify | Modify bundle action. |
14+
| Repair | Repair bundle action. |
15+
| Uninstall | Uninstall bundle action. |
16+
| Unknown | Unknown bundle action. |
17+
| UpdateReplace | Update bundle action. |
18+
| UpdateReplaceEmbedded | Update using embedded bundle action. |
19+
20+
`FireGiant.BundleApplicationFramework v6.0.1`

‎src/content/docs/firegiant/api/firegiantbundleapplicationframework/bundleactionstate.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: BundleActionState Enumeration
3+
pagefind: false
4+
---
5+
Action state for a package or bundle.
6+
## Members
7+
| Member | Description |
8+
| ------ | ----------- |
9+
| AdminInstall | Administrative install action state. |
10+
| Install | Install action state. |
11+
| MajorUpgrade | Major upgrade action state. |
12+
| Mend | Mend action state. |
13+
| MinorUpgrade | Minor upgrade action state. |
14+
| Modify | Modify action state. |
15+
| None | No action or do not change the action state. |
16+
| Patch | Patch action state. |
17+
| Repair | Repair action state. |
18+
| Uninstall | Uninstall action state. |
19+
20+
`FireGiant.BundleApplicationFramework v6.0.1`

‎src/content/docs/firegiant/api/firegiantbundleapplicationframework/bundleapplyphase.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: BundleApplyPhase Enumeration
3+
pagefind: false
4+
---
5+
Apply phases of a bundle.
6+
## Members
7+
| Member | Description |
8+
| ------ | ----------- |
9+
| Acquire | Acquire (download/cache/verify) phase. |
10+
| Execute | Execute (install/uninstall) phase. |
11+
| Rollback | Rollback phase. |
12+
| Unknown | Unknown apply phase. |
13+
14+
`FireGiant.BundleApplicationFramework v6.0.1`

‎src/content/docs/firegiant/api/firegiantbundleapplicationframework/bundlecacheoperation.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: BundleCacheOperation Enumeration
3+
pagefind: false
4+
---
5+
Bundle cache operations.
6+
## Members
7+
| Member | Description |
8+
| ------ | ----------- |
9+
| Copy | Copy payload to cache. |
10+
| Download | Download payload to cache. |
11+
| Extract | Extract payload from containers to cache. |
12+
| None | Payload source is not available. |
13+
| Unknown | Unknown cache operation. |
14+
15+
`FireGiant.BundleApplicationFramework v6.0.1`

‎src/content/docs/firegiant/api/firegiantbundleapplicationframework/bundlecondition.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: BundleCondition Class
3+
pagefind: false
4+
---
5+
Condition evaluated during bundle initialization.
6+
## Properties
7+
| Property | Description |
8+
| ------ | ----------- |
9+
| [Condition](#condition) | Condition to evaluate. If the condition evaluates to false, Message is displayed and executionis blocked. |
10+
| [Message](#message) | Message to be shown when the Condition fails. |
11+
### Remarks
12+
Use the bal:Condition element to add conditions to your bundle.
13+
14+
`FireGiant.BundleApplicationFramework v6.0.1`
15+
## Condition Property {#condition}
16+
Condition to evaluate. If the condition evaluates to false, Message is displayed and executionis blocked.
17+
### Declaration
18+
```cs
19+
public string Condition { get; set; }
20+
```
21+
## Message Property {#message}
22+
Message to be shown when the Condition fails.
23+
### Declaration
24+
```cs
25+
public string Message { get; set; }
26+
```

‎src/content/docs/firegiant/api/firegiantbundleapplicationframework/bundleerrortype.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: BundleErrorType Enumeration
3+
pagefind: false
4+
---
5+
Types of error.
6+
## Members
7+
| Member | Description |
8+
| ------ | ----------- |
9+
| Apply | Failure during apply phase. |
10+
| Elevate | Failure during elevation. |
11+
| ExePackage | Failure from an executable package. |
12+
| HttpProxyAuthentication | Failure to authenticate with an HTTP proxy. |
13+
| HttpServerAuthentication | Failure to authenticate with an HTTP server. |
14+
| WindowsInstaller | Failure from Windows Installer. |
15+
16+
`FireGiant.BundleApplicationFramework v6.0.1`

‎src/content/docs/firegiant/api/firegiantbundleapplicationframework/bundlefeature.md‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
---
2+
title: BundleFeature Class
3+
pagefind: false
4+
---
5+
Details about a feature that is part of a Bundle's package.
6+
## Properties
7+
| Property | Description |
8+
| ------ | ----------- |
9+
| [Attributes](#attributes) | The default remote execution option for the feature. |
10+
| [Description](#description) | Description of the package. |
11+
| [Display](#display) | The number in this field specifies the order in which the feature is to be displayed in the user interface.
12+
The value also determines whether or not the feature is initially displayed expanded or collapsed. If the value is null or 0 (zero), the record is not displayed.
13+
If the value is odd, the feature node is expanded initially.
14+
If the value is even, the feature node is collapsed initially. |
15+
| [Id](#id) | Unique identity of the feature in the package. |
16+
| [Level](#level) | The installation level of this feature. |
17+
| [PackageId](#packageid) | Unique identity of the package in the chain. |
18+
| [ParentId](#parentid) | Optional identity of the parent of a feature in the package. |
19+
| [RequestState](#requeststate) | Request state for the feature. |
20+
| [RequestStateSet](#requeststateset) | Indicates whether the request state was explicitly set by the BundleUI. |
21+
| [Size](#size) | Size of the files contained in the feature. |
22+
| [State](#state) | Feature state. |
23+
| [Title](#title) | Title of feature in the package. |
24+
25+
`FireGiant.BundleApplicationFramework v6.0.1`
26+
## Attributes Property {#attributes}
27+
The default remote execution option for the feature.
28+
### Declaration
29+
```cs
30+
public int Attributes { get; set; }
31+
```
32+
## Description Property {#description}
33+
Description of the package.
34+
### Declaration
35+
```cs
36+
public string Description { get; set; }
37+
```
38+
## Display Property {#display}
39+
The number in this field specifies the order in which the feature is to be displayed in the user interface.
40+
The value also determines whether or not the feature is initially displayed expanded or collapsed. If the value is null or 0 (zero), the record is not displayed.
41+
If the value is odd, the feature node is expanded initially.
42+
If the value is even, the feature node is collapsed initially.
43+
### Declaration
44+
```cs
45+
public int Display { get; set; }
46+
```
47+
## Id Property {#id}
48+
Unique identity of the feature in the package.
49+
### Declaration
50+
```cs
51+
public string Id { get; set; }
52+
```
53+
## Level Property {#level}
54+
The installation level of this feature.
55+
### Declaration
56+
```cs
57+
public int Level { get; set; }
58+
```
59+
## PackageId Property {#packageid}
60+
Unique identity of the package in the chain.
61+
### Declaration
62+
```cs
63+
public string PackageId { get; set; }
64+
```
65+
## ParentId Property {#parentid}
66+
Optional identity of the parent of a feature in the package.
67+
### Declaration
68+
```cs
69+
public string ParentId { get; set; }
70+
```
71+
## RequestState Property {#requeststate}
72+
Request state for the feature.
73+
### Declaration
74+
```cs
75+
public BundleFeatureState RequestState { get; set; }
76+
```
77+
## RequestStateSet Property {#requeststateset}
78+
Indicates whether the request state was explicitly set by the BundleUI.
79+
### Declaration
80+
```cs
81+
public bool RequestStateSet { get; set; }
82+
```
83+
## Size Property {#size}
84+
Size of the files contained in the feature.
85+
### Declaration
86+
```cs
87+
public int Size { get; set; }
88+
```
89+
## State Property {#state}
90+
Feature state.
91+
### Declaration
92+
```cs
93+
public BundleFeatureState State { get; set; }
94+
```
95+
## Title Property {#title}
96+
Title of feature in the package.
97+
### Declaration
98+
```cs
99+
public string Title { get; set; }
100+
```

‎src/content/docs/firegiant/api/firegiantbundleapplicationframework/bundlefeaturestate.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: BundleFeatureState Enumeration
3+
pagefind: false
4+
---
5+
Feature state.
6+
## Members
7+
| Member | Description |
8+
| ------ | ----------- |
9+
| Absent | Feature is not installed. |
10+
| Advertised | Feature is advertised. |
11+
| Local | Feature is installed locally. |
12+
| Source | Feature is installed run from source. |
13+
| Unknown | Feature state is unkown. |
14+
15+
`FireGiant.BundleApplicationFramework v6.0.1`

‎src/content/docs/firegiant/api/firegiantbundleapplicationframework/bundleinstallmessage.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: BundleInstallMessage Enumeration
3+
pagefind: false
4+
---
5+
Types of messages sent during apply.
6+
## Members
7+
| Member | Description |
8+
| ------ | ----------- |
9+
| ActionData | Data from an action. |
10+
| ActionStart | Start of an action. |
11+
| CommonData | Data sent by Windows Installer. |
12+
| Error | Error. |
13+
| FatalExit | Fatal exit. |
14+
| FilesInUse | Files in use prompt. |
15+
| Info | Informational message. |
16+
| Initialize | Initialize message. |
17+
| OutOfDiskSpace | Out of disk space error. |
18+
| Progress | Progress from an action. |
19+
| ResolveSource | Source resolution prompt. |
20+
| RMFilesInUse | Restart manager files in use prompt. |
21+
| ShowDialog | Show dialog prompt. |
22+
| Terminate | Terminate message. |
23+
| User | Message requiring user interaction. |
24+
| Warning | Warning. |
25+
26+
`FireGiant.BundleApplicationFramework v6.0.1`

0 commit comments

Comments
 (0)