@interopio/workspaces-api 3.5.7 → 4.0.1

package/workspaces.d.ts

@@ -7,15 +7,14 @@ export default WorkspacesFactory;
 /**
  * @docname Workspaces
  * @intro
- * The Workspaces API offers advanced window management functionalities. Using Workspaces, users are able to arrange multiple applications 
- * within the same visual window (called *Frame*). This arrangement can be performed programmatically or by dragging and dropping applications within the Frame. 
- * Users can also save Workspace Layouts and restore them within the same Frame or even in different Frames.
+ * The Workspaces API offers advanced window management functionalities. Using Workspaces, users are able to arrange multiple apps
+ * within the same visual window (called Frame or a Workspaces App). This arrangement can be performed programmatically or by dragging and dropping
+ * apps within the Frame. Users can also save Workspace Layouts and restore them within the same Frame or even in different Frames.
  *
- * The io.Connect Workspaces enable the users to compose a custom arrangement of applications by treating each application 
- * as an individual building block that can be added, removed, moved or resized within a Workspace. 
+ * The app windows in a Workspace are treated as individual building blocks that can be added, removed, moved, or resized within the Workspace.
  * The Frame can hold multiple Workspaces (as tabs) and can also be maximized, minimized or resized.
- * 
- * The Workspaces API is accessible through the `io.workspaces` object.
+ *
+ * The Workspaces API is accessible via the [`io.workspaces`](#API) object.
  */
 export namespace IOConnectWorkspaces {
 
@@ -50,7 +49,10 @@ export namespace IOConnectWorkspaces {
         /** The type of the workspace element. */
         type: "Workspace";
 
-        /** The name of the workspaces app with which the layout is associated (available only in **io.Connect Desktop**). */
+        /**
+         * The name of the workspaces app with which the layout is associated.
+         * *Available only in **io.Connect Desktop**.*
+         */
         application?: string;
 
         state: WorkspaceLayoutComponentState;
@@ -93,7 +95,7 @@ export namespace IOConnectWorkspaces {
     }
 
     export interface WindowLayoutItemConfig {
-        /** The name of the application as defined in **io.Connect Desktop**. */
+        /** The name of the application as specified in its definition. */
         appName: string;
         /** The id of the window */
         windowId?: string;
@@ -127,7 +129,10 @@ export namespace IOConnectWorkspaces {
         /** A string id of an existing frame. If provided, this workspace will be opened in that specific frame */
         frameId?: string;
 
-        /** The application name of the workspace app that should be used for the new frame (available only for **io.Connect Desktop**) */
+        /**
+         * The application name of the workspace app that should be used for the new frame.
+         * *Available only in **io.Connect Desktop**.*
+         */
         applicationName?: string;
 
         /** A setting used to declare that the workspace must be in a new frame and also provide options for that new frame */
@@ -162,7 +167,9 @@ export namespace IOConnectWorkspaces {
         positionIndex?: number;
 
         /**
-         * Controls the users ability to activate the Workspaces frame when the workspace is restored (available only for **io.Connect Desktop**). Defaults to the configuration passed in the workspaces.json or to false.
+         * Controls the users ability to activate the Workspaces frame when the workspace is restored.
+         * *Available only in **io.Connect Desktop**.*
+         * Defaults to the configuration passed in the `workspaces.json` file or to `false`.
          */
         activateFrame?: boolean;
 
@@ -220,6 +227,7 @@ export namespace IOConnectWorkspaces {
 
     /**
      * Options for closing a Frame.
+     * *Available only for **io.Connect Desktop**.*
      * @since io.Connect Desktop 9.9
      */
     export interface FrameCloseOptions {
@@ -240,7 +248,7 @@ export namespace IOConnectWorkspaces {
     }
 
     /**
-    * The loading strategy used to open new workspaces. 
+    * The loading strategy used to open new workspaces.
     * "direct" will cause all windows to start loading at the same time as soon as the workspace loads
     * "delayed" will cause all visible/active/selected windows to start loading at the same time as soon as the workspace loads. The rest will be loaded gradually at a specific interval.
     * "lazy" will cause all visible/active/selected windows to start loading at the same time as soon as the workspace loads. The rest will start loading when the user selects them and not before that.
@@ -276,7 +284,7 @@ export namespace IOConnectWorkspaces {
         /** Position of the workspace in relation to it's siblings in the frame. */
         position?: number;
 
-        /** 
+        /**
          * Provides the opportunity to open a workspace with no tab header
          * @default false
          */
@@ -300,79 +308,80 @@ export namespace IOConnectWorkspaces {
          */
         allowDropLeft?: boolean;
 
-        /** 
+        /**
          * Controls the users ability to drop windows in the top-most zone of the workspace
          * @default true
          */
         allowDropTop?: boolean;
 
-        /** 
+        /**
          * Controls the users ability to drop windows in the right-most zone of the workspace
          * @default true
          */
         allowDropRight?: boolean;
 
-        /** 
+        /**
          * Controls the users ability to drop windows in the bottom-most zone of the workspace
          * @default true
          */
         allowDropBottom?: boolean;
 
-        /** 
+        /**
          * Controls the users ability to extract windows from the workspace
          * @default true
          */
         allowExtract?: boolean;
 
-        /** 
+        /**
          * Control the users ability to reorder windows in the workspace
          * @default true
          */
         allowWindowReorder?: boolean;
 
-        /** 
+        /**
          * Controls the visibility of the save workspace button located in the workspace tab
          * @default true
          */
         showSaveButton?: boolean;
 
-        /** 
+        /**
          * Controls whether a workspace tab can be reordered in the frame
          * @default true
          */
         allowWorkspaceTabReorder?: boolean;
 
-        /** 
-         * Controls whether a workspace tab can be extracted from the frame (available only for **io.Connect Desktop**).
+        /**
+         * Controls whether a workspace tab can be extracted from the frame.
+         * *Available only in **io.Connect Desktop**.*
          * @default true
          */
         allowWorkspaceTabExtract?: boolean;
 
-        /** 
+        /**
          * Controls the visibility of the close button located in the workspaces tab
          * @default true
          */
         showCloseButton?: boolean;
 
-        /** 
+        /**
          * Prevents the splitters for being draggable, so the windows cannot be resized
          * @default true
          */
         allowSplitters?: boolean;
 
-        /** 
+        /**
          * Controls the visibility of all close button located in the windows' tab elements
          * @default true
          */
         showWindowCloseButtons?: boolean;
 
-        /** 
+        /**
          * Controls the visibility of all eject buttons located in the groups' headers
          * @default true
          */
         showEjectButtons?: boolean;
 
-        /** 
+        /**
          * Controls the visibility of all the add window buttons (the ones with the plus icon) located in the group headers
          * @default true
          */
@@ -401,7 +410,7 @@ export namespace IOConnectWorkspaces {
         positionIndex?: number;
 
         /**
-         * Mode for dragging the windows that are part of the Workspace. If set to `"autoEject"` (available only for **io.Connect Desktop**), when the user drags a Workspace window, it will be ejected from the Workspace during the dragging operation and the user will be able to drop it back inside the Workspace, or out of the Workspace.
+         * Mode for dragging the windows that are part of the Workspace. If set to `"autoEject"` (available only in **io.Connect Desktop**), when the user drags a Workspace window, it will be ejected from the Workspace during the dragging operation and the user will be able to drop it back inside the Workspace, or out of the Workspace.
          * If set to `"keepInside"`, the window won't be ejected from the Workspace when being dragged and the user will be able to drop it only inside the Workspace.
          */
         windowDragMode?: "keepInside" | "autoEject";
@@ -449,7 +458,10 @@ export namespace IOConnectWorkspaces {
         /** Controls the whether the workspace tab can be reordered */
         allowWorkspaceTabReorder?: boolean;
 
-        /** Controls the whether the workspace tab can be extracted (available only for **io.Connect Desktop**). */
+        /**
+         * Controls the whether the workspace tab can be extracted.
+         * *Available only in **io.Connect Desktop**.*
+         */
         allowWorkspaceTabExtract?: boolean;
 
         /** Controls the visibility of all the add window buttons (the ones with the plus icon) located in the group headers */
@@ -649,13 +661,20 @@ export namespace IOConnectWorkspaces {
     }
 
     export interface FrameTargetingOptions {
-        /** If true the frame will be activated when the operation is executed (available only for **io.Connect Desktop**). Defaults to the configuration passed in the workspaces.json or to false. */
+        /**
+         * If `true`, the frame will be activated when the operation is executed.
+         * *Available only in **io.Connect Desktop**.*
+         * Defaults to the configuration passed in the `workspaces.json` file or to `false`.
+         */
         activate?: boolean;
 
         /** A string id of an existing frame. If provided, this workspace will be opened in that specific frame */
         reuseFrameId?: string;
 
-        /** The application name of the workspace app that should be used for the new frame (available only for **io.Connect Desktop**). */
+        /**
+         * The application name of the workspace app that should be used for the new frame.
+         * *Available only in **io.Connect Desktop**.*
+         */
         applicationName?: string;
 
         /** A setting used to declare that the workspace must be in a new frame and also provide options for that new frame */
@@ -755,15 +774,21 @@ export namespace IOConnectWorkspaces {
         /** An unique string name and identifier of the layout */
         name: string;
 
-        /** The name of the workspaces app with which the layout is associated (available only in **io.Connect Desktop**). */
+        /**
+         * The name of the workspaces app with which the layout is associated.
+         * *Available only in **io.Connect Desktop**.*
+         */
         applicationName?: string;
     }
 
     export interface EmptyFrameDefinition {
-        /** The application name of the workspace app that should be used for the new frame (available only for **io.Connect Desktop**). */
+        /**
+         * The application name of the workspace app that should be used for the new frame.
+         * *Available only in **io.Connect Desktop**.*
+         */
         applicationName?: string;
 
-        /**      
+        /**
          * Optional frame related settings
          */
         frameConfig?: IOConnectWorkspaces.NewFrameConfig;
@@ -773,7 +798,7 @@ export namespace IOConnectWorkspaces {
          */
         context?: object;
 
-        /**      
+        /**
          * Optional the id of the layout component which is being restored
          */
         layoutComponentId?: string;
@@ -802,59 +827,70 @@ export namespace IOConnectWorkspaces {
         isInitialized: boolean;
     }
 
-    /** An object describing a frame */
+    /**
+     * Describes a Frame (a Workspaces App instance).
+     */
     export interface Frame extends FrameSummary {
         /**
-         * Registers keyboard shortcut to the current frame (available only in **io.Connect Desktop**).
+         * Registers a keyboard shortcut for the current Frame.
+         * @param shortcut Keyboard combination to register as a shortcut for the Frame (e.g., "ctrl+w").
+         * @param callback Callback that will be invoked when the Frame for which the shortcut is registered
+         * is on focus and the user presses the registered keyboard combination.
+         * *Available only in **io.Connect Desktop**.*
          */
         registerShortcut(shortcut: string, callback: () => void): Promise<Unsubscribe>;
 
         /**
-         * Retrieves the current bounds of the frame.
+         * Retrieves the current bounds of the Frame.
          */
         getBounds(): Promise<FrameBounds>;
 
         /**
-         * Changes the size of this frame.
-         * @param config An object defining the resize parameters.
+         * Resizes the Frame.
+         * @param config Options for resizing the Frame.
          */
         resize(config: ResizeConfig): Promise<void>;
 
         /**
-         * Changes the position of this frame.
-         * @param config An object defining the position parameters.
+         * Moves the Frame.
+         * @param config Options for moving the Frame.
          */
         move(config: MoveConfig): Promise<void>;
 
         /**
-         * Focuses this frame.
+         * Focuses the Frame.
          */
         focus(): Promise<void>;
 
         /**
-         * Returns the current state of the frame.
-         * Not available in **io.Connect Browser**.
+         * Returns the current state of the Frame.
+         * *Available only in **io.Connect Desktop**.*
          */
         state(): Promise<FrameState>;
 
         /**
-         * Minimizes this frame.
-         * Not available in **io.Connect Browser**.
+         * Minimizes the Frame.
+         * *Available only in **io.Connect Desktop**.*
          */
         minimize(): Promise<void>;
 
         /**
-         * Maximizes this frame.
-         * Not available in **io.Connect Browser**.
+         * Maximizes the Frame.
+         * *Available only in **io.Connect Desktop**.*
          */
         maximize(): Promise<void>;
 
         /**
-         * Restores this frame.
-         * Not available in **io.Connect Browser**.
+         * Restores the Frame.
+         * *Available only in **io.Connect Desktop**.*
          */
         restore(): Promise<void>;
 
+        /**
+         * Closes the Frame.
+         * The result from using this method in **io.Connect Browser** projects may vary depending on whether the browser will allow the closing operation.
+         * @param options Options for closing the Frame.
+         */
         close(options?: FrameCloseOptions): Promise<void>;
 
         /**
@@ -864,15 +900,17 @@ export namespace IOConnectWorkspaces {
         init(config: FrameInitializationConfig): Promise<void>;
 
         /**
-        * Returns the taskbar icon of the frame 
-        * Not available in **io.Connect Browser**.
+        * Retrieves the taskbar icon of the `Frame` instance. 
+        * *Available only for **io.Connect Desktop**.*
+        * @since io.Connect Desktop 9.9
         */
         getIcon(): Promise<Icon>;
 
         /**
-         * Updates the taskbar icon of the frame
-         * Not available in **io.Connect Browser**.
-         * @param icon An object describing the new icon.
+         * Sets the taskbar icon of the `Frame` instance.
+         * *Available only for **io.Connect Desktop**.*
+         * @param icon New icon to be displayed in the taskbar for the `Frame` instance. The icon must be encoded as a Base64 string.
+         * @since io.Connect Desktop 9.9
          */
         setIcon(icon: Icon): Promise<void>;
 
@@ -941,7 +979,8 @@ export namespace IOConnectWorkspaces {
         onNormal(callback: () => void): Promise<Unsubscribe>;
 
         /**
-         * Triggered when either a window in the frame is focused or the frame itself (supported only in **io.Connect Desktop**).
+         * Triggered when either a window in the frame is focused or the frame itself.
+         * *Available only in **io.Connect Desktop**.*
          * @param callback Callback function to handle the event. It receives a data oject which indicates how the focus has changed.
          */
         onFocusChanged(callback: (data: FrameFocusChangedData) => void): Promise<IOConnectWorkspaces.Unsubscribe>;
@@ -1044,7 +1083,10 @@ export namespace IOConnectWorkspaces {
         /** Indicates if the save button for this workspace is visible to the user */
         showSaveButton?: boolean;
 
-        /** Controls whether the workspace tab can be extracted (available only for **io.Connect Desktop**) */
+        /**
+         * Controls whether the workspace tab can be extracted.
+         * *Available only in **io.Connect Desktop**.*
+         */
         allowWorkspaceTabExtract?: boolean;
 
         /** Controls whether the workspace tab can be reordered*/
@@ -1079,7 +1121,7 @@ export namespace IOConnectWorkspaces {
 
         /**
          * Indicates the loading strategy for the Workspace.
-         * *Available only for **io.Connect Desktop**.*
+         * *Available only in **io.Connect Desktop**.*
          */
         loadingStrategy?: LoadingStrategy;
 
@@ -1144,7 +1186,7 @@ export namespace IOConnectWorkspaces {
         onContextUpdated(callback: (data: any) => void): Promise<Unsubscribe>;
 
         /**
-         * Updates this workspace reference to reflect the current state of the workspace. 
+         * Updates this workspace reference to reflect the current state of the workspace.
          */
         refreshReference(): Promise<void>;
 
@@ -1277,7 +1319,8 @@ export namespace IOConnectWorkspaces {
         lock(config?: WorkspaceLockConfig | ((config: WorkspaceLockConfig) => WorkspaceLockConfig)): Promise<void>;
 
         /**
-         * Sets the mode for dragging the windows that are part of the Workspace. *Available only for **io.Connect Desktop**.*
+         * Sets the mode for dragging the windows that are part of the Workspace.
+         * *Available only in **io.Connect Desktop**.*
          * @param mode Mode for dragging the Workspace windows. If set to `"autoEject"`, when the user drags a Workspace window, it will be ejected from the Workspace during the dragging operation and the user will be able to drop it back inside the Workspace, or out of the Workspace.
          * If set to `"keepInside"`, the window won't be ejected from the Workspace when being dragged and the user will be able to drop it only inside the Workspace.
          */
@@ -1288,7 +1331,8 @@ export namespace IOConnectWorkspaces {
          * This will override the current loading strategy for the Workspace that may have been specified via configuration or programmatically
          * when creating or restoring the Workspace. The loading strategy specified via this method will be preserved in the Workspace Layout
          * only if the Workspace is saved afterwards and the `"persistCurrentStrategy"` flag is set to `true` in the Workspaces App definition.
-         * *Available only for **io.Connect Desktop**.*
+         * *Available only in **io.Connect Desktop**.*
+         * @since io.Connect Desktop 9.8
          * @param strategy Loading strategy for the Workspace.
          */
         setLoadingStrategy(strategy: LoadingStrategy): Promise<void>;
@@ -1337,7 +1381,7 @@ export namespace IOConnectWorkspaces {
          * @param callback Callback function to handle the event. Receives the loaded window as a parameter.
          */
         onWindowLoaded(callback: (window: WorkspaceWindow) => void): Promise<Unsubscribe>;
-        /** 
+        /**
                 * Notifies when a window was maximized in this workspace and returns an unsubscribe function.
                 * A maximized window means that the window has been maximized either by an API call or from the maximize button by the user.
                 * @param callback Callback function to handle the event. Receives the maximized window as a parameter.
@@ -1363,7 +1407,7 @@ export namespace IOConnectWorkspaces {
         isPinned?: boolean;
 
         /**
-         * Mode for dragging the windows that are part of the Workspace. If set to `"autoEject"` (available only for **io.Connect Desktop**), when the user drags a Workspace window, it will be ejected from the Workspace during the dragging operation and the user will be able to drop it back inside the Workspace, or out of the Workspace.
+         * Mode for dragging the windows that are part of the Workspace. If set to `"autoEject"` (available only in **io.Connect Desktop**), when the user drags a Workspace window, it will be ejected from the Workspace during the dragging operation and the user will be able to drop it back inside the Workspace, or out of the Workspace.
          * If set to `"keepInside"`, the window won't be ejected from the Workspace when being dragged and the user will be able to drop it only inside the Workspace.
          */
         windowDragMode?: "keepInside" | "autoEject";
@@ -1391,17 +1435,19 @@ export namespace IOConnectWorkspaces {
 
         /**
          * Changes the workspace icon to the specified one
-         * @param icon 
+         * @param icon
          */
         setIcon(icon: string): Promise<void>;
 
         /**
-         * Shows the loading animation of the workspace (supported only in **io.Connect Desktop**).
+         * Shows the loading animation of the workspace.
+         * *Available only in **io.Connect Desktop**.*
          */
         showLoadingAnimation(): Promise<void>;
 
         /**
-         * Hides the loading animation of the workspace (supported only in **io.Connect Desktop**).
+         * Hides the loading animation of the workspace.
+         * *Available only in **io.Connect Desktop**.*
          */
         hideLoadingAnimation(): Promise<void>;
     }
@@ -1864,7 +1910,7 @@ export namespace IOConnectWorkspaces {
     /** A configuration object used to save a current workspace as a layout */
     export interface WorkspaceLayoutSaveConfig {
         /**
-         * A string used as name (doubles as id) of the layout, which is later used when restoring it. 
+         * A string used as name (doubles as id) of the layout, which is later used when restoring it.
          */
         name: string;
 
@@ -1930,8 +1976,13 @@ export namespace IOConnectWorkspaces {
         frameBounds?: FrameBounds;
     }
 
-    /** An object describing the complete state of a toolbar icon at the time when the icon was created */
+    /**
+     * Describes the taskbar icon of a `Frame` instance.
+     */
     export interface Icon {
+        /**
+         * Icon encoded as a Base64 string.
+         */
         base64Image: string;
     }
 
@@ -2041,7 +2092,7 @@ export namespace IOConnectWorkspaces {
 
         /**
          * Returns an instance of the workspace with the passed id. The performance is better than getWorkspace when querying for a workspace by id.
-         * @param workspaceId The id of the desired workspace 
+         * @param workspaceId The id of the desired workspace
          */
         getWorkspaceById(workspaceId: string): Promise<Workspace>;
 
@@ -2080,13 +2131,13 @@ export namespace IOConnectWorkspaces {
         createWorkspace(definition: WorkspaceDefinition, saveConfig?: WorkspaceCreateConfig): Promise<Workspace>;
 
         /**
-         * 
+         *
          * @param definition Optional definition of the frame
          */
         createEmptyFrame(definition?: EmptyFrameDefinition): Promise<IOConnectWorkspaces.Frame>;
 
         /**
-         * Wait for a frame with the specified id to be loaded. 
+         * Wait for a frame with the specified id to be loaded.
          * It's needed when using the workspaces-api from a custom workspaces frame and you have the frameId,
          * but the frame object is not populated in the API yet (e.g. the frame is in the pool)
          * @param id the id of the frame that should be waited