@sapui5/ts-types 1.119.2 → 1.120.0

package/types/sap.insights.d.ts

@@ -1,10 +1,47 @@
-// For Library Version: 1.119.1
+// For Library Version: 1.120.0
 
 declare namespace sap {
   /**
    * SAP UI library: sap.insights
    */
   namespace insights {
+    namespace CardsChannel {
+      /**
+       * @experimental
+       *
+       * The card object
+       */
+      type Card = {
+        /**
+         * Unique identifier for the card.
+         */
+        id: string;
+        /**
+         * manifest of the card.
+         */
+        descriptorContent: Object;
+      };
+
+      /**
+       * @experimental
+       *
+       * The cardInfo object
+       */
+      type CardInfo = {
+        /**
+         * Unique identifier for the card.
+         */
+        id: string;
+        /**
+         * Title of the card.
+         */
+        title: string;
+        /**
+         * Id of the parent app.
+         */
+        parentAppId: string;
+      };
+    }
     /**
      * @experimental
      *
@@ -34,9 +71,13 @@ declare namespace sap {
          */
         oCardMessageInfo: object,
         /**
-         * boolean to determine if the method called within insights
+         * text for confirm button on the dialog
+         */
+        sConfirmButtonText: string,
+        /**
+         * callback event to be called when confirm button is pressed
          */
-        bCalledInternally: boolean
+        onConfirm: Function
       ): Promise<void>;
     }
 
@@ -188,6 +229,8 @@ declare namespace sap {
        * @experimental
        *
        * Initialize the CardsChannel either with the FLP message broker or an internal implementation for iframes.
+       *
+       * @returns .
        */
       init(): Promise<void>;
       /**
@@ -202,24 +245,42 @@ declare namespace sap {
        * @experimental
        *
        * Send a list of all available cards to a given consumer or broadcast it to all consumers.
+       *
+       * @returns .
        */
       publishAvailableCards(
+        /**
+         * .
+         */
         providerId: string,
-
-        cardInfos: object[],
-
+        /**
+         * .
+         */
+        cardInfos: sap.insights.CardsChannel.CardInfo[],
+        /**
+         * .
+         */
         consumerId: string
       ): Promise<void>;
       /**
        * @experimental
        *
        * Send a card to a given consumer or broadcast it to all consumers.
+       *
+       * @returns .
        */
       publishCard(
+        /**
+         * .
+         */
         providerId: string,
-
-        card: object,
-
+        /**
+         * .
+         */
+        card: sap.insights.CardsChannel.Card,
+        /**
+         * .
+         */
         consumerId?: string
       ): Promise<void>;
       /**
@@ -227,6 +288,8 @@ declare namespace sap {
        *
        * Register a card consumer with a unique id. The consumer will be notified through its callback when corresponding
        * messages are received.
+       *
+       * @returns .
        */
       registerConsumer(
         /**
@@ -242,6 +305,8 @@ declare namespace sap {
        * @experimental
        *
        * Register a card provider with a unique id. The provider will be notified if new consumers get registered.
+       *
+       * @returns .
        */
       registerProvider(
         /**
@@ -257,20 +322,36 @@ declare namespace sap {
        * @experimental
        *
        * Request a card from a given provider.
+       *
+       * @returns .
        */
       requestCard(
+        /**
+         * .
+         */
         consumerId: string,
-
+        /**
+         * .
+         */
         cardId: string,
-
+        /**
+         * .
+         */
         providerId: string
       ): Promise<void>;
       /**
        * @experimental
        *
        * Unregister a previously registered consumer or provider.
+       *
+       * @returns .
        */
-      unregister(id: string): Promise<void>;
+      unregister(
+        /**
+         * .
+         */
+        id: string
+      ): Promise<void>;
     }
     /**
      * @since 1.119