@sapui5/ts-types 1.145.1 → 1.147.0

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.145.1
+// For Library Version: 1.147.0
 
 declare namespace sap {
   namespace ui {

package/types/{mdc-1.145.0-d.ts → sap.ui.mdc.d.ts}

@@ -1,4 +1,4 @@
-// For Library Version: 1.145.0
+// For Library Version: 1.147.0
 
 declare module "sap/ui/mdc/AggregationBaseDelegate" {
   import BaseDelegate from "sap/ui/mdc/BaseDelegate";
@@ -9880,8 +9880,10 @@ declare namespace sap {
         interface $FilterBarBaseSettings extends sap.ui.mdc.$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
@@ -9952,8 +9954,8 @@ declare namespace sap {
            * 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.
            *
@@ -10149,6 +10151,28 @@ declare namespace sap {
              */
             oInvisibleText: sap.ui.core.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: sap.ui.core.MessageType
+          ): sap.ui.core.message.Message;
           /**
            * Attaches event handler `fnFunction` to the {@link #event:filtersChanged filtersChanged} event of this
            * `sap.ui.mdc.filterbar.FilterBarBase`.
@@ -10395,8 +10419,10 @@ declare namespace sap {
            * 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
@@ -10454,6 +10480,19 @@ declare namespace sap {
            * @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
+          ): sap.ui.core.message.Message[];
           /**
            * Gets the value of the basic search condition.
            *
@@ -10531,6 +10570,30 @@ declare namespace sap {
            * @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: sap.ui.core.Message
+          ): 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}.
            *
@@ -10547,8 +10610,10 @@ declare namespace sap {
            * 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
@@ -10957,7 +11022,7 @@ declare namespace sap {
           visible?: boolean;
           /**
            * Key of the group in which the property is located. Used to visually group properties in personalization
-           * dialogs.
+           * dialogs. The group with the `basic` key is always shown as the first group.
            */
           group?: string;
           /**
@@ -19744,8 +19809,10 @@ declare namespace sap {
 
         /**
          * 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
@@ -20020,7 +20087,8 @@ declare namespace sap {
       interface $ControlSettings extends sap.ui.core.$ControlSettings {
         /**
          * 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:
@@ -20045,7 +20113,8 @@ declare namespace sap {
       interface $ElementSettings extends sap.ui.core.$ElementSettings {
         /**
          * 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:
@@ -20476,7 +20545,8 @@ declare namespace sap {
         /**
          * 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
@@ -21609,8 +21679,10 @@ declare namespace sap {
          * 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
@@ -21942,8 +22014,10 @@ declare namespace sap {
          * 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
@@ -25677,7 +25751,8 @@ declare namespace sap {
          *
          * 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
@@ -26238,7 +26313,8 @@ declare namespace sap {
          *
          * 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
@@ -27178,6 +27254,17 @@ declare namespace sap {
         ): this;
       }
 
+      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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.145.1
+// For Library Version: 1.147.0
 
 declare namespace sap {
   namespace ui {
@@ -278,7 +278,7 @@ declare namespace sap {
          * Defines the footer of the control. The footer will be available only with custom toolbar. **Note:** The
          * footer aggregation accepts only controls inheriting `sap.m.IBar`.
          *
-         * @experimental As of version 1.135.
+         * @since 1.135
          */
         footer?: sap.ui.core.Control;
 
@@ -874,7 +874,7 @@ declare namespace sap {
         /**
          * Destroys the footer in the aggregation {@link #getFooter footer}.
          *
-         * @experimental As of version 1.135.
+         * @since 1.135
          *
          * @returns Reference to `this` in order to allow method chaining
          */
@@ -1123,7 +1123,7 @@ declare namespace sap {
          * Defines the footer of the control. The footer will be available only with custom toolbar. **Note:** The
          * footer aggregation accepts only controls inheriting `sap.m.IBar`.
          *
-         * @experimental As of version 1.135.
+         * @since 1.135
          */
         getFooter(): sap.ui.core.Control;
         /**
@@ -1632,7 +1632,7 @@ declare namespace sap {
         /**
          * Sets the aggregated {@link #getFooter footer}.
          *
-         * @experimental As of version 1.135.
+         * @since 1.135
          *
          * @returns Reference to `this` in order to allow method chaining
          */
@@ -2201,7 +2201,7 @@ declare namespace sap {
         /**
          * Uses TinyMCE version 6 as editor
          *
-         * @deprecated As of version 1.141. TinyMCE 6 is no longer supported. Use the {@link sap.ui.richtexteditor.EditorType.TinyMCE }
+         * @deprecated As of version 1.136.13. TinyMCE 6 is no longer supported. Use the {@link sap.ui.richtexteditor.EditorType.TinyMCE }
          * instead.
          */
         TinyMCE6 = "TinyMCE6",

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.145.1
+// For Library Version: 1.147.0
 
 declare module "sap/ui/rta/api/startAdaptation" {
   /**

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.145.1
+// For Library Version: 1.147.0
 
 declare namespace sap {
   namespace ui {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.145.1
+// For Library Version: 1.147.0
 
 declare namespace sap {
   namespace ui {
@@ -398,7 +398,7 @@ declare namespace sap {
         /**
          * 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.145.1
+// For Library Version: 1.147.0
 
 declare namespace sap {
   namespace ui {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.145.1
+// For Library Version: 1.147.0
 
 declare namespace sap {
   interface IUI5DefineDependencyNames {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.145.1
+// For Library Version: 1.147.0
 
 declare namespace sap {
   namespace ui {
@@ -7454,6 +7454,9 @@ declare namespace sap {
         /**
          * Allows users to upload all files from a given directory and its corresponding subdirectories.
          *
+         * **Note:** This feature is supported on all WebKit-based browsers as well as Microsoft Edge and Firefox
+         * after version 50. **Note:** Multiple directory selection is not supported.
+         *
          * @since 1.105.0
          */
         directory?:
@@ -7464,6 +7467,10 @@ declare namespace sap {
         /**
          * Indicates whether the file uploader is required.
          *
+         * **Note:** The control can be marked as required either by setting this property to `true` or by using
+         * the legacy approach of setting the `required` property to `true` on a `sap.m.Label` that has its `labelFor`
+         * property pointing to this control.
+         *
          * @since 1.144
          */
         required?:
@@ -8321,7 +8328,7 @@ declare namespace sap {
       /**
        * Describes the settings that can be provided to the TimeRange constructor.
        *
-       * @experimental As of version 1.127.0.
+       * @experimental As of version 1.127.
        */
       interface $TimeRangeSettings extends sap.ui.core.$ElementSettings {
         /**
@@ -16953,6 +16960,9 @@ declare namespace sap {
          *
          * Allows users to upload all files from a given directory and its corresponding subdirectories.
          *
+         * **Note:** This feature is supported on all WebKit-based browsers as well as Microsoft Edge and Firefox
+         * after version 50. **Note:** Multiple directory selection is not supported.
+         *
          * Default value is `false`.
          *
          * @since 1.105.0
@@ -16995,7 +17005,7 @@ declare namespace sap {
          *
          * Chosen HTTP request method for file upload.
          *
-         * Default value is `Post`.
+         * Default value is `POST`.
          *
          * @since 1.81.0
          *
@@ -17184,6 +17194,10 @@ declare namespace sap {
          *
          * Indicates whether the file uploader is required.
          *
+         * **Note:** The control can be marked as required either by setting this property to `true` or by using
+         * the legacy approach of setting the `required` property to `true` on a `sap.m.Label` that has its `labelFor`
+         * property pointing to this control.
+         *
          * Default value is `false`.
          *
          * @since 1.144
@@ -17526,6 +17540,9 @@ declare namespace sap {
          *
          * Allows users to upload all files from a given directory and its corresponding subdirectories.
          *
+         * **Note:** This feature is supported on all WebKit-based browsers as well as Microsoft Edge and Firefox
+         * after version 50. **Note:** Multiple directory selection is not supported.
+         *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
          * Default value is `false`.
@@ -17585,7 +17602,7 @@ declare namespace sap {
          *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
-         * Default value is `Post`.
+         * Default value is `POST`.
          *
          * @since 1.81.0
          *
@@ -17820,6 +17837,10 @@ declare namespace sap {
          *
          * Indicates whether the file uploader is required.
          *
+         * **Note:** The control can be marked as required either by setting this property to `true` or by using
+         * the legacy approach of setting the `required` property to `true` on a `sap.m.Label` that has its `labelFor`
+         * property pointing to this control.
+         *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
          * Default value is `false`.
@@ -19976,7 +19997,6 @@ declare namespace sap {
       /**
        * NonWorkingPeriod
        *
-       * @since 1.27.0
        * @experimental As of version 1.127.0.
        */
       class NonWorkingPeriod extends sap.ui.core.Element {
@@ -20105,7 +20125,6 @@ declare namespace sap {
        *
        * Applications can inherit from this element to add own fields.
        *
-       * @since 1.127.0
        * @experimental As of version 1.127.0.
        */
       class RecurringNonWorkingPeriod extends sap.ui.unified.NonWorkingPeriod {
@@ -22497,8 +22516,7 @@ declare namespace sap {
       /**
        * Time range for use in `NonWorkingPeriod`
        *
-       * @since 1.127.0
-       * @experimental As of version 1.127.0.
+       * @experimental As of version 1.127.
        */
       class TimeRange extends sap.ui.core.Element {
         /**
@@ -22693,7 +22711,6 @@ declare namespace sap {
        * 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.
        */
       enum CalendarAppointmentRoundWidth {
@@ -22911,8 +22928,9 @@ declare namespace sap {
        * 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.
        */
       enum ContentSwitcherAnimation {
         /**
@@ -22953,10 +22971,22 @@ declare namespace sap {
         /**
          * HTTP request POST method.
          */
+        POST = "POST",
+        /**
+         * HTTP request POST method.
+         *
+         * @deprecated As of version 1.145.0. use {@link sap.ui.unified.FileUploaderHttpRequestMethod.POST} instead
+         */
         Post = "POST",
         /**
          * HTTP request PUT method.
          */
+        PUT = "PUT",
+        /**
+         * HTTP request PUT method.
+         *
+         * @deprecated As of version 1.145.0. use {@link sap.ui.unified.FileUploaderHttpRequestMethod.PUT} instead
+         */
         Put = "PUT",
       }
       /**

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.145.1
+// For Library Version: 1.147.0
 
 declare namespace sap {
   namespace ui {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.145.0
+// For Library Version: 1.147.0
 
 declare namespace sap {
   namespace ui {
@@ -564,9 +564,6 @@ declare namespace sap {
 
       /**
        * 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.
        */
       interface $ContainerLegendItemSettings
         extends sap.m.$StandardListItemSettings {
@@ -1159,9 +1156,6 @@ declare namespace sap {
 
       /**
        * 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.
        */
       interface $ListPanelSettings extends sap.ui.core.$ControlSettings {
         /**
@@ -1233,9 +1227,6 @@ declare namespace sap {
 
       /**
        * 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.
        */
       interface $ListPanelStackSettings extends sap.ui.core.$ControlSettings {
         /**
@@ -1559,8 +1550,7 @@ declare namespace sap {
          * 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?:
           | sap.ui.vbm.RouteType
@@ -7430,8 +7420,7 @@ declare namespace sap {
       /**
        * 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
        */
       class ContainerLegendItem extends sap.m.StandardListItem {
         /**
@@ -10471,8 +10460,7 @@ declare namespace sap {
         /**
          * 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.
          */
@@ -12213,8 +12201,7 @@ declare namespace sap {
       /**
        * 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
        */
       class ListPanel extends sap.ui.core.Control {
         /**
@@ -12847,8 +12834,7 @@ declare namespace sap {
       /**
        * 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
        */
       class ListPanelStack extends sap.ui.core.Control {
         /**
@@ -14878,8 +14864,7 @@ declare namespace sap {
          *
          * 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`
          */
@@ -15192,8 +15177,7 @@ declare namespace sap {
          *
          * 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
          */