DesktopConnection Class |
Note: This API is now obsolete.
An object for launching, connecting to, and controlling AppDesktop.
Inheritance HierarchySystemObject
Openfin.DesktopDesktopConnection
Openfin.DesktopDesktopConnection
Namespace: Openfin.Desktop
Assembly: OpenfinDesktop (in OpenfinDesktop.dll) Version: 17.6.0
SyntaxC#
[ObsoleteAttribute("DesktopConnection class is no longer supported. Use Openfin.Desktop.Runtime instead.")] public class DesktopConnection : DesktopStateListener, IDisposable
The DesktopConnection type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | DesktopConnection |
Creates a new instance of DesktopConnection (obsolete) using the specified UUID, host, port, and external Window.
|
Properties| Name | Description | |
|---|---|---|
 | ExternalWindow |
Gets or sets an ExternalWindow which responds to Runtime external windowing events.
|
| MessageTrace |
Gets or sets a value indicating whether or not all incoming and outgoing messages should be trace logged.
|
| Port |
Gets the port number of the current websocket connection.
|
Methods| Name | Description | |
|---|---|---|
| addEventCallback |
Registers an event listener on the specified event.
|
| addExternalMessageHandler |
Registers a listener to handle messages for this connection's UUID originating via HTTPS/HTTP.
|
| connect |
Connects to an AppDesktop processs
|
| connectToVersion(RuntimeOptions, DesktopStateListener) |
Connect to an instance of Desktop as specified in the supplied Runtime options.
|
| connectToVersion(String, DesktopStateListener, Boolean, Int32, String, String, String) |
Connect to specified version of Desktop. If the specified version is not running, it will try to start it.
|
| disconnect |
Disconnects from AppDesktop
|
| Dispose |
Closes the DesktopConnection.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| exit |
Notify AppDesktop to exit.
|
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| getInterApplicationBus |
Gets the Inter-Application message dispatcher associated with
this DesktopConnection.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| isConnected |
Gets the current connection state of the DesktopConnection.
|
| joinWebSocketThread |
Joins the thread that handles the Websocket communication.
|
| launchAndConnect |
Launches AppDesktop and notifies the listener when connected.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| onClosed |
Callback when the connection with the Desktop has closed.
|
| onError |
Callback when client cannot start or connect to the Desktop.
|
| onMessage |
Callback when a message is sent to this client.
|
| onOutgoingMessage |
Callback when a message is sent from this client.
|
| onReady |
Callback when Desktop is successfully connected and ready to
accept commands.
|
| removeEventCallback |
Removes a previously registered event listener from the specified event.
The listener is passed an event object containing information related to the event. |
| sendAction(String, JObject) |
Sends a message to AppDesktop.
|
| sendAction(String, JObject, AckCallback, Object) |
Sends a message to AppDesktop.
|
| sendAction(String, JObject, AckCallback, AckCallback, Object) |
Sends a message to AppDesktop.
|
| sendActionToNotificationsCenter | Obsolete.
Sends a message to an AppDesktop Notification.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Events
See Also