@openui5/ts-types 1.143.1 → 1.145.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.
@@ -279,7 +279,7 @@ declare namespace sap {
279
279
  "sap/ui/thirdparty/qunit-2": undefined;
280
280
  }
281
281
  }
282
- // For Library Version: 1.143.1
282
+ // For Library Version: 1.145.0
283
283
 
284
284
  declare module "sap/base/assert" {
285
285
  /**
@@ -1471,8 +1471,8 @@ declare module "sap/base/i18n/ResourceBundle" {
1471
1471
  bundleName?: string;
1472
1472
  /**
1473
1473
  * Optional locale (aka 'language tag') to load the texts for. Can either be a BCP47 language tag or a JDK
1474
- * compatible locale string (e.g. "en-GB", "en_GB" or "en"). Defaults to the current session locale if `sap.ui.getCore`
1475
- * is available, otherwise to the provided `fallbackLocale`
1474
+ * compatible locale string (e.g. "en-GB", "en_GB" or "en"). Defaults to the current session locale ({@link module:sap/base/i18n/Localization.getLanguage Localization.getLanguage})
1475
+ * if available, otherwise to the provided `fallbackLocale`
1476
1476
  */
1477
1477
  locale?: string;
1478
1478
  /**
@@ -4943,7 +4943,7 @@ declare module "sap/ui/core/message/MessageType" {
4943
4943
 
4944
4944
  declare module "sap/ui/core/Messaging" {
4945
4945
  /**
4946
- * Messaging provides a central place for managing `sap.ui.core.message.Messages`.
4946
+ * Messaging provides a central place for managing `sap.ui.core.message.Message`s.
4947
4947
  *
4948
4948
  * @since 1.118.0
4949
4949
  */
@@ -4953,7 +4953,7 @@ declare module "sap/ui/core/Messaging" {
4953
4953
  */
4954
4954
  addMessages(
4955
4955
  /**
4956
- * Array of sap.ui.core.message.Message or single sap.ui.core.message.Message
4956
+ * Array of `Message` or single `Message`
4957
4957
  */
4958
4958
  vMessages: sap.ui.core.message.Message | sap.ui.core.message.Message[]
4959
4959
  ): void;
@@ -7206,14 +7206,15 @@ declare module "sap/ui/test/starter/config" {
7206
7206
  */
7207
7207
  export type CoverageConfiguration = {
7208
7208
  /**
7209
- * List of modules or packages that should be instrumented. If not given, all modules are instrumented.
7210
- * Default is null
7209
+ * A single module or package name, or a list of such names, that should be instrumented. If not given,
7210
+ * all modules are instrumented. Default is null
7211
7211
  */
7212
- only?: string[];
7212
+ only?: string | string[];
7213
7213
  /**
7214
- * List of modules or packages that never should be instrumented. Default is null
7214
+ * A single module or package name, or a list of such names, that never should be instrumented. Default
7215
+ * is null
7215
7216
  */
7216
- never?: string[];
7217
+ never?: string | string[];
7217
7218
 
7218
7219
  branchTracking?: boolean;
7219
7220
  /**
@@ -11960,7 +11961,7 @@ declare namespace sap {
11960
11961
  /**
11961
11962
  * Metadata of the property
11962
11963
  */
11963
- oProperty?: /* was: sap.ui.base.ManagedObject.MetaOptions.Property */ any
11964
+ oProperty?: sap.ui.base.ManagedObject.MetadataOptions.Property
11964
11965
  ): sap.ui.base.DataType | undefined;
11965
11966
  /**
11966
11967
  * Registers an enum under the given name. With version 2.0, registering an enum becomes mandatory when
@@ -18560,7 +18561,7 @@ declare namespace sap {
18560
18561
  * since 1.34.0 contains pattern symbols (e.g. "yMMMd" or "Hms") which will be converted into the pattern
18561
18562
  * in the used locale, which matches the wanted symbols best. The symbols must be in canonical order, that
18562
18563
  * is: Era (G), Year (y/Y), Quarter (q/Q), Month (M/L), Week (w), Day-Of-Week (E/e/c), Day (d), Hour (h/H/k/K/j/J),
18563
- * Minute (m), Second (s), Timezone (z/Z/v/V/O/X/x) See {@link http://unicode.org/reports/tr35/tr35-dates.html#availableFormats_appendItems}
18564
+ * Minute (m), Second (s), Timezone (z/Z/v/V/O/X/x) See {@link https://unicode.org/reports/tr35/tr35-dates.html#availableFormats_appendItems Unicode Locale Data Markup Language (LDML): Elements availableFormats, appendItems}.
18564
18565
  */
18565
18566
  format?: string;
18566
18567
  /**
@@ -18673,7 +18674,7 @@ declare namespace sap {
18673
18674
  * since 1.34.0 contains pattern symbols (e.g. "yMMMd" or "Hms") which will be converted into the pattern
18674
18675
  * in the used locale, which matches the wanted symbols best. The symbols must be in canonical order, that
18675
18676
  * is: Era (G), Year (y/Y), Quarter (q/Q), Month (M/L), Week (w), Day-Of-Week (E/e/c), Day (d), Hour (h/H/k/K/j/J),
18676
- * Minute (m), Second (s), Timezone (z/Z/v/V/O/X/x) See http://unicode.org/reports/tr35/tr35-dates.html#availableFormats_appendItems
18677
+ * Minute (m), Second (s), Timezone (z/Z/v/V/O/X/x) See {@link https://unicode.org/reports/tr35/tr35-dates.html#availableFormats_appendItems Unicode Locale Data Markup Language (LDML): Elements availableFormats, appendItems}.
18677
18678
  */
18678
18679
  format?: string;
18679
18680
  /**
@@ -18790,7 +18791,7 @@ declare namespace sap {
18790
18791
  * A string containing pattern symbols (e.g. "yMMMd" or "Hms") which will be converted into a pattern for
18791
18792
  * the used locale that matches the wanted symbols best. The symbols must be in canonical order, that is:
18792
18793
  * Era (G), Year (y/Y), Quarter (q/Q), Month (M/L), Week (w), Day-Of-Week (E/e/c), Day (d), Hour (h/H/k/K/j/J),
18793
- * Minute (m), Second (s), Timezone (z/Z/v/V/O/X/x) See http://unicode.org/reports/tr35/tr35-dates.html#availableFormats_appendItems
18794
+ * Minute (m), Second (s), Timezone (z/Z/v/V/O/X/x) See {@link https://unicode.org/reports/tr35/tr35-dates.html#availableFormats_appendItems Unicode Locale Data Markup Language (LDML): Elements availableFormats, appendItems}.
18794
18795
  */
18795
18796
  format?: string;
18796
18797
  /**
@@ -18898,7 +18899,7 @@ declare namespace sap {
18898
18899
  * since 1.34.0 contains pattern symbols (e.g. "yMMMd" or "Hms") which will be converted into the pattern
18899
18900
  * in the used locale, which matches the wanted symbols best. The symbols must be in canonical order, that
18900
18901
  * is: Era (G), Year (y/Y), Quarter (q/Q), Month (M/L), Week (w), Day-Of-Week (E/e/c), Day (d), Hour (h/H/k/K/j/J),
18901
- * Minute (m), Second (s), Timezone (z/Z/v/V/O/X/x) See http://unicode.org/reports/tr35/tr35-dates.html#availableFormats_appendItems
18902
+ * Minute (m), Second (s), Timezone (z/Z/v/V/O/X/x) See {@link https://unicode.org/reports/tr35/tr35-dates.html#availableFormats_appendItems Unicode Locale Data Markup Language (LDML): Elements availableFormats, appendItems}.
18902
18903
  */
18903
18904
  format?: string;
18904
18905
  /**
@@ -20674,17 +20675,6 @@ declare namespace sap {
20674
20675
  */
20675
20676
  constructor();
20676
20677
 
20677
- /**
20678
- * Add messages to Messaging
20679
- */
20680
- static addMessages(
20681
- /**
20682
- * Array of sap.ui.core.message.Message or single sap.ui.core.message.Message
20683
- */
20684
- vMessages:
20685
- | sap.ui.core.message.Message
20686
- | sap.ui.core.message.Message[]
20687
- ): void;
20688
20678
  /**
20689
20679
  * Creates a new subclass of class sap.ui.core.message.MessageManager with name `sClassName` and enriches
20690
20680
  * it with the information contained in `oClassInfo`.
@@ -20710,23 +20700,34 @@ declare namespace sap {
20710
20700
  FNMetaImpl?: Function
20711
20701
  ): Function;
20712
20702
  /**
20713
- * Get the MessageModel
20703
+ * Returns a metadata object for class sap.ui.core.message.MessageManager.
20714
20704
  *
20715
20705
  *
20716
- * @returns oMessageModel The Message Model
20706
+ * @returns Metadata object describing this class
20707
+ */
20708
+ static getMetadata(): sap.ui.base.Metadata;
20709
+ /**
20710
+ * Add messages to Messaging
20717
20711
  */
20718
- static getMessageModel(): sap.ui.model.message.MessageModel;
20712
+ addMessages(
20713
+ /**
20714
+ * Array of `Message` or single `Message`
20715
+ */
20716
+ vMessages:
20717
+ | sap.ui.core.message.Message
20718
+ | sap.ui.core.message.Message[]
20719
+ ): void;
20719
20720
  /**
20720
- * Returns a metadata object for class sap.ui.core.message.MessageManager.
20721
+ * Get the MessageModel
20721
20722
  *
20722
20723
  *
20723
- * @returns Metadata object describing this class
20724
+ * @returns oMessageModel The Message Model
20724
20725
  */
20725
- static getMetadata(): sap.ui.base.Metadata;
20726
+ getMessageModel(): sap.ui.model.message.MessageModel;
20726
20727
  /**
20727
20728
  * Register MessageProcessor
20728
20729
  */
20729
- static registerMessageProcessor(
20730
+ registerMessageProcessor(
20730
20731
  /**
20731
20732
  * The MessageProcessor
20732
20733
  */
@@ -20738,7 +20739,7 @@ declare namespace sap {
20738
20739
  * ManagedObjects, the Messaging attaches to these events and creates a `sap.ui.core.message.Message` (bHandleValidation=true)
20739
20740
  * for each of these errors and cancels the event bubbling.
20740
20741
  */
20741
- static registerObject(
20742
+ registerObject(
20742
20743
  /**
20743
20744
  * The sap.ui.base.ManagedObject
20744
20745
  */
@@ -20752,11 +20753,11 @@ declare namespace sap {
20752
20753
  /**
20753
20754
  * Remove all messages
20754
20755
  */
20755
- static removeAllMessages(): void;
20756
+ removeAllMessages(): void;
20756
20757
  /**
20757
20758
  * Remove given Messages
20758
20759
  */
20759
- static removeMessages(
20760
+ removeMessages(
20760
20761
  /**
20761
20762
  * The message(s) to be removed.
20762
20763
  */
@@ -20767,7 +20768,7 @@ declare namespace sap {
20767
20768
  /**
20768
20769
  * Deregister MessageProcessor
20769
20770
  */
20770
- static unregisterMessageProcessor(
20771
+ unregisterMessageProcessor(
20771
20772
  /**
20772
20773
  * The MessageProcessor
20773
20774
  */
@@ -20776,7 +20777,7 @@ declare namespace sap {
20776
20777
  /**
20777
20778
  * Unregister ManagedObject
20778
20779
  */
20779
- static unregisterObject(
20780
+ unregisterObject(
20780
20781
  /**
20781
20782
  * The sap.ui.base.ManagedObject
20782
20783
  */
@@ -20787,7 +20788,7 @@ declare namespace sap {
20787
20788
  *
20788
20789
  * The old ones will be removed, the new ones will be added.
20789
20790
  */
20790
- static updateMessages(
20791
+ updateMessages(
20791
20792
  /**
20792
20793
  * Array of old messages to be removed
20793
20794
  */
@@ -22519,15 +22520,15 @@ declare namespace sap {
22519
22520
  */
22520
22521
  sViewType: string,
22521
22522
  /**
22522
- * declares if the vPreprocessor ensures safe sync processing. This means the preprocessor will be executed
22523
- * also for sync views. Please be aware that any kind of async processing (like Promises, XHR, etc) may
22524
- * break the view initialization and lead to unexpected results.
22523
+ * Deprecated as of version 1.145, because this parameter is only applicable to sync views and is no longer
22524
+ * used. Declares if the vPreprocessor ensures safe sync processing. This means the preprocessor will be
22525
+ * executed also for sync views. Please be aware that any kind of async processing (like Promises, XHR,
22526
+ * etc) may break the view initialization and lead to unexpected results.
22525
22527
  */
22526
22528
  bSyncSupport: boolean,
22527
22529
  /**
22528
22530
  * on-demand preprocessor which enables developers to quickly activate the preprocessor for a view, by setting
22529
- * `preprocessors : { xml }`, for example. This should be false except for very special cases. There can
22530
- * only be one on-demand preprocessor per content type.
22531
+ * `preprocessors : { xml }`, for example. There can only be one on-demand preprocessor per content type.
22531
22532
  */
22532
22533
  bOnDemand?: boolean,
22533
22534
  /**
@@ -23458,9 +23459,10 @@ declare namespace sap {
23458
23459
  */
23459
23460
  sViewType: string,
23460
23461
  /**
23461
- * declares if the vPreprocessor ensures safe sync processing. This means the preprocessor will be executed
23462
- * also for sync views. Please be aware that any kind of async processing (like Promises, XHR, etc) may
23463
- * break the view initialization and lead to unexpected results.
23462
+ * Deprecated as of version 1.145, because this parameter is only applicable to sync views and is no longer
23463
+ * used. Declares if the vPreprocessor ensures safe sync processing. This means the preprocessor will be
23464
+ * executed also for sync views. Please be aware that any kind of async processing (like Promises, XHR,
23465
+ * etc) may break the view initialization and lead to unexpected results.
23464
23466
  */
23465
23467
  bSyncSupport: boolean,
23466
23468
  /**
@@ -23507,9 +23509,10 @@ declare namespace sap {
23507
23509
  p3: object
23508
23510
  ) => void),
23509
23511
  /**
23510
- * declares if the vPreprocessor ensures safe sync processing. This means the preprocessor will be executed
23511
- * also for sync views. Please be aware that any kind of async processing (like Promises, XHR, etc) may
23512
- * break the view initialization and lead to unexpected results.
23512
+ * Deprecated as of version 1.145, because this parameter is only applicable to sync views and is no longer
23513
+ * used. Declares if the vPreprocessor ensures safe sync processing. This means the preprocessor will be
23514
+ * executed also for sync views. Please be aware that any kind of async processing (like Promises, XHR,
23515
+ * etc) may break the view initialization and lead to unexpected results.
23513
23516
  */
23514
23517
  bSyncSupport: boolean,
23515
23518
  /**
@@ -24699,6 +24702,54 @@ declare namespace sap {
24699
24702
  }
24700
24703
 
24701
24704
  namespace LocaleData {
24705
+ /**
24706
+ * Type which describes the difference in the date field groups of the two dates of an date time interval.
24707
+ * The keys are the names of the date field symbol groups. If one of them is set, the value should be set
24708
+ * to `true`.
24709
+ */
24710
+ type DateFieldGroupsDifference = {
24711
+ /**
24712
+ * The era date field symbol group
24713
+ */
24714
+ Era?: boolean;
24715
+ /**
24716
+ * The year date field symbol group
24717
+ */
24718
+ Year?: boolean;
24719
+ /**
24720
+ * The quarter date field symbol group
24721
+ */
24722
+ Quarter?: boolean;
24723
+ /**
24724
+ * The month date field symbol group
24725
+ */
24726
+ Month?: boolean;
24727
+ /**
24728
+ * The week date field symbol group
24729
+ */
24730
+ Week?: boolean;
24731
+ /**
24732
+ * The day date field symbol group
24733
+ */
24734
+ Day?: boolean;
24735
+ /**
24736
+ * The day period date field symbol group
24737
+ */
24738
+ DayPeriod?: boolean;
24739
+ /**
24740
+ * The hour date field symbol group
24741
+ */
24742
+ Hour?: boolean;
24743
+ /**
24744
+ * The minute date field symbol group
24745
+ */
24746
+ Minute?: boolean;
24747
+ /**
24748
+ * The second date field symbol group
24749
+ */
24750
+ Second?: boolean;
24751
+ };
24752
+
24702
24753
  /**
24703
24754
  * A relative time pattern.
24704
24755
  */
@@ -28868,7 +28919,7 @@ declare namespace sap {
28868
28919
  get(
28869
28920
  /**
28870
28921
  * the (array with) CSS parameter name(s) or an object containing the (array with) CSS parameter name(s),
28871
- * the scopeElement and a callback for async retrieval of parameters.
28922
+ * and a callback for async retrieval of parameters.
28872
28923
  */
28873
28924
  vName:
28874
28925
  | string
@@ -28878,22 +28929,12 @@ declare namespace sap {
28878
28929
  * the (array with) CSS parameter name(s)
28879
28930
  */
28880
28931
  name: string | string[];
28881
- /**
28882
- * Element / control instance to take into account when looking for a parameter value. This can make a difference
28883
- * when a parameter value is overridden in a theme scope set via a CSS class.
28884
- */
28885
- scopeElement?: sap.ui.core.Element;
28886
28932
  /**
28887
28933
  * If given, the callback is only executed in case there are still parameters pending and one or more of
28888
28934
  * the requested parameters is missing.
28889
28935
  */
28890
28936
  callback?: (p1: sap.ui.core.theming.Parameters.Value) => void;
28891
- },
28892
- /**
28893
- * Element / control instance to take into account when looking for a parameter value. This can make a difference
28894
- * when a parameter value is overridden in a theme scope set via a CSS class.
28895
- */
28896
- oElement?: sap.ui.core.Element
28937
+ }
28897
28938
  ): sap.ui.core.theming.Parameters.Value;
28898
28939
  /**
28899
28940
  * Resets the CSS parameters which finally will reload the parameters the next time they are queried via
@@ -30414,7 +30455,7 @@ declare namespace sap {
30414
30455
  * "controlId": "App",
30415
30456
  * "controlAggregation": "pages",
30416
30457
  * "viewNamespace": "myApplication.namespace",
30417
- * // If you are using the mobile library, you have to use an sap.m.Router, to get support for
30458
+ * // If you are using the mobile library, you have to use an sap.m.routing.Router, to get support for
30418
30459
  * // the controls sap.m.App, sap.m.SplitApp, sap.m.NavContainer and sap.m.SplitContainer.
30419
30460
  * "routerClass": "sap.m.routing.Router",
30420
30461
  * // What happens if no route matches the hash?
@@ -33711,6 +33752,18 @@ declare namespace sap {
33711
33752
  __implements__sap_ui_core_IShrinkable: boolean;
33712
33753
  }
33713
33754
 
33755
+ /**
33756
+ * Interface for controls that represent a title.
33757
+ *
33758
+ * This marker interface can be implemented by controls that are semantically suitable to act as a title
33759
+ * or heading inside a toolbar.
33760
+ *
33761
+ * @since 1.144
33762
+ */
33763
+ interface ITitle {
33764
+ __implements__sap_ui_core_ITitle: boolean;
33765
+ }
33766
+
33714
33767
  /**
33715
33768
  * Marker interface for controls that can be used in `content` aggregation of the `sap.m.Title` control.
33716
33769
  *
@@ -34123,13 +34176,13 @@ declare namespace sap {
34123
34176
 
34124
34177
  /**
34125
34178
  * Dependents are not rendered, but their databinding context and lifecycle are bound to the aggregating
34126
- * Element.
34179
+ * ManagedObject.
34127
34180
  *
34128
34181
  * @since 1.19
34129
34182
  */
34130
34183
  dependents?:
34131
- | sap.ui.core.Element[]
34132
- | sap.ui.core.Element
34184
+ | sap.ui.base.ManagedObject[]
34185
+ | sap.ui.base.ManagedObject
34133
34186
  | sap.ui.base.ManagedObject.AggregationBindingInfo
34134
34187
  | `{${string}}`;
34135
34188
 
@@ -36633,7 +36686,7 @@ declare namespace sap {
36633
36686
  /**
36634
36687
  * Returns the registered element for the given ID, if any.
36635
36688
  *
36636
- * @deprecated As of version 1.1. use `sap.ui.core.Core.byId` instead!
36689
+ * @deprecated As of version 1.1. use `sap.ui.core.Core.prototype.byId` instead!
36637
36690
  *
36638
36691
  * @returns Element for the given ID or `undefined`
36639
36692
  */
@@ -39748,7 +39801,7 @@ declare namespace sap {
39748
39801
  *
39749
39802
  * The configuration above can be accessed via `sample.Component.getMetadata().getCustomEntry("my.custom.config")`.
39750
39803
  *
39751
- * @deprecated As of version 1.27.1. Please use the sap.ui.core.ComponentMetadata#getManifestEntry
39804
+ * @deprecated As of version 1.27.1. without replacement.
39752
39805
  *
39753
39806
  * @returns custom Component configuration with the specified key.
39754
39807
  */
@@ -41274,7 +41327,7 @@ declare namespace sap {
41274
41327
  /**
41275
41328
  * The dependent to add; if empty, nothing is inserted
41276
41329
  */
41277
- oDependent: sap.ui.core.Element
41330
+ oDependent: sap.ui.base.ManagedObject
41278
41331
  ): this;
41279
41332
  /**
41280
41333
  * Adds some dragDropConfig to the aggregation {@link #getDragDropConfig dragDropConfig}.
@@ -41658,11 +41711,11 @@ declare namespace sap {
41658
41711
  * Gets content of aggregation {@link #getDependents dependents}.
41659
41712
  *
41660
41713
  * Dependents are not rendered, but their databinding context and lifecycle are bound to the aggregating
41661
- * Element.
41714
+ * ManagedObject.
41662
41715
  *
41663
41716
  * @since 1.19
41664
41717
  */
41665
- getDependents(): sap.ui.core.Element[];
41718
+ getDependents(): sap.ui.base.ManagedObject[];
41666
41719
  /**
41667
41720
  * Returns the best suitable DOM Element that represents this UI5 Element. By default the DOM Element with
41668
41721
  * the same ID as this Element is returned. Subclasses should override this method if the lookup via id
@@ -41835,8 +41888,8 @@ declare namespace sap {
41835
41888
  oCustomData: sap.ui.core.CustomData
41836
41889
  ): int;
41837
41890
  /**
41838
- * Checks for the provided `sap.ui.core.Element` in the aggregation {@link #getDependents dependents}. and
41839
- * returns its index if found or -1 otherwise.
41891
+ * Checks for the provided `sap.ui.base.ManagedObject` in the aggregation {@link #getDependents dependents}.
41892
+ * and returns its index if found or -1 otherwise.
41840
41893
  *
41841
41894
  * @since 1.19
41842
41895
  *
@@ -41846,7 +41899,7 @@ declare namespace sap {
41846
41899
  /**
41847
41900
  * The dependent whose index is looked for
41848
41901
  */
41849
- oDependent: sap.ui.core.Element
41902
+ oDependent: sap.ui.base.ManagedObject
41850
41903
  ): int;
41851
41904
  /**
41852
41905
  * Checks for the provided `sap.ui.core.dnd.DragDropBase` in the aggregation {@link #getDragDropConfig dragDropConfig}.
@@ -41910,7 +41963,7 @@ declare namespace sap {
41910
41963
  /**
41911
41964
  * The dependent to insert; if empty, nothing is inserted
41912
41965
  */
41913
- oDependent: sap.ui.core.Element,
41966
+ oDependent: sap.ui.base.ManagedObject,
41914
41967
  /**
41915
41968
  * The `0`-based index the dependent should be inserted at; for a negative value of `iIndex`, the dependent
41916
41969
  * is inserted at position 0; for a value greater than the current size of the aggregation, the dependent
@@ -42049,7 +42102,7 @@ declare namespace sap {
42049
42102
  *
42050
42103
  * @returns An array of the removed elements (might be empty)
42051
42104
  */
42052
- removeAllDependents(): sap.ui.core.Element[];
42105
+ removeAllDependents(): sap.ui.base.ManagedObject[];
42053
42106
  /**
42054
42107
  * Removes all the controls from the aggregation {@link #getDragDropConfig dragDropConfig}.
42055
42108
  *
@@ -42083,8 +42136,8 @@ declare namespace sap {
42083
42136
  /**
42084
42137
  * The dependent to remove or its index or id
42085
42138
  */
42086
- vDependent: int | string | sap.ui.core.Element
42087
- ): sap.ui.core.Element | null;
42139
+ vDependent: int | string | sap.ui.base.ManagedObject
42140
+ ): sap.ui.base.ManagedObject | null;
42088
42141
  /**
42089
42142
  * Removes a dragDropConfig from the aggregation {@link #getDragDropConfig dragDropConfig}.
42090
42143
  *
@@ -42568,9 +42621,9 @@ declare namespace sap {
42568
42621
  * which returns the UI control tree defined inside the Fragments. When used within declarative Views, the
42569
42622
  * Fragment content is imported and seamlessly integrated into the View.
42570
42623
  *
42571
- * Fragments are used similar as sap.ui.core.mvc.Views, but Fragments do not have a Controller on their
42572
- * own (they may know one, though), they are not a Control, they are not part of the UI tree and they have
42573
- * no representation in HTML. By default, in contrast to declarative Views, they do not do anything to guarantee
42624
+ * Fragments are used similar as sap.ui.core.mvc.View, but Fragments do not have a Controller on their own
42625
+ * (they may know one, though), they are not a Control, they are not part of the UI tree and they have no
42626
+ * representation in HTML. By default, in contrast to declarative Views, they do not do anything to guarantee
42574
42627
  * ID uniqueness.
42575
42628
  *
42576
42629
  * But like Views they can be defined in several Formats (XML and JavaScript; support for other types can
@@ -45499,7 +45552,7 @@ declare namespace sap {
45499
45552
  * that is: Era (G), Year (y/Y), Quarter (q/Q), Month (M/L), Week (w/W), Day-Of-Week (E/e/c), Day (d/D),
45500
45553
  * Hour (h/H/k/K/), Minute (m), Second (s), Timezone (z/Z/v/V/O/X/x)
45501
45554
  *
45502
- * See https://unicode.org/reports/tr35/tr35-dates.html#availableFormats_appendItems
45555
+ * See {@link https://unicode.org/reports/tr35/tr35-dates.html#availableFormats_appendItems Unicode - Available Formats}
45503
45556
  *
45504
45557
  * @since 1.46
45505
45558
  *
@@ -45513,11 +45566,14 @@ declare namespace sap {
45513
45566
  sSkeleton: string,
45514
45567
  /**
45515
45568
  * is either a string which represents the symbol matching the greatest difference in the two dates to format
45516
- * or an object which contains key-value pairs. The value is always true. The key is one of the date field
45517
- * symbol groups whose value are different between the two dates. The key can only be set with 'Year', 'Quarter',
45518
- * 'Month', 'Week', 'Day', 'DayPeriod', 'Hour', 'Minute', or 'Second'.
45569
+ * or an object which contains key-value pairs. The value is always `true`. The key is one of the date field
45570
+ * symbol groups whose value are different between the two dates. The key can only be set with: `'Era',
45571
+ * 'Year', 'Quarter', 'Month', 'Week', 'Day', 'DayPeriod', 'Hour','Minute', 'Second'`. For more information,
45572
+ * see {@link https://unicode.org/reports/tr35/tr35-dates.html#element-intervalformats Unicode - Element intervalFormats}.
45519
45573
  */
45520
- vGreatestDiff: object | string,
45574
+ vGreatestDiff:
45575
+ | sap.ui.core.LocaleData.DateFieldGroupsDifference
45576
+ | string,
45521
45577
  /**
45522
45578
  * the type of calendar. If it's not set, it falls back to the calendar type either set in configuration
45523
45579
  * or calculated from locale.
@@ -47573,7 +47629,8 @@ declare namespace sap {
47573
47629
  /**
47574
47630
  * A class that handles the rendering of controls.
47575
47631
  *
47576
- * For the default rendering task of UI5, a shared RenderManager is created and owned by `sap.ui.core.Core`.
47632
+ * For the default rendering task of UI5, a shared RenderManager is created and owned by the framework.
47633
+ *
47577
47634
  * Controls or other code that want to render controls outside the default rendering task can create a private
47578
47635
  * instance of RenderManager by calling the {@link sap.ui.core.Core#createRenderManager sap.ui.getCore().createRenderManager() }
47579
47636
  * method. When such a private instance is no longer needed, it should be {@link #destroy destroyed}.
@@ -50686,7 +50743,144 @@ declare namespace sap {
50686
50743
  * sap.ui.core.Fragment
50687
50744
  * {@link https://ui5.sap.com/#/topic/b83a4dcb7d0e46969027345b8d32fd44 XML Composite Controls}
50688
50745
  */
50689
- constructor();
50746
+ constructor(
50747
+ /**
50748
+ * Initial settings for the new control
50749
+ */
50750
+ mSettings?: sap.ui.core.$XMLCompositeSettings
50751
+ );
50752
+ /**
50753
+ * XMLComposite is the base class for composite controls that use a XML fragment representation for their
50754
+ * visual parts. From a user perspective such controls appear as any other control, but internally the rendering
50755
+ * part is added as a fragment. The fragment that is used should appear in the same folder as the control's
50756
+ * JS implementation with the file extension `.control.xml`. The fragment's content can access the interface
50757
+ * data from the XMLComposite control via bindings. Currently only aggregations and properties can be used
50758
+ * with bindings inside a fragment. The exposed model that is used for internal bindings in the fragment
50759
+ * has the default name `$this`. The name will always start with an `$`. The metadata of the derived control
50760
+ * can define the alias with its metadata. A code example can be found below.
50761
+ *
50762
+ * As XMLComposites compose other controls, they are only invalidated and re-rendered if explicitly defined.
50763
+ * Additional metadata for invalidation can be given for properties and aggregation. The default invalidation
50764
+ * is `"none"`. Setting invalidate to `true` for properties and aggregations sets the complete XMLComposite
50765
+ * to invalidate and rerender.
50766
+ *
50767
+ * Example:
50768
+ * ```javascript
50769
+ *
50770
+ * XMLComposite.extend("sap.mylib.MyXMLComposite", {
50771
+ * metadata : {
50772
+ * library: "sap.mylib",
50773
+ * properties : {
50774
+ * text: { //changing this property will not re-render the XMLComposite
50775
+ * type: "string",
50776
+ * defaultValue: ""
50777
+ * },
50778
+ * title: { //changing this property will re-render the XMLComposite as it defines invalidate: true
50779
+ * type: "string",
50780
+ * defaultValue: "",
50781
+ * invalidate: true
50782
+ * },
50783
+ * value: { //changing this property will re-render the XMLComposite as it defines invalidate: true
50784
+ * type: "string",
50785
+ * defaultValue: "",
50786
+ * invalidate: true
50787
+ * }
50788
+ * },
50789
+ * defaultProperty : "text",
50790
+ * aggregations : {
50791
+ * items : {
50792
+ * type: "sap.ui.core.Control",
50793
+ * invalidate: true
50794
+ * },
50795
+ * header : {
50796
+ * type: "sap.mylib.FancyHeader",
50797
+ * multiple : false
50798
+ * }
50799
+ * },
50800
+ * defaultAggregation : "items"
50801
+ * events: {
50802
+ * outerEvent : {
50803
+ * parameters : {
50804
+ * opener : "sap.ui.core.Control"
50805
+ * }
50806
+ * }
50807
+ * }
50808
+ * },
50809
+ * //alias defaults to "this"
50810
+ * alias: "mycontrolroot" //inner bindings will use model name $mycontrolroot
50811
+ * //fragment defaults to {control name}.control.xml in this case sap.mylib.MyXMLComposite.control.xml
50812
+ * fragment: "sap.mylib.MyXMLCompositeOther.control.xml" //the name of the fragment
50813
+ * });
50814
+ * ```
50815
+ *
50816
+ *
50817
+ * Internally the XMLComposite instantiates and initializes the given fragment and stores the resulting
50818
+ * control in a hidden aggregation named `_content`. The fragment should only include one root element.
50819
+ *
50820
+ * Bindings of inner controls to the interface of the XMLComposite can be done with normal binding syntax.
50821
+ * Here properties are used as property bindings and aggregations are used as list bindings. Currently it
50822
+ * is not possible to bind associations in a fragment.
50823
+ *
50824
+ * Example:
50825
+ * ```javascript
50826
+ *
50827
+ * <core:FragmentDefinition xmlns:m="sap.m" xmlns:core="sap.ui.core">
50828
+ * <m:Text text="{$this>text}" visible="{= ${$this>text} !== ""}" />
50829
+ * </core:FragmentDefinition>
50830
+ * ```
50831
+ *
50832
+ * ```javascript
50833
+ *
50834
+ * <core:FragmentDefinition xmlns:m="sap.m" xmlns:core="sap.ui.core">
50835
+ * <m:VBox items="{path:"$this>texts", filters:{path:"text", operator:"Contains", value1:"Text"}, sorter:{path:"text", descending:true}}">
50836
+ * <m:Text text="{$this>text}" />
50837
+ * </m:VBox>
50838
+ * </core:FragmentDefinition>
50839
+ * ```
50840
+ *
50841
+ * ```javascript
50842
+ *
50843
+ * <core:FragmentDefinition xmlns:m="sap.m" xmlns:core="sap.ui.core">
50844
+ * <m:Button text="Press Me" press="handlePress"/>
50845
+ * </core:FragmentDefinition>
50846
+ * ```
50847
+ *
50848
+ *
50849
+ * All events handled within the fragment will be dispatched to the XMLComposite control. It is recommended
50850
+ * to follow this paradigm to allow reuse of a XMLComposite without any dependency to controller code of
50851
+ * the current embedding view.
50852
+ *
50853
+ *
50854
+ * ```javascript
50855
+ *
50856
+ * MyXMLComposite.prototype.handlePress = function() {
50857
+ * this.fireOuterEvent(); // passing on the event to the outer view
50858
+ * }
50859
+ * ```
50860
+ *
50861
+ *
50862
+ * **Note:** {@link https://ui5.sap.com/#/topic/b11d853a8e784db6b2d210ef57b0f7d7 Requiring modules in XML }
50863
+ * will result in side effects that might cause the XMLComposite to not work properly. We suggest you require
50864
+ * the needed modules inside the JavaScript coding of the class extending the XMLComposite.
50865
+ *
50866
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
50867
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
50868
+ * of the syntax of the settings object.
50869
+ * See:
50870
+ * sap.ui.core.Control
50871
+ * sap.ui.core.Fragment
50872
+ * {@link https://ui5.sap.com/#/topic/b83a4dcb7d0e46969027345b8d32fd44 XML Composite Controls}
50873
+ */
50874
+ constructor(
50875
+ /**
50876
+ * ID for the new control, generated automatically if no ID is given
50877
+ */
50878
+ sId?: string,
50879
+ /**
50880
+ * Initial settings for the new control
50881
+ */
50882
+ mSettings?: sap.ui.core.$XMLCompositeSettings
50883
+ );
50690
50884
 
50691
50885
  /**
50692
50886
  * Creates a new subclass of class sap.ui.core.XMLComposite with name `sClassName` and enriches it with
@@ -54953,6 +55147,13 @@ declare namespace sap {
54953
55147
  * @returns true if and only one or more properties are measure properties.
54954
55148
  */
54955
55149
  hasMeasures(): boolean;
55150
+ /**
55151
+ * Initialize binding. Fires a change if data is already available ($expand) or a refresh. If metadata is
55152
+ * not yet available, do nothing, method will be called again when metadata is loaded.
55153
+ *
55154
+ * The ODataModel will call this on all bindings as soon as the metadata was loaded
55155
+ */
55156
+ initialize(): void;
54956
55157
  /**
54957
55158
  * Determines if a given name refers to a measure property
54958
55159
  *
@@ -55104,6 +55305,8 @@ declare namespace sap {
55104
55305
  *
55105
55306
  * Also handles clean-up after all responses (either success or error) have been collected. Instantiated
55106
55307
  * in AnalyticalBinding.prototype._executeBatchRequest()
55308
+ *
55309
+ * @deprecated As of version 1.144.0. will be replaced by OData V4 data aggregation, see {@link topic:7d914317c0b64c23824bf932cc8a4ae1 Extension for Data Aggregation}
55107
55310
  */
55108
55311
  class BatchResponseCollector {
55109
55312
  /**
@@ -55294,17 +55497,55 @@ declare namespace sap {
55294
55497
  * @returns Metadata object describing this class
55295
55498
  */
55296
55499
  static getMetadata(): sap.ui.base.Metadata;
55500
+ /**
55501
+ * Returns the value of the property for the given `sPath` and `oContext`.
55502
+ *
55503
+ * @deprecated As of version 1.145.0. use {@link #getProperty} instead
55504
+ *
55505
+ * @returns The value for the given `sPath` and `oContext`. If the property path derived from the given
55506
+ * `sPath` and `oContext` is absolute (starts with a "/") but does not lead to a property in the data structure,
55507
+ * `undefined` is returned. If the property `sPath` is not absolute, `null` is returned.
55508
+ */
55509
+ static getObject(
55510
+ /**
55511
+ * The path to the object you want to read
55512
+ */
55513
+ sPath: string,
55514
+ /**
55515
+ * The context that resolves the path
55516
+ */
55517
+ oContext?: sap.ui.model.Context
55518
+ ): any | null | undefined;
55519
+ /**
55520
+ * Returns the original value for the property with the given `sPath` and `oContext`.
55521
+ *
55522
+ * @deprecated As of version 1.145.0. use {@link #getProperty} instead
55523
+ *
55524
+ * @returns The value of the property for the given `sPath` and `oContext`. If the property path derived
55525
+ * from the given `sPath` and `oContext` is absolute (starts with a "/") but does not lead to a property
55526
+ * in the data structure, `undefined` is returned. If the property `sPath` is not absolute, `null` is returned.
55527
+ */
55528
+ static getOriginalProperty(
55529
+ /**
55530
+ * The path/name of the property
55531
+ */
55532
+ sPath: string,
55533
+ /**
55534
+ * Context for accessing the property value
55535
+ */
55536
+ oContext?: sap.ui.model.Context
55537
+ ): any | null | undefined;
55297
55538
  /**
55298
55539
  * Returns a Promise of the current data-loading state. Every currently running {@link sap.ui.model.json.JSONModel#loadData }
55299
55540
  * call is respected by the returned Promise. This also includes a potential loadData call from the JSONModel's
55300
55541
  * constructor in case a URL was given. The data-loaded Promise will resolve once all running requests have
55301
- * finished. Only request, which have been queued up to the point of calling this function will be respected
55542
+ * finished. Only requests, which have been queued up to the point of calling this function will be respected
55302
55543
  * by the returned Promise.
55303
55544
  *
55304
55545
  *
55305
55546
  * @returns a Promise, which resolves if all pending data-loading requests have finished
55306
55547
  */
55307
- dataLoaded(): Promise<any>;
55548
+ dataLoaded(): Promise<undefined>;
55308
55549
  /**
55309
55550
  * Serializes the current JSON data of the model into a string.
55310
55551
  *
@@ -55313,7 +55554,7 @@ declare namespace sap {
55313
55554
  */
55314
55555
  getJSON(): string;
55315
55556
  /**
55316
- * Returns the value for the property with the given path and context.
55557
+ * Returns the value for the given `sPath` and `oContext`.
55317
55558
  *
55318
55559
  *
55319
55560
  * @returns The value of the property. If the property is not found, `null` or `undefined` is returned.
@@ -55822,7 +56063,7 @@ declare namespace sap {
55822
56063
  *
55823
56064
  * @returns the type's name
55824
56065
  */
55825
- getName(): string;
56066
+ getName(): "sap.ui.model.odata.type.Boolean";
55826
56067
  /**
55827
56068
  * Parses the given value from the given type to a boolean.
55828
56069
  *
@@ -55925,7 +56166,7 @@ declare namespace sap {
55925
56166
  *
55926
56167
  * @returns the type's name
55927
56168
  */
55928
- getName(): string;
56169
+ getName(): "sap.ui.model.odata.type.Byte";
55929
56170
  /**
55930
56171
  * Returns the type's supported range as object with properties `minimum` and `maximum`.
55931
56172
  *
@@ -55933,7 +56174,11 @@ declare namespace sap {
55933
56174
  *
55934
56175
  * @returns the range
55935
56176
  */
55936
- getRange(): object;
56177
+ getRange(): {
56178
+ minimum: number;
56179
+
56180
+ maximum: number;
56181
+ };
55937
56182
  }
55938
56183
  /**
55939
56184
  * This class represents the `Currency` composite type with the parts amount, currency, and currency customizing.
@@ -56073,7 +56318,7 @@ declare namespace sap {
56073
56318
  *
56074
56319
  * @returns The type's name
56075
56320
  */
56076
- getName(): string;
56321
+ getName(): "sap.ui.model.odata.type.Currency";
56077
56322
  /**
56078
56323
  * Parses the given string value to an array containing amount and currency.
56079
56324
  * See:
@@ -56216,7 +56461,7 @@ declare namespace sap {
56216
56461
  *
56217
56462
  * @returns the type's name
56218
56463
  */
56219
- getName(): string;
56464
+ getName(): "sap.ui.model.odata.type.Date";
56220
56465
  /**
56221
56466
  * Parses the given value to a date.
56222
56467
  *
@@ -56342,7 +56587,7 @@ declare namespace sap {
56342
56587
  *
56343
56588
  * @returns the type's name
56344
56589
  */
56345
- getName(): string;
56590
+ getName(): "sap.ui.model.odata.type.DateTime";
56346
56591
  }
56347
56592
  /**
56348
56593
  * This is an abstract base class for the OData primitive types `Edm.DateTime` and `Edm.DateTimeOffset`.
@@ -56602,7 +56847,7 @@ declare namespace sap {
56602
56847
  *
56603
56848
  * @returns The type's name
56604
56849
  */
56605
- getName(): string;
56850
+ getName(): "sap.ui.model.odata.type.DateTimeOffset";
56606
56851
  /**
56607
56852
  * Parses the given value to a `Date` instance (OData V2) or a string like "1970-12-31T23:59:58Z" (OData
56608
56853
  * V4), depending on the model's OData version.
@@ -56728,7 +56973,7 @@ declare namespace sap {
56728
56973
  *
56729
56974
  * @returns The type's name
56730
56975
  */
56731
- getName(): string;
56976
+ getName(): "sap.ui.model.odata.type.DateTimeWithTimezone";
56732
56977
  /**
56733
56978
  * Gets an array of indices that determine which parts of this type shall not propagate their model messages
56734
56979
  * to the attached control. Prerequisite is that the corresponding binding supports this feature, see {@link sap.ui.model.Binding#supportsIgnoreMessages}.
@@ -56933,7 +57178,7 @@ declare namespace sap {
56933
57178
  *
56934
57179
  * @returns the type's name
56935
57180
  */
56936
- getName(): string;
57181
+ getName(): "sap.ui.model.odata.type.Decimal";
56937
57182
  /**
56938
57183
  * Parses the given value, which is expected to be of the given type, to a decimal in `string` representation.
56939
57184
  *
@@ -57062,7 +57307,7 @@ declare namespace sap {
57062
57307
  *
57063
57308
  * @returns the type's name
57064
57309
  */
57065
- getName(): string;
57310
+ getName(): "sap.ui.model.odata.type.Double";
57066
57311
  /**
57067
57312
  * Parses the given value, which is expected to be of the given type, to an Edm.Double in `number` representation.
57068
57313
  *
@@ -57182,7 +57427,7 @@ declare namespace sap {
57182
57427
  *
57183
57428
  * @returns the type's name
57184
57429
  */
57185
- getName(): string;
57430
+ getName(): "sap.ui.model.odata.type.Guid";
57186
57431
  /**
57187
57432
  * Parses the given value to a GUID.
57188
57433
  *
@@ -57399,7 +57644,7 @@ declare namespace sap {
57399
57644
  *
57400
57645
  * @returns the type's name
57401
57646
  */
57402
- getName(): string;
57647
+ getName(): "sap.ui.model.odata.type.Int16";
57403
57648
  /**
57404
57649
  * Returns the type's supported range as object with properties `minimum` and `maximum`.
57405
57650
  *
@@ -57407,7 +57652,11 @@ declare namespace sap {
57407
57652
  *
57408
57653
  * @returns the range
57409
57654
  */
57410
- getRange(): object;
57655
+ getRange(): {
57656
+ minimum: number;
57657
+
57658
+ maximum: number;
57659
+ };
57411
57660
  }
57412
57661
  /**
57413
57662
  * This class represents the OData primitive type `Edm.Int32`, see
@@ -57484,7 +57733,7 @@ declare namespace sap {
57484
57733
  *
57485
57734
  * @returns the type's name
57486
57735
  */
57487
- getName(): string;
57736
+ getName(): "sap.ui.model.odata.type.Int32";
57488
57737
  /**
57489
57738
  * Returns the type's supported range as object with properties `minimum` and `maximum`.
57490
57739
  *
@@ -57492,7 +57741,11 @@ declare namespace sap {
57492
57741
  *
57493
57742
  * @returns the range
57494
57743
  */
57495
- getRange(): object;
57744
+ getRange(): {
57745
+ minimum: number;
57746
+
57747
+ maximum: number;
57748
+ };
57496
57749
  }
57497
57750
  /**
57498
57751
  * This class represents the OData primitive type `Edm.Int64`, see
@@ -57599,7 +57852,7 @@ declare namespace sap {
57599
57852
  *
57600
57853
  * @returns the type's name
57601
57854
  */
57602
- getName(): string;
57855
+ getName(): "sap.ui.model.odata.type.Int64";
57603
57856
  /**
57604
57857
  * Parses the given value, which is expected to be of the given type, to an Int64 in `string` representation.
57605
57858
  *
@@ -57787,7 +58040,7 @@ declare namespace sap {
57787
58040
  *
57788
58041
  * @returns The type's name
57789
58042
  */
57790
- getName(): string;
58043
+ getName(): "sap.ui.model.odata.type.Raw";
57791
58044
  /**
57792
58045
  * Method not supported
57793
58046
  * See:
@@ -57879,7 +58132,7 @@ declare namespace sap {
57879
58132
  *
57880
58133
  * @returns the type's name
57881
58134
  */
57882
- getName(): string;
58135
+ getName(): "sap.ui.model.odata.type.SByte";
57883
58136
  /**
57884
58137
  * Returns the type's supported range as object with properties `minimum` and `maximum`.
57885
58138
  *
@@ -57887,7 +58140,11 @@ declare namespace sap {
57887
58140
  *
57888
58141
  * @returns the range
57889
58142
  */
57890
- getRange(): object;
58143
+ getRange(): {
58144
+ minimum: number;
58145
+
58146
+ maximum: number;
58147
+ };
57891
58148
  }
57892
58149
  /**
57893
58150
  * This class represents the OData primitive type `Edm.Single`, see
@@ -57985,7 +58242,7 @@ declare namespace sap {
57985
58242
  *
57986
58243
  * @returns the type's name
57987
58244
  */
57988
- getName(): string;
58245
+ getName(): "sap.ui.model.odata.type.Single";
57989
58246
  /**
57990
58247
  * Parses the given value, which is expected to be of the given type, to an Edm.Single in `number` representation.
57991
58248
  *
@@ -58109,7 +58366,7 @@ declare namespace sap {
58109
58366
  *
58110
58367
  * @returns The type's name
58111
58368
  */
58112
- getName(): string;
58369
+ getName(): "sap.ui.model.odata.type.Stream";
58113
58370
  /**
58114
58371
  * Method not supported
58115
58372
  * See:
@@ -58241,7 +58498,7 @@ declare namespace sap {
58241
58498
  *
58242
58499
  * @returns the type's name
58243
58500
  */
58244
- getName(): string;
58501
+ getName(): "sap.ui.model.odata.type.String";
58245
58502
  /**
58246
58503
  * Parses the given value which is expected to be of the given type to a string. If `isDigitSequence` constraint
58247
58504
  * of this type is set to `true` and the parsed string is a sequence of digits, then the parsed string is
@@ -58376,7 +58633,7 @@ declare namespace sap {
58376
58633
  */
58377
58634
  oDate: Date | import("sap/ui/core/date/UI5Date").default | null
58378
58635
  ): {
58379
- __edmType: string;
58636
+ __edmType: "Edm.Time";
58380
58637
 
58381
58638
  ms: int;
58382
58639
  } | null;
@@ -58386,7 +58643,7 @@ declare namespace sap {
58386
58643
  *
58387
58644
  * @returns the type's name
58388
58645
  */
58389
- getName(): string;
58646
+ getName(): "sap.ui.model.odata.type.Time";
58390
58647
  /**
58391
58648
  * Parses the given value, which is expected to be of the given type, to a time object.
58392
58649
  *
@@ -58403,7 +58660,11 @@ declare namespace sap {
58403
58660
  * See {@link sap.ui.model.odata.type} for more information.
58404
58661
  */
58405
58662
  sSourceType: string
58406
- ): object;
58663
+ ): {
58664
+ __edmType: "Edm.Time";
58665
+
58666
+ ms: int;
58667
+ };
58407
58668
  /**
58408
58669
  * Validates whether the given value in model representation is valid and meets the defined constraints.
58409
58670
  */
@@ -58411,7 +58672,11 @@ declare namespace sap {
58411
58672
  /**
58412
58673
  * the value to be validated
58413
58674
  */
58414
- oValue: object
58675
+ oValue: {
58676
+ __edmType: "Edm.Time";
58677
+
58678
+ ms: int;
58679
+ }
58415
58680
  ): void;
58416
58681
  }
58417
58682
  /**
@@ -58516,7 +58781,7 @@ declare namespace sap {
58516
58781
  *
58517
58782
  * @returns The type's name
58518
58783
  */
58519
- getName(): string;
58784
+ getName(): "sap.ui.model.odata.type.TimeOfDay";
58520
58785
  /**
58521
58786
  * Parses the given value, which is expected to be of the given type, to a string with an OData V4 Edm.TimeOfDay
58522
58787
  * value.
@@ -58692,7 +58957,7 @@ declare namespace sap {
58692
58957
  *
58693
58958
  * @returns The type's name
58694
58959
  */
58695
- getName(): string;
58960
+ getName(): "sap.ui.model.odata.type.Unit";
58696
58961
  /**
58697
58962
  * Parses the given string value to an array containing measure and unit.
58698
58963
  * See:
@@ -58753,8 +59018,8 @@ declare namespace sap {
58753
59018
  */
58754
59019
  type failedParameters = {
58755
59020
  /**
58756
- * An array of Errors, see {@link sap.ui.model.v2.ODataAnnotations#error} that occurred while loading a
58757
- * group of annotations
59021
+ * An array of Errors, see {@link sap.ui.model.odata.v2.ODataAnnotations#error} that occurred while loading
59022
+ * a group of annotations
58758
59023
  */
58759
59024
  result: Error[];
58760
59025
  };
@@ -58764,7 +59029,7 @@ declare namespace sap {
58764
59029
  */
58765
59030
  type loadedParameters = {
58766
59031
  /**
58767
- * An array of results and Errors (see {@link sap.ui.model.v2.ODataAnnotations#success} and {@link sap.ui.model.v2.ODataAnnotations#error})
59032
+ * An array of results and Errors (see {@link sap.ui.model.odata.v2.ODataAnnotations#success} and {@link sap.ui.model.odata.v2.ODataAnnotations#error})
58768
59033
  * that occurred while loading a group of annotations
58769
59034
  */
58770
59035
  result:
@@ -58830,6 +59095,26 @@ declare namespace sap {
58830
59095
  single?: boolean;
58831
59096
  };
58832
59097
  }
59098
+ /**
59099
+ * Parameters of the ODataAnnotations#error event.
59100
+ */
59101
+ interface ODataAnnotations$ErrorEventParameters {}
59102
+
59103
+ /**
59104
+ * Parameters of the ODataAnnotations#failed event.
59105
+ */
59106
+ interface ODataAnnotations$FailedEventParameters {}
59107
+
59108
+ /**
59109
+ * Parameters of the ODataAnnotations#loaded event.
59110
+ */
59111
+ interface ODataAnnotations$LoadedEventParameters {}
59112
+
59113
+ /**
59114
+ * Parameters of the ODataAnnotations#success event.
59115
+ */
59116
+ interface ODataAnnotations$SuccessEventParameters {}
59117
+
58833
59118
  /**
58834
59119
  * Parameters of the ODataListBinding#createActivate event.
58835
59120
  */
@@ -59218,8 +59503,8 @@ declare namespace sap {
59218
59503
  */
59219
59504
  groupId?: string;
59220
59505
  /**
59221
- * ID of the `ChangeSet` that this request should belong to. If not provided, the `changeSetId` defined
59222
- * for the type of the entity to be deleted is used.
59506
+ * ID of the change set that this request should belong to. If not provided, the `changeSetId` defined for
59507
+ * the type of the entity to be deleted is used.
59223
59508
  */
59224
59509
  changeSetId?: string;
59225
59510
  /**
@@ -59367,7 +59652,16 @@ declare namespace sap {
59367
59652
  | string[]
59368
59653
  | sap.ui.model.odata.v2.ODataAnnotations.Source
59369
59654
  | sap.ui.model.odata.v2.ODataAnnotations.Source[]
59370
- ): Promise<any>;
59655
+ ): Promise<
59656
+ Array<
59657
+ | {
59658
+ source: sap.ui.model.odata.v2.ODataAnnotations.Source;
59659
+
59660
+ data: any;
59661
+ }
59662
+ | Error
59663
+ >
59664
+ >;
59371
59665
  /**
59372
59666
  * Attaches the given callback to the `allFailed` event.
59373
59667
  *
@@ -59810,7 +60104,7 @@ declare namespace sap {
59810
60104
  *
59811
60105
  * @returns A promise that resolves after the last added sources have been processed
59812
60106
  */
59813
- loaded(): Promise<any>;
60107
+ loaded(): Promise<void>;
59814
60108
  /**
59815
60109
  * Set custom headers which are provided in a key/value map. These headers are used for all requests. The
59816
60110
  * "Accept-Language" header cannot be modified and is set using the core's language setting.
@@ -60128,7 +60422,7 @@ declare namespace sap {
60128
60422
  */
60129
60423
  mParameters?: {
60130
60424
  /**
60131
- * The ID of the `ChangeSet` that this request should belong to
60425
+ * The ID of the change set that this request should belong to
60132
60426
  */
60133
60427
  changeSetId?: string;
60134
60428
  /**
@@ -60597,7 +60891,16 @@ declare namespace sap {
60597
60891
  *
60598
60892
  * @returns A promise that resolves with an array containing information about the initially loaded annotations
60599
60893
  */
60600
- annotationsLoaded(): Promise<any>;
60894
+ annotationsLoaded(): Promise<
60895
+ Array<
60896
+ | {
60897
+ source: sap.ui.model.odata.v2.ODataAnnotations.Source;
60898
+
60899
+ data: any;
60900
+ }
60901
+ | Error
60902
+ >
60903
+ >;
60601
60904
  /**
60602
60905
  * Attaches event handler `fnFunction` to the `annotationsFailed` event of this `sap.ui.model.odata.v2.ODataModel`.
60603
60906
  *
@@ -61029,7 +61332,7 @@ declare namespace sap {
61029
61332
  /**
61030
61333
  * A context object for the new binding
61031
61334
  */
61032
- oContext?: object,
61335
+ oContext?: sap.ui.model.Context,
61033
61336
  /**
61034
61337
  * Map of optional parameters for the binding
61035
61338
  */
@@ -61278,7 +61581,7 @@ declare namespace sap {
61278
61581
  */
61279
61582
  adjustDeepPath?: Function;
61280
61583
  /**
61281
- * ID of the `ChangeSet` that this request belongs to
61584
+ * ID of the change set that this request belongs to
61282
61585
  */
61283
61586
  changeSetId?: string;
61284
61587
  /**
@@ -61301,7 +61604,7 @@ declare namespace sap {
61301
61604
  * - the HTTP method used for the function import is "POST",
61302
61605
  * - the function import returns a single entity,
61303
61606
  * - the back-end service must support the "Content-ID" header,
61304
- * - the back end must allow GET requests relative to this content ID outside the changeset within the
61607
+ * - the back end must allow GET requests relative to this content ID outside the change set within the
61305
61608
  * `$batch` request. The success and error callback functions are called only once, even if there
61306
61609
  * are two requests in the `$batch` related to a single call of {@link #callFunction}.
61307
61610
  * - If both requests succeed, the success callback is called with the merged data of the POST and the
@@ -61347,7 +61650,13 @@ declare namespace sap {
61347
61650
  */
61348
61651
  batchGroupId?: string;
61349
61652
  }
61350
- ): object;
61653
+ ):
61654
+ | {
61655
+ contextCreated: () => Promise<sap.ui.model.Context>;
61656
+
61657
+ abort: () => void;
61658
+ }
61659
+ | undefined;
61351
61660
  /**
61352
61661
  * Whether the canonical requests calculation is switched on, see the `canonicalRequests` parameter of the
61353
61662
  * model constructor.
@@ -61414,7 +61723,7 @@ declare namespace sap {
61414
61723
  */
61415
61724
  groupId?: string;
61416
61725
  /**
61417
- * ID of the `ChangeSet` that this request should belong to
61726
+ * ID of the change set that this request should belong to
61418
61727
  */
61419
61728
  changeSetId?: string;
61420
61729
  /**
@@ -61423,7 +61732,9 @@ declare namespace sap {
61423
61732
  */
61424
61733
  refreshAfterChange?: boolean;
61425
61734
  }
61426
- ): object;
61735
+ ): {
61736
+ abort: () => void;
61737
+ };
61427
61738
  /**
61428
61739
  * Creates a binding context for the given path.
61429
61740
  *
@@ -61448,7 +61759,7 @@ declare namespace sap {
61448
61759
  /**
61449
61760
  * Binding context
61450
61761
  */
61451
- oContext?: object,
61762
+ oContext?: sap.ui.model.Context,
61452
61763
  /**
61453
61764
  * Map which contains additional parameters for the binding
61454
61765
  */
@@ -61475,7 +61786,7 @@ declare namespace sap {
61475
61786
  * The function to be called when the context has been created. The parameter of the callback function is
61476
61787
  * the newly created binding context, an instance of {@link sap.ui.model.odata.v2.Context}.
61477
61788
  */
61478
- fnCallBack?: Function,
61789
+ fnCallBack?: (p1: sap.ui.model.Context) => void,
61479
61790
  /**
61480
61791
  * Whether to reload data
61481
61792
  */
@@ -61504,7 +61815,7 @@ declare namespace sap {
61504
61815
  * The parameter `expand` is supported since 1.78.0. If this parameter is set, the given navigation properties
61505
61816
  * are expanded automatically with the same $batch request in which the POST request for the creation is
61506
61817
  * contained. Ensure that the batch mode is used and the back-end service supports GET requests relative
61507
- * to a content ID outside the changeset. The success and error callback functions are called only once,
61818
+ * to a content ID outside the change set. The success and error callback functions are called only once,
61508
61819
  * even if there are two requests in the `$batch` related to a single call of {@link #createEntry}:
61509
61820
  *
61510
61821
  * - a POST request for creating an entity,
@@ -61550,7 +61861,7 @@ declare namespace sap {
61550
61861
  */
61551
61862
  batchGroupId?: string;
61552
61863
  /**
61553
- * The ID of the `ChangeSet` that this request should belong to
61864
+ * The ID of the change set that this request should belong to
61554
61865
  */
61555
61866
  changeSetId?: string;
61556
61867
  /**
@@ -61573,7 +61884,7 @@ declare namespace sap {
61573
61884
  * GET request. **Note:** The following prerequisites must be fulfilled:
61574
61885
  * - batch mode must be enabled; see constructor parameter `useBatch`,
61575
61886
  * - the back-end service must support the "Content-ID" header,
61576
- * - the back end must allow GET requests relative to this content ID outside the changeset within the
61887
+ * - the back end must allow GET requests relative to this content ID outside the change set within the
61577
61888
  * `$batch` request.
61578
61889
  */
61579
61890
  expand?: string;
@@ -61627,7 +61938,7 @@ declare namespace sap {
61627
61938
  /**
61628
61939
  * Object containing at least all the key properties of the entity type
61629
61940
  */
61630
- oKeyProperties: object
61941
+ oKeyProperties: Record<string, string>
61631
61942
  ): string;
61632
61943
  /**
61633
61944
  * Deletes a created entry from the request queue and from the model.
@@ -61915,7 +62226,7 @@ declare namespace sap {
61915
62226
  /**
61916
62227
  * The optional context which is used with the `sPath` to retrieve the requested data.
61917
62228
  */
61918
- oContext?: object,
62229
+ oContext?: sap.ui.model.Context,
61919
62230
  /**
61920
62231
  * This parameter should be set when a URI or custom parameter with a `$expand` system query option was
61921
62232
  * used to retrieve associated entries embedded. If set to `true` then the `getProperty` function returns
@@ -61975,7 +62286,7 @@ declare namespace sap {
61975
62286
  *
61976
62287
  * @returns The header map
61977
62288
  */
61978
- getHeaders(): object;
62289
+ getHeaders(): Record<string, any>;
61979
62290
  /**
61980
62291
  * Returns the key part for the given the canonical entry URI, model context or data object or `undefined`
61981
62292
  * when the `vValue` can't be interpreted.
@@ -62139,7 +62450,7 @@ declare namespace sap {
62139
62450
  /**
62140
62451
  * The context if available to access the property value
62141
62452
  */
62142
- oContext?: object
62453
+ oContext?: sap.ui.model.Context
62143
62454
  ): any;
62144
62455
  /**
62145
62456
  * Returns the pending changes in this model.
@@ -62177,7 +62488,7 @@ declare namespace sap {
62177
62488
  /**
62178
62489
  * Context if available to access the property value
62179
62490
  */
62180
- oContext?: object,
62491
+ oContext?: sap.ui.model.Context,
62181
62492
  /**
62182
62493
  * **Deprecated as of version 1.41.0**, use {@link #getObject} function with 'select' and 'expand' parameters
62183
62494
  * instead. Whether entities for navigation properties of this property which have been read via `$expand`
@@ -62277,7 +62588,7 @@ declare namespace sap {
62277
62588
  * A function which can be used to restrict invalidation to specific entries, gets the entity key and object
62278
62589
  * as parameters and should return true for entities to invalidate.
62279
62590
  */
62280
- fnCheckEntry?: Function
62591
+ fnCheckEntry?: (p1: string, p2: object) => boolean
62281
62592
  ): void;
62282
62593
  /**
62283
62594
  * Invalidate all entries of the given entity type in the model data.
@@ -62331,7 +62642,7 @@ declare namespace sap {
62331
62642
  * @returns A promise resolving with `true` if the OData V2 annotation "message-scope-supported" on the
62332
62643
  * `EntityContainer` is set to `true`
62333
62644
  */
62334
- messageScopeSupported(): Promise<any>;
62645
+ messageScopeSupported(): Promise<boolean>;
62335
62646
  /**
62336
62647
  * Returns a promise for the loaded state of the metadata.
62337
62648
  *
@@ -62369,7 +62680,7 @@ declare namespace sap {
62369
62680
  * loading the annotations fails.
62370
62681
  */
62371
62682
  bRejectOnFailure?: boolean
62372
- ): Promise<any>;
62683
+ ): Promise<void>;
62373
62684
  /**
62374
62685
  * Trigger a `GET` request to the OData service that was specified in the model constructor.
62375
62686
  *
@@ -62391,7 +62702,7 @@ declare namespace sap {
62391
62702
  /**
62392
62703
  * If specified, `sPath` has to be relative to the path given with the context.
62393
62704
  */
62394
- context?: object;
62705
+ context?: sap.ui.model.Context;
62395
62706
  /**
62396
62707
  * A map containing the parameters that will be passed as query strings
62397
62708
  */
@@ -62431,7 +62742,9 @@ declare namespace sap {
62431
62742
  */
62432
62743
  updateAggregatedMessages?: boolean;
62433
62744
  }
62434
- ): object;
62745
+ ): {
62746
+ abort: () => void;
62747
+ };
62435
62748
  /**
62436
62749
  * Refresh the model.
62437
62750
  *
@@ -62475,17 +62788,19 @@ declare namespace sap {
62475
62788
  /**
62476
62789
  * Callback function which is called when the data has been successfully retrieved.
62477
62790
  */
62478
- fnSuccess?: Function,
62791
+ fnSuccess?: (p1: object, p2: object) => void,
62479
62792
  /**
62480
62793
  * Callback function which is called when the request failed. The handler can have the parameter: oError
62481
62794
  * which contains additional error information.
62482
62795
  */
62483
- fnError?: Function,
62796
+ fnError?: (p1: object) => void,
62484
62797
  /**
62485
62798
  * Whether the request should be sent asynchronously
62486
62799
  */
62487
62800
  bAsync?: boolean
62488
- ): object;
62801
+ ): {
62802
+ abort: () => void;
62803
+ };
62489
62804
  /**
62490
62805
  * Trigger a `DELETE` request to the OData service that was specified in the model constructor.
62491
62806
  *
@@ -62505,7 +62820,7 @@ declare namespace sap {
62505
62820
  /**
62506
62821
  * If specified, `sPath` has to be relative to the path given with the context.
62507
62822
  */
62508
- context?: object;
62823
+ context?: sap.ui.model.Context;
62509
62824
  /**
62510
62825
  * A callback function which is called when the data has been successfully retrieved. The handler can have
62511
62826
  * the following parameters: `oData` and `response`.
@@ -62538,7 +62853,7 @@ declare namespace sap {
62538
62853
  */
62539
62854
  groupId?: string;
62540
62855
  /**
62541
- * ID of the `ChangeSet` that this request should belong to
62856
+ * ID of the change set that this request should belong to
62542
62857
  */
62543
62858
  changeSetId?: string;
62544
62859
  /**
@@ -62547,7 +62862,9 @@ declare namespace sap {
62547
62862
  */
62548
62863
  refreshAfterChange?: boolean;
62549
62864
  }
62550
- ): object;
62865
+ ): {
62866
+ abort: () => void;
62867
+ };
62551
62868
  /**
62552
62869
  * Resets pending changes and aborts corresponding requests.
62553
62870
  *
@@ -62583,14 +62900,14 @@ declare namespace sap {
62583
62900
  * Whether to delete the entities created via {@link #createEntry} or {@link #callFunction}; since 1.95.0
62584
62901
  */
62585
62902
  bDeleteCreatedEntities?: boolean
62586
- ): Promise<any>;
62903
+ ): Promise<void>;
62587
62904
  /**
62588
62905
  * Returns a promise, which will resolve with the security token as soon as it is available.
62589
62906
  *
62590
62907
  *
62591
62908
  * @returns A promise on the security token
62592
62909
  */
62593
- securityTokenAvailable(): Promise<any>;
62910
+ securityTokenAvailable(): Promise<string>;
62594
62911
  /**
62595
62912
  * Definition of batch groups per entity type for two-way binding changes.
62596
62913
  *
@@ -62682,7 +62999,7 @@ declare namespace sap {
62682
62999
  /**
62683
63000
  * The header name/value map.
62684
63001
  */
62685
- mHeaders: object
63002
+ mHeaders: Record<string, string>
62686
63003
  ): void;
62687
63004
  /**
62688
63005
  * Sets this model's message scope.
@@ -62842,7 +63159,9 @@ declare namespace sap {
62842
63159
  */
62843
63160
  merge?: boolean;
62844
63161
  }
62845
- ): object;
63162
+ ): {
63163
+ abort: () => void;
63164
+ };
62846
63165
  /**
62847
63166
  * Trigger a `PUT/MERGE` request to the OData service that was specified in the model constructor.
62848
63167
  *
@@ -62905,7 +63224,7 @@ declare namespace sap {
62905
63224
  */
62906
63225
  groupId?: string;
62907
63226
  /**
62908
- * ID of the `ChangeSet` that this request should belong to
63227
+ * ID of the change set that this request should belong to
62909
63228
  */
62910
63229
  changeSetId?: string;
62911
63230
  /**
@@ -62914,7 +63233,9 @@ declare namespace sap {
62914
63233
  */
62915
63234
  refreshAfterChange?: boolean;
62916
63235
  }
62917
- ): object;
63236
+ ): {
63237
+ abort: () => void;
63238
+ };
62918
63239
  /**
62919
63240
  * Update all bindings.
62920
63241
  */
@@ -62992,7 +63313,7 @@ declare namespace sap {
62992
63313
  * If set to true, no change event will be fired
62993
63314
  */
62994
63315
  bSuppressChange: boolean
62995
- ): Promise<any>;
63316
+ ): Promise<void>;
62996
63317
  /**
62997
63318
  * Applies the given filters to the ODataTreeBinding.
62998
63319
  *
@@ -63042,7 +63363,7 @@ declare namespace sap {
63042
63363
  /**
63043
63364
  * the context element of the node
63044
63365
  */
63045
- oContext: Object
63366
+ oContext: sap.ui.model.Context
63046
63367
  ): int;
63047
63368
  /**
63048
63369
  * Get a download URL with the specified format considering the sort/filter/custom parameters.
@@ -63203,6 +63524,38 @@ declare namespace sap {
63203
63524
  */
63204
63525
  None = "None",
63205
63526
  }
63527
+ /**
63528
+ * Event object of the ODataAnnotations#error event.
63529
+ */
63530
+ type ODataAnnotations$ErrorEvent = sap.ui.base.Event<
63531
+ ODataAnnotations$ErrorEventParameters,
63532
+ ODataAnnotations
63533
+ >;
63534
+
63535
+ /**
63536
+ * Event object of the ODataAnnotations#failed event.
63537
+ */
63538
+ type ODataAnnotations$FailedEvent = sap.ui.base.Event<
63539
+ ODataAnnotations$FailedEventParameters,
63540
+ ODataAnnotations
63541
+ >;
63542
+
63543
+ /**
63544
+ * Event object of the ODataAnnotations#loaded event.
63545
+ */
63546
+ type ODataAnnotations$LoadedEvent = sap.ui.base.Event<
63547
+ ODataAnnotations$LoadedEventParameters,
63548
+ ODataAnnotations
63549
+ >;
63550
+
63551
+ /**
63552
+ * Event object of the ODataAnnotations#success event.
63553
+ */
63554
+ type ODataAnnotations$SuccessEvent = sap.ui.base.Event<
63555
+ ODataAnnotations$SuccessEventParameters,
63556
+ ODataAnnotations
63557
+ >;
63558
+
63206
63559
  /**
63207
63560
  * Event object of the ODataListBinding#createActivate event.
63208
63561
  */
@@ -64369,6 +64722,9 @@ declare namespace sap {
64369
64722
  * is supported. As a precondition, the context must not be both {@link #setKeepAlive kept alive} and hidden
64370
64723
  * (for example due to a filter), and the group ID must not have {@link sap.ui.model.odata.v4.SubmitMode.API}.
64371
64724
  * Such a deletion is not a pending change.
64725
+ *
64726
+ * When using data aggregation without group levels, single entities can be deleted (@experimental as of
64727
+ * version 1.144.0, see {@link #isAggregated}). The same restrictions as for a recursive hierarchy apply.
64372
64728
  * See:
64373
64729
  * #hasPendingChanges
64374
64730
  * #resetChanges
@@ -64410,12 +64766,15 @@ declare namespace sap {
64410
64766
  bDoNotRequestCount?: boolean
64411
64767
  ): Promise<void>;
64412
64768
  /**
64769
+ * Note: You may want to call {@link #delete} instead in order to delete the OData entity on the server
64770
+ * side.
64771
+ *
64413
64772
  * Destroys this context, that is, it removes this context from all dependent bindings and drops references
64414
64773
  * to {@link #getBinding binding} and {@link #getModel model}, so that the context cannot be used anymore;
64415
64774
  * it keeps path and index for debugging purposes. A destroyed context can be recognized by calling {@link #getBinding},
64416
64775
  * which returns `undefined`.
64417
64776
  *
64418
- * **BEWARE:** Do not call this function! The lifetime of an OData V4 context is completely controlled by
64777
+ * **BEWARE: Do not call this function!** The lifetime of an OData V4 context is completely controlled by
64419
64778
  * its binding.
64420
64779
  * See:
64421
64780
  * sap.ui.base.Object#destroy
@@ -64579,6 +64938,20 @@ declare namespace sap {
64579
64938
  * @returns Whether there are pending changes
64580
64939
  */
64581
64940
  hasPendingChanges(): boolean;
64941
+ /**
64942
+ * Indicates whether this context represents aggregated data rather than a single entity instance. This
64943
+ * method returns `true` only in case of data aggregation (but not for a recursive hierarchy) and not for
64944
+ * non-expandable nodes (so-called leaves; see {@link #isExpanded}) if all of the entity type's key properties
64945
+ * are available as groups. For a list binding's {@link sap.ui.model.odata.v4.ODataListBinding#getHeaderContext header context},
64946
+ * the returned value matches that of every leaf.
64947
+ * See:
64948
+ * sap.ui.model.odata.v4.ODataListBinding#setAggregation
64949
+ *
64950
+ * @since 1.144.0
64951
+ *
64952
+ * @returns Whether this context represents aggregated data
64953
+ */
64954
+ isAggregated(): boolean;
64582
64955
  /**
64583
64956
  * Tells whether this node is an ancestor of (or the same as) the given node (in case of a recursive hierarchy,
64584
64957
  * see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}).
@@ -64737,6 +65110,10 @@ declare namespace sap {
64737
65110
  * Refreshes the single entity represented by this context. Use {@link #requestRefresh} if you want to wait
64738
65111
  * for the refresh.
64739
65112
  *
65113
+ * When using data aggregation without `groupLevels` and without `"grandTotal like 1.84"` (see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}),
65114
+ * single entities (see {@link #isAggregated}) can be refreshed and the grand total is updated accordingly
65115
+ * (@experimental as of version 1.145.0).
65116
+ *
64740
65117
  * @since 1.53.0
64741
65118
  */
64742
65119
  refresh(
@@ -64870,7 +65247,7 @@ declare namespace sap {
64870
65247
  */
64871
65248
  sGroupId?: string,
64872
65249
  /**
64873
- * Allows to remove the context
65250
+ * Allows to remove the context, see {@link #refresh} for details
64874
65251
  */
64875
65252
  bAllowRemoval?: boolean
64876
65253
  ): Promise<void>;
@@ -64936,7 +65313,8 @@ declare namespace sap {
64936
65313
  * Since 1.82.0, absolute paths are supported. Absolute paths must start with the entity container (example
64937
65314
  * "/com.sap.gateway.default.iwbep.tea_busi.v0001.Container/TEAMS") of the service. All (navigation) properties
64938
65315
  * in the complete model matching such an absolute path are updated. Since 1.85.0, "14.3.11 Expression edm:String"
64939
- * is accepted as well.
65316
+ * is accepted as well. Since 1.145.0, you can use `null` values (and `{$Null : null}`) as synonyms for
65317
+ * empty navigation property paths.
64940
65318
  *
64941
65319
  * Since 1.108.8, a property path matching the "com.sap.vocabularies.Common.v1.Messages" annotation of a
64942
65320
  * list binding's entity type is treated specially for a row context of a list binding: It is loaded even
@@ -64983,6 +65361,14 @@ declare namespace sap {
64983
65361
  * the context if it is no longer needed.
64984
65362
  *
64985
65363
  * Note: This is only supported if the model uses the `autoExpandSelect` parameter.
65364
+ *
65365
+ * Note: This can be used for single entities in a data aggregation scenario (@experimental as of version
65366
+ * 1.144.0), see {@link #isAggregated}. Such a kept-alive context
65367
+ * can be used as a binding context, can be used for updating data (see {@link #setProperty}),
65368
+ * can be refreshed (see {@link #refresh} and {@link #requestRefresh}), is refreshed when its list
65369
+ * binding's {@link sap.ui.model.odata.v4.ODataListBinding#refresh}) is called, and is refreshed when
65370
+ * {@link #requestSideEffects}) is called on its list binding's header context. Other APIs are not
65371
+ * supported.
64986
65372
  * See:
64987
65373
  * #isKeepAlive
64988
65374
  *
@@ -64996,9 +65382,9 @@ declare namespace sap {
64996
65382
  /**
64997
65383
  * Callback function that is called once for a kept-alive context without any argument just before the context
64998
65384
  * is destroyed; see {@link #destroy}. If a context has been replaced in a list binding (see {@link #replaceWith }
64999
- * and {@link sap.ui.odata.v4.ODataContextBinding#invoke}), the callback will later also be called just
65000
- * before the replacing context is destroyed, but with that context as the only argument. Supported since
65001
- * 1.84.0
65385
+ * and {@link sap.ui.model.odata.v4.ODataContextBinding#invoke}), the callback will later also be called
65386
+ * just before the replacing context is destroyed, but with that context as the only argument. Supported
65387
+ * since 1.84.0
65002
65388
  */
65003
65389
  fnOnBeforeDestroy?: (
65004
65390
  p1: sap.ui.model.odata.v4.Context | undefined
@@ -65517,6 +65903,7 @@ declare namespace sap {
65517
65903
  * Method not supported
65518
65904
  *
65519
65905
  * @since 1.37.0
65906
+ * @deprecated As of version 1.37.0. calling this method is not supported
65520
65907
  */
65521
65908
  isInitial(): boolean;
65522
65909
  /**
@@ -66239,7 +66626,7 @@ declare namespace sap {
66239
66626
  *
66240
66627
  * If known, the value represents the sum of the element count of the collection on the server and the number
66241
66628
  * of {@link sap.ui.model.odata.v4.Context#isInactive active} {@link sap.ui.model.odata.v4.Context#isTransient transient }
66242
- * entities created on the client, minus the {@link #sap.ui.model.data.v4.Context#delete deleted} entities.
66629
+ * entities created on the client, minus the {@link #sap.ui.model.odata.v4.Context#delete deleted} entities.
66243
66630
  * Otherwise, it is `undefined`. The value is a number of type `Edm.Int64`. Since 1.91.0, in case of data
66244
66631
  * aggregation with group levels, the count is the leaf count on the server; it is only determined if the
66245
66632
  * `$count` system query option is given. Since 1.110.0, in case of a recursive hierarchy, the count is
@@ -66284,12 +66671,13 @@ declare namespace sap {
66284
66671
  * sap.ui.model.ListBinding#getDistinctValues
66285
66672
  *
66286
66673
  * @since 1.37.0
66674
+ * @deprecated As of version 1.37.0. calling this method is not supported
66287
66675
  */
66288
- getDistinctValues(_sPath?: string): any[];
66676
+ getDistinctValues(): any[];
66289
66677
  /**
66290
66678
  * Returns a URL by which the complete content of the list can be downloaded in JSON format. The request
66291
66679
  * delivers all entities considering the binding's query options (such as filters or sorters). Returns `null`
66292
- * if the binding's filter is {@link sap.ui.filter.Filter.NONE}. The returned URL does not specify `$skip`
66680
+ * if the binding's filter is {@link sap.ui.model.Filter.NONE}. The returned URL does not specify `$skip`
66293
66681
  * and `$top` and leaves it up to the server how many rows it delivers. Many servers tend to choose a small
66294
66682
  * limit without `$skip` and `$top`, so it might be wise to add an appropriate value for `$top` at least.
66295
66683
  *
@@ -66468,6 +66856,7 @@ declare namespace sap {
66468
66856
  * Method not supported
66469
66857
  *
66470
66858
  * @since 1.37.0
66859
+ * @deprecated As of version 1.37.0. calling this method is not supported
66471
66860
  */
66472
66861
  isInitial(): boolean;
66473
66862
  /**
@@ -66548,7 +66937,7 @@ declare namespace sap {
66548
66937
  /**
66549
66938
  * Resolves with a URL by which the complete content of the list can be downloaded in JSON format. The request
66550
66939
  * delivers all entities considering the binding's query options (such as filters or sorters). Resolves
66551
- * with `null` if the binding's filter is {@link sap.ui.filter.Filter.NONE}.
66940
+ * with `null` if the binding's filter is {@link sap.ui.model.Filter.NONE}.
66552
66941
  *
66553
66942
  * The returned URL does not specify `$skip` and `$top` and leaves it up to the server how many rows it
66554
66943
  * delivers. Many servers tend to choose a small limit without `$skip` and `$top`, so it might be wise to
@@ -67039,18 +67428,9 @@ declare namespace sap {
67039
67428
  * sap.ui.model.Model#bindTree
67040
67429
  *
67041
67430
  * @since 1.37.0
67431
+ * @deprecated As of version 1.37.0. calling this method is not supported
67042
67432
  */
67043
- bindTree(
67044
- _sPath: string,
67045
-
67046
- _oContext?: sap.ui.model.Context,
67047
-
67048
- _aFilters?: sap.ui.model.Filter[],
67049
-
67050
- _mParameters?: object,
67051
-
67052
- _aSorters?: sap.ui.model.Sorter[]
67053
- ): sap.ui.model.TreeBinding;
67433
+ bindTree(): sap.ui.model.TreeBinding;
67054
67434
  /**
67055
67435
  * Returns a snapshot of each $metadata or annotation file loaded so far, combined into a single "JSON"
67056
67436
  * object according to the streamlined OData V4 Metadata JSON Format.
@@ -67150,6 +67530,7 @@ declare namespace sap {
67150
67530
  * Method not supported
67151
67531
  *
67152
67532
  * @since 1.37.0
67533
+ * @deprecated As of version 1.37.0. calling this method is not supported
67153
67534
  */
67154
67535
  getOriginalProperty(): void;
67155
67536
  /**
@@ -67217,6 +67598,7 @@ declare namespace sap {
67217
67598
  * sap.ui.model.Model#refresh
67218
67599
  *
67219
67600
  * @since 1.37.0
67601
+ * @deprecated As of version 1.37.0. calling this method is not supported
67220
67602
  */
67221
67603
  refresh(): void;
67222
67604
  /**
@@ -67261,7 +67643,7 @@ declare namespace sap {
67261
67643
 
67262
67644
  Text: string;
67263
67645
 
67264
- UnitSpecificScale: string;
67646
+ UnitSpecificScale: number;
67265
67647
  }
67266
67648
  > | null>;
67267
67649
  /**
@@ -67406,9 +67788,9 @@ declare namespace sap {
67406
67788
  * of type "Edm.Int64". Otherwise, it is invalid.
67407
67789
  *
67408
67790
  * A segment which represents an OData simple identifier (or the special names "$ReturnType", since 1.71.0,
67409
- * or "$Parameter", since 1.73.0) needs special preparations. The same applies to the empty segment after
67410
- * a trailing slash. If the current object has a "$Action", "$Function" or "$Type" property, it
67411
- * is used for scope lookup first. This way, "/EMPLOYEES/ENTRYDATE" addresses the same object as "/EMPLOYEES/$Type/ENTRYDATE",
67791
+ * or "$Parameter", since 1.73.0) needs special preparations. The same applies to the empty segment (typically
67792
+ * after a trailing slash). If the current object has a "$Action", "$Function" or "$Type" property,
67793
+ * it is used for scope lookup first. This way, "/EMPLOYEES/ENTRYDATE" addresses the same object as "/EMPLOYEES/$Type/ENTRYDATE",
67412
67794
  * namely the "ENTRYDATE" child of the entity type corresponding to the "EMPLOYEES" child of the entity
67413
67795
  * container. The other cases jump from an operation import to the corresponding operation overloads.
67414
67796
  * Else if the segment is the first one within its path, the last schema child addressed via scope lookup
@@ -67429,6 +67811,8 @@ declare namespace sap {
67429
67811
  *
67430
67812
  * Operation overloads are then filtered by binding parameter; multiple overloads after filtering are invalid
67431
67813
  * except if addressing all overloads via the segment "@$ui5.overload", for example "/acme.NewAction/@$ui5.overload".
67814
+ * Since 1.144.0, multiple overloads for an unbound function are tolerated when addressing the return type
67815
+ * (which is the same for all of them).
67432
67816
  *
67433
67817
  * Once a single overload has been determined, its parameters can be immediately addressed, for example
67434
67818
  * "/TEAMS/acme.NewAction/Team_ID", or the special name "$Parameter" can be used (since 1.73.0), for example
@@ -67563,7 +67947,7 @@ declare namespace sap {
67563
67947
 
67564
67948
  Text: string;
67565
67949
 
67566
- UnitSpecificScale: string;
67950
+ UnitSpecificScale: number;
67567
67951
  }
67568
67952
  > | null>;
67569
67953
  /**
@@ -67639,6 +68023,7 @@ declare namespace sap {
67639
68023
  * Method not supported
67640
68024
  *
67641
68025
  * @since 1.37.0
68026
+ * @deprecated As of version 1.37.0. calling this method is not supported
67642
68027
  */
67643
68028
  setLegacySyntax(): void;
67644
68029
  /**
@@ -68223,18 +68608,9 @@ declare namespace sap {
68223
68608
  * sap.ui.model.Model#bindTree
68224
68609
  *
68225
68610
  * @since 1.37.0
68611
+ * @deprecated As of version 1.37.0. calling this method is not supported
68226
68612
  */
68227
- bindTree(
68228
- _sPath: string,
68229
-
68230
- _oContext?: sap.ui.model.Context,
68231
-
68232
- _aFilters?: sap.ui.model.Filter[],
68233
-
68234
- _mParameters?: object,
68235
-
68236
- _aSorters?: sap.ui.model.Sorter[]
68237
- ): sap.ui.model.TreeBinding;
68613
+ bindTree(): sap.ui.model.TreeBinding;
68238
68614
  /**
68239
68615
  * Changes the HTTP headers used for data and metadata requests sent by this model.
68240
68616
  *
@@ -68351,6 +68727,7 @@ declare namespace sap {
68351
68727
  * Method not supported
68352
68728
  *
68353
68729
  * @since 1.37.0
68730
+ * @deprecated As of version 1.37.0. calling this method is not supported
68354
68731
  */
68355
68732
  destroyBindingContext(): void;
68356
68733
  /**
@@ -68540,6 +68917,7 @@ declare namespace sap {
68540
68917
  * Method not supported
68541
68918
  *
68542
68919
  * @since 1.37.0
68920
+ * @deprecated As of version 1.37.0. calling this method is not supported
68543
68921
  */
68544
68922
  getObject(): void;
68545
68923
  /**
@@ -68554,6 +68932,7 @@ declare namespace sap {
68554
68932
  * Method not supported
68555
68933
  *
68556
68934
  * @since 1.37.0
68935
+ * @deprecated As of version 1.37.0. calling this method is not supported
68557
68936
  */
68558
68937
  getOriginalProperty(): void;
68559
68938
  /**
@@ -68562,6 +68941,7 @@ declare namespace sap {
68562
68941
  * sap.ui.model.Model#getProperty
68563
68942
  *
68564
68943
  * @since 1.37.0
68944
+ * @deprecated As of version 1.37.0. calling this method is not supported
68565
68945
  */
68566
68946
  getProperty(): void;
68567
68947
  /**
@@ -68715,6 +69095,7 @@ declare namespace sap {
68715
69095
  * Method not supported
68716
69096
  *
68717
69097
  * @since 1.37.0
69098
+ * @deprecated As of version 1.37.0. calling this method is not supported
68718
69099
  */
68719
69100
  setLegacySyntax(): void;
68720
69101
  /**
@@ -68734,7 +69115,7 @@ declare namespace sap {
68734
69115
  /**
68735
69116
  * A "Retry-After" handler
68736
69117
  */
68737
- fnRetryAfter: (p1: Error) => Promise<undefined>
69118
+ fnRetryAfter: (p1: Error) => Promise<void>
68738
69119
  ): void;
68739
69120
  /**
68740
69121
  * Submits the requests associated with the given group ID in one batch request. Requests from subsequent
@@ -68929,6 +69310,7 @@ declare namespace sap {
68929
69310
  * Method not supported
68930
69311
  *
68931
69312
  * @since 1.37.0
69313
+ * @deprecated As of version 1.37.0. calling this method is not supported
68932
69314
  */
68933
69315
  isInitial(): boolean;
68934
69316
  /**
@@ -69031,6 +69413,7 @@ declare namespace sap {
69031
69413
  * sap.ui.model.Binding#resume
69032
69414
  *
69033
69415
  * @since 1.37.0
69416
+ * @deprecated As of version 1.37.0. calling this method is not supported
69034
69417
  */
69035
69418
  resume(): void;
69036
69419
  /**
@@ -69095,6 +69478,7 @@ declare namespace sap {
69095
69478
  * sap.ui.model.Binding#suspend
69096
69479
  *
69097
69480
  * @since 1.37.0
69481
+ * @deprecated As of version 1.37.0. calling this method is not supported
69098
69482
  */
69099
69483
  suspend(): void;
69100
69484
  /**
@@ -69369,6 +69753,47 @@ declare namespace sap {
69369
69753
  >;
69370
69754
  }
69371
69755
 
69756
+ namespace ODataMessageParser {
69757
+ type Request = {
69758
+ /**
69759
+ * The HTTP method used for this request
69760
+ */
69761
+ method: string;
69762
+ /**
69763
+ * The request URI of this request
69764
+ */
69765
+ requestUri: string;
69766
+ /**
69767
+ * The headers of this request
69768
+ */
69769
+ headers: Record<string, string>;
69770
+ /**
69771
+ * Entity key for created entities
69772
+ */
69773
+ key?: string;
69774
+ /**
69775
+ * Flag indicating if an entity was created
69776
+ */
69777
+ created?: boolean;
69778
+ /**
69779
+ * Deep path for nested entities
69780
+ */
69781
+ deepPath?: string;
69782
+ /**
69783
+ * Metadata for function imports
69784
+ */
69785
+ functionMetadata?: object;
69786
+ /**
69787
+ * Target for function imports
69788
+ */
69789
+ functionTarget?: string;
69790
+ /**
69791
+ * Flag for updating aggregated messages
69792
+ */
69793
+ updateAggregatedMessages?: boolean;
69794
+ };
69795
+ }
69796
+
69372
69797
  namespace ODataMetaModel {
69373
69798
  /**
69374
69799
  * The abstraction of an OData property.
@@ -70597,7 +71022,7 @@ declare namespace sap {
70597
71022
  * the EDM type
70598
71023
  */
70599
71024
  sEdmType: string
70600
- ): Function;
71025
+ ): (p1: any, p2: any) => int;
70601
71026
  /**
70602
71027
  * Adds an origin to the given service URL. If an origin is already present, it will only be replaced if
70603
71028
  * the parameters object contains the flag "force: true". In case the URL already contains URL parameters,
@@ -71325,19 +71750,25 @@ declare namespace sap {
71325
71750
  /**
71326
71751
  * The response from the server containing body and headers
71327
71752
  */
71328
- oResponse: object,
71753
+ oResponse: {
71754
+ statusCode: number;
71755
+
71756
+ headers: Record<string, string>;
71757
+
71758
+ body: string;
71759
+ },
71329
71760
  /**
71330
71761
  * The original request that lead to this response
71331
71762
  */
71332
- oRequest: object,
71763
+ oRequest: sap.ui.model.odata.ODataMessageParser.Request,
71333
71764
  /**
71334
- * A map with the keys of the entities requested from the back-end mapped to true
71765
+ * A map with the keys of the entities requested from the back end mapped to true
71335
71766
  */
71336
- mGetEntities?: object,
71767
+ mGetEntities?: Record<string, true>,
71337
71768
  /**
71338
- * A map with the keys of the entities changed in the back-end mapped to true
71769
+ * A map with the keys of the entities changed in the back end mapped to true
71339
71770
  */
71340
- mChangeEntities?: object,
71771
+ mChangeEntities?: Record<string, true>,
71341
71772
  /**
71342
71773
  * Whether the used OData service supports the message scope {@link sap.ui.model.odata.MessageScope.BusinessObject}
71343
71774
  */
@@ -71824,8 +72255,8 @@ declare namespace sap {
71824
72255
  static getMetadata(): sap.ui.base.Metadata;
71825
72256
  /**
71826
72257
  * Gets the metadata context for the given function import and parameter name. The result can be used with
71827
- * {@link sap.ui.model.ODataMetaModel#getODataValueLists} to request the metadata for the value lists for
71828
- * that function import parameter.
72258
+ * {@link sap.ui.model.odata.ODataMetaModel#getODataValueLists} to request the metadata for the value lists
72259
+ * for that function import parameter.
71829
72260
  *
71830
72261
  * @since 1.129.0
71831
72262
  *
@@ -72092,7 +72523,7 @@ declare namespace sap {
72092
72523
  *
72093
72524
  * @returns a Promise
72094
72525
  */
72095
- loaded(): Promise<any>;
72526
+ loaded(): Promise<void>;
72096
72527
  /**
72097
72528
  * Refresh not supported by OData meta model!
72098
72529
  */
@@ -72337,7 +72768,7 @@ declare namespace sap {
72337
72768
  /**
72338
72769
  * Appends the change batch operations to the end of the batch stack. Only `PUTPOST` or `DELETE`
72339
72770
  * batch operations should be included in the specified array. The operations in the array will be included
72340
- * in a single changeset. To embed change operations in different change sets call this method with the
72771
+ * in a single change set. To embed change operations in different change sets call this method with the
72341
72772
  * corresponding change operations again. If an illegal batch operation is added to the change set nothing
72342
72773
  * will be performed and false will be returned.
72343
72774
  *
@@ -73566,10 +73997,10 @@ declare namespace sap {
73566
73997
  /**
73567
73998
  * Different modes for retrieving the count of collections.
73568
73999
  * See:
73569
- * sap.ui.model.ODataModel#bindList
73570
- * sap.ui.model.ODataModel#constructor
73571
- * sap.ui.model.v2.ODataModel#bindList
73572
- * sap.ui.model.v2.ODataModel#constructor
74000
+ * sap.ui.model.odata.ODataModel#bindList
74001
+ * sap.ui.model.odata.ODataModel#constructor
74002
+ * sap.ui.model.odata.v2.ODataModel#bindList
74003
+ * sap.ui.model.odata.v2.ODataModel#constructor
73573
74004
  */
73574
74005
  enum CountMode {
73575
74006
  /**
@@ -73606,7 +74037,7 @@ declare namespace sap {
73606
74037
  /**
73607
74038
  * Different scopes for retrieving messages from a service consumed via a {@link sap.ui.model.odata.v2.ODataModel}.
73608
74039
  * See:
73609
- * sap.ui.model.ODataModel#constructor
74040
+ * sap.ui.model.odata.v2.ODataModel#constructor
73610
74041
  */
73611
74042
  enum MessageScope {
73612
74043
  /**
@@ -74062,7 +74493,12 @@ declare namespace sap {
74062
74493
  * Returns the object for the given path and context.
74063
74494
  *
74064
74495
  *
74065
- * @returns The object
74496
+ * @returns The object at the specified path:
74497
+ * - An XML DOM Element node object when the path resolves to an element.
74498
+ * - A string value when the path points to an attribute (using the @attribute syntax) or text content.
74499
+ *
74500
+ * - `null` when the document has no root element or the path cannot be resolved.
74501
+ * - `undefined` when the path resolution returns an empty result.
74066
74502
  */
74067
74503
  getObject(
74068
74504
  /**
@@ -74072,8 +74508,8 @@ declare namespace sap {
74072
74508
  /**
74073
74509
  * The context which will be used to retrieve the object
74074
74510
  */
74075
- oContext?: object
74076
- ): object;
74511
+ oContext?: sap.ui.model.Context
74512
+ ): Element | string | null | undefined;
74077
74513
  /**
74078
74514
  * Returns the value for the property with the given `sPropertyName`.
74079
74515
  *
@@ -74088,7 +74524,7 @@ declare namespace sap {
74088
74524
  /**
74089
74525
  * The context which will be used to retrieve the property
74090
74526
  */
74091
- oContext?: object
74527
+ oContext?: sap.ui.model.Context
74092
74528
  ): string;
74093
74529
  /**
74094
74530
  * Serializes the current XML data of the model into a string.
@@ -74129,7 +74565,7 @@ declare namespace sap {
74129
74565
  /**
74130
74566
  * An object of additional header key/value pairs to send along with the request
74131
74567
  */
74132
- mHeaders?: object
74568
+ mHeaders?: Record<string, string>
74133
74569
  ): void;
74134
74570
  /**
74135
74571
  * Sets the provided XML encoded data object to the model
@@ -74172,7 +74608,7 @@ declare namespace sap {
74172
74608
  /**
74173
74609
  * The context which will be used to set the property
74174
74610
  */
74175
- oContext?: object,
74611
+ oContext?: sap.ui.model.Context,
74176
74612
  /**
74177
74613
  * Whether to update other bindings dependent on this property asynchronously
74178
74614
  */
@@ -75714,12 +76150,24 @@ declare namespace sap {
75714
76150
  /**
75715
76151
  * the sections into which oNewSection will be merged
75716
76152
  */
75717
- aSections: object[],
76153
+ aSections: Array<{
76154
+ startIndex: number;
76155
+
76156
+ length: number;
76157
+ }>,
75718
76158
  /**
75719
76159
  * the section which should be merged into aNewSections
75720
76160
  */
75721
- oNewSection: object
75722
- ): object[];
76161
+ oNewSection: {
76162
+ startIndex: number;
76163
+
76164
+ length: number;
76165
+ }
76166
+ ): Array<{
76167
+ startIndex: number;
76168
+
76169
+ length: number;
76170
+ }>;
75723
76171
  }
75724
76172
 
75725
76173
  /**
@@ -76180,7 +76628,7 @@ declare namespace sap {
76180
76628
  /**
76181
76629
  * The model instance to compare against
76182
76630
  */
76183
- oModel: object
76631
+ oModel: sap.ui.model.Model
76184
76632
  ): boolean;
76185
76633
  }
76186
76634
  /**
@@ -76443,7 +76891,7 @@ declare namespace sap {
76443
76891
  /**
76444
76892
  * A context object for the new binding
76445
76893
  */
76446
- oContext?: object,
76894
+ oContext?: sap.ui.model.Context,
76447
76895
  /**
76448
76896
  * Map of optional parameters for the binding
76449
76897
  */
@@ -77497,22 +77945,23 @@ declare namespace sap {
77497
77945
  */
77498
77946
  getModel(): sap.ui.model.Model;
77499
77947
  /**
77500
- * Gets the (model dependent) object the context points to or the object with the given relative binding
77501
- * path
77948
+ * Gets the (model-dependent) object the context points to, or the object with the given relative binding
77949
+ * path.
77502
77950
  *
77503
77951
  *
77504
77952
  * @returns the context object
77505
77953
  */
77506
77954
  getObject(
77507
77955
  /**
77508
- * the binding path
77956
+ * the binding path as a string, or if an object is provided, it is treated as additional parameters (same
77957
+ * as `mParameters`)
77509
77958
  */
77510
- sPath?: string,
77959
+ vPath?: string | object,
77511
77960
  /**
77512
- * additional model specific parameters (optional)
77961
+ * additional model-specific parameters
77513
77962
  */
77514
77963
  mParameters?: object
77515
- ): object;
77964
+ ): any;
77516
77965
  /**
77517
77966
  * Getter for path of the context itself or a subpath
77518
77967
  *
@@ -77554,7 +78003,7 @@ declare namespace sap {
77554
78003
 
77555
78004
  mParameters?: object,
77556
78005
  /**
77557
- * object defining event handlers
78006
+ * **Deprecated as of version 1.144.0** - unused
77558
78007
  */
77559
78008
  oEvents?: object
77560
78009
  );
@@ -77703,9 +78152,18 @@ declare namespace sap {
77703
78152
  * map only contains the changed properties.
77704
78153
  *
77705
78154
  *
77706
- * @returns The changed properties of the data state
78155
+ * @returns The changed properties and messages of the data state. Changed messages are located in the `messages`
78156
+ * property. They share the same object structure as the changed properties, but the values in this structure
78157
+ * are of type {@link sap.ui.core.message.Message}.
77707
78158
  */
77708
- getChanges(): object;
78159
+ getChanges(): Record<
78160
+ string,
78161
+ {
78162
+ oldValue: any;
78163
+
78164
+ value: any;
78165
+ }
78166
+ >;
77709
78167
  /**
77710
78168
  * Returns the array of this data state's current control messages.
77711
78169
  *
@@ -78909,9 +79367,9 @@ declare namespace sap {
78909
79367
  */
78910
79368
  mParameters?: object,
78911
79369
  /**
78912
- * Event handlers can be passed to the binding ({change:myHandler})
79370
+ * **Deprecated as of version 1.144.0** - unused
78913
79371
  */
78914
- oEvents?: object
79372
+ oEvents?: Record<string, Function>
78915
79373
  ): sap.ui.model.ContextBinding;
78916
79374
  /**
78917
79375
  *
@@ -79236,16 +79694,19 @@ declare namespace sap {
79236
79694
  */
79237
79695
  getMetaModel(): sap.ui.model.MetaModel | undefined;
79238
79696
  /**
79697
+ * Returns the value of the property for the given `sPath` and `oContext`.
79698
+ *
79239
79699
  *
79240
- * @returns The value for the given path/context or `undefined` if data could not be found
79700
+ * @returns The the value of the property for the given path/context or `undefined` if data could not be
79701
+ * found
79241
79702
  */
79242
79703
  getObject(
79243
79704
  /**
79244
- * Path to where to read the object
79705
+ * The path to the object you want to read
79245
79706
  */
79246
79707
  sPath: string,
79247
79708
  /**
79248
- * Context with which the path should be resolved
79709
+ * The context that resolves the path
79249
79710
  */
79250
79711
  oContext?: sap.ui.model.Context,
79251
79712
  /**
@@ -79259,29 +79720,31 @@ declare namespace sap {
79259
79720
  * The original value is the value that was last responded by a server if using a server model implementation.
79260
79721
  *
79261
79722
  *
79262
- * @returns vValue The value of the property
79723
+ * @returns The value of the property
79263
79724
  */
79264
79725
  getOriginalProperty(
79265
79726
  /**
79266
- * Path/name of the property
79727
+ * The path/name of the property
79267
79728
  */
79268
79729
  sPath: string,
79269
79730
  /**
79270
- * Context if available to access the property value
79731
+ * Context for accessing the property value
79271
79732
  */
79272
79733
  oContext?: sap.ui.model.Context
79273
79734
  ): any;
79274
79735
  /**
79736
+ * Returns the value of the property for the given `sPath` and `oContext`.
79275
79737
  *
79276
- * @returns Value of the addressed property
79738
+ *
79739
+ * @returns The value of the addressed property
79277
79740
  */
79278
79741
  getProperty(
79279
79742
  /**
79280
- * The path to where to read the attribute value
79743
+ * The path to the attribute value you want to read
79281
79744
  */
79282
79745
  sPath: string,
79283
79746
  /**
79284
- * The context with which the path should be resolved
79747
+ * The context that resolves the path
79285
79748
  */
79286
79749
  oContext?: sap.ui.model.Context
79287
79750
  ): any;
@@ -81937,6 +82400,25 @@ declare namespace sap {
81937
82400
  * @returns Metadata object describing this class
81938
82401
  */
81939
82402
  static getMetadata(): sap.ui.base.ManagedObjectMetadata;
82403
+ /**
82404
+ * Finds the most suitable jQuery element to execute an action on. A control may have many elements in its
82405
+ * DOM representation. The most suitable one is chosen by priority:
82406
+ * - If the user provided an idSuffix, return the element that matches it, or null
82407
+ * - If there is a control adapter for the action - return the element that matches it. See `controlAdapters`
82408
+ * at {@link sap.ui.test.Press} for an example
82409
+ * - If there is no control adapter, or it matches no elements, return the focusDomRef of the control.
82410
+ * Note that some controls may not have a focusDomRef.
82411
+ *
82412
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
82413
+ *
82414
+ * @returns the jQuery element which is most suitable for the action
82415
+ */
82416
+ $(
82417
+ /**
82418
+ * the control to execute an action on
82419
+ */
82420
+ oControl: object
82421
+ ): jQuery;
81940
82422
  /**
81941
82423
  * Checks if the matcher is matching - will get an instance of sap.ui.core.Control as parameter Should be
81942
82424
  * overwritten by subclasses
@@ -81963,6 +82445,14 @@ declare namespace sap {
81963
82445
  * @returns Value of property `idSuffix`
81964
82446
  */
81965
82447
  getIdSuffix(): string;
82448
+ /**
82449
+ * Returns the QUnitUtils
82450
+ *
82451
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
82452
+ *
82453
+ * @returns QUnit utils of the current window or the OPA frame
82454
+ */
82455
+ getUtils(): /* was: sap.ui.test.qunit.QUnitUtils */ any;
81966
82456
  /**
81967
82457
  * Sets a new value for property {@link #getIdSuffix idSuffix}.
81968
82458
  *
@@ -85162,7 +85652,7 @@ declare namespace sap {
85162
85652
  * viewName: "my.View"
85163
85653
  * controlType: "sap.m.Input",
85164
85654
  * success: function (aInputs) {
85165
- * // aInputs are all sap.m.Inputs inside of a view called 'my.View'
85655
+ * // aInputs are all sap.m.Input controls inside of a view called 'my.View'
85166
85656
  * }
85167
85657
  * });
85168
85658
  * ```
@@ -86124,7 +86614,7 @@ declare namespace sap {
86124
86614
  FNMetaImpl?: Function
86125
86615
  ): Function;
86126
86616
  /**
86127
- * Returns the registered element with the given ID, if any. Internally forwards to {@link sap.ui.core.Element#getElementById }
86617
+ * Returns the registered element with the given ID, if any. Internally forwards to {@link sap.ui.core.Element.getElementById }
86128
86618
  * or the corresponsing legacy API. The legacy API is used when the tested app is loaded in an iframe that
86129
86619
  * uses a lower UI5 version.
86130
86620
  *
@@ -86139,7 +86629,7 @@ declare namespace sap {
86139
86629
  sId: sap.ui.core.ID | null | undefined
86140
86630
  ): sap.ui.core.Element | undefined;
86141
86631
  /**
86142
- * Retrieves a resource bundle for the given library and locale. Internally forwards to {@link sap.ui.core.Lib#getResourceBundleFor }
86632
+ * Retrieves a resource bundle for the given library and locale. Internally forwards to {@link sap.ui.core.Lib.getResourceBundleFor }
86143
86633
  * or the corresponsing legacy API. The legacy API is used when the tested app is loaded in an iframe that
86144
86634
  * uses a lower UI5 version.
86145
86635
  *
@@ -86154,8 +86644,8 @@ declare namespace sap {
86154
86644
  */
86155
86645
  static getMetadata(): sap.ui.base.Metadata;
86156
86646
  /**
86157
- * Returns the root element of the static, hidden area. Internally forwards to {@link sap.ui.core.StaticArea#getDomRef }
86158
- * or the corresponsing legacy API. The legacy API is used when the tested app is loaded in an iframe that
86647
+ * Returns the root element of the static, hidden area. Internally forwards to {@link module:sap/ui/core/StaticArea.getDomRef }
86648
+ * or the corresponding legacy API. The legacy API is used when the tested app is loaded in an iframe that
86159
86649
  * uses a lower UI5 version.
86160
86650
  *
86161
86651
  * @ui5-protected Do not call from applications (only from related classes in the framework)
@@ -86165,8 +86655,8 @@ declare namespace sap {
86165
86655
  static getStaticAreaDomRef(): Element;
86166
86656
  /**
86167
86657
  * Returns `true` if there are any pending rendering tasks or when such rendering tasks are currently being
86168
- * executed. Internally forwards to {@link sap.ui.core.Rendering#isPending} or the corresponsing legacy
86169
- * API. The legacy API is used when the tested app is loaded in an iframe that uses a lower UI5 version.
86658
+ * executed. Internally forwards to {@link module:sap/ui/core/Rendering.isPending} or the corresponsing
86659
+ * legacy API. The legacy API is used when the tested app is loaded in an iframe that uses a lower UI5 version.
86170
86660
  *
86171
86661
  * @ui5-protected Do not call from applications (only from related classes in the framework)
86172
86662
  *
@@ -86335,7 +86825,7 @@ declare namespace sap {
86335
86825
  *
86336
86826
  * // control type is often combined with viewName - only controls that are inside of the view
86337
86827
  * // and have the correct type will be returned
86338
- * // here all sap.m.Inputs inside of a view called 'my.View' will be returned
86828
+ * // here all sap.m.Input controls inside of a view called 'my.View' will be returned
86339
86829
  * new OpaPlugin().getMatchingControls({
86340
86830
  * viewName: "my.View"
86341
86831
  * controlType: "sap.m.Input"
@@ -86536,7 +87026,7 @@ declare namespace sap {
86536
87026
  /**
86537
87027
  * Clear existing text before interaction
86538
87028
  */
86539
- clearTextFirst?: string;
87029
+ clearTextFirst?: boolean;
86540
87030
  /**
86541
87031
  * If ENTER key will be entered after the text
86542
87032
  */
@@ -86732,6 +87222,8 @@ declare namespace sap {
86732
87222
 
86733
87223
  "sap/base/util/array/uniqueSort": undefined;
86734
87224
 
87225
+ "sap/base/util/clamp": undefined;
87226
+
86735
87227
  "sap/base/util/deepClone": undefined;
86736
87228
 
86737
87229
  "sap/base/util/deepEqual": undefined;
@@ -87144,6 +87636,8 @@ declare namespace sap {
87144
87636
 
87145
87637
  "sap/ui/dom/denormalizeScrollLeftRTL": undefined;
87146
87638
 
87639
+ "sap/ui/dom/detectTextSelection": undefined;
87640
+
87147
87641
  "sap/ui/dom/getOwnerWindow": undefined;
87148
87642
 
87149
87643
  "sap/ui/dom/getScrollbarSize": undefined;