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 HierarchyNamespace: Openfin.Desktop
Assembly: OpenfinDesktop (in OpenfinDesktop.dll) Version: 14.1.0-alpha3
SyntaxC#
public sealed class DesktopSystem : IDisposable
The DesktopSystem type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | DesktopSystem | Obsolete.
DesktopSystem Constructor.
|
Methods| Name | Description | |
|---|---|---|
| addEventListener | Obsolete.
Registers an event listener on the specified event.
|
| clearCache |
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. |
| deleteCacheOnRestart |
Clears all cached data when App Desktop is restarted.
Requires administrator privileges. |
| Dispose |
Disposes this instance of the DesktopSystem and unsubscribes from all events.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| exit |
Exits App Desktop.
Requires administrator privileges. |
| getAllApplications |
Retrieves an array of data (uuid, running/active state) for all application windows.
Requires administrator privileges. |
| getAllWindows |
Retrieves an array of data (name, ids, bounds) for all application windows.
Requires administrator privileges. |
| getCommandLineArguments |
Retrieves the command line argument string that started App Desktop.
Requires administrator privileges. |
| getConfig |
Retrieves the App Desktop's configuration.
Requires administrator privileges. |
| getDeviceId |
Gets the UUID of the computer on which App Desktop is installed.
Requires administrator privileges. |
| GetEntityInfo |
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'.
|
| getEnvironmentVariable(String, AckCallback, AckCallback) |
Expands an environment variable.
|
| getEnvironmentVariable(String, AckCallback, AckCallback) |
Expands the passed environment variables.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetInstalledRuntimes |
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).
|
| getLog |
Retrieves the contents of the log with the specified filename.
Requires administrator privileges. |
| getLogList |
Retrieves an array of data objects for all available logs.
Requires administrator privileges. |
| getMonitorInfo |
Retrieves an object that contains data about the about the
monitor setup of the computer that App Desktop is running on.
Requires administrator privileges. |
| getMousePosition |
Returns the mouse in virtual screen coordinates (left, top).
|
| getProcessList |
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. |
| getProxySettings |
Retrieves the proxy settings object.
|
| getRuntimeInfo |
Gets info about the runtime
|
| getRvmInfo |
Gets info about the RVM
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| getVersion |
Returns the version of App Desktop.
The version contains the major, minor, build and revision numbers (e.g., "2.0.3.0"). |
| launchExternalProcess |
Runs an executable or batch file.
|
| log |
Writes a message to the log.
|
| openUrlWithBrowser |
Opens the passed URL
|
| releaseExternalProcess |
Removes the process entry for the passed UUID obtained
from a previous call to DesktopSystem.launchExternalProcess().
|
| removeEventListener | Obsolete.
Removes a previously registered event listener from the specified event.
The listener is passed an event object containing information related to the event. |
| setClipboard |
Copies text to the clipboard
|
| setCookie |
Stores a cookie in the runtime.
|
| showDeveloperTools |
Shows Developer tool
|
| terminateExternalProcess |
Attempts to cleanly close an external process and terminates it
if the close has not occured after the elapsed timeout in milliseconds.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| updateProxySettings |
Updates the proxy settings.
Requires administrator privileges. |
Events| Name | Description | |
|---|---|---|
 | ApplicationClosed |
Occurs when an application is closed.
|
| ApplicationConnected |
Occurs when an application has authenticated and is connected.
|
| ApplicationCrashed |
Occurs when an application crashes.
|
| ApplicationCreated |
Occurs when a new application has been created.
|
| ApplicationInitialized |
Occurs when an application has initialized.
|
| ApplicationManifestChanged |
Occurs when the RVM notifies an application that the manifest has changed.
|
| ApplicationNotResponding |
Occurs when an application is not responding.
|
| ApplicationResponding |
Occurs when an application is not responding.
|
| ApplicationRunRequested |
Occurs when Application.run() is called for an already running application.
|
| ApplicationStarted |
Occurs when an application has been started.
|
| ApplicationTrayIconClicked |
Occurs when the tray icon is clicked.
|
| ExternalApplicationConnected |
Occurs when an external application has connected.
|
| ExternalApplicationDisconnected |
Occurs when an external application has disconnected.
|
| IdleStateChanged |
Occurs when a user enters or returns from a system idle state.
|
| WindowAlertRequested |
Occurs when a window is requesting to show an alert.
|
| WindowAuthenticationRequested |
Occurs when a window has requested authentication credentials.
|
| WindowBlurred |
Occurs when a window loses its focus.
|
| WindowClosed |
Occurs when the application has closed a window.
|
| WindowClosing |
Occurs when a child window has initiated the closing routine.
|
| WindowCrashed |
Occurs when a window has crashed.
|
| WindowCreated |
Occurs when the application has created a window.
|
| WindowEmbedded |
Occurs when the window has been embedded
|
| WindowEndLoaded |
Occurs when a window ended loading.
|
| WindowExternalProcessExited |
Occurs when the external process has exited.
|
| WindowExternalProcessStarted |
Occurs when the external process has started.
|
| WindowFileDownloadCompleted |
Occurs when a file download has completed.
|
| WindowFileDownloadProgress |
Occurs during file download progress.
|
| WindowFileDownloadStarted |
Occurs when a file download has started.
|
| WindowFocused |
Occurs when a window of the application gains focus.
|
| WindowFrameDisabled |
Occurs when a widnows frame becomes disabled.
|
| WindowFrameEnabled |
Occurs when a window frame becomes enabled
|
| WindowGroupChanged |
Occurs when a window joins/leaves a group and/or when the group a window is a member of changes.
|
| WindowHidden |
Occurs when a window has been hidden.
|
| WindowInitialized |
Occurs when a window is initialized.
|
| WindowMaximized |
Occurs when a window is maximized.
|
| WindowMinimized |
Occurs when a window is minimized.
|
| WindowNavigationRejected |
Occurs when the application main window navigation was rejected.
|
| WindowNotResponding |
Occurs when a window is not responding.
|
| WindowPreloadScriptsStateChanged |
Occurs after the execution of all of a window's preload scripts.
Contains information about all window's preload scripts' final states.
|
| WindowPreloadScriptsStateChanging |
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.
|
| WindowReloaded |
Occurs when a window was reloaded.
|
| WindowResponding |
Occurs when a window is responding following a not responding event.
|
| WindowRestored |
Occurs when a window is displayed after having been minimized or when a window leaves the maximize state without minimizing.
|
| WindowShown |
Occurs when a hidden window has been shown.
|
| WindowShowRequested |
Occurs when a window is requesting to be shown.
|
| WindowStartLoad |
Occurs when a window started loading.
|
See Also