@interopio/workspaces-api 4.1.0 → 4.1.1

package/workspaces.d.ts

@@ -167,9 +167,11 @@ export namespace IOConnectWorkspaces {
         positionIndex?: number;
 
         /**
-         * Controls the users ability to activate the Workspaces frame when the workspace is restored.
-         * *Available only in **io.Connect Desktop**.*
+         * If `true`, the Workspaces Frame instance containing the restored Workspace will be activated.
+         * This means that the Workspaces Frame window will gain focus, will be restored to its normal state (e.g., if it has been previously minimized),
+         * and will be brought in front of other existing windows.
          * Defaults to the configuration passed in the `workspaces.json` file or to `false`.
+         * *Available only in **io.Connect Desktop**.*
          */
         activateFrame?: boolean;
 
@@ -180,6 +182,19 @@ export namespace IOConnectWorkspaces {
         allowSystemHibernation?: boolean;
     }
 
+    /**
+     * Settings for showing a previously hidden Workspaces Frame instance.
+     */
+    export interface FrameShowConfig {
+
+        /**
+         * If `true`, the Workspaces Frame instance will be activated. This means that the Workspaces Frame window will gain focus,
+         * will be restored to its normal state (e.g., if it has been previously minimized), and will be brought in front of other existing windows.
+         * @default false
+         */
+        activate?: boolean;
+    }
+
     /** An object containing the bounds of a frame */
     export interface FrameBounds {
         top: number;
@@ -190,6 +205,7 @@ export namespace IOConnectWorkspaces {
 
     /** An object describing the possible settings when defining a new frame. */
     export interface NewFrameConfig {
+
         /** An object describing the possible settings when defining a new frame. */
         bounds?: {
             top?: number;
@@ -197,6 +213,15 @@ export namespace IOConnectWorkspaces {
             width?: number;
             height?: number;
         };
+
+        /**
+         * If `true`, the newly created Workspaces Frame instance will be visible.
+         * *Available only in **io.Connect Desktop**.*
+         * @since io.Connect Desktop 9.9.5
+         * @default true
+         */
+        isVisible?: boolean;
+
         /** A string which will be used as an id of the new frame. The call will reject if a frame with id already exists */
         frameId?: string;
     }
@@ -231,12 +256,12 @@ export namespace IOConnectWorkspaces {
      * @since io.Connect Desktop 9.9
      */
     export interface FrameCloseOptions {
-        /** 
-         * If `true`, will allow preventing the operation for closing the Frame. 
+        /**
+         * If `true`, will allow preventing the operation for closing the Frame.
          */
         allowPrevent?: boolean;
-        /** 
-         * If `true`, will show a dialog for the user to confirm or cancel closing the Frame. 
+        /**
+         * If `true`, will show a dialog for the user to confirm or cancel closing the Frame.
          */
         showDialog?: boolean;
     }
@@ -662,9 +687,10 @@ export namespace IOConnectWorkspaces {
 
     export interface FrameTargetingOptions {
         /**
-         * If `true`, the frame will be activated when the operation is executed.
-         * *Available only in **io.Connect Desktop**.*
+         * If `true`, the targeted Workspaces Frame instance will be activated. This means that the Workspaces Frame window will gain focus,
+         * will be restored to its normal state (e.g., if it has been previously minimized), and will be brought in front of other existing windows.
          * Defaults to the configuration passed in the `workspaces.json` file or to `false`.
+         * *Available only in **io.Connect Desktop**.*
          */
         activate?: boolean;
 
@@ -900,7 +926,7 @@ export namespace IOConnectWorkspaces {
         init(config: FrameInitializationConfig): Promise<void>;
 
         /**
-        * Retrieves the taskbar icon of the `Frame` instance. 
+        * Retrieves the taskbar icon of the `Frame` instance.
         * *Available only for **io.Connect Desktop**.*
         * @since io.Connect Desktop 9.9
         */
@@ -929,6 +955,27 @@ export namespace IOConnectWorkspaces {
         */
         getConstraints(): Promise<FrameConstraints>;
 
+        /**
+         * Retrieves the current visibility state of the Workspaces Frame instance.
+         * *Available only in **io.Connect Desktop**.*
+         * @since io.Connect Desktop 9.9.5
+         */
+        isVisible(): Promise<boolean>;
+
+        /**
+         * Shows the Workspaces Frame instance if it has been previously hidden.
+         * *Available only in **io.Connect Desktop**.*
+         * @since io.Connect Desktop 9.9.5
+         */
+        show(config?: FrameShowConfig): Promise<void>;
+
+        /**
+         * Hides the Workspaces Frame instance if it's currently visible.
+         * *Available only in **io.Connect Desktop**.*
+         * @since io.Connect Desktop 9.9.5
+         */
+        hide(): Promise<void>;
+
         /**
          * Opens a new workspace in this frame by restoring a previously saved workspace layout.
          * @param name The name of a saved workspace layout, which will be restored.
@@ -943,11 +990,11 @@ export namespace IOConnectWorkspaces {
          */
         createWorkspace(definition: WorkspaceDefinition, config?: WorkspaceCreateConfig): Promise<Workspace>;
 
-        /** 
+        /**
          * Notifies when the Frame is about to be closed.
-         * *Available only for io.Connect Desktop.* 
-         * @param callback Callback function for handling the event. Receives as an argument an object with options for closing the Frame. 
-         * @since io.Connect Desktop 9.9 
+         * *Available only for io.Connect Desktop.*
+         * @param callback Callback function for handling the event. Receives as an argument an object with options for closing the Frame.
+         * @since io.Connect Desktop 9.9
          */
         onClosing(callback: (options: FrameClosingData) => void | Promise<void>): Promise<Unsubscribe>;