@openfin/core 30.73.21 → 30.73.22

package/package.json

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

package/src/OpenFin.d.ts

@@ -429,6 +429,12 @@ export declare type ConstViewOptions = {
     enableBeforeUnload: boolean;
     accelerator?: Partial<Accelerator>;
 };
+export declare type ViewState = ViewCreationOptions & {
+    backgroundThrottling: boolean;
+    componentName: 'view';
+    initialUrl: string;
+    minWidth?: number;
+};
 export declare type Certificate = {
     data: string;
     fingerprint: string;
@@ -673,6 +679,14 @@ export declare type PlatformProvider = {
      * @return { Promise<Snapshot> } Snapshot of current platform state.
      */
     getSnapshot(payload: undefined, identity: Identity): Promise<Snapshot>;
+    /**
+     * Gets the current state of a single view and returns an object with the options needed to restore that view as part of a snapshot.
+     * @param { Identity } payload Identity of the view.
+     * @return { Promise<ViewState> }
+     */
+    getViewSnapshot(payload: {
+        viewIdentity: Identity;
+    }): Promise<ViewState>;
     /**
      * Called when a snapshot is being applied and some windows in that snapshot would be fully or partially off-screen.
      * Returns an array of windows with modified positions, such that any off-screen windows are positioned in the top left

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

@@ -65,6 +65,18 @@ export declare class Platform extends EmitterBase<PlatformEvents> {
      * @tutorial Platform.getSnapshot
      */
     getSnapshot(): Promise<OpenFin.Snapshot>;
+    /**
+     * Returns a snapshot of a single view's options in its current state.
+     *
+     * Can be used to restore a view to a previous state.
+     *
+     * NOTE: this method is meant for advanced usage only, it is not recommended to manage the state of individual views.
+     *
+     * @param { Identity } viewIdentity View identity
+     * @returns { Promise<ViewState> }
+     * @tutorial Platform.getViewSnapshot
+     */
+    getViewSnapshot(viewIdentity: OpenFin.Identity): Promise<OpenFin.ViewState>;
     /**
      * Adds a snapshot to a running Platform.
      * Requested snapshot must be a valid Snapshot object, or a url or filepath to such an object.

package/src/api/platform/Instance.js

@@ -173,6 +173,21 @@ class Platform extends base_1.EmitterBase {
         const client = await this.getClient();
         return client.dispatch('get-snapshot');
     }
+    /**
+     * Returns a snapshot of a single view's options in its current state.
+     *
+     * Can be used to restore a view to a previous state.
+     *
+     * NOTE: this method is meant for advanced usage only, it is not recommended to manage the state of individual views.
+     *
+     * @param { Identity } viewIdentity View identity
+     * @returns { Promise<ViewState> }
+     * @tutorial Platform.getViewSnapshot
+     */
+    async getViewSnapshot(viewIdentity) {
+        const client = await this.getClient();
+        return client.dispatch('get-view-snapshot', { viewIdentity });
+    }
     /**
      * Adds a snapshot to a running Platform.
      * Requested snapshot must be a valid Snapshot object, or a url or filepath to such an object.