@sapui5/ts-types 1.102.1 → 1.103.0

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.102.0
+// For Library Version: 1.103.0
 
 declare namespace sap {
   namespace suite {
@@ -167,25 +167,32 @@ declare namespace sap {
                  */
                 setCustomMessage(
                   /**
-                   * custom message along with type to set on table
+                   * custom message along with type to set on table. If this parameter is faulty an existing message will
+                   * be removed.
                    */
-                  oMessage: {
+                  oMessage?: {
                     /**
                      * message string to display
                      */
-                    message?: string;
+                    message: string;
                     /**
                      * indicates type of message (sap.ui.core.MessageType) whether it's sap.ui.core.MessageType.Success, sap.ui.core.MessageType.Warning,
                      * sap.ui.core.MessageType.Error or sap.ui.core.MessageType.Information.
                      */
-                    type?: string;
+                    type: string;
                   },
                   /**
                    * If switching between different table views is enabled, this parameter can be used to identify the views
                    * which are affected by this call. Faulty values indicate that all views should be affected. Otherwise
                    * the value should either be one string or an array of strings identifying the affected variant items.
                    */
-                  vTabKey?: any[] | string
+                  vTabKey?: any[] | string,
+                  /**
+                   * A function that is called when the user closes the message bar. Note that the messages for all tabs specified
+                   * via `vTabKey` will be considered to be obsolete when the user closes the message bar while one of them
+                   * is active.
+                   */
+                  onClose?: Function
                 ): void;
               }
             }
@@ -937,7 +944,7 @@ declare namespace sap {
                    * This gives the provision to the application developer to chosse between "display"/"edit" mode for target
                    * page
                    */
-                  displayMode?: /* was: sap.suite.ui.generic.template.displayMode */ any;
+                  displayMode?: sap.suite.ui.generic.template.displayMode;
                 }
               ): void;
             }
@@ -1172,25 +1179,32 @@ declare namespace sap {
                  */
                 setCustomMessage(
                   /**
-                   * custom message along with type to set on table
+                   * custom message along with type to set on table. If this parameter is faulty an existing message will
+                   * be removed.
                    */
-                  oMessage: {
+                  oMessage?: {
                     /**
                      * message string to display
                      */
-                    message?: string;
+                    message: string;
                     /**
                      * indicates type of message (sap.ui.core.MessageType) whether it's sap.ui.core.MessageType.Success, sap.ui.core.MessageType.Warning,
                      * sap.ui.core.MessageType.Error or sap.ui.core.MessageType.Information.
                      */
-                    type?: string;
+                    type: string;
                   },
                   /**
                    * If switching between different table views is enabled, this parameter can be used to identify the views
                    * which are affected by this call. Faulty values indicate that all views should be affected. Otherwise
                    * the value should either be one string or an array of strings identifying the affected variant items.
                    */
-                  vTabKey?: any[] | string
+                  vTabKey?: any[] | string,
+                  /**
+                   * A function that is called when the user closes the message bar. Note that the messages for all tabs specified
+                   * via `vTabKey` will be considered to be obsolete when the user closes the message bar while one of them
+                   * is active.
+                   */
+                  onClose?: Function
                 ): void;
                 /**
                  * @EXPERIMENTAL
@@ -2076,6 +2090,56 @@ declare namespace sap {
                     sActionLabel?: string;
                   }
                 ): Promise<any>;
+                /**
+                 * Provide an option for showing an own message in the message bar above the OP table
+                 */
+                setCustomMessage(
+                  /**
+                   * the entitySet identifying the table to set custom message
+                   */
+                  vTabKey: any[] | string,
+                  /**
+                   * custom message along with type to set on table
+                   */
+                  oMessage: {
+                    /**
+                     * message string to display
+                     */
+                    message?: string;
+                    /**
+                     * indicates type of message (sap.ui.core.MessageType) whether it's sap.ui.core.MessageType.Success, sap.ui.core.MessageType.Warning,
+                     * sap.ui.core.MessageType.Error or sap.ui.core.MessageType.Information.
+                     */
+                    type?: string;
+                  },
+                  /**
+                   * Id of the table for which message should be set
+                   */
+                  sSmartTableId: string
+                ): void;
+                /**
+                 * Provide an option for showing an own message in the message bar above the OP table
+                 */
+                setCustomMessage(
+                  /**
+                   * custom message along with type to set on table
+                   */
+                  oMessage: {
+                    /**
+                     * message string to display
+                     */
+                    message?: string;
+                    /**
+                     * indicates type of message (sap.ui.core.MessageType) whether it's sap.ui.core.MessageType.Success, sap.ui.core.MessageType.Warning,
+                     * sap.ui.core.MessageType.Error or sap.ui.core.MessageType.Information.
+                     */
+                    type?: string;
+                  },
+                  /**
+                   * Id of the table for which message should be set
+                   */
+                  sSmartTableId: string
+                ): void;
                 /**
                  * @EXPERIMENTAL
                  *
@@ -2444,6 +2508,28 @@ declare namespace sap {
             }
             const controllerFrameworkExtensions: controllerFrameworkExtensions;
           }
+
+          /**
+           * A static enumeration type which indicates the mode of targeted page while using navigateInternal extensionAPI
+           */
+          enum displayMode {
+            /**
+             * Navigating in create mode
+             */
+            create = "create",
+            /**
+             * Navigating in read-only mode
+             */
+            display = "display",
+            /**
+             * Navigating in draft mode
+             */
+            edit = "edit",
+            /**
+             * Navigating with a mode which is not yet decided (fallback condition)
+             */
+            undefined = "undefined",
+          }
         }
       }
     }

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.102.1
+// For Library Version: 1.103.0
 
 declare namespace sap {
   namespace suite {
@@ -2625,7 +2625,7 @@ declare namespace sap {
              * The line to remove or its index or id
              */
             vLine: int | string | sap.suite.ui.microchart.AreaMicroChartItem
-          ): sap.suite.ui.microchart.AreaMicroChartItem;
+          ): sap.suite.ui.microchart.AreaMicroChartItem | null;
           /**
            * Sets the aggregated {@link #getChart chart}.
            *
@@ -3142,7 +3142,7 @@ declare namespace sap {
              * The point to remove or its index or id
              */
             vPoint: int | string | sap.suite.ui.microchart.AreaMicroChartPoint
-          ): sap.suite.ui.microchart.AreaMicroChartPoint;
+          ): sap.suite.ui.microchart.AreaMicroChartPoint | null;
           /**
            * Sets a new value for property {@link #getColor color}.
            *
@@ -3963,7 +3963,7 @@ declare namespace sap {
               | int
               | string
               | sap.suite.ui.microchart.BulletMicroChartData
-          ): sap.suite.ui.microchart.BulletMicroChartData;
+          ): sap.suite.ui.microchart.BulletMicroChartData | null;
           /**
            * Sets the aggregated {@link #getActual actual}.
            *
@@ -4897,7 +4897,7 @@ declare namespace sap {
              * The column to remove or its index or id
              */
             vColumn: int | string | sap.suite.ui.microchart.ColumnMicroChartData
-          ): sap.suite.ui.microchart.ColumnMicroChartData;
+          ): sap.suite.ui.microchart.ColumnMicroChartData | null;
           /**
            * @SINCE 1.60.0
            *
@@ -5853,7 +5853,7 @@ declare namespace sap {
               | int
               | string
               | sap.suite.ui.microchart.ComparisonMicroChartData
-          ): sap.suite.ui.microchart.ComparisonMicroChartData;
+          ): sap.suite.ui.microchart.ComparisonMicroChartData | null;
           /**
            * Sets a new value for property {@link #getColorPalette colorPalette}.
            *
@@ -7276,7 +7276,7 @@ declare namespace sap {
               | int
               | string
               | sap.suite.ui.microchart.HarveyBallMicroChartItem
-          ): sap.suite.ui.microchart.HarveyBallMicroChartItem;
+          ): sap.suite.ui.microchart.HarveyBallMicroChartItem | null;
           /**
            * @SINCE 1.62.0
            *
@@ -8157,7 +8157,7 @@ declare namespace sap {
              * The bar to remove or its index or id
              */
             vBar: int | string | sap.suite.ui.microchart.InteractiveBarChartBar
-          ): sap.suite.ui.microchart.InteractiveBarChartBar;
+          ): sap.suite.ui.microchart.InteractiveBarChartBar | null;
           /**
            * Sets a new value for property {@link #getDisplayedBars displayedBars}.
            *
@@ -8916,7 +8916,7 @@ declare namespace sap {
               | int
               | string
               | sap.suite.ui.microchart.InteractiveDonutChartSegment
-          ): sap.suite.ui.microchart.InteractiveDonutChartSegment;
+          ): sap.suite.ui.microchart.InteractiveDonutChartSegment | null;
           /**
            * Sets a new value for property {@link #getDisplayedSegments displayedSegments}.
            *
@@ -9650,7 +9650,7 @@ declare namespace sap {
               | int
               | string
               | sap.suite.ui.microchart.InteractiveLineChartPoint
-          ): sap.suite.ui.microchart.InteractiveLineChartPoint;
+          ): sap.suite.ui.microchart.InteractiveLineChartPoint | null;
           /**
            * Sets a new value for property {@link #getDisplayedPoints displayedPoints}.
            *
@@ -10566,7 +10566,7 @@ declare namespace sap {
              * The line to remove or its index or id
              */
             vLine: int | string | sap.suite.ui.microchart.LineMicroChartLine
-          ): sap.suite.ui.microchart.LineMicroChartLine;
+          ): sap.suite.ui.microchart.LineMicroChartLine | null;
           /**
            * Removes a point from the aggregation {@link #getPoints points}.
            *
@@ -10577,7 +10577,7 @@ declare namespace sap {
              * The point to remove or its index or id
              */
             vPoint: int | string | sap.suite.ui.microchart.LineMicroChartPoint
-          ): sap.suite.ui.microchart.LineMicroChartPoint;
+          ): sap.suite.ui.microchart.LineMicroChartPoint | null;
           /**
            * Sets a new value for property {@link #getColor color}.
            *
@@ -11269,7 +11269,7 @@ declare namespace sap {
              * The point to remove or its index or id
              */
             vPoint: int | string | sap.suite.ui.microchart.LineMicroChartPoint
-          ): sap.suite.ui.microchart.LineMicroChartPoint;
+          ): sap.suite.ui.microchart.LineMicroChartPoint | null;
           /**
            * Sets a new value for property {@link #getColor color}.
            *
@@ -12239,7 +12239,7 @@ declare namespace sap {
              * The bar to remove or its index or id
              */
             vBar: int | string | sap.suite.ui.microchart.StackedBarMicroChartBar
-          ): sap.suite.ui.microchart.StackedBarMicroChartBar;
+          ): sap.suite.ui.microchart.StackedBarMicroChartBar | null;
           /**
            * @SINCE 1.76
            *

package/types/sap.tnt.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.102.1
+// For Library Version: 1.103.0
 
 declare namespace sap {
   /**
@@ -825,7 +825,7 @@ declare namespace sap {
       /**
        * Gets the currently selected `NavigationListItem`.
        *
-       * @returns The selected item or null if nothing is selected
+       * @returns The selected item or `null` if nothing is selected
        */
       getSelectedItem(): sap.tnt.NavigationListItem | null;
       /**
@@ -927,7 +927,7 @@ declare namespace sap {
          * The item to remove or its index or id
          */
         vItem: int | string | sap.tnt.NavigationListItem
-      ): sap.tnt.NavigationListItem;
+      ): sap.tnt.NavigationListItem | null;
       /**
        * Sets a new value for property {@link #getExpanded expanded}.
        *
@@ -1261,7 +1261,7 @@ declare namespace sap {
          * The item to remove or its index or id
          */
         vItem: int | string | sap.tnt.NavigationListItem
-      ): sap.tnt.NavigationListItem;
+      ): sap.tnt.NavigationListItem | null;
       /**
        * Sets a new value for property {@link #getExpanded expanded}.
        *
@@ -2071,7 +2071,7 @@ declare namespace sap {
          * The mainContent to remove or its index or id
          */
         vMainContent: int | string | sap.ui.core.Control
-      ): sap.ui.core.Control;
+      ): sap.ui.core.Control | null;
       /**
        * Sets the aggregated {@link #getHeader header}.
        *

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

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.102.1
+// For Library Version: 1.103.0
 
 declare namespace sap {
   namespace ui {
@@ -2187,7 +2187,7 @@ declare namespace sap {
              * The content to remove or its index or id
              */
             vContent: int | string | sap.ui.core.Control
-          ): sap.ui.core.Control;
+          ): sap.ui.core.Control | null;
           /**
            * @deprecated (since 1.3.3) - Redundant to the aggregation by the parent border layout.
            *
@@ -2571,7 +2571,7 @@ declare namespace sap {
              * The row to remove or its index or id
              */
             vRow: int | string | sap.ui.commons.layout.MatrixLayoutRow
-          ): sap.ui.commons.layout.MatrixLayoutRow;
+          ): sap.ui.commons.layout.MatrixLayoutRow | null;
           /**
            * Sets a new value for property {@link #getColumns columns}.
            *
@@ -2918,7 +2918,7 @@ declare namespace sap {
              * The content to remove or its index or id
              */
             vContent: int | string | sap.ui.core.Control
-          ): sap.ui.core.Control;
+          ): sap.ui.core.Control | null;
           /**
            * Removes the given string from the list of custom style classes that have been set previously. Regular
            * style classes like "sapUiBtn" cannot be removed.
@@ -3250,7 +3250,7 @@ declare namespace sap {
              * The cell to remove or its index or id
              */
             vCell: int | string | sap.ui.commons.layout.MatrixLayoutCell
-          ): sap.ui.commons.layout.MatrixLayoutCell;
+          ): sap.ui.commons.layout.MatrixLayoutCell | null;
           /**
            * Removes the given string from the list of custom style classes that have been set previously. Regular
            * style classes like "sapUiBtn" cannot be removed.
@@ -8017,7 +8017,7 @@ declare namespace sap {
            * The section to remove or its index or id
            */
           vSection: int | string | sap.ui.commons.AccordionSection
-        ): sap.ui.commons.AccordionSection;
+        ): sap.ui.commons.AccordionSection | null;
         /**
          * Redefinition of the method to add additional handling
          *
@@ -8306,7 +8306,7 @@ declare namespace sap {
            * The content to remove or its index or id
            */
           vContent: int | string | sap.ui.core.Control
-        ): sap.ui.core.Control;
+        ): sap.ui.core.Control | null;
         /**
          * Property setter for the "collapsed" state
          *
@@ -9691,7 +9691,7 @@ declare namespace sap {
            * The content to remove or its index or id
            */
           vContent: int | string | sap.ui.core.Control
-        ): sap.ui.core.Control;
+        ): sap.ui.core.Control | null;
       }
       /**
        * @deprecated (since 1.38)
@@ -10359,7 +10359,7 @@ declare namespace sap {
            * The content to remove or its index or id
            */
           vContent: int | string | sap.ui.core.Control
-        ): sap.ui.core.Control;
+        ): sap.ui.core.Control | null;
         /**
          * Sets a new value for property {@link #getAnimationDuration animationDuration}.
          *
@@ -11210,11 +11210,11 @@ declare namespace sap {
          */
         getDisplaySecondaryValues(): boolean;
         /**
-         * Returns the DomRef which represents the icon for value help. Could be overwritten in child-classes
+         * Returns the DOM element which represents the icon for value help. Could be overwritten in child-classes.
          *
-         * @returns The F4-element's DOM reference or null
+         * @returns The F4-element's DOM reference or `null`
          */
-        getF4ButtonDomRef(): Element;
+        getF4ButtonDomRef(): Element | null;
         /**
          * Gets content of aggregation {@link #getItems items}.
          *
@@ -11353,7 +11353,7 @@ declare namespace sap {
            * The item to remove or its index or id
            */
           vItem: int | string | sap.ui.core.ListItem
-        ): sap.ui.core.ListItem;
+        ): sap.ui.core.ListItem | null;
         /**
          * Sets a new value for property {@link #getDisplaySecondaryValues displaySecondaryValues}.
          *
@@ -12107,7 +12107,7 @@ declare namespace sap {
            * The button to remove or its index or id
            */
           vButton: int | string | sap.ui.core.Control
-        ): sap.ui.core.Control;
+        ): sap.ui.core.Control | null;
         /**
          * Removes a content from the aggregation {@link #getContent content}.
          *
@@ -12118,7 +12118,7 @@ declare namespace sap {
            * The content to remove or its index or id
            */
           vContent: int | string | sap.ui.core.Control
-        ): sap.ui.core.Control;
+        ): sap.ui.core.Control | null;
         /**
          * Sets a new value for property {@link #getAccessibleRole accessibleRole}.
          *
@@ -13158,7 +13158,7 @@ declare namespace sap {
            * The control to remove or its index or id
            */
           vControl: int | string | sap.ui.core.Control
-        ): sap.ui.core.Control;
+        ): sap.ui.core.Control | null;
         /**
          * Sets a new value for property {@link #getAccessibleRole accessibleRole}.
          *
@@ -13885,7 +13885,7 @@ declare namespace sap {
            * The area to remove or its index or id
            */
           vArea: int | string | sap.ui.commons.Area
-        ): sap.ui.commons.Area;
+        ): sap.ui.commons.Area | null;
         /**
          * Sets a new value for property {@link #getName name}.
          *
@@ -15523,7 +15523,7 @@ declare namespace sap {
            * The item to remove or its index or id
            */
           vItem: int | string | sap.ui.core.Item
-        ): sap.ui.core.Item;
+        ): sap.ui.core.Item | null;
         /**
          * Removes the given index from this selection. When the index is invalid or not selected, the call is ignored.
          *
@@ -16058,7 +16058,7 @@ declare namespace sap {
            * The item to remove or its index or id
            */
           vItem: int | string | sap.ui.unified.MenuItem
-        ): sap.ui.unified.MenuItem;
+        ): sap.ui.unified.MenuItem | null;
         /**
          * Sets a new value for property {@link #getDesign design}.
          *
@@ -17867,7 +17867,7 @@ declare namespace sap {
            * The button to remove or its index or id
            */
           vButton: int | string | sap.ui.commons.Button
-        ): sap.ui.commons.Button;
+        ): sap.ui.commons.Button | null;
         /**
          * Removes a content from the aggregation {@link #getContent content}.
          *
@@ -17878,7 +17878,7 @@ declare namespace sap {
            * The content to remove or its index or id
            */
           vContent: int | string | sap.ui.core.Control
-        ): sap.ui.core.Control;
+        ): sap.ui.core.Control | null;
         /**
          * Property setter for the padding
          *
@@ -19190,7 +19190,7 @@ declare namespace sap {
            * The item to remove or its index or id
            */
           vItem: int | string | sap.ui.core.Item
-        ): sap.ui.core.Item;
+        ): sap.ui.core.Item | null;
         /**
          * Sets a new value for property {@link #getColumns columns}.
          *
@@ -20115,7 +20115,7 @@ declare namespace sap {
            * The range to remove or its index or id
            */
           vRange: int | string | sap.ui.commons.ResponsiveContainerRange
-        ): sap.ui.commons.ResponsiveContainerRange;
+        ): sap.ui.commons.ResponsiveContainerRange | null;
         /**
          * Sets the associated {@link #getDefaultContent defaultContent}.
          *
@@ -20821,7 +20821,7 @@ declare namespace sap {
            * The step to remove or its index or id
            */
           vStep: int | string | sap.ui.commons.RoadMapStep
-        ): sap.ui.commons.RoadMapStep;
+        ): sap.ui.commons.RoadMapStep | null;
         /**
          * Sets a new value for property {@link #getFirstVisibleStep firstVisibleStep}.
          *
@@ -21084,7 +21084,7 @@ declare namespace sap {
            * The subStep to remove or its index or id
            */
           vSubStep: int | string | sap.ui.commons.RoadMapStep
-        ): sap.ui.commons.RoadMapStep;
+        ): sap.ui.commons.RoadMapStep | null;
         /**
          * Sets a new value for property {@link #getEnabled enabled}.
          *
@@ -21864,7 +21864,7 @@ declare namespace sap {
            * The filter to remove or its index or id
            */
           vFilter: int | string | sap.ui.commons.RowRepeaterFilter
-        ): sap.ui.commons.RowRepeaterFilter;
+        ): sap.ui.commons.RowRepeaterFilter | null;
         /**
          * Removes a row from the aggregation {@link #getRows rows}.
          *
@@ -21875,7 +21875,7 @@ declare namespace sap {
            * The row to remove or its index or id
            */
           vRow: int | string | sap.ui.core.Control
-        ): sap.ui.core.Control;
+        ): sap.ui.core.Control | null;
         /**
          * Removes a sorter from the aggregation {@link #getSorters sorters}.
          *
@@ -21886,7 +21886,7 @@ declare namespace sap {
            * The sorter to remove or its index or id
            */
           vSorter: int | string | sap.ui.commons.RowRepeaterSorter
-        ): sap.ui.commons.RowRepeaterSorter;
+        ): sap.ui.commons.RowRepeaterSorter | null;
         /**
          * Resizes the row repeater by changing the number of displayed rows. This method will only resize the RowRepeater
          * if the property showMoreSteps is set.
@@ -23451,7 +23451,7 @@ declare namespace sap {
            * The button to remove or its index or id
            */
           vButton: int | string | sap.ui.commons.Button
-        ): sap.ui.commons.Button;
+        ): sap.ui.commons.Button | null;
         /**
          * Sets a new value for property {@link #getEnabled enabled}.
          *
@@ -24399,7 +24399,7 @@ declare namespace sap {
            * The firstPaneContent to remove or its index or id
            */
           vFirstPaneContent: int | string | sap.ui.core.Control
-        ): sap.ui.core.Control;
+        ): sap.ui.core.Control | null;
         /**
          * Removes a secondPaneContent from the aggregation {@link #getSecondPaneContent secondPaneContent}.
          *
@@ -24410,7 +24410,7 @@ declare namespace sap {
            * The secondPaneContent to remove or its index or id
            */
           vSecondPaneContent: int | string | sap.ui.core.Control
-        ): sap.ui.core.Control;
+        ): sap.ui.core.Control | null;
         /**
          * Sets a new value for property {@link #getHeight height}.
          *
@@ -25092,7 +25092,7 @@ declare namespace sap {
            * The tab to remove or its index or id
            */
           vTab: int | string | sap.ui.commons.Tab
-        ): sap.ui.commons.Tab;
+        ): sap.ui.commons.Tab | null;
         /**
          * Sets whether tab reordering is enabled.
          *
@@ -27062,7 +27062,7 @@ declare namespace sap {
            * The item to remove or its index or id
            */
           vItem: int | string | sap.ui.commons.ToolbarItem
-        ): sap.ui.commons.ToolbarItem;
+        ): sap.ui.commons.ToolbarItem | null;
         /**
          * Removes a rightItem from the aggregation {@link #getRightItems rightItems}.
          *
@@ -27073,7 +27073,7 @@ declare namespace sap {
            * The rightItem to remove or its index or id
            */
           vRightItem: int | string | sap.ui.commons.ToolbarItem
-        ): sap.ui.commons.ToolbarItem;
+        ): sap.ui.commons.ToolbarItem | null;
         /**
          * Sets a new value for property {@link #getDesign design}.
          *
@@ -27667,7 +27667,7 @@ declare namespace sap {
            * The node to remove or its index or id
            */
           vNode: int | string | sap.ui.commons.TreeNode
-        ): sap.ui.commons.TreeNode;
+        ): sap.ui.commons.TreeNode | null;
         /**
          * Sets a new value for property {@link #getHeight height}.
          *
@@ -28246,7 +28246,7 @@ declare namespace sap {
            * The node to remove or its index or id
            */
           vNode: int | string | sap.ui.commons.TreeNode
-        ): sap.ui.commons.TreeNode;
+        ): sap.ui.commons.TreeNode | null;
         /**
          * Select the node, and if any, deselects the previously selected node
          */