@sapui5/ts-types-esm 1.146.0 → 1.147.0

package/types/sap.ui.mdc.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.146.0
+// For Library Version: 1.147.0
 
 declare module "sap/ui/mdc/AggregationBaseDelegate" {
   import BaseDelegate from "sap/ui/mdc/BaseDelegate";
@@ -3767,6 +3767,17 @@ declare module "sap/ui/mdc/library" {
 
   import ParseException from "sap/ui/model/ParseException";
 
+  export type DelegateConfig = {
+    /**
+     * Delegate module path
+     */
+    name: string;
+    /**
+     * defines application-specific information that can be used in the given delegate
+     */
+    payload?: any;
+  };
+
   /**
    * Acts a subset of the `FilterBarDelegate` that can be used in {@link module:sap/ui/mdc/TableDelegate.getFilterDelegate TableDelegate.getFilterDelegate }
    * or {@link module:sap/ui/mdc/ChartDelegate.getFilterDelegate Chart.getFilterDelegate} to enable inbuilt
@@ -4819,8 +4830,10 @@ declare module "sap/ui/mdc/Chart" {
      * Gets current value of property {@link #getDelegate delegate}.
      *
      * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
-     *  The object has the following properties:
-     * 	 - `name` defines the path to the `Delegate` module
+     *  The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
+     *
+     * 	 - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/ChartDelegate ChartDelegate}.
+     *
      * 	 - `payload` (optional) defines application-specific information that can be used in the given delegate
      *      Sample delegate object:
      * ```javascript
@@ -5152,8 +5165,10 @@ declare module "sap/ui/mdc/Chart" {
      * Sets a new value for property {@link #getDelegate delegate}.
      *
      * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
-     *  The object has the following properties:
-     * 	 - `name` defines the path to the `Delegate` module
+     *  The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
+     *
+     * 	 - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/ChartDelegate ChartDelegate}.
+     *
      * 	 - `payload` (optional) defines application-specific information that can be used in the given delegate
      *      Sample delegate object:
      * ```javascript
@@ -5518,8 +5533,10 @@ declare module "sap/ui/mdc/Chart" {
 
     /**
      * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
-     *  The object has the following properties:
-     * 	 - `name` defines the path to the `Delegate` module
+     *  The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
+     *
+     * 	 - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/ChartDelegate ChartDelegate}.
+     *
      * 	 - `payload` (optional) defines application-specific information that can be used in the given delegate
      *      Sample delegate object:
      * ```javascript
@@ -7769,7 +7786,8 @@ declare module "sap/ui/mdc/Control" {
   export interface $ControlSettings extends $ControlSettings1 {
     /**
      * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
-     *  The object has the following properties:
+     *  The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
+     *
      * 	 - `name` defines the path to the `Delegate` module
      * 	 - `payload` (optional) defines application-specific information that can be used in the given delegate
      *      Sample delegate object:
@@ -7991,7 +8009,8 @@ declare module "sap/ui/mdc/Element" {
   export interface $ElementSettings extends $ElementSettings1 {
     /**
      * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
-     *  The object has the following properties:
+     *  The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
+     *
      * 	 - `name` defines the path to the `Delegate` module
      * 	 - `payload` (optional) defines application-specific information that can be used in the given delegate
      *      Sample delegate object:
@@ -13483,13 +13502,17 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
 
   import InvisibleText from "sap/ui/core/InvisibleText";
 
+  import { MessageType, ID } from "sap/ui/core/library";
+
+  import Message from "sap/ui/core/message/Message";
+
   import FilterBarValidationStatus from "sap/ui/mdc/enums/FilterBarValidationStatus";
 
   import FilterField from "sap/ui/mdc/FilterField";
 
   import ElementMetadata from "sap/ui/core/ElementMetadata";
 
-  import { ID } from "sap/ui/core/library";
+  import Message1 from "sap/ui/core/Message";
 
   import VariantManagement from "sap/ui/fl/variants/VariantManagement";
 
@@ -13588,6 +13611,28 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
        */
       oInvisibleText: InvisibleText
     ): void;
+    /**
+     * Adds a message to the {@link sap.ui.model.message.MessageModel MessageModel} for a `propertyKey`. The
+     * message is displayed on the corresponding {@link sap.ui.mdc.FilterField FilterField}.
+     *
+     * @since 1.147
+     *
+     * @returns The created message object
+     */
+    addMessage(
+      /**
+       * The `propertyKey` of the {@link sap.ui.mdc.FilterField FilterField}
+       */
+      sPropertyKey: string,
+      /**
+       * The message text
+       */
+      sMessage: string,
+      /**
+       * The message type
+       */
+      sMessageType: MessageType | keyof typeof MessageType
+    ): Message;
     /**
      * Attaches event handler `fnFunction` to the {@link #event:filtersChanged filtersChanged} event of this
      * `sap.ui.mdc.filterbar.FilterBarBase`.
@@ -13834,8 +13879,10 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
      * Gets current value of property {@link #getDelegate delegate}.
      *
      * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
-     *  The object has the following properties:
-     * 	 - `name` defines the path to the `Delegate` module
+     *  The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
+     *
+     * 	 - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/FilterBarDelegate FilterBarDelegate}.
+     *
      * 	 - `payload` (optional) defines application-specific information that can be used in the given delegate
      *      Sample delegate object:
      * ```javascript
@@ -13893,6 +13940,19 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
      * @returns Value of property `liveMode`
      */
     getLiveMode(): boolean;
+    /**
+     * Returns all messages associated with the given `propertyKey` from the {@link sap.ui.model.message.MessageModel MessageModel}.
+     *
+     * @since 1.147
+     *
+     * @returns Array of messages for the given `propertyKey`
+     */
+    getMessages(
+      /**
+       * The `propertyKey` of the {@link sap.ui.mdc.FilterField FilterField}
+       */
+      sPropertyKey: string
+    ): Message[];
     /**
      * Gets the value of the basic search condition.
      *
@@ -13970,6 +14030,30 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
      * @returns Resolves after the initial filters have been applied and the metadata has been obtained
      */
     initializedWithMetadata(): Promise<any>;
+    /**
+     * Removes a given message from the {@link sap.ui.model.message.MessageModel MessageModel}. The message
+     * is removed from the corresponding {@link sap.ui.mdc.FilterField FilterField}.
+     *
+     * @since 1.147
+     */
+    removeMessage(
+      /**
+       * The message to remove
+       */
+      oMessage: Message1
+    ): void;
+    /**
+     * Removes all messages for the given `propertyKey` from the {@link sap.ui.model.message.MessageModel MessageModel}.
+     * Clears the messages from the corresponding {@link sap.ui.mdc.FilterField FilterField}.
+     *
+     * @since 1.147
+     */
+    removeMessages(
+      /**
+       * The `propertyKey` of the {@link sap.ui.mdc.FilterField FilterField}
+       */
+      sPropertyKey: string
+    ): void;
     /**
      * Sets the aggregated {@link #getBasicSearchField basicSearchField}.
      *
@@ -13986,8 +14070,10 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
      * Sets a new value for property {@link #getDelegate delegate}.
      *
      * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
-     *  The object has the following properties:
-     * 	 - `name` defines the path to the `Delegate` module
+     *  The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
+     *
+     * 	 - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/FilterBarDelegate FilterBarDelegate}.
+     *
      * 	 - `payload` (optional) defines application-specific information that can be used in the given delegate
      *      Sample delegate object:
      * ```javascript
@@ -14141,8 +14227,10 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
   export interface $FilterBarBaseSettings extends $ControlSettings {
     /**
      * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
-     *  The object has the following properties:
-     * 	 - `name` defines the path to the `Delegate` module
+     *  The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
+     *
+     * 	 - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/FilterBarDelegate FilterBarDelegate}.
+     *
      * 	 - `payload` (optional) defines application-specific information that can be used in the given delegate
      *      Sample delegate object:
      * ```javascript
@@ -14198,8 +14286,8 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" {
      * aggregation) should be specified here, rather than in the `FilterField` configuration.
      *  **Note**: This property must not be bound.
      *  **Node**: Please check {@link sap.ui.mdc.filterbar.PropertyInfo} for more information about the supported
-     * inner elements. **Note**: Existing properties (set via `sap.ui.mdc.filterbar.FilterBarBase#setPropertyInfo`)
-     * must not be removed and their attributes must not be changed during the {@link module:sap/ui/mdc/FilterBarDelegate.fetchProperties fetchProperties }
+     * inner elements. **Note**: Existing properties (set via {@link #setPropertyInfo setPropertyInfo}) must
+     * not be removed and their attributes must not be changed during the {@link module:sap/ui/mdc/FilterBarDelegate.fetchProperties fetchProperties }
      * callback. Otherwise validation errors might occur whenever personalization-related control features (such
      * as the opening of any personalization dialog) are activated.
      *
@@ -18088,7 +18176,8 @@ declare module "sap/ui/mdc/Table" {
      *
      * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
      *
-     * The object has the following properties:
+     * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
+     *
      * 	 - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/TableDelegate TableDelegate}.
      *
      * 	 - `payload` (optional) defines application-specific information that can be used in the given delegate
@@ -18649,7 +18738,8 @@ declare module "sap/ui/mdc/Table" {
      *
      * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
      *
-     * The object has the following properties:
+     * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
+     *
      * 	 - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/TableDelegate TableDelegate}.
      *
      * 	 - `payload` (optional) defines application-specific information that can be used in the given delegate
@@ -19325,7 +19415,8 @@ declare module "sap/ui/mdc/Table" {
     /**
      * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic.
      *
-     * The object has the following properties:
+     * The object has the following properties (see {@link sap.ui.mdc.DelegateConfig DelegateConfig}):
+     *
      * 	 - `name` defines the path to the `Delegate` module. The used delegate module must inherit from {@link module:sap/ui/mdc/TableDelegate TableDelegate}.
      *
      * 	 - `payload` (optional) defines application-specific information that can be used in the given delegate

package/types/sap.ui.richtexteditor.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.146.0
+// For Library Version: 1.147.0
 
 declare module "sap/ui/richtexteditor/library" {
   /**

package/types/sap.ui.rta.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.146.0
+// For Library Version: 1.147.0
 
 declare module "sap/ui/rta/api/startAdaptation" {
   import Control from "sap/ui/core/Control";

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.146.0
+// For Library Version: 1.147.0
 
 declare module "sap/ui/suite/library" {
   /**

package/types/sap.ui.support.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.146.0
+// For Library Version: 1.147.0
 
 declare module "sap/ui/support/library" {
   /**
@@ -166,7 +166,7 @@ declare module "sap/ui/support/library" {
     /**
      * Preset to find usages of deprecated controls, properties, aggregations and others.
      *
-     * @experimental As of version 1.120.
+     * @since 1.120
      */
     Deprecations = "undefined",
   }

package/types/sap.ui.table.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.146.0
+// For Library Version: 1.147.0
 
 declare module "sap/ui/table/library" {
   import TreeAutoExpandMode1 from "sap/ui/model/TreeAutoExpandMode";

package/types/sap.ui.testrecorder.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.146.0
+// For Library Version: 1.147.0
 
 declare module "sap/ui/testrecorder/library" {}
 

package/types/sap.ui.unified.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.146.0
+// For Library Version: 1.147.0
 
 declare module "sap/ui/unified/library" {
   /**
@@ -33,7 +33,6 @@ declare module "sap/ui/unified/library" {
    * This enum is part of the 'sap/ui/unified/library' module export and must be accessed by the property
    * 'CalendarAppointmentRoundWidth'.
    *
-   * @since 1.81.0
    * @experimental As of version 1.81.0.
    */
   export enum CalendarAppointmentRoundWidth {
@@ -232,8 +231,9 @@ declare module "sap/ui/unified/library" {
    * This enum is part of the 'sap/ui/unified/library' module export and must be accessed by the property
    * 'ContentSwitcherAnimation'.
    *
-   * @since 1.16.0
-   * @experimental As of version 1.16.0. API is not yet finished and might change completely
+   * @deprecated As of version 1.147.0. the concept has been discarded. API is not yet finished and might
+   * change completely
+   * @experimental As of version 1.16.0.
    */
   export enum ContentSwitcherAnimation {
     /**
@@ -20245,7 +20245,6 @@ declare module "sap/ui/unified/NonWorkingPeriod" {
   /**
    * NonWorkingPeriod
    *
-   * @since 1.27.0
    * @experimental As of version 1.127.0.
    */
   export default class NonWorkingPeriod extends UI5Element {
@@ -20404,7 +20403,6 @@ declare module "sap/ui/unified/RecurringNonWorkingPeriod" {
    *
    * Applications can inherit from this element to add own fields.
    *
-   * @since 1.127.0
    * @experimental As of version 1.127.0.
    */
   export default class RecurringNonWorkingPeriod extends NonWorkingPeriod {
@@ -23266,8 +23264,7 @@ declare module "sap/ui/unified/TimeRange" {
   /**
    * Time range for use in `NonWorkingPeriod`
    *
-   * @since 1.127.0
-   * @experimental As of version 1.127.0.
+   * @experimental As of version 1.127.
    */
   export default class TimeRange extends UI5Element {
     /**
@@ -23433,7 +23430,7 @@ declare module "sap/ui/unified/TimeRange" {
   /**
    * Describes the settings that can be provided to the TimeRange constructor.
    *
-   * @experimental As of version 1.127.0.
+   * @experimental As of version 1.127.
    */
   export interface $TimeRangeSettings extends $ElementSettings {
     /**

package/types/sap.ui.ux3.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.146.0
+// For Library Version: 1.147.0
 
 declare module "sap/ui/ux3/library" {
   /**

package/types/sap.ui.vbm.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.146.0
+// For Library Version: 1.147.0
 
 declare module "sap/ui/vbm/library" {
   /**
@@ -5405,8 +5405,7 @@ declare module "sap/ui/vbm/ContainerLegendItem" {
   /**
    * Legend item control
    *
-   * @experimental As of version 1.38.0. This class is experimental and might be modified or removed in future
-   * versions.
+   * @since 1.38.0
    */
   export default class ContainerLegendItem extends StandardListItem {
     /**
@@ -5524,9 +5523,6 @@ declare module "sap/ui/vbm/ContainerLegendItem" {
   }
   /**
    * Describes the settings that can be provided to the ContainerLegendItem constructor.
-   *
-   * @experimental As of version 1.38.0. This class is experimental and might be modified or removed in future
-   * versions.
    */
   export interface $ContainerLegendItemSettings
     extends $StandardListItemSettings {
@@ -8869,8 +8865,7 @@ declare module "sap/ui/vbm/GeoMap" {
     /**
      * Trigger the interactive creation mode to get a position or position array.
      *
-     * @experimental As of version 1.30.0. This method is experimental and might be modified or removerd in
-     * future versions.
+     * @since 1.30.0
      *
      * @returns Indicator whether the creation mode could be triggered successfully or not.
      */
@@ -11311,8 +11306,7 @@ declare module "sap/ui/vbm/ListPanel" {
   /**
    * Aggregation control for the Legend
    *
-   * @experimental As of version 1.38.0. This class is experimental and might be modified or removed in future
-   * versions.
+   * @since 1.38.0
    */
   export default class ListPanel extends Control {
     /**
@@ -11944,9 +11938,6 @@ declare module "sap/ui/vbm/ListPanel" {
   }
   /**
    * Describes the settings that can be provided to the ListPanel constructor.
-   *
-   * @experimental As of version 1.38.0. This class is experimental and might be modified or removed in future
-   * versions.
    */
   export interface $ListPanelSettings extends $ControlSettings {
     /**
@@ -12103,8 +12094,7 @@ declare module "sap/ui/vbm/ListPanelStack" {
   /**
    * ListPanelStack control
    *
-   * @experimental As of version 1.38.0. This class is experimental and might be modified or removed in future
-   * versions.
+   * @since 1.38.0
    */
   export default class ListPanelStack extends Control {
     /**
@@ -12363,9 +12353,6 @@ declare module "sap/ui/vbm/ListPanelStack" {
   }
   /**
    * Describes the settings that can be provided to the ListPanelStack constructor.
-   *
-   * @experimental As of version 1.38.0. This class is experimental and might be modified or removed in future
-   * versions.
    */
   export interface $ListPanelStackSettings extends $ControlSettings {
     /**
@@ -14494,8 +14481,7 @@ declare module "sap/ui/vbm/Route" {
      *
      * Default value is `'Straight'`.
      *
-     * @experimental As of version 1.32.0. this method is experimental and might be modified or removed in future
-     * versions.
+     * @since 1.32.0
      *
      * @returns Value of property `routetype`
      */
@@ -14808,8 +14794,7 @@ declare module "sap/ui/vbm/Route" {
      *
      * Default value is `'Straight'`.
      *
-     * @experimental As of version 1.32.0. this method is experimental and might be modified or removed in future
-     * versions.
+     * @since 1.32.0
      *
      * @returns Reference to `this` in order to allow method chaining
      */
@@ -14904,8 +14889,7 @@ declare module "sap/ui/vbm/Route" {
      * Defines the type of the route, default is 'Straight'. Other types are 'Geodesic' which show the shortest
      * path between two points, e.g. flightroutes
      *
-     * @experimental As of version 1.32.0. this method is experimental and might be modified or removed in future
-     * versions.
+     * @since 1.32.0
      */
     routetype?:
       | (RouteType | keyof typeof RouteType)

package/types/sap.ui.vk.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.146.0
+// For Library Version: 1.147.0
 
 declare module "sap/ui/vk/library" {
   /**

package/types/sap.ui.vtm.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.146.0
+// For Library Version: 1.147.0
 
 declare module "sap/ui/vtm/library" {
   import Vtm from "sap/ui/vtm/Vtm";

package/types/sap.uiext.inbox.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.146.0
+// For Library Version: 1.147.0
 
 declare module "sap/uiext/inbox/library" {}