@openfin/core 25.68.26

package/src/api/application/Instance.d.ts

@@ -0,0 +1,302 @@
+import { EmitterBase } from '../base';
+import Transport from '../../transport/transport';
+import { ApplicationEvents } from '../events/application';
+/**
+ * @classdesc An object representing an application. Allows the developer to create,
+ * execute, show/close an application as well as listen to <a href="tutorial-Application.EventEmitter.html">application events</a>.
+ * @class
+ * @hideconstructor
+ */
+export declare class Application extends EmitterBase<ApplicationEvents> {
+    identity: OpenFin.ApplicationIdentity;
+    _manifestUrl?: string;
+    private window;
+    constructor(wire: Transport, identity: OpenFin.ApplicationIdentity);
+    private windowListFromIdentityList;
+    /**
+     * 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 Application
+     * @instance
+     * @tutorial Application.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 Application
+     * @instance
+     * @tutorial Application.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 Application
+     * @instance
+     * @tutorial Application.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 Application
+     * @instance
+     * @tutorial Application.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 Application
+     * @instance
+     * @tutorial Application.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 Application
+     * @instance
+     * @tutorial Application.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 Application
+     * @instance
+     * @tutorial Application.EventEmitter
+     */
+    /**
+     * Determines if the application is currently running.
+     * @return {Promise.<boolean>}
+     * @tutorial Application.isRunning
+     */
+    /**
+     * JumpListCategory interface
+     * @typedef { object } JumpListCategory
+     * @property { string } name The display title for the category. If omitted, items in this category will be placed into the standard 'Tasks' category. There can be only one such category, and it will always be displayed at the bottom of the JumpList.
+     * @property { JumpListItem[] } items Array of JumpListItem objects
+     */
+    /**
+     * JumpListItem interface
+     * @typedef { object } JumpListItem
+     * @property { string } type One of the following: "task" or "separator". Defaults to task.
+     * @property { string } title The text to be displayed for the JumpList Item. Should only be set if type is "task".
+     * @property { string } description Description of the task (displayed in a tooltip). Should only be set if type is "task".
+     * @property { string } deepLink Deep link to a manifest, i.e: fins://path.to/manifest.json?$$param1=value1. See {@link https://developers.openfin.co/docs/deep-linking deep-linking} for more information.
+     * @property { string } iconPath The absolute path to an icon to be displayed for the item, which can be an arbitrary resource file that contains an icon (e.g. .ico, .exe, .dll).
+     * @property { number } iconIndex The index of the icon in the resource file. If a resource file contains multiple icons this value can be used to specify the zero-based index of the icon that should be displayed for this task. If a resource file contains only one icon, this property should be set to zero.
+     */
+    isRunning(): Promise<boolean>;
+    /**
+     * Closes the application and any child windows created by the application.
+     * Cleans the application from state so it is no longer found in getAllApplications.
+     * @param { boolean } [force = false] Close will be prevented from closing when force is false and
+     *  ‘close-requested’ has been subscribed to for application’s main window.
+     * @return {Promise.<boolean>}
+     * @tutorial Application.quit
+     */
+    quit(force?: boolean): Promise<void>;
+    private _close;
+    close(force?: boolean): Promise<void>;
+    /**
+     * Retrieves an array of wrapped fin.Windows for each of the application’s child windows.
+     * @return {Promise.Array.<_Window>}
+     * @tutorial Application.getChildWindows
+     */
+    getChildWindows(): Promise<Array<OpenFin.Window>>;
+    /**
+     * Retrieves the JSON manifest that was used to create the application. Invokes the error callback
+     * if the application was not created from a manifest.
+     * @return {Promise.<any>}
+     * @tutorial Application.getManifest
+     */
+    getManifest(): Promise<any>;
+    /**
+     * Retrieves UUID of the application that launches this application. Invokes the error callback
+     * if the application was created from a manifest.
+     * @return {Promise.<string>}
+     * @tutorial Application.getParentUuid
+     */
+    getParentUuid(): Promise<string>;
+    /**
+     * Retrieves current application's shortcut configuration.
+     * @return {Promise.<ShortCutConfig>}
+     * @tutorial Application.getShortcuts
+     */
+    getShortcuts(): Promise<OpenFin.ShortCutConfig>;
+    /**
+     * Retrieves current application's views.
+     * @experimental
+     * @return {Promise.Array.<View>}
+     * @tutorial Application.getViews
+     */
+    getViews(): Promise<Array<OpenFin.View>>;
+    /**
+     * Returns the current zoom level of the application.
+     * @return {Promise.<number>}
+     * @tutorial Application.getZoomLevel
+     */
+    getZoomLevel(): Promise<number>;
+    /**
+     * Returns an instance of the main Window of the application
+     * @return {Promise.<_Window>}
+     * @tutorial Application.getWindow
+     */
+    getWindow(): Promise<OpenFin.Window>;
+    /**
+     * Manually registers a user with the licensing service. The only data sent by this call is userName and appName.
+     * @param { string } userName - username to be passed to the RVM.
+     * @param { string } appName - app name to be passed to the RVM.
+     * @return {Promise.<void>}
+     * @tutorial Application.registerUser
+     */
+    registerUser(userName: string, appName: string): Promise<void>;
+    /**
+     * Removes the application’s icon from the tray.
+     * @return {Promise.<void>}
+     * @tutorial Application.removeTrayIcon
+     */
+    removeTrayIcon(): Promise<void>;
+    /**
+     * Restarts the application.
+     * @return {Promise.<void>}
+     * @tutorial Application.restart
+     */
+    restart(): Promise<void>;
+    /**
+     * DEPRECATED method to run the application.
+     * Needed when starting application via {@link Application.create}, but NOT needed when starting via {@link Application.start}.
+     * @return {Promise.<void>}
+     * @tutorial Application.run
+     * @ignore
+     */
+    run(): Promise<void>;
+    private _run;
+    /**
+     * Instructs the RVM to schedule one restart of the application.
+     * @return {Promise.<void>}
+     * @tutorial Application.scheduleRestart
+     */
+    scheduleRestart(): Promise<void>;
+    /**
+     * Sends a message to the RVM to upload the application's logs. On success,
+     * an object containing logId is returned.
+     * @return {Promise.<LogInfo>}
+     * @tutorial Application.sendApplicationLog
+     */
+    sendApplicationLog(): Promise<OpenFin.LogInfo>;
+    /**
+     * Sets or removes a custom JumpList for the application. Only applicable in Windows OS.
+     * If categories is null the previously set custom JumpList (if any) will be replaced by the standard JumpList for the app (managed by Windows).
+     * Note: If the "name" property is omitted it defaults to "tasks".
+     * @param { Array.<JumpListCategory> | null } jumpListCategories An array of JumpList Categories to populate. If null, remove any existing JumpList configuration and set to Windows default.
+     * @return { Promise.<void> }
+     * @tutorial Application.setJumpList
+     */
+    setJumpList(jumpListCategories: OpenFin.JumpListCategory[] | null): Promise<void>;
+    /**
+     * Adds a customizable icon in the system tray.  To listen for a click on the icon use the `tray-icon-clicked` event.
+     * @param { string } icon Image URL or base64 encoded string to be used as the icon
+     * @return {Promise.<void>}
+     * @tutorial Application.setTrayIcon
+     */
+    setTrayIcon(icon: string): Promise<void>;
+    /**
+     * Sets new application's shortcut configuration. Windows only.
+     * @param { ShortCutConfig } config New application's shortcut configuration.
+     * @param { boolean } [config.desktop] - Enable/disable desktop shortcut.
+     * @param { boolean } [config.startMenu] - Enable/disable start menu shortcut.
+     * @param { boolean } [config.systemStartup] - Enable/disable system startup shortcut.
+     * @return {Promise.<void>}
+     * @tutorial Application.setShortcuts
+     */
+    setShortcuts(config: OpenFin.ShortCutConfig): Promise<void>;
+    /**
+     * Sets the query string in all shortcuts for this app. Requires RVM 5.5+.
+     * @param { string } queryString The new query string for this app's shortcuts.
+     * @return {Promise.<void>}
+     * @tutorial Application.setShortcutQueryParams
+     */
+    setShortcutQueryParams(queryString: string): Promise<void>;
+    /**
+     * Sets the zoom level of the application. The original size is 0 and each increment above or below represents zooming 20%
+     * larger or smaller to default limits of 300% and 50% of original size, respectively.
+     * @param { number } level The zoom level
+     * @return {Promise.<void>}
+     * @tutorial Application.setZoomLevel
+     */
+    setZoomLevel(level: number): Promise<void>;
+    /**
+     * Sets a username to correlate with App Log Management.
+     * @param { string } username Username to correlate with App's Log.
+     * @return {Promise.<void>}
+     * @tutorial Application.setAppLogUsername
+     */
+    setAppLogUsername(username: string): Promise<void>;
+    /**
+     * @summary Retrieves information about the system tray.
+     * @desc The only information currently returned is the position and dimensions.
+     * @return {Promise.<TrayInfo>}
+     * @tutorial Application.getTrayIconInfo
+     */
+    getTrayIconInfo(): Promise<OpenFin.TrayInfo>;
+    /**
+     * Closes the application by terminating its process.
+     * @return {Promise.<void>}
+     * @tutorial Application.terminate
+     */
+    terminate(): Promise<void>;
+    /**
+     * Waits for a hanging application. This method can be called in response to an application
+     * "not-responding" to allow the application to continue and to generate another "not-responding"
+     * message after a certain period of time.
+     * @return {Promise.<void>}
+     * @ignore
+     */
+    wait(): Promise<void>;
+    /**
+     * Retrieves information about the application.
+     * @return {Promise.<ApplicationInfo>}
+     * @tutorial Application.getInfo
+     */
+    getInfo(): Promise<OpenFin.ApplicationInfo>;
+    /**
+     * Retrieves all process information for entities (windows and views) associated with an application.
+     * @return {Promise.<AppProcessInfo>}
+     * @tutorial Application.getProcessInfo
+     * @experimental
+     */
+    getProcessInfo(): Promise<OpenFin.AppProcessInfo>;
+    /**
+     * Sets file auto download location.
+     * @param { string } downloadLocation file auto download location
+     * @return {Promise.<void>}
+     * @tutorial Application.setFileDownloadLocation
+     */
+    setFileDownloadLocation(downloadLocation: string): Promise<void>;
+}