OptionalacceleratorEnable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
OptionalalwaysOptionalapiConfigurations for API injection.
Set the timezone for the app logs. When setting this value the timestamp will be in ISO 8601 format. By default, if no value is set, it will show the local time in this format: 'y-MM-dd HH:mm:ss.SSS'
OptionalaspectOptionalautoAutomatically show the window when it is created.
OptionalautoplayAutoplay policy to apply to content in the window, can be
no-user-gesture-required, user-gesture-required,
document-user-activation-required. Defaults to no-user-gesture-required.
OptionalbackgroundThe window’s backfill color as a hexadecimal value. Not to be confused with the content background color
(document.body.style.backgroundColor),
this color briefly fills a window’s (a) content area before its content is loaded as well as (b) newly exposed
areas when growing a window. Setting
this value to the anticipated content background color can help improve user experience.
Default is white.
Configuration for keyboard commands. For details and usage, see Using Keyboard Commands.
OptionalcontentRestrict navigation to URLs that match an allowed pattern. In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited. See here for more details.
OptionalcontextOptionalcornerDefines and applies rounded corners for a frameless window. NOTE: On macOS corner is not ellipse but circle rounded by the average of height and width.
OptionalcustomA field that the user can attach serializable data to be ferried around with the window options. When omitted, inherits from the parent application.
OptionalcustomCustom headers for requests sent by the window.
OptionaldefaultCenters the window in the primary monitor. This option overrides defaultLeft and defaultTop. When saveWindowState is true,
this value will be ignored for subsequent launches in favor of the cached value.
NOTE: On macOS defaultCenter is somewhat above center vertically.
Please use domainSettings instead
OptionaldefaultOptionaldefaultOptionaldefaultPlatforms Only. Default view options apply to all platform views.
OptionaldefaultPlatforms Only. Default window options apply to all platform windows.
Define the file download rules and domain-based api injection rules.
OptionalframeOptionalhideOptionaliconA URL for the icon to be shown in the window title bar and the taskbar. When omitted, inherits from the parent application.
Note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.
OptionalignoreIgnores the cached state of the window.
Defaults the opposite value of saveWindowState to maintain backwards compatibility.
Configuration for interop broker.
'There was an error loading the application.'
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.
OptionalmaxOptionalmaxOptionalmaximizableOptionalminOptionalminOptionalminimizableThe name of the application.
This property is used for naming the application logging folder, which will be sanitized to remove
any special characters, spaces or international characters. It's also used in error messages, API
security dialog boxes and in the directory name in %localappdata%/OpenFin/apps/
This property will be deprecated in the future.
OptionalopacityOptionalpermissionsThe permissions for secured APIs.
OptionalpreloadScripts that run before page load. When omitted, inherits from the parent application.
false
**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.
OptionalresizableOptionalresizeDefines a region in pixels that will respond to user mouse interaction for resizing a frameless window.
Optionalsavetrue
Caches the location of the window.
Note: this option is ignored in Platforms as it would cause inconsistent applySnapshot behavior.
OptionalshadowOptionalshowOptionalsmallfalse
Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
Windows 10: Requires maximizable to be false. Resizing with the mouse is only possible down to 38x39 px.
Platforms Only. The snapshot to be applied.
OptionalstateOptionaltaskbarSpecify a taskbar group for the window. Can be shared across applications.
If omitted from a main window, defaults to app's uuid (fin.Application.getCurrentSync().identity.uuid).
Use platform.defaultWindowOptions.taskbarIconGroup to set a default for platform applications.
If omitted, defaults to app's uuid (fin.Application.getCurrentSync().identity.uuid).
The Unique Universal Identifier (UUID) of the application, unique within the set of all other applications running in the OpenFin Runtime.
Optionalwait
The complete set of options for an application.