Click or drag to resize

DesktopSystem Class

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

Inheritance Hierarchy
SystemObject
  Openfin.DesktopDesktopSystem

Namespace:  Openfin.Desktop
Assembly:  OpenfinDesktop (in OpenfinDesktop.dll) Version: 16.6.0
Syntax
C#
public sealed class DesktopSystem : IDisposable

The DesktopSystem type exposes the following members.

Constructors
  NameDescription
Public methodDesktopSystem Obsolete.
DesktopSystem Constructor.
Top
Methods
  NameDescription
Public methodaddEventListener Obsolete.
Registers an event listener on the specified event.
Public methodclearCache
Clears cached data containing window state/positions, application resource files (images, HTML, JavaScript files) cookies, and items stored in the Local Storage.

Requires administrator privileges.

Public methoddeleteCacheOnRestart
Clears all cached data when App Desktop is restarted.

Requires administrator privileges.

Public methodDispose
Disposes this instance of the DesktopSystem and unsubscribes from all events.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodexit
Exits App Desktop.

Requires administrator privileges.

Public methodgetAllApplications
Retrieves an array of data (uuid, running/active state) for all application windows.

Requires administrator privileges.

Public methodGetAllExternalApplications
Retrieves a collection of all running external applications.
Public methodgetAllWindows
Retrieves an array of data (name, ids, bounds) for all application windows.

Requires administrator privileges.

Public methodgetCommandLineArguments
Retrieves the command line argument string that started App Desktop.

Requires administrator privileges.

Public methodgetConfig
Retrieves the App Desktop's configuration.

Requires administrator privileges.

Public methodgetDeviceId
Gets the UUID of the computer on which App Desktop is installed.

Requires administrator privileges.

Public methodGetEntityInfo
Returns a frame info object relating to the entity specified by the uuid and name passed in. The possible types are 'window', 'iframe', 'external connection' or 'unknown'.
Public methodgetEnvironmentVariable(String, AckCallback, AckCallback)
Expands an environment variable.
Public methodgetEnvironmentVariable(String, AckCallback, AckCallback)
Expands the passed environment variables.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetInstalledRuntimes
Gets the version numbers of all installed runtimes. This method should be called after a connection has been established (eg. after Runtime.Connected event has been fired).
Public methodgetLog
Retrieves the contents of the log with the specified filename.

Requires administrator privileges.

Public methodgetLogList
Retrieves an array of data objects for all available logs.

Requires administrator privileges.

Public methodgetMonitorInfo
Retrieves an object that contains data about the about the monitor setup of the computer that App Desktop is running on.

Requires administrator privileges.

Public methodgetMousePosition
Returns the mouse in virtual screen coordinates (left, top).
Public methodgetProcessList
Retrieves an array of all App Desktop processes that are currently running.

Each element in the array is an object containing the uuid and the name of the application to which the process belongs.

Requires administrator privileges.

Public methodgetProxySettings
Retrieves the proxy settings object.
Public methodgetRuntimeInfo
Gets info about the runtime
Public methodgetRvmInfo
Gets info about the RVM
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodgetVersion
Returns the version of App Desktop.

The version contains the major, minor, build and revision numbers (e.g., "2.0.3.0").

Public methodlaunchExternalProcess
Runs an executable or batch file.
Public methodlog
Writes a message to the log.
Public methodopenUrlWithBrowser
Opens the passed URL
Public methodreleaseExternalProcess
Removes the process entry for the passed UUID obtained from a previous call to DesktopSystem.launchExternalProcess().
Public methodremoveEventListener Obsolete.
Removes a previously registered event listener from the specified event.

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

Public methodsetClipboard
Copies text to the clipboard
Public methodsetCookie
Stores a cookie in the runtime.
Public methodshowDeveloperTools
Shows Developer tool
Public methodterminateExternalProcess
Attempts to cleanly close an external process and terminates it if the close has not occured after the elapsed timeout in milliseconds.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodupdateProxySettings
Updates the proxy settings.

Requires administrator privileges.

Top
Events
  NameDescription
Public eventApplicationClosed
Occurs when an application is closed.
Public eventApplicationConnected
Occurs when an application has authenticated and is connected.
Public eventApplicationCrashed
Occurs when an application crashes.
Public eventApplicationCreated
Occurs when a new application has been created.
Public eventApplicationInitialized
Occurs when an application has initialized.
Public eventApplicationManifestChanged
Occurs when the RVM notifies an application that the manifest has changed.
Public eventApplicationNotResponding
Occurs when an application is not responding.
Public eventApplicationResponding
Occurs when an application is not responding.
Public eventApplicationRunRequested
Occurs when Application.run() is called for an already running application.
Public eventApplicationStarted
Occurs when an application has been started.
Public eventApplicationTrayIconClicked
Occurs when the tray icon is clicked.
Public eventExternalApplicationConnected
Occurs when an external application has connected.
Public eventExternalApplicationDisconnected
Occurs when an external application has disconnected.
Public eventIdleStateChanged
Occurs when a user enters or returns from a system idle state.
Public eventWindowAlertRequested
Occurs when a window is requesting to show an alert.
Public eventWindowAuthenticationRequested
Occurs when a window has requested authentication credentials.
Public eventWindowBlurred
Occurs when a window loses its focus.
Public eventWindowClosed
Occurs when the application has closed a window.
Public eventWindowClosing
Occurs when a child window has initiated the closing routine.
Public eventWindowCrashed
Occurs when a window has crashed.
Public eventWindowCreated
Occurs when the application has created a window.
Public eventWindowEmbedded
Occurs when the window has been embedded
Public eventWindowEndLoaded
Occurs when a window ended loading.
Public eventWindowExternalProcessExited
Occurs when the external process has exited.
Public eventWindowExternalProcessStarted
Occurs when the external process has started.
Public eventWindowFileDownloadCompleted
Occurs when a file download has completed.
Public eventWindowFileDownloadProgress
Occurs during file download progress.
Public eventWindowFileDownloadStarted
Occurs when a file download has started.
Public eventWindowFocused
Occurs when a window of the application gains focus.
Public eventWindowFrameDisabled
Occurs when a widnows frame becomes disabled.
Public eventWindowFrameEnabled
Occurs when a window frame becomes enabled
Public eventWindowGroupChanged
Occurs when a window joins/leaves a group and/or when the group a window is a member of changes.
Public eventWindowHidden
Occurs when a window has been hidden.
Public eventWindowInitialized
Occurs when a window is initialized.
Public eventWindowMaximized
Occurs when a window is maximized.
Public eventWindowMinimized
Occurs when a window is minimized.
Public eventWindowNavigationRejected
Occurs when the application main window navigation was rejected.
Public eventWindowNotResponding
Occurs when a window is not responding.
Public eventWindowPreloadScriptsStateChanged
Occurs after the execution of all of a window's preload scripts. Contains information about all window's preload scripts' final states.
Public eventWindowPreloadScriptsStateChanging
Occurs during the execution of a window's preload script. Contains information about a single window's preload script's state, for which the event has been raised.
Public eventWindowReloaded
Occurs when a window was reloaded.
Public eventWindowResponding
Occurs when a window is responding following a not responding event.
Public eventWindowRestored
Occurs when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
Public eventWindowShown
Occurs when a hidden window has been shown.
Public eventWindowShowRequested
Occurs when a window is requesting to be shown.
Public eventWindowStartLoad
Occurs when a window started loading.
Top
See Also