Click or drag to resize

DesktopConnection Class

Note: This API is now obsolete.

An object for launching, connecting to, and controlling AppDesktop.
Inheritance Hierarchy
SystemObject
  Openfin.DesktopDesktopConnection

Namespace:  Openfin.Desktop
Assembly:  OpenfinDesktop (in OpenfinDesktop.dll) Version: 16.6.0
Syntax
C#
[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
  NameDescription
Public methodDesktopConnection
Creates a new instance of DesktopConnection (obsolete) using the specified UUID, host, port, and external Window.
Top
Properties
  NameDescription
Public propertyExternalWindow
Gets or sets an ExternalWindow which responds to Runtime external windowing events.
Public propertyMessageTrace
Gets or sets a value indicating whether or not all incoming and outgoing messages should be trace logged.
Public propertyPort
Gets the port number of the current websocket connection.
Top
Methods
  NameDescription
Public methodaddEventCallback
Registers an event listener on the specified event.
Public methodaddExternalMessageHandler
Registers a listener to handle messages for this connection's UUID originating via HTTPS/HTTP.
Public methodconnect
Connects to an AppDesktop processs
Public methodconnectToVersion(RuntimeOptions, DesktopStateListener)
Connect to an instance of Desktop as specified in the supplied Runtime options.
Public methodconnectToVersion(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.
Public methoddisconnect
Disconnects from AppDesktop
Public methodDispose
Closes the DesktopConnection.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodexit
Notify AppDesktop to exit.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodgetInterApplicationBus
Gets the Inter-Application message dispatcher associated with this DesktopConnection.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodisConnected
Gets the current connection state of the DesktopConnection.
Public methodjoinWebSocketThread
Joins the thread that handles the Websocket communication.
Public methodlaunchAndConnect
Launches AppDesktop and notifies the listener when connected.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodonClosed
Callback when the connection with the Desktop has closed.
Public methodonError
Callback when client cannot start or connect to the Desktop.
Public methodonMessage
Callback when a message is sent to this client.
Public methodonOutgoingMessage
Callback when a message is sent from this client.
Public methodonReady
Callback when Desktop is successfully connected and ready to accept commands.
Public methodremoveEventCallback
Removes a previously registered event listener from the specified event.

The listener is passed an event object containing information related to the event.

Public methodsendAction(String, JObject)
Sends a message to AppDesktop.
Public methodsendAction(String, JObject, AckCallback, Object)
Sends a message to AppDesktop.
Public methodsendAction(String, JObject, AckCallback, AckCallback, Object)
Sends a message to AppDesktop.
Public methodsendActionToNotificationsCenter
Sends a message to an AppDesktop Notification.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Public eventError
Occurs when an error is raised by the Openfin Desktop.
Top
See Also