@openfin/core 33.76.31 → 33.76.38

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

@@ -1,517 +0,0 @@
-import type * as OpenFin from '../../OpenFin';
-import { EmitterBase } from '../base';
-import { Transport } from '../../transport/transport';
-type Identity = OpenFin.Identity;
-type ProxyInfo = OpenFin.ProxyInfo;
-type ProxyConfig = OpenFin.ProxyConfig;
-type InstalledApps = OpenFin.InstalledApps;
-type LogInfo = OpenFin.LogInfo;
-type LogLevel = OpenFin.LogLevel;
-type GetLogRequestType = OpenFin.GetLogRequestType;
-type RegistryInfo = OpenFin.RegistryInfo;
-type EntityInfo = OpenFin.EntityInfo;
-type Entity = OpenFin.ApplicationType;
-type ApplicationState = OpenFin.ApplicationState;
-type ApplicationWindowInfo = OpenFin.ApplicationWindowInfo;
-type PrinterInfo = OpenFin.PrinterInfo;
-/**
- * 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<OpenFin.SystemEvent> {
-    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.<ApplicationWindowInfo>}
-     * @tutorial System.getAllWindows
-     */
-    getAllWindows(): Promise<Array<ApplicationWindowInfo>>;
-    /**
-     * Retrieves an array of data for all applications.
-     * @return {Promise.Array.<ApplicationState>}
-     * @tutorial System.getAllApplications
-     */
-    getAllApplications(): Promise<Array<ApplicationState>>;
-    /**
-     * 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.<Identity | null>}
-     * @tutorial System.getFocusedWindow
-     */
-    getFocusedWindow(): Promise<OpenFin.Identity | null>;
-    /**
-     * 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<any>>;
-    /**
-     * 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>. 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.
-     * @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.<ApplicationType>}
-     * @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>;
-    /**
-     * 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.
-     * @param { SystemShutdownHandler } handler system shutdown handler
-     * @return {Promise.<void>}
-     * @tutorial System.registerShutdownHandler
-     * @experimental
-     */
-    registerShutdownHandler(handler: OpenFin.SystemShutdownHandler): Promise<void>;
-    /**
-     * 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>;
-    /**
-     * (Internal) 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>;
-    /**
-     * Returns an array with all printers of the caller and not all the printers on the desktop.
-     * @return { Promise.Array.<PrinterInfo> }
-     * @tutorial System.getPrinters
-     */
-    getPrinters(): Promise<PrinterInfo[]>;
-    /**
-     * Updates Process Logging values: periodic interval and outlier detection entries and interval.
-     * @param {ProcessLoggingOptions} options Process Logging updatable options.
-     * @return { Promise<void> }
-     * @tutorial System.updateProcessLoggingOptions
-     */
-    updateProcessLoggingOptions(options: OpenFin.ProcessLoggingOptions): Promise<void>;
-}
-export {};