@interopio/workspaces-api 4.3.0 → 4.5.0-next.1

package/workspaces.d.ts

@@ -979,6 +979,16 @@ export namespace IOConnectWorkspaces {
         Global = "Global"
     }
 
+    /**
+     * Options for setting the on-top state of a Workspaces Frame.
+     */
+    export interface FrameSetOnTopOptions {
+        /**
+         * If `true`, the Frame will be set on top of other windows.
+         */
+        onTop: boolean;
+    }
+
     /**
      * Options for showing a dialog from the Workspaces Frame.
      */
@@ -1276,6 +1286,13 @@ export namespace IOConnectWorkspaces {
          */
         showDialog<T>(options: FrameDialogOptions): Promise<T>;
 
+        /**
+         * Sets the on-top state of the Frame.
+         * *Available only in **io.Connect Desktop**.*
+         * @param options Options for setting the on-top state.
+         */
+        setOnTop(options: FrameSetOnTopOptions): Promise<void>;
+
         /**
          * Notifies when the Frame is about to be closed.
          * *Available only in **io.Connect Desktop**.*
@@ -1465,6 +1482,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 {
 
@@ -1526,8 +1545,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.
@@ -1694,6 +1714,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.
@@ -2173,6 +2209,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 */
@@ -2263,6 +2307,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 {
@@ -2522,6 +2578,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.
@@ -2562,11 +2625,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;
     }
 }
-
-
-
-