@sapui5/ts-types 1.112.3 → 1.113.0

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.112.3
+// For Library Version: 1.113.0
 
 declare namespace sap {
   namespace suite {
@@ -202,6 +202,8 @@ declare namespace sap {
              */
             interface controllerFrameworkExtensions {
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements before triggering an external navigation. Application developers
                * can override this method and programmatically adapt the parameters which are passed to the target application.
                * Application developers can use the oObjectInfo parameter to identify the navigation context and modify
@@ -227,11 +229,15 @@ declare namespace sap {
                 }
               ): void;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements whenever the busy state is switched off. Application developers
                * can override this method, access the message model and adapt the transient messages related to the component.
                */
               adaptTransientMessageExtension(): void;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements when a smart link in a table is clicked. Application developers
                * can override this method and invoke the oParams.getSourceInfo method to find out the information about
                * the clicked smart link.
@@ -258,6 +264,8 @@ declare namespace sap {
                 }
               ): boolean;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements before persisting the AppState. Application developers can
                * override this method for persisting the state of custom controls. State of the custom control (controls)
                * should be stored in the oCustomData passed as a parameter to this method. To make a complete functionality,
@@ -270,6 +278,8 @@ declare namespace sap {
                 oCustomData: object
               ): void;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called in the AppState creation lifecycle. Application developers can override this method,
                * return an array of all selection fields set on SmartFilterBar using custom code as default and doesn't
                * really want to store as part of the AppState. SAP Fiori elements framework will remove these filter properties
@@ -280,6 +290,8 @@ declare namespace sap {
                */
               getVisibleSelectionsWithDefaults(): any[];
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements in the startup life cycle of a component. Application developers
                * can override this method and modify the startup object. For an example, when the application is started,
                * the selection variant might contain some properties that are not required for this app. Such properties
@@ -303,6 +315,33 @@ declare namespace sap {
                 }
               ): void;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
+               * 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.
+               *
+               * To add new filter entries to the exported file, create an instance of {@link sap.ui.export.util.Filter}
+               * and add it to "oExportParams.filterSettings"
+               */
+              onBeforeExportTableExtension(
+                /**
+                 * Object containing the table export info
+                 */
+                oExportParams: {
+                  /**
+                   * The filters in the exported file Note: Please make changes on "oExportParams.filterSettings" array only
+                   * when "Include filter settings" is selected. Otherwise, the changes will be ignored.
+                   */
+                  filterSettings: sap.ui.export.util.Filter[];
+                  /**
+                   * The value of "Include filter settings" checkbox
+                   */
+                  includeFilterSettings: boolean;
+                }
+              ): void;
+              /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements before binding a chart. Application developers can override
                * this method and programmatically modify parameters or filters before chart triggers a query to retrieve
                * data.
@@ -316,6 +355,8 @@ declare namespace sap {
                 oEvent: sap.ui.base.Event
               ): void;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements before binding a filterable KPI. Application developers can
                * override this method to modify parameters or filters for a filterable KPI.
                */
@@ -334,6 +375,8 @@ declare namespace sap {
                 sKPIId: string
               ): void;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements before binding a table. Application developers can override
                * this method and programmatically modify parameters or filters before the table triggers a query to retrieve
                * data.
@@ -347,6 +390,8 @@ declare namespace sap {
                 oEvent: sap.ui.base.Event
               ): void;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements before binding a visual filter. Application developers can
                * override this method and programmatically modify parameters, filters, or influence sorting before the
                * chart triggers a query to retrieve data. Application developers can also access incoming navigation contexts
@@ -389,6 +434,8 @@ declare namespace sap {
                 }
               ): void;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method should be implemented whenever application uses onListNavigationExtension for internal navigation.
                * In this case the implementation of this method should provide an 'inverse' mapping to the transformation
                * implemented within onListNavigationExtension. More precisely, the identification of a child page instance
@@ -420,6 +467,8 @@ declare namespace sap {
                 fnSetPath: Function
               ): void;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements when the Clear button on the filter dialog is clicked. Application
                * developers can override this method to clear custom filters.
                */
@@ -430,11 +479,15 @@ declare namespace sap {
                 oEvent: sap.ui.base.Event
               ): void;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by Fiori elements on the initialization of View. Application developers can override
                * this method & perform internal setup in this hook.
                */
               onInit(): void;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements once the smart filter bar is initialized with a variant.
                * Application developers can override this method when there is a custom filter field bound outside the
                * standard model.
@@ -446,6 +499,8 @@ declare namespace sap {
                 oEvent: sap.ui.base.Event
               ): void;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called when the user leaves the app and this page has been displayed within the same app
                * session (this is the time since last opening the app) at least once. Moreover, it is called for all pages
                * that have been displayed within some app session when the app is finally destroyed.
@@ -462,6 +517,8 @@ declare namespace sap {
                 bIsDestroyed: boolean
               ): Function;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements when a chevron navigation is triggered from a table. Application
                * developers can override this method and perform conditional (internal or external) navigation from different
                * rows of a table. Such custom navigation should be triggered via corresponding methods of {@link sap.suite.ui.generic.template.extensionAPI.NavigationController
@@ -487,6 +544,8 @@ declare namespace sap {
                 bReplaceInHistory: boolean
               ): boolean;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements when the Share functionality is triggered. Application developers
                * can adapt the service URL passed as a parameter to this method. Adapted service URL will be used in the
                * 'Send Email' or 'Save as Tile' options.
@@ -503,6 +562,8 @@ declare namespace sap {
                 }
               ): void;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements while applying the AppState. This method should be overridden
                * with `getCustomAppStateDataExtension`. The custom data retrieved from the AppState will be passed as
                * a parameter to this method. Application developers can use this custom data to restore the state of the
@@ -1186,6 +1247,8 @@ declare namespace sap {
                 oListener?: object
               ): this;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * Fires event {@link #event:pageDataLoaded pageDataLoaded} to attached listeners.
                *
                * @returns Reference to `this` in order to allow method chaining
@@ -1843,6 +1906,8 @@ declare namespace sap {
              */
             interface controllerFrameworkExtensions {
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * Obsolete and not called anymore. Kept here to avoid conflicts (in the very unlikely case, Fiori elements
                * would come up with the idea to invent a new extension method with the exact same name some day in future,
                * and any application would still have an implementation for this old extension).
@@ -1865,6 +1930,8 @@ declare namespace sap {
               getVisibleSelectionsWithDefaults: undefined;
 
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements before triggering an external navigation. Application developers
                * can override this method and programmatically adapt the parameters which are passed to the target application.
                * Application developers can use the oObjectInfo parameter to identify the navigation context and modify
@@ -1890,11 +1957,15 @@ declare namespace sap {
                 }
               ): void;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements whenever the busy state is switched off. Application developers
                * can override this method, access the message model and adapt the transient messages related to the component.
                */
               adaptTransientMessageExtension(): void;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements when the delete operation is triggered. Application developers
                * can override this method in controller extension & perform additional checks before executing the delete
                * operation. Method is expected to return a Promise. To veto the delete operation, promise needs to be
@@ -1914,6 +1985,8 @@ declare namespace sap {
                 }
               ): Promise<any>;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method should be implemented whenever the application needs to have a custom save functionality
                * for multi edit scenario. The logic for save should be defined here and this method should return a promise
                * based on whose resolution or rejection the framework would perform cleanup tasks like closing the dialog
@@ -1939,6 +2012,8 @@ declare namespace sap {
                 }>
               ): Promise<any>;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements when a smart link in a table is clicked. Application developers
                * can override this method and invoke the oParams.getSourceInfo method to find out the information about
                * the clicked smart link.
@@ -1965,6 +2040,8 @@ declare namespace sap {
                 }
               ): boolean;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements before persisting the AppState. Application developers can
                * override this method for persisting the state of custom controls. State of the custom control (controls)
                * should be stored in the oCustomData passed as a parameter to this method. To make a complete functionality,
@@ -1993,6 +2070,8 @@ declare namespace sap {
                 oCustomData: object
               ): void;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements when the Create with Filters is executed. Application developers
                * can enable this feature in the LR component by adding createWithFilters in the settings object of the
                * List Report component & strategy needs to be set as `extension`. SmartFilterBar instance will be passed
@@ -2013,6 +2092,8 @@ declare namespace sap {
                 oDefaultValues: object
               ): Map<any, any>;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements in the startup life cycle of a component. Application developers
                * can override this method and modify the startup object. For an example, when the application is started,
                * the selection variant might contain some properties that are not required for this app. Such properties
@@ -2044,6 +2125,33 @@ declare namespace sap {
                 }
               ): void;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
+               * 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.
+               *
+               * To add new filter entries to the exported file, create an instance of {@link sap.ui.export.util.Filter}
+               * and add it to "oExportParams.filterSettings"
+               */
+              onBeforeExportTableExtension(
+                /**
+                 * Object containing the table export info
+                 */
+                oExportParams: {
+                  /**
+                   * The filters in the exported file Note: Please make changes on "oExportParams.filterSettings" array only
+                   * when "Include filter settings" is selected. Otherwise, the changes will be ignored.
+                   */
+                  filterSettings: sap.ui.export.util.Filter[];
+                  /**
+                   * The value of "Include filter settings" checkbox
+                   */
+                  includeFilterSettings: boolean;
+                }
+              ): void;
+              /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements before binding a chart. Application developers can override
                * this method and programmatically modify parameters or filters before chart triggers a query to retrieve
                * data.
@@ -2060,6 +2168,8 @@ declare namespace sap {
                 oEvent: sap.ui.base.Event
               ): void;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements before binding a table. Application developers can override
                * this method and programmatically modify parameters or filters before the table triggers a query to retrieve
                * data.
@@ -2076,6 +2186,8 @@ declare namespace sap {
                 oEvent: sap.ui.base.Event
               ): void;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method should be implemented whenever application uses onListNavigationExtension for internal navigation.
                * In this case the implementation of this method should provide an 'inverse' mapping to the transformation
                * implemented within onListNavigationExtension. More precisely, the identification of a child page instance
@@ -2107,11 +2219,15 @@ declare namespace sap {
                 fnSetPath: Function
               ): void;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements on the initialization of View. Application developers can
                * override this method & perform internal setup in this hook, It is only called once per View instance.
                */
               onInit(): void;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements once the smart filter bar is initialized with a variant.
                *
                * Application developers can override this method when there is a custom filter field bound outside the
@@ -2130,6 +2246,8 @@ declare namespace sap {
                 oEvent: sap.ui.base.Event
               ): void;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called when the user leaves the app and this page has been displayed within the same app
                * session (this is the time since last opening the app) at least once. Moreover, it is called for all pages
                * that have been displayed within some app session when the app is finally destroyed.
@@ -2146,6 +2264,8 @@ declare namespace sap {
                 bIsDestroyed: boolean
               ): Function;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements when a chevron navigation is triggered from a table. Application
                * developers can override this method and perform conditional (internal or external) navigation from different
                * rows of a table. Such custom navigation should be triggered via corresponding methods of {@link sap.suite.ui.generic.template.extensionAPI.NavigationController
@@ -2171,6 +2291,8 @@ declare namespace sap {
                 bReplaceInHistory: boolean
               ): boolean;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements when the Share functionality is triggered. Application developers
                * can adapt the service URL passed as a parameter to this method. Adapted service URL will be used in the
                * 'Send Email' or 'Save as Tile' options.
@@ -2187,6 +2309,8 @@ declare namespace sap {
                 }
               ): void;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements while applying the AppState. This method should be overridden
                * in combination with `getCustomAppStateDataExtension`. The custom data retrieved from the AppState will
                * be passed as a parameter to this method. Application developers can use this custom data to restore the
@@ -2862,6 +2986,8 @@ declare namespace sap {
              */
             interface controllerFrameworkExtensions {
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements before triggering an external navigation. Application developers
                * can override this method and programmatically adapt the parameters which are passed to the target application.
                * Application developers can use the oObjectInfo parameter to identify the navigation context and modify
@@ -2887,11 +3013,15 @@ declare namespace sap {
                 }
               ): void;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements whenever the busy state is switched off. Application developers
                * can override this method, access the message model and adapt the transient messages related to the component.
                */
               adaptTransientMessageExtension(): void;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method will be called by SAP Fiori elements while applying the AppState. The custom state object
                * retrieved from the AppState will be passed as a parameter to this method. Application developers can
                * use this custom state for restoring the state of the custom control. To make a complete functionality,
@@ -2912,6 +3042,8 @@ declare namespace sap {
                 bIsSameAsLast: boolean
               ): void;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori element when Delete button on the Object Page is clicked. Application
                * developers can override this method & perform additional checks before executing the delete operation.
                * Method is expected to return a Promise. To veto the delete operation, promise needs to be rejected else
@@ -2921,6 +3053,8 @@ declare namespace sap {
                */
               beforeDeleteExtension(): Promise<any>;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called when the Delete operation is triggered on a table in the Object Page. Application
                * developers can override this method & perform additional checks before executing the delete operation.
                * Method is expected to return a Promise. Delete operation is executed only once the returned promise is
@@ -2946,6 +3080,8 @@ declare namespace sap {
                 }
               ): Promise<any>;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements when Save button is clicked. Application developers can override
                * this method & perform additional checks before executing the Save operation. Method is expected to return
                * a Promise. Save operation will be continued only once the promise is resolved. In case the extension
@@ -2955,6 +3091,8 @@ declare namespace sap {
                */
               beforeSaveExtension(): Promise<any>;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements when a smart link in a table or form is clicked. Application
                * developers can override this method and invoke the oParams.getSourceInfo method to find out the information
                * about the clicked smart link.
@@ -2981,6 +3119,33 @@ declare namespace sap {
                 }
               ): boolean;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
+               * 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.
+               *
+               * To add new filter entries to the exported file, create an instance of {@link sap.ui.export.util.Filter}
+               * and add it to "oExportParams.filterSettings"
+               */
+              onBeforeExportTableExtension(
+                /**
+                 * Object containing the table export info
+                 */
+                oExportParams: {
+                  /**
+                   * The filters in the exported file Note: Please make changes on "oExportParams.filterSettings" array only
+                   * when "Include filter settings" is selected. Otherwise, the changes will be ignored.
+                   */
+                  filterSettings: sap.ui.export.util.Filter[];
+                  /**
+                   * The value of "Include filter settings" checkbox
+                   */
+                  includeFilterSettings: boolean;
+                }
+              ): void;
+              /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements before binding a table. Application developers can override
                * this method and programmatically modify parameters or filters before the table triggers a query to retrieve
                * data. Source property of the oEvent shall be used to determine table triggering the event
@@ -2994,6 +3159,8 @@ declare namespace sap {
                 oEvent: sap.ui.base.Event
               ): void;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method should be implemented whenever application uses onListNavigationExtension for internal navigation.
                * In this case the implementation of this method should provide an 'inverse' mapping to the transformation
                * implemented within onListNavigationExtension. More precisely, the identification of a child page instance
@@ -3025,11 +3192,15 @@ declare namespace sap {
                 fnSetPath: Function
               ): void;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements on the initialization of View. Application developers can
                * override this method & perform internal setup in this hook.
                */
               onInit(): void;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called when the user leaves the app and this page has been displayed within the same app
                * session (this is the time since last opening the app) at least once. Moreover, it is called for all pages
                * that have been displayed within some app session when the app is finally destroyed.
@@ -3046,6 +3217,8 @@ declare namespace sap {
                 bIsDestroyed: boolean
               ): Function;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements when a chevron navigation is triggered from a table. Application
                * developers can override this method and perform conditional (internal or external) navigation from different
                * rows of a table. Such custom navigation should be triggered via corresponding methods of {@link sap.suite.ui.generic.template.extensionAPI.NavigationController
@@ -3071,6 +3244,8 @@ declare namespace sap {
                 bReplaceInHistory: boolean
               ): boolean;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called by SAP Fiori elements when the Share functionality is triggered. Application developers
                * can adapt the service URL passed as a parameter to this method. Adapted service URL will be used in the
                * 'Send Email' or 'Save as Tile' options.
@@ -3087,6 +3262,8 @@ declare namespace sap {
                 }
               ): void;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method is called when the SubSection enters the Viewport first time for an ObjectPage. Method would
                * be called again for the same SubSection only in case ObjectPage binding context is changed. Application
                * developers could use this method to perform specific actions on the current SubSection children. This
@@ -3100,6 +3277,8 @@ declare namespace sap {
                 oSubSection: sap.uxap.ObjectPageSubSection
               ): void;
               /**
+               * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+               *
                * This method will be called by SAP Fiori elements before persisting the AppState. Application developers
                * can override this method for persisting the state of custom controls. State of the custom controls should
                * be stored in the oState object passed as a parameter to this method. To make a complete functionality,