@interopio/desktop 6.13.1 → 6.15.0

package/changelog.md

@@ -1,3 +1,15 @@
+6.15.0
+- fix: channels - creation inconsistency - G4E-9871
+- chore: intents - add excludeList in handlerFilter - G4E-9881
+- chore: latest core version
+6.14.0
+- feat: windows - add dragMove method
+- feat: windows - add clearPlacement method
+- feat: windows - configure method now accepts a new option - showInTaskbar
+- feat: layouts - add onDefaultGlobalChanged event
+- feat: layouts - onRenamed event now receives the old name as a second argument
+- feat: layouts - add new options to the save method - ignoreContexts
+- bugfix: appManager - fix hangs on initialization with appManager: "full" outside platform
 6.13.1
 - fix: windows - group.onClosing throws an unhandledrejection error when the group is closed before the event is subscribed
 6.13.0

package/desktop.d.ts

@@ -1651,6 +1651,8 @@ export declare namespace IOConnectDesktop {
             activityType?: string;
             /** If `true`, multiple instances of the app can be started. */
             allowMultiple?: boolean;
+            /** Whether to register the iodesktop object in the global window context. */
+            registerIoDesktop?: boolean;
         }
 
         /** @ignore */
@@ -2116,11 +2118,20 @@ export declare namespace IOConnectDesktop {
              */
             onChanged(callback: (layout: Layout) => void): UnsubscribeFunction;
 
+            /**
+             * Notifies when a new default Global Layout has been selected or when the current one has been cleared.
+             * @param callback Callback function for handling the event. Receives as an argument an object with a `name` property
+             * holding the name of the newly selected default Global Layout. If the default Global Layout has been cleared, the argument will be `undefined`.
+             */
+            onDefaultGlobalChanged(callback: (layout?: { name: string }) => void): UnsubscribeFunction;
+
             /**
              * Notifies when a Layout is renamed.
              * @param callback Callback function for handling the event.
+             * Receives as a first argument the `Layout` object describing the renamed Layout.
+             * Receives as a second argument an object with a `name` property holding the previous Layout name.
              */
-            onRenamed(callback: (layout: Layout) => void): UnsubscribeFunction;
+            onRenamed(callback: (layout: Layout, previous: { name: string }) => void): UnsubscribeFunction;
 
             /**
              * Notifies when a Layout is restored.
@@ -2403,6 +2414,14 @@ export declare namespace IOConnectDesktop {
              * @ignore
              */
             ignoreMyInstance?: boolean;
+
+            /**
+             * If `true`, the context objects of individual io.Connect Windows and Workspaces participating in the Global Layout won't be saved when the Layout is saved.
+             * You can still use the `context` property to provide context data to be saved for the Global Layout itself.
+             * Valid only for Global Layouts.
+             * *Available since io.Connect Desktop 9.9.*
+             */
+            ignoreContexts?: boolean;
         }
 
         /**
@@ -3865,6 +3884,24 @@ export declare namespace IOConnectDesktop {
              * @default "onDemand"
              */
             buttonsVisibility?: "off" | "onDemand" | "always" | "onFocus";
+
+            /**
+             * If `true`, the window icon will appear in the taskbar.",
+             * @since io.Connect Desktop 9.9
+             */
+            showInTaskbar?: boolean;
+
+            /**
+             * Settings for searching in web apps.
+             * @since io.Connect Desktop 9.9
+             */
+            search?: {
+                /**
+                 * If `true`, will enable searching in web apps with `CTRL + F`.
+                 * @default true
+                 */
+                enabled?: boolean;
+            };
         }
 
         /**
@@ -4090,6 +4127,13 @@ export declare namespace IOConnectDesktop {
              */
             snapped: boolean;
 
+            /**
+             * If `true`, the last known bounds of the io.Connect Window will be saved unless the window has already been snapped.
+             * This allows the window to be restored using these saved bounds when clearing the placement settings for the window via the `clearPlacement()` method.
+             * @since io.Connect Desktop 9.9
+             */
+            saveBounds?: boolean;
+
             /**
              * Vertical alignment for the placed window. If `horizontalAlignment` is set, then `verticalAlignment` will default to "stretch".
              */
@@ -4142,6 +4186,21 @@ export declare namespace IOConnectDesktop {
             display?: IOConnectDesktop.Displays.Display | "current";
         }
 
+        /**
+         * Settings for clearing the window placement.
+         */
+        export interface ClearPlacementSettings {
+            /**
+             * If `true`, the io.Connect Window will be restored to its last known bounds saved in the `place()` method if `saveBounds` has been set to `true`.
+             */
+            restoreBounds?: boolean;
+
+            /**
+             * New bounds for the io.Connect Window. If this is provided, the `restoreBounds` property will be ignored.
+             */
+            newBounds?: Partial<Bounds>;
+        }
+
         /**
          * Modes for flashing the window icon in the taskbar:
          * - `"auto"` - the icon will flash only if the window isn't on focus and will stop flashing when the window is activated;
@@ -4661,7 +4720,24 @@ export declare namespace IOConnectDesktop {
              */
             value?: string;
         }
-
+        /**
+         * Options for dragging a window.
+         */
+        export interface DragMoveOptions {
+            /**
+             * Location of the mouse cursor within the window at the time the dragging operation was initiated.
+             */
+            location?: {
+                /**
+                 * Horizontal coordinate of the mouse cursor within the window in pixels. Relative to the left border of the io.Connect Window.
+                 */
+                x: number;
+                /**
+                 * Vertical coordinate of the mouse cursor within the window in pixels. Relative to the top border of the io.Connect Window.
+                 */
+                y: number;
+            }
+        }
         /**
          * Describes a docked window.
          */
@@ -5491,6 +5567,16 @@ export declare namespace IOConnectDesktop {
              */
             snap(target: string | IOConnectWindow, options?: SnappingOptions | RelativeDirection, success?: (window: IOConnectWindow) => void, error?: (error: string) => void): Promise<IOConnectWindow>;
 
+            /**
+             * This method can be used to start dragging the window with the mouse when the left mouse button is pressed.
+             * @param options Options for dragging the window. Use this argument to optionally provide the location of the mouse cursor within the window
+             * at the time the dragging operation was initiated. The platform will use that location to place the window under the mouse cursor when the mouse is moving
+             * (e.g., in case the mouse has already moved several pixels in any direction before the dragging operation has been initiated by the platform).
+             * If the starting mouse location isn't specified, its current position will be used.
+             * @since io.Connect Desktop 9.9
+             */
+            dragMove(options?: DragMoveOptions): Promise<void>;
+
             /**
              * Shows a loader animation for the window or updates the loader properties (animation type, background or text).
              * @param options Settings for the loader animation.
@@ -5728,6 +5814,14 @@ export declare namespace IOConnectDesktop {
              */
             place(options: PlacementSettings): Promise<void>;
 
+            /**
+             * Clears the window placement settings.
+             * This means that the window will no longer be automatically snapped to a specific position on the display in case of resolution, scaling, and monitor changes.
+             * @param options Settings for clearing the window placement.
+             * @since io.Connect Desktop 9.9
+             */
+            clearPlacement(options?: ClearPlacementSettings): Promise<void>;
+
             /**
              * Makes the window navigate back to the previous web page.
              */
@@ -6786,6 +6880,34 @@ export declare namespace IOConnectDesktop {
         // eslint-disable-next-line @typescript-eslint/no-empty-interface, @typescript-eslint/no-empty-object-type
         export interface IntentInfo extends AddIntentListenerRequest { }
 
+        /**
+         * Criteria for excluding Intent handlers from the results when using the `filterHandlers()` method.
+         * Intent handlers can be excluded either by app name, or by app instance ID.
+         */
+        export type HandlerExclusionCriteria = AppHandlerExclusion | InstanceHandlerExclusion;
+
+        /**
+         * Describes the criteria for excluding Intent handlers by app name when using the `filterHandlers()` method.
+         */
+        export interface AppHandlerExclusion {
+            /**
+             * Name of an app to exclude from the list of Intent handlers.
+             * When using an app name as an exclusion criterion, all Intents handlers associated with that app name will be excluded
+             * (the app itself and all already running instances of it).
+             */
+            applicationName: string;
+        }
+
+        /**
+         * Describes the criteria for excluding Intent handlers by app instance ID when using the `filterHandlers()` method.
+         */
+        export interface InstanceHandlerExclusion {
+            /**
+             * ID of a specific app instance to exclude from the list of Intent handlers.
+             */
+            instanceId: string;
+        }
+
         /**
          * Specifies the criteria for filtering the available Intent handlers when using the `filterHandlers()` method.
          */
@@ -6826,6 +6948,12 @@ export declare namespace IOConnectDesktop {
              * List of app names which will be used as a filter criteria.
              */
             applicationNames?: string[];
+
+            /**
+             * List of exclusion criteria for filtering out Intent handlers from the results.
+             * @since io.Connect Desktop 9.10
+             */
+            excludeList?: HandlerExclusionCriteria[];
         }
 
         /**
@@ -7646,6 +7774,11 @@ export declare namespace IOConnectDesktop {
              * If `true`, will enable showing a notification badge on the tray menu icon, in the "Notifications" section of the io.Connect launcher, and on the taskbar icon of the io.Connect launcher (or your shell app).
              */
             showNotificationBadge?: boolean;
+
+            /**
+             * If `true`, the Notification Panel will be hidden automatically when it loses focus.
+             */
+            autoHidePanel?: boolean;
         }
 
         /**