Openfin.Desktop Namespace

A class representing the predefined accelerator keys which can be enabled in OpenFin

A message that is delivered to an AckListener when an action has been processed by AppDesktop

A class representing customizable options for Openfin analytics

A class representing the options for a Window animation.

A class representing a collection of transitions for a Window animation.

An object representing the Application.

Allows the developer to execute, show and close an application, as well as show and hide an icon on Desktop. Also provides access to the Window object for the main application window to control window state such as the ability to minimize, maximize, restore, etc.

Application Asset

Provides data for common OpenFin application events.

Helper object that provides getters/setters for the various options needed for creating an Application.

Bounds of the window

Represents Navigation rules. Allows blacklist/whitelist lists to be applied on Navigation. Navigation failures will raise a window-navigation-rejected event.

A Class storing information about a custom request header.

An object for launching, connecting to, and controlling AppDesktop.

Provides data for a desktop idle state change event.

Provides data for a desktop session change event.

An object representing the core of the OpenFin Desktop. Allows the developer to perform system-level actions, such as accessing logs, viewing processes, clearing the cache and exiting the Desktop.

In order to use the System object, an application must have admin-level privileges (e.g., isAdmin must be set to true when in the options when the application is created).

Static helper class for getting/setting values from a JObject.

Information about the current monitor

An object representing an External Application.

Allows the developer to listen to the events raised when an External Application connects/disconnects from the runtime or whe it's started

Provides data for common OpenFin application events.

Utility class to communicate results from calls to an ExternalMessageHandlerDelegate back to the AppDesktop.

Encapsulates and sends the result of an ExternalWindow action to the desktop. The result is sent after invocation of an ExternalWindow method. In cases where this behavior needs to be prevented, such as when work done should be handled by another thread, Set PreventAutomaticSend to true and call send() when the result state is determined. send() will be called automatically by Dispose() if it has not been explicitly called prior.

Integrates a window outside of the desktop for interaction and control with the API.

A base class representing a transition of the window.

Represents the RVM options that can be used.

A messaging bus that allows for pub / sub messaging between different applications. Available via getInterApplicationBus() method on DesktopConnection

A MessageChannel factory for creating ChannelProvider and ChannelClient instances.

Encapsulates the result from a call to DesktopSystem.launchExternalProcess()

Represents mouse position on based on virtual screen coordinates.

A class representing a transition of a Window's opacity.

Defines the base class for Openfin events.

Provides data for a sent or received message to the OpenFin Runtime.

A class that provides the ability to use undocumented or experimental properties.

A class representing a transition of a Window's position.

A class representing a preload script entry for a given Openfin Application or Window

Provides data for the PreloadScriptEvaluatedEvent.

Provides data for the PreloadScriptStateChanged event.

Encapsulates coodinates of each corner of the display

Provides data for failed content load event

Provides data for response received event

Class representing an OpenFin Runtime object.

Runtime Asset

Provides data for a runtime connection timeout event.

Provides data for a runtime connection failed event.

The internal error from AppDesktop.

A class representing the Runtime options that can be used.

Represents the RVM options that can be used.

Event argument for when a session has changed

A class representing an Application shortcut.

A class representing a transition of a Window's dimensions.

A class representing support contact information if the RVM or an OpenFin Application encounters an error.

Encapsulates the result from a call to DesktopSystem.terminateExternalProcess(). The result of the close/terminate can be retrieved by the getter named "Result".

A window that can be controlled by the AppDesktop API.

Window objects are available through application.getWindow(). This class can not be instantiated directly.

Provides data for an Openfin window alert request.

Provides data for a on Openfin Window authentication request event.

Provides data for common OpenFin window events.

Provides data for an Openfin Window navigation rejected event.

A class representing the options for a Window.

Helper struct representing the payload returned by the window event 'group-changed'

A listener interface for receiving status updates from Desktop.

Responds to API window messages to control a window outside of the desktop.

Defines the interface for an Openfin entity.

Delegate for receiving Ack's from AppDesktop

A delegate to handle the returned groups and their respective windows from Application.getGroups().

A delegate to handle the resulting windows from Application.getChildWindow().

Delegate for consuming external messages targeted at an application originating from HTTP/HTTPS.

A delegate that handles all sent/published messages.

A delegate that handles (un)subscription events on a DesktopConnection's InterApplicationBus.

A delegate which receives a mapped process UUID from DesktopSystem.launchExternalProcess()

Errors from the OpenFin runtime

Messages from the OpenFin runtime

A delegate which is passed the resulting status of a process after DesktopSystem.terminateExternalProcess() has completed.

A delegate to handle the returned grouped windows, if any, from Window.getGroup()

A delegate to handle the returned window object.

A delegate to handle the resulting options from Window.getOptions().

Specifies which client information which will be hashed before reporting an analytics event

Specifies the services which will be reported by the Openfin analytics

Specifies the type of action which raised an application event.

Specifies the type of action which raised a channel event.

Enumeration of possible internal errors when Http response cant be delivered

The connection state of a DesktopConnection

Specifies the type of action which raised an application event.

Which group array the window that the event listeer was registered on is included in

Enumeration of Http methods that could be use to request the content

Type of the resource carried in the http response

Port Discovery protocol

Specifies the load and evaluation state of a preload script.

Advanced settings to configure how the adapter manages and connects to a runtime instance.

Customizable attributes used to identify the application to the RVM for automatic runtime management and cleanup

The action that triggered a session change

Specifies the type of action which raised a system event

Specifies the type of action which raised a window event.

Indicates the state of the window