@openui5/ts-types 1.115.1 → 1.117.0

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

@@ -1,3 +1,3 @@
-// For Library Version: 1.115.1
+// For Library Version: 1.117.0
 
 declare namespace sap {}

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.115.1
+// For Library Version: 1.117.0
 
 declare namespace sap {
   namespace ui {
@@ -57,15 +57,6 @@ declare namespace sap {
             | sap.ui.base.ManagedObject.PropertyBindingInfo
             | `{${string}}`;
 
-          /**
-           * If set to `true`, the key for a vendor variant will be added manually.
-           *   **Note:** This flag is only used internally.
-           */
-          manualVariantKey?:
-            | boolean
-            | sap.ui.base.ManagedObject.PropertyBindingInfo
-            | `{${string}}`;
-
           /**
            * Indicates that the control is in error state. If set to `true`, an error message will be displayed whenever
            * the variant is opened.
@@ -136,9 +127,7 @@ declare namespace sap {
            * This event is fired when the Save View dialog or the Save As dialog is closed with the
            * save button.
            */
-          save?: (
-            oEvent: sap.ui.base.Event<sap.ui.fl.variants.VariantManagement$SaveEventParameters>
-          ) => void;
+          save?: (oEvent: VariantManagement$SaveEvent) => void;
 
           /**
            * This event is fired when users presses the cancel button inside Save As dialog.
@@ -148,16 +137,12 @@ declare namespace sap {
           /**
            * This event is fired when users apply changes to variants in the Manage Views dialog.
            */
-          manage?: (
-            oEvent: sap.ui.base.Event<sap.ui.fl.variants.VariantManagement$ManageEventParameters>
-          ) => void;
+          manage?: (oEvent: VariantManagement$ManageEvent) => void;
 
           /**
            * This event is fired when a new variant is selected.
            */
-          select?: (
-            oEvent: sap.ui.base.Event<sap.ui.fl.variants.VariantManagement$SelectEventParameters>
-          ) => void;
+          select?: (oEvent: VariantManagement$SelectEvent) => void;
         }
 
         interface VariantManagement$CancelEventParameters {}
@@ -776,17 +761,6 @@ declare namespace sap {
            * @returns Value of property `inErrorState`
            */
           getInErrorState(): boolean;
-          /**
-           * Gets current value of property {@link #getManualVariantKey manualVariantKey}.
-           *
-           * If set to `true`, the key for a vendor variant will be added manually.
-           *   **Note:** This flag is only used internally.
-           *
-           * Default value is `false`.
-           *
-           * @returns Value of property `manualVariantKey`
-           */
-          getManualVariantKey(): boolean;
           /**
            * @since 1.109
            *
@@ -996,24 +970,6 @@ declare namespace sap {
              */
             bInErrorState?: boolean
           ): this;
-          /**
-           * Sets a new value for property {@link #getManualVariantKey manualVariantKey}.
-           *
-           * If set to `true`, the key for a vendor variant will be added manually.
-           *   **Note:** This flag is only used internally.
-           *
-           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
-           *
-           * Default value is `false`.
-           *
-           * @returns Reference to `this` in order to allow method chaining
-           */
-          setManualVariantKey(
-            /**
-             * New value for property `manualVariantKey`
-             */
-            bManualVariantKey?: boolean
-          ): this;
           /**
            * @since 1.109
            *
@@ -1126,45 +1082,30 @@ declare namespace sap {
           ): this;
         }
 
-        /**
-         * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'VariantManagement$CancelEventParameters'
-         * in 1.115.1 and any later releases.
-         */
-        type $VariantManagementCancelEventParameters = sap.ui.fl.variants.VariantManagement$CancelEventParameters;
-
-        type VariantManagement$CancelEvent = sap.ui.base.Event<VariantManagement$CancelEventParameters>;
-
-        /**
-         * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'VariantManagement$InitializedEventParameters'
-         * in 1.115.1 and any later releases.
-         */
-        type $VariantManagementInitializedEventParameters = sap.ui.fl.variants.VariantManagement$InitializedEventParameters;
-
-        type VariantManagement$InitializedEvent = sap.ui.base.Event<VariantManagement$InitializedEventParameters>;
-
-        /**
-         * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'VariantManagement$ManageEventParameters'
-         * in 1.115.1 and any later releases.
-         */
-        type $VariantManagementManageEventParameters = sap.ui.fl.variants.VariantManagement$ManageEventParameters;
-
-        type VariantManagement$ManageEvent = sap.ui.base.Event<VariantManagement$ManageEventParameters>;
-
-        /**
-         * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'VariantManagement$SaveEventParameters'
-         * in 1.115.1 and any later releases.
-         */
-        type $VariantManagementSaveEventParameters = sap.ui.fl.variants.VariantManagement$SaveEventParameters;
-
-        type VariantManagement$SaveEvent = sap.ui.base.Event<VariantManagement$SaveEventParameters>;
-
-        /**
-         * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'VariantManagement$SelectEventParameters'
-         * in 1.115.1 and any later releases.
-         */
-        type $VariantManagementSelectEventParameters = sap.ui.fl.variants.VariantManagement$SelectEventParameters;
-
-        type VariantManagement$SelectEvent = sap.ui.base.Event<VariantManagement$SelectEventParameters>;
+        type VariantManagement$CancelEvent = sap.ui.base.Event<
+          VariantManagement$CancelEventParameters,
+          VariantManagement
+        >;
+
+        type VariantManagement$InitializedEvent = sap.ui.base.Event<
+          VariantManagement$InitializedEventParameters,
+          VariantManagement
+        >;
+
+        type VariantManagement$ManageEvent = sap.ui.base.Event<
+          VariantManagement$ManageEventParameters,
+          VariantManagement
+        >;
+
+        type VariantManagement$SaveEvent = sap.ui.base.Event<
+          VariantManagement$SaveEventParameters,
+          VariantManagement
+        >;
+
+        type VariantManagement$SelectEvent = sap.ui.base.Event<
+          VariantManagement$SelectEventParameters,
+          VariantManagement
+        >;
       }
       /**
        * The `sap.ui.fl.write` namespace contains all code to create, update, and reset flex objects. Additional

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.115.1
+// For Library Version: 1.117.0
 
 declare namespace sap {
   namespace ui {
@@ -421,8 +421,8 @@ declare namespace sap {
            *
            * Gets current value of property {@link #getBaseUrl baseUrl}.
            *
-           * Defines the base URL of the Card Manifest. It should be used when manifest property is an object instead
-           * of a URL.
+           * Defines the base URL of the card manifest. It should be used when manifest property is an object instead
+           * of a URL. If both manifest URL and base URL are defined - the base URL will be used for loading dependencies.
            *
            * @returns Value of property `baseUrl`
            */
@@ -519,6 +519,12 @@ declare namespace sap {
              */
             eCardArea?: sap.ui.integration.CardArea
           ): void;
+          /**
+           * @experimental (since 1.117)
+           *
+           * Hides the message previously shown by showMessage.
+           */
+          hideMessage(): void;
           /**
            * @since 1.85
            * @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
@@ -768,8 +774,8 @@ declare namespace sap {
            * @since 1.70
            * @experimental (since 1.70)
            *
-           * Defines the base URL of the Card Manifest. It should be used when manifest property is an object instead
-           * of a URL.
+           * Defines the base URL of the card manifest. It should be used when manifest property is an object instead
+           * of a URL. If both manifest URL and base URL are defined - the base URL will be used for loading dependencies.
            */
           baseUrl?:
             | sap.ui.core.URI
@@ -878,9 +884,7 @@ declare namespace sap {
            * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
            * one to handle the action by calling `oEvent.preventDefault()`.
            */
-          action?: (
-            oEvent: sap.ui.base.Event<sap.ui.integration.widgets.Card$ActionEventParameters>
-          ) => void;
+          action?: (oEvent: Card$ActionEvent) => void;
 
           /**
            * @experimental (since 1.96)
@@ -888,9 +892,7 @@ declare namespace sap {
            * Fired when some configuration settings are changed as a result of user interaction. For example - filter
            * value is changed.
            */
-          configurationChange?: (
-            oEvent: sap.ui.base.Event<sap.ui.integration.widgets.Card$ConfigurationChangeEventParameters>
-          ) => void;
+          configurationChange?: (oEvent: Card$ConfigurationChangeEvent) => void;
 
           /**
            * @experimental (since 1.72)
@@ -1543,8 +1545,8 @@ declare namespace sap {
            *
            * Gets current value of property {@link #getBaseUrl baseUrl}.
            *
-           * Defines the base URL of the Card Manifest. It should be used when manifest property is an object instead
-           * of a URL.
+           * Defines the base URL of the card manifest. It should be used when manifest property is an object instead
+           * of a URL. If both manifest URL and base URL are defined - the base URL will be used for loading dependencies.
            *
            * @returns Value of property `baseUrl`
            */
@@ -1758,6 +1760,12 @@ declare namespace sap {
              */
             eCardArea?: sap.ui.integration.CardArea
           ): void;
+          /**
+           * @experimental (since 1.117)
+           *
+           * Hides the message previously shown by showMessage.
+           */
+          hideMessage(): void;
           /**
            * @since 1.85
            * @experimental (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
@@ -1917,8 +1925,8 @@ declare namespace sap {
            *
            * Sets a new value for property {@link #getBaseUrl baseUrl}.
            *
-           * Defines the base URL of the Card Manifest. It should be used when manifest property is an object instead
-           * of a URL.
+           * Defines the base URL of the card manifest. It should be used when manifest property is an object instead
+           * of a URL. If both manifest URL and base URL are defined - the base URL will be used for loading dependencies.
            *
            * When called with a value of `null` or `undefined`, the default value of the property will be restored.
            *
@@ -2177,45 +2185,30 @@ declare namespace sap {
           validateControls(): boolean;
         }
 
-        /**
-         * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'Card$ActionEventParameters'
-         * in 1.115.1 and any later releases.
-         */
-        type $CardActionEventParameters = sap.ui.integration.widgets.Card$ActionEventParameters;
-
-        type Card$ActionEvent = sap.ui.base.Event<Card$ActionEventParameters>;
-
-        /**
-         * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'Card$ConfigurationChangeEventParameters'
-         * in 1.115.1 and any later releases.
-         */
-        type $CardConfigurationChangeEventParameters = sap.ui.integration.widgets.Card$ConfigurationChangeEventParameters;
-
-        type Card$ConfigurationChangeEvent = sap.ui.base.Event<Card$ConfigurationChangeEventParameters>;
-
-        /**
-         * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'Card$ManifestAppliedEventParameters'
-         * in 1.115.1 and any later releases.
-         */
-        type $CardManifestAppliedEventParameters = sap.ui.integration.widgets.Card$ManifestAppliedEventParameters;
-
-        type Card$ManifestAppliedEvent = sap.ui.base.Event<Card$ManifestAppliedEventParameters>;
-
-        /**
-         * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'Card$ManifestReadyEventParameters'
-         * in 1.115.1 and any later releases.
-         */
-        type $CardManifestReadyEventParameters = sap.ui.integration.widgets.Card$ManifestReadyEventParameters;
-
-        type Card$ManifestReadyEvent = sap.ui.base.Event<Card$ManifestReadyEventParameters>;
-
-        /**
-         * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'Card$StateChangedEventParameters'
-         * in 1.115.1 and any later releases.
-         */
-        type $CardStateChangedEventParameters = sap.ui.integration.widgets.Card$StateChangedEventParameters;
-
-        type Card$StateChangedEvent = sap.ui.base.Event<Card$StateChangedEventParameters>;
+        type Card$ActionEvent = sap.ui.base.Event<
+          Card$ActionEventParameters,
+          Card
+        >;
+
+        type Card$ConfigurationChangeEvent = sap.ui.base.Event<
+          Card$ConfigurationChangeEventParameters,
+          Card
+        >;
+
+        type Card$ManifestAppliedEvent = sap.ui.base.Event<
+          Card$ManifestAppliedEventParameters,
+          Card
+        >;
+
+        type Card$ManifestReadyEvent = sap.ui.base.Event<
+          Card$ManifestReadyEventParameters,
+          Card
+        >;
+
+        type Card$StateChangedEvent = sap.ui.base.Event<
+          Card$StateChangedEventParameters,
+          Card
+        >;
       }
 
       interface $ActionDefinitionSettings extends sap.ui.core.$ElementSettings {
@@ -2315,9 +2308,7 @@ declare namespace sap {
          * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
          * one to handle the action by calling `oEvent.preventDefault()`.
          */
-        action?: (
-          oEvent: sap.ui.base.Event<sap.ui.integration.Extension$ActionEventParameters>
-        ) => void;
+        action?: (oEvent: Extension$ActionEvent) => void;
       }
 
       interface $HostSettings extends sap.ui.core.$ElementSettings {
@@ -2358,9 +2349,7 @@ declare namespace sap {
          * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
          * one to handle the action by calling `oEvent.preventDefault()`.
          */
-        action?: (
-          oEvent: sap.ui.base.Event<sap.ui.integration.Host$ActionEventParameters>
-        ) => void;
+        action?: (oEvent: Host$ActionEvent) => void;
 
         /**
          * @experimental (since 1.96)
@@ -2369,7 +2358,7 @@ declare namespace sap {
          * - filter value is changed.
          */
         cardConfigurationChange?: (
-          oEvent: sap.ui.base.Event<sap.ui.integration.Host$CardConfigurationChangeEventParameters>
+          oEvent: Host$CardConfigurationChangeEvent
         ) => void;
 
         /**
@@ -2378,18 +2367,22 @@ declare namespace sap {
          * Fired when the state of a card is changed. For example - the card is ready, new page is selected inside
          * the card, a filter is changed or data is refreshed.
          */
-        cardStateChanged?: (
-          oEvent: sap.ui.base.Event<sap.ui.integration.Host$CardStateChangedEventParameters>
-        ) => void;
+        cardStateChanged?: (oEvent: Host$CardStateChangedEvent) => void;
+
+        /**
+         * @experimental (since 1.116)
+         *
+         * Fired when the card is initially ready for the first time. Will not be fired for consecutive refreshes
+         * or data changes.
+         */
+        cardInitialized?: (oEvent: Host$CardInitializedEvent) => void;
 
         /**
          * @experimental (since 1.91)
          *
          * Fired when a message from channels like navigator.serviceWorker is received.
          */
-        message?: (
-          oEvent: sap.ui.base.Event<sap.ui.integration.Host$MessageEventParameters>
-        ) => void;
+        message?: (oEvent: Host$MessageEvent) => void;
       }
 
       interface ActionDefinition$PressEventParameters {}
@@ -2469,6 +2462,13 @@ declare namespace sap {
         changes?: object;
       }
 
+      interface Host$CardInitializedEventParameters {
+        /**
+         * The card.
+         */
+        card?: sap.ui.core.Control;
+      }
+
       interface Host$CardStateChangedEventParameters {
         /**
          * The card the changes are fired from.
@@ -3114,6 +3114,25 @@ declare namespace sap {
          * Called after the card is initialized.
          */
         onCardReady(): void;
+        /**
+         * @deprecated (since 1.85) - This property is replaced by the `actions` aggregation of the card;
+         * @experimental (since 1.75) - Disclaimer: this property is in a beta state - incompatible API changes
+         * may be done before its official public release. Use at your own discretion.
+         *
+         * Sets a new value for property {@link #getActions actions}.
+         *
+         * The actions configuration.
+         *
+         * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        setActions(
+          /**
+           * New value for property `actions`
+           */
+          sActions: sap.ui.integration.CardMenuAction[]
+        ): this;
         /**
          * Sets current value of property {@link #setFormatters formatters}.
          *
@@ -3310,6 +3329,59 @@ declare namespace sap {
            */
           oListener?: object
         ): this;
+        /**
+         * @experimental (since 1.116)
+         *
+         * Attaches event handler `fnFunction` to the {@link #event:cardInitialized cardInitialized} event of this
+         * `sap.ui.integration.Host`.
+         *
+         * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+         * otherwise it will be bound to this `sap.ui.integration.Host` itself.
+         *
+         * Fired when the card is initially ready for the first time. Will not be fired for consecutive refreshes
+         * or data changes.
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        attachCardInitialized(
+          /**
+           * An application-specific payload object that will be passed to the event handler along with the event
+           * object when firing the event
+           */
+          oData: object,
+          /**
+           * The function to be called when the event occurs
+           */
+          fnFunction: (p1: Host$CardInitializedEvent) => void,
+          /**
+           * Context object to call the event handler with. Defaults to this `sap.ui.integration.Host` itself
+           */
+          oListener?: object
+        ): this;
+        /**
+         * @experimental (since 1.116)
+         *
+         * Attaches event handler `fnFunction` to the {@link #event:cardInitialized cardInitialized} event of this
+         * `sap.ui.integration.Host`.
+         *
+         * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+         * otherwise it will be bound to this `sap.ui.integration.Host` itself.
+         *
+         * Fired when the card is initially ready for the first time. Will not be fired for consecutive refreshes
+         * or data changes.
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        attachCardInitialized(
+          /**
+           * The function to be called when the event occurs
+           */
+          fnFunction: (p1: Host$CardInitializedEvent) => void,
+          /**
+           * Context object to call the event handler with. Defaults to this `sap.ui.integration.Host` itself
+           */
+          oListener?: object
+        ): this;
         /**
          * @experimental (since 1.107)
          *
@@ -3482,6 +3554,26 @@ declare namespace sap {
            */
           oListener?: object
         ): this;
+        /**
+         * @experimental (since 1.116)
+         *
+         * Detaches event handler `fnFunction` from the {@link #event:cardInitialized cardInitialized} event of
+         * this `sap.ui.integration.Host`.
+         *
+         * The passed function and listener object must match the ones used for event registration.
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        detachCardInitialized(
+          /**
+           * The function to be called, when the event occurs
+           */
+          fnFunction: (p1: Host$CardInitializedEvent) => void,
+          /**
+           * Context object on which the given function had to be called
+           */
+          oListener?: object
+        ): this;
         /**
          * @experimental (since 1.107)
          *
@@ -3553,6 +3645,20 @@ declare namespace sap {
            */
           mParameters?: sap.ui.integration.Host$CardConfigurationChangeEventParameters
         ): this;
+        /**
+         * @experimental (since 1.116)
+         * @ui5-protected Do not call from applications (only from related classes in the framework)
+         *
+         * Fires event {@link #event:cardInitialized cardInitialized} to attached listeners.
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        fireCardInitialized(
+          /**
+           * Parameters to pass along with the event
+           */
+          mParameters?: sap.ui.integration.Host$CardInitializedEventParameters
+        ): this;
         /**
          * @experimental (since 1.107)
          * @ui5-protected Do not call from applications (only from related classes in the framework)
@@ -3963,53 +4069,40 @@ declare namespace sap {
         parameters: object;
       };
 
-      /**
-       * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'ActionDefinition$PressEventParameters'
-       * in 1.115.1 and any later releases.
-       */
-      type $ActionDefinitionPressEventParameters = sap.ui.integration.ActionDefinition$PressEventParameters;
-
-      type ActionDefinition$PressEvent = sap.ui.base.Event<ActionDefinition$PressEventParameters>;
-
-      /**
-       * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'Extension$ActionEventParameters'
-       * in 1.115.1 and any later releases.
-       */
-      type $ExtensionActionEventParameters = sap.ui.integration.Extension$ActionEventParameters;
-
-      type Extension$ActionEvent = sap.ui.base.Event<Extension$ActionEventParameters>;
-
-      /**
-       * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'Host$ActionEventParameters'
-       * in 1.115.1 and any later releases.
-       */
-      type $HostActionEventParameters = sap.ui.integration.Host$ActionEventParameters;
-
-      type Host$ActionEvent = sap.ui.base.Event<Host$ActionEventParameters>;
-
-      /**
-       * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'Host$CardConfigurationChangeEventParameters'
-       * in 1.115.1 and any later releases.
-       */
-      type $HostCardConfigurationChangeEventParameters = sap.ui.integration.Host$CardConfigurationChangeEventParameters;
-
-      type Host$CardConfigurationChangeEvent = sap.ui.base.Event<Host$CardConfigurationChangeEventParameters>;
-
-      /**
-       * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'Host$CardStateChangedEventParameters'
-       * in 1.115.1 and any later releases.
-       */
-      type $HostCardStateChangedEventParameters = sap.ui.integration.Host$CardStateChangedEventParameters;
-
-      type Host$CardStateChangedEvent = sap.ui.base.Event<Host$CardStateChangedEventParameters>;
-
-      /**
-       * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'Host$MessageEventParameters'
-       * in 1.115.1 and any later releases.
-       */
-      type $HostMessageEventParameters = sap.ui.integration.Host$MessageEventParameters;
-
-      type Host$MessageEvent = sap.ui.base.Event<Host$MessageEventParameters>;
+      type ActionDefinition$PressEvent = sap.ui.base.Event<
+        ActionDefinition$PressEventParameters,
+        ActionDefinition
+      >;
+
+      type Extension$ActionEvent = sap.ui.base.Event<
+        Extension$ActionEventParameters,
+        Extension
+      >;
+
+      type Host$ActionEvent = sap.ui.base.Event<
+        Host$ActionEventParameters,
+        Host
+      >;
+
+      type Host$CardConfigurationChangeEvent = sap.ui.base.Event<
+        Host$CardConfigurationChangeEventParameters,
+        Host
+      >;
+
+      type Host$CardInitializedEvent = sap.ui.base.Event<
+        Host$CardInitializedEventParameters,
+        Host
+      >;
+
+      type Host$CardStateChangedEvent = sap.ui.base.Event<
+        Host$CardStateChangedEventParameters,
+        Host
+      >;
+
+      type Host$MessageEvent = sap.ui.base.Event<
+        Host$MessageEventParameters,
+        Host
+      >;
     }
   }