@openui5/ts-types 1.102.1 → 1.103.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -264,7 +264,7 @@ interface JQuery<TElement = HTMLElement> extends Iterable<TElement> {
264
264
  ): jQuery;
265
265
  }
266
266
 
267
- // For Library Version: 1.102.1
267
+ // For Library Version: 1.103.0
268
268
 
269
269
  declare module "sap/base/assert" {
270
270
  /**
@@ -3817,7 +3817,7 @@ declare module "sap/ui/util/Storage" {
3817
3817
  /**
3818
3818
  * Retrieves data item for a specific key.
3819
3819
  *
3820
- * @returns keys value or null
3820
+ * @returns key's value or `null`
3821
3821
  */
3822
3822
  get(
3823
3823
  /**
@@ -5791,7 +5791,7 @@ declare namespace sap {
5791
5791
  * that {@link sap.ui.define} uses: module names are specified without the implicit extension '.js'. Relative
5792
5792
  * module names are not supported.
5793
5793
  *
5794
- * @returns A single module export value (sync probing variant) or undefined (async loading variant)
5794
+ * @returns A single module export value (sync probing variant) or `undefined` (async loading variant)
5795
5795
  */
5796
5796
  function require(
5797
5797
  /**
@@ -9069,7 +9069,7 @@ declare namespace sap {
9069
9069
  * Applications or frameworks must not use this method to generically read the content of an aggregation.
9070
9070
  * Use the concrete method getXYZ for aggregation 'XYZ' instead.
9071
9071
  *
9072
- * @returns Aggregation array in case of 0..n-aggregations or the managed object or null in case of 0..1-aggregations
9072
+ * @returns Aggregation array in case of 0..n-aggregations or the managed object or `null` in case of 0..1-aggregations
9073
9073
  */
9074
9074
  getAggregation(
9075
9075
  /**
@@ -9078,7 +9078,7 @@ declare namespace sap {
9078
9078
  sAggregationName: string,
9079
9079
  /**
9080
9080
  * Object that is used in case the current aggregation is empty. If provided, it must be null for 0..1 aggregations
9081
- * or an empty array for 0..n aggregations. If not provided, null is used.
9081
+ * or an empty array for 0..n aggregations. If not provided, `null` is used.
9082
9082
  *
9083
9083
  * **Note:** When an empty array is given and used because the aggregation was not set before, then this
9084
9084
  * array will be used for the aggregation from thereon. Sharing the same empty array between different calls
@@ -9254,14 +9254,16 @@ declare namespace sap {
9254
9254
  * information is not active by default and must be activated by configuration. Even then, it might not
9255
9255
  * be present for all properties and their values depending on where the value came form.
9256
9256
  *
9257
- * @returns a map of properties describing the origin of this property value or null
9257
+ * If no origin info is available, `null` will be returned.
9258
+ *
9259
+ * @returns An object describing the origin of this property's value or `null`
9258
9260
  */
9259
9261
  getOriginInfo(
9260
9262
  /**
9261
- * the name of the property
9263
+ * Name of the property
9262
9264
  */
9263
9265
  sPropertyName: string
9264
- ): object;
9266
+ ): object | null;
9265
9267
  /**
9266
9268
  * @SINCE 1.88.0
9267
9269
  *
@@ -9519,7 +9521,7 @@ declare namespace sap {
9519
9521
  *
9520
9522
  * If the given object is found in the aggregation, it is removed, it's parent relationship is unset and
9521
9523
  * this ManagedObject is marked as changed. The removed object is returned as result of this method. If
9522
- * the object could not be found, `undefined` is returned.
9524
+ * the object could not be found, `null` is returned.
9523
9525
  *
9524
9526
  * This method must only be called for aggregations of cardinality 0..n. The only way to remove objects
9525
9527
  * from a 0..1 aggregation is to set a `null` value for them.
@@ -9528,7 +9530,7 @@ declare namespace sap {
9528
9530
  * Applications or frameworks must not use this method to generically remove an object from an aggregation.
9529
9531
  * Use the concrete method removeXYZ for aggregation 'XYZ' instead.
9530
9532
  *
9531
- * @returns the removed object or null
9533
+ * @returns the removed object or `null`
9532
9534
  */
9533
9535
  removeAggregation(
9534
9536
  /**
@@ -9545,7 +9547,7 @@ declare namespace sap {
9545
9547
  * if true, this ManagedObject is not marked as changed
9546
9548
  */
9547
9549
  bSuppressInvalidate?: boolean
9548
- ): sap.ui.base.ManagedObject;
9550
+ ): sap.ui.base.ManagedObject | null;
9549
9551
  /**
9550
9552
  * Removes all objects from the 0..n-aggregation named `sAggregationName`.
9551
9553
  *
@@ -10334,14 +10336,14 @@ declare namespace sap {
10334
10336
  * not part of the API. See the {@link #constructor Notes about Info objects} in the constructor documentation
10335
10337
  * of this class.
10336
10338
  *
10337
- * @returns aggregation info object or undefined
10339
+ * @returns aggregation info object or `undefined`
10338
10340
  */
10339
10341
  getManagedAggregation(
10340
10342
  /**
10341
10343
  * name of the aggregation to be retrieved or empty
10342
10344
  */
10343
10345
  sAggregationName: string
10344
- ): object;
10346
+ ): object | undefined;
10345
10347
  /**
10346
10348
  * Returns the info object for the named public or private association declared by the described class or
10347
10349
  * by any of its ancestors.
@@ -10350,14 +10352,14 @@ declare namespace sap {
10350
10352
  * not part of the API. See the {@link #constructor Notes about Info objects} in the constructor documentation
10351
10353
  * of this class.
10352
10354
  *
10353
- * @returns association info object or undefined
10355
+ * @returns association info object or `undefined`
10354
10356
  */
10355
10357
  getManagedAssociation(
10356
10358
  /**
10357
10359
  * name of the association to be retrieved
10358
10360
  */
10359
10361
  sName: string
10360
- ): object;
10362
+ ): object | undefined;
10361
10363
  /**
10362
10364
  * Returns the info object for the named public or private property declared by the described class or by
10363
10365
  * any of its ancestors.
@@ -10369,14 +10371,14 @@ declare namespace sap {
10369
10371
  * not part of the API. See the {@link #constructor Notes about Info objects} in the constructor documentation
10370
10372
  * of this class.
10371
10373
  *
10372
- * @returns property info object or undefined
10374
+ * @returns property info object or `undefined`
10373
10375
  */
10374
10376
  getManagedProperty(
10375
10377
  /**
10376
10378
  * name of the property to be retrieved or empty
10377
10379
  */
10378
10380
  sName: string
10379
- ): object;
10381
+ ): object | undefined;
10380
10382
  /**
10381
10383
  * Returns a map of info objects for the public properties of the described class. Properties declared by
10382
10384
  * ancestor classes are not included.
@@ -11524,7 +11526,7 @@ declare namespace sap {
11524
11526
  * The key of the data
11525
11527
  */
11526
11528
  sKey: string
11527
- ): any;
11529
+ ): any | undefined;
11528
11530
  /**
11529
11531
  * Returns the data that has been set via `setData` method.
11530
11532
  *
@@ -13815,12 +13817,130 @@ declare namespace sap {
13815
13817
  * ```
13816
13818
  *
13817
13819
  *
13818
- * # * @param {object} [oFormatOptions] The option object, which supports the following parameters. If no
13819
- * options are given, default values according to the type and locale settings are used.
13820
- *
13821
13820
  * @returns float instance of the NumberFormat
13822
13821
  */
13823
13822
  static getFloatInstance(
13823
+ /**
13824
+ * The option object, which supports the following parameters. If no options are given, default values according
13825
+ * to the type and locale settings are used.
13826
+ */
13827
+ oFormatOptions?: {
13828
+ /**
13829
+ * defines the number of decimal digits
13830
+ */
13831
+ decimals?: int;
13832
+ /**
13833
+ * defines the character used as decimal separator. Note: `decimalSeparator` must always be different from
13834
+ * `groupingSeparator`.
13835
+ */
13836
+ decimalSeparator?: string;
13837
+ /**
13838
+ * @since 1.30.0 defines what an empty string is parsed as, and what is formatted as an empty string. The
13839
+ * allowed values are "" (empty string), NaN, `null`, or 0. The 'format' and 'parse' functions are done
13840
+ * in a symmetric way. For example, when this parameter is set to NaN, an empty string is parsed as NaN,
13841
+ * and NaN is formatted as an empty string.
13842
+ */
13843
+ emptyString?: number;
13844
+ /**
13845
+ * defines the grouping base size in digits if it is different from the grouping size (e.g. Indian grouping)
13846
+ */
13847
+ groupingBaseSize?: int;
13848
+ /**
13849
+ * defines whether grouping is enabled (grouping separators are shown)
13850
+ */
13851
+ groupingEnabled?: boolean;
13852
+ /**
13853
+ * defines the character used as grouping separator. Note: `groupingSeparator` must always be different
13854
+ * from `decimalSeparator`.
13855
+ */
13856
+ groupingSeparator?: string;
13857
+ /**
13858
+ * defines the grouping size in digits; the default is `3`. It must be a positive number.
13859
+ */
13860
+ groupingSize?: int;
13861
+ /**
13862
+ * defines the maximum number of decimal digits
13863
+ */
13864
+ maxFractionDigits?: int;
13865
+ /**
13866
+ * defines the maximum number of non-decimal digits. If the number exceeds this maximum, e.g. 1e+120, "?"
13867
+ * characters are shown instead of digits.
13868
+ */
13869
+ maxIntegerDigits?: int;
13870
+ /**
13871
+ * defines the minimal number of decimal digits
13872
+ */
13873
+ minFractionDigits?: int;
13874
+ /**
13875
+ * defines the minimal number of non-decimal digits
13876
+ */
13877
+ minIntegerDigits?: int;
13878
+ /**
13879
+ * defines the used minus symbol
13880
+ */
13881
+ minusSign?: string;
13882
+ /**
13883
+ * @since 1.28.2 defines whether to output the string from the parse function in order to keep the precision
13884
+ * for big numbers. Numbers in scientific notation are parsed back to standard notation. For example, "5e-3"
13885
+ * is parsed to "0.005".
13886
+ */
13887
+ parseAsString?: boolean;
13888
+ /**
13889
+ * CLDR number pattern which is used to format the number
13890
+ */
13891
+ pattern?: string;
13892
+ /**
13893
+ * defines the used plus symbol
13894
+ */
13895
+ plusSign?: string;
13896
+ /**
13897
+ * defines the numerical precision; the number of decimals is calculated dependent on the integer digits
13898
+ */
13899
+ precision?: int;
13900
+ /**
13901
+ * Whether {@link #format} preserves decimal digits except trailing zeros in case there are more decimals
13902
+ * than the `maxFractionDigits` format option allows. If decimals are not preserved, the formatted number
13903
+ * is rounded to `maxFractionDigits`.
13904
+ */
13905
+ preserveDecimals?: boolean;
13906
+ /**
13907
+ * specifies the rounding behavior for discarding the digits after the maximum fraction digits defined by
13908
+ * maxFractionDigits. Rounding will only be applied if the passed value is of type `number`. This can be
13909
+ * assigned
13910
+ * - by value in {@link sap.ui.core.format.NumberFormat.RoundingMode RoundingMode},
13911
+ * - via a function that is used for rounding the number and takes two parameters: the number itself,
13912
+ * and the number of decimal digits that should be reserved.
13913
+ */
13914
+ roundingMode?: sap.ui.core.format.NumberFormat.RoundingMode;
13915
+ /**
13916
+ * defines the number of decimal in the shortened format string. If this isn't specified, the 'decimals'
13917
+ * options is used
13918
+ */
13919
+ shortDecimals?: int;
13920
+ /**
13921
+ * only use short number formatting for values above this limit
13922
+ */
13923
+ shortLimit?: int;
13924
+ /**
13925
+ * @since 1.40 specifies a number from which the scale factor for 'short' or 'long' style format is generated.
13926
+ * The generated scale factor is used for all numbers which are formatted with this format instance. This
13927
+ * option has effect only when the option 'style' is set to 'short' or 'long'. This option is by default
13928
+ * set with `undefined` which means the scale factor is selected automatically for each number being formatted.
13929
+ */
13930
+ shortRefNumber?: int;
13931
+ /**
13932
+ * @since 1.40 specifies whether the scale factor is shown in the formatted number. This option takes effect
13933
+ * only when the 'style' options is set to either 'short' or 'long'.
13934
+ */
13935
+ showScale?: boolean;
13936
+ /**
13937
+ * defines the style of format. Valid values are 'short, 'long' or 'standard' (based on the CLDR decimalFormat).
13938
+ * When set to 'short' or 'long', numbers are formatted into compact forms. When this option is set, the
13939
+ * default value of the 'precision' option is set to 2. This can be changed by setting either min/maxFractionDigits,
13940
+ * decimals, shortDecimals, or the 'precision' option itself.
13941
+ */
13942
+ style?: string;
13943
+ },
13824
13944
  /**
13825
13945
  * Locale to get the formatter for
13826
13946
  */
@@ -14913,9 +15033,9 @@ declare namespace sap {
14913
15033
  /**
14914
15034
  * Returns the registered processor on which the events for message handling can be fired
14915
15035
  *
14916
- * @returns The currently set MessageProcessor or null if none is set
15036
+ * @returns The currently set MessageProcessor or `null` if none is set
14917
15037
  */
14918
- getProcessor(): sap.ui.core.message.MessageProcessor;
15038
+ getProcessor(): sap.ui.core.message.MessageProcessor | null;
14919
15039
  /**
14920
15040
  * Abstract parse method must be implemented in the inheriting class.
14921
15041
  */
@@ -16946,7 +17066,7 @@ declare namespace sap {
16946
17066
  * The content to remove or its index or id
16947
17067
  */
16948
17068
  vContent: int | string | sap.ui.core.Control
16949
- ): sap.ui.core.Control;
17069
+ ): sap.ui.core.Control | null;
16950
17070
  /**
16951
17071
  * Executes preprocessors for a type of source
16952
17072
  *
@@ -18553,14 +18673,14 @@ declare namespace sap {
18553
18673
  * get Unknown because it might be backwards or forwards. For hash replacements, the history stack will
18554
18674
  * be replaced at this position for the history.
18555
18675
  *
18556
- * @returns or undefined, if no navigation has taken place yet.
18676
+ * @returns Direction for the given hash or `undefined`, if no navigation has taken place yet.
18557
18677
  */
18558
18678
  getDirection(
18559
18679
  /**
18560
18680
  * optional, if this parameter is not passed the last hashChange is taken.
18561
18681
  */
18562
18682
  sNewHash?: string
18563
- ): sap.ui.core.routing.HistoryDirection;
18683
+ ): sap.ui.core.routing.HistoryDirection | undefined;
18564
18684
  /**
18565
18685
  * @SINCE 1.70
18566
18686
  *
@@ -18582,12 +18702,13 @@ declare namespace sap {
18582
18702
  */
18583
18703
  getHistoryStateOffset(): int | undefined;
18584
18704
  /**
18585
- * gets the previous hash in the history - if the last direction was Unknown or there was no navigation
18586
- * yet, undefined will be returned
18705
+ * Gets the previous hash in the history.
18706
+ *
18707
+ * If the last direction was Unknown or there was no navigation yet, `undefined` will be returned.
18587
18708
  *
18588
- * @returns or undefined
18709
+ * @returns Previous hash in the history or `undefined`
18589
18710
  */
18590
- getPreviousHash(): string;
18711
+ getPreviousHash(): string | undefined;
18591
18712
  }
18592
18713
 
18593
18714
  class Route extends sap.ui.base.EventProvider {
@@ -20868,7 +20989,7 @@ declare namespace sap {
20868
20989
  * Returns a target by its name (if you pass myTarget: { view: "myView" }) in the config myTarget is the
20869
20990
  * name.
20870
20991
  *
20871
- * @returns The target with the coresponding name or undefined. If an array way passed as name this will
20992
+ * @returns The target with the coresponding name or undefined. If an array was passed as name, this will
20872
20993
  * return an array with all found targets. Non existing targets will not be returned and an error is logged
20873
20994
  * when `bSuppressNotFoundError` param isn't set to `true`.
20874
20995
  */
@@ -21966,7 +22087,7 @@ declare namespace sap {
21966
22087
  * The attribute to remove or its index or id
21967
22088
  */
21968
22089
  vAttribute: int | string | sap.ui.core.tmpl.DOMAttribute
21969
- ): sap.ui.core.tmpl.DOMAttribute;
22090
+ ): sap.ui.core.tmpl.DOMAttribute | null;
21970
22091
  /**
21971
22092
  * Removes a element from the aggregation {@link #getElements elements}.
21972
22093
  *
@@ -21977,7 +22098,7 @@ declare namespace sap {
21977
22098
  * The element to remove or its index or id
21978
22099
  */
21979
22100
  vElement: int | string | sap.ui.core.tmpl.DOMElement
21980
- ): sap.ui.core.tmpl.DOMElement;
22101
+ ): sap.ui.core.tmpl.DOMElement | null;
21981
22102
  /**
21982
22103
  * Sets a new value for property {@link #getTag tag}.
21983
22104
  *
@@ -23574,7 +23695,7 @@ declare namespace sap {
23574
23695
  * The column to remove or its index or id
23575
23696
  */
23576
23697
  vColumn: int | string | sap.ui.core.util.ExportColumn
23577
- ): sap.ui.core.util.ExportColumn;
23698
+ ): sap.ui.core.util.ExportColumn | null;
23578
23699
  /**
23579
23700
  * Removes a row from the aggregation {@link #getRows rows}.
23580
23701
  *
@@ -23585,7 +23706,7 @@ declare namespace sap {
23585
23706
  * The row to remove or its index or id
23586
23707
  */
23587
23708
  vRow: int | string | sap.ui.core.util.ExportRow
23588
- ): sap.ui.core.util.ExportRow;
23709
+ ): sap.ui.core.util.ExportRow | null;
23589
23710
  /**
23590
23711
  * Generates the file content, triggers a download / save action and returns a Promise with the instance
23591
23712
  * as context (this).
@@ -23971,7 +24092,7 @@ declare namespace sap {
23971
24092
  * The cell to remove or its index or id
23972
24093
  */
23973
24094
  vCell: int | string | sap.ui.core.util.ExportCell
23974
- ): sap.ui.core.util.ExportCell;
24095
+ ): sap.ui.core.util.ExportCell | null;
23975
24096
  }
23976
24097
  /**
23977
24098
  * @SINCE 1.22.0
@@ -32508,14 +32629,14 @@ declare namespace sap {
32508
32629
  * dash) and the DOM node with that compound ID will be returned. This matches the UI5 naming convention
32509
32630
  * for named inner DOM nodes of a control.
32510
32631
  *
32511
- * @returns The Element's DOM Element sub DOM Element or null
32632
+ * @returns The Element's DOM Element, sub DOM Element or `null`
32512
32633
  */
32513
32634
  getDomRef(
32514
32635
  /**
32515
32636
  * ID suffix to get the DOMRef for
32516
32637
  */
32517
32638
  sSuffix?: string
32518
- ): /* was Element */ global_Element;
32639
+ ): /* was Element */ global_Element | null;
32519
32640
  /**
32520
32641
  * @SINCE 1.56
32521
32642
  *
@@ -32544,13 +32665,13 @@ declare namespace sap {
32544
32665
  sModelName?: string
32545
32666
  ): sap.ui.model.ContextBinding;
32546
32667
  /**
32547
- * Returns the DOM Element that should get the focus.
32668
+ * Returns the DOM Element that should get the focus or `null` if there's no such element currently.
32548
32669
  *
32549
32670
  * To be overwritten by the specific control method.
32550
32671
  *
32551
- * @returns Returns the DOM Element that should get the focus
32672
+ * @returns Returns the DOM Element that should get the focus or `null`
32552
32673
  */
32553
- getFocusDomRef(): /* was Element */ global_Element;
32674
+ getFocusDomRef(): /* was Element */ global_Element | null;
32554
32675
  /**
32555
32676
  * Returns an object representing the serialized focus information.
32556
32677
  *
@@ -32597,20 +32718,20 @@ declare namespace sap {
32597
32718
  */
32598
32719
  getTooltip(): string | sap.ui.core.TooltipBase;
32599
32720
  /**
32600
- * Returns the tooltip for this element but only if it is a simple string. Otherwise an undefined value
32601
- * is returned.
32721
+ * Returns the tooltip for this element but only if it is a simple string. Otherwise, `undefined` is returned.
32602
32722
  *
32603
- * @returns string tooltip or undefined
32723
+ * @returns string tooltip or `undefined`
32604
32724
  */
32605
- getTooltip_AsString(): string;
32725
+ getTooltip_AsString(): string | undefined;
32606
32726
  /**
32607
- * Returns the main text for the current tooltip or undefined if there is no such text. If the tooltip is
32608
- * an object derived from sap.ui.core.Tooltip, then the text property of that object is returned. Otherwise
32609
- * the object itself is returned (either a string or undefined or null).
32727
+ * Returns the main text for the current tooltip or `undefined` if there is no such text.
32610
32728
  *
32611
- * @returns text of the current tooltip or undefined
32729
+ * If the tooltip is an object derived from `sap.ui.core.TooltipBase`, then the text property of that object
32730
+ * is returned. Otherwise the object itself is returned (either a string or `undefined` or `null`).
32731
+ *
32732
+ * @returns Text of the current tooltip or `undefined` or `null`
32612
32733
  */
32613
- getTooltip_Text(): string;
32734
+ getTooltip_Text(): string | undefined;
32614
32735
  /**
32615
32736
  * Checks for the provided `sap.ui.core.CustomData` in the aggregation {@link #getCustomData customData}.
32616
32737
  * and returns its index if found or -1 otherwise.
@@ -32773,7 +32894,7 @@ declare namespace sap {
32773
32894
  * The customData to remove or its index or id
32774
32895
  */
32775
32896
  vCustomData: int | string | sap.ui.core.CustomData
32776
- ): sap.ui.core.CustomData;
32897
+ ): sap.ui.core.CustomData | null;
32777
32898
  /**
32778
32899
  * @SINCE 1.19
32779
32900
  *
@@ -32786,7 +32907,7 @@ declare namespace sap {
32786
32907
  * The dependent to remove or its index or id
32787
32908
  */
32788
32909
  vDependent: int | string | sap.ui.core.Element
32789
- ): sap.ui.core.Element;
32910
+ ): sap.ui.core.Element | null;
32790
32911
  /**
32791
32912
  * @SINCE 1.56
32792
32913
  *
@@ -32799,7 +32920,7 @@ declare namespace sap {
32799
32920
  * The dragDropConfig to remove or its index or id
32800
32921
  */
32801
32922
  vDragDropConfig: int | string | sap.ui.core.dnd.DragDropBase
32802
- ): sap.ui.core.dnd.DragDropBase;
32923
+ ): sap.ui.core.dnd.DragDropBase | null;
32803
32924
  /**
32804
32925
  * @SINCE 1.9.0
32805
32926
  *
@@ -33628,14 +33749,14 @@ declare namespace sap {
33628
33749
  getContent(): string;
33629
33750
  /**
33630
33751
  *
33631
- * @returns The element's DOM reference or null
33752
+ * @returns The element's DOM reference or `null`
33632
33753
  */
33633
33754
  getDomRef(
33634
33755
  /**
33635
33756
  * Suffix of the Element to be retrieved or empty
33636
33757
  */
33637
33758
  sSuffix?: string
33638
- ): /* was Element */ global_Element;
33759
+ ): /* was Element */ global_Element | null;
33639
33760
  /**
33640
33761
  * Gets current value of property {@link #getPreferDOM preferDOM}.
33641
33762
  *
@@ -35285,9 +35406,9 @@ declare namespace sap {
35285
35406
  *
35286
35407
  * Use {@link #getExtensions} to get the individual extension tokens as an array.
35287
35408
  *
35288
- * @returns the extension
35409
+ * @returns the extension or `null`
35289
35410
  */
35290
- getExtension(): string;
35411
+ getExtension(): string | null;
35291
35412
  /**
35292
35413
  * Get the locale extensions as an array of tokens.
35293
35414
  *
@@ -35358,17 +35479,17 @@ declare namespace sap {
35358
35479
  * Note that the case might differ from the original language tag (Upper case first letter and lower case
35359
35480
  * reminder enforced as recommended by BCP47/ISO15924)
35360
35481
  *
35361
- * @returns the script code or null
35482
+ * @returns the script code or `null`
35362
35483
  */
35363
- getScript(): string;
35484
+ getScript(): string | null;
35364
35485
  /**
35365
35486
  * Get the locale variants as a single string or `null`.
35366
35487
  *
35367
35488
  * Multiple variants are separated by a dash '-'.
35368
35489
  *
35369
- * @returns the variant or null
35490
+ * @returns the variant or `null`
35370
35491
  */
35371
- getVariant(): string;
35492
+ getVariant(): string | null;
35372
35493
  /**
35373
35494
  * Get the locale variants as an array of individual variants.
35374
35495
  *
@@ -39660,7 +39781,7 @@ declare namespace sap {
39660
39781
  * The content to remove or its index or id
39661
39782
  */
39662
39783
  vContent: int | string | sap.ui.core.Control
39663
- ): sap.ui.core.Control;
39784
+ ): sap.ui.core.Control | null;
39664
39785
  /**
39665
39786
  * Removes a dependent from the aggregation {@link #getDependents dependents}.
39666
39787
  *
@@ -39671,7 +39792,7 @@ declare namespace sap {
39671
39792
  * The dependent to remove or its index or id
39672
39793
  */
39673
39794
  vDependent: int | string | sap.ui.core.Control
39674
- ): sap.ui.core.Control;
39795
+ ): sap.ui.core.Control | null;
39675
39796
  /**
39676
39797
  * @deprecated (since 1.1) - use {@link #removeAllContent} and {@link #addContent} instead
39677
39798
  *
@@ -40157,7 +40278,7 @@ declare namespace sap {
40157
40278
  * The multipleLayoutData to remove or its index or id
40158
40279
  */
40159
40280
  vMultipleLayoutData: int | string | sap.ui.core.LayoutData
40160
- ): sap.ui.core.LayoutData;
40281
+ ): sap.ui.core.LayoutData | null;
40161
40282
  }
40162
40283
  /**
40163
40284
  * @SINCE 1.56.0
@@ -52682,7 +52803,8 @@ declare namespace sap {
52682
52803
  * @returns A promise which is resolved without a result in case of success, or rejected with an instance
52683
52804
  * of `Error` in case of failure, for example if the annotation belongs to the read-only namespace "@$ui5.*".
52684
52805
  * With `bRetry` it is only rejected with an `Error` instance where `oError.canceled === true` when the
52685
- * property has been reset via the methods
52806
+ * entity has been deleted while the request was pending or the property has been reset via the methods
52807
+ *
52686
52808
  * {@link sap.ui.model.odata.v4.ODataModel#resetChanges} {@link sap.ui.model.odata.v4.ODataContextBinding#resetChanges}
52687
52809
  * or {@link sap.ui.model.odata.v4.ODataListBinding#resetChanges}.
52688
52810
  */
@@ -55412,6 +55534,37 @@ declare namespace sap {
55412
55534
  */
55413
55535
  oContext?: sap.ui.model.Context
55414
55536
  ): sap.ui.model.Context;
55537
+ /**
55538
+ * @SINCE 1.103.0
55539
+ *
55540
+ * Deletes the entity with the given canonical path on the server and in all bindings. Pending changes in
55541
+ * contexts for this entity or in dependents thereof are canceled.
55542
+ *
55543
+ * Deleting in the bindings is only possible if the given path is a canonical path, and all paths follow
55544
+ * these rules in addition to the OData 4.0 specification:
55545
+ * Key properties are ordered just as in the metadata, for single key properties, the name of the
55546
+ * key is omitted, for collection-valued navigation properties, all keys are present, the key-value
55547
+ * pairs are encoded via encodeURIComponent.
55548
+ *
55549
+ * @returns A promise resolving when the delete succeeded, and rejecting with an instance of Error otherwise.
55550
+ * In the latter case the HTTP status code of the response is given in the error's property `status`.
55551
+ */
55552
+ delete(
55553
+ /**
55554
+ * The canonical path of the entity to delete, starting with a '/'
55555
+ */
55556
+ sCanonicalPath: string,
55557
+ /**
55558
+ * The group ID that is used for the DELETE request; if not specified, the model's {@link #getUpdateGroupId
55559
+ * update group ID} is used; the resulting group ID must not have {@link sap.ui.model.odata.v4.SubmitMode.API}
55560
+ */
55561
+ sGroupId?: string,
55562
+ /**
55563
+ * If `true`, deletion fails if the entity does not exist (HTTP status code 404 or 412 due to the `If-Match:
55564
+ * *` header); otherwise we assume that it has already been deleted by someone else and report success
55565
+ */
55566
+ bRejectIfNotFound?: boolean
55567
+ ): Promise<any>;
55415
55568
  /**
55416
55569
  * @SINCE 1.38.0
55417
55570
  *
@@ -65544,25 +65697,6 @@ declare namespace sap {
65544
65697
  * @returns Returns the number of entries in the tree
65545
65698
  */
65546
65699
  getLength(): number;
65547
- /**
65548
- * Gets an array of nodes for the requested part of the tree.
65549
- *
65550
- * @returns The requested tree nodes
65551
- */
65552
- getNodes(
65553
- /**
65554
- * The index of the first requested node
65555
- */
65556
- iStartIndex: number,
65557
- /**
65558
- * The maximum number of returned nodes; if not given the model's size limit is used; see {@link sap.ui.model.Model#setSizeLimit}
65559
- */
65560
- iLength: number,
65561
- /**
65562
- * The maximum number of nodes to read additionally as buffer
65563
- */
65564
- iThreshold?: number
65565
- ): object[];
65566
65700
  }
65567
65701
  /**
65568
65702
  * @deprecated - use {@link sap.ui.model.TreeBindingAdapter} instead
@@ -66003,7 +66137,9 @@ declare namespace sap {
66003
66137
  * If this flag is set to `true`, the mobile variant of the browser is used or a tablet or phone device
66004
66138
  * is detected.
66005
66139
  *
66006
- * **Note:** This information might not be available for all browsers.
66140
+ * **Note:** This information might not be available for all browsers. **Note:** The flag is also set to
66141
+ * `true` for any touch device, including laptops with touchscreen monitor. For more information, see the
66142
+ * documentation for {@link sap.ui.Device.system.combi} devices.
66007
66143
  */
66008
66144
  export const mobile: boolean;
66009
66145
 
@@ -66626,7 +66762,9 @@ declare namespace sap {
66626
66762
  * If this flag is set to `true`, the used browser supports touch events.
66627
66763
  *
66628
66764
  * **Note:** This flag indicates whether the used browser supports touch events or not. This does not necessarily
66629
- * mean that the used device has a touchable screen.
66765
+ * mean that the used device has a touchable screen. **Note:** This flag also affects other {@link sap.ui.Device}
66766
+ * properties. For more information, see the documentation for {@link sap.ui.Device.browser.mobile} and
66767
+ * {@link sap.ui.Device.system.combi} devices.
66630
66768
  */
66631
66769
  export const touch: boolean;
66632
66770
 
@@ -66991,6 +67129,17 @@ declare namespace sap {
66991
67129
  * @returns Metadata object describing this class
66992
67130
  */
66993
67131
  static getMetadata(): sap.ui.base.ManagedObjectMetadata;
67132
+ /**
67133
+ * Starts a drag event sequence for this control. To finish the drag, and drop the control on a specified
67134
+ * target, trigger a {@link sap.ui.test.actions.Drop} action on the target. Logs an error if control is
67135
+ * not visible (i.e. has no DOM representation)
67136
+ */
67137
+ executeOn(
67138
+ /**
67139
+ * the control on which the drag events are triggered
67140
+ */
67141
+ oControl: sap.ui.core.Control
67142
+ ): void;
66994
67143
  }
66995
67144
  /**
66996
67145
  * @SINCE 1.76
@@ -67064,6 +67213,17 @@ declare namespace sap {
67064
67213
  * @returns Metadata object describing this class
67065
67214
  */
67066
67215
  static getMetadata(): sap.ui.base.ManagedObjectMetadata;
67216
+ /**
67217
+ * Starts a drop event sequence for this control, such that a predefined source will be dropped on the control.
67218
+ * To start a drag sequence ad define the dragged source, trigger a {@link sap.ui.test.actions.Drag} action
67219
+ * on the source. Logs an error if control is not visible (i.e. has no DOM representation)
67220
+ */
67221
+ executeOn(
67222
+ /**
67223
+ * the control on which the drop events are triggered
67224
+ */
67225
+ oControl: sap.ui.core.Control
67226
+ ): void;
67067
67227
  /**
67068
67228
  * Gets current value of property {@link #getAfter after}.
67069
67229
  *
@@ -67182,6 +67342,21 @@ declare namespace sap {
67182
67342
  */
67183
67343
  mSettings?: sap.ui.test.actions.$EnterTextSettings
67184
67344
  );
67345
+ /**
67346
+ * @SINCE 1.70
67347
+ *
67348
+ * A map of ID suffixes for controls that require a special DOM reference for `EnterText` interaction.
67349
+ *
67350
+ * You can specify an ID suffix for specific controls in this map. The enter text action will be triggered
67351
+ * on the DOM element with the specified suffix.
67352
+ *
67353
+ * Here is a sublist of supported controls and their `EnterText` control adapter:
67354
+ * - sap.m.StepInput - internal Input
67355
+ */
67356
+ static controlAdapters: Record<
67357
+ string,
67358
+ string | ((p1: sap.ui.core.Control) => string)
67359
+ >;
67185
67360
 
67186
67361
  /**
67187
67362
  * Creates a new subclass of class sap.ui.test.actions.EnterText with name `sClassName` and enriches it
@@ -67374,6 +67549,31 @@ declare namespace sap {
67374
67549
  */
67375
67550
  mSettings?: sap.ui.test.actions.$PressSettings
67376
67551
  );
67552
+ /**
67553
+ * @SINCE 1.63
67554
+ *
67555
+ * A map of ID suffixes for controls that require a special DOM reference for `Press` interaction.
67556
+ *
67557
+ * You can specify an ID suffix for specific controls in this map. The press action will be triggered on
67558
+ * the DOM element with the specified suffix.
67559
+ *
67560
+ * Here is a sublist of supported controls and their `Press` control adapter:
67561
+ * - sap.m.ComboBox - Arrow button
67562
+ * - sap.m.SearchField - Search Button
67563
+ * - sap.m.Input - Value help
67564
+ * - sap.m.List - More Button
67565
+ * - sap.m.Table - More Button
67566
+ * - sap.m.ObjectIdentifier - Title
67567
+ * - sap.m.ObjectAttribute - Text
67568
+ * - sap.m.Page - Back Button
67569
+ * - sap.m.semantic.FullscreenPage - Back Button
67570
+ * - sap.m.semantic.DetailPage - Back Button
67571
+ * - sap.ui.comp.smartfilterbar.SmartFilterBar - Go Button
67572
+ */
67573
+ static controlAdapters: Record<
67574
+ string,
67575
+ string | ((p1: sap.ui.core.Control) => string)
67576
+ >;
67377
67577
 
67378
67578
  /**
67379
67579
  * Creates a new subclass of class sap.ui.test.actions.Press with name `sClassName` and enriches it with
@@ -69721,8 +69921,8 @@ declare namespace sap {
69721
69921
  /**
69722
69922
  * Creates a matcher function that returns an aggregation element of a control at a given index.
69723
69923
  *
69724
- * @returns the matcher function returns the item at a certain index in the aggregation or null if index
69725
- * not in range
69924
+ * @returns the matcher function returns the item at a certain index in the aggregation or `undefined` if
69925
+ * index not in range
69726
69926
  */
69727
69927
  aggregationAtIndex(
69728
69928
  /**
@@ -71884,7 +72084,7 @@ declare namespace sap {
71884
72084
  */
71885
72085
  controlType?: string | Function;
71886
72086
  }
71887
- ): sap.ui.core.Element | sap.ui.core.Element[];
72087
+ ): sap.ui.core.Element | sap.ui.core.Element[] | null;
71888
72088
  /**
71889
72089
  * Gets the constructor function of a certain controlType
71890
72090
  *
@@ -72006,14 +72206,14 @@ declare namespace sap {
72006
72206
  * Returns the view with a specific name. The result should be a unique view. If there are multiple visible
72007
72207
  * views with that name, none will be returned.
72008
72208
  *
72009
- * @returns or undefined
72209
+ * @returns Unique view or `undefined`
72010
72210
  */
72011
72211
  getView(
72012
72212
  /**
72013
- * the name of the view
72213
+ * Name of the view
72014
72214
  */
72015
72215
  sViewName: string
72016
- ): sap.ui.core.mvc.View;
72216
+ ): sap.ui.core.mvc.View | undefined;
72017
72217
  }
72018
72218
  /**
72019
72219
  * @SINCE 1.26
@@ -72418,6 +72618,8 @@ declare namespace sap {
72418
72618
 
72419
72619
  "sap/ui/base/ObjectPool": undefined;
72420
72620
 
72621
+ "sap/ui/base/SyncPromise": undefined;
72622
+
72421
72623
  "sap/ui/core/AppCacheBuster": undefined;
72422
72624
 
72423
72625
  "sap/ui/core/BusyIndicator": undefined;