Global

Name of the context group.

The unique application identifier located within a specific application directory instance. An example of an appId might be 'app@sub.root'.

An optional instance identifier, indicating that this object represents a specific instance of the application described. The endpointId should be used as the instanceId. The most convenient way to get this would be to use the InteropBroker.getAllClientInfo API.

Details of the intent whose relationship to resolving applications is being described

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

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.

Platforms Only. Prevent the Platform Provider from quitting automatically when the last Platform Window is closed. Note: if the Platform Provider is showing, it won't close automatically. If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.

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).

Enables the use of the Jumplists API and the 'pin to taskbar' functionality. Only relevant in Windows.

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 close existing includeInSnapshots: true 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 unique application identifier located within a specific application directory instance. An example of an appId might be 'app@sub.root'.

An optional instance identifier, indicating that this object represents a specific instance of the application described. The endpointId should be used as the instanceId. The most convenient way to get this would be to use the InteropBroker.getAllClientInfo API.

The 'friendly' app name. This field was used with the open and raiseIntent calls in FDC3 <2.0, which now require an AppIdentifier with appId set. Note that for display purposes the title field should be used, if set, in preference to this field.

The version of the application.

A more user-friendly application title that can be used to render UI elements.

A tooltip for the application that can be used to render UI elements.

A longer, multi-paragraph description for the application that could include mark-up.

A list of icon URLs for the application that can be used to render UI elements.

Images representing the app in common usage scenarios that can be used to render UI elements.

The type of result returned for any intent specified during resolution. May express a particular context type (e.g. "fdc3.instrument"), channel (e.g. "channel") or a channel that will receive a specified type (e.g. "channel<fdc3.instrument>").

Area's height

Area's width

X coordinate of area's starting point

Y coordinate of area's starting point

Specifies if the Window should close

Array of views that will close

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.

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.

Broadcasts a context for the channel.

Add a context handler for incoming context.

Gets the current context for the channel.

GUID of an application.

Name of an entity in an application.

Unique differentiator for different Channel connections for an entity.

View to be closed.

When set to true skips any before handler set on views that are part of the window

Identity of the Window

'view' | 'window' | 'browser' | 'block'

List of match patterns.

Window creation options or View creation options.

An object containing string 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)

An object containing string 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.

Identifier for the app instance that sent the context and/or intent.

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.

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

The horizontal dpi

The vertical dpi

The URL of the manifest to fetch.

Whether to search forward or backward.

Whether to begin a new text finding session. Should be true for first requests, and false for subsequent requests. Defaults to false.

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.

Name of the context group to get info for.

Context Type

Name of the context group to get info for.

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

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

The new context object

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

The fully qualified url to the icon.

The dimensions of the Icon formatted as x.

The media type of the icon. If not provided the Desktop Agent may refer to the src file extension.

The fully qualified url to the image.

The dimensions of the image formatted as x.

The media type of the image. If not provided the Desktop Agent may refer to the src file extension.

The FDC3 version

The provider uuid with prepend 'openfin'

The provider runtime version

The FDC3 version

The provider's uuid prepended with 'openfin' (e.g. 'openfin-myUuid').

The provider runtime version

The calling application instance's own metadata, according to the Desktop Agent (MUST include at least the appId and instanceId).

Used to indicate whether the exposure of 'originating app metadata' for context and intent messages is supported by the Desktop Agent.

Used to indicate whether the optional fdc3.joinUserChannel, fdc3.getCurrentChannel and fdc3.leaveCurrentChannel are implemented by the Desktop Agent.

Name of the intent to get info for.

Optional context.

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.

Name of the intent.

Data associated with the intent

The unique name of the intent that can be invoked by the raiseIntent call.

A friendly display name for the intent that should be used to render UI elements.

identifier for the Application resolving the Intent (null if the Intent could not be resolved)

Return data structure - if one is provided for the given Intent.

The version number of the Intents schema being used

Identifier for the app instance that was selected (or started) to resolve the intent.

Intent name

The version number of the Intents schema being used.

Function that returns a promise that will resolve to either Context data returned by the application that resolves the raised intent or a Channel established and returned by the app resolving the intent.

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.

The display title for the category. If omitted, items in this category will be placed into the standard 'Tasks' category. There can be only one such category, and it will always be displayed at the bottom of the JumpList.

Array of JumpListItem objects

One of the following: "task" or "separator". Defaults to task.

The text to be displayed for the JumpList Item. Should only be set if type is "task".

Description of the task (displayed in a tooltip). Should only be set if type is "task".

Deep link to a manifest, i.e: fins://path.to/manifest.json?$$param1=value1. See deep-linking for more information.

The absolute path to an icon to be displayed for the item, which can be an arbitrary resource file that contains an icon (e.g. .ico, .exe, .dll).

The index of the icon in the resource file. If a resource file contains multiple icons this value can be used to specify the zero-based index of the icon that should be displayed for this task. If a resource file contains only one icon, this property should be set to zero.

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, tab contents can't be resized by the user.

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 and addIntentListener.

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 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.

'same' | 'different'.

If a window with this name exists, it will be shown as a popup. Otherwise, a new window with this name will be created. If this name is undefined, initialOptions.name will be used. If this name and intialOptions.name are both undefined, a name will be generated.

Navigates to this url if showing an existing window as a popup, otherwise the newly created window will load this url.

Window creation options when using showPopupWindow to create a new window.

Updatable window options applied to new and existing windows when shown as popups.

Executed when this window's popup calls dispatchPopupResult. Note: if this is defined, showPopupWindow will not return a PopupResult.

Executed when the popup window is shown. Provides the popup window to the provided function, and allows for easy access the popup window for additional behavior customization.

Height of the popup window (takes priority over intialOptions size properties).

Width of the popup window (takes priority over intialOptions size properties).

Left position where the popup window will be shown (relative to the window calling showPopupWindow).

Top position where the popup window will be shown (relative to the window calling showPopupWindow).

Determines what happens if the popup window is blurred. 'modal' restricts resizing and positioning in the caller, 'hide' hides the popup window on blur and 'close' closes the popup window on blur.

Determines what happens when the popup window calls dispatchPopupResult. 'none' will do nothing, 'hide' hides the popup window on dispatchPopupResult and 'close' closes the popup window on dispatchPopupResult.

Determines if the popup window should or should not be focused when it is shown.

Hide the popup window instead of closing whenever close is called on it. Note: if this is true and blurBehavior and/or resultDispatchBehavior are set to close, the window will be hidden.

name and uuid of the popup window that called dispatched this result.

Result of the user interaction with the popup window.

Data passed to dispatchPopupResult.

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

Private Channel Id

Channel Type

views in the same domain will have the same process affinity.

views in the same domain will have different process affinities.

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 SessionContextGroup's id.

Sets a context of a certain type

Gets the currently set context of a certain type

Adds a handler for context change.

New context to set.

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 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 unique id of the shared worker.

The url of the shared worker.

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

Enables or disables showing views when the layout splitter is being dragged.

Enables or disables showing views when a tab is being dragged.

Enables or disables showing Views when a Platform Window is being resized.

Number of miliseconds to wait between view repaints.

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

Function to unsubscribe the handler.

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.

Specifies if the Window should close

Identity of the Window

Array of identities for the Views that are preventing an unload

Array of identities for the Views that are not preventing an unload

If the close action came from the Window or a single View

Array of identities for the Views that are preventing an unload

Array of identities for the Views that are not preventing an unload

Enables views to be shown when a Platform Window is being resized by the user.

Allows views to be shown when they are resized by the user dragging the splitter between layout stacks.

Supported on Windows Operating Systems only. Allows views to be shown when the user is dragging a tab around a layout.

Data to be written

Clipboard Type