@interopio/workspaces-api 5.0.0-next.0 → 5.0.0

package/workspaces.d.ts

@@ -488,20 +488,67 @@ export namespace IOConnectWorkspaces {
          */
         allowSystemHibernation?: boolean;
 
+        /**
+         * Restrictions for dropping apps in the Workspace and allowing apps to appear in the "Add Apps" popup menu of the Workspace.
+         * @since io.Connect Desktop 10.5
+         * @since io.Connect Browser 4.6
+         * @since @interopio/workspaces-api 5.0.0
+         */
         appRestrictions?: AppRestrictions | undefined;
     }
 
+    /**
+     * Describes the default restrictions for dropping apps in a Workspace and allowing apps to appear in the "Add Apps" popup menu of a Workspace.
+     * @since io.Connect Desktop 10.5
+     * @since io.Connect Browser 4.6
+     * @since @interopio/workspaces-api 5.0.0
+     */
     export interface AppRestrictionRule {
+
+        /**
+         * If `true`, will allow an app to appear in the "Add Apps" popup menu of a Workspace.
+         */
         allowInApplicationPopup?: boolean;
+
+        /**
+         * If `true`, will allow an app to be dropped in a Workspace.
+         * *Available only in **io.Connect Desktop**.*
+         */
         allowDrop?: boolean;
     }
 
+    /**
+     * Describes the restrictions for dropping a specific app in a Workspace and allowing it to appear in the "Add Apps" popup menu of a Workspace.
+     * @since io.Connect Desktop 10.5
+     * @since io.Connect Browser 4.6
+     * @since @interopio/workspaces-api 5.0.0
+     */
     export interface AppRestrictionEntry extends AppRestrictionRule {
+
+        /**
+         * Name of the app, as defined within the io.Connect framework, for which to apply the specified restrictions.
+         */
         appName: string;
     }
 
+    /**
+     * Describes the restrictions for dropping apps in a Workspace and allowing apps to appear in the "Add Apps" popup menu of a Workspace.
+     * @since io.Connect Desktop 10.5
+     * @since io.Connect Browser 4.6
+     * @since @interopio/workspaces-api 5.0.0
+     */
     export interface AppRestrictions {
+
+        /**
+         * Array of objects describing the restrictions related to specific apps.
+         * The restrictions specified here will override the default restrictions specified via the `default` property.
+         */
         apps?: AppRestrictionEntry[];
+
+        /**
+         * Default restrictions that will be applied to all apps.
+         * The restrictions specified here can be overridden per app via the `apps` array.
+         */
         default?: AppRestrictionRule;
     }
 
@@ -1523,6 +1570,12 @@ export namespace IOConnectWorkspaces {
          */
         allowSystemHibernation?: boolean;
 
+        /**
+         * Restrictions for dropping apps in the Workspace and allowing apps to appear in the "Add Apps" popup menu of the Workspace.
+         * @since io.Connect Desktop 10.5
+         * @since io.Connect Browser 4.6
+         * @since @interopio/workspaces-api 5.0.0
+         */
         appRestrictions?: AppRestrictions;
     }
 
@@ -1597,7 +1650,7 @@ export namespace IOConnectWorkspaces {
          * Returns the first box in this workspace, which satisfies the provided predicate.
          * @param predicate A filtering function (predicate) called for each box present in this workspace.
          */
-        getBox(predicate: (box: WorkspaceBox) => boolean): WorkspaceBox;
+        getBox(predicate: (box: WorkspaceBox) => boolean): WorkspaceBox | undefined;
 
         /**
          * Returns all boxes in this workspace, which satisfy the provided predicate. If no predicate was provided, will return all boxes.
@@ -1609,7 +1662,7 @@ export namespace IOConnectWorkspaces {
          * Returns the first row in this workspace, which satisfies the provided predicate.
          * @param predicate A filtering function (predicate) called for each row present in this workspace.
          */
-        getRow(predicate: (row: Row) => boolean): Row;
+        getRow(predicate: (row: Row) => boolean): Row | undefined;
 
         /**
          * Returns all rows in this workspace, which satisfy the provided predicate. If no predicate was provided, will return all rows.
@@ -1621,7 +1674,7 @@ export namespace IOConnectWorkspaces {
          * Returns the first column in this workspace, which satisfies the provided predicate.
          * @param predicate A filtering function (predicate) called for each column present in this workspace.
          */
-        getColumn(predicate: (column: Column) => boolean): Column;
+        getColumn(predicate: (column: Column) => boolean): Column | undefined;
 
         /**
          * Returns all columns in this workspace, which satisfy the provided predicate. If no predicate was provided, will return all column.
@@ -1633,7 +1686,7 @@ export namespace IOConnectWorkspaces {
          * Returns the first group in this workspace, which satisfies the provided predicate.
          * @param predicate A filtering function (predicate) called for each group present in this workspace.
          */
-        getGroup(predicate: (group: Group) => boolean): Group;
+        getGroup(predicate: (group: Group) => boolean): Group | undefined;
 
         /**
          * Returns all groups in this workspace, which satisfy the provided predicate. If no predicate was provided, will return all groups.
@@ -1645,7 +1698,7 @@ export namespace IOConnectWorkspaces {
          * Returns the first window in this workspace, which satisfies the provided predicate.
          * @param predicate A filtering function (predicate) called for each window present in this workspace.
          */
-        getWindow(predicate: (window: WorkspaceWindow) => boolean): WorkspaceWindow;
+        getWindow(predicate: (window: WorkspaceWindow) => boolean): WorkspaceWindow | undefined;
 
         /**
          * Returns all windows in this workspace, which satisfy the provided predicate. If no predicate was provided, will return all windows.
@@ -2522,7 +2575,7 @@ export namespace IOConnectWorkspaces {
          * Returns the first frame instance which satisfies the provided predicate or undefined, if non do.
          * @param predicate A filtering function (predicate) called for each open frame.
          */
-        getFrame(predicate: (frame: Frame) => boolean): Promise<Frame>;
+        getFrame(predicate: (frame: Frame) => boolean): Promise<Frame | undefined>;
 
         /**
          * Returns all frames which satisfy the provided predicate. If no predicate is provided, will return all frames.
@@ -2546,7 +2599,7 @@ export namespace IOConnectWorkspaces {
          * Returns the first workspace instance which satisfies the provided predicate or undefined, if non do.
          * @param predicate A filtering function (predicate) called for each open workspace.
          */
-        getWorkspace(predicate: (workspace: Workspace) => boolean): Promise<Workspace>;
+        getWorkspace(predicate: (workspace: Workspace) => boolean): Promise<Workspace | undefined>;
 
         /**
          * Returns an instance of the workspace with the passed id. The performance is better than getWorkspace when querying for a workspace by id.
@@ -2565,14 +2618,14 @@ export namespace IOConnectWorkspaces {
          * This function will search recursively in all open workspaces.
          * @param predicate A filtering function (predicate) called for each window in each open workspace.
          */
-        getWindow(predicate: (workspaceWindow: WorkspaceWindow) => boolean): Promise<WorkspaceWindow>;
+        getWindow(predicate: (workspaceWindow: WorkspaceWindow) => boolean): Promise<WorkspaceWindow | undefined>;
 
         /**
          * Returns the instance of the first box, which satisfies the provided predicate.
          * This function will search recursively in all open workspaces.
          * @param predicate A filtering function (predicate) called for each box in each open workspace.
          */
-        getBox(predicate: (box: WorkspaceBox) => boolean): Promise<WorkspaceBox>;
+        getBox(predicate: (box: WorkspaceBox) => boolean): Promise<WorkspaceBox | undefined>;
 
         /**
          * Opens a new workspace by restoring a previously saved workspace layout.