@interopio/workspaces-api 3.0.2 → 3.0.4

package/workspaces.d.ts

@@ -5,14 +5,13 @@ declare const WorkspacesFactory: WorkspacesFactoryFunction;
 export default WorkspacesFactory;
 
 /**
- * @docmenuorder 1
- * @docName Workspaces
+ * @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 IO Connect Workspaces enable the users to compose a custom arrangement of applications by treating each application 
+ * 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 Frame can hold multiple Workspaces (as tabs) and can also be maximized, minimized or resized.
  * 
@@ -51,7 +50,7 @@ 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;
@@ -94,7 +93,7 @@ export namespace IOConnectWorkspaces {
     }
 
     export interface WindowLayoutItemConfig {
-        /** The name of the application as defined in IO Connect Desktop */
+        /** The name of the application as defined in **io.Connect Desktop**. */
         appName: string;
         /** The id of the window */
         windowId?: string;
@@ -128,7 +127,7 @@ 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 for **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 */
@@ -284,7 +283,7 @@ export namespace IOConnectWorkspaces {
         /** Controls whether a workspace tab can be reordered in the frame */
         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 for **io.Connect Desktop**). */
         allowWorkspaceTabExtract?: boolean;
 
         /** Controls the visibility of the close button located in the workspaces tab */
@@ -358,7 +357,7 @@ 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 for **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 */
@@ -555,7 +554,7 @@ export namespace IOConnectWorkspaces {
         /** 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 for **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 */
@@ -655,12 +654,12 @@ 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 for **io.Connect Desktop**). */
         applicationName?: string;
 
         /**      
@@ -705,11 +704,7 @@ export namespace IOConnectWorkspaces {
     /** An object describing a frame */
     export interface Frame extends FrameSummary {
         /**
-         * An API which gives full read, write and delete access to the workspaces layouts.
-         */
-
-        /**
-         * Registers keyboard shortcut to the current frame (available only in IO Connect Desktop).
+         * Registers keyboard shortcut to the current frame (available only in **io.Connect Desktop**).
          */
         registerShortcut(shortcut: string, callback: () => void): Promise<Unsubscribe>;
 
@@ -737,25 +732,25 @@ export namespace IOConnectWorkspaces {
 
         /**
          * Returns the current state of the frame.
-         * Not available in IO Connect Browser
+         * Not available in **io.Connect Browser**.
          */
         state(): Promise<FrameState>;
 
         /**
          * Minimizes this frame.
-         * Not available in IO Connect Browser
+         * Not available in **io.Connect Browser**.
          */
         minimize(): Promise<void>;
 
         /**
          * Maximizes this frame.
-         * Not available in IO Connect Browser
+         * Not available in **io.Connect Browser**.
          */
         maximize(): Promise<void>;
 
         /**
          * Restores this frame.
-         * Not available in IO Connect Browser
+         * Not available in **io.Connect Browser**.
          */
         restore(): Promise<void>;
 
@@ -807,27 +802,27 @@ export namespace IOConnectWorkspaces {
 
         /**
          * Notifies when this frame is maximized.
-         * This event is not supported in IO Connect Browser.
+         * This event is not supported in **io.Connect Browser**.
          * @param callback Callback function to handle the event.
          */
         onMaximized(callback: () => void): Promise<Unsubscribe>;
 
         /**
          * Notifies when this frame is closed.
-         * This event is not supported in IO Connect Browser.
+         * This event is not supported in **io.Connect Browser**.
          * @param callback Callback function to handle the event.
          */
         onMinimized(callback: () => void): Promise<Unsubscribe>;
 
         /**
          * Notifies when this frame is closed.
-         * This event is not supported in IO Connect Browser.
+         * This event is not supported in **io.Connect Browser**.
          * @param callback Callback function to handle the event.
          */
         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 (supported 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>;
@@ -897,7 +892,7 @@ export namespace IOConnectWorkspaces {
         /** Indicates if the workspace is hibernated */
         isHibernated?: boolean;
 
-        /** Indicates if the workspace is selected in its frame. Can be undefined if using with an older version of IO Connect Desktop or Browser */
+        /** Indicates if the workspace is selected in its frame. Can be undefined if using with an older version of **io.Connect Desktop** or **io.Connect Browser**. */
         isSelected?: boolean;
 
         /** Indicates if dragging of splitters is allowed in the workspace */
@@ -930,7 +925,7 @@ 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 for **io.Connect Desktop**) */
         allowWorkspaceTabExtract?: boolean;
 
         /** Controls whether the workspace tab can be reordered*/
@@ -1023,7 +1018,7 @@ export namespace IOConnectWorkspaces {
         refreshReference(): Promise<void>;
 
         /**
-         * 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.
+         * 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.
          */
         saveLayout(name: string, config?: { saveContext?: boolean }): Promise<void>;
@@ -1171,7 +1166,7 @@ export namespace IOConnectWorkspaces {
 
         /**
          * Notifies when a window was removed from this workspace and returns an unsubscribe function.
-         * Not supported in IO Connect Browser
+         * Not supported in **io.Connect Browser**.
          * @param callback Callback function to handle the event. Receives an object containing the ids of the removed window, and the respective workspace and frame as a parameter.
          */
         onWindowRemoved(callback: (removed: { windowId?: string; workspaceId: string; frameId: string }) => void): Promise<Unsubscribe>;
@@ -1235,12 +1230,12 @@ export namespace IOConnectWorkspaces {
         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 (supported 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 (supported only in **io.Connect Desktop**).
          */
         hideLoadingAnimation(): Promise<void>;
     }
@@ -1605,7 +1600,7 @@ export namespace IOConnectWorkspaces {
         getGdWindow(): any;
 
         /**
-         * Moves the workspace window to a new box. In IO Connect Browser this box must be part of the same frame.
+         * Moves the workspace window to a new box. In **io.Connect Browser** this box must be part of the same frame.
          * @param box An object describing the new box of the window.
          */
         moveTo(box: WorkspaceBox): Promise<void>;
@@ -1770,7 +1765,7 @@ export namespace IOConnectWorkspaces {
         getSummaries(): Promise<WorkspaceLayoutSummary[]>;
 
         /**
-         * Deletes a previously saved layout. In IO Connect Browser delete will fail with an error in trying to delete a read-only layout, this is a layout defined in the io.layouts.json file.
+         * Deletes a previously saved layout. In **io.Connect Browser** delete will fail with an error in trying to delete a read-only layout, this is a layout defined in the io.layouts.json file.
          * @param name The name of the layout to delete.
          */
         delete(name: string): Promise<void>;
@@ -1782,7 +1777,7 @@ export namespace IOConnectWorkspaces {
         export(predicate?: (layout: WorkspaceLayout) => boolean): Promise<WorkspaceLayout[]>;
 
         /**
-         * Saves the provided layouts into IO Connect. In IO Connect Browser this will fail with an error if a provided layout's name matches a read-only layout.
+         * Saves the provided layouts into io.Connect. In **io.Connect Browser** this will fail with an error if a provided layout's name matches a read-only layout.
          * @param layouts A collection of layouts to add to IO Connet.
          */
         import(layouts: WorkspaceLayout[], mode?: "replace" | "merge"): Promise<void>;
@@ -1980,7 +1975,7 @@ export namespace IOConnectWorkspaces {
          */
         onWindowSelected(callback: (workspaceWindow: IOConnectWorkspaces.WorkspaceWindow) => void): Promise<IOConnectWorkspaces.Unsubscribe>;
 
-        /** IO Connect Workspaces API version. */
+        /** The io.Connect Workspaces API version. */
         version: string;
     }
 }