Global

Name of the context group.

The URL to a zip file containing the package files (executables, dlls, etc…)

The name of the asset

The version of the package

Specify default executable to launch. This option can be overridden in launchExternalProcess

The default command line arguments for the aforementioned target.

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)

The name of the asset

true when the application is a Platform controller

true when the application is running

uuid of the application

uuid of the application that launches this application

When set to true it will disable IAB secure logging for the app.

A flag to enable FDC3 API. When set to true the fdc3 API object is present for all windows

An error message to display when the application (launched via manifest) fails to load. A dialog box will be launched with the error message just before the runtime exits. Load fails such as failed DNS resolutions or aborted connections as well as cancellations, e.g., window.stop(), will trigger this dialog. Client response codes such as 404 Not Found are not treated as fails as they are valid server responses.

The options of the main window of the application. For a description of these options, click the link (in the Type column).

Platforms Only. The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed. If you do not wish for views to be pooled on your platform, set this property to zero.

The name of the application (and the application's main window).

If provided, must match uuid.

A flag to configure the application as non-persistent. Runtime exits when there are no persistent apps running.

Enable Flash at the application level.

Enable spell check at the application level.

The url to the application (specifically the application's main window).

The Unique Universal Identifier (UUID) of the application, unique within the set of all other applications running in the OpenFin Runtime.

Note that name and uuid must match.

When set to false it will disable the same-origin policy for the app.

When true, applySnapshot will close existing windows, replacing current Platform state with the given snapshot.

When true, applySnapshot will not check whether any windows in a snapshot are off-screen. By default, such windows will be repositioned to be on-screen, as defined by PlatformProvider.positionOutOfBoundsWindows.

The snapshot to be applied.

Options to customize snapshot application.

The uuid of the application

Array of process info for each window and view for the application

Area's height

Area's width

X coordinate of area's starting point

Y coordinate of area's starting point

Get the application height bound

Get the application width bound

Get the application top bound

Get the application left bound

Get the application right bound

Get the application bottom bound

The area of the window to be captured.

The format of the captured image. Can be 'png', 'jpg', or 'bmp'.

Number representing quality of JPEG image only. Between 0 - 100.

true if the app is running

true if the app has opted into certification

true if the app is certified

true if the app manifest's SSL certificate is valid

true if the app is present in the OpenFin app directory

Name of the context group

Metadata for the Context Group. Contains the group's human-readable name, color, and an image, as defined by the Interop Broker.

Defaults to system.

html5 application cache

browser data cache for html files and images

browser cookies

browser data that can be used across sessions

GUID of an application.

Name of an entity in an application.

Unique differentiator for different Channel connections for an entity.

View to be closed.

An object containing key-value pairs for the bulk of the data for the context. Differs between context types.

User-readable name for the incoming context.

Conserved type for the context (e.g. instrument or country)

Name of the context group

Metadata for the Context Group. Contains the group's human-readable name, color, and an image, as defined by the Interop Broker.

The name of the cookie

The domain of the cookie

The path of the cookie

The name of the cookie

The model of the cpu

The number in MHz

The numbers of milliseconds the CPU has spent in different modes.

In diagnostic mode the crash reporter will send diagnostic logs to the OpenFin reporting service on runtime shutdown

check if it's running

Options for the view to be added.

Window the view will be added to. If no target is provided, a new window will be created.

Specify a path of a custom CSS file to be injected to all of the platform's windows. note: this option is only applied to windows that use the Default OpenFin Window. Windows with a specified url (Custom Windows) will not be affected by this option.

The DIP coordinates

The scale coordinates

The DIP coordinates

The scale coordinates

A user-readable name for this context group, e.g: "Red"

The color that should be associated within this context group when displaying this context group in a UI, e.g: 0xFF0000.

A URL of an image that can be used to display this context group

url to the preload script

error during preload script acquisition

download operation success

url to the preload script

The horizontal dpi

The vertical dpi

The type of the entity

The uuid of the entity

The name of the entity

The uuid of the entity

The parent of the entity

The type of the entity

The uuid for the entity

The name for the entity

URL associated with the entity

Type for the entity: window or view

The percentage of total CPU usage

The current nonpaged pool usage in bytes

The number of page faults

The current paged pool usage in bytes

The total amount of memory in bytes that the memory manager has committed

The peak nonpaged pool usage in bytes

The peak paged pool usage in bytes

The peak value in bytes of pagefileUsage during the lifetime of this process

The peak working set size in bytes

The current working set size (both shared and private data) in bytes

The native process identifier

Array of process info for each iframe corresponeding to the entity

The parent identity

The token to broker an external connection

The uuid of the external connection

The file path to where the running application resides

The argument passed to the running application

This is described in the {LaunchExternalProcessListner} type definition

The URL of the manifest to fetch.

Whether to search forward or backward.

Whether the operation is first request or a follow up.

Whether search should be case-sensitive.

Whether to look only at the start of words.

When combined with wordStart, accepts a match in the middle of a word if the match begins with an uppercase letter followed by a
lowercase or non-letter. Accepts several other intra-word matches.

The name of the frame

The uuid of the frame

The entity type, could be 'window', 'iframe', 'external connection' or 'unknown'

The parent identity

Current URL associated with the process

Type for the frame

The percentage of total CPU usage

The current nonpaged pool usage in bytes

The number of page faults

The current paged pool usage in bytes

The total amount of memory in bytes that the memory manager has committed

The peak nonpaged pool usage in bytes

The peak paged pool usage in bytes

The peak value in bytes of pagefileUsage during the lifetime of this process

The peak working set size in bytes

The current working set size (both shared and private data) in bytes

The native process identifier

Name of the context group to get info for.

Name of the context group to get info for.

The name of the running application

The file length of the log file

The set size limit of the log file

Entity type of the target of the context update ('view' or 'window').

Identity of the entity targeted by the call to Platform.getWindowContext.

The graphics card name

The new context object

The reason for the update: 'updated' or 'reparented'

Value to check if Aero Glass theme is supported on Windows platforms

"x86" for 32-bit or "x86_64" for 64-bit

The same payload as Node's os.cpus()

The graphics card name

The same payload as Node's os.totalmem()

The OS name and version/edition

Value to check if screensaver is running. Supported on Windows only

Optional - the name of the component

Universally unique identifier of the application

The id attribute of the container where the window's Layout should be initialized. If not provided then an element with id layout-container is used. We recommend using a div element.

a callback function that can be used to extend or replace default Provider behavior.

Context Group for the client. (green, yellow, red, etc.)

When provided, automatically connects the client to the specified provider uuid

Id of the context group.

Identity of the entity you wish to join to a context group.

Content of the layout. There can only be one top-level LayoutItem in the content array. We do not recommend trying to build Layouts or LayoutItems by hand and instead use calls such as getSnapshot or our Layout Config Generation Tool .

Configuration for certain Layout behaviors. See the LayoutSettings interface.

The type of the item. Possible values are 'row', 'column', 'stack', and 'component'.

An array of configurations for items that will be created as children of this item.

Only a component type will have this property and it should be set to view.

Only a component type will have this property and it represents the view options of a given component.

Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.

Turns tab headers on or off. If false, the layout will be displayed with splitters only.

Configuration of the Plus button that appears on each tabstrip. Upon pressing, a new tab will be added to the tabstrip with the specified url.

Properties

Whether the popout button will only act on the entire stack, as opposed to only the active tab.

If true, tabs can't be dragged into the window.

If true, tabs can't be dragged out of the window.

If true, the user can re-arrange the layout by dragging items by their tabs to the desired location.

Whether to show the close button on stack header (not to be confused with close button on every tab).

Whether to show the maximize button on stack header. The button will maximize the current tab to fill the entire window.

Whether to show the popout button on stack header. The button will create a new window with current tab as its content. In case popoutWholeStack is set to true, all tabs in the stack will be in the new window.

function for addContextListener.

The filename of the log

The size of the log in bytes

The unix time at which the log was created "Thu Jan 08 2015 14:40:30 GMT-0500 (Eastern Standard Time)"

all logs written

info and above

warning and above

error and above

fatal only, indicates a crash is imminent

The uuid of the application

The runtime manifest URL

Can be default, none, printableArea, or custom. If custom is chosen, you will also need to specify top, bottom, left, and right.

The top margin of the printed web page, in pixels.

The bottom margin of the printed web page, in pixels.

The left margin of the printed web page, in pixels.

The right margin of the printed web page, in pixels.

Data to be returned if the user selects the element. Must be serializable. Large objects can have a performance impact.

Defaults to 'normal' unless a 'submenu' key exists

The text to show on the menu item. Should be left undefined for type: 'separator'

If false, the menu item will be greyed out and unclickable.

If false, the menu item will be entirely hidden.

Should only be specified for checkbox type menu items.

Should be specified for submenu type menu items. If submenu is specified, the type: 'submenu' can be omitted.

Whether the user clicked on a menu item or the menu was closed (user clicked elsewhere).

The data property of the menu item clicked by the user. Only defined if result was clicked.

The available DIP scale coordinates

The available monitor coordinates

The device id of the display

true if the display is active

The device scale factor

The monitor coordinates

The name of the display

The dots per inch

The monitor coordinates

The device scale factor

The dots per inch

The array of monitor details

The monitor details

always "api-query"

The taskbar on monitor

The virtual display screen coordinates

The total time in milliseconds this transition should take.

Treat 'opacity' as absolute or as a delta. Defaults to false.

This value is clamped from 0.0 to 1.0.

Configuration for keyboard commands. For details and usage, see Using Keyboard Commands.

Default window options apply to all platform windows.

Default view options apply to all platform views.

The mouse x position

The mouse y position

The mouse top position in virtual screen coordinates

The mouse left position in virtual screen coordinates

The total time in milliseconds this transition should take.

Treat 'opacity' as absolute or as a delta. Defaults to false.

Defaults to the window's current left position in virtual screen coordinates.

Defaults to the window's current top position in virtual screen coordinates.

Which preset layout arrangement to use. The preset options are columns, grid, rows, and tabs.

Printer Name

Printer Description

Printer Status

Indicates that system's default printer

Don't ask user for print settings.

Prints the background color and image of the web page.

Set the printer device name to use.

Set whether the printed web page will be in color or grayscale.

Set margins for the printed web page

Whether the web page should be printed in landscape mode.

The scale factor of the web page.

The number of pages to print per page sheet.

Whether the web page should be collated.

The number of copies of the web page to print.

The page range to print. Should have two keys: from and to.

Set the duplex mode of the printed web page. Can be simplex, shortEdge, or longEdge.

Set dpi for the printed web page

The percentage of total CPU usage

The current nonpaged pool usage in bytes

The number of page faults

The current paged pool usage in bytes

The total amount of memory in bytes that the memory manager has committed

The peak nonpaged pool usage in bytes

The peak paged pool usage in bytes

The peak value in bytes of pagefileUsage during the lifetime of this process

The peak working set size in bytes

The current working set size (both shared and private data) in bytes

The native process identifier

The percentage of total CPU usage

The application name

The current nonpaged pool usage in bytes

The number of page faults

The current paged pool usage in bytes

The total amount of memory in bytes that the memory manager has committed

The peak nonpaged pool usage in bytes

The peak paged pool usage in bytes

The peak value in bytes of pagefileUsage during the lifetime of this process

The peak working set size in bytes

The native process identifier

The application UUID

The current working set size (both shared and private data) in bytes

The configured proxy address

The configured proxy port

The proxy Type

The proxy config

The proxy system info

The auto configuration url

The proxy bypass info

Value to check if a proxy is enabled

The proxy info

The bottom-most coordinate

The left-most coordinate

The right-most coordinate

The top-most coordinate

The registry data

The registry root key

The registry key

The registry type

The registry value name

Identity of the entity you wish to join to a context group.

Layout config to be applied.

Object containing the layout to be applied.

Identity of the window whose layout will be replace.

The given version to download

The runtime build architecture

The runtime manifest URL

The runtime websocket port

The runtime security realm

The runtime version

the command line argument used to start the Runtime

The chrome version

The electron version

The name of action: "get-rvm-info"

The app log directory

The path of OpenfinRVM.exe

The start time of RVM

The version of RVM

The working directory

true if no UI when launching

The user app configuration args

The service configuration

The name of the service

The name of the service

New context to set.

The requested context update.

Entity type of the target of the context update ('view' or 'window').

Identity of the entity targetted by the call to Platform.setWindowContext.

The requested context update.

Entity type of the target of the context update ('view' or 'window').

Identity of the entity targeted by the call to Platform.setWindowContext.

The unique id of the shared worker.

The url of the shared worker.

true if application has a shortcut on the desktop

true if application has shortcut in the start menu

true if application will be launched on system startup

An array describing the menu to show.

The window x coordinate where to show the menu. Defaults to mouse position. If using must also use y.

The window y coordinate where to show the menu. Defaults to mouse position. If using must also use x

The total time in milliseconds this transition should take.

Treat 'opacity' as absolute or as a delta. Defaults to false.

Optional if height is present. Defaults to the window's current width.

Optional if width is present. Defaults to the window's current height.

The array of window options objects

The event timestamp

Info on browser process

Array of apps and their process info

which edge of a monitor the taskbar is on

The taskbar coordinates

The uuid of the running application

Time out period before the running application terminates

Value to terminate the running application

The number of milliseconds the CPU has spent in user mode

The number of milliseconds the CPU has spent in nice mode

The number of milliseconds the CPU has spent in sys mode

The number of milliseconds the CPU has spent in idle mode

The number of milliseconds the CPU has spent in irq mode

The Opacity transition

The Position transition

The Size transition

This option interrupts the current animation. When false it pushes this animation onto the end of the animation queue.

Treat 'opacity' as absolute or as a delta. Defaults to false.

The bound of tray icon in virtual screen pixels

Please see fin.System.getMonitorInfo for more information

copy of bounds.x

copy of bounds.y

The bottom-most coordinate of the window

The height of the window

Value to check if the window is showing

The left-most coordinate of the window

The name of the window

The right-most coordinate of the window

The window state

The top-most coordinate of the window

The width of the window

The array of child windows details

The main window detail

The uuid of the application

Move a window independently of its group or along with its group. Defaults to false.

Data to be written

Clipboard Type