@openui5/ts-types 1.101.0 → 1.102.2

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

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.101.0
+// For Library Version: 1.102.2
 
 declare module "sap/ui/rta/api/startAdaptation" {
   /**
@@ -8,6 +8,8 @@ declare module "sap/ui/rta/api/startAdaptation" {
    * Starts UI adaptation, initiated for an application at the passed root control instance. With this API
    * you are also able to modify the UI adaptation plugins list and or add some event handler functions to
    * be called on start, failed and stop events.
+   *
+   * @returns Resolves when UI adaptation was successfully started
    */
   export default function startAdaptation(
     /**
@@ -59,6 +61,8 @@ declare module "sap/ui/rta/api/startKeyUserAdaptation" {
    *
    * Starts key user adaptation, initiated for an application at the passed root control instance. It subsequently
    * extends to all valid child controls.
+   *
+   * @returns Resolves when UI adaptation was successfully started
    */
   export default function startKeyUserAdaptation(
     /**

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.101.0
+// For Library Version: 1.102.2
 
 declare namespace sap {
   namespace ui {
@@ -13,24 +13,34 @@ declare namespace sap {
          * Current value of the task circle to be displayed. In dependency of the parameters maxValue and minValue
          * it controls the size of the circle.
          */
-        value?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
+        value?:
+          | int
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Upper limit of the displayed values. Default is 100.
          */
-        maxValue?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
+        maxValue?:
+          | int
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Lower limit of the displayed values. Default is 0.
          */
-        minValue?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
+        minValue?:
+          | int
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Color of the circle. The default color is red.
          */
         color?:
           | sap.ui.suite.TaskCircleColor
-          | sap.ui.base.ManagedObject.PropertyBindingInfo;
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Association to controls / ids which label this control (see WAI-ARIA attribute aria-labelledby).
@@ -54,7 +64,10 @@ declare namespace sap {
          * The numerical value between 0 and 100 which determines the height of the vertical bar. Values higher
          * than 100 will be displayed as 100%, values lower than zero will be displayed as 0%.
          */
-        percentage?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
+        percentage?:
+          | int
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Association to controls / ids which label this control (see WAI-ARIA attribute aria-labelledby).
@@ -114,6 +127,8 @@ declare namespace sap {
          * information contained in `oClassInfo`.
          *
          * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
+         *
+         * @returns Created class / constructor function
          */
         static extend<T extends Record<string, unknown>>(
           /**
@@ -132,10 +147,14 @@ declare namespace sap {
         ): Function;
         /**
          * Returns a metadata object for class sap.ui.suite.TaskCircle.
+         *
+         * @returns Metadata object describing this class
          */
         static getMetadata(): sap.ui.core.ElementMetadata;
         /**
          * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         addAriaDescribedBy(
           /**
@@ -145,6 +164,8 @@ declare namespace sap {
         ): this;
         /**
          * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         addAriaLabelledBy(
           /**
@@ -159,6 +180,8 @@ declare namespace sap {
          * otherwise it will be bound to this `sap.ui.suite.TaskCircle` itself.
          *
          * Event is fired when the user clicks the control.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         attachPress(
           /**
@@ -182,6 +205,8 @@ declare namespace sap {
          * otherwise it will be bound to this `sap.ui.suite.TaskCircle` itself.
          *
          * Event is fired when the user clicks the control.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         attachPress(
           /**
@@ -197,6 +222,8 @@ declare namespace sap {
          * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.ui.suite.TaskCircle`.
          *
          * The passed function and listener object must match the ones used for event registration.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         detachPress(
           /**
@@ -210,6 +237,8 @@ declare namespace sap {
         ): this;
         /**
          * Fires event {@link #event:press press} to attached listeners.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         firePress(
           /**
@@ -237,6 +266,8 @@ declare namespace sap {
          * Color of the circle. The default color is red.
          *
          * Default value is `Gray`.
+         *
+         * @returns Value of property `color`
          */
         getColor(): sap.ui.suite.TaskCircleColor;
         /**
@@ -245,6 +276,8 @@ declare namespace sap {
          * Upper limit of the displayed values. Default is 100.
          *
          * Default value is `100`.
+         *
+         * @returns Value of property `maxValue`
          */
         getMaxValue(): int;
         /**
@@ -253,6 +286,8 @@ declare namespace sap {
          * Lower limit of the displayed values. Default is 0.
          *
          * Default value is `0`.
+         *
+         * @returns Value of property `minValue`
          */
         getMinValue(): int;
         /**
@@ -262,18 +297,26 @@ declare namespace sap {
          * it controls the size of the circle.
          *
          * Default value is `0`.
+         *
+         * @returns Value of property `value`
          */
         getValue(): int;
         /**
          * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
+         *
+         * @returns An array of the removed elements (might be empty)
          */
         removeAllAriaDescribedBy(): sap.ui.core.ID[];
         /**
          * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
+         *
+         * @returns An array of the removed elements (might be empty)
          */
         removeAllAriaLabelledBy(): sap.ui.core.ID[];
         /**
          * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
+         *
+         * @returns The removed ariaDescribedBy or `null`
          */
         removeAriaDescribedBy(
           /**
@@ -283,6 +326,8 @@ declare namespace sap {
         ): sap.ui.core.ID;
         /**
          * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
+         *
+         * @returns The removed ariaLabelledBy or `null`
          */
         removeAriaLabelledBy(
           /**
@@ -298,6 +343,8 @@ declare namespace sap {
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
          * Default value is `Gray`.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         setColor(
           /**
@@ -313,6 +360,8 @@ declare namespace sap {
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
          * Default value is `100`.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         setMaxValue(
           /**
@@ -328,6 +377,8 @@ declare namespace sap {
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
          * Default value is `0`.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         setMinValue(
           /**
@@ -344,6 +395,8 @@ declare namespace sap {
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
          * Default value is `0`.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         setValue(
           /**
@@ -395,6 +448,8 @@ declare namespace sap {
          * it with the information contained in `oClassInfo`.
          *
          * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
+         *
+         * @returns Created class / constructor function
          */
         static extend<T extends Record<string, unknown>>(
           /**
@@ -413,10 +468,14 @@ declare namespace sap {
         ): Function;
         /**
          * Returns a metadata object for class sap.ui.suite.VerticalProgressIndicator.
+         *
+         * @returns Metadata object describing this class
          */
         static getMetadata(): sap.ui.core.ElementMetadata;
         /**
          * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         addAriaDescribedBy(
           /**
@@ -426,6 +485,8 @@ declare namespace sap {
         ): this;
         /**
          * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         addAriaLabelledBy(
           /**
@@ -440,6 +501,8 @@ declare namespace sap {
          * otherwise it will be bound to this `sap.ui.suite.VerticalProgressIndicator` itself.
          *
          * Event is fired when the user clicks the control.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         attachPress(
           /**
@@ -464,6 +527,8 @@ declare namespace sap {
          * otherwise it will be bound to this `sap.ui.suite.VerticalProgressIndicator` itself.
          *
          * Event is fired when the user clicks the control.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         attachPress(
           /**
@@ -480,6 +545,8 @@ declare namespace sap {
          * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.ui.suite.VerticalProgressIndicator`.
          *
          * The passed function and listener object must match the ones used for event registration.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         detachPress(
           /**
@@ -493,6 +560,8 @@ declare namespace sap {
         ): this;
         /**
          * Fires event {@link #event:press press} to attached listeners.
+         *
+         * @returns Reference to `this` in order to allow method chaining
          */
         firePress(
           /**
@@ -519,18 +588,26 @@ declare namespace sap {
          *
          * The numerical value between 0 and 100 which determines the height of the vertical bar. Values higher
          * than 100 will be displayed as 100%, values lower than zero will be displayed as 0%.
+         *
+         * @returns Value of property `percentage`
          */
         getPercentage(): int;
         /**
          * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
+         *
+         * @returns An array of the removed elements (might be empty)
          */
         removeAllAriaDescribedBy(): sap.ui.core.ID[];
         /**
          * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
+         *
+         * @returns An array of the removed elements (might be empty)
          */
         removeAllAriaLabelledBy(): sap.ui.core.ID[];
         /**
          * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
+         *
+         * @returns The removed ariaDescribedBy or `null`
          */
         removeAriaDescribedBy(
           /**
@@ -540,6 +617,8 @@ declare namespace sap {
         ): sap.ui.core.ID;
         /**
          * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
+         *
+         * @returns The removed ariaLabelledBy or `null`
          */
         removeAriaLabelledBy(
           /**
@@ -551,6 +630,8 @@ declare namespace sap {
          * Property setter for the Percentage, which determines the height of the vertical bar. Values higher than
          * 100 will be displayed as 100%, values lower than zero will be displayed as 0%. A new rendering is not
          * necessary, only the bar will be moved
+         *
+         * @returns `this` to allow method chaining
          */
         setPercentage(iPercentage: int): this;
       }

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.101.0
+// For Library Version: 1.102.2
 
 declare namespace sap {
   namespace ui {
@@ -20,6 +20,8 @@ declare namespace sap {
       namespace RuleSet {
         /**
          * Adds rules to RuleSet.
+         *
+         * @returns sRuleVerificationStatus Verification status
          */
         function addRule(
           /**
@@ -33,6 +35,8 @@ declare namespace sap {
         function clearAllRuleSets(): void;
         /**
          * Gets all rules from the RuleSet.
+         *
+         * @returns All rules within the current RuleSet
          */
         function getRules(): object;
         /**
@@ -65,6 +69,8 @@ declare namespace sap {
         ): void;
         /**
          * Updates rules from the RuleSet.
+         *
+         * @returns sRuleVerification Rule Verification status
          */
         function updateRule(
           /**
@@ -98,6 +104,8 @@ declare namespace sap {
          * @SINCE 1.60
          *
          * Adds new temporary rule when in silent mode
+         *
+         * @returns Rule creation status. Possible values are "success" or description of why adding failed.
          */
         addRule(
           /**
@@ -111,6 +119,8 @@ declare namespace sap {
          *
          * Allows to choose a particular execution scope - desired part of the UI to be checked and a flexible way
          * to specify the list of rules to be used.
+         *
+         * @returns Notifies the finished state by starting the Analyzer
          */
         analyze(
           /**
@@ -145,10 +155,15 @@ declare namespace sap {
         ): Promise<any>;
         /**
          * Returns the history of all executed analyses.
+         *
+         * @returns Array of history objects in the order of analyses performed. The results of the last analysis
+         * are contained in the last element in the array.
          */
         getAnalysisHistory(): sap.ui.support.AnalysisResult[];
         /**
          * Returns the history of all executed analyses into formatted output depending on the passed format.
+         *
+         * @returns All analysis history objects in the correct format.
          */
         getFormattedAnalysisHistory(
           /**
@@ -158,6 +173,8 @@ declare namespace sap {
         ): any;
         /**
          * Returns the result of the last analysis performed.
+         *
+         * @returns Last analysis history.
          */
         getLastAnalysisHistory(): sap.ui.support.AnalysisResult;
       }
@@ -185,6 +202,10 @@ declare namespace sap {
       class ExecutionScope {
         constructor();
 
+        /**
+         *
+         * @returns Array of matched elements
+         */
         static getElements(
           /**
            * Object with specific filtering options
@@ -206,6 +227,8 @@ declare namespace sap {
         ): any[];
         /**
          * Gets elements by their type
+         *
+         * @returns Array of matched elements
          */
         static getElementsByClassName(
           /**
@@ -215,6 +238,8 @@ declare namespace sap {
         ): any[];
         /**
          * Gets the logged objects by object type
+         *
+         * @returns Array of logged objects
          */
         static getLoggedObjects(
           /**
@@ -224,10 +249,14 @@ declare namespace sap {
         ): any[];
         /**
          * Returns all public elements, i.e. elements that are part of public API aggregations
+         *
+         * @returns Array of matched elements
          */
         static getPublicElements(): any[];
         /**
          * Gets the type of the execution scope
+         *
+         * @returns The type of the execution scope. Possible values are `global`, `subtree` or `components`.
          */
         static getType(): string;
       }