@openfin/core 25.68.26

package/src/api/system/index.d.ts

@@ -0,0 +1,957 @@
+import { EmitterBase } from '../base';
+import { ApplicationInfo } from './application';
+import { WindowInfo } from './window';
+import { GetLogRequestType, LogInfo, LogLevel } from './log';
+import { ProxyInfo, ProxyConfig } from './proxy';
+import { ProcessInfo } from './process';
+import { Entity, EntityInfo } from './entity';
+import Transport from '../../transport/transport';
+import { RegistryInfo } from './registry-info';
+import { SystemEvents } from '../events/system';
+import { InstalledApps } from './installedApps';
+import Identity = OpenFin.Identity;
+/**
+ * AppAssetInfo interface
+ * @typedef { object } AppAssetInfo
+ * @property { string } src  The URL to a zip file containing the package files (executables, dlls, etc…)
+ * @property { string } alias The name of the asset
+ * @property { string } version The version of the package
+ * @property { string } target Specify default executable to launch. This option can be overridden in launchExternalProcess
+ * @property { string } args The default command line arguments for the aforementioned target.
+ * @property { boolean } mandatory When set to true, the app will fail to load if the asset cannot be downloaded.
+ * When set to false, the app will continue to load if the asset cannot be downloaded. (Default: true)
+ */
+/**
+ * AppAssetRequest interface
+ * @typedef { object } AppAssetRequest
+ * @property { string } alias The name of the asset
+ */
+/**
+ * ApplicationInfo interface
+ * @typedef { object } ApplicationInfo
+ * @property { boolean } isPlatform true when the application is a Platform controller
+ * @property { boolean } isRunning  true when the application is running
+ * @property { string } uuid uuid of the application
+ * @property { string } parentUuid uuid of the application that launches this application
+ */
+/**
+ * @typedef { object } ClearCacheOption
+ * @summary Clear cache options.
+ * @desc These are the options required by the clearCache function.
+ *
+ * @property {boolean} appcache html5 application cache
+ * @property {boolean} cache browser data cache for html files and images
+ * @property {boolean} cookies browser cookies
+ * @property {boolean} localStorage browser data that can be used across sessions
+ */
+/**
+ * CookieInfo interface
+ * @typedef { object } CookieInfo
+ * @property { string } name  The name of the cookie
+ * @property { string } domain The domain of the cookie
+ * @property { string } path The path of the cookie
+ */
+/**
+ * CookieOption interface
+ * @typedef { object } CookieOption
+ * @property { string } name The name of the cookie
+ */
+/**
+ * CpuInfo interface
+ * @typedef { object } CpuInfo
+ * @property { string } model The model of the cpu
+ * @property { number } speed The number in MHz
+ * @property { Time } times The numbers of milliseconds the CPU has spent in different modes.
+ */
+/**
+ * CrashReporterState interface
+ * @typedef { object } CrashReporterState
+ * @property { boolean } diagnosticsMode In diagnostics mode the crash reporter will send diagnostic logs to
+ *  the OpenFin reporting service on runtime shutdown
+ * @property { boolean } isRunning check if it's running
+ */
+/**
+ * CrashReporterOptions interface
+ * @typedef { object } CrashReporterOptions
+ * @property { boolean } diagnosticsMode In diagnostics mode the crash reporter will send diagnostic logs to
+ *  the OpenFin reporting service on runtime shutdown
+ */
+/**
+ * DipRect interface
+ * @typedef { object } DipRect
+ * @property { Rect } dipRect The DIP coordinates
+ * @property { Rect } scaledRect The scale coordinates
+ */
+/**
+ * DipScaleRects interface
+ * @typedef { object } DipScaleRects
+ * @property { Rect } dipRect The DIP coordinates
+ * @property { Rect } scaledRect The scale coordinates
+ */
+/**
+ * DownloadPreloadInfo interface
+ * @typedef { object } DownloadPreloadInfo
+ * @desc downloadPreloadScripts function return value
+ * @property { string } url url to the preload script
+ * @property { string } error error during preload script acquisition
+ * @property { boolean } succeess download operation success
+ */
+/**
+ * DownloadPreloadOption interface
+ * @typedef { object } DownloadPreloadOption
+ * @desc These are the options object required by the downloadPreloadScripts function
+ * @property { string } url url to the preload script
+ */
+/**
+ * Entity interface
+ * @typedef { object } Entity
+ * @property { string } type The type of the entity
+ * @property { string } uuid The uuid of the entity
+ */
+/**
+ * EntityInfo interface
+ * @typedef { object } EntityInfo
+ * @property { string } name The name of the entity
+ * @property { string } uuid The uuid of the entity
+ * @property { Identity } parent The parent of the entity
+ * @property { string } entityType The type of the entity
+ */
+/**
+ * ExternalApplicationInfo interface
+ * @typedef { object } ExternalApplicationInfo
+ * @property { Identity } parent The parent identity
+ */
+/**
+ * ExternalConnection interface
+ * @typedef { object } ExternalConnection
+ * @property { string } token The token to broker an external connection
+ * @property { string } uuid The uuid of the external connection
+ */
+/**
+ * ExternalProcessRequestType interface
+ * @typedef { object } ExternalProcessRequestType
+ * @property { string } path The file path to where the running application resides
+ * @property { string } arguments The argument passed to the running application
+ * @property { LaunchExternalProcessListener } listener This is described in the {LaunchExternalProcessListner} type definition
+ * @property { string } initialWindowState Initial window state after launching: 'normal' (default), 'minimized', 'maximized'
+ * @property { string } cwd current working directory
+ */
+/**
+ * FrameInfo interface
+ * @typedef { object } FrameInfo
+ * @property { string } name The name of the frame
+ * @property { string } uuid The uuid of the frame
+ * @property { EntityType } entityType The entity type, could be 'window', 'iframe', 'external connection' or 'unknown'
+ * @property { Identity } parent The parent identity
+ */
+/**
+ * GetLogRequestType interface
+ * @typedef { object } GetLogRequestType
+ * @property { string } name The name of the running application
+ * @property { number } endFile The file length of the log file
+ * @property { number } sizeLimit The set size limit of the log file
+ */
+/**
+ * GpuInfo interface
+ * @typedef { object } GpuInfo
+ * @property { string } name The graphics card name
+ */
+/**
+ * HostSpecs interface
+ * @typedef { object } HostSpecs
+ * @property { boolean } aeroGlassEnabled Value to check if Aero Glass theme is supported on Windows platforms
+ * @property { string } arch "x86" for 32-bit or "x86_64" for 64-bit
+ * @property { Array<CpuInfo> } cpus The same payload as Node's os.cpus()
+ * @property { GpuInfo } gpu The graphics card name
+ * @property { number } memory The same payload as Node's os.totalmem()
+ * @property { string } name The OS name and version/edition
+ * @property { boolean } screenSaver Value to check if screensaver is running. Supported on Windows only
+ */
+/**
+ * Identity interface
+ * @typedef { object } Identity
+ * @property { string } name Optional - the name of the component
+ * @property { string } uuid Universally unique identifier of the application
+ */
+/**
+ * LogInfo interface
+ * @typedef { object } LogInfo
+ * @property { string } name The filename of the log
+ * @property { number } size The size of the log in bytes
+ * @property { string } date The unix time at which the log was created "Thu Jan 08 2015 14:40:30 GMT-0500 (Eastern Standard Time)"
+ */
+/**
+ * ManifestInfo interface
+ * @typedef { object } ManifestInfo
+ * @property { string } uuid The uuid of the application
+ * @property { string } manifestUrl The runtime manifest URL
+ */
+/**
+ * MonitorDetails interface
+ * @typedef { object } MonitorDetails
+ * @property { DipScaleRects } available The available DIP scale coordinates
+ * @property { Rect } availableRect The available monitor coordinates
+ * @property { string } deviceId The device id of the display
+ * @property { boolean } displayDeviceActive true if the display is active
+ * @property { number } deviceScaleFactor The device scale factor
+ * @property { Rect } monitorRect The monitor coordinates
+ * @property { string } name The name of the display
+ * @property { Point } dpi The dots per inch
+ * @property { DipScaleRects } monitor The monitor coordinates
+ */
+/**
+ * MonitorInfo interface
+ * @typedef { object } MonitorInfo
+ * @property { number } deviceScaleFactor The device scale factor
+ * @property { Point } dpi The dots per inch
+ * @property { Array<MonitorDetails> } nonPrimaryMonitors The array of monitor details
+ * @property { MonitorDetails } primaryMonitor The monitor details
+ * @property { string } reason always "api-query"
+ * @property { TaskBar } taskBar The taskbar on monitor
+ * @property { DipRect } virtualScreen The virtual display screen coordinates
+ */
+/**
+ * @typedef { verbose | info | warning | error | fatal } LogLevel
+ * @summary Log verbosity levels.
+ * @desc Describes the minimum level (inclusive) above which logs will be written
+ *
+ * @property { string } verbose all logs written
+ * @property { string } info info and above
+ * @property { string } warning warning and above
+ * @property { string } error error and above
+ * @property { string } fatal fatal only, indicates a crash is imminent
+ */
+/**
+ * PointTopLeft interface
+ * @typedef { object } PointTopLeft
+ * @property { number } top The mouse top position in virtual screen coordinates
+ * @property { number } left The mouse left position in virtual screen coordinates
+ */
+/**
+ * Point interface
+ * @typedef { object } Point
+ * @property { number } x The mouse x position
+ * @property { number } y The mouse y position
+ */
+/**
+ * ProcessInfo interface
+ * @typedef { object } ProcessInfo
+ * @property { number } cpuUsage The percentage of total CPU usage
+ * @property { string } name The application name
+ * @property { number } nonPagedPoolUsage The current nonpaged pool usage in bytes
+ * @property { number } pageFaultCount The number of page faults
+ * @property { number } pagedPoolUsage The current paged pool usage in bytes
+ * @property { number } pagefileUsage The total amount of memory in bytes that the memory manager has committed
+ * @property { number } peakNonPagedPoolUsage The peak nonpaged pool usage in bytes
+ * @property { number } peakPagedPoolUsage The peak paged pool usage in bytes
+ * @property { number } peakPagefileUsage The peak value in bytes of pagefileUsage during the lifetime of this process
+ * @property { number } peakWorkingSetSize The peak working set size in bytes
+ * @property { number } processId The native process identifier
+ * @property { string } uuid The application UUID
+ * @property { number } workingSetSize The current working set size (both shared and private data) in bytes
+ */
+/**
+ * SystemProcessInfo interface
+ * @typedef { object } SystemProcessInfo
+ * @property { ProcessDetails } browserProcess Info on browser process
+ * @property { Array<AppProcessInfo> } apps Array of apps and their process info
+ */
+/**
+ * AppProcessInfo interface
+ * @typedef { object } AppProcessInfo
+ * @property { string } uuid The uuid of the application
+ * @property { Array<EntityProcessDetails> } entities  Array of process info for each window and view for the application
+ */
+/**
+ * EntityProcessDetails interface
+ * @typedef { object } EntityProcessDetails
+ * @property { string } uuid The uuid for the entity
+ * @property { string } name The name for the entity
+ * @property { string } url URL associated with the entity
+ * @property { string } entityType Type for the entity: window or view
+ * @property { number } cpuUsage The percentage of total CPU usage
+ * @property { number } nonPagedPoolUsage The current nonpaged pool usage in bytes
+ * @property { number } pageFaultCount The number of page faults
+ * @property { number } pagedPoolUsage The current paged pool usage in bytes
+ * @property { number } pagefileUsage The total amount of memory in bytes that the memory manager has committed
+ * @property { number } peakNonPagedPoolUsage The peak nonpaged pool usage in bytes
+ * @property { number } peakPagedPoolUsage The peak paged pool usage in bytes
+ * @property { number } peakPagefileUsage The peak value in bytes of pagefileUsage during the lifetime of this process
+ * @property { number } peakWorkingSetSize The peak working set size in bytes
+ * @property { number } privateSetSize The current working set size (not shared)
+ * @property { number } workingSetSize The current working set size (both shared and private data) in bytes
+ * @property { number } pid The native process identifier
+ * @property { Array<FrameProcessDetails> } frames Array of process info for each iframe corresponeding to the entity
+ */
+/**
+ * FrameProcessDetails interface
+ * @typedef { object } FrameProcessDetails
+ * @property { string } url Current URL associated with the process
+ * @property { string } entityType Type for the frame
+ * @property { number } cpuUsage The percentage of total CPU usage
+ * @property { number } nonPagedPoolUsage The current nonpaged pool usage in bytes
+ * @property { number } pageFaultCount The number of page faults
+ * @property { number } pagedPoolUsage The current paged pool usage in bytes
+ * @property { number } pagefileUsage The total amount of memory in bytes that the memory manager has committed
+ * @property { number } peakNonPagedPoolUsage The peak nonpaged pool usage in bytes
+ * @property { number } peakPagedPoolUsage The peak paged pool usage in bytes
+ * @property { number } peakPagefileUsage The peak value in bytes of pagefileUsage during the lifetime of this process
+ * @property { number } peakWorkingSetSize The peak working set size in bytes
+ * @property { number } workingSetSize The current working set size (both shared and private data) in bytes
+ * @property { number } pid The native process identifier
+ */
+/**
+ * ProcessDetails interface
+ * @typedef { object } ProcessDetails
+ * @property { number } cpuUsage The percentage of total CPU usage
+ * @property { number } nonPagedPoolUsage The current nonpaged pool usage in bytes
+ * @property { number } pageFaultCount The number of page faults
+ * @property { number } pagedPoolUsage The current paged pool usage in bytes
+ * @property { number } pagefileUsage The total amount of memory in bytes that the memory manager has committed
+ * @property { number } peakNonPagedPoolUsage The peak nonpaged pool usage in bytes
+ * @property { number } peakPagedPoolUsage The peak paged pool usage in bytes
+ * @property { number } peakPagefileUsage The peak value in bytes of pagefileUsage during the lifetime of this process
+ * @property { number } peakWorkingSetSize The peak working set size in bytes
+ * @property { number } workingSetSize The current working set size (both shared and private data) in bytes
+ * @property { number } pid The native process identifier
+ */
+/**
+ * ProxyConfig interface
+ * @typedef { object } ProxyConfig
+ * @property { string } proxyAddress The configured proxy address
+ * @property { number } proxyPort The configured proxy port
+ * @property { string } type The proxy Type
+ */
+/**
+ * ProxyInfo interface
+ * @typedef { object } ProxyInfo
+ * @property { ProxyConfig } config The proxy config
+ * @property { ProxySystemInfo } system The proxy system info
+ */
+/**
+ * QueryPermissionResult interface
+ * @typedef { object } QueryPermissionResult
+ * @property { string } permission The full name of a secured API
+ * @property { string } state 'granted' | 'denied' | 'unavailable'
+ * @property { boolean } granted true if permission is granted
+ * @property { object } [rawValue] The value of permission
+ */
+/**
+ * ProxySystemInfo interface
+ * @typedef { object } ProxySystemInfo
+ * @property { string } autoConfigUrl The auto configuration url
+ * @property { string } bypass The proxy bypass info
+ * @property { boolean } enabled Value to check if a proxy is enabled
+ * @property { string } proxy The proxy info
+ */
+/**
+ * Rect interface
+ * @typedef { object } Rect
+ * @property { number } bottom The bottom-most coordinate
+ * @property { number } left The left-most coordinate
+ * @property { number } right The right-most coordinate
+ * @property { number } top The top-most coordinate
+ */
+/**
+ * RegistryInfo interface
+ * @typedef { object } RegistryInfo
+ * @property { any } data The registry data
+ * @property { string } rootKey The registry root key
+ * @property { string } subkey The registry key
+ * @property { string } type The registry type
+ * @property { string } value The registry value name
+ */
+/**
+ * RuntimeDownloadOptions interface
+ * @typedef { object } RuntimeDownloadOptions
+ * @desc These are the options object required by the downloadRuntime function.
+ * @property { string } version The given version to download
+ */
+/**
+ * RuntimeInfo interface
+ * @typedef { object } RuntimeInfo
+ * @property { string } architecture The runtime build architecture
+ * @property { string } manifestUrl The runtime manifest URL
+ * @property { number } port The runtime websocket port
+ * @property { string } securityRealm The runtime security realm
+ * @property { string } version The runtime version
+ * @property { object } args the command line argument used to start the Runtime
+ * @property { string } chromeVersion The chrome version
+ * @property { string } electronVersion The electron version
+ */
+/**
+ * RVMInfo interface
+ * @typedef { object } RVMInfo
+ * @property { string } action The name of action: "get-rvm-info"
+ * @property { string } appLogDirectory The app log directory
+ * @property { string } path The path of OpenfinRVM.exe
+ * @property { string } 'start-time' The start time of RVM
+ * @property { string } version The version of RVM
+ * @property { string } 'working-dir' The working directory
+ */
+/**
+ * RvmLaunchOptions interface
+ * @typedef { object } RvmLaunchOptions
+ * @property { boolean } [noUi] true if no UI when launching
+ * @property { object } [userAppConfigArgs] The user app configuration args
+ */
+/**
+ * ServiceIdentifier interface
+ * @typedef { object } ServiceIdentifier
+ * @property { string } name The name of the service
+ */
+/**
+ * ServiceConfiguration interface
+ * @typedef { object } ServiceConfiguration
+ * @property { object } config The service configuration
+ * @property { string } name The name of the service
+ */
+/**
+ * ShortCutConfig interface
+ * @typedef { object } ShortCutConfig
+ * @property { boolean } desktop true if application has a shortcut on the desktop
+ * @property { boolean } startMenu true if application has shortcut in the start menu
+ * @property { boolean } systemStartup true if application will be launched on system startup
+ */
+/**
+ * SubOptions interface
+ * @typedef { Object } SubOptions
+ * @property { number } timestamp The event timestamp
+ */
+/**
+ * TaskBar interface
+ * @typedef { object } TaskBar
+ * @property { string } edge which edge of a monitor the taskbar is on
+ * @property { Rect } rect The taskbar coordinates
+ */
+/**
+ * TerminateExternalRequestType interface
+ * @typedef { object } TerminateExternalRequestType
+ * @property { string } uuid The uuid of the running application
+ * @property { number } timeout Time out period before the running application terminates
+ * @property { boolean } killtree Value to terminate the running application
+ */
+/**
+ * Time interface
+ * @typedef { object } Time
+ * @property { number } user The number of milliseconds the CPU has spent in user mode
+ * @property { number } nice The number of milliseconds the CPU has spent in nice mode
+ * @property { number } sys The number of milliseconds the CPU has spent in sys mode
+ * @property { number } idle The number of milliseconds the CPU has spent in idle mode
+ * @property { number } irq The number of milliseconds the CPU has spent in irq mode
+ */
+/**
+ * TrayInfo interface
+ * @typedef { object } TrayInfo
+ * @property { Bounds } bounds The bound of tray icon in virtual screen pixels
+ * @property { MonitorInfo } monitorInfo Please see fin.System.getMonitorInfo for more information
+ * @property { number } x copy of bounds.x
+ * @property { number } y copy of bounds.y
+ */
+/**
+ * WindowDetail interface
+ * @typedef { object } WindowDetail
+ * @property { number } bottom The bottom-most coordinate of the window
+ * @property { number } height The height of the window
+ * @property { boolean } isShowing Value to check if the window is showing
+ * @property { number } left The left-most coordinate of the window
+ * @property { string } name The name of the window
+ * @property { number } right The right-most coordinate of the window
+ * @property { string } state The window state
+ * @property { number } top The top-most coordinate of the window
+ * @property { number } width The width of the window
+ */
+/**
+ * WindowInfo interface
+ * @typedef { object } WindowInfo
+ * @property { Array<WindowDetail> } childWindows The array of child windows details
+ * @property { WindowDetail } mainWindow The main window detail
+ * @property { string } uuid The uuid of the application
+ */
+/**
+ * CertifiedAppInfo interface
+ * @typedef { object } CertifiedAppInfo
+ * @property { boolean } isRunning true if the app is running
+ * @property { boolean } [isOptedIntoCertfiedApp] true if the app has opted into certification
+ * @property { boolean } [isCertified] true if the app is certified
+ * @property { boolean } [isSSLCertified] true if the app manifest's SSL certificate is valid
+ * @property { boolean } [isPresentInAppDirectory] true if the app is present in the OpenFin app directory
+ */
+/**
+ * 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 <a href="tutorial-System.EventEmitter.html">system events</a>.
+ * @namespace
+ */
+export default class System extends EmitterBase<SystemEvents> {
+    constructor(wire: Transport);
+    private sendExternalProcessRequest;
+    /**
+     * Adds a listener to the end of the listeners array for the specified event.
+     * @param { string | symbol } eventType  - The type of the event.
+     * @param { Function } listener - Called whenever an event of the specified type occurs.
+     * @param { SubOptions } [options] - Option to support event timestamps.
+     * @return {Promise.<this>}
+     * @function addListener
+     * @memberof System
+     * @instance
+     * @tutorial System.EventEmitter
+     */
+    /**
+     * Adds a listener to the end of the listeners array for the specified event.
+     * @param { string | symbol } eventType  - The type of the event.
+     * @param { Function } listener - Called whenever an event of the specified type occurs.
+     * @param { SubOptions } [options] - Option to support event timestamps.
+     * @return {Promise.<this>}
+     * @function on
+     * @memberof System
+     * @instance
+     * @tutorial System.EventEmitter
+     */
+    /**
+     * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
+     * @param { string | symbol } eventType  - The type of the event.
+     * @param { Function } listener - The callback function.
+     * @param { SubOptions } [options] - Option to support event timestamps.
+     * @return {Promise.<this>}
+     * @function once
+     * @memberof System
+     * @instance
+     * @tutorial System.EventEmitter
+     */
+    /**
+     * Adds a listener to the beginning of the listeners array for the specified event.
+     * @param { string | symbol } eventType  - The type of the event.
+     * @param { Function } listener - The callback function.
+     * @param { SubOptions } [options] - Option to support event timestamps.
+     * @return {Promise.<this>}
+     * @function prependListener
+     * @memberof System
+     * @instance
+     * @tutorial System.EventEmitter
+     */
+    /**
+     * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
+     * The listener is added to the beginning of the listeners array.
+     * @param { string | symbol } eventType  - The type of the event.
+     * @param { Function } listener - The callback function.
+     * @param { SubOptions } [options] - Option to support event timestamps.
+     * @return {Promise.<this>}
+     * @function prependOnceListener
+     * @memberof System
+     * @instance
+     * @tutorial System.EventEmitter
+     */
+    /**
+     * Remove a listener from the listener array for the specified event.
+     * Caution: Calling this method changes the array indices in the listener array behind the listener.
+     * @param { string | symbol } eventType  - The type of the event.
+     * @param { Function } listener - The callback function.
+     * @param { SubOptions } [options] - Option to support event timestamps.
+     * @return {Promise.<this>}
+     * @function removeListener
+     * @memberof System
+     * @instance
+     * @tutorial System.EventEmitter
+     */
+    /**
+     * Removes all listeners, or those of the specified event.
+     * @param { string | symbol } [eventType]  - The type of the event.
+     * @return {Promise.<this>}
+     * @function removeAllListeners
+     * @memberof System
+     * @instance
+     * @tutorial System.EventEmitter
+     */
+    /**
+     * Returns the version of the runtime. The version contains the major, minor,
+     * build and revision numbers.
+     * @return {Promise.<string>}
+     * @tutorial System.getVersion
+     */
+    getVersion(): Promise<string>;
+    /**
+     * Clears cached data containing application resource
+     * files (images, HTML, JavaScript files), cookies, and items stored in the
+     * Local Storage.
+     * @param { ClearCacheOption } options - See tutorial for more details.
+     * @return {Promise.<void>}
+     * @tutorial System.clearCache
+     */
+    clearCache(options: OpenFin.ClearCacheOption): Promise<void>;
+    /**
+     * Clears all cached data when OpenFin Runtime exits.
+     * @return {Promise.<void>}
+     * @tutorial System.deleteCacheOnExit
+     */
+    deleteCacheOnExit(): Promise<void>;
+    /**
+     * Exits the Runtime.
+     * @return {Promise.<void>}
+     * @tutorial System.exit
+     */
+    exit(): Promise<void>;
+    /**
+     * Fetches a JSON manifest using the browser process and returns a Javascript object.
+     * @param { string } manifestUrl The URL of the manifest to fetch.
+     * @return {Promise.<any>}
+     * @tutorial System.fetchManifest
+     */
+    fetchManifest(manifestUrl: string): Promise<any>;
+    /**
+     * Writes any unwritten cookies data to disk.
+     * @return {Promise.<void>}
+     * @tutorial System.flushCookieStore
+     */
+    flushCookieStore(): Promise<void>;
+    /**
+     * Retrieves an array of data (name, ids, bounds) for all application windows.
+     * @return {Promise.Array.<WindowInfo>}
+     * @tutorial System.getAllWindows
+     */
+    getAllWindows(): Promise<Array<WindowInfo>>;
+    /**
+     * Retrieves an array of data for all applications.
+     * @return {Promise.Array.<ApplicationInfo>}
+     * @tutorial System.getAllApplications
+     */
+    getAllApplications(): Promise<Array<ApplicationInfo>>;
+    /**
+     * Retrieves the command line argument string that started OpenFin Runtime.
+     * @return {Promise.<string>}
+     * @tutorial System.getCommandLineArguments
+     */
+    getCommandLineArguments(): Promise<string>;
+    /**
+     * Get the current state of the crash reporter.
+     * @return {Promise.<CrashReporterState>}
+     * @tutorial System.getCrashReporterState
+     */
+    getCrashReporterState(): Promise<OpenFin.CrashReporterState>;
+    /**
+     * Start the crash reporter if not already running.
+     * @param { CrashReporterOptions } options - configure crash reporter
+     * @return {Promise.<CrashReporterState>}
+     * @tutorial System.startCrashReporter
+     */
+    startCrashReporter(options: OpenFin.CrashReporterOptions | {
+        diagnosticMode: boolean;
+    }): Promise<OpenFin.CrashReporterState>;
+    /**
+     * Returns a hex encoded hash of the machine id and the currently logged in user name.
+     * This is the recommended way to uniquely identify a user / machine combination.
+     * @return {Promise.<string>}
+     * @tutorial System.getUniqueUserId
+     * @static
+     */
+    getUniqueUserId(): Promise<string>;
+    /**
+     * Retrieves a frame info object for the uuid and name passed in
+     * @param { string } uuid - The UUID of the target.
+     * @param { string } name - The name of the target.
+     * @return {Promise.<EntityInfo>}
+     * @tutorial System.getEntityInfo
+     */
+    getEntityInfo(uuid: string, name: string): Promise<EntityInfo>;
+    /**
+     * Gets the value of a given environment variable on the computer on which the runtime is installed
+     * @return {Promise.<string>}
+     * @tutorial System.getEnvironmentVariable
+     */
+    getEnvironmentVariable(envName: string): Promise<string>;
+    /**
+     * Get current focused window.
+     * @return {Promise.<WindowInfo>}
+     * @tutorial System.getFocusedWindow
+     */
+    getFocusedWindow(): Promise<WindowInfo>;
+    /**
+     * Returns information about the given app's certification status
+     * @return {Promise.<CertifiedAppInfo>}
+     * @tutorial System.isAppCertified
+     */
+    isAppCertified(manifestUrl: string): Promise<OpenFin.CertifiedAppInfo>;
+    /**
+     * Returns an array of all the installed runtime versions in an object.
+     * @return {Promise.<string[]>}
+     * @tutorial System.getInstalledRuntimes
+     */
+    getInstalledRuntimes(): Promise<string[]>;
+    getInstalledApps(): Promise<InstalledApps>;
+    /**
+     * Retrieves the contents of the log with the specified filename.
+     * @param { GetLogRequestType } options A object that id defined by the GetLogRequestType interface
+     * @return {Promise.<string>}
+     * @tutorial System.getLog
+     */
+    getLog(options: GetLogRequestType): Promise<string>;
+    /**
+     * Returns a unique identifier (UUID) provided by the machine.
+     * @return {Promise.<string>}
+     * @tutorial System.getMachineId
+     */
+    getMachineId(): Promise<string>;
+    /**
+     * Returns the minimum (inclusive) logging level that is currently being written to the log.
+     * @return {Promise.<LogLevel>}
+     * @tutorial System.getMinLogLevel
+     */
+    getMinLogLevel(): Promise<LogLevel>;
+    /**
+     * Retrieves an array containing information for each log file.
+     * @return {Promise.Array<LogInfo>}
+     * @tutorial System.getLogList
+     */
+    getLogList(): Promise<Array<LogInfo>>;
+    /**
+     * Retrieves an object that contains data about the monitor setup of the
+     * computer that the runtime is running on.
+     * @return {Promise.<MonitorInfo>}
+     * @tutorial System.getMonitorInfo
+     */
+    getMonitorInfo(): Promise<OpenFin.MonitorInfo>;
+    /**
+     * Returns the mouse in virtual screen coordinates (left, top).
+     * @return {Promise.<PointTopLeft>}
+     * @tutorial System.getMousePosition
+     */
+    getMousePosition(): Promise<OpenFin.PointTopLeft>;
+    /**
+     * 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.
+     * @deprecated Please use our new set of process APIs:
+     * [Window.getProcessInfo]{@link Window#getProcessInfo}
+     * [View.getProcessInfo]{@link View#getProcessInfo}
+     * [Application.getProcessInfo]{@link Application#getProcessInfo}
+     * [System.getAllProcessInfo]{@link System#getAllProcessInfo}
+     * @return {Promise.Array.<ProcessInfo>}
+     * @tutorial System.getProcessList
+     */
+    getProcessList(): Promise<Array<ProcessInfo>>;
+    /**
+     * Retrieves all process information. This includes the browser process and every process associated to all entities (windows and views).
+     * @return {Promise.<SystemProcessInfo>}
+     * @tutorial System.getAllProcessInfo
+     * @experimental
+     */
+    getAllProcessInfo(): Promise<OpenFin.SystemProcessInfo>;
+    /**
+     * Retrieves the Proxy settings.
+     * @return {Promise.<ProxyInfo>}
+     * @tutorial System.getProxySettings
+     */
+    getProxySettings(): Promise<ProxyInfo>;
+    /**
+     * Returns information about the running Runtime in an object.
+     * @return {Promise.<RuntimeInfo>}
+     * @tutorial System.getRuntimeInfo
+     */
+    getRuntimeInfo(): Promise<OpenFin.RuntimeInfo>;
+    /**
+     * Returns information about the running RVM in an object.
+     * @return {Promise.<RVMInfo>}
+     * @tutorial System.getRvmInfo
+     */
+    getRvmInfo(): Promise<OpenFin.RVMInfo>;
+    /**
+     * Retrieves system information.
+     * @return {Promise.<HostSpecs>}
+     * @tutorial System.getHostSpecs
+     */
+    getHostSpecs(): Promise<OpenFin.HostSpecs>;
+    /**
+     * Runs an executable or batch file. A path to the file must be included in options.
+     * <br> A uuid may be optionally provided. If not provided, OpenFin will create a uuid for the new process.
+     * <br> Note: This method is restricted by default and must be enabled via
+     * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
+     * @param { ExternalProcessRequestType } options A object that is defined in the ExternalProcessRequestType interface
+     * @return {Promise.<Identity>}
+     * @tutorial System.launchExternalProcess
+     */
+    launchExternalProcess(options: OpenFin.ExternalProcessRequestType): Promise<Identity>;
+    /**
+     * Monitors a running process. A pid for the process must be included in options.
+     * <br> A uuid may be optionally provided. If not provided, OpenFin will create a uuid for the new process.
+     * @param { ExternalProcessInfo } options See tutorial for more details
+     * @return {Promise.<Identity>}
+     * @tutorial System.monitorExternalProcess
+     */
+    monitorExternalProcess(options: OpenFin.ExternalProcessInfo): Promise<Identity>;
+    /**
+     * Writes the passed message into both the log file and the console.
+     * @param { string } level The log level for the entry. Can be either "info", "warning" or "error"
+     * @param { string } message The log message text
+     * @return {Promise.<void>}
+     * @tutorial System.log
+     */
+    log(level: string, message: string): Promise<void>;
+    /**
+     * Opens 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
+     * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
+     * File protocol and file path are not supported.
+     * @param { string } url The URL to open
+     * @return {Promise.<void>}
+     * @tutorial System.openUrlWithBrowser
+     */
+    openUrlWithBrowser(url: string): Promise<void>;
+    /**
+     * Removes the process entry for the passed UUID obtained from a prior call
+     * of fin.System.launchExternalProcess().
+     * @param { string } uuid The UUID for a process obtained from a prior call to fin.desktop.System.launchExternalProcess()
+     * @return {Promise.<void>}
+     * @tutorial System.releaseExternalProcess
+     */
+    releaseExternalProcess(uuid: string): Promise<void>;
+    /**
+     * Shows the Chromium Developer Tools for the specified window
+     * @param { Identity } identity This is a object that is defined by the Identity interface
+     * @return {Promise.<void>}
+     * @tutorial System.showDeveloperTools
+     */
+    showDeveloperTools(identity: Identity): Promise<void>;
+    /**
+     * Attempt to close an external process. The process will be terminated if it
+     * has not closed after the elapsed timeout in milliseconds.<br>
+     * Note: This method is restricted by default and must be enabled via
+     * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
+     * @param { TerminateExternalRequestType } options A object defined in the TerminateExternalRequestType interface
+     * @return {Promise.<void>}
+     * @tutorial System.terminateExternalProcess
+     */
+    terminateExternalProcess(options: OpenFin.TerminateExternalRequestType): Promise<void>;
+    /**
+     * Update the OpenFin Runtime Proxy settings.
+     * @param { ProxyConfig } options A config object defined in the ProxyConfig interface
+     * @return {Promise.<void>}
+     * @tutorial System.updateProxySettings
+     */
+    updateProxySettings(options: ProxyConfig): Promise<void>;
+    /**
+     * Downloads the given application asset<br>
+     * Note: This method is restricted by default and must be enabled via
+     * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
+     * @param { AppAssetInfo } appAsset App asset object
+     * @return {Promise.<void>}
+     * @tutorial System.downloadAsset
+     */
+    downloadAsset(appAsset: OpenFin.AppAssetInfo, progressListener: (progress: OpenFin.RuntimeDownloadProgress) => void): Promise<void>;
+    /**
+     * Downloads a version of the runtime.
+     * @param { RuntimeDownloadOptions } options - Download options.
+     * @param {Function} [progressListener] - called as the runtime is downloaded with progress information.
+     * @return {Promise.<void>}
+     * @tutorial System.downloadRuntime
+     */
+    downloadRuntime(options: OpenFin.RuntimeDownloadOptions, progressListener: (progress: OpenFin.RuntimeDownloadProgress) => void): Promise<void>;
+    /**
+     * Download preload scripts from given URLs
+     * @param {DownloadPreloadOption[]} scripts - URLs of preload scripts. See tutorial for more details.
+     * @return {Promise.Array<DownloadPreloadInfo>}
+     * @tutorial System.downloadPreloadScripts
+     */
+    downloadPreloadScripts(scripts: Array<OpenFin.DownloadPreloadOption>): Promise<Array<OpenFin.DownloadPreloadInfo>>;
+    /**
+     * Retrieves an array of data (name, ids, bounds) for all application windows.
+     * @return {Promise.Array.<Identity>}
+     * @tutorial System.getAllExternalApplications
+     */
+    getAllExternalApplications(): Promise<Array<Identity>>;
+    /**
+     * Retrieves app asset information.
+     * @param { AppAssetRequest } options
+     * @return {Promise.<AppAssetInfo>}
+     * @tutorial System.getAppAssetInfo
+     */
+    getAppAssetInfo(options: OpenFin.AppAssetRequest): Promise<OpenFin.AppAssetInfo>;
+    /**
+     * Get additional info of cookies.
+     * @param { CookieOption } options - See tutorial for more details.
+     * @return {Promise.Array.<CookieInfo>}
+     * @tutorial System.getCookies
+     */
+    getCookies(options: OpenFin.CookieOption): Promise<Array<OpenFin.CookieInfo>>;
+    /**
+     * Set the minimum log level above which logs will be written to the OpenFin log
+     * @param { LogLevel } The minimum level (inclusive) above which all calls to log will be written
+     * @return {Promise.<void>}
+     * @tutorial System.setMinLogLevel
+     */
+    setMinLogLevel(level: LogLevel): Promise<void>;
+    /**
+     * Retrieves the UUID of the computer on which the runtime is installed
+     * @param { string } uuid The uuid of the running application
+     * @return {Promise.<Entity>}
+     * @tutorial System.resolveUuid
+     */
+    resolveUuid(uuid: string): Promise<Entity>;
+    /**
+     * Retrieves an array of data for all external applications
+     * @param { Identity } requestingIdentity This object is described in the Identity typedef
+     * @param { any } data Any data type to pass to the method
+     * @return {Promise.<any>}
+     * @ignore
+     */
+    executeOnRemote(requestingIdentity: Identity, data: any): Promise<any>;
+    /**
+     * Reads the specifed value from the registry.<br>
+     * Note: This method is restricted by default and must be enabled via
+     * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
+     * @param { string } rootKey - The registry root key.
+     * @param { string } subkey - The registry key.
+     * @param { string } value - The registry value name.
+     * @return {Promise.<RegistryInfo>}
+     * @tutorial System.readRegistryValue
+     */
+    readRegistryValue(rootKey: string, subkey: string, value: string): Promise<RegistryInfo>;
+    /**
+     * This function call will register a unique id and produce a token.
+     * The token can be used to broker an external connection.
+     * @param { string } uuid - A UUID for the remote connection.
+     * @return {Promise.<ExternalConnection>}
+     * @tutorial System.registerExternalConnection
+     */
+    registerExternalConnection(uuid: string): Promise<OpenFin.ExternalConnection>;
+    /**
+     * Returns the json blob found in the [desktop owner settings](https://openfin.co/documentation/desktop-owner-settings/)
+     * for the specified service.
+     * More information about desktop services can be found [here](https://developers.openfin.co/docs/desktop-services).
+     * @param { ServiceIdentifier } serviceIdentifier An object containing a name key that identifies the service.
+     * @return {Promise.<ServiceConfiguration>}
+     * @tutorial System.getServiceConfiguration
+     */
+    getServiceConfiguration(serviceIdentifier: OpenFin.ServiceIdentifier): Promise<OpenFin.ServiceConfiguration>;
+    protected getSystemAppConfig(name: string): Promise<any>;
+    /**
+     * Signals the RVM to perform a health check and returns the results as json.
+     * @return {Promise.<string[]>}
+     * @tutorial System.runRvmHealthCheck
+     */
+    runRvmHealthCheck(): Promise<string[]>;
+    /**
+     * Launch application using a manifest URL/path. It differs from Application.startFromManifest in that this API can accept a manifest using the fin protocol.
+     * @param {string} manifestUrl - The manifest's URL or path.
+     * @param {RvmLaunchOptions} [opts] - Parameters that the RVM will use.
+     * @return {Promise.<Manifest>}
+     * @experimental
+     * @tutorial System.launchManifest
+     * @static
+     */
+    launchManifest(manifestUrl: string, opts?: OpenFin.RvmLaunchOptions): Promise<OpenFin.Manifest>;
+    /**
+     * Query permission of a secured api in current context.
+     * @param {string} apiName - The full name of a secured API.
+     * @return {Promise.<QueryPermissionResult>}
+     * @tutorial System.queryPermissionForCurrentContext
+     */
+    queryPermissionForCurrentContext(apiName: string): Promise<OpenFin.QueryPermissionResult>;
+    enableNativeWindowIntegrationProvider(permissions: any): Promise<OpenFin.NativeWindowIntegrationProviderAuthorization>;
+    /**
+     * Register the usage of a component with a platform
+     * @param {OpenFin.RegisterUsageData} options - Object with data and type
+     * @return {Promise.<void>}
+     * @tutorial System.registerUsage
+     */
+    registerUsage({ data, type }: OpenFin.RegisterUsageData): Promise<void>;
+}