Type Definitions
AppAssetInfo
AppAssetInfo interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
src |
string | The URL to a zip file containing the package files (executables, dlls, etc…) |
alias |
string | The name of the asset |
version |
string | The version of the package |
target |
string | Specify default executable to launch. This option can be overridden in launchExternalProcess |
args |
args | The default command line arguments for the aforementioned target. |
mandatory |
boolean | When set to true, the app will fail to load if the asset cannot be downloaded. When set to false, the app will continue to load if the asset cannot be downloaded. (Default: true) |
AppAssetRequest
AppAssetRequest interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
alias |
string | The name of the asset |
Area
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
height |
number | Area's height |
width |
number | Area's width |
x |
number | X coordinate of area's starting point |
y |
number | Y coordinate of area's starting point |
Bounds
Bounds is a interface that has the properties of height, width, left, top which are all numbers
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
height |
number | Get the application height bound |
width |
number | Get the application width bound |
top |
number | Get the application top bound |
left |
number | Get the application left bound |
right |
number | Get the application right bound |
bottom |
number | Get the application bottom bound |
ClearCacheOption
Clear cache options.
These are the options required by the clearCache function.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
appcache |
boolean | html5 application cache |
cache |
boolean | browser data cache for html files and images |
cookies |
boolean | browser cookies |
localStorage |
boolean | browser data that can be used across sessions |
CookieInfo
CookieInfo interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
name |
string | The name of the cookie |
domain |
string | The domain of the cookie |
path |
string | The path of the cookie |
CookieOption
CookieOption interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
name |
string | The name of the cookie |
CrashReporterOption
CrashReporterOption interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
diagnosticMode |
boolean | In diagnostic mode the crash reporter will send diagnostic logs to the OpenFin reporting service on runtime shutdown |
isRunning |
boolean | check if it's running |
DownloadPreloadInfo
downloadPreloadScripts function return value
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
url |
string | url to the preload script |
error |
string | error during preload script acquisition |
succeess |
boolean | download operation success |
DownloadPreloadOption
These are the options object required by the downloadPreloadScripts function
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
url |
string | url to the preload script |
Entity
Entity interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
type |
string | The type of the entity |
uuid |
string | The uuid of the entity |
EntityInfo
EntityInfo interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
name |
string | The name of the entity |
uuid |
string | The uuid of the entity |
parent |
Identity | The parent of the entity |
entityType |
string | The type of the entity |
ExternalConnection
ExternalConnection interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
token |
string | The token to broker an external connection |
uuid |
string | The uuid of the external connection |
ExternalProcessRequestType
ExternalProcessRequestType interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
path |
string | The file path to where the running application resides |
arguments |
string | The argument passed to the running application |
listener |
Object | This is described in the {LaunchExternalProcessListner} type definition |
GetLogRequestType
GetLogRequestType interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
name |
string | The name of the running application |
endFile |
number | The file length of the log file |
sizeLimit |
number | The set size limit of the log file |
Identity
Identity interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
name |
string | The name of the application |
uuid |
string | The uuid of the application |
legacyWindowIdentity
Object summary
Object description
Type:
- object
Properties:
| Name | Type | Description |
|---|---|---|
appUuid |
string | The UUID of the application this window entry belongs to. |
windowName |
string | The name of this window entry. |
LogLevel
Log verbosity levels.
Describes the minimum level (inclusive) above which logs will be written
Type:
- verbose | info | warning | error | fatal
Properties:
| Name | Type | Description |
|---|---|---|
verbose |
string | all logs written |
info |
string | info and above |
warning |
string | warning and above |
error |
string | error and above |
fatal |
string | fatal only, indicates a crash is imminent |
Opacity
Type:
- object
Properties:
| Name | Type | Description |
|---|---|---|
duration |
number | The total time in milliseconds this transition should take. |
relative |
boolean | Treat 'opacity' as absolute or as a delta. Defaults to false. |
opacity |
number | This value is clamped from 0.0 to 1.0. |
Position
Type:
- object
Properties:
| Name | Type | Description |
|---|---|---|
duration |
number | The total time in milliseconds this transition should take. |
relative |
boolean | Treat 'opacity' as absolute or as a delta. Defaults to false. |
left |
number | Defaults to the window's current left position in virtual screen coordinates. |
top |
number | Defaults to the window's current top position in virtual screen coordinates. |
preloadScriptState
Object summary
Object description
Type:
- object
Properties:
| Name | Type | Description |
|---|---|---|
url |
string | The url of the preload script. |
state |
string | The preload script state: "load-failed", "failed", "succeeded" |
ProxyConfig
ProxyConfig interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
proxyPort |
numder | The port number of the running application |
proxyAddress |
string | The address of the running application |
type |
string |
RegistryInfo
RegistryInfo interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
data |
any | The registry data |
rootKey |
string | The registry root key |
subkey |
string | The registry key |
type |
string | The registry type |
value |
string | The registry value name |
RuntimeDownloadOptions
These are the options object required by the downloadRuntime function.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
version |
string | The given version to download |
Size
Type:
- object
Properties:
| Name | Type | Description |
|---|---|---|
duration |
number | The total time in milliseconds this transition should take. |
relative |
boolean | Treat 'opacity' as absolute or as a delta. Defaults to false. |
width |
number | Optional if height is present. Defaults to the window's current width. |
height |
number | Optional if width is present. Defaults to the window's current height. |
TerminateExternalRequestType
TerminateExternalRequestType interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
uuid |
string | The uuid of the running application |
timeout |
number | Time out period before the running application terminates |
killtree |
boolean | Value to terminate the running application |
Transition
Type:
- object
Properties:
| Name | Type | Description |
|---|---|---|
opacity |
Opacity | The Opacity transition |
position |
Position | The Position transition |
size |
Size | The Size transition |
TransitionOptions
Type:
- object
Properties:
| Name | Type | Description |
|---|---|---|
interrupt |
boolean | This option interrupts the current animation. When false it pushes this animation onto the end of the animation queue. |
relative |
boolean | Treat 'opacity' as absolute or as a delta. Defaults to false. |
WriteRequestType
WriteRequestType interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
name |
string | The name of the running application |
uuid |
string | The uuid of the running application |