@interopio/desktop 6.5.0 → 6.6.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Tick42
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/changelog.md

@@ -1,3 +1,8 @@
+6.6.0
+- feat: layouts - add new methods - reset, getRestoredLayoutsInfo
+- feat: layouts - resume/restore methods now returns the restored instances
+6.5.1
+- chore: unified repo bump
 6.5.0
 - feat: contexts - add new methods - setPath,setPaths
 - fix: windows - activate/focus never resolves in certain cases

package/desktop.d.ts

@@ -2008,7 +2008,13 @@ export declare namespace IOConnectDesktop {
              * Restores a Layout.
              * @param options Options for restoring a Layout.
              */
-            restore(options: RestoreOptions): Promise<void>;
+            restore(options: RestoreOptions): Promise<RestoreResumeResult>;
+
+            /**
+             * Resets a Layout.
+             * @param options Options for resetting a Layout.
+             */
+            reset(options: ResetLayoutOptions): Promise<RestoreResumeResult>;
 
             /**
              * Removes a Layout
@@ -2035,6 +2041,11 @@ export declare namespace IOConnectDesktop {
              */
             getCurrentLayout(): Promise<Layout | undefined>;
 
+            /**
+             * Retrieves info about the currently active Layout (ID, type, name, participating app instances), as well as about any previously active Layouts that still have running instances of their participating apps.
+             */
+            getRestoredLayoutsInfo(): Promise<GetRestoredLayoutsInfoResult | undefined>;
+
             /**
              * Hibernates a Layout.
              * @param name Name of the Layout to hibernate.
@@ -2048,7 +2059,7 @@ export declare namespace IOConnectDesktop {
              * @param context Context for the Layout.
              * @param options Options for resuming a Layout.
              */
-            resume(name: string, context?: any, options?: IOConnectDesktop.Layouts.ResumeOptions): Promise<ResumeResult>;
+            resume(name: string, context?: any, options?: IOConnectDesktop.Layouts.ResumeOptions): Promise<RestoreResumeResult>;
 
             /**
              * Updates the context saved for your app in the currently loaded Layout.
@@ -2196,17 +2207,37 @@ export declare namespace IOConnectDesktop {
         }
 
         /**
-         * Describes the result returned from resuming a Layout.
+         * Describes the result returned from restoring or resuming a Layout.
          */
-        export interface ResumeResult extends LayoutResult {
+        export interface RestoreResumeResult extends LayoutResult {
             /**
-             * Array of objects describing all resumed app instances participating in the Layout.
-             * Each object contains the instance ID and the app name of the resumed app instance.
+             * Status of the Layout restore or resume operation.
              */
-            instances: {
-                instanceId: string,
-                appName: string
-            }[];
+            status: "Success" | "Failed";
+
+            /**
+             * ID of the Layout that was restored or resumed.
+             */
+            layoutId: string;
+
+            /**
+             * List of objects describing the app instances participating in the restored or resumed Layout.
+             */
+            instances: RestoredInstance[];
+        }
+
+        /**
+         * Describes an app instance participating in a restored or resumed Layout.
+         */
+        export interface RestoredInstance {
+            /**
+             * Name of the app within the io.Connect framework.
+             */
+            appName: string;
+            /**
+             * Unique ID of the app instance within the io.Connect framework.
+             */
+            instanceId: string;
         }
 
         /**
@@ -2223,6 +2254,48 @@ export declare namespace IOConnectDesktop {
             }[];
         }
 
+        /**
+         * Describes the currently active Layout (ID, type, name and participating app instances), as well as any previously active Layouts that still have running instances of their participating apps.
+         */
+        export interface GetRestoredLayoutsInfoResult {
+            /**
+             * List of objects each describing the currently active Layout or any previously active Layouts.
+             */
+            layoutInfo: RestoredLayoutDetails[];
+        }
+
+        /**
+         * Describes a currently active Layout, or a previously active Layout that may still have running instances of its participating apps.
+         */
+        export interface RestoredLayoutDetails {
+            /**
+             * ID of the Layout.
+             */
+            id: string;
+            /**
+             * Type of the Layout.
+             */
+            type: string;
+            /**
+             * Name of the Layout.
+             */
+            name: string;
+            /**
+             * List of objects each describing the app instances participating in the Layout.
+             */
+            instances: RestoredLayoutInstanceInfo[];
+        }
+
+        /**
+         * Describes an app instance participating in a Layout.
+         */
+        export interface RestoredLayoutInstanceInfo extends RestoredInstance {
+            /**
+             * Flag indicating whether the app instance has been stopped.
+             */
+            stopped: boolean;
+        }
+
         /**
          * Type of the Layout component - an activity or an app.
          * @ignore
@@ -2409,6 +2482,31 @@ export declare namespace IOConnectDesktop {
             splash?: RestoreSplashOptions;
         }
 
+        /**
+         * Options for resetting a Layout.
+         */
+        export interface ResetLayoutOptions {
+            /**
+             * ID of the Layout to reset.
+             */
+            layoutId: string
+            /**
+             * If `true`, will reset only the visible apps. Any apps that may have been hidden programmatically won't be included in the Layout reset process.
+             * @default false
+             */
+            visibleOnly?: boolean;
+            /**
+             * If `true`, will create any missing apps that may have been closed by the user or programmatically.
+             * @default true
+             */
+            createMissing?: boolean;
+            /**
+             * If `true`, will reset the Layout to its default state. Set to `false` to preserve any current app context or Channel selection.
+             * @default true
+             */
+            resetState?: boolean;
+        }
+
         /**
          * Options for hibernating Layouts.
          */
@@ -5112,6 +5210,11 @@ export declare namespace IOConnectDesktop {
              */
             jumpList: IOConnectDesktop.Windows.JumpList;
 
+            /**
+             * If `true`, the user is able to drop the current window in a Workspace.
+             */
+            allowWorkspaceDrop: boolean;
+
             /**
              * Attaches a tab window to the current tab window.
              * @param tab The instance or the name of the tab window to attach.
@@ -5525,6 +5628,12 @@ export declare namespace IOConnectDesktop {
              */
             setSticky(isSticky: boolean, success?: (window: IOConnectWindow) => void, error?: (error: string) => void): Promise<IOConnectWindow>;
 
+            /**
+             * Specifies whether the user will able to drop the current window in a Workspace.
+             * @param allow Flag indicating whether the user will be able to drop the window in a Workspace.
+             */
+            setAllowWorkspaceDrop(allow: boolean): Promise<IOConnectWindow>;
+
             /**
              * Refreshes the current window.
              * @param ignoreCache Flag indicating whether to use the Chromium cache (if `false`), or the server cache (if `true`) when refreshing the web page. Defaults to `false`.