@sapui5/types 1.120.8 → 1.121.0

package/types/sap.insights.d.ts

@@ -1,31 +1,31 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.121.0
 
 declare module "sap/insights/library" {}
 
 declare module "sap/insights/CardHelper" {
   /**
+   * Provides functionality for Insight cards CRUD operations.
+   *
    * @since 1.102
    * @experimental (since 1.102)
-   *
-   * Provides functionality for Insight cards CRUD operations.
    */
   interface CardHelper {}
   const CardHelper: CardHelper;
   export default CardHelper;
 
   /**
-   * @experimental
-   *
    * Public (experimental) interface of the sap.insights.CardHelperService
+   *
+   * @experimental
    */
   export interface CardHelperService {
     __implements__sap_insights_CardHelperService: boolean;
 
     /**
-     * @experimental
-     *
      * Show preview for a given card
      *
+     * @experimental
+     *
      * @returns Returns promise, which generates preview for the passed card manifest
      */
     showCardPreview(
@@ -70,6 +70,7 @@ declare module "sap/insights/CardsChannel" {
      *
      * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
      *
+     *
      * @returns Created class / constructor function
      */
     static extend<T extends Record<string, unknown>>(
@@ -90,30 +91,31 @@ declare module "sap/insights/CardsChannel" {
     /**
      * Returns a metadata object for class sap.insights.CardsChannel.
      *
+     *
      * @returns Metadata object describing this class
      */
     static getMetadata(): Metadata;
     /**
-     * @experimental
-     *
      * Initialize the CardsChannel either with the FLP message broker or an internal implementation for iframes.
      *
+     * @experimental
+     *
      * @returns .
      */
     init(): Promise<void>;
     /**
-     * @experimental
-     *
      * Checks if the broker is enabled.
      *
+     * @experimental
+     *
      * @returns true if the broker is enabled
      */
     isEnabled(): boolean;
     /**
-     * @experimental
-     *
      * Send a list of all available cards to a given consumer or broadcast it to all consumers.
      *
+     * @experimental
+     *
      * @returns .
      */
     publishAvailableCards(
@@ -131,10 +133,10 @@ declare module "sap/insights/CardsChannel" {
       consumerId: string
     ): Promise<void>;
     /**
-     * @experimental
-     *
      * Send a card to a given consumer or broadcast it to all consumers.
      *
+     * @experimental
+     *
      * @returns .
      */
     publishCard(
@@ -152,11 +154,11 @@ declare module "sap/insights/CardsChannel" {
       consumerId?: string
     ): Promise<void>;
     /**
-     * @experimental
-     *
      * Register a card consumer with a unique id. The consumer will be notified through its callback when corresponding
      * messages are received.
      *
+     * @experimental
+     *
      * @returns .
      */
     registerConsumer(
@@ -170,10 +172,10 @@ declare module "sap/insights/CardsChannel" {
       consumer: ICardConsumer
     ): Promise<void>;
     /**
-     * @experimental
-     *
      * Register a card provider with a unique id. The provider will be notified if new consumers get registered.
      *
+     * @experimental
+     *
      * @returns .
      */
     registerProvider(
@@ -187,10 +189,10 @@ declare module "sap/insights/CardsChannel" {
       provider: ICardProvider
     ): Promise<void>;
     /**
-     * @experimental
-     *
      * Request a card from a given provider.
      *
+     * @experimental
+     *
      * @returns .
      */
     requestCard(
@@ -208,10 +210,10 @@ declare module "sap/insights/CardsChannel" {
       providerId: string
     ): Promise<void>;
     /**
-     * @experimental
-     *
      * Unregister a previously registered consumer or provider.
      *
+     * @experimental
+     *
      * @returns .
      */
     unregister(
@@ -222,9 +224,9 @@ declare module "sap/insights/CardsChannel" {
     ): Promise<void>;
   }
   /**
-   * @experimental
-   *
    * The card object
+   *
+   * @experimental
    */
   export type Card = {
     /**
@@ -238,9 +240,9 @@ declare module "sap/insights/CardsChannel" {
   };
 
   /**
-   * @experimental
-   *
    * The cardInfo object
+   *
+   * @experimental
    */
   export type CardInfo = {
     /**
@@ -262,17 +264,17 @@ declare module "sap/insights/CardsChannel" {
   };
 
   /**
-   * @experimental
-   *
    * Interface required for classes that would like to consume cards using the `sap.insights.CardsChannel`.
+   *
+   * @experimental
    */
   export interface ICardConsumer {
     __implements__sap_insights_ICardConsumer: boolean;
 
     /**
-     * @experimental
-     *
      * Callback when a card is created for this consumer.
+     *
+     * @experimental
      */
     onCardProvided(
       /**
@@ -283,9 +285,9 @@ declare module "sap/insights/CardsChannel" {
       card: object
     ): void;
     /**
-     * @experimental
-     *
      * Callback when cards are available.
+     *
+     * @experimental
      */
     onCardsAvailable(
       /**
@@ -300,17 +302,17 @@ declare module "sap/insights/CardsChannel" {
   }
 
   /**
-   * @experimental
-   *
    * Interface required for classes that would like to provide cards using the `sap.insights.CardsChannel`.
+   *
+   * @experimental
    */
   export interface ICardProvider {
     __implements__sap_insights_ICardProvider: boolean;
 
     /**
-     * @experimental
-     *
      * Callback when a consumer requests a specific card.
+     *
+     * @experimental
      */
     onCardRequested(
       /**
@@ -323,9 +325,9 @@ declare module "sap/insights/CardsChannel" {
       cardId: string
     ): void;
     /**
-     * @experimental
-     *
      * Callback when a consumer is connected.
+     *
+     * @experimental
      */
     onConsumerConnected(
       /**
@@ -334,9 +336,9 @@ declare module "sap/insights/CardsChannel" {
       consumerId: string
     ): void;
     /**
-     * @experimental
-     *
      * Callback when a consumer is disconnected.
+     *
+     * @experimental
      */
     onConsumerDisconnected(
       /**
@@ -347,6 +349,118 @@ declare module "sap/insights/CardsChannel" {
   }
 }
 
+declare module "sap/insights/channels/ContextChannel" {
+  import BaseObject from "sap/ui/base/Object";
+
+  import Metadata from "sap/ui/base/Metadata";
+
+  export default class ContextChannel extends BaseObject {
+    /**
+     * Provides a communication between card providers and consumers in FLP and included iframes.
+     */
+    constructor();
+
+    /**
+     * Creates a new subclass of class sap.insights.channels.ContextChannel with name `sClassName` and enriches
+     * it with the information contained in `oClassInfo`.
+     *
+     * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
+     *
+     *
+     * @returns Created class / constructor function
+     */
+    static extend<T extends Record<string, unknown>>(
+      /**
+       * Name of the class being created
+       */
+      sClassName: string,
+      /**
+       * Object literal with information about the class
+       */
+      oClassInfo?: sap.ClassInfo<T, ContextChannel>,
+      /**
+       * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
+       * used by this class
+       */
+      FNMetaImpl?: Function
+    ): Function;
+    /**
+     * Returns a metadata object for class sap.insights.channels.ContextChannel.
+     *
+     *
+     * @returns Metadata object describing this class
+     */
+    static getMetadata(): Metadata;
+    /**
+     * Get the context from the active provider.
+     *
+     * @experimental
+     *
+     * @returns .
+     */
+    getContext(): Promise<object>;
+    /**
+     * Initialize the ContextChannel either with the FLP message broker or an internal implementation for iframes.
+     *
+     * @experimental
+     *
+     * @returns .
+     */
+    init(): Promise<void>;
+    /**
+     * Register a card provider with a unique id. The provider will be notified if new consumers get registered.
+     *
+     * @experimental
+     *
+     * @returns .
+     */
+    registerProvider(
+      /**
+       * Object implementing the TBD interface
+       */
+      provider: IContextProvider
+    ): Promise<void>;
+    /**
+     * Unregister a previously registered consumer or provider.
+     *
+     * @experimental
+     *
+     * @returns .
+     */
+    unregisterProvider(
+      /**
+       * Object implementing the TBD interface
+       */
+      provider: IContextProvider
+    ): Promise<void>;
+  }
+  /**
+   * Interface required for classes that would like to provide cards using the `sap.insights.CardsChannel`.
+   *
+   * @experimental
+   */
+  export interface IContextProvider {
+    __implements__sap_insights_channels_IContextProvider: boolean;
+
+    /**
+     * Getter of the current context as promise.
+     *
+     * @experimental
+     *
+     * @returns returns a promise of the context
+     */
+    getContext(): Promise<object>;
+    /**
+     * Get the unique identifier of the context provider (e.g. app id)
+     *
+     * @experimental
+     *
+     * @returns unique id of the context provider
+     */
+    getId(): string;
+  }
+}
+
 declare module "sap/insights/ManageCards" {
   import { default as Control, $ControlSettings } from "sap/ui/core/Control";
 
@@ -355,10 +469,10 @@ declare module "sap/insights/ManageCards" {
   import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
 
   /**
-   * @since 1.119
-   *
    * This control shows list of all user cards and allows perform actions like change visibility, change order.
    * It also allows user to get preview of particular card, delete or copy.
+   *
+   * @since 1.119
    */
   export default class ManageCards extends Control {
     /**
@@ -372,6 +486,7 @@ declare module "sap/insights/ManageCards" {
      *
      * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
      *
+     *
      * @returns Created class / constructor function
      */
     static extend<T extends Record<string, unknown>>(
@@ -392,6 +507,7 @@ declare module "sap/insights/ManageCards" {
     /**
      * Returns a metadata object for class sap.insights.ManageCards.
      *
+     *
      * @returns Metadata object describing this class
      */
     static getMetadata(): ElementMetadata;
@@ -401,6 +517,7 @@ declare module "sap/insights/ManageCards" {
      * Sets the cardId property which decides whether to render the details page or cardlist page, if cardId
      * is provided , cardDetails page is rendered
      *
+     *
      * @returns Value of property `cardId`
      */
     getCardId(): string;
@@ -411,6 +528,7 @@ declare module "sap/insights/ManageCards" {
      *
      * Default value is `false`.
      *
+     *
      * @returns Value of property `enableResetAllCards`
      */
     getEnableResetAllCards(): boolean;
@@ -422,6 +540,7 @@ declare module "sap/insights/ManageCards" {
      *
      * When called with a value of `null` or `undefined`, the default value of the property will be restored.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     setCardId(
@@ -439,6 +558,7 @@ declare module "sap/insights/ManageCards" {
      *
      * Default value is `false`.
      *
+     *
      * @returns Reference to `this` in order to allow method chaining
      */
     setEnableResetAllCards(
@@ -469,6 +589,8 @@ declare namespace sap {
 
     "sap/insights/CardsChannel": undefined;
 
+    "sap/insights/channels/ContextChannel": undefined;
+
     "sap/insights/library": undefined;
 
     "sap/insights/ManageCards": undefined;