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 |
string | 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 |
ApplicationInfo
ApplicationInfo interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
isRunning |
boolean | true when the application is running |
uuid |
string | uuid of the application |
parentUuid |
string | uuid of the application that launches this application |
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 |
CpuInfo
CpuInfo interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
model |
string | The model of the cpu |
speed |
number | The number in MHz |
times |
Time | The numbers of milliseconds the CPU has spent in different modes. |
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 |
DipRect
DipRect interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
dipRect |
Rect | The DIP coordinates |
scaledRect |
Rect | The scale coordinates |
DipScaleRects
DipScaleRects interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
dipRect |
Rect | The DIP coordinates |
scaledRect |
Rect | The scale coordinates |
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 |
ExternalApplicationInfo
ExternalApplicationInfo interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
parent |
Identity | The parent identity |
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 |
FrameInfo
FrameInfo interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
name |
string | The name of the frame |
uuid |
string | The uuid of the frame |
entityType |
entityType | The entity type, could be 'window', 'iframe', 'external connection' or 'unknown' |
parent |
Identity | The parent identity |
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 |
GpuInfo
GpuInfo interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
name |
string | The graphics card name |
HostSpecs
HostSpecs interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
aeroGlassEnabled |
boolean | Value to check if Aero Glass theme is supported on Windows platforms |
arch |
string | "x86" for 32-bit or "x86_64" for 64-bit |
cpus |
Array.<CpuInfo> | The same payload as Node's os.cpus() |
gpu |
GpuInfo | The graphics card name |
memory |
number | The same payload as Node's os.totalmem() |
name |
string | The OS name and version/edition |
screenSaver |
boolean | Value to check if screensaver is running. Supported on Windows only |
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. |
LogInfo
LogInfo interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
name |
string | The filename of the log |
size |
number | The size of the log in bytes |
date |
string | The unix time at which the log was created "Thu Jan 08 2015 14:40:30 GMT-0500 (Eastern Standard Time)"" |
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 |
MonitorDetails
MonitorDetails interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
available |
DipScaleRects | The available DIP scale coordinates |
availableRect |
Rect | The available monitor coordinates |
deviceId |
string | The device id of the display |
displayDeviceActive |
boolean | true if the display is active |
deviceScaleFactor |
number | The device scale factor |
monitorRect |
Rect | The monitor coordinates |
name |
string | The name of the display |
dpi |
Point | The dots per inch |
monitor |
DipScaleRects | The monitor coordinates |
MonitorInfo
MonitorInfo interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
deviceScaleFactor |
number | The device scale factor |
dpi |
Point | The dots per inch |
nonPrimaryMonitors |
Array.<MonitorDetails> | The array of monitor details |
primaryMonitor |
MonitorDetails | The monitor details |
reason |
string | always "api-query" |
taskBar |
TaskBar | The taskbar on monitor |
virtualScreen |
DipRect | The virtual display screen coordinates |
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. |
Point
Point interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
x |
number | The mouse x position |
y |
number | The mouse y position |
PointTopLeft
PointTopLeft interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
top |
number | The mouse top position in virtual screen coordinates |
left |
number | The mouse left position in virtual screen coordinates |
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" |
ProcessInfo
ProcessInfo interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
cpuUsage |
numder | The percentage of total CPU usage |
name |
string | The application name |
nonPagedPoolUsage |
number | The current nonpaged pool usage in bytes |
pageFaultCount |
number | The number of page faults |
pagedPoolUsage |
number | The current paged pool usage in bytes |
pagefileUsage |
number | The total amount of memory in bytes that the memory manager has committed |
peakNonPagedPoolUsage |
number | The peak nonpaged pool usage in bytes |
peakPagedPoolUsage |
number | The peak paged pool usage in bytes |
peakPagefileUsage |
number | The peak value in bytes of pagefileUsage during the lifetime of this process |
peakWorkingSetSize |
number | The peak working set size in bytes |
processId |
number | The native process identifier |
uuid |
string | The application UUID |
workingSetSize |
nubmer | The current working set size (both shared and private data) in bytes |
ProxyConfig
ProxyConfig interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
proxyAddress |
string | The configured proxy address |
proxyPort |
numder | The configured proxy port |
type |
string | The proxy Type |
ProxyInfo
ProxyInfo interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
config |
ProxyConfig | The proxy config |
system |
ProxySystemInfo | The proxy system info |
ProxySystemInfo
ProxySystemInfo interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
autoConfigUrl |
string | The auto configuration url |
bypass |
string | The proxy bypass info |
enabled |
boolean | Value to check if a proxy is enabled |
proxy |
string | The proxy info |
Rect
Rect interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
bottom |
number | The bottom-most coordinate |
left |
nubmer | The left-most coordinate |
right |
number | The right-most coordinate |
top |
nubmer | The top-most coordinate |
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 |
RuntimeInfo
RuntimeInfo interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
architecture |
string | The runtime build architecture |
manifestUrl |
string | The runtime manifest URL |
port |
nubmer | The runtime websocket port |
securityRealm |
string | The runtime security realm |
version |
string | The runtime version |
RVMInfo
RVMInfo interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
action |
string | The name of action: "get-rvm-info" |
appLogDirectory |
string | The app log directory |
path |
string | The path of OpenfinRVM.exe |
'start-time' |
string | The start time of RVM |
version |
string | The version of RVM |
'working-dir' |
string | The working directory |
ShortCutConfig
ShortCutConfig interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
desktop |
boolean | true if application has a shortcut on the desktop |
startMenu |
boolean | true if application has shortcut in the start menu |
systemStartup |
boolean | true if application will be launched on system startup |
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. |
TaskBar
TaskBar interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
edge |
string | which edge of a monitor the taskbar is on |
rect |
Rect | The taskbar coordinates |
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 |
Time
Time interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
user |
number | The number of milliseconds the CPU has spent in user mode |
nice |
number | The number of milliseconds the CPU has spent in nice mode |
sys |
number | The number of milliseconds the CPU has spent in sys mode |
idle |
number | The number of milliseconds the CPU has spent in idle mode |
irq |
number | The number of milliseconds the CPU has spent in irq mode |
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. |
TrayInfo
TrayInfo interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
bounds |
Bounds | The bound of tray icon in virtual screen pixels |
monitorInfo |
MonitorInfo | Please see fin.System.getMonitorInfo for more information |
x |
number | copy of bounds.x |
y |
number | copy of bounds.y |
WindowDetail
WindowDetail interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
bottom |
number | The bottom-most coordinate of the window |
height |
number | The height of the window |
isShowing |
boolean | Value to check if the window is showing |
left |
number | The left-most coordinate of the window |
name |
string | The name of the window |
right |
number | The right-most coordinate of the window |
state |
string | The window state |
top |
number | The top-most coordinate of the window |
width |
number | The width of the window |
WindowInfo
WindowInfo interface
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
childWindows |
Array.<WindowDetail> | The array of child windows details |
mainWindow |
WindowDetail | The main window detail |
uuid |
string | The uuid of the application |
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 |