@openfin/core 26.71.2 → 26.71.6

package/OpenFin.d.ts

@@ -874,7 +874,56 @@ declare namespace OpenFin {
             payload: import('./src/api/events/window').WindowOptionsChangedEvent<'window', 'options-changed'>
         ): Promise<OpenFin.HostContextChangedPayload | undefined>;
 
+        /**
+         * Closes a Window.
+         * By default it will fire any before unload handler set by a View in the Window.
+         * This can be disabled by setting skipBeforeUnload in the options object of the payload.
+         * This method is called by {@link Platform#closeWindow Platform.closeWindow}.
+         * @param {CloseWindowPayload} payload Object that contains the Window Identity and related options.
+         * @param {Identity} callerIdentity
+         * @returns {Promise<void>}
+         */
         closeWindow(payload: CloseWindowPayload, callerIdentity: Identity): Promise<void>;
+
+        /**
+         * Gets all the Views attached to a Window that should close along with it. This is meant to be overridable
+         * in the case where you want to return other Views that may not be attached to the Window that is closing.
+         * @param winId Identity of the Window that is closing
+         * @returns { Promise<View> }
+         */
+        getViewsForWindowClose(windowId: OpenFin.Identity): Promise<OpenFin.View[]>;
+
+        /**
+         * It takes in an array of Views and returns an object specifying which of them are trying to prevent an unload and which are not.
+         * @param {View[]} views Array of Views
+         * @returns { Promise<ViewStatuses> }
+         */
+        checkViewsForPreventUnload(views: OpenFin.View[]): Promise<OpenFin.ViewStatuses>;
+
+        /**
+         * Handle the decision of whether a Window or specific View should close when trying to prevent an unload. This is meant to be overridden.
+         * Called in {@link PlatformProvider#closeWindow PlatformProvider.closeWindow}.
+         * Normally you would use this method to show a dialog indicating that there are Views that are trying to prevent an unload.
+         * By default it will always return all Views passed into it as meaning to close.
+         * @param {ViewsPreventingUnloadPayload} payload
+         * @tutorial PlatformProvider.getUserDecisionForBeforeUnload
+         * @returns {Promise<BeforeUnloadUserDecision>}
+         */
+        getUserDecisionForBeforeUnload(
+            payload: OpenFin.ViewsPreventingUnloadPayload
+        ): Promise<OpenFin.BeforeUnloadUserDecision>;
+
+        /**
+         * Handles the closing of a Window and/or its Views. Called in {@link PlatformProvider#closeWindow PlatformProvider.closeWindow}.
+         * The return of {@link PlatformProvider#getUserDecisionForBeforeUnload PlatformProvider.getUserDecisionForBeforeUnload} is passed into this method.
+         * @param {Identity} winId Identity of the Window
+         * @param {BeforeUnloadUserDecision} userDecision Decision object
+         * @returns {Promise<void>}
+         */
+        handleViewsAndWindowClose(
+            windowId: OpenFin.Identity,
+            userDecision: OpenFin.BeforeUnloadUserDecision
+        ): Promise<void>;
     };
 
     export type InitPlatformOptions = {
@@ -1057,6 +1106,7 @@ declare namespace OpenFin {
     export type RvmLaunchOptions = {
         noUi?: boolean;
         userAppConfigArgs?: object;
+        timeToLive?: number;
     };
 
     export type ShortCutConfig = {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "26.71.2",
+    "version": "26.71.6",
     "license": "Apache-2.0",
     "main": "./src/mock.js",
     "types": "./src/mock.d.ts",

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

@@ -111,12 +111,13 @@ export default class ApplicationModule extends Base {
      * 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
      */
-    startManyManifests(applications: Array<OpenFin.ManifestInfo>): Promise<void>;
+    startManyManifests(applications: Array<OpenFin.ManifestInfo>, opts?: OpenFin.RvmLaunchOptions): Promise<void>;
     /**
      * Asynchronously returns an Application object that represents the current application
      * @return {Promise.<Application>}

package/src/api/application/Factory.js

@@ -156,13 +156,14 @@ class ApplicationModule extends base_1.Base {
      * 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) {
-        return this.wire.sendAction('run-applications', { applications }).then(() => undefined);
+    async startManyManifests(applications, opts) {
+        return this.wire.sendAction('run-applications', { applications, opts }).then(() => undefined);
     }
     /**
      * Asynchronously returns an Application object that represents the current application

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

@@ -119,6 +119,15 @@ export declare class Platform extends EmitterBase<PlatformEvents> {
      * @experimental
      */
     getWindowContext(target?: OpenFin.Identity): Promise<any>;
+    /**
+     * Closes a window. If enableBeforeUnload is enabled in the Platform options, any beforeunload handler set on Views will fire
+     * This behavior can be disabled by setting skipBeforeUnload to false in the options parameter.
+     * @param {Identity} winId
+     * @param {closeWindowoptions} [options]
+     * @returns {Promise<void>}
+     * @tutorial Platform.closeWindow
+     * @experimental
+     */
     closeWindow(windowId: OpenFin.Identity, options?: {
         skipBeforeUnload: boolean;
     }): Promise<void>;

package/src/api/platform/Instance.js

@@ -293,6 +293,15 @@ class Platform extends base_1.EmitterBase {
             entityType
         });
     }
+    /**
+     * Closes a window. If enableBeforeUnload is enabled in the Platform options, any beforeunload handler set on Views will fire
+     * This behavior can be disabled by setting skipBeforeUnload to false in the options parameter.
+     * @param {Identity} winId
+     * @param {closeWindowoptions} [options]
+     * @returns {Promise<void>}
+     * @tutorial Platform.closeWindow
+     * @experimental
+     */
     async closeWindow(windowId, options = { skipBeforeUnload: false }) {
         this.wire.sendAction('platform-close-window', this.identity).catch((e) => {
             // don't expose

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

@@ -397,6 +397,7 @@ import ApplicationWindowInfo = OpenFin.ApplicationWindowInfo;
  * @typedef { object } RvmLaunchOptions
  * @property { boolean } [noUi] true if no UI when launching
  * @property { object } [userAppConfigArgs] The user app configuration args
+ * @property { number } [timeToLive] Timeout in seconds until RVM launch request expires
  */
 /**
  * ServiceIdentifier interface

package/src/api/system/index.js

@@ -387,6 +387,7 @@ const window_1 = require("../window");
  * @typedef { object } RvmLaunchOptions
  * @property { boolean } [noUi] true if no UI when launching
  * @property { object } [userAppConfigArgs] The user app configuration args
+ * @property { number } [timeToLive] Timeout in seconds until RVM launch request expires
  */
 /**
  * ServiceIdentifier interface

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

@@ -57,11 +57,14 @@ import UpdatableViewOptions = OpenFin.UpdatableViewOptions;
  * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
  *
  * @property {any} [customData=""] - _Updatable._
- * A field that the user can attach serializable data to to be ferried around with the view options.
+ * A field that the user can attach serializable data to be ferried around with the view options.
  * _When omitted, the default value of this property is the empty string (`""`)._
  *
+ * @property {any} [customContext=""] - _Updatable._
+ * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
+ * is called.
  * When omitted, the default value of this property is the empty string (`""`).
- * As opposed to customData this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
+ * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
  *
  * @property {object[]} [hotkeys=[]] - _Updatable._
  * Defines the list of hotkeys that will be emitted as a `hotkey` event on the view. For usage example see [example]{@tutorial hotkeys}.
@@ -393,5 +396,12 @@ export declare class View extends WebContents<ViewEvents> {
      * @experimental
      */
     getCurrentWindow: () => Promise<OpenFin.Window>;
+    /**
+     * Triggers the before-unload handler for the View, if one is set. Returns `true` if the handler is trying to prevent the View from unloading, and `false` if it isn't.
+     * Only enabled when setting enableBeforeUnload: true in your View options. If this option is not enabled it will always return false.
+     * @returns {Promise<boolean>}
+     * @tutorial View.triggerBeforeUnload
+     * @experimental
+     */
     triggerBeforeUnload: () => Promise<boolean>;
 }

package/src/api/view/Instance.js

@@ -60,11 +60,14 @@ const window_1 = require("../window");
  * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
  *
  * @property {any} [customData=""] - _Updatable._
- * A field that the user can attach serializable data to to be ferried around with the view options.
+ * A field that the user can attach serializable data to be ferried around with the view options.
  * _When omitted, the default value of this property is the empty string (`""`)._
  *
+ * @property {any} [customContext=""] - _Updatable._
+ * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
+ * is called.
  * When omitted, the default value of this property is the empty string (`""`).
- * As opposed to customData this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
+ * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
  *
  * @property {object[]} [hotkeys=[]] - _Updatable._
  * Defines the list of hotkeys that will be emitted as a `hotkey` event on the view. For usage example see [example]{@tutorial hotkeys}.
@@ -394,6 +397,13 @@ class View extends main_1.WebContents {
             const { payload: { data } } = await this.wire.sendAction('get-view-window', { ...this.identity });
             return new window_1._Window(this.wire, data);
         };
+        /**
+         * Triggers the before-unload handler for the View, if one is set. Returns `true` if the handler is trying to prevent the View from unloading, and `false` if it isn't.
+         * Only enabled when setting enableBeforeUnload: true in your View options. If this option is not enabled it will always return false.
+         * @returns {Promise<boolean>}
+         * @tutorial View.triggerBeforeUnload
+         * @experimental
+         */
         this.triggerBeforeUnload = async () => {
             const message = await this.wire.sendAction('trigger-before-unload', { ...this.identity });
             return message.payload.data;

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

@@ -171,16 +171,16 @@ import WindowEvents = OpenFin.WindowEvents;
  * @property {number} [cornerRounding.height=0] The height in pixels.
  * @property {number} [cornerRounding.width=0] The width in pixels.
  *
- * @property {any} [customContext=""] - _Updatable._
+ * @property {any} [customContext=""] - _Updatable. Inheritable._
  * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
  * is called.  If a window in a Platform is trying to update or retrieve its own context, it can use the
  * {@link Platform#setWindowContext Platform.setWindowContext} and {@link Platform#getWindowContext Platform.getWindowContext} calls.
- * When omitted, the default value of this property is the empty string (`""`).
- * As opposed to customData this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
+ * _When omitted, _inherits_ from the parent application._
+ * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
  *
- * @property {any} [customData=""] - _Updatable._
- * A field that the user can attach serializable data to to be ferried around with the window options.
- * _When omitted, the default value of this property is the empty string (`""`)._
+ * @property {any} [customData=""] - _Updatable. Inheritable._
+ * A field that the user can attach serializable data to be ferried around with the window options.
+ * _When omitted, _inherits_ from the parent application._
  *
  * @property {object[]} [customRequestHeaders]
  * Defines list of custom headers for requests sent by the window.
@@ -235,7 +235,7 @@ import WindowEvents = OpenFin.WindowEvents;
  *
  * @property {string} [icon] - _Updatable. Inheritable._
  * A URL for the icon to be shown in the window title bar and the taskbar.
- * _When omitted, inherits from the parent application._
+ * When omitted, inherits from the parent application._
  *  note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.
  *
  * @property {number} [maxHeight=-1] - _Updatable._

package/src/api/window/Instance.js

@@ -178,16 +178,16 @@ const view_1 = require("../view");
  * @property {number} [cornerRounding.height=0] The height in pixels.
  * @property {number} [cornerRounding.width=0] The width in pixels.
  *
- * @property {any} [customContext=""] - _Updatable._
+ * @property {any} [customContext=""] - _Updatable. Inheritable._
  * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
  * is called.  If a window in a Platform is trying to update or retrieve its own context, it can use the
  * {@link Platform#setWindowContext Platform.setWindowContext} and {@link Platform#getWindowContext Platform.getWindowContext} calls.
- * When omitted, the default value of this property is the empty string (`""`).
- * As opposed to customData this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
+ * _When omitted, _inherits_ from the parent application._
+ * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
  *
- * @property {any} [customData=""] - _Updatable._
- * A field that the user can attach serializable data to to be ferried around with the window options.
- * _When omitted, the default value of this property is the empty string (`""`)._
+ * @property {any} [customData=""] - _Updatable. Inheritable._
+ * A field that the user can attach serializable data to be ferried around with the window options.
+ * _When omitted, _inherits_ from the parent application._
  *
  * @property {object[]} [customRequestHeaders]
  * Defines list of custom headers for requests sent by the window.
@@ -242,7 +242,7 @@ const view_1 = require("../view");
  *
  * @property {string} [icon] - _Updatable. Inheritable._
  * A URL for the icon to be shown in the window title bar and the taskbar.
- * _When omitted, inherits from the parent application._
+ * When omitted, inherits from the parent application._
  *  note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.
  *
  * @property {number} [maxHeight=-1] - _Updatable._