@openfin/core 33.76.36 → 33.77.1

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

@@ -1,692 +0,0 @@
-import type * as OpenFin from '../../OpenFin';
-import { EmitterBase } from '../base';
-import { Transport } from '../../transport/transport';
-/**
- * An object representing an application. Allows the developer to create,
- * execute, show/close an application as well as listen to {@link OpenFin.ApplicationEvents application events}.
- */
-export declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
-    identity: OpenFin.ApplicationIdentity;
-    /**
-     * @internal
-     */
-    _manifestUrl?: string;
-    private window;
-    /**
-     * @internal
-     */
-    constructor(wire: Transport, identity: OpenFin.ApplicationIdentity);
-    private windowListFromIdentityList;
-    /**
-     * Adds a listener to the end of the listeners array for the specified event.
-     * @param eventType  - The type of the event.
-     * @param listener - Called whenever an event of the specified type occurs.
-     * @param options - Option to support event timestamps.
-     *
-     * @function addListener
-     * @memberof Application
-     * @instance
-     * @tutorial Application.EventEmitter
-     */
-    /**
-     * Adds a listener to the end of the listeners array for the specified event.
-     * @param eventType  - The type of the event.
-     * @param listener - Called whenever an event of the specified type occurs.
-     * @param options - Option to support event timestamps.
-     *
-     * @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 eventType  - The type of the event.
-     * @param listener - The callback function.
-     * @param options - Option to support event timestamps.
-     *
-     * @function once
-     * @memberof Application
-     * @instance
-     * @tutorial Application.EventEmitter
-     */
-    /**
-     * Adds a listener to the beginning of the listeners array for the specified event.
-     * @param eventType  - The type of the event.
-     * @param listener - The callback function.
-     * @param options - Option to support event timestamps.
-     *
-     * @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 eventType  - The type of the event.
-     * @param listener - The callback function.
-     * @param options - Option to support event timestamps.
-     *
-     * @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 eventType  - The type of the event.
-     * @param listener - The callback function.
-     * @param options - Option to support event timestamps.
-     *
-     * @function removeListener
-     * @memberof Application
-     * @instance
-     * @tutorial Application.EventEmitter
-     */
-    /**
-     * Removes all listeners, or those of the specified event.
-     * @param eventType  - The type of the event.
-     *
-     * @function removeAllListeners
-     * @memberof Application
-     * @instance
-     * @tutorial Application.EventEmitter
-     */
-    /**
-     * 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
-     */
-    /**
-     * @PORTED
-     * 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.
-     */
-    /**
-     * Determines if the application is currently running.
-     *
-     * @example
-     *
-     * ```js
-     * async function isAppRunning() {
-     *     const app = await fin.Application.getCurrent();
-     *     return await app.isRunning();
-     * }
-     * isAppRunning().then(running => console.log(`Current app is running: ${running}`)).catch(err => console.log(err));
-     * ```
-     */
-    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 force Close will be prevented from closing when force is false and
-     *  ‘close-requested’ has been subscribed to for application’s main window.
-     *
-     * @example
-     *
-     * ```js
-     * async function closeApp() {
-     *     const allApps1 = await fin.System.getAllApplications(); //[{uuid: 'app1', isRunning: true}, {uuid: 'app2', isRunning: true}]
-     *     const app = await fin.Application.wrap({uuid: 'app2'});
-     *     await app.quit();
-     *     const allApps2 = await fin.System.getAllApplications(); //[{uuid: 'app1', isRunning: true}]
-     *
-     * }
-     * closeApp().then(() => console.log('Application quit')).catch(err => console.log(err));
-     * ```
-     */
-    quit(force?: boolean): Promise<void>;
-    private _close;
-    /**
-     * @deprecated use Application.quit instead
-     * Closes the application and any child windows created by the application.
-     * @param force - Close will be prevented from closing when force is false and ‘close-requested’ has been subscribed to for application’s main window.
-     * @param callback - called if the method succeeds.
-     * @param errorCallback - called if the method fails. The reason for failure is passed as an argument.
-     *
-     * @example
-     *
-     * ```js
-     * async function closeApp() {
-     *     const app = await fin.Application.getCurrent();
-     *     return await app.close();
-     * }
-     * closeApp().then(() => console.log('Application closed')).catch(err => console.log(err));
-     * ```
-     */
-    close(force?: boolean): Promise<void>;
-    /**
-     * Retrieves an array of wrapped fin.Windows for each of the application’s child windows.
-     *
-     * @example
-     *
-     * ```js
-     * async function getChildWindows() {
-     *     const app = await fin.Application.getCurrent();
-     *     return await app.getChildWindows();
-     * }
-     *
-     * getChildWindows().then(children => console.log(children)).catch(err => console.log(err));
-     * ```
-     */
-    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.
-     *
-     * @example
-     *
-     * ```js
-     * async function getManifest() {
-     *     const app = await fin.Application.getCurrent();
-     *     return await app.getManifest();
-     * }
-     *
-     * getManifest().then(manifest => console.log(manifest)).catch(err => console.log(err));
-     * ```
-     */
-    getManifest(): Promise<OpenFin.Manifest>;
-    /**
-     * Retrieves UUID of the application that launches this application. Invokes the error callback
-     * if the application was created from a manifest.
-     *
-     * @example
-     *
-     * ```js
-     * async function getParentUuid() {
-     *     const app = await fin.Application.start({
-     *         uuid: 'app-1',
-     *         name: 'myApp',
-     *         url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Application.getParentUuid.html',
-     *         autoShow: true
-     *     });
-     *     return await app.getParentUuid();
-     * }
-     *
-     * getParentUuid().then(parentUuid => console.log(parentUuid)).catch(err => console.log(err));
-     * ```
-     */
-    getParentUuid(): Promise<string>;
-    /**
-     * Retrieves current application's shortcut configuration.
-     *
-     * @example
-     *
-     * ```js
-     * async function getShortcuts() {
-     *     const app = await fin.Application.wrap({ uuid: 'testapp' });
-     *     return await app.getShortcuts();
-     * }
-     * getShortcuts().then(config => console.log(config)).catch(err => console.log(err));
-     * ```
-     */
-    getShortcuts(): Promise<OpenFin.ShortCutConfig>;
-    /**
-     * Retrieves current application's views.
-     * @experimental
-     *
-     * @example
-     *
-     * ```js
-     * async function getViews() {
-     *     const app = await fin.Application.getCurrent();
-     *     return await app.getViews();
-     * }
-     * getViews().then(views => console.log(views)).catch(err => console.log(err));
-     * ```
-     */
-    getViews(): Promise<Array<OpenFin.View>>;
-    /**
-     * Returns the current zoom level of the application.
-     *
-     * @example
-     *
-     * ```js
-     * async function getZoomLevel() {
-     *     const app = await fin.Application.getCurrent();
-     *     return await app.getZoomLevel();
-     * }
-     *
-     * getZoomLevel().then(zoomLevel => console.log(zoomLevel)).catch(err => console.log(err));
-     * ```
-     */
-    getZoomLevel(): Promise<number>;
-    /**
-     * Returns an instance of the main Window of the application
-     *
-     * @example
-     *
-     * ```js
-     * async function getWindow() {
-     *     const app = await fin.Application.start({
-     *         uuid: 'app-1',
-     *         name: 'myApp',
-     *         url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Application.getWindow.html',
-     *         autoShow: true
-     *     });
-     *     return await app.getWindow();
-     * }
-     *
-     * getWindow().then(win => {
-     *     win.showAt(0, 400);
-     *     win.flash();
-     * }).catch(err => console.log(err));
-     * ```
-     */
-    getWindow(): Promise<OpenFin.Window>;
-    /**
-     * Manually registers a user with the licensing service. The only data sent by this call is userName and appName.
-     * @param userName - username to be passed to the RVM.
-     * @param appName - app name to be passed to the RVM.
-     *
-     * @example
-     *
-     * ```js
-     * async function registerUser() {
-     *     const app = await fin.Application.getCurrent();
-     *     return await app.registerUser('user', 'myApp');
-     * }
-     *
-     * registerUser().then(() => console.log('Successfully registered the user')).catch(err => console.log(err));
-     * ```
-     */
-    registerUser(userName: string, appName: string): Promise<void>;
-    /**
-     * Removes the application’s icon from the tray.
-     *
-     * @example
-     *
-     * ```js
-     * async function removeTrayIcon() {
-     *     const app = await fin.Application.getCurrent();
-     *     return await app.removeTrayIcon();
-     * }
-     *
-     * removeTrayIcon().then(() => console.log('Removed the tray icon.')).catch(err => console.log(err));
-     * ```
-     */
-    removeTrayIcon(): Promise<void>;
-    /**
-     * Restarts the application.
-     *
-     * @example
-     *
-     * ```js
-     * async function restartApp() {
-     *     const app = await fin.Application.getCurrent();
-     *     return await app.restart();
-     * }
-     * restartApp().then(() => console.log('Application restarted')).catch(err => console.log(err));
-     * ```
-     */
-    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}.
-     *
-     * @example
-     *
-     * ```js
-     * async function run() {
-     *     const app = await fin.Application.create({
-     *         name: 'myApp',
-     *         uuid: 'app-1',
-     *         url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Application.run.html',
-     *         autoShow: true
-     *     });
-     *     await app.run();
-     * }
-     * run().then(() => console.log('Application is running')).catch(err => console.log(err));
-     * ```
-     *
-     * @ignore
-     */
-    run(): Promise<void>;
-    private _run;
-    /**
-     * Instructs the RVM to schedule one restart of the application.
-     *
-     * @example
-     *
-     * ```js
-     * async function scheduleRestart() {
-     *     const app = await fin.Application.getCurrent();
-     *     return await app.scheduleRestart();
-     * }
-     *
-     * scheduleRestart().then(() => console.log('Application is scheduled to restart')).catch(err => console.log(err));
-     * ```
-     */
-    scheduleRestart(): Promise<void>;
-    /**
-     * Sends a message to the RVM to upload the application's logs. On success,
-     * an object containing logId is returned.
-     *
-     * @example
-     *
-     * ```js
-     * async function sendLog() {
-     *     const app = await fin.Application.getCurrent();
-     *     return await app.sendApplicationLog();
-     * }
-     *
-     * sendLog().then(info => console.log(info.logId)).catch(err => console.log(err));
-     * ```
-     */
-    sendApplicationLog(): Promise<OpenFin.SendApplicationLogResponse>;
-    /**
-     * 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 jumpListCategories An array of JumpList Categories to populate. If null, remove any existing JumpList configuration and set to Windows default.
-     *
-     *
-     * @remarks If categories is null the previously set custom JumpList (if any) will be replaced by the standard JumpList for the app (managed by Windows).
-     *
-     * The bottommost item in the jumplist will always be an item pointing to the current app. Its name is taken from the manifest's
-     * **` shortcut.name `** and uses **` shortcut.company `** as a fallback. Clicking that item will launch the app from its current manifest.
-     *
-     * Note: If the "name" property is omitted it defaults to "tasks".
-     *
-     * Note: Window OS caches jumplists icons, therefore an icon change might only be visible after the cache is removed or the
-     * uuid or shortcut.name is changed.
-     *
-     * @example
-     *
-     * ```js
-     *     const app = fin.Application.getCurrentSync();
-     *     const appName = 'My App';
-     *     const jumpListConfig = [ // array of JumpList categories
-     *         {
-     *             // has no name and no type so `type` is assumed to be "tasks"
-     *             items: [ // array of JumpList items
-     *             {
-     *                 type: 'task',
-     *                 title: `Launch ${appName}`,
-     *                 description: `Runs ${appName} with the default configuration`,
-     *                 deepLink: 'fins://path.to/app/manifest.json',
-     *                 iconPath: 'https://path.to/app/icon.ico',
-     *                 iconIndex: 0
-     *             },
-     *             { type: 'separator' },
-     *             {
-     *                 type: 'task',
-     *                 title: `Restore ${appName}`,
-     *                 description: 'Restore to last configuration',
-     *                 deepLink: 'fins://path.to/app/manifest.json?$$use-last-configuration=true',
-     *                 iconPath: 'https://path.to/app/icon.ico',
-     *                 iconIndex: 0
-     *             },
-     *             ]
-     *         },
-     *         {
-     *             name: 'Tools',
-     *             items: [ // array of JumpList items
-     *             {
-     *                 type: 'task',
-     *                 title: 'Tool A',
-     *                 description: 'Runs Tool A',
-     *                 deepLink: 'fins://path.to/tool-a/manifest.json',
-     *                 iconPath: 'https://path.to/tool-a/icon.ico',
-     *                 iconIndex: 0
-     *             },
-     *             {
-     *                 type: 'task',
-     *                 title: 'Tool B',
-     *                 description: 'Runs Tool B',
-     *                 deepLink: 'fins://path.to/tool-b/manifest.json',
-     *                 iconPath: 'https://path.to/tool-b/icon.ico',
-     *                 iconIndex: 0
-     *             }]
-     *         }
-     *     ];
-     *
-     *     app.setJumpList(jumpListConfig).then(() => console.log('JumpList applied')).catch(e => console.log(`JumpList failed to apply: ${e.toString()}`));
-     * ```
-     *
-     * To handle deeplink args:
-     * ```js
-     *     function handleUseLastConfiguration() {
-     *         // this handler is called when the app is being launched
-     *         app.on('run-requested', event => {
-     *             if(event.userAppConfigArgs['use-last-configuration']) {
-     *                 // your logic here
-     *             }
-     *         });
-     *         // this handler is called when the app was already running when the launch was requested
-     *         fin.desktop.main(function(args) {
-     *             if(args && args['use-last-configuration']) {
-     *                 // your logic here
-     *             }
-     *         });
-     *     }
-     * ```
-     */
-    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 icon Image URL or base64 encoded string to be used as the icon
-     *
-     * @example
-     *
-     * ```js
-     * const imageUrl = "http://cdn.openfin.co/assets/testing/icons/circled-digit-one.png";
-     * const base64EncodedImage = "iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX\
-     * ///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYII";
-     * const dataURL = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DH\
-     * xgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==";
-     *
-     * async function setTrayIcon(icon) {
-     *     const app = await fin.Application.getCurrent();
-     *     return await app.setTrayIcon(icon);
-     * }
-     *
-     * // use image url to set tray icon
-     * setTrayIcon(imageUrl).then(() => console.log('Setting tray icon')).catch(err => console.log(err));
-     *
-     * // use base64 encoded string to set tray icon
-     * setTrayIcon(base64EncodedImage).then(() => console.log('Setting tray icon')).catch(err => console.log(err));
-     *
-     * // use a dataURL to set tray icon
-     * setTrayIcon(dataURL).then(() => console.log('Setting tray icon')).catch(err => console.log(err));
-     * ```
-     */
-    setTrayIcon(icon: string): Promise<void>;
-    /**
-     * Sets new application's shortcut configuration. Windows only.
-     * @param config New application's shortcut configuration.
-     *
-     * @remarks Application has to be launched with a manifest and has to have shortcut configuration (icon url, name, etc.) in its manifest
-     * to be able to change shortcut states.
-     *
-     * @example
-     *
-     * ```js
-     * async function setShortcuts(config) {
-     *     const app = await fin.Application.getCurrent();
-     *     return app.setShortcuts(config);
-     * }
-     *
-     * setShortcuts({
-     *     desktop: true,
-     *     startMenu: false,
-     *     systemStartup: true
-     * }).then(() => console.log('Shortcuts are set.')).catch(err => console.log(err));
-     * ```
-     */
-    setShortcuts(config: OpenFin.ShortCutConfig): Promise<void>;
-    /**
-     * Sets the query string in all shortcuts for this app. Requires RVM 5.5+.
-     * @param queryString The new query string for this app's shortcuts.
-     *
-     * @example
-     *
-     * ```js
-     * const newQueryArgs = 'arg=true&arg2=false';
-     * const app = await fin.Application.getCurrent();
-     * try {
-     *     await app.setShortcutQueryParams(newQueryArgs);
-     * } catch(err) {
-     *     console.error(err)
-     * }
-     * ```
-     */
-    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 level The zoom level
-     *
-     * @example
-     *
-     * ```js
-     * async function setZoomLevel(number) {
-     *     const app = await fin.Application.getCurrent();
-     *     return await app.setZoomLevel(number);
-     * }
-     *
-     * setZoomLevel(5).then(() => console.log('Setting a  zoom level')).catch(err => console.log(err));
-     * ```
-     */
-    setZoomLevel(level: number): Promise<void>;
-    /**
-     * Sets a username to correlate with App Log Management.
-     * @param username Username to correlate with App's Log.
-     *
-     * @example
-     *
-     * ```js
-     * async function setAppLogUser() {
-     *     const app = await fin.Application.getCurrent();
-     *     return await app.setAppLogUsername('username');
-     * }
-     *
-     * setAppLogUser().then(() => console.log('Success')).catch(err => console.log(err));
-     *
-     * ```
-     */
-    setAppLogUsername(username: string): Promise<void>;
-    /**
-     * Retrieves information about the system tray. If the system tray is not set, it will throw an error message.
-     * @remarks The only information currently returned is the position and dimensions.
-     *
-     * @example
-     *
-     * ```js
-     * async function getTrayIconInfo() {
-     *     const app = await fin.Application.wrap({ uuid: 'testapp' });
-     *     return await app.getTrayIconInfo();
-     * }
-     * getTrayIconInfo().then(info => console.log(info)).catch(err => console.log(err));
-     * ```
-     */
-    getTrayIconInfo(): Promise<OpenFin.TrayInfo>;
-    /**
-     * Checks if the application has an associated tray icon.
-     *
-     * @example
-     *
-     * ```js
-     * const app = await fin.Application.wrap({ uuid: 'testapp' });
-     * const hasTrayIcon = await app.hasTrayIcon();
-     * console.log(hasTrayIcon);
-     * ```
-     */
-    hasTrayIcon(): Promise<boolean>;
-    /**
-     * Closes the application by terminating its process.
-     *
-     * @example
-     *
-     * ```js
-     * async function terminateApp() {
-     *     const app = await fin.Application.getCurrent();
-     *     return await app.terminate();
-     * }
-     * terminateApp().then(() => console.log('Application terminated')).catch(err => console.log(err));
-     * ```
-     */
-    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.
-     *
-     * @ignore
-     */
-    wait(): Promise<void>;
-    /**
-     * Retrieves information about the application.
-     *
-     * @remarks If the application was not launched from a manifest, the call will return the closest parent application `manifest`
-     * and `manifestUrl`.  `initialOptions` shows the parameters used when launched programmatically, or the `startup_app` options
-     * if launched from manifest. The `parentUuid` will be the uuid of the immediate parent (if applicable).
-     *
-     * @example
-     *
-     * ```js
-     * async function getInfo() {
-     *     const app = await fin.Application.getCurrent();
-     *     return await app.getInfo();
-     * }
-     *
-     * getInfo().then(info => console.log(info)).catch(err => console.log(err));
-     * ```
-     */
-    getInfo(): Promise<OpenFin.ApplicationInfo>;
-    /**
-     * Retrieves all process information for entities (windows and views) associated with an application.
-     *
-     * @example
-     * ```js
-     *     const app = await fin.Application.getCurrent();
-     *     const processInfo = await app.getProcessInfo();
-     * ```
-     * @experimental
-     */
-    getProcessInfo(): Promise<OpenFin.AppProcessInfo>;
-    /**
-     * Sets file auto download location. It's only allowed in the same application.
-     * 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 downloadLocation file auto download location
-     *
-     * @throws if setting file auto download location on different applications.
-     * @example
-     *
-     * ```js
-     * const downloadLocation = 'C:\\dev\\temp';
-     * const app = await fin.Application.getCurrent();
-     * try {
-     *     await app.setFileDownloadLocation(downloadLocation);
-     *     console.log('File download location is set');
-     * } catch(err) {
-     *     console.error(err)
-     * }
-     * ```
-     */
-    setFileDownloadLocation(downloadLocation: string): Promise<void>;
-    /**
-     * Gets file auto download location. It's only allowed in the same application. If file auto download location is not set, it will return the default location.
-     * 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>.
-     *
-     * @throws if getting file auto download location on different applications.
-     * @example
-     *
-     * ```js
-     * const app = await fin.Application.getCurrent();
-     * const fileDownloadDir =  await app.getFileDownloadLocation();
-     * ```
-     */
-    getFileDownloadLocation(): Promise<string>;
-}