@interopio/workspaces-api 4.2.8-next.0 → 4.4.0

package/workspaces.d.ts

@@ -748,18 +748,30 @@ export namespace IOConnectWorkspaces {
         icon?: string;
     }
 
-    /** An object describing the possible options when defining a new workspace */
+    /**
+     * Describes a Workspace to be created.
+     */
     export interface WorkspaceDefinition {
-        /** An array of all the workspace's children which will also be opened. */
+
+        /**
+         * Array of objects describing the Workspace windows and box elements (rows, columns, groups) that the Workspace will contain.
+         */
         children?: Array<WorkspaceWindowDefinition | BoxDefinition>;
 
-        /** An object which will be set as the window context of all windows inside this workspace. */
+        /**
+         * Context object for the Workspace. Can contain any data relevant to the Workspace
+         * which the Workspace or the apps loaded in it can use after the Workspace has been created.
+         */
         context?: any;
 
-        /** Workspace-specific options. */
+        /**
+         * Configuration for the new Workspace.
+         */
         config?: WorkspaceConfig;
 
-        /** Options regarding the frame where this workspace will be opened in. */
+        /**
+         * Options for targeting a Workspaces App instance that will host the newly created Workspace.
+         */
         frame?: FrameTargetingOptions;
     }
 
@@ -1453,6 +1465,8 @@ export namespace IOConnectWorkspaces {
         allowSystemHibernation?: boolean;
     }
 
+    export type SaveLayoutConfig = Omit<Omit<IOConnectWorkspaces.WorkspaceLayoutSaveConfig, "name">, "workspaceId">;
+
     /** An object describing a workspace */
     export interface Workspace extends WorkspaceSummary {
 
@@ -1514,8 +1528,9 @@ export namespace IOConnectWorkspaces {
         /**
          * Saves the current workspace structure as a layout. In **io.Connect Browser** this will throw an error if the name matches the name of a read-only layout.
          * @param name A string representing the name (also ID) of the new workspace layout.
+         * @param config An optional object used to set various options for saving the workspace layout.
          */
-        saveLayout(name: string, config?: { saveContext?: boolean, allowMultiple?: boolean }): Promise<void>;
+        saveLayout(name: string, config?: SaveLayoutConfig): Promise<void>;
 
         /**
          * Returns the first box in this workspace, which satisfies the provided predicate.
@@ -1682,6 +1697,22 @@ export namespace IOConnectWorkspaces {
          */
         onResumed(callback: () => void): Promise<IOConnectWorkspaces.Unsubscribe>;
 
+       /**
+        * Notifies when the Workspace tab has been reordered. Returns an unsubscribe function.
+        * @param callback Callback function for handling the event.
+        * *Available only in **io.Connect Browser**.*
+        * @since io.Connect Browser 4.4
+        */
+        onTabReordered(callback: () => void): Promise<IOConnectWorkspaces.Unsubscribe>;
+
+        /**
+         * Notifies when the tab of a window participating in the Workspace has been reordered. Returns an unsubscribe function.
+         * @param callback Callback function for handling the event. Receives as an argument the `WorkspaceWindow` object describing the window whose tab has been reordered.
+         * *Available only in **io.Connect Browser**.*
+         * @since io.Connect Browser 4.4
+         */
+        onWindowTabReordered(callback: (window: WorkspaceWindow) => void): Promise<IOConnectWorkspaces.Unsubscribe>;
+
         /**
          * Notifies when a new window was added to this workspace and returns an unsubscribe function.
          * An added window means that the window has a place in the workspace (it is a valid workspace element), but does not guarantee that the contents of the window are loaded.
@@ -2161,6 +2192,14 @@ export namespace IOConnectWorkspaces {
          * @param callback Callback function to handle the event. Receives the new lock configuration as a parameter
          */
         onLockConfigurationChanged(callback: (config: IOConnectWorkspaces.WorkspaceWindowLockConfig) => void): Promise<IOConnectWorkspaces.Unsubscribe>
+
+        /**
+         * Notifies when the tab of the Workspace window has been reordered. Returns an unsubscribe function.
+         * @param callback Callback function for handling the event.
+         * *Available only in **io.Connect Browser**.*
+         * @since io.Connect Browser 4.4
+         */
+        onTabReordered(callback: () => void): Promise<IOConnectWorkspaces.Unsubscribe>;
     }
 
     /** An object describing a builder user to create workspaces */
@@ -2251,6 +2290,18 @@ export namespace IOConnectWorkspaces {
 
         /** Object which will be saved as part of the layout */
         metadata?: object;
+
+        /**
+         * If `true`, the context objects of individual io.Connect Windows set via the `setContext()` method of a `WebWindow` instance
+         * will be saved when the Workspace Layout is saved. This is valid both for Browser Client apps, as well as for windows that have been
+         * opened by the Main app or by a Browser Client, but aren't Browser Clients themselves (i.e., don't use the io.Connect libraries).
+         * If a Browser Client has subscribed for the `onSaveRequested()` event and its context has also been set via the `setContext()` method,
+         * the context returned by the `onSaveRequested()` event handler will take precedence.
+         * *Available only in **io.Connect Browser**.*
+         * @default false
+         * @since io.Connect Browser 4.4
+         */
+        saveWindowContexts?: boolean;
     }
 
     export interface SetMaximizationBoundaryConfig {
@@ -2510,6 +2561,13 @@ export namespace IOConnectWorkspaces {
          */
         onWorkspaceResumed(callback: (workspace: IOConnectWorkspaces.Workspace) => void): Promise<IOConnectWorkspaces.Unsubscribe>;
 
+        /**
+         * Notifies when the tab of any Workspace in any Workspaces App has been reordered. Returns an unsubscribe function.
+         * @param callback Callback function for handling the event. Receives as an argument the `Workspace` object describing the Workspace whose tab has been reordered.
+         * *Available only in **io.Connect Browser**.*
+         * @since io.Connect Browser 4.4
+         */
+        onWorkspaceTabReordered(callback: (workspace: IOConnectWorkspaces.Workspace) => void): Promise<IOConnectWorkspaces.Unsubscribe>;
         /**
          * Notifies when a new window was added to any workspace in any frame and returns an unsubscribe function.
          * An added window means that the window has a place in a workspace (it is a valid workspace element), but does not guarantee that the contents of the window are loaded.
@@ -2550,11 +2608,15 @@ export namespace IOConnectWorkspaces {
          */
         onWindowSelected(callback: (workspaceWindow: IOConnectWorkspaces.WorkspaceWindow) => void): Promise<IOConnectWorkspaces.Unsubscribe>;
 
+        /**
+         * Notifies when the tab of a Workspace window participating in any Workspace in any Workspaces App has been reordered. Returns an unsubscribe function.
+         * @param callback Callback function for handling the event. Receives as an argument the `WorkspaceWindow` object describing the Workspace window whose tab has been reordered.
+         * *Available only in **io.Connect Browser**.*
+         * @since io.Connect Browser 4.4
+         */
+        onWindowTabReordered(callback: (workspaceWindow: IOConnectWorkspaces.WorkspaceWindow) => void): Promise<IOConnectWorkspaces.Unsubscribe>;
+
         /** The io.Connect Workspaces API version. */
         version: string;
     }
 }
-
-
-
-