@sapui5/ts-types 1.142.1 → 1.143.0

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.142.0
+// For Library Version: 1.143.0
 
 declare namespace sap {
   namespace ui {
@@ -411,7 +411,9 @@ declare namespace sap {
         /**
          * Facade of the {@link sap.ui.integration.widgets.Card} control.
          *
-         * @experimental As of version 1.79.
+         * This facade contains methods accessible within the card extension. The available methods represent a
+         * limited subset of all card methods, since not all card methods function as expected when called from
+         * within the extension.
          */
         interface CardFacade {
           __implements__sap_ui_integration_widgets_CardFacade: boolean;
@@ -431,6 +433,27 @@ declare namespace sap {
              */
             oActionDefinition: sap.ui.integration.ActionDefinition
           ): this;
+          /**
+           * Destroys all the actionDefinitions in the aggregation {@link #getActionDefinitions actionDefinitions}.
+           *
+           * @since 1.85
+           * @experimental As of version 1.85. Disclaimer: this aggregation is in a beta state - incompatible API
+           * changes may be done before its official public release. Use at your own discretion.
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          destroyActionDefinitions(): this;
+          /**
+           * Gets content of aggregation {@link #getActionDefinitions actionDefinitions}.
+           *
+           * Actions definitions from which actions in the header menu of the card are created. **Note**: This aggregation
+           * is destroyed when the property `manifest` changes.
+           *
+           * @since 1.85
+           * @experimental As of version 1.85. Disclaimer: this aggregation is in a beta state - incompatible API
+           * changes may be done before its official public release. Use at your own discretion.
+           */
+          getActionDefinitions(): sap.ui.integration.ActionDefinition[];
           /**
            * Gets current value of property {@link #getBaseUrl baseUrl}.
            *
@@ -466,6 +489,11 @@ declare namespace sap {
            * @returns Object containing parameters in format `{parameterKey: parameterValue}`.
            */
           getCombinedParameters(): Record<string, any>;
+          /**
+           * @deprecated As of version 1.143. Do not access the card dom reference, as this is not supported in a
+           * mobile native environment.
+           */
+          getDomRef(): void;
           /**
            * Returns a value from the Manifest based on the specified path.
            *
@@ -481,15 +509,19 @@ declare namespace sap {
              */
             sPath: string
           ): any;
+          /**
+           * @deprecated As of version 1.143. Avoid accessing the models directly, use the binding syntax instead.
+           */
+          getModel(): void;
           /**
            * Gets current value of property {@link #getParameters parameters}.
            *
-           * Overrides the default values of the parameters, which are defined in the manifest. The value is an object
-           * containing parameters in format `{parameterKey: parameterValue}`.
+           * Overrides the default values of the parameters, which are defined in the manifest. The returned value
+           * is an object containing parameters in format `{parameterKey: parameterValue}`.
            *
-           * @experimental As of version 1.65. This property might be changed in future.
+           * @deprecated As of version 1.143. Use `getCombinedParameters()` instead.
            *
-           * @returns Value of property `parameters`
+           * @returns Value of property parameters
            */
           getParameters(): object;
           /**
@@ -684,6 +716,11 @@ declare namespace sap {
              */
             sKey: string
           ): Promise<string>;
+          /**
+           * @deprecated As of version 1.143. Use `hide()` to hide a card opened by `showCard()`. The card facade
+           * does not provide methods for showing or hiding the main card itself.
+           */
+          setVisible(): void;
           /**
            * Show blocking message in the card's content area. Should be used after the `manifestApplied` event or
            * after the `cardReady` lifecycle hook in Component cards and Extensions.
@@ -2557,8 +2594,6 @@ declare namespace sap {
 
       /**
        * Describes the settings that can be provided to the Host constructor.
-       *
-       * @experimental As of version 1.75.
        */
       interface $HostSettings extends sap.ui.core.$ElementSettings {
         /**
@@ -3602,7 +3637,6 @@ declare namespace sap {
        * Examples may include, but are not limited to options like: share a card, remove a card.
        *
        * @since 1.75
-       * @experimental As of version 1.75.
        */
       class Host extends sap.ui.core.Element {
         /**
@@ -4163,6 +4197,7 @@ declare namespace sap {
          * Editor.
          *
          * @since 1.83
+         * @experimental As of version 1.143.
          *
          * @returns A promise which contains the context structure.
          */
@@ -4179,6 +4214,7 @@ declare namespace sap {
          * userId: { value: "{context>sap.workzone/currentUser/id}" resolves to UserId } }
          *
          * @since 1.83
+         * @experimental As of version 1.143.
          *
          * @returns A promise which resolves with the value of this context.
          */

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.142.0
+// For Library Version: 1.143.0
 
 declare namespace sap {
   namespace ui {
@@ -39,7 +39,8 @@ declare namespace sap {
         interface $ColumnContainerDataSettings
           extends sap.ui.core.$LayoutDataSettings {
           /**
-           * Number of columns the `FormContainer` element uses if the `Form` control has extra-large size.
+           * Number of columns the {@link sap.ui.layout.form.FormContainer FormContainer} element uses if the {@link sap.ui.layout.form.Form Form }
+           * control has extra-large size.
            *
            * The number of columns for extra-large size must not be smaller than the number of columns for large size.
            */
@@ -49,7 +50,8 @@ declare namespace sap {
             | `{${string}}`;
 
           /**
-           * Number of columns the `FormContainer` element uses if the `Form` control has large size.
+           * Number of columns the {@link sap.ui.layout.form.FormContainer FormContainer} element uses if the {@link sap.ui.layout.form.Form Form }
+           * control has large size.
            *
            * The number of columns for large size must not be smaller than the number of columns for medium size.
            */
@@ -59,7 +61,8 @@ declare namespace sap {
             | `{${string}}`;
 
           /**
-           * Number of columns the `FormContainer` element uses if the `Form` control has medium size.
+           * Number of columns the {@link sap.ui.layout.form.FormContainer FormContainer} element uses if the {@link sap.ui.layout.form.Form Form }
+           * control has medium size.
            */
           columnsM?:
             | sap.ui.layout.form.ColumnsM
@@ -73,10 +76,10 @@ declare namespace sap {
         interface $ColumnElementDataSettings
           extends sap.ui.core.$LayoutDataSettings {
           /**
-           * Number of cells used by a field if the `FormElement` element is large. The label is then beside the fields
-           * per default.
+           * Number of cells used by a field if the {@link sap.ui.layout.form.FormElement FormElement} element is
+           * large. The label is then beside the fields per default.
            *
-           * If set to `12`, the full size of the `FormElement` element is used.
+           * If set to `12`, the full size of the {@link sap.ui.layout.form.FormElement FormElement} element is used.
            */
           cellsLarge?:
             | sap.ui.layout.form.ColumnCells
@@ -84,10 +87,10 @@ declare namespace sap {
             | `{${string}}`;
 
           /**
-           * Number of cells used by a field if the `FormElement` element is small. The label is then above the fields
-           * per default.
+           * Number of cells used by a field if the {@link sap.ui.layout.form.FormElement FormElement} element is
+           * small. The label is then above the fields per default.
            *
-           * If set to `12`, the full size of the `FormElement` is used.
+           * If set to `12`, the full size of the {@link sap.ui.layout.form.FormElement FormElement} is used.
            */
           cellsSmall?:
             | sap.ui.layout.form.ColumnCells
@@ -1103,10 +1106,12 @@ declare namespace sap {
         }
 
         /**
-         * The `ColumnLayout`-specific layout data for the `FormContainer` element.
+         * The {@link sap.ui.layout.form.ColumnLayout ColumnLayout}-specific layout data for the {@link sap.ui.layout.form.FormContainer FormContainer }
+         * element.
          *
-         * Depending on its size, the `Form` control is divided into 1, 2, 3 or 4 columns by the `ColumnLayout`
-         * control. Using `ColumnContainerData`, the size of the `FormContainer` element can be influenced.
+         * Depending on its size, the {@link sap.ui.layout.form.Form Form} control is divided into 1, 2, 3 or 4
+         * columns by the {@link sap.ui.layout.form.ColumnLayout ColumnLayout} control. Using `ColumnContainerData`,
+         * the size of the {@link sap.ui.layout.form.FormContainer FormContainer} element can be influenced.
          *
          * @since 1.56.0
          */
@@ -1179,7 +1184,8 @@ declare namespace sap {
           /**
            * Gets current value of property {@link #getColumnsL columnsL}.
            *
-           * Number of columns the `FormContainer` element uses if the `Form` control has large size.
+           * Number of columns the {@link sap.ui.layout.form.FormContainer FormContainer} element uses if the {@link sap.ui.layout.form.Form Form }
+           * control has large size.
            *
            * The number of columns for large size must not be smaller than the number of columns for medium size.
            *
@@ -1192,7 +1198,8 @@ declare namespace sap {
           /**
            * Gets current value of property {@link #getColumnsM columnsM}.
            *
-           * Number of columns the `FormContainer` element uses if the `Form` control has medium size.
+           * Number of columns the {@link sap.ui.layout.form.FormContainer FormContainer} element uses if the {@link sap.ui.layout.form.Form Form }
+           * control has medium size.
            *
            * Default value is `1`.
            *
@@ -1203,7 +1210,8 @@ declare namespace sap {
           /**
            * Gets current value of property {@link #getColumnsXL columnsXL}.
            *
-           * Number of columns the `FormContainer` element uses if the `Form` control has extra-large size.
+           * Number of columns the {@link sap.ui.layout.form.FormContainer FormContainer} element uses if the {@link sap.ui.layout.form.Form Form }
+           * control has extra-large size.
            *
            * The number of columns for extra-large size must not be smaller than the number of columns for large size.
            *
@@ -1216,7 +1224,8 @@ declare namespace sap {
           /**
            * Sets a new value for property {@link #getColumnsL columnsL}.
            *
-           * Number of columns the `FormContainer` element uses if the `Form` control has large size.
+           * Number of columns the {@link sap.ui.layout.form.FormContainer FormContainer} element uses if the {@link sap.ui.layout.form.Form Form }
+           * control has large size.
            *
            * The number of columns for large size must not be smaller than the number of columns for medium size.
            *
@@ -1236,7 +1245,8 @@ declare namespace sap {
           /**
            * Sets a new value for property {@link #getColumnsM columnsM}.
            *
-           * Number of columns the `FormContainer` element uses if the `Form` control has medium size.
+           * Number of columns the {@link sap.ui.layout.form.FormContainer FormContainer} element uses if the {@link sap.ui.layout.form.Form Form }
+           * control has medium size.
            *
            * When called with a value of `null` or `undefined`, the default value of the property will be restored.
            *
@@ -1254,7 +1264,8 @@ declare namespace sap {
           /**
            * Sets a new value for property {@link #getColumnsXL columnsXL}.
            *
-           * Number of columns the `FormContainer` element uses if the `Form` control has extra-large size.
+           * Number of columns the {@link sap.ui.layout.form.FormContainer FormContainer} element uses if the {@link sap.ui.layout.form.Form Form }
+           * control has extra-large size.
            *
            * The number of columns for extra-large size must not be smaller than the number of columns for large size.
            *
@@ -1273,10 +1284,12 @@ declare namespace sap {
           ): this;
         }
         /**
-         * The `ColumnLayout`-specific layout data for the `FormElement` content fields.
+         * The {@link sap.ui.layout.form.ColumnLayout ColumnLayout}-specific layout data for the {@link sap.ui.layout.form.Form Form }
+         * content fields.
          *
-         * One `FormElement` element contains 12 cells and has two sizes, small and large. Using `ColumnElementData`,
-         * the default calculation of the cells used for a field or label can be overwritten.
+         * One {@link sap.ui.layout.form.FormElement FormElement} element contains 12 cells and has two sizes, small
+         * and large. Using `ColumnElementData`, the default calculation of the cells used for a field or label
+         * can be overwritten.
          *
          * @since 1.56.0
          */
@@ -1346,10 +1359,10 @@ declare namespace sap {
           /**
            * Gets current value of property {@link #getCellsLarge cellsLarge}.
            *
-           * Number of cells used by a field if the `FormElement` element is large. The label is then beside the fields
-           * per default.
+           * Number of cells used by a field if the {@link sap.ui.layout.form.FormElement FormElement} element is
+           * large. The label is then beside the fields per default.
            *
-           * If set to `12`, the full size of the `FormElement` element is used.
+           * If set to `12`, the full size of the {@link sap.ui.layout.form.FormElement FormElement} element is used.
            *
            * Default value is `8`.
            *
@@ -1360,10 +1373,10 @@ declare namespace sap {
           /**
            * Gets current value of property {@link #getCellsSmall cellsSmall}.
            *
-           * Number of cells used by a field if the `FormElement` element is small. The label is then above the fields
-           * per default.
+           * Number of cells used by a field if the {@link sap.ui.layout.form.FormElement FormElement} element is
+           * small. The label is then above the fields per default.
            *
-           * If set to `12`, the full size of the `FormElement` is used.
+           * If set to `12`, the full size of the {@link sap.ui.layout.form.FormElement FormElement} is used.
            *
            * Default value is `12`.
            *
@@ -1374,10 +1387,10 @@ declare namespace sap {
           /**
            * Sets a new value for property {@link #getCellsLarge cellsLarge}.
            *
-           * Number of cells used by a field if the `FormElement` element is large. The label is then beside the fields
-           * per default.
+           * Number of cells used by a field if the {@link sap.ui.layout.form.FormElement FormElement} element is
+           * large. The label is then beside the fields per default.
            *
-           * If set to `12`, the full size of the `FormElement` element is used.
+           * If set to `12`, the full size of the {@link sap.ui.layout.form.FormElement FormElement} element is used.
            *
            * When called with a value of `null` or `undefined`, the default value of the property will be restored.
            *
@@ -1395,10 +1408,10 @@ declare namespace sap {
           /**
            * Sets a new value for property {@link #getCellsSmall cellsSmall}.
            *
-           * Number of cells used by a field if the `FormElement` element is small. The label is then above the fields
-           * per default.
+           * Number of cells used by a field if the {@link sap.ui.layout.form.FormElement FormElement} element is
+           * small. The label is then above the fields per default.
            *
-           * If set to `12`, the full size of the `FormElement` is used.
+           * If set to `12`, the full size of the {@link sap.ui.layout.form.FormElement FormElement} is used.
            *
            * When called with a value of `null` or `undefined`, the default value of the property will be restored.
            *
@@ -1442,7 +1455,7 @@ declare namespace sap {
          * of the used column. If there is enough space, the labels are beside the fields, otherwise above the fields.
          *
          * The default size of a content control of a {@link sap.ui.layout.form.FormElement FormElement} element
-         * can be overwritten using {@link sap.ui.layout.form.ColumnElementData ColumnElementData} as `LayoutData`.
+         * can be overwritten using {@link sap.ui.layout.form.ColumnElementData ColumnElementData} as {@link sap.ui.core.Element#setLayoutData LayoutData}.
          * If one control assigned to a {@link sap.ui.layout.form.FormElement FormElement} element has {@link sap.ui.layout.form.ColumnElementData ColumnElementData }
          * set, the size calculation of the other controls assigned to the {@link sap.ui.layout.form.FormElement FormElement }
          * element might not lead to the expected result. In this case, use {@link sap.ui.layout.form.ColumnElementData ColumnElementData }
@@ -1453,7 +1466,7 @@ declare namespace sap {
          * results than might be expected.
          *
          * **Note:** This control cannot be used stand-alone, it just renders a {@link sap.ui.layout.form.Form Form }
-         * control, so it must be assigned to a {@link sap.ui.layout.form.Form Form} control using the `layout`
+         * control, so it must be assigned to a {@link sap.ui.layout.form.Form Form} control using the {@link sap.ui.layout.form.Form#setLayout layout }
          * aggregation.
          *
          * @since 1.56.0
@@ -5376,8 +5389,9 @@ declare namespace sap {
           ResponsiveLayout = "ResponsiveLayout",
         }
         /**
-         * An `int` type that defines how many cells a control inside of a column of a `Form` control using the
-         * `ColumnLayout` control as layout can use.
+         * An `int` type that defines how many cells a control inside of a column of a {@link sap.ui.layout.form.Form Form }
+         * control using the {@link sap.ui.layout.form.ColumnLayout ColumnLayout} control as {@link sap.ui.layout.form.FormE#setLayout layout }
+         * can use.
          *
          * Allowed values are numbers from 1 to 12 and -1. -1 means the value is calculated.
          *
@@ -5386,8 +5400,9 @@ declare namespace sap {
         type ColumnCells = int;
 
         /**
-         * An `int` type that defines how many columns a `Form` control using the `ColumnLayout` as layout can have
-         * if it has large size
+         * An `int` type that defines how many columns a {@link sap.ui.layout.form.Form Form} control using the
+         * {@link sap.ui.layout.form.ColumnLayout ColumnLayout} as {@link sap.ui.layout.form.FormE#setLayout layout }
+         * can have if it has large size
          *
          * Allowed values are numbers from 1 to 4. **Note:** In versions lower than 1.122 only 3 columns are allowed.
          *
@@ -5396,8 +5411,9 @@ declare namespace sap {
         type ColumnsL = int;
 
         /**
-         * An `int` type that defines how many columns a `Form` control using the `ColumnLayout` as layout can have
-         * if it has medium size
+         * An `int` type that defines how many columns a {@link sap.ui.layout.form.Form Form} control using the
+         * {@link sap.ui.layout.form.ColumnLayout ColumnLayout} as {@link sap.ui.layout.form.FormE#setLayout layout }
+         * can have if it has medium size
          *
          * Allowed values are numbers from 1 to 3. **Note:** In versions lower than 1.122 only 2 columns are allowed.
          *
@@ -5406,8 +5422,9 @@ declare namespace sap {
         type ColumnsM = int;
 
         /**
-         * An `int` type that defines how many columns a `Form` control using the `ColumnLayout` as layout can have
-         * if it has extra-large size
+         * An `int` type that defines how many columns a {@link sap.ui.layout.form.Form Form} control using the
+         * {@link sap.ui.layout.form.ColumnLayout ColumnLayout} as {@link sap.ui.layout.form.FormE#setLayout layout }
+         * can have if it has extra-large size
          *
          * Allowed values are numbers from 1 to 6. **Note:** In versions lower than 1.89 only 4 columns are allowed.
          *
@@ -5416,8 +5433,9 @@ declare namespace sap {
         type ColumnsXL = int;
 
         /**
-         * An `int` type that defines how many cells beside the controls inside of a column of a `Form` control
-         * using the `ColumnLayout` control as layout are empty.
+         * An `int` type that defines how many cells beside the controls inside of a column of a {@link sap.ui.layout.form.Form Form }
+         * control using the {@link sap.ui.layout.form.ColumnLayout ColumnLayout} control as {@link sap.ui.layout.form.FormE#setLayout layout }
+         * are empty.
          *
          * Allowed values are numbers from 0 to 11.
          *