@sapui5/ts-types-esm 1.132.1 → 1.134.0

package/types/sap.suite.ui.generic.template.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.132.0
+// For Library Version: 1.134.1
 
 declare module "sap/suite/ui/generic/template/library" {
   /**
@@ -636,8 +636,8 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/extensionAPI/Ex
          */
         message: string;
         /**
-         * indicates type of message (sap.ui.core.message.MessageType) whether it's sap.ui.core.message.MessageType.Success,
-         * sap.ui.core.message.MessageType.Warning, sap.ui.core.message.MessageType.Error or sap.ui.core.message.MessageType.Information.
+         * indicates type of message (sap/ui/core/message/MessageType) whether it's MessageType.Success, MessageType.Warning,
+         * MessageType.Error or MessageType.Information.
          */
         type: string;
       },
@@ -761,6 +761,22 @@ declare module "sap/suite/ui/generic/template/Canvas/extensionAPI/ExtensionAPI"
        */
       fnFunction: Function
     ): void;
+    /**
+     * Returns a communication object for storing and accessing custom state information within the current
+     * app.
+     *
+     * - If `iLevel` is `0`, it returns a global communication object shared across components. - If `iLevel`
+     *     is `1`, it returns a local communication object specific to the current canvas component.
+     *
+     *
+     * @returns The communication object.
+     */
+    getCommunicationObject(
+      /**
+       * The scope level of the communication object (0 for global, 1 for local).
+       */
+      iLevel: number
+    ): object;
     /**
      * Get the Flexible Column Layout Action Buttons (Fullscreen, Exit Fullscreen and Close). Note that the
      * usage of the Flexible Column Layout Action Buttons must have been switched on in the settings of the
@@ -964,7 +980,7 @@ declare module "sap/suite/ui/generic/template/extensionAPI/extensionAPI" {
      * (e.g. `oController.byId()` or `oController.extensionAPI`.
      *  In the definition of the controller extension specified in the manifest, simply call `registerControllerExtensions`.
      *
-     * @deprecated (since 1.120) - please refer the {@link topic:4120052d90374ce8b1cea24a0d8bd317 documentation }
+     * @deprecated As of version 1.120. please refer the {@link topic:4120052d90374ce8b1cea24a0d8bd317 documentation }
      * for the migration steps.
      */
     registerControllerExtensions(
@@ -2295,6 +2311,14 @@ declare module "sap/suite/ui/generic/template/ListReport/extensionAPI/ExtensionA
        */
       oControl: Control
     ): void;
+    /**
+     * Returns the global communication object for storing and accessing custom state information within the
+     * current app. This object can be used across components to share state information.
+     *
+     *
+     * @returns The communication object.
+     */
+    getCommunicationObject(): object;
     /**
      * Get the navigation controller for navigation actions
      *
@@ -2303,11 +2327,10 @@ declare module "sap/suite/ui/generic/template/ListReport/extensionAPI/ExtensionA
      */
     getNavigationController(): NavigationController;
     /**
-     * If switching between different table views is enabled, this function returns the selected key.
+     * If multi view table is enabled, this function returns the selected variant's key.
      *
-     * @experimental
      *
-     * @returns The key of the variant item that is currently selected.
+     * @returns The currently selected variant key on the table.
      */
     getQuickVariantSelectionKey(): string;
     /**
@@ -2463,8 +2486,8 @@ declare module "sap/suite/ui/generic/template/ListReport/extensionAPI/ExtensionA
          */
         message: string;
         /**
-         * indicates type of message (sap.ui.core.message.MessageType) whether it's sap.ui.core.message.MessageType.Success,
-         * sap.ui.core.message.MessageType.Warning, sap.ui.core.message.MessageType.Error or sap.ui.core.message.MessageType.Information.
+         * indicates type of message (sap/ui/core/message/MessageType) whether it's MessageType.Success, MessageType.Warning,
+         * MessageType.Error or MessageType.Information.
          */
         type: string;
       },
@@ -2482,13 +2505,11 @@ declare module "sap/suite/ui/generic/template/ListReport/extensionAPI/ExtensionA
       onClose?: Function
     ): void;
     /**
-     * If switching between different table views is enabled, this function sets the selected key.
-     *
-     * @experimental
+     * If multi view table is enabled, this function switches the table's view to given variant key.
      */
     setQuickVariantSelectionKey(
       /**
-       * The key of the variant item that is currently selected.
+       * The table variant key to be selected.
        */
       sKey: string
     ): void;
@@ -2589,6 +2610,8 @@ declare module "sap/suite/ui/generic/template/ListReport/extensionAPI/NonDraftTr
 declare module "sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExtensions" {
   import SelectionVariant from "sap/fe/navigation/SelectionVariant";
 
+  import Control from "sap/ui/core/Control";
+
   import Filter from "sap/ui/export/util/Filter";
 
   import Event from "sap/ui/base/Event";
@@ -2739,6 +2762,24 @@ declare module "sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExte
         getSourceInfo?: Function;
       }
     ): boolean;
+    /**
+     * Extension point for the application to specify the control to focus on in the object page upon edit.
+     *
+     * @ui5-protected Do not call from applications (only from related classes in the framework)
+     *
+     * @returns - The control that needs to be focused.
+     *
+     * The returned control must meet the following criteria: - Be focusable and have a "focus" property. -
+     * Be visible within the viewport.
+     *
+     * If the returned control does not satisfy these conditions, the standard focus handling logic is executed.
+     */
+    focusOnEditExtension(
+      /**
+       * The ID of the selected section.
+       */
+      sSelectedSection: String
+    ): Control;
     /**
      * This method is called by SAP Fiori elements when the table data is getting exported. Application developers
      * can override this method to add/remove the filters in the exported file.
@@ -3024,34 +3065,31 @@ declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/DraftTrans
       fnFunction: Function
     ): void;
     /**
-     * Cancel the draft. Note that this method only works when you are on the root of a draft. The normal navigation
+     * Cancels the draft. Note that this method only works when you are on the root of a draft. The normal navigation
      * which follows the cancellation of a draft is executed. Moreover, note that executing this method will
      * set the App to be busy. However, it does not ensure, that the method is only called, when the App is
      * currently unbusy. If you want to ensure that, you have to use {@link sap.suite.ui.generic.template.ObjectPage.extensionAPI.ExtensionAPI#securedExecution}.
      *
-     * @experimental
      *
-     * @returns a promise that is resolved when the draft is cancelled, rejected when this is not possible.
+     * @returns A promise that is resolved when the draft is cancelled, rejected when it is not possible.
      */
-    discardDraft(): Function;
+    discardDraft(): Promise<void>;
     /**
-     * checks if side effects exist for the given properties or entities and executes them. if there are pending
-     * changes in the model those pending changes are sent as a patch request with the side effect batch request.
-     * If no source property and no source entity is passed a global side effect is executed
-     *
-     * @experimental
+     * Checks if side effects exist for the given properties or entities and executes them. If there are pending
+     * changes in the model, those pending changes are sent as a patch request with the side effect batch request.
+     * If no source property and no source entity is passed, a global side effect is executed.
      */
     executeSideEffects(
       /**
-       * object containing any of the following properties:
+       * Object containing any of the following properties:
        */
       oSideEffects?: {
         /**
-         * array with property paths
+         * Array with property paths
          */
         sourceProperties: any[];
         /**
-         * array with navigation property paths
+         * Array with navigation property paths
          */
         sourceEntities: any[];
       }
@@ -3162,6 +3200,14 @@ declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/ExtensionA
        */
       fnFunction: Function
     ): void;
+    /**
+     * Returns the global communication object for storing and accessing custom state information within the
+     * current app. This object can be used across components to share state information.
+     *
+     *
+     * @returns The communication object.
+     */
+    getCommunicationObject(): object;
     /**
      * Get the navigation controller for navigation actions
      *
@@ -3170,15 +3216,14 @@ declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/ExtensionA
      */
     getNavigationController(): NavigationController;
     /**
-     * This function returns the selected key of selected table of Object Page.
+     * Returns the currently selected variant key on the table in the given object page section.
      *
-     * @experimental
      *
-     * @returns The key of variant item that is currently selected section.
+     * @returns The currently selected variant key on the table.
      */
     getQuickVariantSelectionKey(
       /**
-       * id of the section in Object Page mentioned in manifest of the application
+       * The object page section id in which the table is present.
        */
       sSectionKey: string
     ): string;
@@ -3395,8 +3440,8 @@ declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/ExtensionA
          */
         message: string;
         /**
-         * indicates type of message (sap.ui.core.message.MessageType) whether it's sap.ui.core.message.MessageType.Success,
-         * sap.ui.core.message.MessageType.Warning, sap.ui.core.message.MessageType.Error or sap.ui.core.message.MessageType.Information.
+         * indicates type of message (sap/ui/core/message/MessageType) whether it's MessageType.Success, MessageType.Warning,
+         * MessageType.Error or MessageType.Information.
          */
         type: string;
       },
@@ -3418,19 +3463,17 @@ declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/ExtensionA
       onClose?: Function
     ): void;
     /**
-     * This function sets the key in the selected section of the table of Object Page.
-     *
-     * @experimental
+     * Switches the table's view to the given variant key.
      */
     setQuickVariantSelectionKey(
       /**
-       * id of the section in Object Page mentioned in manifest of the application
+       * The object page section id in which the table is present.
        */
       sSectionKey: string,
       /**
-       * The key of variant item that is currently need to be set.
+       * The table variant key to be selected.
        */
-      sKey: string
+      sVariantKey: string
     ): void;
   }
 }