Home

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.
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">
        document.addEventListener('DOMContentLoaded', () => {
            //get the current version.
            fin.System.getVersion().then(version => {
                document.querySelector('#of-version').innerText = version;
            });
        });
        </script>
    </head>
    <body>
        <p>
            OpenFin adapter <span id="of-version"></span>
        </p>
    </body>
</html>

Index of API Methods