@interopio/desktop 6.9.0-rc.1 → 6.9.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,15 @@
+6.9.0
+- feat: Enable executeJavaScript Method Access through External API
+- feat: Bulk update Notifications from Notification Panel
+- feat: Added the pinned tabs methods and properties
+- feat: Interception API
+- feat: Added fdc3 parsing options to the channels API
+6.8.4
+- chore: bump due to workspaces api release
+6.8.3
+- fix: Added missing fdc3 dependency
+6.8.2
+- chore: Update ChannelContext's data type
 6.8.1
 - fix: ignore peerID when invocation target has instance
 6.8.0

package/desktop.d.ts

@@ -227,6 +227,7 @@ export declare namespace IOConnectDesktop {
 
         /**
          * Interception API.
+         * @since io.Connect Desktop 9.6
          */
         interception: IOConnectDesktop.Interception.API;
     }
@@ -5651,7 +5652,7 @@ export declare namespace IOConnectDesktop {
              * 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`.
              */
-            refresh(ignoreCache: boolean): Promise<IOConnectWindow>;
+            refresh(ignoreCache?: boolean): Promise<IOConnectWindow>;
 
             /**
              * Downloads a file.
@@ -6085,16 +6086,18 @@ export declare namespace IOConnectDesktop {
         export interface API {
             /**
              * Subscribes for data updates of the current Channel. Persisted after a Channel change. Returns an unsubscribe function.
-             * @param callback Callback function to handle the received data.
+             * @param callback Callback function for handling the received data. The callback receives as arguments the updated Channel data, the current Channel context and the ID of the updating app instance.
+             * @param options Settings for subscribing to an FDC3 context published in the io.Connect Channel. *Available since io.Connect Desktop 9.6.*
              */
-            subscribe(callback: (data: any, context: ChannelContext, updaterId: string) => void): () => void;
+            subscribe(callback: (data: any, context: ChannelContext, updaterId: string) => void, options?: FDC3Options): () => void;
 
             /**
-             * Subscribes for data updates of a specified Channel. Returns a `Promise` that resolves with an unsubscribe function.
-             * @param name The Channel to track.
-             * @param callback Callback function to handle the received data.
+             * Subscribes for data updates of a specified Channel. Resolves with an unsubscribe function.
+             * @param name The Channel to which to subscribe.
+             * @param callback Callback function for handling the received data. The callback receives as arguments the updated Channel data, the current Channel context and the ID of the updating app instance.
+             * @param options Settings for subscribing to an FDC3 context published in the io.Connect Channel. *Available since io.Connect Desktop 9.6.*
              */
-            subscribeFor(name: string, callback: (data: any, context: ChannelContext, updaterId: string) => void): Promise<() => void>;
+            subscribeFor(name: string, callback: (data: any, context: ChannelContext, updaterId: string) => void, options?: FDC3Options): Promise<() => void>;
 
             /**
              * Updates the context of the current or a specified Channel.
@@ -6130,13 +6133,15 @@ export declare namespace IOConnectDesktop {
             /**
              * Retrieves the context of a specified Channel.
              * @param name The name of the Channel whose context to retrieve.
+             * @param options Settings for retrieving an FDC3 context published in the io.Connect Channel. *Available since io.Connect Desktop 9.6.*
              */
-            get(name: string): Promise<ChannelContext>;
+            get(name: string, options?: FDC3Options): Promise<ChannelContext>;
 
             /**
              * Retrieves the context of the current Channel.
+             * @param options Settings for retrieving an FDC3 context published in the io.Connect Channel. *Available since io.Connect Desktop 9.6.*
              */
-            getMy(): Promise<ChannelContext>;
+            getMy(options?: FDC3Options): Promise<ChannelContext>;
 
             /**
              * Joins a new Channel by name. Leaves the current Channel.
@@ -6220,6 +6225,17 @@ export declare namespace IOConnectDesktop {
             onChanged(callback: (channel: string) => void): () => void;
         }
 
+        /**
+         * Settings for retrieving and subscribing for FDC3 contexts published in an io.Connect Channel.
+         * @since io.Connect Desktop 9.6
+         */
+        export interface FDC3Options {
+            /**
+             * Type of the FDC3 context to retrieve or to which to subscribe.
+             */
+            contextType?: string;
+        }
+
         /**
          * Describes an io.Connect Window that can use Channels.
          */
@@ -6439,16 +6455,18 @@ export declare namespace IOConnectDesktop {
             addIntentListener(intent: string | AddIntentListenerRequest, handler: (context: IntentContext) => any): { unsubscribe: UnsubscribeFunction };
 
             /**
-             * Notifies when a handler for the an Intent is added.
-             * @param callback Callback function for handling the event.
+             * Notifies when a handler for an Intent is added. Returns an unsubscribe function.
+             * @param callback Callback function for handling the event. Receives an object describing the added Intent handler as an argument.
+             * @since io.Connect Desktop 9.6
              */
-            onHandlerAdded(callback: (handler: IOConnectDesktop.Intents.ResolverIntentHandler) => void, intentName: string): UnsubscribeFunction;
+            onHandlerAdded(callback: (handler: IOConnectDesktop.Intents.IntentHandler) => void, intentName: string): UnsubscribeFunction;
 
             /**
-             * Notifies when a handler for the an Intent is removed.
-             * @param callback Callback function for handling the event.
+             * Notifies when a handler for an Intent is removed. Returns an unsubscribe function.
+             * @param callback Callback function for handling the event. Receives an object describing the removed Intent handler as an argument.
+             * @since io.Connect Desktop 9.6
              */
-            onHandlerRemoved(callback: (handler: IOConnectDesktop.Intents.ResolverIntentHandler)=> void, intentName: string): UnsubscribeFunction;
+            onHandlerRemoved(callback: (handler: IOConnectDesktop.Intents.IntentHandler)=> void, intentName: string): UnsubscribeFunction;
 
             /**
              * Registers an Intent handler. If your app is already registered as an Intent handler through its configuration,
@@ -7031,6 +7049,14 @@ export declare namespace IOConnectDesktop {
              */
             snoozeMany(notifications: string[], duration: number): Promise<void>;
 
+            /**
+             * Imports a list of notifications into the platform. Only imported notifications with state `"Active"` will be shown as notification toasts.
+             * All imported notifications will be available in the Notification Panel. An event for raising a notification will be triggered for all imported notifications.
+             * @param notificationOptions List of objects each describing a notification to import. The notification options for importing notifications are identical to the ones for raising a notification.
+             * @since io.Connect Desktop 9.6
+             */
+            import(notificationOptions: IOConnectNotificationOptions[]): Promise<IOConnectDesktop.Notifications.NotificationData[]>;
+
             /**
              * Notifies when a new notification is raised.
              * @param callback Callback function for handling the event.
@@ -7112,6 +7138,12 @@ export declare namespace IOConnectDesktop {
              * Array of names of apps not allowed to raise notifications.
              */
             blocked?: string[];
+
+            /**
+             * Array of names of apps that are currently muted.
+             * @since io.Connect Desktop 9.6
+             */
+            muted?: string[];
         }
 
         /**
@@ -7402,15 +7434,17 @@ export declare namespace IOConnectDesktop {
 
             /**
              * Unique ID for the notification action. This ID can be used in the `displayPath` property of another notification action to determine the position of the latter within the notification action menu.
+             * @since io.Connect Desktop 9.6
              */
-            displayId: string;
+            displayId?: string;
 
             /**
              * List of `displayId` values or titles of other notification actions describing the path within the notification action menu where the current notification action will be placed (e.g., `[ "main-action-id", "My Nested Action" ]`).
              * The display ID takes precedence over the title when the framework searches for the respective item. If the provided display ID or title doesn't exist, an empty notification action will be created
              * (the action will have a dropdown menu that will contain other actions, but when the user clicks on the action itself, nothing will happen).
+             * @since io.Connect Desktop 9.6
              */
-            displayPath: string[];
+            displayPath?: string[];
         }
 
         /**
@@ -7478,6 +7512,13 @@ export declare namespace IOConnectDesktop {
              * Describes the placement settings for the Notification Panel and the notification toasts.
              */
             placement?: NotificationPlacement;
+
+            /**
+             * If `true`, when the user clicks on the body of a notification in the Notification Panel, the notification will be removed from the list.
+             * Set to `false` if you want users to be able to click on the notification body (e.g., to copy text) without the notification disappearing from the Notification Panel.
+             * @since io.Connect Desktop 9.6
+             */
+            closeNotificationOnClick?: boolean;
         }
 
 
@@ -7909,20 +7950,21 @@ export declare namespace IOConnectDesktop {
 
     /**
      * @intro
+     * @since io.Connect Desktop 9.6
      * The Interception API enables apps to register interception handlers with which to modify the low-level platform operations.
      * Interception handlers can be executed before and/or after the default implementations of the platform operations,
      * and the execution of the default implementation for a platform operation can be prevented entirely.
      * This allows for finer control over the platform operations.
      * It's possible to register only a single interception handler per platform operation within an API domain.
      *
-     * For an app to be able to register interception handlers, interception must be enabled
-     * in the system configuration of **io.Connect Desktop** and the name of the app must be specified in the list of apps allowed to register interception handlers.
+     * For an app to be able to register interception handlers, interception must be enabled in the system configuration of **io.Connect Desktop**.
      *
      * *Available since io.Connect Desktop 9.6.*
      */
     export namespace Interception {
         /**
          * Interception API.
+         * @since io.Connect Desktop 9.6
          */
         export interface API {
             /**
@@ -7980,11 +8022,13 @@ export declare namespace IOConnectDesktop {
              */
             callerId: string;
             /**
-             * Specifies whether the platform operation has been intercepted before or after its execution.
+             * Specifies whether the platform operation has been intercepted before or after the execution of its default implementation.
              */
             phase: "before" | "after";
             /**
-             * Arguments with which the intercepted platform operation was invoked.
+             * In the `"before"` phase, this property will contain the arguments with which the calling app has invoked the intercepted operation.
+             * In the `"after"` phase, this property will contain the result returned from executing the default platform implementation of the intercepted operation
+             * (or the result from the decorated operation, if the interception handler was invoked also in the `"before"` phase to modify the default operation).
              */
             operationArgs?: any[];
         }