@openfin/core 33.76.31 → 33.76.38

package/src/api/application/Factory.js

@@ -1,230 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const base_1 = require("../base");
-const validate_1 = require("../../util/validate");
-const Instance_1 = require("./Instance");
-/**
- * @PORTED
- * @typedef {object} ApplicationOptions
- * @summary Application creation options.
- * @desc This is the options object required by {@link Application.start Application.start}.
- *
- * The following options are required:
- * * `uuid` is required in the app manifest as well as by {@link Application.start Application.start}
- * * `name` is optional in the app manifest but required by {@link Application.start Application.start}
- * * `url` is optional in both the app manifest {@link Application.start Application.start} and  but is usually given
- * (defaults to `"about:blank"` when omitted).
- *
- * _This jsdoc typedef mirrors the `ApplicationOption` TypeScript interface in `@types/openfin`._
- *
- * **IMPORTANT NOTE:**
- * This object inherits all the properties of the window creation {@link Window~options options} object,
- * which will take priority over those of the same name that may be provided in `mainWindowOptions`.
- *
- * @property {boolean} [disableIabSecureLogging=false]
- * When set to `true` it will disable IAB secure logging for the app.
- *
- * @property {string} [loadErrorMessage="There was an error loading the application."]
- * An error message to display when the application (launched via manifest) fails to load.
- * A dialog box will be launched with the error message just before the runtime exits.
- * Load fails such as failed DNS resolutions or aborted connections as well as cancellations, _e.g.,_ `window.stop()`,
- * will trigger this dialog.
- * Client response codes such as `404 Not Found` are not treated as fails as they are valid server responses.
- *
- * @property {Window~options} [mainWindowOptions]
- * The options of the main window of the application.
- * For a description of these options, click the link (in the Type column).
- *
- * @property {number} [maxViewPoolSize=1000]
- * Platforms Only.  The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
- * If you do not wish for views to be pooled on your platform, set this property to zero.
- *
- * @property {boolean} [preventQuitOnLastWindowClosed=false]
- * Platforms Only. Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
- * Note: if the Platform Provider is showing, it won't close automatically.
- * If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
- *
- * @property {string} [name]
- * The name of the application (and the application's main window).
- *
- * If provided, _must_ match `uuid`.
- *
- * @property {boolean} [nonPersistent=false]
- * A flag to configure the application as non-persistent.
- * Runtime exits when there are no persistent apps running.
- *
- * @property {boolean} [plugins=false]
- * Enable Flash at the application level.
- *
- * @property {boolean} [spellCheck=false]
- * Enable spell check at the application level.
- *
- * @property {string} [url="about:blank"]
- * The url to the application (specifically the application's main window).
- *
- * @property {boolean} [enableJumpList=false]
- * Enables the use of the Jumplists API and the 'pin to taskbar' functionality.
- * Only relevant in Windows.
- *
- * @property {string} uuid
- * The _Unique Universal Identifier_ (UUID) of the application, unique within the set of all other applications
- *  running in the OpenFin Runtime.
- *
- * Note that `name` and `uuid` must match.
- *
- * @property {boolean} [webSecurity=true]
- * When set to `false` it will disable the same-origin policy for the app.
- */
-/**
- * @lends Application
- */
-class ApplicationModule extends base_1.Base {
-    /**
-     * Asynchronously returns an Application object that represents an existing application.
-     * @param { Identity } identity
-     * @return {Promise.<Application>}
-     * @tutorial Application.wrap
-     * @static
-     */
-    async wrap(identity) {
-        this.wire.sendAction('wrap-application').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        const errorMsg = (0, validate_1.validateIdentity)(identity);
-        if (errorMsg) {
-            throw new Error(errorMsg);
-        }
-        return new Instance_1.Application(this.wire, identity);
-    }
-    /**
-     * Synchronously returns an Application object that represents an existing application.
-     * @param { Identity } identity
-     * @return {Application}
-     * @tutorial Application.wrapSync
-     * @static
-     */
-    wrapSync(identity) {
-        this.wire.sendAction('wrap-application-sync').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        const errorMsg = (0, validate_1.validateIdentity)(identity);
-        if (errorMsg) {
-            throw new Error(errorMsg);
-        }
-        return new Instance_1.Application(this.wire, identity);
-    }
-    async _create(appOptions) {
-        // set defaults:
-        if (appOptions.waitForPageLoad === undefined) {
-            appOptions.waitForPageLoad = false;
-        }
-        if (appOptions.autoShow === undefined && appOptions.isPlatformController === undefined) {
-            appOptions.autoShow = true;
-        }
-        await this.wire.sendAction('create-application', appOptions);
-        return this.wrap({ uuid: appOptions.uuid });
-    }
-    /**
-     * DEPRECATED method to create a new Application. Use {@link Application.start} instead.
-     * @param { ApplicationOptions } appOptions
-     * @return {Promise.<Application>}
-     * @tutorial Application.create
-     * @ignore
-     */
-    create(appOptions) {
-        console.warn('Deprecation Warning: fin.Application.create is deprecated. Please use fin.Application.start');
-        this.wire.sendAction('application-create').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        return this._create(appOptions);
-    }
-    /**
-     * Creates and starts a new Application.
-     * @param { ApplicationOptions } appOptions
-     * @return {Promise.<Application>}
-     * @tutorial Application.start
-     * @static
-     */
-    async start(appOptions) {
-        this.wire.sendAction('start-application').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        const app = await this._create(appOptions);
-        await this.wire.sendAction('run-application', { uuid: appOptions.uuid });
-        return app;
-    }
-    /**
-     * Asynchronously starts a batch of applications given an array of application identifiers and manifestUrls.
-     * Returns once the RVM is finished attempting to launch the applications.
-     * @param { Array.<ManifestInfo> } applications
-     * @param {RvmLaunchOptions} [opts] - Parameters that the RVM will use.
-     * @return {Promise.<void>}
-     * @static
-     * @tutorial Application.startManyManifests
-     * @experimental
-     */
-    async startManyManifests(applications, opts) {
-        return this.wire.sendAction('run-applications', { applications, opts }).then(() => undefined);
-    }
-    /**
-     * Asynchronously returns an Application object that represents the current application
-     * @return {Promise.<Application>}
-     * @tutorial Application.getCurrent
-     * @static
-     */
-    getCurrent() {
-        this.wire.sendAction('get-current-application').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        return this.wrap({ uuid: this.wire.me.uuid });
-    }
-    /**
-     * Synchronously returns an Application object that represents the current application
-     * @return {Application}
-     * @tutorial Application.getCurrentSync
-     * @static
-     */
-    getCurrentSync() {
-        this.wire.sendAction('get-current-application-sync').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        return this.wrapSync({ uuid: this.wire.me.uuid });
-    }
-    /**
-     * Retrieves application's manifest and returns a running instance of the application.
-     * @param {string} manifestUrl - The URL of app's manifest.
-     * @param {RvmLaunchOptions} [opts] - Parameters that the RVM will use.
-     * @return {Promise.<Application>}
-     * @tutorial Application.startFromManifest
-     * @static
-     */
-    async startFromManifest(manifestUrl, opts) {
-        this.wire.sendAction('application-start-from-manifest').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        const app = await this._createFromManifest(manifestUrl);
-        // @ts-expect-error using private method without warning.
-        await app._run(opts); // eslint-disable-line no-underscore-dangle
-        return app;
-    }
-    createFromManifest(manifestUrl) {
-        console.warn('Deprecation Warning: fin.Application.createFromManifest is deprecated. Please use fin.Application.startFromManifest');
-        this.wire.sendAction('application-create-from-manifest').catch((e) => {
-            // we do not want to expose this error, just continue if this analytics-only call fails
-        });
-        return this._createFromManifest(manifestUrl);
-    }
-    _createFromManifest(manifestUrl) {
-        return this.wire
-            .sendAction('get-application-manifest', { manifestUrl })
-            .then(({ payload }) => {
-            const uuid = payload.data.platform ? payload.data.platform.uuid : payload.data.startup_app.uuid;
-            return this.wrap({ uuid });
-        })
-            .then((app) => {
-            app._manifestUrl = manifestUrl; // eslint-disable-line no-underscore-dangle
-            return app;
-        });
-    }
-}
-exports.default = ApplicationModule;

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

@@ -1,321 +0,0 @@
-import type * as OpenFin from '../../OpenFin';
-import { EmitterBase } from '../base';
-import { Transport } from '../../transport/transport';
-/**
- * @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<OpenFin.ApplicationEvent> {
-    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
-     */
-    /**
-     * @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.
-     */
-    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.<Manifest>}
-     * @tutorial Application.getManifest
-     */
-    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.
-     * @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.<SendApplicationLogResponse>}
-     * @tutorial Application.sendApplicationLog
-     */
-    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 { 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. If the system tray is not set, it will throw an error message.
-     * @desc The only information currently returned is the position and dimensions.
-     * @return {Promise.<TrayInfo>}
-     * @tutorial Application.getTrayIconInfo
-     */
-    getTrayIconInfo(): Promise<OpenFin.TrayInfo>;
-    /**
-     * @summary Checks if the application has an associated tray icon.
-     * @return {Promise.<boolean>}
-     * @tutorial Application.hasTrayIcon
-     */
-    hasTrayIcon(): Promise<boolean>;
-    /**
-     * 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. 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 { string } downloadLocation file auto download location
-     * @return {Promise.<void>}
-     * @throws if setting file auto download location on different applications.
-     * @tutorial Application.setFileDownloadLocation
-     */
-    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>.
-     * @return {Promise.<string>}
-     * @throws if getting file auto download location on different applications.
-     * @tutorial Application.getFileDownloadLocation
-     */
-    getFileDownloadLocation(): Promise<string>;
-}