Have you been using our legacy API under the
fin.desktop
object? Welcome to the new and improved V2 API! You can now access the same classes and methods directly on the fin
object. Please read this explanation of the differences between the legacy V1 API and the new V2 API.
Welcome to the JavaScript API. This API allows you to create an HTML/JavaScript application that has access to the native windowing environment, can communicate with other applications and has access to sandboxed system-level features.
The fin
namespace
When running within the OpenFin Runtime your web applications have access to the fin
namespace and all the modules within the API without the need to include additional source files.
You can treat the fin
namespace as you would the window
, navigator
or document
objects.
API Methods
The full API Method Index can be found below.
- To find a specific method by name, simply search this page.
- To browse the API, click one of the classes or namespaces in the sidebar at left.
Configuration
New applications and windows are instantiated by the respective start
and create
calls with the following options objects:
- The Application Options object is consumed by Application.start
- The Window Options object is consumed by Window.create
For a single-page reference to all application settings and configuration options, see also our Application Config page.
Example
<!DOCTYPE html>
<head>
<style>
#status-indicator {
display: inline-block;
height: 10px;
width: 10px;
background-color: red;
border-radius: 20px;
}
#status-indicator.online {
background-color: green;
}
</style>
<script type="text/javascript">
fin.System.getVersion().then(version => {
document.querySelector('#of-version').innerText = version;
});
</script>
</head>
<body>
<p>
OpenFin version <span id="of-version"></span>
</p>
</body>
</html>
Index of API Methods
- animate Window
- authenticate Window
- blur Window
- bringToFront Window
- clearCache System
- close Notification
- close Window
- connect Channel
- create Notification
- create Channel
- create Window
- createFromManifest Application
- deleteCacheOnExit System
- disableUserMovement Window
- dispatch ChannelClient
- dispatch ChannelProvider
- downloadAsset System
- downloadPreloadScripts System
- downloadRuntime System
- enableUserMovement Window
- executeJavaScript Window
- exit System
- flash Window
- flushCookieStore System
- focus Window
- getAllApplications System
- getAllExternalApplications System
- getAllWindows System
- getAppAssetInfo System
- getAvailableFormats Clipboard
- getBounds Window
- getChildWindows Application
- getCommandLineArguments System
- getCookies System
- getCrashReporterState System
- getCurrent Application
- getCurrent Frame
- getCurrent Notification
- getCurrent Window
- getCurrentSync Application
- getCurrentSync Frame
- getCurrentSync Notification
- getCurrentSync Window
- getDeviceUserId System
- getEntityInfo System
- getEnvironmentVariable System
- getFocusedWindow System
- getGroup Window
- getGroups Application
- getHostSpecs System
- getInfo Application
- getInfo ExternalApplication
- getInfo Frame
- getInfo Window
- getLog System
- getLogList System
- getMachineId System
- getMinLogLevel System
- getManifest Application
- getMonitorInfo System
- getMousePosition System
- getOptions Window
- getParentApplication Window
- getParentUuid Application
- getParentWindow Frame
- getParentWindow Window
- getProcessList System
- getProxySettings System
- getRuntimeInfo System
- getRvmInfo System
- getShortcuts Application
- getSnapshot Window
- getState Window
- getTrayIconInfo Application
- getVersion System
- getWindow Application
- getZoomLevel Application
- getZoomLevel Window
- hide Window
- isMainWindow Window
- isRegistered GlobalHotkey
- isRunning Application
- isShowing Window
- joinGroup Window
- launchExternalProcess System
- leaveGroup Window
- log System
- maximize Window
- mergeGroups Window
- minimize Window
- monitorExternalProcess System
- moveBy Window
- moveTo Window
- navigate Window
- navigateBack Window
- navigateForward Window
- onChannelConnect Channel
- onChannelDisconnect Channel
- openUrlWithBrowser System
- publish ChannelProvider
- publish InterApplicationBus
- quit Application
- readHtml Clipboard
- readRegistryValue System
- readRtf Clipboard
- readText Clipboard
- register ChannelClient
- register ChannelProvider
- register GlobalHotkey
- registerExternalConnection System
- registerUser Application
- releaseExternalProcess System
- reload Window
- remove ChannelClient
- remove ChannelProvider
- removeTrayIcon Application
- resizeBy Window
- resizeTo Window
- restart Application
- restore Window
- scheduleRestart Application
- send InterApplicationBus
- sendMessage Notification
- setAppLogUsername Application
- setAsForeground Window
- setBounds Window
- setMinLogLevel System
- setShortcuts Application
- setTrayIcon Application
- setZoomLevel Application
- setZoomLevel Window
- show Window
- showAt Window
- showDeveloperTools System
- start Application
- startCrashReporter System
- stopFlashing Window
- stopNavigation Window
- subscribe InterApplicationBus
- terminate Application
- terminateExternalProcess System
- unregister GlobalHotkey
- unregisterAll GlobalHotkey
- unsubscribe InterApplicationBus
- updateOptions Window
- updateProxySettings System
- wrap Application
- wrap ExternalApplication
- wrap Frame
- wrap Window
- wrapSync Application
- wrapSync ExternalApplication
- wrapSync Frame
- wrapSync Window
- write Clipboard
- writeHtml Clipboard
- writeRtf Clipboard
- writeText Clipboard