Optional options: SubscriptionOptionsClears cached data containing application resource files (images, HTML, JavaScript files), cookies, and items stored in the Local Storage.
System.clearCache
See tutorial for more details.
Downloads the given application asset
Note: This method is restricted by default and must be enabled via
API security settings.
System.downloadAsset
App asset object
Download preload scripts from given URLs
System.downloadPreloadScripts
URLs of preload scripts. See tutorial for more details.
Downloads a version of the runtime.
System.downloadRuntime
Download options.
Optional progressListener: ((progress: RuntimeDownloadProgress) => void)called as the runtime is downloaded with progress information.
Retrieves an array of data for all applications.
System.getAllApplications
Experimental
Retrieves all process information. This includes the browser process and every process associated to all entities (windows and views).
System.getAllProcessInfo
Retrieves an array of data (name, ids, bounds) for all application windows.
System.getAllWindows
Retrieves app asset information.
System.getAppAssetInfo
Get additional info of cookies.
System.getCookies
See tutorial for more details.
Get the current state of the crash reporter.
System.getCrashReporterState
Retrieves a frame info object for the uuid and name passed in
System.getEntityInfo
The UUID of the target.
The name of the target.
Retrieves the contents of the log with the specified filename.
System.getLog
A object that id defined by the GetLogRequestType interface
Retrieves an object that contains data about the monitor setup of the computer that the runtime is running on.
System.getMonitorInfo
Returns the mouse in virtual screen coordinates (left, top).
System.getMousePosition
Returns an array with all printers of the caller and not all the printers on the desktop.
System.getPrinters
Retrieves an array of all of the runtime 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.
Please use our new set of process APIs: [Window.getProcessInfo]Window#getProcessInfo [View.getProcessInfo]View#getProcessInfo [Application.getProcessInfo]Application#getProcessInfo [System.getAllProcessInfo]getAllProcessInfo
System.getProcessList
Returns information about the running Runtime in an object.
System.getRuntimeInfo
Returns the json blob found in the desktop owner settings for the specified service. More information about desktop services can be found here.
System.getServiceConfiguration
An object containing a name key that identifies the service.
Returns information about the given app's certification status
System.isAppCertified
Runs an executable or batch file. A path to the file must be included in options.
A uuid may be optionally provided. If not provided, OpenFin will create a uuid for the new process.
Note: This method is restricted by default and must be enabled via
API security settings. Also, this api has an enhanced permission set to make it less dangerous. So application owners can only allow to launch the assets owned by the application, the enabled downloaded files or the restricted executables.
System.launchExternalProcess
A object that is defined in the ExternalProcessRequestType interface
Experimental
Launch application using a manifest URL/path. It differs from Application.startFromManifest in that this API can accept a manifest using the fin protocol.
System.launchManifest
The manifest's URL or path.
Optional opts: RvmLaunchOptions = {}Parameters that the RVM will use.
Monitors a running process. A pid for the process must be included in options.
A uuid may be optionally provided. If not provided, OpenFin will create a uuid for the new process.
System.monitorExternalProcess
See tutorial for more details
Optional options: SubscriptionOptionsOptional options: SubscriptionOptionsOpens the passed URL in the default web browser. It only supports http(s) and fin(s) protocols by default. In order to use other custom protocols, they have to be enabled via API security settings. File protocol and file path are not supported.
System.openUrlWithBrowser
The URL to open
Optional options: SubscriptionOptionsOptional options: SubscriptionOptionsQuery permission of a secured api in current context.
System.queryPermissionForCurrentContext
The full name of a secured API.
Reads the specifed value from the registry.
Note: This method is restricted by default and must be enabled via
API security settings.
System.readRegistryValue
The registry root key.
The registry key.
The registry value name.
This function call will register a unique id and produce a token. The token can be used to broker an external connection.
System.registerExternalConnection
A UUID for the remote connection.
Experimental
Registers a system shutdown handler so user can do some cleanup before system is shutting down. Note: Once system shutdown starts, you are unable to cancel it.
System.registerShutdownHandler
system shutdown handler
(Internal) Register the usage of a component with a platform
System.registerUsage
Object with data and type
Removes the process entry for the passed UUID obtained from a prior call of fin.System.launchExternalProcess().
System.releaseExternalProcess
The UUID for a process obtained from a prior call to fin.desktop.System.launchExternalProcess()
Optional eventType: "view-attached" | "window-alert-requested" | "window-created" | "window-end-load" | "window-not-responding" | "window-responding" | "window-start-load" | "view-blurred" | "view-certificate-selection-shown" | "view-crashed" | "view-did-change-theme-color" | "view-focused" | "view-navigation-rejected" | "view-url-changed" | "view-did-fail-load" | "view-did-finish-load" | "view-page-favicon-updated" | "view-page-title-updated" | "view-resource-load-failed" | "view-response-received" | "view-child-content-blocked" | "view-child-content-opened-in-browser" | "view-child-view-created" | "view-file-download-started" | "view-file-download-progress" | "view-file-download-completed" | "view-created" | "view-destroyed" | "view-hidden" | "view-hotkey" | "view-shown" | "view-target-changed" | "window-blurred" | "window-certificate-selection-shown" | "window-crashed" | "window-did-change-theme-color" | "window-focused" | "window-navigation-rejected" | "window-url-changed" | "window-did-fail-load" | "window-did-finish-load" | "window-page-favicon-updated" | "window-page-title-updated" | "window-resource-load-failed" | "window-response-received" | "window-child-content-blocked" | "window-child-content-opened-in-browser" | "window-child-view-created" | "window-file-download-started" | "window-file-download-progress" | "window-file-download-completed" | "window-view-attached" | "window-view-detached" | "window-begin-user-bounds-changing" | "window-bounds-changed" | "window-bounds-changing" | "window-closed" | "window-closing" | "window-disabled-movement-bounds-changed" | "window-disabled-movement-bounds-changing" | "window-embedded" | "window-end-user-bounds-changing" | "window-external-process-exited" | "window-external-process-started" | "window-hidden" | "window-hotkey" | "window-initialized" | "window-layout-initialized" | "window-layout-ready" | "window-maximized" | "window-minimized" | "window-options-changed" | "window-performance-report" | "window-preload-script-state-changed" | "window-preload-script-state-changing" | "window-reloaded" | "window-restored" | "window-shown" | "window-user-movement-disabled" | "window-user-movement-enabled" | "window-will-move" | "window-will-redirect" | "window-will-resize" | `app-version-progress.${string}` | `runtime-status.${string}` | `app-version-complete.${string}` | `app-version-error.${string}` | "application-created" | "desktop-icon-clicked" | "system-shutdown" | "application-crashed" | "application-closed" | "application-connected" | "application-initialized" | "application-manifest-changed" | "application-not-responding" | "application-responding" | "application-run-requested" | "application-started" | "application-tray-icon-clicked" | "application-file-download-location-changed" | "idle-state-changed" | "session-changed" | "monitor-info-changed"Optional options: SubscriptionOptionsRetrieves the UUID of the computer on which the runtime is installed
System.resolveUuid
The uuid of the running application
Start the crash reporter if not already running.
System.startCrashReporter
configure crash reporter
Attempt to close an external process. The process will be terminated if it
has not closed after the elapsed timeout in milliseconds.
Note: This method is restricted by default and must be enabled via
API security settings.
System.terminateExternalProcess
A object defined in the TerminateExternalRequestType interface
Update the OpenFin Runtime Proxy settings.
System.updateProxySettings
A config object defined in the ProxyConfig interface
Generated using TypeDoc
An object representing the core of OpenFin Runtime. Allows the developer to perform system-level actions, such as accessing logs, viewing processes, clearing the cache and exiting the runtime as well as listen to system events.
Namespace