@openui5/ts-types-esm 1.94.0 → 1.97.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -264,7 +264,7 @@ interface JQuery<TElement = HTMLElement> extends Iterable<TElement> {
264
264
  ): jQuery;
265
265
  }
266
266
 
267
- // For Library Version: 1.94.0
267
+ // For Library Version: 1.97.0
268
268
 
269
269
  declare module "sap/base/assert" {
270
270
  /**
@@ -4877,8 +4877,8 @@ declare module "sap/ui/base/ManagedObject" {
4877
4877
  * **'library'** : string
4878
4878
  * Name of the library that the new subclass should belong to. If the subclass is a control or element,
4879
4879
  * it will automatically register with that library so that authoring tools can discover it. By convention,
4880
- * the name of the subclass should have the library name as a prefix, e.g. 'sap.ui.commons.Panel' belongs
4881
- * to library 'sap.ui.commons'.
4880
+ * the name of the subclass should have the library name as a prefix, but subfolders are allowed, e.g. `sap.ui.layout.form.Form`
4881
+ * belongs to library `sap.ui.layout`.
4882
4882
  *
4883
4883
  * **'properties'** : object
4884
4884
  * An object literal whose properties each define a new managed property in the ManagedObject subclass.
@@ -10354,6 +10354,8 @@ declare module "sap/ui/core/Component" {
10354
10354
  ): any;
10355
10355
  }
10356
10356
  /**
10357
+ * @SINCE 1.67
10358
+ *
10357
10359
  * Registry of all `Component`s that currently exist.
10358
10360
  */
10359
10361
  export interface registry {
@@ -10845,12 +10847,6 @@ declare module "sap/ui/core/ComponentContainer" {
10845
10847
  * Container width in CSS size
10846
10848
  */
10847
10849
  getWidth(): CSSSize;
10848
- /**
10849
- * @SINCE 1.91
10850
- *
10851
- * Hides the placeholder that is shown on the component container.
10852
- */
10853
- hidePlaceholder(): void;
10854
10850
  /**
10855
10851
  * Sets a new value for property {@link #getAsync async}.
10856
10852
  *
@@ -11055,22 +11051,6 @@ declare module "sap/ui/core/ComponentContainer" {
11055
11051
  */
11056
11052
  sWidth?: CSSSize
11057
11053
  ): this;
11058
- /**
11059
- * @SINCE 1.91
11060
- *
11061
- * Shows the provided placeholder on the component container.
11062
- */
11063
- showPlaceholder(
11064
- /**
11065
- * Object containing the placeholder object
11066
- */
11067
- mSettings: {
11068
- /**
11069
- * The placeholder instance
11070
- */
11071
- placeholder: /* was: sap.ui.core.Placeholder */ any;
11072
- }
11073
- ): Promise<any>;
11074
11054
  }
11075
11055
 
11076
11056
  export interface $ComponentContainerSettings extends $ControlSettings {
@@ -11495,7 +11475,8 @@ declare module "sap/ui/core/Configuration" {
11495
11475
  */
11496
11476
  getAppCacheBusterMode(): string;
11497
11477
  /**
11498
- * @deprecated (since 1.15.1) - Please use the rootComponent configuration option {@link sap.ui.core.Configuration#getRootComponent}.
11478
+ * @deprecated (since 1.15.1) - Please use {@link module:sap/ui/core/ComponentSupport} instead. See also
11479
+ * {@link topic:82a0fcecc3cb427c91469bc537ebdddf Declarative API for Initial Components}.
11499
11480
  *
11500
11481
  * The name of the application to start or empty.
11501
11482
  */
@@ -11609,7 +11590,8 @@ declare module "sap/ui/core/Configuration" {
11609
11590
  */
11610
11591
  getOriginInfo(): boolean;
11611
11592
  /**
11612
- * @EXPERIMENTAL (since 1.15.1)
11593
+ * @deprecated (since 1.95) - Please use {@link module:sap/ui/core/ComponentSupport} instead. See also {@link
11594
+ * topic:82a0fcecc3cb427c91469bc537ebdddf Declarative API for Initial Components}.
11613
11595
  *
11614
11596
  * The name of the root component to start or empty.
11615
11597
  */
@@ -11627,6 +11609,14 @@ declare module "sap/ui/core/Configuration" {
11627
11609
  * It will be returned in uppercase. e.g. "EN", "DE"
11628
11610
  */
11629
11611
  getSAPLogonLanguage(): string;
11612
+ /**
11613
+ * @SINCE 1.95.0
11614
+ *
11615
+ * Returns the security token handlers of an OData V4 model.
11616
+ * See:
11617
+ * #setSecurityTokenHandlers
11618
+ */
11619
+ getSecurityTokenHandlers(): Function[];
11630
11620
  /**
11631
11621
  * Returns the theme name
11632
11622
  */
@@ -11777,6 +11767,20 @@ declare module "sap/ui/core/Configuration" {
11777
11767
  */
11778
11768
  bRTL: boolean | null
11779
11769
  ): this;
11770
+ /**
11771
+ * @SINCE 1.95.0
11772
+ *
11773
+ * Sets the security token handlers for an OData V4 model. See chapter "Security Token Handling" in {@link
11774
+ * topic:9613f1f2d88747cab21896f7216afdac Model Instantiation and Data Access}.
11775
+ * See:
11776
+ * #getSecurityTokenHandlers
11777
+ */
11778
+ setSecurityTokenHandlers(
11779
+ /**
11780
+ * The security token handlers
11781
+ */
11782
+ aSecurityTokenHandlers: Function[]
11783
+ ): void;
11780
11784
  }
11781
11785
  /**
11782
11786
  * @SINCE 1.50.0
@@ -12314,9 +12318,9 @@ declare module "sap/ui/core/Control" {
12314
12318
  * **IMPORTANT:**
12315
12319
  * This should be only used as FALLBACK when the Control events do not cover a specific use-case! Always
12316
12320
  * try using SAPUI5 control events, as e.g. accessibility-related functionality is then provided automatically.
12317
- * E.g. when working with a `sap.ui.commons.Button`, always use the Button's "press" event, not the native
12318
- * "click" event, because "press" is also guaranteed to be fired when certain keyboard activity is supposed
12319
- * to trigger the Button.
12321
+ * E.g. when working with a `sap.m.Button`, always use the Button's "press" event, not the native "click"
12322
+ * event, because "press" is also guaranteed to be fired when certain keyboard activity is supposed to trigger
12323
+ * the Button.
12320
12324
  *
12321
12325
  * In the event handler, `this` refers to the Control - not to the root DOM element like in jQuery. While
12322
12326
  * the DOM element can be used and modified, the general caveats for working with SAPUI5 control DOM elements
@@ -12924,6 +12928,8 @@ declare module "sap/ui/core/Core" {
12924
12928
 
12925
12929
  import UI5Element from "sap/ui/core/Element";
12926
12930
 
12931
+ import Component from "sap/ui/core/Component";
12932
+
12927
12933
  import RenderManager from "sap/ui/core/RenderManager";
12928
12934
 
12929
12935
  import UIArea from "sap/ui/core/UIArea";
@@ -12932,8 +12938,6 @@ declare module "sap/ui/core/Core" {
12932
12938
 
12933
12939
  import Application from "sap/ui/app/Application";
12934
12940
 
12935
- import Component from "sap/ui/core/Component";
12936
-
12937
12941
  import Configuration from "sap/ui/core/Configuration";
12938
12942
 
12939
12943
  import EventBus from "sap/ui/core/EventBus";
@@ -13314,6 +13318,8 @@ declare module "sap/ui/core/Core" {
13314
13318
  sId: ID | null | undefined
13315
13319
  ): UI5Element | undefined;
13316
13320
  /**
13321
+ * @deprecated (since 1.95) - Please use {@link sap.ui.core.Component.create Component.create} instead.
13322
+ *
13317
13323
  * Creates a component with the provided id and settings.
13318
13324
  *
13319
13325
  * When the optional parameter `sUrl` is given, then all request for resources of the library will be redirected
@@ -13367,7 +13373,7 @@ declare module "sap/ui/core/Core" {
13367
13373
  * the settings object for the component
13368
13374
  */
13369
13375
  mSettings?: object
13370
- ): void;
13376
+ ): Component;
13371
13377
  /**
13372
13378
  * Returns a new instance of the RenderManager for exclusive use by the caller.
13373
13379
  *
@@ -13639,6 +13645,8 @@ declare module "sap/ui/core/Core" {
13639
13645
  */
13640
13646
  getApplication(): Application;
13641
13647
  /**
13648
+ * @deprecated (since 1.95) - Please use {@link sap.ui.core.Component.get Component.get} instead.
13649
+ *
13642
13650
  * Returns the registered component for the given id, if any.
13643
13651
  */
13644
13652
  getComponent(sId: string): Component;
@@ -13759,6 +13767,9 @@ declare module "sap/ui/core/Core" {
13759
13767
  */
13760
13768
  getRenderManager(): void;
13761
13769
  /**
13770
+ * @deprecated (since 1.95) - Please use {@link module:sap/ui/core/ComponentSupport} instead. See also {@link
13771
+ * topic:82a0fcecc3cb427c91469bc537ebdddf Declarative API for Initial Components}.
13772
+ *
13762
13773
  * Returns the instance of the root component (if exists).
13763
13774
  */
13764
13775
  getRootComponent(): Component;
@@ -14008,7 +14019,7 @@ declare module "sap/ui/core/Core" {
14008
14019
  */
14009
14020
  loadLibrary(
14010
14021
  /**
14011
- * name of the library to load
14022
+ * Name of the library to load
14012
14023
  */
14013
14024
  sLibrary: string,
14014
14025
  /**
@@ -14018,16 +14029,16 @@ declare module "sap/ui/core/Core" {
14018
14029
  | string
14019
14030
  | boolean
14020
14031
  | {
14021
- /**
14022
- * URL to load the library from
14023
- */
14024
- url?: string;
14025
14032
  /**
14026
14033
  * Whether to load the library asynchronously
14027
14034
  */
14028
14035
  async?: boolean;
14036
+ /**
14037
+ * URL to load the library from
14038
+ */
14039
+ url?: string;
14029
14040
  }
14030
- ): Object | Promise<any>;
14041
+ ): object | Promise<object>;
14031
14042
  /**
14032
14043
  * Locks the Core. No browser events are dispatched to the controls.
14033
14044
  *
@@ -17188,6 +17199,8 @@ declare module "sap/ui/core/Element" {
17188
17199
  unbindElement(sModelName: string): ManagedObject;
17189
17200
  }
17190
17201
  /**
17202
+ * @SINCE 1.67
17203
+ *
17191
17204
  * Registry of all `sap.ui.core.Element`s that currently exist.
17192
17205
  */
17193
17206
  export interface registry {
@@ -20699,6 +20712,23 @@ declare module "sap/ui/core/IconPool" {
20699
20712
  */
20700
20713
  collectionName?: string
20701
20714
  ): string;
20715
+ /**
20716
+ * Adds CSS code to load an icon font to the DOM
20717
+ */
20718
+ insertFontFaceStyle(
20719
+ /**
20720
+ * the file name of the font face
20721
+ */
20722
+ sFontFace: string,
20723
+ /**
20724
+ * the path to the font file
20725
+ */
20726
+ sPath: string,
20727
+ /**
20728
+ * the collection name, if not specified the font face is used
20729
+ */
20730
+ sCollectionName?: string
20731
+ ): void;
20702
20732
  /**
20703
20733
  * Returns whether the given `uri` is an icon URI.
20704
20734
  *
@@ -23126,6 +23156,8 @@ declare module "sap/ui/core/message/ControlMessageProcessor" {
23126
23156
 
23127
23157
  import Metadata from "sap/ui/base/Metadata";
23128
23158
 
23159
+ import Message from "sap/ui/core/message/Message";
23160
+
23129
23161
  /**
23130
23162
  * The ControlMessageProcessor implementation. This MessageProcessor is able to handle Messages with the
23131
23163
  * following target syntax: 'ControlID/PropertyName'. Creating an instance of this class using the "new"
@@ -23171,9 +23203,9 @@ declare module "sap/ui/core/message/ControlMessageProcessor" {
23171
23203
  */
23172
23204
  setMessages(
23173
23205
  /**
23174
- * map of messages: {'target': [array of messages],...}
23206
+ * map of messages: {'target': [sap.ui.core.message.Message],...}
23175
23207
  */
23176
- vMessages: Record<string, any[]>
23208
+ mMessages: Record<string, Message[]>
23177
23209
  ): void;
23178
23210
  }
23179
23211
  }
@@ -23682,6 +23714,8 @@ declare module "sap/ui/core/message/MessageParser" {
23682
23714
  declare module "sap/ui/core/message/MessageProcessor" {
23683
23715
  import EventProvider from "sap/ui/base/EventProvider";
23684
23716
 
23717
+ import Message from "sap/ui/core/message/Message";
23718
+
23685
23719
  import Metadata from "sap/ui/base/Metadata";
23686
23720
 
23687
23721
  /**
@@ -23786,7 +23820,16 @@ declare module "sap/ui/core/message/MessageProcessor" {
23786
23820
  /**
23787
23821
  * Parameters to pass along with the event
23788
23822
  */
23789
- oParameters?: object
23823
+ mParameters: {
23824
+ /**
23825
+ * Messages already existing before the `messageChange` event was fired.
23826
+ */
23827
+ oldMessages: Message;
23828
+ /**
23829
+ * New messages added by the trigger of the `messageChange` event.
23830
+ */
23831
+ newMessages: Message;
23832
+ }
23790
23833
  ): this;
23791
23834
  /**
23792
23835
  * Returns the ID of the MessageProcessor instance
@@ -23797,9 +23840,9 @@ declare module "sap/ui/core/message/MessageProcessor" {
23797
23840
  */
23798
23841
  setMessages(
23799
23842
  /**
23800
- * map of messages: {'target': [array of messages],...}
23843
+ * map of messages: {'target': [sap.ui.core.message.Message],...}
23801
23844
  */
23802
- vMessages: Record<string, any[]>
23845
+ mMessages: Record<string, Message[]>
23803
23846
  ): void;
23804
23847
  }
23805
23848
  }
@@ -23892,7 +23935,7 @@ declare module "sap/ui/core/mvc/Controller" {
23892
23935
  * **Example for a callback module definition (sync):**
23893
23936
  * ```javascript
23894
23937
  *
23895
- * sap.ui.define("my/custom/sync/ExtensionProvider", ['jquery.sap.global'], function(jQuery) {
23938
+ * sap.ui.define("my/custom/sync/ExtensionProvider", [], function() {
23896
23939
  * var ExtensionProvider = function() {};
23897
23940
  * ExtensionProvider.prototype.getControllerExtensions = function(sControllerName, sComponentId, bAsync) {
23898
23941
  * if (!bAsync && sControllerName == "my.own.Controller") {
@@ -23911,14 +23954,14 @@ declare module "sap/ui/core/mvc/Controller" {
23911
23954
  * }];
23912
23955
  * };
23913
23956
  * return ExtensionProvider;
23914
- * }, true);
23957
+ * });
23915
23958
  * ```
23916
23959
  *
23917
23960
  *
23918
23961
  * **Example for a callback module definition (async):**
23919
23962
  * ```javascript
23920
23963
  *
23921
- * sap.ui.define("my/custom/async/ExtensionProvider", ['jquery.sap.global'], function(jQuery) {
23964
+ * sap.ui.define("my/custom/async/ExtensionProvider", [], function() {
23922
23965
  * var ExtensionProvider = function() {};
23923
23966
  * ExtensionProvider.prototype.getControllerExtensions = function(sControllerName, sComponentId, bAsync) {
23924
23967
  * if (bAsync && sControllerName == "my.own.Controller") {
@@ -23942,7 +23985,7 @@ declare module "sap/ui/core/mvc/Controller" {
23942
23985
  * };
23943
23986
  * };
23944
23987
  * return ExtensionProvider;
23945
- * }, true);
23988
+ * });
23946
23989
  * ```
23947
23990
  *
23948
23991
  *
@@ -24708,6 +24751,11 @@ declare module "sap/ui/core/mvc/View" {
24708
24751
  * #byId}, elements or controls can be found with their view-local ID. Also see {@link topic:91f28be26f4d1014b6dd926db0e91070
24709
24752
  * "Support for Unique IDs"} in the documentation.
24710
24753
  *
24754
+ * **Note: For Views defined using XML markup** On root level, you can only define content for the default
24755
+ * aggregation, e.g. without adding the `<content>` tag. If you want to specify content for another
24756
+ * aggregation of a view like `dependents`, place it in a child control's dependents aggregation or add
24757
+ * it by using {@link sap.ui.core.mvc.XMLView.addDependent}.
24758
+ *
24711
24759
  * View Definition: A view can be defined by {@link sap.ui.core.mvc.View.extend extending} this class and
24712
24760
  * implementing the {@link #createContent} method. The method must return one or many root controls that
24713
24761
  * will be rendered as content of the view.
@@ -27327,6 +27375,9 @@ declare module "sap/ui/core/RenderManager" {
27327
27375
  * When an <img> tag is rendered, the following two attributes are added by default and can be overwritten
27328
27376
  * with corresponding values in the `mAttributes` parameter:
27329
27377
  * - `role: "presentation"` `alt: ""`
27378
+ *
27379
+ * **Note:** This function requires the {@link sap.ui.core.IconPool} module. Ensure that the module is loaded
27380
+ * before this function is called to avoid syncXHRs.
27330
27381
  */
27331
27382
  icon(
27332
27383
  /**
@@ -27597,7 +27648,7 @@ declare module "sap/ui/core/RenderManager" {
27597
27648
  *
27598
27649
  * Writes the attribute and its value into the HTML.
27599
27650
  *
27600
- * For details about the escaping refer to {@link jQuery.sap.encodeHTML}
27651
+ * For details about the escaping refer to {@link sap/base/security/encodeXML}.
27601
27652
  */
27602
27653
  writeAttribute(
27603
27654
  /**
@@ -27675,7 +27726,7 @@ declare module "sap/ui/core/RenderManager" {
27675
27726
  *
27676
27727
  * Escape text for HTML and write it to the buffer.
27677
27728
  *
27678
- * For details about the escaping refer to {@link jQuery.sap.encodeHTML}
27729
+ * For details about the escaping refer to {@link sap/base/security/encodeXML}.
27679
27730
  */
27680
27731
  writeEscaped(
27681
27732
  /**
@@ -28478,6 +28529,17 @@ declare module "sap/ui/core/routing/Router" {
28478
28529
 
28479
28530
  import Views from "sap/ui/core/routing/Views";
28480
28531
 
28532
+ export type RouteInfo = {
28533
+ /**
28534
+ * The route name
28535
+ */
28536
+ name: string;
28537
+ /**
28538
+ * The route data
28539
+ */
28540
+ arguments: Record<string, string>;
28541
+ };
28542
+
28481
28543
  export default class Router extends EventProvider {
28482
28544
  /**
28483
28545
  * Instantiates a SAPUI5 Router
@@ -29162,7 +29224,7 @@ declare module "sap/ui/core/routing/Router" {
29162
29224
  * The hash to be matched
29163
29225
  */
29164
29226
  sHash: string
29165
- ): object | undefined;
29227
+ ): RouteInfo | undefined;
29166
29228
  /**
29167
29229
  * Returns a target by its name.
29168
29230
  *
@@ -31193,11 +31255,22 @@ declare module "sap/ui/core/theming/Parameters" {
31193
31255
  */
31194
31256
  interface Parameters {
31195
31257
  /**
31196
- * Returns the current value for one or more theming parameters, depending on the given arguments. The synchronous
31197
- * usage of this API has been deprecated and only the asynchronous usage should still be used (see the 4th
31198
- * bullet point and the code examples below).
31258
+ * Returns the current value for one or more theming parameters, depending on the given arguments. The
31259
+ * synchronous usage of this API has been deprecated and only the asynchronous usage should still be used
31260
+ * (see the 4th bullet point and the code examples below).
31199
31261
  *
31262
+ * The theming parameters are immutable and cannot be changed at runtime. Multiple `Parameters.get()`
31263
+ * API calls for the same parameter name will always result in the same parameter value.
31200
31264
  *
31265
+ * **Important, since 1.93:** When using the `Parameters.get()` API to retrieve theming parameters defined
31266
+ * as CSS variables, please be aware that the API can also unknowingly retrieve arbitrary CSS variables
31267
+ * defined in the DOM. All CSS variables defined via the `:root` pseudo-class can be retrieved this way.
31268
+ * Please make sure to only access theming parameters defined in a UI5 theme/library.
31269
+ *
31270
+ *
31271
+ *
31272
+ *
31273
+ * The following API variants are available (see also the below examples):
31201
31274
  * - **(deprecated since 1.92)** If no parameter is given a key-value map containing all parameters is
31202
31275
  * returned
31203
31276
  * - **(deprecated since 1.94)** If a `string` is given as first parameter the value is returned as a
@@ -31208,8 +31281,9 @@ declare module "sap/ui/core/theming/Parameters" {
31208
31281
  * are loaded and available or within the callback in case not all CSS files are already loaded. This is
31209
31282
  * the **only asynchronous** API variant. This variant is the preferred way to retrieve theming parameters.
31210
31283
  * The structure of the return value is the same as listed above depending on the type of the name property
31211
- * within the `object`. The returned key-value maps are a copy so changing values in the map does
31212
- * not have any effect
31284
+ * within the `object`.
31285
+ *
31286
+ * The returned key-value maps are a copy so changing values in the map does not have any effect
31213
31287
  *
31214
31288
  * Please see the examples below for a detailed guide on how to use the **asynchronous variant** of
31215
31289
  * the API.
@@ -33117,7 +33191,7 @@ declare module "sap/ui/core/UIArea" {
33117
33191
  /**
33118
33192
  * Returns this `UIArea`'s id (as determined from provided RootNode).
33119
33193
  */
33120
- getId(): string | null;
33194
+ getId(): string;
33121
33195
  /**
33122
33196
  * @deprecated (since 1.1) - use function {@link #getContent} instead
33123
33197
  *
@@ -33445,7 +33519,7 @@ declare module "sap/ui/core/UIComponent" {
33445
33519
  * A `sap.ui.core.UIComponent` subclass can additionally implement the {@link sap.ui.core.IAsyncContentCreation}
33446
33520
  * interface. When implementing this interface the loading and processing of an asynchronous `rootView`
33447
33521
  * will be chained into the result Promise of the {@link sap.ui.core.Component.create Component.create}
33448
- * factory. See Sample 1 below.
33522
+ * factory. An additional async flag can be omitted. See Sample 1 below.
33449
33523
  *
33450
33524
  * Samples 2 and 3 show how subclasses can overwrite the `createContent` function to run asynchronously.
33451
33525
  * To create the root control asynchronously, the subclass has to define the `sap.ui.core.IAsyncContentCreation`
@@ -39144,18 +39218,20 @@ declare module "sap/ui/model/Binding" {
39144
39218
  */
39145
39219
  constructor(
39146
39220
  /**
39147
- * the model
39221
+ * The model
39148
39222
  */
39149
39223
  oModel: Model,
39150
39224
  /**
39151
- * the path
39225
+ * The path
39152
39226
  */
39153
39227
  sPath: string,
39154
39228
  /**
39155
- * the context object
39229
+ * The context object
39156
39230
  */
39157
39231
  oContext: Context,
39158
-
39232
+ /**
39233
+ * Additional, implementation-specific parameters
39234
+ */
39159
39235
  mParameters?: object
39160
39236
  );
39161
39237
 
@@ -39193,27 +39269,27 @@ declare module "sap/ui/model/Binding" {
39193
39269
  */
39194
39270
  attachAggregatedDataStateChange(
39195
39271
  /**
39196
- * The function to be called, when the event occurs
39272
+ * The function to be called when the event occurs
39197
39273
  */
39198
39274
  fnFunction: Function,
39199
39275
  /**
39200
- * Context object to call the event handler with, defaults to this `sap.ui.model.Binding` itself
39276
+ * Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
39201
39277
  */
39202
39278
  oListener?: object
39203
39279
  ): void;
39204
39280
  /**
39205
- * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.model.Model`.
39281
+ * Attaches the `fnFunction` event handler to the {@link #event:change change} event of this `sap.ui.model.Model`.
39206
39282
  *
39207
39283
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
39208
39284
  * otherwise it will be bound to this `sap.ui.model.Binding` itself.
39209
39285
  */
39210
39286
  attachChange(
39211
39287
  /**
39212
- * The function to be called, when the event occurs
39288
+ * The function to be called when the event occurs
39213
39289
  */
39214
39290
  fnFunction: Function,
39215
39291
  /**
39216
- * Context object to call the event handler with, defaults to this `sap.ui.model.Binding` itself
39292
+ * Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
39217
39293
  */
39218
39294
  oListener?: object
39219
39295
  ): void;
@@ -39225,11 +39301,11 @@ declare module "sap/ui/model/Binding" {
39225
39301
  */
39226
39302
  attachDataReceived(
39227
39303
  /**
39228
- * Function to be called, when the event occurs
39304
+ * Function to be called when the event occurs
39229
39305
  */
39230
39306
  fnFunction: Function,
39231
39307
  /**
39232
- * Context object to call the event handler with, defaults to this `sap.ui.model.Binding` itself
39308
+ * Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
39233
39309
  */
39234
39310
  oListener?: object
39235
39311
  ): void;
@@ -39241,35 +39317,40 @@ declare module "sap/ui/model/Binding" {
39241
39317
  */
39242
39318
  attachDataRequested(
39243
39319
  /**
39244
- * The function to be called, when the event occurs
39320
+ * The function to be called when the event occurs
39245
39321
  */
39246
39322
  fnFunction: Function,
39247
39323
  /**
39248
- * Context object to call the event handler with, defaults to this `sap.ui.model.Binding` itself
39324
+ * Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
39249
39325
  */
39250
39326
  oListener?: object
39251
39327
  ): void;
39252
39328
  /**
39253
- * Attaches event handler `fnFunction` to the {@link #event:DataStateChange DataStateChange} event of this
39254
- * `sap.ui.model.Binding`.
39329
+ * Attaches the `fnFunction` event handler to the {@link #event:DataStateChange DataStateChange} event of
39330
+ * thi `sap.ui.model.Binding`.
39255
39331
  *
39256
39332
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
39257
39333
  * otherwise it will be bound to this `sap.ui.model.Binding` itself.
39258
39334
  */
39259
39335
  attachDataStateChange(
39260
39336
  /**
39261
- * Function to be called, when the event occurs
39337
+ * Function to be called when the event occurs
39262
39338
  */
39263
39339
  fnFunction: Function,
39264
39340
  /**
39265
- * Context object to call the event handler with, defaults to this `sap.ui.model.Binding` itself
39341
+ * Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
39266
39342
  */
39267
39343
  oListener?: object
39268
39344
  ): void;
39269
39345
  /**
39270
39346
  * Attach multiple events.
39271
39347
  */
39272
- attachEvents(oEvents: Record<string, Function>): void;
39348
+ attachEvents(
39349
+ /**
39350
+ * Events to attach to this binding
39351
+ */
39352
+ oEvents: Record<string, Function>
39353
+ ): Binding;
39273
39354
  /**
39274
39355
  * Attaches event handler `fnFunction` to the {@link #event:refresh refresh} event of this `sap.ui.model.Binding`.
39275
39356
  *
@@ -39278,11 +39359,11 @@ declare module "sap/ui/model/Binding" {
39278
39359
  */
39279
39360
  attachRefresh(
39280
39361
  /**
39281
- * The function to be called, when the event occurs
39362
+ * The function to be called when the event occurs
39282
39363
  */
39283
39364
  fnFunction: Function,
39284
39365
  /**
39285
- * Context object to call the event handler with, defaults to this `sap.ui.model.Binding` itself
39366
+ * Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
39286
39367
  */
39287
39368
  oListener?: object
39288
39369
  ): void;
@@ -39299,7 +39380,7 @@ declare module "sap/ui/model/Binding" {
39299
39380
  */
39300
39381
  detachAggregatedDataStateChange(
39301
39382
  /**
39302
- * The function to be called, when the event occurs
39383
+ * The function to be called when the event occurs
39303
39384
  */
39304
39385
  fnFunction: Function,
39305
39386
  /**
@@ -39312,7 +39393,7 @@ declare module "sap/ui/model/Binding" {
39312
39393
  */
39313
39394
  detachChange(
39314
39395
  /**
39315
- * Function to be called, when the event occurs
39396
+ * Function to be called when the event occurs
39316
39397
  */
39317
39398
  fnFunction: Function,
39318
39399
  /**
@@ -39325,7 +39406,7 @@ declare module "sap/ui/model/Binding" {
39325
39406
  */
39326
39407
  detachDataReceived(
39327
39408
  /**
39328
- * Function to be called, when the event occurs
39409
+ * Function to be called when the event occurs
39329
39410
  */
39330
39411
  fnFunction: Function,
39331
39412
  /**
@@ -39339,7 +39420,7 @@ declare module "sap/ui/model/Binding" {
39339
39420
  */
39340
39421
  detachDataRequested(
39341
39422
  /**
39342
- * The function to be called, when the event occurs
39423
+ * The function to be called when the event occurs
39343
39424
  */
39344
39425
  fnFunction: Function,
39345
39426
  /**
@@ -39353,7 +39434,7 @@ declare module "sap/ui/model/Binding" {
39353
39434
  */
39354
39435
  detachDataStateChange(
39355
39436
  /**
39356
- * The function to be called, when the event occurs
39437
+ * The function to be called when the event occurs
39357
39438
  */
39358
39439
  fnFunction: Function,
39359
39440
  /**
@@ -39364,17 +39445,22 @@ declare module "sap/ui/model/Binding" {
39364
39445
  /**
39365
39446
  * Detach multiple events.
39366
39447
  */
39367
- detachEvents(oEvents: Record<string, Function>): void;
39448
+ detachEvents(
39449
+ /**
39450
+ * Events to detach from this binding
39451
+ */
39452
+ oEvents: Record<string, Function>
39453
+ ): Binding;
39368
39454
  /**
39369
39455
  * Detaches event handler `fnFunction` from the {@link #event:refresh refresh} event of this `sap.ui.model.Binding`.
39370
39456
  */
39371
39457
  detachRefresh(
39372
39458
  /**
39373
- * The function to be called, when the event occurs
39459
+ * The function to be called when the event occurs
39374
39460
  */
39375
39461
  fnFunction: Function,
39376
39462
  /**
39377
- * object on which to call the given function.
39463
+ * Object on which to call the given function.
39378
39464
  */
39379
39465
  oListener?: object
39380
39466
  ): void;
@@ -39385,11 +39471,11 @@ declare module "sap/ui/model/Binding" {
39385
39471
  */
39386
39472
  fireDataReceived(
39387
39473
  /**
39388
- * Parameters to pass along with the event.
39474
+ * Parameters to pass along with the event
39389
39475
  */
39390
39476
  oParameters: {
39391
39477
  /**
39392
- * Data received. In error cases it will be undefined.
39478
+ * Data received; on error cases it will be undefined
39393
39479
  */
39394
39480
  data?: object;
39395
39481
  }
@@ -39399,7 +39485,7 @@ declare module "sap/ui/model/Binding" {
39399
39485
  */
39400
39486
  fireDataRequested(
39401
39487
  /**
39402
- * Parameters to pass along with the event.
39488
+ * Parameters to pass along with the event
39403
39489
  */
39404
39490
  oParameters: object
39405
39491
  ): void;
@@ -39445,11 +39531,11 @@ declare module "sap/ui/model/Binding" {
39445
39531
  */
39446
39532
  initialize(): void;
39447
39533
  /**
39448
- * Returns whether the binding is initial, which means it did not get an initial value yet
39534
+ * Returns whether the binding is initial, which means it did not get an initial value yet.
39449
39535
  */
39450
39536
  isInitial(): boolean;
39451
39537
  /**
39452
- * Returns whether the binding is relative, which means its path does not start with a slash ('/')
39538
+ * Returns whether the binding is relative, which means its path does not start with a slash.
39453
39539
  */
39454
39540
  isRelative(): boolean;
39455
39541
  /**
@@ -39482,8 +39568,8 @@ declare module "sap/ui/model/Binding" {
39482
39568
  /**
39483
39569
  * Resumes the binding update. Change events will be fired again.
39484
39570
  *
39485
- * When the binding is resumed, a change event will be fired immediately, if the data has changed while
39486
- * the binding was suspended. For server-side models, a request to the server will be triggered, if a refresh
39571
+ * When the binding is resumed, a change event will be fired immediately if the data has changed while the
39572
+ * binding was suspended. For server-side models, a request to the server will be triggered if a refresh
39487
39573
  * was requested while the binding was suspended.
39488
39574
  */
39489
39575
  resume(): void;
@@ -39593,7 +39679,9 @@ declare module "sap/ui/model/ChangeReason" {
39593
39679
  * The list was refreshed
39594
39680
  */
39595
39681
  Refresh = "refresh",
39596
-
39682
+ /**
39683
+ * A context was removed from a binding.
39684
+ */
39597
39685
  Remove = "remove",
39598
39686
  /**
39599
39687
  * The list was sorted
@@ -40066,9 +40154,9 @@ declare module "sap/ui/model/ClientTreeBinding" {
40066
40154
  */
40067
40155
  sort(
40068
40156
  /**
40069
- * array of Sorter instances which will be applied
40157
+ * An array of Sorter instances which will be applied
40070
40158
  */
40071
- an: Sorter[]
40159
+ aSorters: Sorter[]
40072
40160
  ): this;
40073
40161
  }
40074
40162
  }
@@ -40097,7 +40185,7 @@ declare module "sap/ui/model/CompositeBinding" {
40097
40185
  *
40098
40186
  * A `CompositeBinding` combines the values from all its binding parts (each an instance of `PropertyBinding`),
40099
40187
  * either by calling a formatter function or by involving a {@link sap.ui.model.CompositeType composite
40100
- * type}. When a formatter function is used, then the composite binding is automatically limited to `OneWay`
40188
+ * type}. When a formatter function is used, the composite binding is automatically limited to `OneWay`
40101
40189
  * mode. When a type is used, the binding can also operate in `TwoWay` mode.
40102
40190
  *
40103
40191
  * Higher layers of the framework derive composite bindings from easy-to-write string representations (the
@@ -40163,7 +40251,7 @@ declare module "sap/ui/model/CompositeBinding" {
40163
40251
  */
40164
40252
  fnFunction: Function,
40165
40253
  /**
40166
- * object on which to call the given function.
40254
+ * Object on which to call the given function
40167
40255
  */
40168
40256
  oListener?: object
40169
40257
  ): void;
@@ -40179,7 +40267,7 @@ declare module "sap/ui/model/CompositeBinding" {
40179
40267
  */
40180
40268
  fnFunction: Function,
40181
40269
  /**
40182
- * object on which to call the given function
40270
+ * Object on which to call the given function
40183
40271
  */
40184
40272
  oListener?: object
40185
40273
  ): void;
@@ -40195,7 +40283,7 @@ declare module "sap/ui/model/CompositeBinding" {
40195
40283
  */
40196
40284
  fnFunction: Function,
40197
40285
  /**
40198
- * object on which to call the given function
40286
+ * Object on which to call the given function
40199
40287
  */
40200
40288
  oListener?: object
40201
40289
  ): void;
@@ -40208,7 +40296,7 @@ declare module "sap/ui/model/CompositeBinding" {
40208
40296
  */
40209
40297
  fnFunction: Function,
40210
40298
  /**
40211
- * object on which to call the given function
40299
+ * Object on which to call the given function
40212
40300
  */
40213
40301
  oListener?: object
40214
40302
  ): void;
@@ -40221,7 +40309,7 @@ declare module "sap/ui/model/CompositeBinding" {
40221
40309
  */
40222
40310
  fnFunction: Function,
40223
40311
  /**
40224
- * object on which to call the given function
40312
+ * Object on which to call the given function
40225
40313
  */
40226
40314
  oListener?: object
40227
40315
  ): void;
@@ -40234,7 +40322,7 @@ declare module "sap/ui/model/CompositeBinding" {
40234
40322
  */
40235
40323
  fnFunction: Function,
40236
40324
  /**
40237
- * object on which to call the given function
40325
+ * Object on which to call the given function
40238
40326
  */
40239
40327
  oListener?: object
40240
40328
  ): void;
@@ -40248,12 +40336,12 @@ declare module "sap/ui/model/CompositeBinding" {
40248
40336
  getExternalValue(): object;
40249
40337
  /**
40250
40338
  * Returns the current internal value of the bound target which is an array of the internal (JS native)
40251
- * values of nested bindings
40339
+ * values of nested bindings.
40252
40340
  */
40253
40341
  getInternalValue(): any[];
40254
40342
  /**
40255
40343
  * Returns the current raw value of the bound target which is an array of the raw (model) values of nested
40256
- * bindings
40344
+ * bindings.
40257
40345
  */
40258
40346
  getRawValue(): any[];
40259
40347
  /**
@@ -40262,10 +40350,10 @@ declare module "sap/ui/model/CompositeBinding" {
40262
40350
  getValue(): object;
40263
40351
  /**
40264
40352
  * Initialize the binding. The method should be called when creating a binding. The default implementation
40265
- * calls checkUpdate(true). Prevent checkUpdate to be triggered while initializing nestend bindings, it
40266
- * is sufficient to call checkUpdate when all nested bindings are initialized.
40353
+ * calls checkUpdate(true). Prevent checkUpdate to be triggered while initializing nested bindings, it is
40354
+ * sufficient to call checkUpdate when all nested bindings are initialized.
40267
40355
  */
40268
- initialize(): void;
40356
+ initialize(): this;
40269
40357
  /**
40270
40358
  * Suspends the binding update. No change events will be fired.
40271
40359
  *
@@ -40276,12 +40364,12 @@ declare module "sap/ui/model/CompositeBinding" {
40276
40364
  resume(): void;
40277
40365
  /**
40278
40366
  * Sets the external value of a composite binding. If no CompositeType is assigned to the binding, the default
40279
- * implementation assumes a space separated list of values. This will cause the setValue to be called for
40367
+ * implementation assumes a space-separated list of values. This will cause the setValue to be called for
40280
40368
  * each nested binding, except for undefined values in the array.
40281
40369
  */
40282
40370
  setExternalValue(
40283
40371
  /**
40284
- * the value to set for this binding
40372
+ * The value to set for this binding
40285
40373
  */
40286
40374
  oValue: object
40287
40375
  ): undefined | Promise<any>;
@@ -40294,7 +40382,7 @@ declare module "sap/ui/model/CompositeBinding" {
40294
40382
  * the new values of the nested bindings
40295
40383
  */
40296
40384
  aValues: any[]
40297
- ): void;
40385
+ ): undefined | Promise<any>;
40298
40386
  /**
40299
40387
  * Sets the raw value of the bound target. Parameter must be an array of values matching the raw (model)
40300
40388
  * types of nested bindings.
@@ -40304,7 +40392,7 @@ declare module "sap/ui/model/CompositeBinding" {
40304
40392
  * the new values of the nested bindings
40305
40393
  */
40306
40394
  aValues: any[]
40307
- ): void;
40395
+ ): undefined | Promise<any>;
40308
40396
  /**
40309
40397
  * Sets the optional type and internal type for the binding. The type and internal type are used to do the
40310
40398
  * parsing/formatting correctly. The internal type is the property type of the element which the value is
@@ -40312,11 +40400,11 @@ declare module "sap/ui/model/CompositeBinding" {
40312
40400
  */
40313
40401
  setType(
40314
40402
  /**
40315
- * the type for the binding
40403
+ * The type for the binding
40316
40404
  */
40317
40405
  oType: CompositeType,
40318
40406
  /**
40319
- * the internal type of the element property which this binding is bound against.
40407
+ * The internal type of the element property which this binding is bound against.
40320
40408
  */
40321
40409
  sInternalType: string
40322
40410
  ): void;
@@ -40326,7 +40414,7 @@ declare module "sap/ui/model/CompositeBinding" {
40326
40414
  */
40327
40415
  setValue(
40328
40416
  /**
40329
- * the values to set for this binding
40417
+ * The values to set for this binding
40330
40418
  */
40331
40419
  aValues: any[]
40332
40420
  ): void;
@@ -40980,17 +41068,19 @@ declare module "sap/ui/model/Filter" {
40980
41068
  * You either pass a single object literal with the filter parameters or use the individual constructor
40981
41069
  * arguments. No matter which variant is used, only certain combinations of parameters are supported (the
40982
41070
  * following list uses the names from the object literal):
40983
- * - A `path`, `operator` and one or two values (`value1`, `value2`), depending on the operator
40984
- * - A `path` and a custom filter function `test`
40985
- * - An array of other filters named `filters` and a Boolean flag `and` that specifies whether to combine
40986
- * the filters with an AND (`true`) or an OR (`false`) operator. An error will be logged to the console
40987
- * if an invalid combination of parameters is provided. Please note that a model implementation may not
40988
- * support a custom filter function, e.g. if the model does not perform client side filtering. It also depends
40989
- * on the model implementation if the filtering is case sensitive or not. Client models filter case insensitive
40990
- * compared to the OData models which filter case sensitive by default. See particular model documentation
40991
- * for details The filter operators `Any` and `All` are only supported in V4 OData models. When creating
40992
- * a filter instance with these filter operators, the argument `variable` only accepts a string identifier
40993
- * and `condition` needs to be another filter instance.
41071
+ * A `path`, `operator` and one or two values (`value1`, `value2`), depending on the operator A `path`
41072
+ * and a custom filter function `test` An array of other filters named `filters` and a Boolean flag
41073
+ * `and` that specifies whether to combine the filters with an AND (`true`) or an OR (`false`) operator.
41074
+ * An error will be logged to the console if an invalid combination of parameters is provided.
41075
+ *
41076
+ * Please note that a model implementation may not support a custom filter function, e.g. if the model does
41077
+ * not perform client-side filtering. It also depends on the model implementation if the filtering is case
41078
+ * sensitive or not. Client models filter case insensitive compared to the OData models which filter case
41079
+ * sensitive by default. See particular model documentation for details.
41080
+ *
41081
+ * The filter operators {@link sap.ui.model.FilterOperator.Any "Any"} and {@link sap.ui.model.FilterOperator.All
41082
+ * "All"} are only supported in V4 OData models. When creating a filter instance with these filter operators,
41083
+ * the argument `variable` only accepts a string identifier and `condition` needs to be another filter instance.
40994
41084
  */
40995
41085
  constructor(
40996
41086
  /**
@@ -41003,15 +41093,19 @@ declare module "sap/ui/model/Filter" {
41003
41093
  */
41004
41094
  path?: string;
41005
41095
  /**
41006
- * Function which is used to filter the items and which should return a Boolean value to indicate whether
41007
- * the current item passes the filter
41096
+ * Function used for the client-side filtering of items. It should return a Boolean indicating whether the
41097
+ * current item passes the filter. If no test function is given, a default test function is used, based
41098
+ * on the given filter operator and the comparator function.
41008
41099
  */
41009
- test?: Function;
41100
+ test?: (p1: any) => boolean;
41010
41101
  /**
41011
- * Function which is used to compare two values, this is used for processing of equal, less than and greater
41012
- * than operators
41102
+ * Function used to compare two values for equality and order during client-side filtering. Two values are
41103
+ * given as parameters. The function is expected to return:
41104
+ * a negative number if the first value is smaller than the second value, `0` if the two values are
41105
+ * equal, a positive number if the first value is larger than the second value, `NaN` for non-comparable
41106
+ * values. If no function is given, {@link sap.ui.model.Filter.defaultComparator} is used.
41013
41107
  */
41014
- comparator?: Function;
41108
+ comparator?: (p1: any, p2: any) => number;
41015
41109
  /**
41016
41110
  * Operator used for the filter
41017
41111
  */
@@ -41021,47 +41115,52 @@ declare module "sap/ui/model/Filter" {
41021
41115
  */
41022
41116
  value1?: any;
41023
41117
  /**
41024
- * Second value to use with the filter operator (only for some operators)
41118
+ * Second value to use with the given filter operator, used only for the {@link sap.ui.model.FilterOperator.BT
41119
+ * "BT" between} and {@link sap.ui.model.FilterOperator.NB "NB" not between} filter operators
41025
41120
  */
41026
41121
  value2?: any;
41027
41122
  /**
41028
- * The variable used in lambda operators (`Any` and `All`)
41123
+ * The variable name used in lambda operators ({@link sap.ui.model.FilterOperator.Any "Any"} and {@link
41124
+ * sap.ui.model.FilterOperator.All "All"})
41029
41125
  */
41030
41126
  variable?: string;
41031
41127
  /**
41032
- * A `Filter` instance which will be used as the condition for the lambda operator
41128
+ * A filter instance which will be used as the condition for lambda operators ({@link sap.ui.model.FilterOperator.Any
41129
+ * "Any"} and {@link sap.ui.model.FilterOperator.All "All"})
41033
41130
  */
41034
41131
  condition?: Filter;
41035
41132
  /**
41036
- * Array of filters on which logical conjunction is applied
41133
+ * An array of filters on which the logical conjunction is applied
41037
41134
  */
41038
41135
  filters?: Filter[];
41039
41136
  /**
41040
41137
  * Indicates whether an "AND" logical conjunction is applied on the filters. If it's not set or set to `false`,
41041
- * an "OR" conjunction is applied
41138
+ * an "OR" conjunction is applied.
41042
41139
  */
41043
41140
  and?: boolean;
41044
41141
  /**
41045
- * Indicates whether a string value should be compared case sensitive or not.
41142
+ * Indicates whether a string value should be compared case sensitive or not. The handling of `undefined`
41143
+ * depends on the model implementation.
41046
41144
  */
41047
41145
  caseSensitive?: boolean;
41048
41146
  }
41049
41147
  | string
41050
41148
  | Filter[],
41051
41149
  /**
41052
- * Either a filter operator or a custom filter function or a Boolean flag that defines how to combine multiple
41053
- * filters
41150
+ * Either a filter operator or a custom filter function or a `boolean` flag that defines how to combine
41151
+ * multiple filters
41054
41152
  */
41055
41153
  vOperator?:
41056
41154
  | (FilterOperator | keyof typeof FilterOperator)
41057
- | Function
41155
+ | ((p1: any) => boolean)
41058
41156
  | boolean,
41059
41157
  /**
41060
41158
  * First value to use with the given filter operator
41061
41159
  */
41062
41160
  vValue1?: any,
41063
41161
  /**
41064
- * Second value to use with the given filter operator (only for some operators)
41162
+ * Second value to use with the given filter operator, used only for the {@link sap.ui.model.FilterOperator.BT
41163
+ * "BT" between} and {@link sap.ui.model.FilterOperator.NB "NB" not between} filter operators
41065
41164
  */
41066
41165
  vValue2?: any
41067
41166
  );
@@ -41069,7 +41168,7 @@ declare module "sap/ui/model/Filter" {
41069
41168
  /**
41070
41169
  * Compares two values
41071
41170
  *
41072
- * This is the default comparator function used for clientside filtering, if no custom comparator is given
41171
+ * This is the default comparator function used for client-side filtering, if no custom comparator is given
41073
41172
  * in the constructor. It does compare just by using equal/less than/greater than with automatic type casting,
41074
41173
  * except for null values, which are neither less or greater, and string values where localeCompare is used.
41075
41174
  *
@@ -41084,7 +41183,7 @@ declare module "sap/ui/model/Filter" {
41084
41183
  * the second value to compare
41085
41184
  */
41086
41185
  b: any
41087
- ): int;
41186
+ ): number;
41088
41187
  /**
41089
41188
  * Creates a new subclass of class sap.ui.model.Filter with name `sClassName` and enriches it with the information
41090
41189
  * contained in `oClassInfo`.
@@ -41110,6 +41209,83 @@ declare module "sap/ui/model/Filter" {
41110
41209
  * Returns a metadata object for class sap.ui.model.Filter.
41111
41210
  */
41112
41211
  static getMetadata(): Metadata;
41212
+ /**
41213
+ * @SINCE 1.96.0
41214
+ *
41215
+ * Returns the comparator function as provided on construction of this filter, see {@link sap.ui.model.Filter#constructor},
41216
+ * parameter `vFilterInfo.comparator`.
41217
+ */
41218
+ getComparator(): ((p1: any) => boolean) | undefined;
41219
+ /**
41220
+ * @SINCE 1.96.0
41221
+ *
41222
+ * Returns the filter instance which is used as the condition for lambda operators, see {@link sap.ui.model.Filter#constructor},
41223
+ * parameter `vFilterInfo.condition`.
41224
+ */
41225
+ getCondition(): Filter | undefined;
41226
+ /**
41227
+ * @SINCE 1.96.0
41228
+ *
41229
+ * Returns the array of filters as specified on construction of this filter, see {@link sap.ui.model.Filter#constructor},
41230
+ * parameter `vFilterInfo.filters`
41231
+ */
41232
+ getFilters(): Filter[] | undefined;
41233
+ /**
41234
+ * @SINCE 1.96.0
41235
+ *
41236
+ * Returns the filter operator used for this filter, see {@link sap.ui.model.Filter#constructor}, parameter
41237
+ * `vFilterInfo.operator` or `vOperator`.
41238
+ */
41239
+ getOperator(): (FilterOperator | keyof typeof FilterOperator) | undefined;
41240
+ /**
41241
+ * @SINCE 1.96.0
41242
+ *
41243
+ * Returns the binding path for this filter, see {@link sap.ui.model.Filter#constructor}, parameter `vFilterInfo`
41244
+ * or `vFilterInfo.path`.
41245
+ */
41246
+ getPath(): string | undefined;
41247
+ /**
41248
+ * @SINCE 1.96.0
41249
+ *
41250
+ * Returns the test function which is used to filter the items, see {@link sap.ui.model.Filter#constructor},
41251
+ * parameter `vFilterInfo.test`.
41252
+ */
41253
+ getTest(): ((p1: any, p2: any) => boolean) | undefined;
41254
+ /**
41255
+ * @SINCE 1.96.0
41256
+ *
41257
+ * Returns the first value that is used with the given filter operator, see {@link sap.ui.model.Filter#constructor},
41258
+ * parameter `vFilterInfo.value1` or `vValue1`.
41259
+ */
41260
+ getValue1(): any;
41261
+ /**
41262
+ * @SINCE 1.96.0
41263
+ *
41264
+ * Returns the second value that is used with the given filter operator, see {@link sap.ui.model.Filter#constructor},
41265
+ * parameter `vFilterInfo.value2` or `vValue2`.
41266
+ */
41267
+ getValue2(): any;
41268
+ /**
41269
+ * @SINCE 1.96.0
41270
+ *
41271
+ * Returns the variable name used in lambda operators, see {@link sap.ui.model.Filter#constructor}, parameter
41272
+ * `vFilterInfo.variable`.
41273
+ */
41274
+ getVariable(): string | undefined;
41275
+ /**
41276
+ * @SINCE 1.96.0
41277
+ *
41278
+ * Indicates whether an "AND" logical conjunction is applied on the filters, see {@link sap.ui.model.Filter#constructor},
41279
+ * parameter `vFilterInfo.and`.
41280
+ */
41281
+ isAnd(): boolean;
41282
+ /**
41283
+ * @SINCE 1.96.0
41284
+ *
41285
+ * Indicates whether a string value should be compared case sensitive, see {@link sap.ui.model.Filter#constructor},
41286
+ * parameter `vFilterInfo.caseSensitive`.
41287
+ */
41288
+ isCaseSensitive(): boolean;
41113
41289
  }
41114
41290
  }
41115
41291
 
@@ -41351,7 +41527,9 @@ declare module "sap/ui/model/json/JSONModel" {
41351
41527
  import Context from "sap/ui/model/Context";
41352
41528
 
41353
41529
  /**
41354
- * Model implementation for JSON format
41530
+ * Model implementation for the JSON format.
41531
+ *
41532
+ * This model is not prepared to be inherited from.
41355
41533
  */
41356
41534
  export default class JSONModel extends ClientModel {
41357
41535
  /**
@@ -41700,7 +41878,7 @@ declare module "sap/ui/model/ListBinding" {
41700
41878
  */
41701
41879
  fnFunction: Function,
41702
41880
  /**
41703
- * Context object to call the event handler with, defaults to this `ListBinding` itself
41881
+ * Context object to call the event handler with; defaults to this `ListBinding` itself
41704
41882
  */
41705
41883
  oListener?: object
41706
41884
  ): void;
@@ -41719,7 +41897,7 @@ declare module "sap/ui/model/ListBinding" {
41719
41897
  */
41720
41898
  fnFunction: Function,
41721
41899
  /**
41722
- * Context object to call the event handler with, defaults to this `ListBinding` itself
41900
+ * Context object to call the event handler with; defaults to this `ListBinding` itself
41723
41901
  */
41724
41902
  oListener?: object
41725
41903
  ): void;
@@ -41734,7 +41912,7 @@ declare module "sap/ui/model/ListBinding" {
41734
41912
  */
41735
41913
  fnFunction: Function,
41736
41914
  /**
41737
- * on which the given function had to be called
41915
+ * On which object the given function had to be called
41738
41916
  */
41739
41917
  oListener?: object
41740
41918
  ): void;
@@ -41790,7 +41968,11 @@ declare module "sap/ui/model/ListBinding" {
41790
41968
  * The path of the property containing the key or a function getting the context as only parameter to calculate
41791
41969
  * a key to identify an entry
41792
41970
  */
41793
- vKey: Function | string
41971
+ vKey: Function | string,
41972
+ /**
41973
+ * The configuration for the change detection
41974
+ */
41975
+ oExtendedChangeDetectionConfig: object
41794
41976
  ): void;
41795
41977
  /**
41796
41978
  * Applies a new set of filters to the list represented by this binding.
@@ -41799,18 +41981,18 @@ declare module "sap/ui/model/ListBinding" {
41799
41981
  * a server and it might execute asynchronously.
41800
41982
  *
41801
41983
  * Application and Control Filters: Each list binding maintains two separate lists of filters, one for filters
41802
- * defined by the control that owns the binding and another list for filters that an application can define
41984
+ * defined by the control that owns the binding, and another list for filters that an application can define
41803
41985
  * in addition. When executing the filter operation, both sets of filters are combined.
41804
41986
  *
41805
- * By using the second parameter `sFilterType` of method `filter`, the caller can control which set of filters
41987
+ * By using the `sFilterType` parameter of the `filter` method, the caller can control which set of filters
41806
41988
  * is modified. If no type is given, then the behavior depends on the model implementation and should be
41807
41989
  * documented in the API reference for that model.
41808
41990
  *
41809
41991
  * Auto-Grouping of Filters: Filters are first grouped according to their binding path. All filters belonging
41810
- * to the same group are ORed and after that the results of all groups are ANDed. Usually this means, all
41811
- * filters applied to a single table column are ORed, while filters on different table columns are ANDed.
41812
- * Please either use the automatic grouping of filters (where applicable) or use explicit AND/OR filters,
41813
- * a mixture of both is not supported.
41992
+ * to the same path are ORed, and after that the results of all paths are ANDed. Usually this means that
41993
+ * all filters applied to the same property are ORed, while filters on different properties are ANDed. Please
41994
+ * use either the automatic grouping of filters (where applicable) or explicit AND/OR filters, as a mixture
41995
+ * of both is not supported.
41814
41996
  */
41815
41997
  filter(
41816
41998
  /**
@@ -41822,6 +42004,15 @@ declare module "sap/ui/model/ListBinding" {
41822
42004
  */
41823
42005
  sFilterType?: FilterType | keyof typeof FilterType
41824
42006
  ): this;
42007
+ /**
42008
+ * @SINCE 1.97.0
42009
+ *
42010
+ * Returns all current contexts of this list binding in no special order. Just like {@link #getCurrentContexts},
42011
+ * this method does not request any data from a back end and does not change the binding's state. In contrast
42012
+ * to {@link #getCurrentContexts}, it does not only return the contexts as last requested by a control,
42013
+ * but all that are currently available in the binding.
42014
+ */
42015
+ getAllCurrentContexts(): Context[];
41825
42016
  /**
41826
42017
  * Returns an array of binding contexts for the bound target list.
41827
42018
  *
@@ -41839,22 +42030,22 @@ declare module "sap/ui/model/ListBinding" {
41839
42030
  */
41840
42031
  getContexts(
41841
42032
  /**
41842
- * the startIndex where to start the retrieval of contexts
42033
+ * The startIndex where to start the retrieval of contexts
41843
42034
  */
41844
42035
  iStartIndex?: int,
41845
42036
  /**
41846
- * determines how many contexts to retrieve beginning from the start index.
42037
+ * Determines how many contexts to retrieve beginning from the start index.
41847
42038
  */
41848
42039
  iLength?: int,
41849
42040
  /**
41850
42041
  * The maximum number of contexts to read before and after the given range; with this, controls can prefetch
41851
- * data that is likely to be needed soon, e.g. when scrolling down in a table. This parameter is model-specific
41852
- * and not implemented by all models.
42042
+ * data that is likely to be needed soon, e.g. when scrolling down in a table; this parameter is model-specific
42043
+ * and not implemented by all models
41853
42044
  */
41854
42045
  iMaximumPrefetchSize?: int,
41855
42046
  /**
41856
42047
  * Whether this call keeps the result of {@link #getCurrentContexts} untouched; since 1.86.0. This parameter
41857
- * is model-specific and not implemented by all models.
42048
+ * is model-specific and not implemented by all models
41858
42049
  */
41859
42050
  bKeepCurrent?: boolean
41860
42051
  ): Context[];
@@ -41874,11 +42065,10 @@ declare module "sap/ui/model/ListBinding" {
41874
42065
  /**
41875
42066
  * @SINCE 1.28
41876
42067
  *
41877
- * Returns an array of currently used binding contexts of the bound control.
42068
+ * Returns the contexts of this list binding as last requested by the control and in the same order the
42069
+ * control has received them.
41878
42070
  *
41879
- * This method does not trigger any data requests from the backend or delta calculation, but just returns
41880
- * the context array as last requested by the control. This can be used by the application to get access
41881
- * to the data currently displayed by a list control.
42071
+ * This method does not request any data from a back end and does not change the binding's state.
41882
42072
  */
41883
42073
  getCurrentContexts(): Context[];
41884
42074
  /**
@@ -41890,6 +42080,17 @@ declare module "sap/ui/model/ListBinding" {
41890
42080
  */
41891
42081
  sPath: string
41892
42082
  ): any[];
42083
+ /**
42084
+ * @SINCE 1.96.0
42085
+ *
42086
+ * Returns the filters set via the constructor or via {@link #filter} for the given {@link sap.ui.model.FilterType}.
42087
+ */
42088
+ getFilters(
42089
+ /**
42090
+ * The FilterType
42091
+ */
42092
+ sFilterType: FilterType | keyof typeof FilterType
42093
+ ): Filter[];
41893
42094
  /**
41894
42095
  * Gets the group for the given context. Must only be called if `isGrouped()` returns that grouping is enabled
41895
42096
  * for this binding. The grouping will be performed using the first sorter (in case multiple sorters are
@@ -41913,8 +42114,8 @@ declare module "sap/ui/model/ListBinding" {
41913
42114
  */
41914
42115
  getLength(): int;
41915
42116
  /**
41916
- * Indicates whether grouping is enabled for the binding. Grouping is enabled for a list binding, if at
41917
- * least one sorter exists on the binding and the first sorter is a grouping sorter.
42117
+ * Indicates whether grouping is enabled for the binding. Grouping is enabled for a list binding if at least
42118
+ * one sorter exists on the binding and the first sorter is a grouping sorter.
41918
42119
  */
41919
42120
  isGrouped(): boolean;
41920
42121
  /**
@@ -41951,7 +42152,7 @@ declare module "sap/ui/model/ListBinding" {
41951
42152
  * Instead of a single sorter also an array of sorters can be passed to the sort method. In this case they
41952
42153
  * are processed in the sequence in which they are contained in the array.
41953
42154
  *
41954
- * Grouping: Sorting and grouping are closely related, in case a list should be grouped, it must be sorted
42155
+ * Grouping: Sorting and grouping are closely related. In case a list should be grouped, it must be sorted
41955
42156
  * by the property to group with. Grouping is enabled by setting the `group` property on the sorter object.
41956
42157
  * If it is enabled, you can get the current group of an item using {@link sap.ui.model.ListBinding.prototype.getGroup}.
41957
42158
  * In case multiple sorters are provided, grouping can only be done on the first sorter, nested grouping
@@ -41959,7 +42160,7 @@ declare module "sap/ui/model/ListBinding" {
41959
42160
  */
41960
42161
  sort(
41961
42162
  /**
41962
- * the Sorter object or an array of sorters which defines the sort order
42163
+ * The Sorter object or an array of sorters which defines the sort order
41963
42164
  */
41964
42165
  aSorters: Sorter | any[]
41965
42166
  ): this;
@@ -41973,8 +42174,12 @@ declare module "sap/ui/model/message/MessageModel" {
41973
42174
 
41974
42175
  import Metadata from "sap/ui/base/Metadata";
41975
42176
 
42177
+ import Context from "sap/ui/model/Context";
42178
+
41976
42179
  /**
41977
- * Model implementation for Messages
42180
+ * Model implementation for Messages.
42181
+ *
42182
+ * This model is not prepared to be inherited from.
41978
42183
  */
41979
42184
  export default class MessageModel extends ClientModel {
41980
42185
  /**
@@ -42013,17 +42218,17 @@ declare module "sap/ui/model/message/MessageModel" {
42013
42218
  */
42014
42219
  static getMetadata(): Metadata;
42015
42220
  /**
42016
- * Returns the value for the property with the given `sPropertyName`
42221
+ * Returns the value for the property with the given `sPropertyName`.
42017
42222
  */
42018
42223
  getProperty(
42019
42224
  /**
42020
- * the path to the property
42225
+ * The path to the property
42021
42226
  */
42022
42227
  sPath: string,
42023
42228
  /**
42024
- * the context which will be used to retrieve the property
42229
+ * The context to resolve a relative path with
42025
42230
  */
42026
- oContext?: object
42231
+ oContext?: Context
42027
42232
  ): any;
42028
42233
  /**
42029
42234
  * Sets the message data to the model.
@@ -42040,7 +42245,20 @@ declare module "sap/ui/model/message/MessageModel" {
42040
42245
  * Other models provide this method to set a new value for a specific property. `MessageModel` does not
42041
42246
  * support it as it supports the `OneWay` mode only.
42042
42247
  */
42043
- setProperty(): void;
42248
+ setProperty(
42249
+ /**
42250
+ * Unused in this implementation
42251
+ */
42252
+ sPath: string,
42253
+ /**
42254
+ * Unused in this implementation
42255
+ */
42256
+ oValue: object,
42257
+ /**
42258
+ * Unused in this implementation
42259
+ */
42260
+ oContext: Context
42261
+ ): void;
42044
42262
  }
42045
42263
  }
42046
42264
 
@@ -42163,7 +42381,7 @@ declare module "sap/ui/model/Model" {
42163
42381
  */
42164
42382
  oData: object,
42165
42383
  /**
42166
- * The function to be called, when the event occurs
42384
+ * The function to be called when the event occurs
42167
42385
  */
42168
42386
  fnFunction: Function,
42169
42387
  /**
@@ -42179,7 +42397,7 @@ declare module "sap/ui/model/Model" {
42179
42397
  */
42180
42398
  attachParseError(
42181
42399
  /**
42182
- * The function to be called, when the event occurs
42400
+ * The function to be called when the event occurs
42183
42401
  */
42184
42402
  fnFunction: Function,
42185
42403
  /**
@@ -42201,7 +42419,7 @@ declare module "sap/ui/model/Model" {
42201
42419
  */
42202
42420
  oData: object,
42203
42421
  /**
42204
- * The function to be called, when the event occurs
42422
+ * The function to be called when the event occurs
42205
42423
  */
42206
42424
  fnFunction: Function,
42207
42425
  /**
@@ -42218,7 +42436,7 @@ declare module "sap/ui/model/Model" {
42218
42436
  */
42219
42437
  attachPropertyChange(
42220
42438
  /**
42221
- * The function to be called, when the event occurs
42439
+ * The function to be called when the event occurs
42222
42440
  */
42223
42441
  fnFunction: Function,
42224
42442
  /**
@@ -42240,7 +42458,7 @@ declare module "sap/ui/model/Model" {
42240
42458
  */
42241
42459
  oData: object,
42242
42460
  /**
42243
- * The function to be called, when the event occurs
42461
+ * The function to be called when the event occurs
42244
42462
  */
42245
42463
  fnFunction: Function,
42246
42464
  /**
@@ -42257,7 +42475,7 @@ declare module "sap/ui/model/Model" {
42257
42475
  */
42258
42476
  attachRequestCompleted(
42259
42477
  /**
42260
- * The function to be called, when the event occurs
42478
+ * The function to be called when the event occurs
42261
42479
  */
42262
42480
  fnFunction: Function,
42263
42481
  /**
@@ -42278,7 +42496,7 @@ declare module "sap/ui/model/Model" {
42278
42496
  */
42279
42497
  oData: object,
42280
42498
  /**
42281
- * The function to be called, when the event occurs
42499
+ * The function to be called when the event occurs
42282
42500
  */
42283
42501
  fnFunction: Function,
42284
42502
  /**
@@ -42294,7 +42512,7 @@ declare module "sap/ui/model/Model" {
42294
42512
  */
42295
42513
  attachRequestFailed(
42296
42514
  /**
42297
- * The function to be called, when the event occurs
42515
+ * The function to be called when the event occurs
42298
42516
  */
42299
42517
  fnFunction: Function,
42300
42518
  /**
@@ -42315,7 +42533,7 @@ declare module "sap/ui/model/Model" {
42315
42533
  */
42316
42534
  oData: object,
42317
42535
  /**
42318
- * The function to be called, when the event occurs
42536
+ * The function to be called when the event occurs
42319
42537
  */
42320
42538
  fnFunction: Function,
42321
42539
  /**
@@ -42331,7 +42549,7 @@ declare module "sap/ui/model/Model" {
42331
42549
  */
42332
42550
  attachRequestSent(
42333
42551
  /**
42334
- * The function to be called, when the event occurs
42552
+ * The function to be called when the event occurs
42335
42553
  */
42336
42554
  fnFunction: Function,
42337
42555
  /**
@@ -42344,111 +42562,103 @@ declare module "sap/ui/model/Model" {
42344
42562
  */
42345
42563
  bindContext(
42346
42564
  /**
42347
- * the path pointing to the property that should be bound
42565
+ * The path pointing to the property that should be bound
42348
42566
  */
42349
42567
  sPath: string,
42350
42568
  /**
42351
- * the context object for this databinding (optional)
42569
+ * The context object for this databinding
42352
42570
  */
42353
42571
  oContext?: Context,
42354
42572
  /**
42355
- * additional model specific parameters (optional)
42573
+ * Additional model-specific parameters
42356
42574
  */
42357
42575
  mParameters?: object,
42358
42576
  /**
42359
- * event handlers can be passed to the binding ({change:myHandler})
42577
+ * Event handlers can be passed to the binding ({change:myHandler})
42360
42578
  */
42361
42579
  oEvents?: object
42362
42580
  ): ContextBinding;
42363
- /**
42364
- * Implement in inheriting classes.
42365
- */
42581
+
42366
42582
  bindList(
42367
42583
  /**
42368
- * the path pointing to the list / array that should be bound
42584
+ * The path pointing to the list / array that should be bound
42369
42585
  */
42370
42586
  sPath: string,
42371
42587
  /**
42372
- * the context object for this databinding (optional)
42588
+ * The context object for this databinding
42373
42589
  */
42374
42590
  oContext?: Context,
42375
42591
  /**
42376
- * initial sort order (can be either a sorter or an array of sorters) (optional)
42592
+ * Initial sort order (can be either a sorter or an array of sorters)
42377
42593
  */
42378
42594
  aSorters?: Sorter | Sorter[],
42379
42595
  /**
42380
- * predefined filter/s (can be either a filter or an array of filters) (optional)
42596
+ * Predefined filter/s (can be either a filter or an array of filters)
42381
42597
  */
42382
42598
  aFilters?: Filter | Filter[],
42383
42599
  /**
42384
- * additional model specific parameters (optional)
42600
+ * Additional model-specific parameters
42385
42601
  */
42386
42602
  mParameters?: object
42387
42603
  ): ListBinding;
42388
- /**
42389
- * Implement in inheriting classes.
42390
- */
42604
+
42391
42605
  bindProperty(
42392
42606
  /**
42393
- * the path pointing to the property that should be bound
42607
+ * The path pointing to the property that should be bound
42394
42608
  */
42395
42609
  sPath: string,
42396
42610
  /**
42397
- * the context object for this databinding (optional)
42611
+ * The context object for this databinding
42398
42612
  */
42399
42613
  oContext?: Context,
42400
42614
  /**
42401
- * additional model specific parameters (optional)
42615
+ * Additional model-specific parameters
42402
42616
  */
42403
42617
  mParameters?: object
42404
42618
  ): PropertyBinding;
42405
- /**
42406
- * Implement in inheriting classes.
42407
- */
42619
+
42408
42620
  bindTree(
42409
42621
  /**
42410
- * the path pointing to the tree / array that should be bound
42622
+ * The path pointing to the tree / array that should be bound
42411
42623
  */
42412
42624
  sPath: string,
42413
42625
  /**
42414
- * the context object for this databinding (optional)
42626
+ * The context object for this databinding
42415
42627
  */
42416
42628
  oContext?: Context,
42417
42629
  /**
42418
- * predefined filter/s contained in an array (optional)
42630
+ * Predefined filter/s contained in an array
42419
42631
  */
42420
42632
  aFilters?: Filter[],
42421
42633
  /**
42422
- * additional model specific parameters (optional)
42634
+ * Additional model specific parameters
42423
42635
  */
42424
42636
  mParameters?: object,
42425
42637
  /**
42426
- * predefined sap.ui.model.sorter/s contained in an array (optional)
42638
+ * Predefined sap.ui.model.sorter/s contained in an array
42427
42639
  */
42428
42640
  aSorters?: Sorter[]
42429
42641
  ): TreeBinding;
42430
- /**
42431
- * Implement in inheriting classes.
42432
- */
42642
+
42433
42643
  createBindingContext(
42434
42644
  /**
42435
- * the path to create the new context from
42645
+ * The path to create the new context from
42436
42646
  */
42437
42647
  sPath: string,
42438
42648
  /**
42439
- * the context which should be used to create the new binding context
42649
+ * The context which should be used to create the new binding context
42440
42650
  */
42441
42651
  oContext?: Context,
42442
42652
  /**
42443
- * the parameters used to create the new binding context
42653
+ * The parameters used to create the new binding context
42444
42654
  */
42445
42655
  mParameters?: object,
42446
42656
  /**
42447
- * the function which should be called after the binding context has been created
42657
+ * The function which should be called after the binding context has been created
42448
42658
  */
42449
42659
  fnCallBack?: Function,
42450
42660
  /**
42451
- * force reload even if data is already available. For server side models this should refetch the data from
42661
+ * Force reload even if data is already available; for server-side models this should refetch the data from
42452
42662
  * the server
42453
42663
  */
42454
42664
  bReload?: boolean
@@ -42456,18 +42666,16 @@ declare module "sap/ui/model/Model" {
42456
42666
  /**
42457
42667
  * Destroys the model and clears the model data.
42458
42668
  *
42459
- * A model implementation may override this function and perform model specific cleanup tasks e.g. abort
42669
+ * A model implementation may override this function and perform model-specific cleanup tasks e.g. abort
42460
42670
  * requests, prevent new requests, etc.
42461
42671
  * See:
42462
42672
  * sap.ui.base.Object.prototype.destroy
42463
42673
  */
42464
42674
  destroy(): void;
42465
- /**
42466
- * Implement in inheriting classes.
42467
- */
42675
+
42468
42676
  destroyBindingContext(
42469
42677
  /**
42470
- * to destroy
42678
+ * The context to destroy
42471
42679
  */
42472
42680
  oContext: Context
42473
42681
  ): void;
@@ -42478,7 +42686,7 @@ declare module "sap/ui/model/Model" {
42478
42686
  */
42479
42687
  detachParseError(
42480
42688
  /**
42481
- * The function to be called, when the event occurs
42689
+ * The function to be called when the event occurs
42482
42690
  */
42483
42691
  fnFunction: Function,
42484
42692
  /**
@@ -42494,7 +42702,7 @@ declare module "sap/ui/model/Model" {
42494
42702
  */
42495
42703
  detachPropertyChange(
42496
42704
  /**
42497
- * The function to be called, when the event occurs
42705
+ * The function to be called when the event occurs
42498
42706
  */
42499
42707
  fnFunction: Function,
42500
42708
  /**
@@ -42526,7 +42734,7 @@ declare module "sap/ui/model/Model" {
42526
42734
  */
42527
42735
  detachRequestFailed(
42528
42736
  /**
42529
- * The function to be called, when the event occurs
42737
+ * The function to be called when the event occurs
42530
42738
  */
42531
42739
  fnFunction: Function,
42532
42740
  /**
@@ -42554,23 +42762,10 @@ declare module "sap/ui/model/Model" {
42554
42762
  */
42555
42763
  fireParseError(
42556
42764
  /**
42557
- * Parameters to pass along with the event
42765
+ * Parameters to pass along with the event; May contain the following parameters: `errorCode`, `url`, `reason`,
42766
+ * `srcText`, `line`, `linePos`, `filePos`
42558
42767
  */
42559
- oParameters?: {
42560
- errorCode?: int;
42561
-
42562
- url?: string;
42563
-
42564
- reason?: string;
42565
-
42566
- srcText?: string;
42567
-
42568
- line?: int;
42569
-
42570
- linepos?: int;
42571
-
42572
- filepos?: int;
42573
- }
42768
+ oParameters?: object
42574
42769
  ): this;
42575
42770
  /**
42576
42771
  * Fires event {@link #event:propertyChange propertyChange} to attached listeners.
@@ -42589,11 +42784,11 @@ declare module "sap/ui/model/Model" {
42589
42784
  */
42590
42785
  path?: string;
42591
42786
  /**
42592
- * the context of the property
42787
+ * The context of the property
42593
42788
  */
42594
42789
  context?: object;
42595
42790
  /**
42596
- * the value of the property
42791
+ * The value of the property
42597
42792
  */
42598
42793
  value?: object;
42599
42794
  }
@@ -42607,7 +42802,7 @@ declare module "sap/ui/model/Model" {
42607
42802
  */
42608
42803
  oParameters?: {
42609
42804
  /**
42610
- * The url which was sent to the backend.
42805
+ * The url which was sent to the back end.
42611
42806
  */
42612
42807
  url?: string;
42613
42808
  /**
@@ -42649,7 +42844,7 @@ declare module "sap/ui/model/Model" {
42649
42844
  */
42650
42845
  statusText?: string;
42651
42846
  /**
42652
- * Response that has been received for the request ,as a text string
42847
+ * Response that has been received for the request, as a text string
42653
42848
  */
42654
42849
  responseText?: string;
42655
42850
  }
@@ -42663,7 +42858,7 @@ declare module "sap/ui/model/Model" {
42663
42858
  */
42664
42859
  oParameters?: {
42665
42860
  /**
42666
- * The url which is sent to the backend.
42861
+ * The url which is sent to the back end.
42667
42862
  */
42668
42863
  url?: string;
42669
42864
  /**
@@ -42675,7 +42870,7 @@ declare module "sap/ui/model/Model" {
42675
42870
  */
42676
42871
  async?: boolean;
42677
42872
  /**
42678
- * additional information for the request (if available) **deprecated**
42873
+ * Additional information for the request (if available) **deprecated**
42679
42874
  */
42680
42875
  info?: string;
42681
42876
  /**
@@ -42720,9 +42915,7 @@ declare module "sap/ui/model/Model" {
42720
42915
  * Returns the meta model associated with this model if it is available for the concrete model type.
42721
42916
  */
42722
42917
  getMetaModel(): MetaModel;
42723
- /**
42724
- * Implement in inheriting classes.
42725
- */
42918
+
42726
42919
  getObject(
42727
42920
  /**
42728
42921
  * Path to where to read the object
@@ -42733,7 +42926,7 @@ declare module "sap/ui/model/Model" {
42733
42926
  */
42734
42927
  oContext?: Context,
42735
42928
  /**
42736
- * Additional model specific parameters
42929
+ * Additional model-specific parameters
42737
42930
  */
42738
42931
  mParameters?: object
42739
42932
  ): any;
@@ -42752,16 +42945,14 @@ declare module "sap/ui/model/Model" {
42752
42945
  */
42753
42946
  oContext?: Context
42754
42947
  ): any;
42755
- /**
42756
- * Implement in inheriting classes.
42757
- */
42948
+
42758
42949
  getProperty(
42759
42950
  /**
42760
- * the path to where to read the attribute value
42951
+ * The path to where to read the attribute value
42761
42952
  */
42762
42953
  sPath: string,
42763
42954
  /**
42764
- * the context with which the path should be resolved
42955
+ * The context with which the path should be resolved
42765
42956
  */
42766
42957
  oContext?: Context
42767
42958
  ): any;
@@ -42864,7 +43055,7 @@ declare module "sap/ui/model/odata/AnnotationHelper" {
42864
43055
  * views, e.g. `<template:with path="meta>Value" helper="sap.ui.model.odata.AnnotationHelper.resolvePath"
42865
43056
  * var="target">`.
42866
43057
  *
42867
- * Since 1.31.0, you DO NOT need to {@link jQuery.sap.require} this module before use.
43058
+ * Since 1.31.0, you DO NOT need to {@link sap.ui.require} this module before use.
42868
43059
  */
42869
43060
  interface AnnotationHelper {
42870
43061
  /**
@@ -42898,7 +43089,7 @@ declare module "sap/ui/model/odata/AnnotationHelper" {
42898
43089
  * ```javascript
42899
43090
  *
42900
43091
  * function myRootFormatter(oValue1, oValue2, sFullName, sGreeting, iAnswer) {
42901
- * return ...; //TODO compute something useful from the given values
43092
+ * return ...;
42902
43093
  * }
42903
43094
  *
42904
43095
  * oSupplierContext = oMetaModel.getMetaContext("/ProductSet('HT-1021')/ToSupplier");
@@ -43698,7 +43889,7 @@ declare module "sap/ui/model/odata/ODataListBinding" {
43698
43889
  /**
43699
43890
  * Filters the list.
43700
43891
  *
43701
- * When using sap.ui.model.Filter the filters are first grouped according to their binding path. All filters
43892
+ * When using `sap.ui.model.Filter` the filters are first grouped according to their binding path. All filters
43702
43893
  * belonging to a group are combined with OR and after that the results of all groups are combined with
43703
43894
  * AND. Usually this means, all filters applied to a single table column are combined with OR, while filters
43704
43895
  * on different table columns are combined with AND. Please note that a custom filter function is not supported.
@@ -43711,21 +43902,28 @@ declare module "sap/ui/model/odata/ODataListBinding" {
43711
43902
  /**
43712
43903
  * Type of the filter which should be adjusted, if it is not given, the standard behaviour applies
43713
43904
  */
43714
- sFilterType: FilterType | keyof typeof FilterType
43905
+ sFilterType: FilterType | keyof typeof FilterType,
43906
+ /**
43907
+ * Whether to return `true` or `false`, instead of `this`, depending on whether the filtering has been done
43908
+ */
43909
+ bReturnSuccess?: boolean
43715
43910
  ): this;
43716
43911
  /**
43717
43912
  * Return contexts for the list
43718
43913
  */
43719
43914
  getContexts(
43720
43915
  /**
43721
- * the start index of the requested contexts
43916
+ * The start index of the requested contexts
43722
43917
  */
43723
43918
  iStartIndex?: int,
43724
43919
  /**
43725
- * the requested amount of contexts
43920
+ * The requested amount of contexts
43726
43921
  */
43727
43922
  iLength?: int,
43728
-
43923
+ /**
43924
+ * The maximum number of contexts to read before and after the given range; with this, controls can prefetch
43925
+ * data that is likely to be needed soon, e.g. when scrolling down in a table
43926
+ */
43729
43927
  iThreshold?: int
43730
43928
  ): Context[];
43731
43929
  /**
@@ -43754,16 +43952,28 @@ declare module "sap/ui/model/odata/ODataListBinding" {
43754
43952
  /**
43755
43953
  * Update the bound control even if no data has been changed
43756
43954
  */
43757
- bForceUpdate?: boolean
43955
+ bForceUpdate?: boolean,
43956
+ /**
43957
+ * A map of changed entities
43958
+ */
43959
+ mChangedEntities?: object,
43960
+ /**
43961
+ * A map of entity types
43962
+ */
43963
+ mEntityTypes?: object
43758
43964
  ): void;
43759
43965
  /**
43760
43966
  * Sorts the list.
43761
43967
  */
43762
43968
  sort(
43763
43969
  /**
43764
- * the Sorter or an array of sorter objects object which define the sort order
43970
+ * The Sorter or an array of sorter objects which define the sort order
43765
43971
  */
43766
- aSorters: Sorter | any[]
43972
+ aSorters: Sorter | Sorter[],
43973
+ /**
43974
+ * Whether to return `true` or `false`, instead of `this`, depending on whether the sorting has been done
43975
+ */
43976
+ bReturnSuccess?: boolean
43767
43977
  ): this;
43768
43978
  }
43769
43979
  }
@@ -44133,6 +44343,8 @@ declare module "sap/ui/model/odata/ODataMetaModel" {
44133
44343
  * V4 annotations from the existing {@link sap.ui.model.odata.ODataAnnotations} directly into the corresponding
44134
44344
  * model element.
44135
44345
  *
44346
+ * This model is not prepared to be inherited from.
44347
+ *
44136
44348
  * Also, annotations from the "http://www.sap.com/Protocols/SAPData" namespace are lifted up from the `extensions`
44137
44349
  * array and transformed from objects into simple properties with an "sap:" prefix for their name. Note
44138
44350
  * that this happens in addition, thus the following example shows both representations. This way, such
@@ -44658,19 +44870,18 @@ declare module "sap/ui/model/odata/ODataModel" {
44658
44870
  bSuppressEvents?: boolean
44659
44871
  ): Promise<any>;
44660
44872
  /**
44661
- * Appends the change batch operations to the end of the batch stack. Only PUT, POST or DELETE batch operations
44662
- * should be included in the specified array. The operations in the array will be included in a single changeset.
44663
- * To embed change operations in different change sets call this method with the corresponding change operations
44664
- * again. If an illegal batch operation is added to the change set nothing will be performed and false will
44665
- * be returned.
44873
+ * Appends the change batch operations to the end of the batch stack. Only `PUTPOST` or `DELETE`
44874
+ * batch operations should be included in the specified array. The operations in the array will be included
44875
+ * in a single changeset. To embed change operations in different change sets call this method with the
44876
+ * corresponding change operations again. If an illegal batch operation is added to the change set nothing
44877
+ * will be performed and false will be returned.
44666
44878
  */
44667
44879
  addBatchChangeOperations(
44668
44880
  /**
44669
- * an array of change batch operations created via `createBatchOperation` and `sMethod` = POST, PUT, MERGE
44670
- * or DELETE
44881
+ * An array of change batch operations created via `createBatchOperation` with parameter `sMethod = "POST"/"PUT"/"MERGE"/"DELETE"`
44671
44882
  */
44672
44883
  aChangeOperations: any[]
44673
- ): void;
44884
+ ): false | undefined;
44674
44885
  /**
44675
44886
  * Appends the read batch operations to the end of the batch stack. Only GET batch operations should be
44676
44887
  * included in the specified array. If an illegal batch operation is added to the batch nothing will be
@@ -44678,10 +44889,10 @@ declare module "sap/ui/model/odata/ODataModel" {
44678
44889
  */
44679
44890
  addBatchReadOperations(
44680
44891
  /**
44681
- * an array of read batch operations created via `createBatchOperation` and `sMethod` = GET
44892
+ * An array of read batch operations created via `createBatchOperation` with `sMethod = "GET"`
44682
44893
  */
44683
44894
  aReadOperations: any[]
44684
- ): void;
44895
+ ): false | undefined;
44685
44896
  /**
44686
44897
  * Attaches event handler `fnFunction` to the {@link #event:annotationsFailed annotationsFailed} event of
44687
44898
  * this `sap.ui.model.odata.ODataModel`.
@@ -44957,29 +45168,29 @@ declare module "sap/ui/model/odata/ODataModel" {
44957
45168
  */
44958
45169
  createBatchOperation(
44959
45170
  /**
44960
- * A string containing the path to the collection or entry where the batch operation should be performed.
44961
- * The path is concatenated to the sServiceUrl which was specified in the model constructor.
45171
+ * A string containing the path to the collection or entry where the batch operation should be performed;
45172
+ * the path is concatenated to the `sServiceUrl` which was specified in the model constructor
44962
45173
  */
44963
45174
  sPath: string,
44964
45175
  /**
44965
- * for the batch operation. Possible values are GET, PUT, MERGE, POST, DELETE
45176
+ * For the batch operation; possible values are `GET`, `PUT`, `MERGE`, `POST` or `DELETE`
44966
45177
  */
44967
45178
  sMethod: string,
44968
45179
  /**
44969
- * optional data payload which should be created, updated, deleted in a change batch operation.
45180
+ * Optional data payload which should be created, updated, deleted in a change batch operation
44970
45181
  */
44971
45182
  oData?: object,
44972
45183
  /**
44973
- * optional parameter for additional information introduced in SAPUI5 1.9.1,
45184
+ * Optional parameter for additional information introduced in SAPUI5 1.9.1
44974
45185
  */
44975
45186
  oParameters?: {
44976
45187
  /**
44977
- * an ETag which can be used for concurrency control. If it is specified, it will be used in an If-Match-Header
45188
+ * An ETag which can be used for concurrency control. If it is specified, it will be used in an If-Match-Header
44978
45189
  * in the request to the server for this entry.
44979
45190
  */
44980
45191
  sETag?: string;
44981
45192
  }
44982
- ): void;
45193
+ ): object;
44983
45194
  /**
44984
45195
  * Creates a new entry object which is described by the metadata of the entity type of the specified sPath
44985
45196
  * Name. A context object is returned which can be used to bind against the newly created object.
@@ -45010,7 +45221,7 @@ declare module "sap/ui/model/odata/ODataModel" {
45010
45221
  vProperties: any[] | object
45011
45222
  ): Context;
45012
45223
  /**
45013
- * Creates the key from the given collection name and property map
45224
+ * Creates the key from the given collection name and property map.
45014
45225
  */
45015
45226
  createKey(
45016
45227
  /**
@@ -45020,12 +45231,12 @@ declare module "sap/ui/model/odata/ODataModel" {
45020
45231
  /**
45021
45232
  * The object containing at least all the key properties of the entity type
45022
45233
  */
45023
- oKeyParameters: object,
45234
+ oKeyProperties: object,
45024
45235
  /**
45025
45236
  * Whether the URI decoding should be applied on the key
45026
45237
  */
45027
45238
  bDecode: boolean
45028
- ): void;
45239
+ ): string;
45029
45240
  /**
45030
45241
  * Deletes a created entry from the request queue and the model.
45031
45242
  */
@@ -45201,19 +45412,19 @@ declare module "sap/ui/model/odata/ODataModel" {
45201
45412
  */
45202
45413
  getData(
45203
45414
  /**
45204
- * A string containing the path to the data object that should be returned.
45415
+ * A string containing the path to the data object that should be returned
45205
45416
  */
45206
45417
  sPath: string,
45207
45418
  /**
45208
- * the optional context which is used with the sPath to retrieve the requested data.
45419
+ * The optional context which is used with the sPath to retrieve the requested data
45209
45420
  */
45210
45421
  oContext?: object,
45211
45422
  /**
45212
- * This parameter should be set when a URI or custom parameter with a $expand System Query Option was used
45213
- * to retrieve associated entries embedded/inline. If true then the getProperty function returns a desired
45214
- * property value/entry and includes the associated expand entries (if any). If false the associated/expanded
45215
- * entry properties are removed and not included in the desired entry as properties at all. This is useful
45216
- * for performing updates on the base entry only. Note: A copy and not a reference of the entry will be
45423
+ * This parameter should be set when a URI or custom parameter with a `$expand` System Query Option was
45424
+ * used to retrieve associated entries embedded/inline; if true then the `getProperty` function returns
45425
+ * a desired property value/entry and includes the associated expand entries (if any); if false the associated/expanded
45426
+ * entry properties are removed and not included in the desired entry as properties at all; this is useful
45427
+ * for performing updates on the base entry only; note: A copy and not a reference of the entry will be
45217
45428
  * returned.
45218
45429
  */
45219
45430
  bIncludeExpandEntries?: boolean
@@ -45221,7 +45432,7 @@ declare module "sap/ui/model/odata/ODataModel" {
45221
45432
  /**
45222
45433
  * @SINCE 1.20
45223
45434
  *
45224
- * Returns the default count mode for retrieving the count of collections
45435
+ * Returns the default count mode for retrieving the count of collections.
45225
45436
  */
45226
45437
  getDefaultCountMode(): CountMode | keyof typeof CountMode;
45227
45438
  /**
@@ -45229,7 +45440,7 @@ declare module "sap/ui/model/odata/ODataModel" {
45229
45440
  */
45230
45441
  getHeaders(): object;
45231
45442
  /**
45232
- * Returns the key part from the entry URI or the given context or object
45443
+ * Returns the key part from the entry URI or the given context or object.
45233
45444
  */
45234
45445
  getKey(
45235
45446
  /**
@@ -45240,7 +45451,7 @@ declare module "sap/ui/model/odata/ODataModel" {
45240
45451
  * Whether the URI decoding should be applied on the key
45241
45452
  */
45242
45453
  bDecode: boolean
45243
- ): void;
45454
+ ): string;
45244
45455
  /**
45245
45456
  * Returns an instance of an OData meta model which offers a unified access to both OData V2 metadata and
45246
45457
  * V4 annotations. It uses the existing {@link sap.ui.model.odata.ODataMetadata} as a foundation and merges
@@ -45253,47 +45464,47 @@ declare module "sap/ui/model/odata/ODataModel" {
45253
45464
  getMetaModel(): ODataMetaModel;
45254
45465
  /**
45255
45466
  * Returns the value for the property with the given `sPath`. If the path points to a navigation property
45256
- * which has been loaded via $expand then the `bIncludeExpandEntries` parameter determines if the navigation
45467
+ * which has been loaded via `$expand` then the `bIncludeExpandEntries` parameter determines if the navigation
45257
45468
  * property should be included in the returned value or not. Please note that this currently works for 1..1
45258
45469
  * navigation properties only.
45259
45470
  */
45260
45471
  getProperty(
45261
45472
  /**
45262
- * the path/name of the property
45473
+ * The path/name of the property
45263
45474
  */
45264
45475
  sPath: string,
45265
45476
  /**
45266
- * the context if available to access the property value
45477
+ * The context if available to access the property value
45267
45478
  */
45268
45479
  oContext?: object,
45269
45480
  /**
45270
- * This parameter should be set when a URI or custom parameter with a $expand System Query Option was used
45271
- * to retrieve associated entries embedded/inline. If true then the getProperty function returns a desired
45272
- * property value/entry and includes the associated expand entries (if any). If false the associated/expanded
45481
+ * This parameter should be set when a URI or custom parameter with a `$expand` System Query Option was
45482
+ * used to retrieve associated entries embedded/inline. If true then the getProperty function returns a
45483
+ * desired property value/entry and includes the associated expand entries (if any). If false the associated/expanded
45273
45484
  * entry properties are removed and not included in the desired entry as properties at all. This is useful
45274
45485
  * for performing updates on the base entry only. Note: A copy and not a reference of the entry will be
45275
45486
  * returned.
45276
45487
  */
45277
45488
  bIncludeExpandEntries?: boolean
45278
- ): any;
45489
+ ): object;
45279
45490
  /**
45280
45491
  * Returns the current security token. If the token has not been requested from the server it will be requested
45281
45492
  * first.
45282
45493
  */
45283
45494
  getSecurityToken(): string;
45284
45495
  /**
45285
- * Return the annotation object. Please note that when using the model with bLoadMetadataAsync = true then
45286
- * this function might return undefined because the metadata has not been loaded yet. In this case attach
45287
- * to the `annotationsLoaded` event to get notified when the annotations are available and then call this
45288
- * function.
45496
+ * Return the annotation object. Please note that when using the model with `bLoadMetadataAsync = true`
45497
+ * then this function might return undefined because the metadata has not been loaded yet. In this case
45498
+ * attach to the `annotationsLoaded` event to get notified when the annotations are available and then call
45499
+ * this function.
45289
45500
  */
45290
- getServiceAnnotations(): Object;
45501
+ getServiceAnnotations(): Object | undefined;
45291
45502
  /**
45292
- * Return the metadata object. Please note that when using the model with bLoadMetadataAsync = true then
45293
- * this function might return undefined because the metadata has not been loaded yet. In this case attach
45294
- * to the `metadataLoaded` event to get notified when the metadata is available and then call this function.
45503
+ * Return the metadata object. Please note that when using the model with `bLoadMetadataAsync = true` then
45504
+ * this function might return `undefinedmetadataLoaded` event to get notified when the metadata is available and then call
45505
+ * this function.
45295
45506
  */
45296
- getServiceMetadata(): Object;
45507
+ getServiceMetadata(): Object | undefined;
45297
45508
  /**
45298
45509
  * Checks if there exist pending changes in the model created by the setProperty method.
45299
45510
  */
@@ -45301,7 +45512,7 @@ declare module "sap/ui/model/odata/ODataModel" {
45301
45512
  /**
45302
45513
  * @deprecated (since 1.20) - please use {@link #getDefaultCountMode} instead.
45303
45514
  *
45304
- * Returns whether this model supports the $count on its collections
45515
+ * Returns whether this model supports `$count` on its collections.
45305
45516
  */
45306
45517
  isCountSupported(): boolean;
45307
45518
  /**
@@ -45454,9 +45665,14 @@ declare module "sap/ui/model/odata/ODataModel" {
45454
45665
  /**
45455
45666
  * @deprecated (since 1.20) - please use {@link #setDefaultCountMode} instead.
45456
45667
  *
45457
- * Sets whether this OData service supports $count on its collections.
45668
+ * Sets whether this OData service supports `$count` on its collections.
45458
45669
  */
45459
- setCountSupported(bCountSupported: boolean): void;
45670
+ setCountSupported(
45671
+ /**
45672
+ * Whether this OData service supports `$count` on its collections
45673
+ */
45674
+ bCountSupported: boolean
45675
+ ): void;
45460
45676
  /**
45461
45677
  * @SINCE 1.20
45462
45678
  *
@@ -45498,33 +45714,33 @@ declare module "sap/ui/model/odata/ODataModel" {
45498
45714
  ): void;
45499
45715
  /**
45500
45716
  * Sets a new value for the given property `sPropertyName` in the model without triggering a server request.
45501
- * This can be done by the submitChanges method.
45717
+ * This can be done by the `submitChanges` method.
45502
45718
  *
45503
- * Note: Only one entry of one collection can be updated at once. Otherwise a fireRejectChange event is
45719
+ * Note: Only one entry of one collection can be updated at once. Otherwise a `fireRejectChange` event is
45504
45720
  * fired.
45505
45721
  *
45506
- * Before updating a different entry the existing changes of the current entry have to be submitted or resetted
45507
- * by the corresponding methods: submitChanges, resetChanges.
45722
+ * Before updating a different entry the existing changes of the current entry have to be submitted or reset
45723
+ * by the corresponding methods: `submitChanges`, `resetChanges`.
45508
45724
  *
45509
- * IMPORTANT: All pending changes are resetted in the model if the application triggeres any kind of refresh
45725
+ * IMPORTANT: All pending changes are reset in the model if the application triggers any kind of refresh
45510
45726
  * on that entry. Make sure to submit the pending changes first. To determine if there are any pending changes
45511
- * call the hasPendingChanges method.
45727
+ * call the `hasPendingChanges` method.
45512
45728
  */
45513
45729
  setProperty(
45514
45730
  /**
45515
- * path of the property to set
45731
+ * Path of the property to set
45516
45732
  */
45517
45733
  sPath: string,
45518
45734
  /**
45519
- * value to set the property to
45735
+ * Value to set the property to
45520
45736
  */
45521
45737
  oValue: any,
45522
45738
  /**
45523
- * the context which will be used to set the property
45739
+ * The context which will be used to set the property
45524
45740
  */
45525
45741
  oContext?: object,
45526
45742
  /**
45527
- * whether to update other bindings dependent on this property asynchronously
45743
+ * Whether to update other bindings dependent on this property asynchronously
45528
45744
  */
45529
45745
  bAsyncUpdate?: boolean
45530
45746
  ): boolean;
@@ -45533,7 +45749,12 @@ declare module "sap/ui/model/odata/ODataModel" {
45533
45749
  *
45534
45750
  * Enable/Disable automatic updates of all Bindings after change operations
45535
45751
  */
45536
- setRefreshAfterChange(bRefreshAfterChange: boolean): void;
45752
+ setRefreshAfterChange(
45753
+ /**
45754
+ * Whether automatic updates should be enabled
45755
+ */
45756
+ bRefreshAfterChange: boolean
45757
+ ): void;
45537
45758
  /**
45538
45759
  * Enable/Disable XCSRF-Token handling
45539
45760
  */
@@ -45775,15 +45996,15 @@ declare module "sap/ui/model/odata/ODataUtils" {
45775
45996
  */
45776
45997
  formatValue(
45777
45998
  /**
45778
- * the value to format
45999
+ * The value to format
45779
46000
  */
45780
46001
  vValue: any,
45781
46002
  /**
45782
- * the EDM type (e.g. Edm.Decimal)
46003
+ * The EDM type (e.g. Edm.Decimal)
45783
46004
  */
45784
46005
  sType: string,
45785
46006
  /**
45786
- * Wether strings gets compared case sensitive or not
46007
+ * Whether strings gets compared case sensitive or not
45787
46008
  */
45788
46009
  bCaseSensitive: boolean
45789
46010
  ): string;
@@ -48545,6 +48766,8 @@ declare module "sap/ui/model/odata/v2/Context" {
48545
48766
  * A context for the OData V2 model cannot be created at will, it has to be retrieved via:
48546
48767
  * - an OData binding
48547
48768
  * - a view element
48769
+ * - {@link sap.ui.model.odata.v2.ODataListBinding#create}
48770
+ * - {@link sap.ui.model.odata.v2.ODataModel#callFunction}
48548
48771
  * - {@link sap.ui.model.odata.v2.ODataModel#createBindingContext}
48549
48772
  * - {@link sap.ui.model.odata.v2.ODataModel#createEntry}
48550
48773
  */
@@ -48576,12 +48799,30 @@ declare module "sap/ui/model/odata/v2/Context" {
48576
48799
  * Returns a metadata object for class sap.ui.model.odata.v2.Context.
48577
48800
  */
48578
48801
  static getMetadata(): Metadata;
48802
+ /**
48803
+ * @SINCE 1.96.0
48804
+ *
48805
+ * Returns a promise on the creation state of this context if it has been created via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
48806
+ * or {@link sap.ui.model.odata.v2.ODataListBinding#create}; otherwise returns `undefined`.
48807
+ *
48808
+ * As long as the promise is not yet resolved or rejected, the entity represented by this context is transient.
48809
+ *
48810
+ * Once the promise is resolved, the entity for this context is stored in the back end and {@link #getPath}
48811
+ * returns a path including the key predicate of the new entity.
48812
+ *
48813
+ * If the context has been created via {@link sap.ui.model.odata.v2.ODataListBinding#create} and the entity
48814
+ * for this context has been stored in the back end, {@link #created} returns `undefined` after the data
48815
+ * has been re-read from the back end and inserted at the right position based on the list binding's filters
48816
+ * and sorters. If the context has been created via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
48817
+ * and the entity for this context has been stored in the back end, {@link #created} returns `undefined`.
48818
+ */
48819
+ created(): Promise<any>;
48579
48820
  /**
48580
48821
  * @SINCE 1.94.0
48581
48822
  *
48582
- * For a context created using {@link sap.ui.model.odata.v2.ODataModel#createEntry}, the method returns
48583
- * `true` if the context is transient or `false` if the context is not transient. A transient context represents
48584
- * an entity created on the client which has not been persisted in the back end.
48823
+ * For a context created using {@link sap.ui.model.odata.v2.ODataModel#createEntry} or {@link sap.ui.model.odata.v2.ODataListBinding#create},
48824
+ * the method returns `true` if the context is transient or `false` if the context is not transient. A transient
48825
+ * context represents an entity created on the client which has not been persisted in the back end.
48585
48826
  */
48586
48827
  isTransient(): boolean;
48587
48828
  }
@@ -49302,6 +49543,14 @@ declare module "sap/ui/model/odata/v2/ODataListBinding" {
49302
49543
  * Defines the count mode of this binding; if not specified, the default count mode of the `oModel` is applied
49303
49544
  */
49304
49545
  countMode?: CountMode | keyof typeof CountMode;
49546
+ /**
49547
+ * A key used in combination with the resolved path of this binding to identify the entities created this
49548
+ * binding's {@link #create} method.
49549
+ *
49550
+ * **Note:** Different controls or control aggregation bindings to the same collection must have different
49551
+ * `createdEntitiesKey` values.
49552
+ */
49553
+ createdEntitiesKey?: string;
49305
49554
  /**
49306
49555
  * An optional map of custom query parameters. Custom parameters must not start with `$`
49307
49556
  */
@@ -49376,6 +49625,9 @@ declare module "sap/ui/model/odata/v2/ODataListBinding" {
49376
49625
  * with AND. Usually this means, all filters applied to a single table column are combined with OR, while
49377
49626
  * filters on different table columns are combined with AND. Please note that a custom filter function is
49378
49627
  * only supported with operation mode `sap.ui.model.odata.OperationMode.Client`.
49628
+ *
49629
+ * Entities that have been created via {@link #create} and saved in the back end are removed from the creation
49630
+ * rows area and inserted at the right position based on the current filters and sorters.
49379
49631
  */
49380
49632
  filter(
49381
49633
  /**
@@ -49437,6 +49689,9 @@ declare module "sap/ui/model/odata/v2/ODataListBinding" {
49437
49689
  * Refreshes the binding, check whether the model data has been changed and fire change event if this is
49438
49690
  * the case. For server side models this should refetch the data from the server. To update a control, even
49439
49691
  * if no data has been changed, e.g. to reset a control after failed validation, use the parameter `bForceUpdate`.
49692
+ *
49693
+ * Entities that have been created via {@link #create} and saved in the back end are removed from the creation
49694
+ * rows area and inserted at the right position based on the current filters and sorters.
49440
49695
  */
49441
49696
  refresh(
49442
49697
  /**
@@ -49468,6 +49723,9 @@ declare module "sap/ui/model/odata/v2/ODataListBinding" {
49468
49723
  ): Promise<Filter>;
49469
49724
  /**
49470
49725
  * Sorts the list.
49726
+ *
49727
+ * Entities that have been created via {@link #create} and saved in the back end are removed from the creation
49728
+ * rows area and inserted at the right position based on the current filters and sorters.
49471
49729
  */
49472
49730
  sort(
49473
49731
  /**
@@ -49525,6 +49783,8 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
49525
49783
  * Model implementation based on the OData protocol.
49526
49784
  *
49527
49785
  * See chapter {@link topic:6c47b2b39db9404582994070ec3d57a2 OData V2 Model} for a general introduction.
49786
+ *
49787
+ * This model is not prepared to be inherited from.
49528
49788
  */
49529
49789
  export default class ODataModel extends Model {
49530
49790
  /**
@@ -50048,6 +50308,14 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
50048
50308
  * Count mode for this binding; if not specified, the default count mode for this model is used
50049
50309
  */
50050
50310
  countMode?: CountMode | keyof typeof CountMode;
50311
+ /**
50312
+ * A key used in combination with the resolved path of the binding to identify the entities created via
50313
+ * the binding's {@link #create} method.
50314
+ *
50315
+ * **Note:** Different controls or control aggregation bindings to the same collection must have different
50316
+ * `createdEntitiesKey` values.
50317
+ */
50318
+ createdEntitiesKey?: string;
50051
50319
  /**
50052
50320
  * Operation mode for this binding; if not specified, the default operation mode of this model is used
50053
50321
  */
@@ -50483,13 +50751,17 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
50483
50751
  * Whether to reload data
50484
50752
  */
50485
50753
  bReload?: boolean
50486
- ): Context1;
50754
+ ): Context1 | undefined;
50487
50755
  /**
50488
50756
  * Creates a new entry object which is described by the metadata of the entity type of the specified `sPath`
50489
50757
  * Name. A context object is returned which can be used to bind against the newly created object.
50490
50758
  *
50491
50759
  * For each created entry a request is created and stored in a request queue. The request queue can be submitted
50492
- * by calling {@link #submitChanges}. To delete a created entry from the request queue call {@link #deleteCreatedEntry}.
50760
+ * by calling {@link #submitChanges}. As long as the context is transient (see {@link sap.ui.model.odata.v2.Context#isTransient}),
50761
+ * {@link sap.ui.model.odata.v2.ODataModel#resetChanges} with the `bDeleteCreatedEntities` parameter set
50762
+ * to `true` can be used to delete the created entity again.
50763
+ *
50764
+ * If the creation of the entity on the server failed, it is repeated automatically.
50493
50765
  *
50494
50766
  * The optional parameter `mParameters.properties` can be used as follows:
50495
50767
  * - `properties` could be an array containing the property names which should be included in the new
@@ -50500,7 +50772,7 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
50500
50772
  *
50501
50773
  * If there are no values specified, the properties will have `undefined` values.
50502
50774
  *
50503
- * Please note that deep creates (including data defined by navigation properties) are not supported.
50775
+ * The `properties` can be modified via property bindings relative to the returned context instance.
50504
50776
  *
50505
50777
  * The parameter `expand` is supported since 1.78.0. If this parameter is set, the given navigation properties
50506
50778
  * are expanded automatically with the same $batch request in which the POST request for the creation is
@@ -50519,6 +50791,14 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
50519
50791
  * handler is called with the data and the response of the POST request. The response object of the success
50520
50792
  * handler call and the response parameter of the corresponding `requestFailed` and `requestCompleted` events
50521
50793
  * have an additional property `expandAfterCreateFailed` set to `true`.
50794
+ *
50795
+ * Note: If a server requires a property in the request, you must supply this property in the initial data,
50796
+ * for example if the server requires a unit for an amount. This also applies if this property has a default
50797
+ * value.
50798
+ *
50799
+ * Note: A deep create (including data defined by navigation properties) is not supported. The dependent
50800
+ * entity has to be created using a second list binding, after this entity has been saved successfully in
50801
+ * the back-end system.
50522
50802
  */
50523
50803
  createEntry(
50524
50804
  /**
@@ -50604,7 +50884,12 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
50604
50884
  oKeyProperties: object
50605
50885
  ): string;
50606
50886
  /**
50887
+ * @deprecated - since 1.95.0; use {@link #resetChanges} instead
50888
+ *
50607
50889
  * Deletes a created entry from the request queue and from the model.
50890
+ *
50891
+ * **Note:** Controls are not updated. Use {@link #resetChanges} instead to update also the controls, for
50892
+ * example: `oModel.resetChanges([oContext.getPath()], undefined, true);`
50608
50893
  */
50609
50894
  deleteCreatedEntry(
50610
50895
  /**
@@ -51051,8 +51336,10 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
51051
51336
  * To get a copy of the entity without internal attributes, use `{select: "*"}` instead.
51052
51337
  *
51053
51338
  * **Note:** If `mParameters.select` is given and not all selected properties are available, this method
51054
- * returns `undefined` instead of incomplete data. If `mParameters.select` is not given, all properties
51055
- * available on the client are returned.
51339
+ * returns `undefined` instead of incomplete data.
51340
+ *
51341
+ * **Note:** If `mParameters.select` is not given, all properties and navigation properties available on
51342
+ * the client are returned.
51056
51343
  *
51057
51344
  * Example:
51058
51345
  * With `mParameters` given as `{select: "Products/ProductName, Products", expand:"Products"}` no properties
@@ -51148,11 +51435,11 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
51148
51435
  /**
51149
51436
  * Return the parsed XML metadata as a Javascript object.
51150
51437
  *
51151
- * Please note that the metadata is loaded asynchronously and this function might return undefined because
51438
+ * Please note that the metadata is loaded asynchronously and this function might return `undefined` because
51152
51439
  * the metadata has not been loaded yet. In this case attach to the `metadataLoaded` event to get notified
51153
51440
  * when the metadata is available and then call this function.
51154
51441
  */
51155
- getServiceMetadata(): Object;
51442
+ getServiceMetadata(): Object | undefined;
51156
51443
  /**
51157
51444
  * Checks if there exist pending changes in the model.
51158
51445
  *
@@ -51364,7 +51651,7 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
51364
51651
  *
51365
51652
  * Returns a new promise which can be resolved or rejected depending on the metadata loading state.
51366
51653
  */
51367
- refreshMetadata(): Promise<any>;
51654
+ refreshMetadata(): Promise<any> | undefined;
51368
51655
  /**
51369
51656
  * Refresh XSRF token by performing a GET request against the service root URL.
51370
51657
  */
@@ -51435,31 +51722,38 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
51435
51722
  */
51436
51723
  changeSetId?: string;
51437
51724
  /**
51438
- * Since 1.46; defines whether to update all bindings after submitting this change operation. See {@link
51439
- * #setRefreshAfterChange} If given, this overrules the model-wide `refreshAfterChange` flag for this operation
51725
+ * Since 1.46; defines whether to update all bindings after submitting this change operation, see {@link
51726
+ * #setRefreshAfterChange}. If given, this overrules the model-wide `refreshAfterChange` flag for this operation
51440
51727
  * only.
51441
51728
  */
51442
51729
  refreshAfterChange?: boolean;
51443
51730
  }
51444
51731
  ): object;
51445
51732
  /**
51446
- * Resets changes that have been collected.
51733
+ * Resets pending changes and aborts corresponding requests.
51447
51734
  *
51448
- * By default, only client data changes triggered through: {@link #createEntry} {@link #setProperty} are
51449
- * taken into account.
51735
+ * By default, only changes triggered through {@link #createEntry} or {@link #setProperty} are taken into
51736
+ * account. If `bAll` is set, also deferred requests triggered through {@link #create}, {@link #update}
51737
+ * or {@link #remove} are taken into account.
51450
51738
  *
51451
- * If `bAll` is set to `true`, also deferred requests triggered through: {@link #create} {@link #update}
51452
- * {@link #remove} are taken into account.
51739
+ * If `bDeleteCreatedEntities` is set, the entity is completely removed, provided it has been created
51740
+ *
51741
+ * - via {@link #createEntry} and it is not yet persisted in the back end, or
51742
+ * - via {@link #callFunction}.
51453
51743
  */
51454
51744
  resetChanges(
51455
51745
  /**
51456
- * Array of paths that should be reset. If no array is passed, all changes will be reset.
51746
+ * Paths to be be reset; if no array is passed, all changes are reset
51457
51747
  */
51458
51748
  aPath?: any[],
51459
51749
  /**
51460
- * If set to true, also deferred requests are taken into account.
51750
+ * Whether also deferred requests are taken into account
51461
51751
  */
51462
- bAll?: boolean
51752
+ bAll?: boolean,
51753
+ /**
51754
+ * Whether to delete the entities created via {@link #createEntry} or {@link #callFunction}; since 1.95.0
51755
+ */
51756
+ bDeleteCreatedEntities?: boolean
51463
51757
  ): Promise<any>;
51464
51758
  /**
51465
51759
  * Returns a promise, which will resolve with the security token as soon as it is available.
@@ -51865,17 +52159,17 @@ declare module "sap/ui/model/odata/v2/ODataTreeBinding" {
51865
52159
  * Applies the given filters to the ODataTreeBinding.
51866
52160
  *
51867
52161
  * Please note that filters of type `FilterType.Control` are not supported for `OperationMode.Server`, here
51868
- * only filters of type `FilterType.Application` are allowed. Filters given via the constructor are always
51869
- * of type `Application` and will be sent with every backend request. See the constructor documentation
51870
- * for more information.
52162
+ * only filters of type `FilterType.Application` are allowed. Filters given via {@link sap.ui.model.odata.v2.ODataModel#bindTree}
52163
+ * are always of type `Application` and will be sent with every back-end request. For more information,
52164
+ * see {@link sap.ui.model.odata.v2.ODataModel#bindTree}.
51871
52165
  *
51872
52166
  * Since 1.34.0, complete client-side filtering is supported for `OperationMode.Client` and also in `OperationMode.Auto`
51873
- * if the backend count is lower than the threshold. In this case, all types of filters will be applied
51874
- * on the client. See also: {@link sap.ui.model.odata.OperationMode.Auto}, {@link sap.ui.model.FilterType}.
52167
+ * if the back-end count is lower than the threshold. In this case, all types of filters will be applied
52168
+ * on the client. See also: {@link sap.ui.model.odata.OperationMode.Auto} and {@link sap.ui.model.FilterType}.
51875
52169
  *
51876
- * For the `OperationMode.Client` and `OperationMode.Auto`, you may also specify the binding parameter `useServersideApplicationFilters`
51877
- * in the constructor. If it is set, the filters of type `Application` will always be applied on the backend
51878
- * and trigger an OData request. See the constructor documentation for more information.
52170
+ * For the `OperationMode.Client` and `OperationMode.Auto`, you may also specify the `useServersideApplicationFilters`
52171
+ * binding parameter when creating an instance. If it is set, the filters of type `Application` will always
52172
+ * be applied on the back end and trigger an OData request. For more information, see {@link sap.ui.model.odata.v2.ODataModel#bindTree}.
51879
52173
  * See:
51880
52174
  * sap.ui.model.TreeBinding.prototype.filter
51881
52175
  */
@@ -51887,7 +52181,11 @@ declare module "sap/ui/model/odata/v2/ODataTreeBinding" {
51887
52181
  /**
51888
52182
  * Type of the filter which should be adjusted. If it is not given, the type `FilterType.Control` is assumed
51889
52183
  */
51890
- sFilterType: FilterType | keyof typeof FilterType
52184
+ sFilterType: FilterType | keyof typeof FilterType,
52185
+ /**
52186
+ * Whether to return `true` or `false`, instead of `this`, depending on whether the filtering has been done
52187
+ */
52188
+ bReturnSuccess?: boolean
51891
52189
  ): this;
51892
52190
  /**
51893
52191
  * Returns the number of child nodes. This function is not available when the annotation "hierarchy-node-descendant-count-for"
@@ -51993,21 +52291,30 @@ declare module "sap/ui/model/odata/v2/ODataTreeBinding" {
51993
52291
  sGroupId?: string
51994
52292
  ): void;
51995
52293
  /**
51996
- * Sets the rootLevel The root level is the level of the topmost tree nodes, which will be used as an entry
52294
+ * Sets the `rootLevel`. The root level is the level of the topmost tree nodes that will be used as an entry
51997
52295
  * point for OData services. This is only possible (and necessary) for OData services implementing the hierarchy
51998
52296
  * annotation specification, or when providing the annotation information locally as a binding parameter.
51999
- * See the constructor for API documentation on this.
52297
+ * For more information, see {@link sap.ui.model.odata.v2.ODataModel#bindTree}.
52000
52298
  */
52001
- setRootLevel(iRootLevel: int): void;
52299
+ setRootLevel(
52300
+ /**
52301
+ * The new `rootLevel`
52302
+ */
52303
+ iRootLevel: int
52304
+ ): void;
52002
52305
  /**
52003
- * Sorts the Tree according to the given Sorter(s). In OperationMode.Client or OperationMode.Auto (if the
52004
- * given threshold is satisfied), the sorters are applied locally on the client.
52306
+ * Sorts the Tree according to the given Sorter(s). In `OperationMode.Client` or `OperationMode.Auto` (if
52307
+ * the given threshold is satisfied), the sorters are applied locally on the client.
52005
52308
  */
52006
52309
  sort(
52007
52310
  /**
52008
- * the Sorter or an Array of sap.ui.model.Sorter instances
52311
+ * The Sorter or an Array of sap.ui.model.Sorter instances
52312
+ */
52313
+ aSorters: Sorter[] | Sorter,
52314
+ /**
52315
+ * Whether to return `true` or `false`, instead of `this`, depending on whether the sorting has been done
52009
52316
  */
52010
- aSorters: Sorter[] | Sorter
52317
+ bReturnSuccess?: boolean
52011
52318
  ): this;
52012
52319
  }
52013
52320
  }
@@ -52636,7 +52943,12 @@ declare module "sap/ui/model/odata/v4/Context" {
52636
52943
  * binding is used, see {@link #getUpdateGroupId}; the resulting group ID must not have {@link sap.ui.model.odata.v4.SubmitMode.API}.
52637
52944
  * Since 1.81, if this context is transient (see {@link #isTransient}), no group ID needs to be specified.
52638
52945
  */
52639
- sGroupId?: string
52946
+ sGroupId?: string,
52947
+ /**
52948
+ * Whether not to request the new count from the server; useful in case of {@link #replaceWith} where it
52949
+ * is known that the count remains unchanged (since 1.97.0)
52950
+ */
52951
+ bDoNotRequestCount?: boolean
52640
52952
  ): Promise<any>;
52641
52953
  /**
52642
52954
  * @SINCE 1.41.0
@@ -52795,6 +53107,18 @@ declare module "sap/ui/model/odata/v4/Context" {
52795
53107
  */
52796
53108
  bAllowRemoval?: boolean
52797
53109
  ): void;
53110
+ /**
53111
+ * @SINCE 1.97.0
53112
+ *
53113
+ * Replaces this context with the given other context. You probably want to delete this context afterwards
53114
+ * without requesting the new count from the server, see the `bDoNotRequestCount` parameter of {@link #delete}.
53115
+ */
53116
+ replaceWith(
53117
+ /**
53118
+ * The other context
53119
+ */
53120
+ oOtherContext: Context
53121
+ ): void;
52798
53122
  /**
52799
53123
  * @SINCE 1.39.0
52800
53124
  *
@@ -53021,8 +53345,8 @@ declare module "sap/ui/model/odata/v4/ODataContextBinding" {
53021
53345
  * @SINCE 1.37.0
53022
53346
  *
53023
53347
  * Context binding for an OData V4 model. An event handler can only be attached to this binding for the
53024
- * following events: 'AggregatedDataStateChange', 'change', 'dataReceived', 'dataRequested', and 'DataStateChange'.
53025
- * For other events, an error is thrown.
53348
+ * following events: 'AggregatedDataStateChange', 'change', 'dataReceived', 'dataRequested', 'DataStateChange',
53349
+ * 'patchCompleted', and 'patchSent'. For other events, an error is thrown.
53026
53350
  *
53027
53351
  * A context binding can also be used as an operation binding to support bound actions, action imports,
53028
53352
  * bound functions and function imports. If you want to control the execution time of an operation, for
@@ -53130,10 +53454,10 @@ declare module "sap/ui/model/odata/v4/ODataContextBinding" {
53130
53454
  *
53131
53455
  * Changes this binding's parameters and refreshes the binding.
53132
53456
  *
53133
- * If there are pending changes an error is thrown. Use {@link #hasPendingChanges} to check if there are
53134
- * pending changes. If there are changes, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit
53135
- * the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before calling
53136
- * {@link #changeParameters}.
53457
+ * If there are pending changes that cannot be ignored, an error is thrown. Use {@link #hasPendingChanges}
53458
+ * to check if there are such pending changes. If there are, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
53459
+ * to submit the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before
53460
+ * calling {@link #changeParameters}.
53137
53461
  *
53138
53462
  * The parameters are changed according to the given map of parameters: Parameters with an `undefined` value
53139
53463
  * are removed, the other parameters are set, and missing parameters remain unchanged.
@@ -53214,7 +53538,19 @@ declare module "sap/ui/model/odata/v4/ODataContextBinding" {
53214
53538
  * the bound action should either be repeated **without** applying the preference or rejected with an `Error`
53215
53539
  * instance `oError` where `oError.canceled === true`. Since 1.92.0.
53216
53540
  */
53217
- fnOnStrictHandlingFailed?: Function
53541
+ fnOnStrictHandlingFailed?: Function,
53542
+ /**
53543
+ * Whether this operation binding's parent context, which must belong to a list binding, is replaced with
53544
+ * the operation's return value context (see below) and that list context is returned instead. The list
53545
+ * context may be a newly created context or an existing context. A newly created context has the same `keepAlive`
53546
+ * attribute and `fnOnBeforeDestroy` function as the parent context, see {@link sap.ui.model.odata.v4.Context#setKeepAlive};
53547
+ * `fnOnBeforeDestroy` will be called with the new context instance as the only argument in this case. An
53548
+ * existing context does not change its `keepAlive` attribute. In any case, the resulting context takes
53549
+ * the place (index, position) of the parent context {@link sap.ui.model.odata.v4.Context#getIndex}. If
53550
+ * the parent context has requested messages when it was kept alive, they will be inherited if the $$inheritExpandSelect
53551
+ * binding parameter is set to `true`. Since 1.97.0.
53552
+ */
53553
+ bReplaceWithRVC?: boolean
53218
53554
  ): Promise<any>;
53219
53555
  /**
53220
53556
  * @SINCE 1.39.0
@@ -53270,7 +53606,15 @@ declare module "sap/ui/model/odata/v4/ODataContextBinding" {
53270
53606
  * returns `true` if there are pending changes for the current parent context path of this binding. If this
53271
53607
  * binding is unresolved (see {@link sap.ui.model.Binding#isResolved}), it returns `false`.
53272
53608
  */
53273
- hasPendingChanges(): boolean;
53609
+ hasPendingChanges(
53610
+ /**
53611
+ * Whether to ignore changes which will not be lost by APIs like {@link sap.ui.model.odata.v4.ODataListBinding#changeParameters
53612
+ * changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#sort
53613
+ * sort}, or {@link sap.ui.model.odata.v4.ODataListBinding#suspend suspend} because they relate to a {@link
53614
+ * sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context of this binding.
53615
+ */
53616
+ bIgnoreKeptAlive?: boolean
53617
+ ): boolean;
53274
53618
  /**
53275
53619
  * @SINCE 1.37.0
53276
53620
  *
@@ -53286,6 +53630,20 @@ declare module "sap/ui/model/odata/v4/ODataContextBinding" {
53286
53630
  * Method not supported
53287
53631
  */
53288
53632
  isInitial(): boolean;
53633
+ /**
53634
+ * @SINCE 1.95.0
53635
+ * @EXPERIMENTAL
53636
+ *
53637
+ * Moves the bound entity into the given list binding. This binding loses its data. The method may only
53638
+ * be called when this binding has finished loading. You can verify this by calling `oBinding.getBoundContext().requestObject()`.
53639
+ * If that promise resolves, the binding has finished loading.
53640
+ */
53641
+ moveEntityTo(
53642
+ /**
53643
+ * The list binding to take the entity
53644
+ */
53645
+ oListBinding: ODataListBinding
53646
+ ): void;
53289
53647
  /**
53290
53648
  * @SINCE 1.37.0
53291
53649
  *
@@ -53340,6 +53698,18 @@ declare module "sap/ui/model/odata/v4/ODataContextBinding" {
53340
53698
  */
53341
53699
  sPath?: string
53342
53700
  ): Promise<any>;
53701
+ /**
53702
+ * @SINCE 1.87.0
53703
+ *
53704
+ * Refreshes the binding and returns a promise to wait for it. See {@link #refresh} for details. Use {@link
53705
+ * #refresh} if you do not need the promise.
53706
+ */
53707
+ requestRefresh(
53708
+ /**
53709
+ * The group ID to be used
53710
+ */
53711
+ sGroupId?: string
53712
+ ): Promise<any>;
53343
53713
  /**
53344
53714
  * @SINCE 1.40.1
53345
53715
  *
@@ -53378,7 +53748,8 @@ declare module "sap/ui/model/odata/v4/ODataContextBinding" {
53378
53748
  *
53379
53749
  * Suspends this binding. A suspended binding does not fire change events nor does it trigger data service
53380
53750
  * requests. Call {@link #resume} to resume the binding. Before 1.53.0, this method was not supported and
53381
- * threw an error.
53751
+ * threw an error. Since 1.97.0, pending changes are ignored if they relate to a {@link sap.ui.model.odata.v4.Context#setKeepAlive
53752
+ * kept-alive} context of this binding.
53382
53753
  * See:
53383
53754
  * {@link topic:b0f5c531e5034a27952cc748954cbe39 Suspend and Resume}
53384
53755
  * sap.ui.model.Binding#suspend
@@ -53387,6 +53758,13 @@ declare module "sap/ui/model/odata/v4/ODataContextBinding" {
53387
53758
  * #resume
53388
53759
  */
53389
53760
  suspend(): void;
53761
+ /**
53762
+ * @SINCE 1.37.0
53763
+ *
53764
+ * Returns a string representation of this object including the binding path. If the binding is relative,
53765
+ * the parent path is also given, separated by a '|'.
53766
+ */
53767
+ toString(): string;
53390
53768
  }
53391
53769
  }
53392
53770
 
@@ -53413,8 +53791,8 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
53413
53791
  * @SINCE 1.37.0
53414
53792
  *
53415
53793
  * List binding for an OData V4 model. An event handler can only be attached to this binding for the following
53416
- * events: 'AggregatedDataStateChange', 'change', 'dataReceived', 'dataRequested', 'DataStateChange' and
53417
- * 'refresh'. For other events, an error is thrown.
53794
+ * events: 'AggregatedDataStateChange', 'change', 'createCompleted', 'createSent', 'dataReceived', 'dataRequested',
53795
+ * 'DataStateChange', 'patchCompleted', 'patchSent', and 'refresh'. For other events, an error is thrown.
53418
53796
  */
53419
53797
  export default class ODataListBinding extends ListBinding {
53420
53798
  constructor();
@@ -53528,10 +53906,10 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
53528
53906
  *
53529
53907
  * Changes this binding's parameters and refreshes the binding.
53530
53908
  *
53531
- * If there are pending changes an error is thrown. Use {@link #hasPendingChanges} to check if there are
53532
- * pending changes. If there are changes, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit
53533
- * the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before calling
53534
- * {@link #changeParameters}.
53909
+ * If there are pending changes that cannot be ignored, an error is thrown. Use {@link #hasPendingChanges}
53910
+ * to check if there are such pending changes. If there are, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
53911
+ * to submit the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before
53912
+ * calling {@link #changeParameters}.
53535
53913
  *
53536
53914
  * The parameters are changed according to the given map of parameters: Parameters with an `undefined` value
53537
53915
  * are removed, the other parameters are set, and missing parameters remain unchanged.
@@ -53601,7 +53979,13 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
53601
53979
  * Whether the entity is inserted at the end of the list. When creating multiple entities, this parameter
53602
53980
  * must have the same value for each entity. Supported since 1.66.0
53603
53981
  */
53604
- bAtEnd?: boolean
53982
+ bAtEnd?: boolean,
53983
+ /**
53984
+ * Create an inactive context. Such a context will only be sent to the server after the first property update.
53985
+ * From then on it behaves like any other created context. This parameter is experimental and its implementation
53986
+ * may still change. Do not use it in productive code yet. Supported since 1.97.0
53987
+ */
53988
+ bInactive?: boolean
53605
53989
  ): Context;
53606
53990
  /**
53607
53991
  * @SINCE 1.40.1
@@ -53674,15 +54058,29 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
53674
54058
  /**
53675
54059
  * @SINCE 1.39.0
53676
54060
  *
53677
- * Filters the list with the given filters.
54061
+ * Filters the list with the given filters. Since 1.97.0, if filters are unchanged, no request is sent,
54062
+ * regardless of pending changes.
53678
54063
  *
53679
- * If there are pending changes an error is thrown. Use {@link #hasPendingChanges} to check if there are
53680
- * pending changes. If there are changes, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit
53681
- * the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before calling
53682
- * {@link #filter}.
54064
+ * If there are pending changes that cannot be ignored, an error is thrown. Use {@link #hasPendingChanges}
54065
+ * to check if there are such pending changes. If there are, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
54066
+ * to submit the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before
54067
+ * calling {@link #filter}.
53683
54068
  *
53684
54069
  * Filters are case sensitive unless the property `caseSensitive` is set to `false`. This property has to
53685
54070
  * be set on each filter, it is not inherited from a multi-filter.
54071
+ *
54072
+ * Application and Control Filters: Each list binding maintains two separate lists of filters, one for filters
54073
+ * defined by the control that owns the binding, and another list for filters that an application can define
54074
+ * in addition. When executing the filter operation, both sets of filters are combined.
54075
+ *
54076
+ * By using the `sFilterType` parameter of the `filter` method, the caller can control which set of filters
54077
+ * is modified.
54078
+ *
54079
+ * Auto-Grouping of Filters: Filters are first grouped according to their binding path. All filters belonging
54080
+ * to the same path are ORed, and after that the results of all paths are ANDed. Usually this means that
54081
+ * all filters applied to the same property are ORed, while filters on different properties are ANDed. Please
54082
+ * use either the automatic grouping of filters (where applicable) or explicit AND/OR filters, as a mixture
54083
+ * of both is not supported.
53686
54084
  * See:
53687
54085
  * sap.ui.model.ListBinding#filter
53688
54086
  * #setAggregation
@@ -53859,7 +54257,15 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
53859
54257
  * returns `true` if there are pending changes for the current parent context path of this binding. If this
53860
54258
  * binding is unresolved (see {@link sap.ui.model.Binding#isResolved}), it returns `false`.
53861
54259
  */
53862
- hasPendingChanges(): boolean;
54260
+ hasPendingChanges(
54261
+ /**
54262
+ * Whether to ignore changes which will not be lost by APIs like {@link sap.ui.model.odata.v4.ODataListBinding#changeParameters
54263
+ * changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#sort
54264
+ * sort}, or {@link sap.ui.model.odata.v4.ODataListBinding#suspend suspend} because they relate to a {@link
54265
+ * sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context of this binding.
54266
+ */
54267
+ bIgnoreKeptAlive?: boolean
54268
+ ): boolean;
53863
54269
  /**
53864
54270
  * @SINCE 1.37.0
53865
54271
  *
@@ -53980,6 +54386,18 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
53980
54386
  */
53981
54387
  fnFilter?: (p1: Message) => boolean
53982
54388
  ): Promise<Filter>;
54389
+ /**
54390
+ * @SINCE 1.87.0
54391
+ *
54392
+ * Refreshes the binding and returns a promise to wait for it. See {@link #refresh} for details. Use {@link
54393
+ * #refresh} if you do not need the promise.
54394
+ */
54395
+ requestRefresh(
54396
+ /**
54397
+ * The group ID to be used
54398
+ */
54399
+ sGroupId?: string
54400
+ ): Promise<any>;
53983
54401
  /**
53984
54402
  * @SINCE 1.40.1
53985
54403
  *
@@ -54069,12 +54487,13 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
54069
54487
  * @SINCE 1.39.0
54070
54488
  *
54071
54489
  * Sort the entries represented by this list binding according to the given sorters. The sorters are stored
54072
- * at this list binding and they are used for each following data request.
54490
+ * at this list binding and they are used for each following data request. Since 1.97.0, if sorters are
54491
+ * unchanged, no request is sent, regardless of pending changes.
54073
54492
  *
54074
- * If there are pending changes an error is thrown. Use {@link #hasPendingChanges} to check if there are
54075
- * pending changes. If there are changes, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit
54076
- * the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before calling
54077
- * {@link #sort}.
54493
+ * If there are pending changes that cannot be ignored, an error is thrown. Use {@link #hasPendingChanges}
54494
+ * to check if there are such pending changes. If there are, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
54495
+ * to submit the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before
54496
+ * calling {@link #sort}.
54078
54497
  * See:
54079
54498
  * sap.ui.model.ListBinding#sort
54080
54499
  */
@@ -54091,7 +54510,8 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
54091
54510
  *
54092
54511
  * Suspends this binding. A suspended binding does not fire change events nor does it trigger data service
54093
54512
  * requests. Call {@link #resume} to resume the binding. Before 1.53.0, this method was not supported and
54094
- * threw an error.
54513
+ * threw an error. Since 1.97.0, pending changes are ignored if they relate to a {@link sap.ui.model.odata.v4.Context#setKeepAlive
54514
+ * kept-alive} context of this binding.
54095
54515
  * See:
54096
54516
  * {@link topic:b0f5c531e5034a27952cc748954cbe39 Suspend and Resume}
54097
54517
  * sap.ui.model.Binding#suspend
@@ -54100,6 +54520,13 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
54100
54520
  * #resume
54101
54521
  */
54102
54522
  suspend(): void;
54523
+ /**
54524
+ * @SINCE 1.37.0
54525
+ *
54526
+ * Returns a string representation of this object including the binding path. If the binding is relative,
54527
+ * the parent path is also given, separated by a '|'.
54528
+ */
54529
+ toString(): string;
54103
54530
  /**
54104
54531
  * @SINCE 1.53.0
54105
54532
  *
@@ -54198,6 +54625,8 @@ declare module "sap/ui/model/odata/v4/ODataMetaModel" {
54198
54625
  * not support any public events; attaching an event handler leads to an error.
54199
54626
  *
54200
54627
  * This model is read-only.
54628
+ *
54629
+ * This model is not prepared to be inherited from.
54201
54630
  */
54202
54631
  export default class ODataMetaModel extends MetaModel {
54203
54632
  constructor();
@@ -54844,6 +55273,8 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
54844
55273
  *
54845
55274
  * Model implementation for OData V4.
54846
55275
  *
55276
+ * This model is not prepared to be inherited from.
55277
+ *
54847
55278
  * Every resource path (relative to the service root URL, no query options) according to "4 Resource Path"
54848
55279
  * in specification "OData Version 4.0 Part 2: URL Conventions" is a valid data binding path within this
54849
55280
  * model if a leading slash is added; for example "/" + "SalesOrderList('A%2FB%26C')" to access an entity
@@ -55067,9 +55498,8 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
55067
55498
  $$groupId?: string;
55068
55499
  /**
55069
55500
  * For operation bindings only: Whether $expand and $select from the parent binding are used in the request
55070
- * sent on {@link #execute}. If set to `true`, the binding must not set the $expand or $select parameter
55071
- * itself, the operation must be bound, and the return value and the binding parameter must belong to the
55072
- * same entity set.
55501
+ * sent on {@link #execute}. If set to `true`, the binding must not set the $expand itself, the operation
55502
+ * must be bound, and the return value and the binding parameter must belong to the same entity set.
55073
55503
  */
55074
55504
  $$inheritExpandSelect?: boolean;
55075
55505
  /**
@@ -55100,7 +55530,7 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
55100
55530
  */
55101
55531
  bindList(
55102
55532
  /**
55103
- * The binding path in the model; must not be empty or end with a slash
55533
+ * The binding path in the model; must not end with a slash
55104
55534
  */
55105
55535
  sPath: string,
55106
55536
  /**
@@ -55201,8 +55631,7 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
55201
55631
  * as a separator and splits it into two parts. The part before the separator is resolved with the binding's
55202
55632
  * context and the result is transformed into a metadata context (see {@link sap.ui.model.odata.v4.ODataMetaModel#getMetaContext}).
55203
55633
  * The part following the separator is then interpreted relative to this metadata context, even if it starts
55204
- * with a '/'; a trailing '/' is allowed here, see {@link sap.ui.model.odata.v4.ODataMetaModel#requestObject}
55205
- * for the effect it has.
55634
+ * with a '/'; see {@link sap.ui.model.odata.v4.ODataMetaModel#requestObject} for more details.
55206
55635
  *
55207
55636
  * If the target type specified in the corresponding control property's binding info is "any" and the binding
55208
55637
  * is relative or points to metadata, the binding may have an object value; in this case and unless the
@@ -55214,8 +55643,7 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
55214
55643
  */
55215
55644
  bindProperty(
55216
55645
  /**
55217
- * The binding path in the model; must not be empty. Must not end with a '/' unless the binding points to
55218
- * metadata.
55646
+ * The binding path in the model; must not end with a slash
55219
55647
  */
55220
55648
  sPath: string,
55221
55649
  /**
@@ -55224,12 +55652,14 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
55224
55652
  oContext?: Context1,
55225
55653
  /**
55226
55654
  * Map of binding parameters which can be OData query options as specified in "OData Version 4.0 Part 2:
55227
- * URL Conventions" or the binding-specific parameter "$$groupId". All "5.2 Custom Query Options" are allowed
55228
- * except for those with a name starting with "sap-" (unless starting with "sap-valid-"). All other query
55229
- * options lead to an error. Query options specified for the binding overwrite model query options. Note:
55230
- * The binding only creates its own data service request if it is absolute or if it is relative to a context
55231
- * created via {@link #createBindingContext}. The binding parameters are ignored in case the binding creates
55232
- * no own data service request or in case the binding points to metadata.
55655
+ * URL Conventions" or the binding-specific parameters as specified below. The following OData query options
55656
+ * are allowed:
55657
+ * All "5.2 Custom Query Options" except for those with a name starting with "sap-" (unless starting with
55658
+ * "sap-valid-") The $apply, $filter, and $search "5.1 System Query Options" if the path ends with
55659
+ * a "$count" segment. All other query options lead to an error. Query options specified for the binding
55660
+ * overwrite model query options. Note: The binding only creates its own data service request if it is absolute
55661
+ * or if it is relative to a context created via {@link #createBindingContext}. The binding parameters are
55662
+ * ignored in case the binding creates no own data service request or in case the binding points to metadata.
55233
55663
  */
55234
55664
  mParameters?: {
55235
55665
  /**
@@ -55688,7 +56118,15 @@ declare module "sap/ui/model/odata/v4/ODataPropertyBinding" {
55688
56118
  * returns `true` if there are pending changes for the current parent context path of this binding. If this
55689
56119
  * binding is unresolved (see {@link sap.ui.model.Binding#isResolved}), it returns `false`.
55690
56120
  */
55691
- hasPendingChanges(): boolean;
56121
+ hasPendingChanges(
56122
+ /**
56123
+ * Whether to ignore changes which will not be lost by APIs like {@link sap.ui.model.odata.v4.ODataListBinding#changeParameters
56124
+ * changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#sort
56125
+ * sort}, or {@link sap.ui.model.odata.v4.ODataListBinding#suspend suspend} because they relate to a {@link
56126
+ * sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context of this binding.
56127
+ */
56128
+ bIgnoreKeptAlive?: boolean
56129
+ ): boolean;
55692
56130
  /**
55693
56131
  * @SINCE 1.37.0
55694
56132
  *
@@ -55730,6 +56168,18 @@ declare module "sap/ui/model/odata/v4/ODataPropertyBinding" {
55730
56168
  */
55731
56169
  sGroupId?: string | boolean
55732
56170
  ): void;
56171
+ /**
56172
+ * @SINCE 1.87.0
56173
+ *
56174
+ * Refreshes the binding and returns a promise to wait for it. See {@link #refresh} for details. Use {@link
56175
+ * #refresh} if you do not need the promise.
56176
+ */
56177
+ requestRefresh(
56178
+ /**
56179
+ * The group ID to be used
56180
+ */
56181
+ sGroupId?: string
56182
+ ): Promise<any>;
55733
56183
  /**
55734
56184
  * @SINCE 1.69
55735
56185
  *
@@ -55825,6 +56275,13 @@ declare module "sap/ui/model/odata/v4/ODataPropertyBinding" {
55825
56275
  * sap.ui.model.Binding#suspend
55826
56276
  */
55827
56277
  suspend(): void;
56278
+ /**
56279
+ * @SINCE 1.37.0
56280
+ *
56281
+ * Returns a string representation of this object including the binding path. If the binding is relative,
56282
+ * the parent path is also given, separated by a '|'.
56283
+ */
56284
+ toString(): string;
55828
56285
  }
55829
56286
  }
55830
56287
 
@@ -56042,7 +56499,7 @@ declare module "sap/ui/model/PropertyBinding" {
56042
56499
  */
56043
56500
  static getMetadata(): Metadata;
56044
56501
  /**
56045
- * Returns the binding mode
56502
+ * Returns the binding mode.
56046
56503
  */
56047
56504
  getBindingMode(): BindingMode | keyof typeof BindingMode;
56048
56505
  /**
@@ -56050,7 +56507,7 @@ declare module "sap/ui/model/PropertyBinding" {
56050
56507
  */
56051
56508
  getExternalValue(): any;
56052
56509
  /**
56053
- * Returns the formatter function
56510
+ * Returns the formatter function.
56054
56511
  */
56055
56512
  getFormatter(): Function;
56056
56513
  /**
@@ -56058,21 +56515,21 @@ declare module "sap/ui/model/PropertyBinding" {
56058
56515
  * model format} of this binding's type. If this binding doesn't have a type, the original value which is
56059
56516
  * stored in the model is returned.
56060
56517
  *
56061
- * This method will be used when targetType if set to "internal" or it's included in a {@link sap.ui.model.CompositeBinding
56518
+ * This method will be used when targetType is set to "internal" or when it's included in a {@link sap.ui.model.CompositeBinding
56062
56519
  * CompositeBinding} and the CompositeBinding needs to have the related JavaScript primitive values for
56063
56520
  * its type or formatter.
56064
56521
  */
56065
56522
  getInternalValue(): any;
56066
56523
  /**
56067
- * Returns the raw model value, as it exists in the model dataset
56524
+ * Returns the raw model value, as it exists in the model dataset.
56068
56525
  *
56069
- * This method will be used when targetType of a binding is set to "raw" or it's included in a {@link sap.ui.model.CompositeBinding
56070
- * CompositeBinding} and the CompositeBinding needs to have the related JavaScript primitive values for
56071
- * its type or formatter.
56526
+ * This method will be used when targetType of a binding is set to "raw" or when it's include in a {@link
56527
+ * sap.ui.model.CompositeBinding CompositeBinding} and the CompositeBinding needs to have the related JavaScript
56528
+ * primitive values for its type or formatter.
56072
56529
  */
56073
56530
  getRawValue(): any;
56074
56531
  /**
56075
- * Returns the type if any for the binding.
56532
+ * Returns the type (if any) for the binding.
56076
56533
  */
56077
56534
  getType(): Type;
56078
56535
  /**
@@ -56087,22 +56544,22 @@ declare module "sap/ui/model/PropertyBinding" {
56087
56544
  */
56088
56545
  resume(): void;
56089
56546
  /**
56090
- * Sets the binding mode
56547
+ * Sets the binding mode.
56091
56548
  */
56092
56549
  setBindingMode(
56093
56550
  /**
56094
- * the binding mode
56551
+ * The binding mode
56095
56552
  */
56096
56553
  sBindingMode: BindingMode | keyof typeof BindingMode
56097
56554
  ): void;
56098
56555
  /**
56099
56556
  * Sets the value for this binding. The value is parsed and validated against its type and then set to the
56100
56557
  * binding. A model implementation should check if the current default binding mode permits setting the
56101
- * binding value and if so set the new value also in the model.
56558
+ * binding value, and if so, set the new value in the model, too.
56102
56559
  */
56103
56560
  setExternalValue(
56104
56561
  /**
56105
- * the value to set for this binding
56562
+ * The value to set for this binding
56106
56563
  */
56107
56564
  vValue: any
56108
56565
  ): undefined | Promise<any>;
@@ -56111,7 +56568,7 @@ declare module "sap/ui/model/PropertyBinding" {
56111
56568
  */
56112
56569
  setFormatter(
56113
56570
  /**
56114
- * the formatter function for the binding
56571
+ * The formatter function for the binding
56115
56572
  */
56116
56573
  fnFormatter: Function
56117
56574
  ): void;
@@ -56122,20 +56579,20 @@ declare module "sap/ui/model/PropertyBinding" {
56122
56579
  */
56123
56580
  setInternalValue(
56124
56581
  /**
56125
- * the value to set for this binding
56582
+ * The value to set for this binding
56126
56583
  */
56127
56584
  vValue: any
56128
- ): void;
56585
+ ): Promise<any> | undefined;
56129
56586
  /**
56130
56587
  * Sets the value for this binding with the raw model value. This setter will perform type validation, in
56131
56588
  * case a type is defined on the binding.
56132
56589
  */
56133
56590
  setRawValue(
56134
56591
  /**
56135
- * the value to set for this binding
56592
+ * The value to set for this binding
56136
56593
  */
56137
56594
  vValue: any
56138
- ): void;
56595
+ ): Promise<any> | undefined;
56139
56596
  /**
56140
56597
  * Sets the optional type and internal type for the binding. The type and internal type are used to do the
56141
56598
  * parsing/formatting correctly. The internal type is the property type of the element which the value is
@@ -56143,17 +56600,17 @@ declare module "sap/ui/model/PropertyBinding" {
56143
56600
  */
56144
56601
  setType(
56145
56602
  /**
56146
- * the type for the binding
56603
+ * The type for the binding
56147
56604
  */
56148
56605
  oType: Type,
56149
56606
  /**
56150
- * the internal type of the element property which this binding is bound against.
56607
+ * The internal type of the element property which this binding is bound against.
56151
56608
  */
56152
56609
  sInternalType: string
56153
56610
  ): void;
56154
56611
  /**
56155
56612
  * Sets the value for this binding. A model implementation should check if the current default binding mode
56156
- * permits setting the binding value and if so set the new value also in the model.
56613
+ * permits setting the binding value, and if so, set the new value in the model, too.
56157
56614
  */
56158
56615
  setValue(
56159
56616
  /**
@@ -56182,6 +56639,8 @@ declare module "sap/ui/model/resource/ResourceModel" {
56182
56639
  /**
56183
56640
  * Model implementation for resource bundles.
56184
56641
  *
56642
+ * This model is not prepared to be inherited from.
56643
+ *
56185
56644
  * This model allows to bind control properties against translatable texts. Its data is taken from a {@link
56186
56645
  * module:sap/base/i18n/ResourceBundle} and it only supports property bindings.
56187
56646
  *
@@ -57166,18 +57625,18 @@ declare module "sap/ui/model/TreeBindingAdapter" {
57166
57625
  * @deprecated (since 1.52) - This method is marked as 'protected' which was meant to be overwritten by
57167
57626
  * its subclasses. It may be renamed or deleted and should only be called from this class or its subclasses.
57168
57627
  *
57169
- * Calculate the request length based on the given information
57628
+ * Calculate the request length based on the given information.
57170
57629
  */
57171
57630
  _calculateRequestLength(
57172
57631
  /**
57173
- * the maximum group size
57632
+ * The maximum group size
57174
57633
  */
57175
- iMaxGroupSize: int,
57634
+ iMaxGroupSize: number,
57176
57635
  /**
57177
- * the information of the current section
57636
+ * The information of the current section
57178
57637
  */
57179
57638
  oSection: object
57180
- ): void;
57639
+ ): number;
57181
57640
  /**
57182
57641
  * Attaches event handler `fnFunction` to the {@link #event:selectionChanged selectionChanged} event of
57183
57642
  * this `sap.ui.model.TreeBindingAdapter`.
@@ -57276,6 +57735,10 @@ declare module "sap/ui/model/TreeBindingAdapter" {
57276
57735
  */
57277
57736
  iThreshold?: number
57278
57737
  ): Context[];
57738
+ /**
57739
+ * Returns the number of entries in the tree.
57740
+ */
57741
+ getLength(): number;
57279
57742
  /**
57280
57743
  * Gets an array of nodes for the requested part of the tree.
57281
57744
  */
@@ -57297,6 +57760,11 @@ declare module "sap/ui/model/TreeBindingAdapter" {
57297
57760
  }
57298
57761
 
57299
57762
  declare module "sap/ui/model/TreeBindingCompatibilityAdapter" {
57763
+ import TreeBinding from "sap/ui/model/TreeBinding";
57764
+
57765
+ /**
57766
+ * @deprecated - use {@link sap.ui.model.TreeBindingAdapter} instead
57767
+ */
57300
57768
  export default class TreeBindingCompatibilityAdapter {
57301
57769
  /**
57302
57770
  * Adapter for TreeBindings to add the ListBinding functionality and use the tree structure in list based
@@ -57304,7 +57772,16 @@ declare module "sap/ui/model/TreeBindingCompatibilityAdapter" {
57304
57772
  *
57305
57773
  * This module is only for experimental and internal use!
57306
57774
  */
57307
- constructor();
57775
+ constructor(
57776
+ /**
57777
+ * The binding to add ListBinding functionality to
57778
+ */
57779
+ oBinding: TreeBinding,
57780
+ /**
57781
+ * The tree or tree table control using the given binding; the control is used for selection handling
57782
+ */
57783
+ oControl: object
57784
+ );
57308
57785
  }
57309
57786
  }
57310
57787
 
@@ -57638,8 +58115,12 @@ declare module "sap/ui/model/type/Date" {
57638
58115
  * Returns a metadata object for class sap.ui.model.type.Date.
57639
58116
  */
57640
58117
  static getMetadata(): Metadata;
57641
-
57642
- getOutputPattern(): void;
58118
+ /**
58119
+ * Returns the output pattern.
58120
+ * See:
58121
+ * sap.ui.core.format.DateFormat.getDateInstance
58122
+ */
58123
+ getOutputPattern(): string;
57643
58124
  }
57644
58125
  }
57645
58126
 
@@ -58539,7 +59020,9 @@ declare module "sap/ui/model/xml/XMLModel" {
58539
59020
  import Metadata from "sap/ui/base/Metadata";
58540
59021
 
58541
59022
  /**
58542
- * Model implementation for XML format
59023
+ * Model implementation for the XML format.
59024
+ *
59025
+ * This model is not prepared to be inherited from.
58543
59026
  */
58544
59027
  export default class XMLModel extends ClientModel {
58545
59028
  /**
@@ -58578,35 +59061,35 @@ declare module "sap/ui/model/xml/XMLModel" {
58578
59061
  */
58579
59062
  static getMetadata(): Metadata;
58580
59063
  /**
58581
- * Returns the object for the given `path`
59064
+ * Returns the object for the given path and context.
58582
59065
  */
58583
59066
  getObject(
58584
59067
  /**
58585
- * the path to the object
59068
+ * The path to the object
58586
59069
  */
58587
59070
  sPath: string,
58588
59071
  /**
58589
- * the context which will be used to retrieve the object
59072
+ * The context which will be used to retrieve the object
58590
59073
  */
58591
59074
  oContext?: object
58592
- ): any;
59075
+ ): object;
58593
59076
  /**
58594
- * Returns the value for the property with the given `sPropertyName`
59077
+ * Returns the value for the property with the given `sPropertyName`.
58595
59078
  */
58596
59079
  getProperty(
58597
59080
  /**
58598
- * the path to the property
59081
+ * The path to the property
58599
59082
  */
58600
59083
  sPath: string,
58601
59084
  /**
58602
- * the context which will be used to retrieve the property
59085
+ * The context which will be used to retrieve the property
58603
59086
  */
58604
59087
  oContext?: object
58605
- ): any;
59088
+ ): string;
58606
59089
  /**
58607
59090
  * Serializes the current XML data of the model into a string.
58608
59091
  */
58609
- getXML(): undefined;
59092
+ getXML(): string;
58610
59093
  /**
58611
59094
  * Load XML-encoded data from the server using a GET HTTP request and store the resulting XML data in the
58612
59095
  * model. Note: Due to browser security restrictions, most "Ajax" requests are subject to the same origin
@@ -58654,11 +59137,11 @@ declare module "sap/ui/model/xml/XMLModel" {
58654
59137
  */
58655
59138
  setNameSpace(
58656
59139
  /**
58657
- * the namespace URI
59140
+ * The namespace URI
58658
59141
  */
58659
59142
  sNameSpace: string,
58660
59143
  /**
58661
- * the prefix for the namespace (optional)
59144
+ * The prefix for the namespace
58662
59145
  */
58663
59146
  sPrefix?: string
58664
59147
  ): void;
@@ -58668,19 +59151,19 @@ declare module "sap/ui/model/xml/XMLModel" {
58668
59151
  */
58669
59152
  setProperty(
58670
59153
  /**
58671
- * path of the property to set
59154
+ * Path of the property to set
58672
59155
  */
58673
59156
  sPath: string,
58674
59157
  /**
58675
- * value to set the property to
59158
+ * Value to set the property to
58676
59159
  */
58677
59160
  oValue: any,
58678
59161
  /**
58679
- * the context which will be used to set the property
59162
+ * The context which will be used to set the property
58680
59163
  */
58681
59164
  oContext?: object,
58682
59165
  /**
58683
- * whether to update other bindings dependent on this property asynchronously
59166
+ * Whether to update other bindings dependent on this property asynchronously
58684
59167
  */
58685
59168
  bAsyncUpdate?: boolean
58686
59169
  ): boolean;
@@ -59323,6 +59806,8 @@ declare module "sap/ui/test/actions/Press" {
59323
59806
 
59324
59807
  import ManagedObjectMetadata from "sap/ui/base/ManagedObjectMetadata";
59325
59808
 
59809
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
59810
+
59326
59811
  /**
59327
59812
  * @SINCE 1.34
59328
59813
  *
@@ -59339,13 +59824,22 @@ declare module "sap/ui/test/actions/Press" {
59339
59824
  * see {@link sap.ui.test.actions.Press.controlAdapters}.
59340
59825
  */
59341
59826
  export default class Press extends Action {
59827
+ /**
59828
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
59829
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
59830
+ * of the syntax of the settings object.
59831
+ */
59342
59832
  constructor(
59343
59833
  /**
59344
59834
  * Optional object with initial settings for the new instance
59345
59835
  */
59346
59836
  mSettings?: $PressSettings
59347
59837
  );
59348
-
59838
+ /**
59839
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
59840
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
59841
+ * of the syntax of the settings object.
59842
+ */
59349
59843
  constructor(
59350
59844
  /**
59351
59845
  * Optional ID for the new instance; generated automatically if no non-empty ID is given. Note: this can
@@ -59393,9 +59887,99 @@ declare module "sap/ui/test/actions/Press" {
59393
59887
  */
59394
59888
  oControl: Control
59395
59889
  ): void;
59890
+ /**
59891
+ * @SINCE 1.97
59892
+ *
59893
+ * Gets current value of property {@link #getAltKey altKey}.
59894
+ *
59895
+ * If it is set to `true`, the Alt Key modifier will be used
59896
+ */
59897
+ getAltKey(): boolean;
59898
+ /**
59899
+ * @SINCE 1.97
59900
+ *
59901
+ * Gets current value of property {@link #getCtrlKey ctrlKey}.
59902
+ *
59903
+ * If it is set to `true`, the Control Key modifier will be used
59904
+ */
59905
+ getCtrlKey(): boolean;
59906
+ /**
59907
+ * @SINCE 1.97
59908
+ *
59909
+ * Gets current value of property {@link #getShiftKey shiftKey}.
59910
+ *
59911
+ * If it is set to `true`, the Shift Key modifier will be used
59912
+ */
59913
+ getShiftKey(): boolean;
59914
+ /**
59915
+ * @SINCE 1.97
59916
+ *
59917
+ * Sets a new value for property {@link #getAltKey altKey}.
59918
+ *
59919
+ * If it is set to `true`, the Alt Key modifier will be used
59920
+ *
59921
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
59922
+ */
59923
+ setAltKey(
59924
+ /**
59925
+ * New value for property `altKey`
59926
+ */
59927
+ bAltKey: boolean
59928
+ ): this;
59929
+ /**
59930
+ * @SINCE 1.97
59931
+ *
59932
+ * Sets a new value for property {@link #getCtrlKey ctrlKey}.
59933
+ *
59934
+ * If it is set to `true`, the Control Key modifier will be used
59935
+ *
59936
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
59937
+ */
59938
+ setCtrlKey(
59939
+ /**
59940
+ * New value for property `ctrlKey`
59941
+ */
59942
+ bCtrlKey: boolean
59943
+ ): this;
59944
+ /**
59945
+ * @SINCE 1.97
59946
+ *
59947
+ * Sets a new value for property {@link #getShiftKey shiftKey}.
59948
+ *
59949
+ * If it is set to `true`, the Shift Key modifier will be used
59950
+ *
59951
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
59952
+ */
59953
+ setShiftKey(
59954
+ /**
59955
+ * New value for property `shiftKey`
59956
+ */
59957
+ bShiftKey: boolean
59958
+ ): this;
59396
59959
  }
59397
59960
 
59398
- export interface $PressSettings extends $ActionSettings {}
59961
+ export interface $PressSettings extends $ActionSettings {
59962
+ /**
59963
+ * @SINCE 1.97
59964
+ *
59965
+ * If it is set to `true`, the Alt Key modifier will be used
59966
+ */
59967
+ altKey?: boolean | PropertyBindingInfo;
59968
+
59969
+ /**
59970
+ * @SINCE 1.97
59971
+ *
59972
+ * If it is set to `true`, the Shift Key modifier will be used
59973
+ */
59974
+ shiftKey?: boolean | PropertyBindingInfo;
59975
+
59976
+ /**
59977
+ * @SINCE 1.97
59978
+ *
59979
+ * If it is set to `true`, the Control Key modifier will be used
59980
+ */
59981
+ ctrlKey?: boolean | PropertyBindingInfo;
59982
+ }
59399
59983
  }
59400
59984
 
59401
59985
  declare module "sap/ui/test/actions/Scroll" {
@@ -60600,7 +61184,8 @@ declare module "sap/ui/test/matchers/I18NText" {
60600
61184
  * The I18NText matcher checks if a control property has the same value as a text from an I18N file.
60601
61185
  *
60602
61186
  * The matcher automatically:
60603
- * - retrieves the text from the assigned 'i18n' model (name can be changed)
61187
+ * - retrieves the text from the assigned 'i18n' model (name can be changed) or library resource bundle
61188
+ *
60604
61189
  * - checks that the I18N key does actually exist in the file
60605
61190
  * - checks if asynchronously loaded I18N have actually been loaded
60606
61191
  *
@@ -60615,6 +61200,10 @@ declare module "sap/ui/test/matchers/I18NText" {
60615
61200
  * }
60616
61201
  * }
60617
61202
  * ```
61203
+ *
61204
+ *
61205
+ * As of version 1.95 if the `useLibraryBundle` flag is set to `true`, the library resource bundle of the
61206
+ * control is used to resolve the i18n key.
60618
61207
  */
60619
61208
  export default class I18NText extends Matcher {
60620
61209
  /**
@@ -60680,6 +61269,12 @@ declare module "sap/ui/test/matchers/I18NText" {
60680
61269
  * The name of the control property to match the I18N text with.
60681
61270
  */
60682
61271
  getPropertyName(): string;
61272
+ /**
61273
+ * Gets current value of property {@link #getUseLibraryBundle useLibraryBundle}.
61274
+ *
61275
+ * The boolean flag to indicate whether to utiliize the library bundle of the control
61276
+ */
61277
+ getUseLibraryBundle(): boolean;
60683
61278
  /**
60684
61279
  * Checks if the control has a property that matches the I18N text
60685
61280
  */
@@ -60743,6 +61338,19 @@ declare module "sap/ui/test/matchers/I18NText" {
60743
61338
  */
60744
61339
  sPropertyName: string
60745
61340
  ): this;
61341
+ /**
61342
+ * Sets a new value for property {@link #getUseLibraryBundle useLibraryBundle}.
61343
+ *
61344
+ * The boolean flag to indicate whether to utiliize the library bundle of the control
61345
+ *
61346
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
61347
+ */
61348
+ setUseLibraryBundle(
61349
+ /**
61350
+ * New value for property `useLibraryBundle`
61351
+ */
61352
+ bUseLibraryBundle: boolean
61353
+ ): this;
60746
61354
  }
60747
61355
 
60748
61356
  export interface $I18NTextSettings extends $MatcherSettings {
@@ -60765,6 +61373,11 @@ declare module "sap/ui/test/matchers/I18NText" {
60765
61373
  * The name of the {@link sap.ui.model.resource.ResourceModel} assigned to the control.
60766
61374
  */
60767
61375
  modelName?: string | PropertyBindingInfo;
61376
+
61377
+ /**
61378
+ * The boolean flag to indicate whether to utiliize the library bundle of the control
61379
+ */
61380
+ useLibraryBundle?: boolean | PropertyBindingInfo;
60768
61381
  }
60769
61382
  }
60770
61383
 
@@ -65512,8 +66125,8 @@ declare namespace sap {
65512
66125
  * to represent an individual folder. In other words: when a resource name is converted to a URL, any dots
65513
66126
  * ('.') are converted to slashes ('/').
65514
66127
  *
65515
- * **Limitation:** For the time being, the **application root folder** is assumed to be the same as the
65516
- * folder where the current page resides in.
66128
+ * **Note:** The **application root folder** is assumed to be the same as the folder where the current page
66129
+ * resides in.
65517
66130
  *
65518
66131
  * Usage sample:
65519
66132
  * ```javascript
@@ -65531,12 +66144,7 @@ declare namespace sap {
65531
66144
  *
65532
66145
  *
65533
66146
  * When applications need a more flexible mapping between resource names and their location, they can use
65534
- * {@link jQuery.sap.registerModulePath}.
65535
- *
65536
- * It is intended to make this configuration obsolete in future releases, but for the time being, applications
65537
- * must call this method when they want to store resources relative to the assumed application root folder.
65538
- * See:
65539
- * jQuery.sap.registerModulePath
66147
+ * {@link sap.ui.loader.config} with option `paths`.
65540
66148
  */
65541
66149
  function localResources(
65542
66150
  /**
@@ -65622,13 +66230,13 @@ declare namespace sap {
65622
66230
  * Returns the URL of a resource that belongs to the given library and has the given relative location within
65623
66231
  * the library. This is mainly meant for static resources like images that are inside the library. It is
65624
66232
  * NOT meant for access to JavaScript modules or anything for which a different URL has been registered
65625
- * with jQuery.sap.registerModulePath(). For these cases use jQuery.sap.getModulePath(). It DOES work, however,
66233
+ * with sap.ui.loader.config({paths:...}). For these cases use sap.ui.require.toUrl(). It DOES work, however,
65626
66234
  * when the given sResourcePath starts with "themes/" (= when it is a theme-dependent resource). Even when
65627
66235
  * for this theme a different location outside the normal library location is configured.
65628
66236
  */
65629
66237
  function resource(
65630
66238
  /**
65631
- * the name of a library, like "sap.ui.commons"
66239
+ * the name of a library, like "sap.ui.layout"
65632
66240
  */
65633
66241
  sLibraryName: string,
65634
66242
  /**
@@ -65647,7 +66255,7 @@ declare namespace sap {
65647
66255
  *
65648
66256
  * <div id="SAPUI5UiArea"></div>
65649
66257
  * <script>
65650
- * var oRoot = new sap.ui.commons.Label();
66258
+ * var oRoot = new sap.m.Label();
65651
66259
  * oRoot.setText("Hello world!");
65652
66260
  * sap.ui.setRoot("SAPUI5UiArea", oRoot);
65653
66261
  * </script>
@@ -66160,8 +66768,8 @@ declare namespace sap {
66160
66768
  *
66161
66769
  * The SAPUI5 Core Runtime.
66162
66770
  *
66163
- * Contains the UI5 jQuery plugins (jQuery.sap.*), the Core and all its components, base classes for Controls,
66164
- * Components and the Model View Controller classes.
66771
+ * Contains the UI5 Core and all its components, base classes for Controls, Components and the Model View
66772
+ * Controller classes.
66165
66773
  */
66166
66774
  namespace core {
66167
66775
  /**
@@ -66420,11 +67028,11 @@ declare namespace sap {
66420
67028
  /**
66421
67029
  * The SAPUI5 Data Binding API.
66422
67030
  *
66423
- * The default binding mode for model implementations (if not implemented otherwise) is two way and the
66424
- * supported binding modes by the model are one way, two way and one time. The default binding mode can
67031
+ * The default binding mode for model implementations (if not implemented otherwise) is two-way and the
67032
+ * supported binding modes by the model are one-way, two-way and one-time. The default binding mode can
66425
67033
  * be changed by the application for each model instance. A model implementation should specify its supported
66426
- * binding modes and set the default binding mode accordingly (e.g. if the model supports only one way binding
66427
- * the default binding mode should also be set to one way).
67034
+ * binding modes and set the default binding mode accordingly (e.g. if the model supports only one-way binding
67035
+ * the default binding mode should also be set to one-way).
66428
67036
  *
66429
67037
  * The default size limit for models is 100. The size limit determines the number of entries used for the
66430
67038
  * list bindings.