@openui5/ts-types 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
  /**
@@ -5348,8 +5348,8 @@ declare namespace sap {
5348
5348
  * to represent an individual folder. In other words: when a resource name is converted to a URL, any dots
5349
5349
  * ('.') are converted to slashes ('/').
5350
5350
  *
5351
- * **Limitation:** For the time being, the **application root folder** is assumed to be the same as the
5352
- * folder where the current page resides in.
5351
+ * **Note:** The **application root folder** is assumed to be the same as the folder where the current page
5352
+ * resides in.
5353
5353
  *
5354
5354
  * Usage sample:
5355
5355
  * ```javascript
@@ -5367,12 +5367,7 @@ declare namespace sap {
5367
5367
  *
5368
5368
  *
5369
5369
  * When applications need a more flexible mapping between resource names and their location, they can use
5370
- * {@link jQuery.sap.registerModulePath}.
5371
- *
5372
- * It is intended to make this configuration obsolete in future releases, but for the time being, applications
5373
- * must call this method when they want to store resources relative to the assumed application root folder.
5374
- * See:
5375
- * jQuery.sap.registerModulePath
5370
+ * {@link sap.ui.loader.config} with option `paths`.
5376
5371
  */
5377
5372
  function localResources(
5378
5373
  /**
@@ -5458,13 +5453,13 @@ declare namespace sap {
5458
5453
  * Returns the URL of a resource that belongs to the given library and has the given relative location within
5459
5454
  * the library. This is mainly meant for static resources like images that are inside the library. It is
5460
5455
  * NOT meant for access to JavaScript modules or anything for which a different URL has been registered
5461
- * with jQuery.sap.registerModulePath(). For these cases use jQuery.sap.getModulePath(). It DOES work, however,
5456
+ * with sap.ui.loader.config({paths:...}). For these cases use sap.ui.require.toUrl(). It DOES work, however,
5462
5457
  * when the given sResourcePath starts with "themes/" (= when it is a theme-dependent resource). Even when
5463
5458
  * for this theme a different location outside the normal library location is configured.
5464
5459
  */
5465
5460
  function resource(
5466
5461
  /**
5467
- * the name of a library, like "sap.ui.commons"
5462
+ * the name of a library, like "sap.ui.layout"
5468
5463
  */
5469
5464
  sLibraryName: string,
5470
5465
  /**
@@ -5483,7 +5478,7 @@ declare namespace sap {
5483
5478
  *
5484
5479
  * <div id="SAPUI5UiArea"></div>
5485
5480
  * <script>
5486
- * var oRoot = new sap.ui.commons.Label();
5481
+ * var oRoot = new sap.m.Label();
5487
5482
  * oRoot.setText("Hello world!");
5488
5483
  * sap.ui.setRoot("SAPUI5UiArea", oRoot);
5489
5484
  * </script>
@@ -7426,8 +7421,8 @@ declare namespace sap {
7426
7421
  * **'library'** : string
7427
7422
  * Name of the library that the new subclass should belong to. If the subclass is a control or element,
7428
7423
  * it will automatically register with that library so that authoring tools can discover it. By convention,
7429
- * the name of the subclass should have the library name as a prefix, e.g. 'sap.ui.commons.Panel' belongs
7430
- * to library 'sap.ui.commons'.
7424
+ * the name of the subclass should have the library name as a prefix, but subfolders are allowed, e.g. `sap.ui.layout.form.Form`
7425
+ * belongs to library `sap.ui.layout`.
7431
7426
  *
7432
7427
  * **'properties'** : object
7433
7428
  * An object literal whose properties each define a new managed property in the ManagedObject subclass.
@@ -10201,8 +10196,8 @@ declare namespace sap {
10201
10196
  *
10202
10197
  * The SAPUI5 Core Runtime.
10203
10198
  *
10204
- * Contains the UI5 jQuery plugins (jQuery.sap.*), the Core and all its components, base classes for Controls,
10205
- * Components and the Model View Controller classes.
10199
+ * Contains the UI5 Core and all its components, base classes for Controls, Components and the Model View
10200
+ * Controller classes.
10206
10201
  */
10207
10202
  namespace core {
10208
10203
  /**
@@ -13351,9 +13346,9 @@ declare namespace sap {
13351
13346
  */
13352
13347
  setMessages(
13353
13348
  /**
13354
- * map of messages: {'target': [array of messages],...}
13349
+ * map of messages: {'target': [sap.ui.core.message.Message],...}
13355
13350
  */
13356
- vMessages: Record<string, any[]>
13351
+ mMessages: Record<string, sap.ui.core.message.Message[]>
13357
13352
  ): void;
13358
13353
  }
13359
13354
 
@@ -13930,7 +13925,16 @@ declare namespace sap {
13930
13925
  /**
13931
13926
  * Parameters to pass along with the event
13932
13927
  */
13933
- oParameters?: object
13928
+ mParameters: {
13929
+ /**
13930
+ * Messages already existing before the `messageChange` event was fired.
13931
+ */
13932
+ oldMessages: sap.ui.core.message.Message;
13933
+ /**
13934
+ * New messages added by the trigger of the `messageChange` event.
13935
+ */
13936
+ newMessages: sap.ui.core.message.Message;
13937
+ }
13934
13938
  ): this;
13935
13939
  /**
13936
13940
  * Returns the ID of the MessageProcessor instance
@@ -13941,9 +13945,9 @@ declare namespace sap {
13941
13945
  */
13942
13946
  setMessages(
13943
13947
  /**
13944
- * map of messages: {'target': [array of messages],...}
13948
+ * map of messages: {'target': [sap.ui.core.message.Message],...}
13945
13949
  */
13946
- vMessages: Record<string, any[]>
13950
+ mMessages: Record<string, sap.ui.core.message.Message[]>
13947
13951
  ): void;
13948
13952
  }
13949
13953
  }
@@ -14213,7 +14217,7 @@ declare namespace sap {
14213
14217
  * **Example for a callback module definition (sync):**
14214
14218
  * ```javascript
14215
14219
  *
14216
- * sap.ui.define("my/custom/sync/ExtensionProvider", ['jquery.sap.global'], function(jQuery) {
14220
+ * sap.ui.define("my/custom/sync/ExtensionProvider", [], function() {
14217
14221
  * var ExtensionProvider = function() {};
14218
14222
  * ExtensionProvider.prototype.getControllerExtensions = function(sControllerName, sComponentId, bAsync) {
14219
14223
  * if (!bAsync && sControllerName == "my.own.Controller") {
@@ -14232,14 +14236,14 @@ declare namespace sap {
14232
14236
  * }];
14233
14237
  * };
14234
14238
  * return ExtensionProvider;
14235
- * }, true);
14239
+ * });
14236
14240
  * ```
14237
14241
  *
14238
14242
  *
14239
14243
  * **Example for a callback module definition (async):**
14240
14244
  * ```javascript
14241
14245
  *
14242
- * sap.ui.define("my/custom/async/ExtensionProvider", ['jquery.sap.global'], function(jQuery) {
14246
+ * sap.ui.define("my/custom/async/ExtensionProvider", [], function() {
14243
14247
  * var ExtensionProvider = function() {};
14244
14248
  * ExtensionProvider.prototype.getControllerExtensions = function(sControllerName, sComponentId, bAsync) {
14245
14249
  * if (bAsync && sControllerName == "my.own.Controller") {
@@ -14263,7 +14267,7 @@ declare namespace sap {
14263
14267
  * };
14264
14268
  * };
14265
14269
  * return ExtensionProvider;
14266
- * }, true);
14270
+ * });
14267
14271
  * ```
14268
14272
  *
14269
14273
  *
@@ -14927,6 +14931,11 @@ declare namespace sap {
14927
14931
  * #byId}, elements or controls can be found with their view-local ID. Also see {@link topic:91f28be26f4d1014b6dd926db0e91070
14928
14932
  * "Support for Unique IDs"} in the documentation.
14929
14933
  *
14934
+ * **Note: For Views defined using XML markup** On root level, you can only define content for the default
14935
+ * aggregation, e.g. without adding the `<content>` tag. If you want to specify content for another
14936
+ * aggregation of a view like `dependents`, place it in a child control's dependents aggregation or add
14937
+ * it by using {@link sap.ui.core.mvc.XMLView.addDependent}.
14938
+ *
14930
14939
  * View Definition: A view can be defined by {@link sap.ui.core.mvc.View.extend extending} this class and
14931
14940
  * implementing the {@link #createContent} method. The method must return one or many root controls that
14932
14941
  * will be rendered as content of the view.
@@ -16039,11 +16048,22 @@ declare namespace sap {
16039
16048
  */
16040
16049
  interface Parameters {
16041
16050
  /**
16042
- * Returns the current value for one or more theming parameters, depending on the given arguments. The synchronous
16043
- * usage of this API has been deprecated and only the asynchronous usage should still be used (see the 4th
16044
- * bullet point and the code examples below).
16051
+ * Returns the current value for one or more theming parameters, depending on the given arguments. The
16052
+ * synchronous usage of this API has been deprecated and only the asynchronous usage should still be used
16053
+ * (see the 4th bullet point and the code examples below).
16054
+ *
16055
+ * The theming parameters are immutable and cannot be changed at runtime. Multiple `Parameters.get()`
16056
+ * API calls for the same parameter name will always result in the same parameter value.
16057
+ *
16058
+ * **Important, since 1.93:** When using the `Parameters.get()` API to retrieve theming parameters defined
16059
+ * as CSS variables, please be aware that the API can also unknowingly retrieve arbitrary CSS variables
16060
+ * defined in the DOM. All CSS variables defined via the `:root` pseudo-class can be retrieved this way.
16061
+ * Please make sure to only access theming parameters defined in a UI5 theme/library.
16062
+ *
16063
+ *
16045
16064
  *
16046
16065
  *
16066
+ * The following API variants are available (see also the below examples):
16047
16067
  * - **(deprecated since 1.92)** If no parameter is given a key-value map containing all parameters is
16048
16068
  * returned
16049
16069
  * - **(deprecated since 1.94)** If a `string` is given as first parameter the value is returned as a
@@ -16054,8 +16074,9 @@ declare namespace sap {
16054
16074
  * are loaded and available or within the callback in case not all CSS files are already loaded. This is
16055
16075
  * the **only asynchronous** API variant. This variant is the preferred way to retrieve theming parameters.
16056
16076
  * The structure of the return value is the same as listed above depending on the type of the name property
16057
- * within the `object`. The returned key-value maps are a copy so changing values in the map does
16058
- * not have any effect
16077
+ * within the `object`.
16078
+ *
16079
+ * The returned key-value maps are a copy so changing values in the map does not have any effect
16059
16080
  *
16060
16081
  * Please see the examples below for a detailed guide on how to use the **asynchronous variant** of
16061
16082
  * the API.
@@ -16138,6 +16159,8 @@ declare namespace sap {
16138
16159
 
16139
16160
  namespace Component {
16140
16161
  /**
16162
+ * @SINCE 1.67
16163
+ *
16141
16164
  * Registry of all `Component`s that currently exist.
16142
16165
  */
16143
16166
  interface registry {
@@ -16568,6 +16591,8 @@ declare namespace sap {
16568
16591
 
16569
16592
  namespace Element {
16570
16593
  /**
16594
+ * @SINCE 1.67
16595
+ *
16571
16596
  * Registry of all `sap.ui.core.Element`s that currently exist.
16572
16597
  */
16573
16598
  interface registry {
@@ -18200,7 +18225,7 @@ declare namespace sap {
18200
18225
  * The hash to be matched
18201
18226
  */
18202
18227
  sHash: string
18203
- ): object | undefined;
18228
+ ): sap.ui.core.routing.RouteInfo | undefined;
18204
18229
  /**
18205
18230
  * Returns a target by its name.
18206
18231
  *
@@ -19435,6 +19460,17 @@ declare namespace sap {
19435
19460
  fullHash?: string;
19436
19461
  };
19437
19462
 
19463
+ type RouteInfo = {
19464
+ /**
19465
+ * The route name
19466
+ */
19467
+ name: string;
19468
+ /**
19469
+ * The route data
19470
+ */
19471
+ arguments: Record<string, string>;
19472
+ };
19473
+
19438
19474
  /**
19439
19475
  * @SINCE 1.84.0
19440
19476
  *
@@ -24487,6 +24523,8 @@ declare namespace sap {
24487
24523
  sId: sap.ui.core.ID | null | undefined
24488
24524
  ): sap.ui.core.Element | undefined;
24489
24525
  /**
24526
+ * @deprecated (since 1.95) - Please use {@link sap.ui.core.Component.create Component.create} instead.
24527
+ *
24490
24528
  * Creates a component with the provided id and settings.
24491
24529
  *
24492
24530
  * When the optional parameter `sUrl` is given, then all request for resources of the library will be redirected
@@ -24540,7 +24578,7 @@ declare namespace sap {
24540
24578
  * the settings object for the component
24541
24579
  */
24542
24580
  mSettings?: object
24543
- ): void;
24581
+ ): sap.ui.core.Component;
24544
24582
  /**
24545
24583
  * Returns a new instance of the RenderManager for exclusive use by the caller.
24546
24584
  *
@@ -24812,6 +24850,8 @@ declare namespace sap {
24812
24850
  */
24813
24851
  getApplication(): sap.ui.app.Application;
24814
24852
  /**
24853
+ * @deprecated (since 1.95) - Please use {@link sap.ui.core.Component.get Component.get} instead.
24854
+ *
24815
24855
  * Returns the registered component for the given id, if any.
24816
24856
  */
24817
24857
  getComponent(sId: string): sap.ui.core.Component;
@@ -24932,6 +24972,9 @@ declare namespace sap {
24932
24972
  */
24933
24973
  getRenderManager(): void;
24934
24974
  /**
24975
+ * @deprecated (since 1.95) - Please use {@link module:sap/ui/core/ComponentSupport} instead. See also {@link
24976
+ * topic:82a0fcecc3cb427c91469bc537ebdddf Declarative API for Initial Components}.
24977
+ *
24935
24978
  * Returns the instance of the root component (if exists).
24936
24979
  */
24937
24980
  getRootComponent(): sap.ui.core.Component;
@@ -25181,7 +25224,7 @@ declare namespace sap {
25181
25224
  */
25182
25225
  loadLibrary(
25183
25226
  /**
25184
- * name of the library to load
25227
+ * Name of the library to load
25185
25228
  */
25186
25229
  sLibrary: string,
25187
25230
  /**
@@ -25191,16 +25234,16 @@ declare namespace sap {
25191
25234
  | string
25192
25235
  | boolean
25193
25236
  | {
25194
- /**
25195
- * URL to load the library from
25196
- */
25197
- url?: string;
25198
25237
  /**
25199
25238
  * Whether to load the library asynchronously
25200
25239
  */
25201
25240
  async?: boolean;
25241
+ /**
25242
+ * URL to load the library from
25243
+ */
25244
+ url?: string;
25202
25245
  }
25203
- ): Object | Promise<any>;
25246
+ ): object | Promise<object>;
25204
25247
  /**
25205
25248
  * Locks the Core. No browser events are dispatched to the controls.
25206
25249
  *
@@ -25621,6 +25664,23 @@ declare namespace sap {
25621
25664
  */
25622
25665
  collectionName?: string
25623
25666
  ): string;
25667
+ /**
25668
+ * Adds CSS code to load an icon font to the DOM
25669
+ */
25670
+ insertFontFaceStyle(
25671
+ /**
25672
+ * the file name of the font face
25673
+ */
25674
+ sFontFace: string,
25675
+ /**
25676
+ * the path to the font file
25677
+ */
25678
+ sPath: string,
25679
+ /**
25680
+ * the collection name, if not specified the font face is used
25681
+ */
25682
+ sCollectionName?: string
25683
+ ): void;
25624
25684
  /**
25625
25685
  * Returns whether the given `uri` is an icon URI.
25626
25686
  *
@@ -27261,12 +27321,6 @@ declare namespace sap {
27261
27321
  * Container width in CSS size
27262
27322
  */
27263
27323
  getWidth(): sap.ui.core.CSSSize;
27264
- /**
27265
- * @SINCE 1.91
27266
- *
27267
- * Hides the placeholder that is shown on the component container.
27268
- */
27269
- hidePlaceholder(): void;
27270
27324
  /**
27271
27325
  * Sets a new value for property {@link #getAsync async}.
27272
27326
  *
@@ -27471,22 +27525,6 @@ declare namespace sap {
27471
27525
  */
27472
27526
  sWidth?: sap.ui.core.CSSSize
27473
27527
  ): this;
27474
- /**
27475
- * @SINCE 1.91
27476
- *
27477
- * Shows the provided placeholder on the component container.
27478
- */
27479
- showPlaceholder(
27480
- /**
27481
- * Object containing the placeholder object
27482
- */
27483
- mSettings: {
27484
- /**
27485
- * The placeholder instance
27486
- */
27487
- placeholder: /* was: sap.ui.core.Placeholder */ any;
27488
- }
27489
- ): Promise<any>;
27490
27528
  }
27491
27529
  /**
27492
27530
  * @SINCE 1.9.2
@@ -27782,7 +27820,8 @@ declare namespace sap {
27782
27820
  */
27783
27821
  getAppCacheBusterMode(): string;
27784
27822
  /**
27785
- * @deprecated (since 1.15.1) - Please use the rootComponent configuration option {@link sap.ui.core.Configuration#getRootComponent}.
27823
+ * @deprecated (since 1.15.1) - Please use {@link module:sap/ui/core/ComponentSupport} instead. See also
27824
+ * {@link topic:82a0fcecc3cb427c91469bc537ebdddf Declarative API for Initial Components}.
27786
27825
  *
27787
27826
  * The name of the application to start or empty.
27788
27827
  */
@@ -27896,7 +27935,8 @@ declare namespace sap {
27896
27935
  */
27897
27936
  getOriginInfo(): boolean;
27898
27937
  /**
27899
- * @EXPERIMENTAL (since 1.15.1)
27938
+ * @deprecated (since 1.95) - Please use {@link module:sap/ui/core/ComponentSupport} instead. See also {@link
27939
+ * topic:82a0fcecc3cb427c91469bc537ebdddf Declarative API for Initial Components}.
27900
27940
  *
27901
27941
  * The name of the root component to start or empty.
27902
27942
  */
@@ -27914,6 +27954,14 @@ declare namespace sap {
27914
27954
  * It will be returned in uppercase. e.g. "EN", "DE"
27915
27955
  */
27916
27956
  getSAPLogonLanguage(): string;
27957
+ /**
27958
+ * @SINCE 1.95.0
27959
+ *
27960
+ * Returns the security token handlers of an OData V4 model.
27961
+ * See:
27962
+ * #setSecurityTokenHandlers
27963
+ */
27964
+ getSecurityTokenHandlers(): Function[];
27917
27965
  /**
27918
27966
  * Returns the theme name
27919
27967
  */
@@ -28064,6 +28112,20 @@ declare namespace sap {
28064
28112
  */
28065
28113
  bRTL: boolean | null
28066
28114
  ): this;
28115
+ /**
28116
+ * @SINCE 1.95.0
28117
+ *
28118
+ * Sets the security token handlers for an OData V4 model. See chapter "Security Token Handling" in {@link
28119
+ * topic:9613f1f2d88747cab21896f7216afdac Model Instantiation and Data Access}.
28120
+ * See:
28121
+ * #getSecurityTokenHandlers
28122
+ */
28123
+ setSecurityTokenHandlers(
28124
+ /**
28125
+ * The security token handlers
28126
+ */
28127
+ aSecurityTokenHandlers: Function[]
28128
+ ): void;
28067
28129
  }
28068
28130
  /**
28069
28131
  * Base Class for Controls.
@@ -28266,9 +28328,9 @@ declare namespace sap {
28266
28328
  * **IMPORTANT:**
28267
28329
  * This should be only used as FALLBACK when the Control events do not cover a specific use-case! Always
28268
28330
  * try using SAPUI5 control events, as e.g. accessibility-related functionality is then provided automatically.
28269
- * E.g. when working with a `sap.ui.commons.Button`, always use the Button's "press" event, not the native
28270
- * "click" event, because "press" is also guaranteed to be fired when certain keyboard activity is supposed
28271
- * to trigger the Button.
28331
+ * E.g. when working with a `sap.m.Button`, always use the Button's "press" event, not the native "click"
28332
+ * event, because "press" is also guaranteed to be fired when certain keyboard activity is supposed to trigger
28333
+ * the Button.
28272
28334
  *
28273
28335
  * In the event handler, `this` refers to the Control - not to the root DOM element like in jQuery. While
28274
28336
  * the DOM element can be used and modified, the general caveats for working with SAPUI5 control DOM elements
@@ -34483,6 +34545,9 @@ declare namespace sap {
34483
34545
  * When an <img> tag is rendered, the following two attributes are added by default and can be overwritten
34484
34546
  * with corresponding values in the `mAttributes` parameter:
34485
34547
  * - `role: "presentation"` `alt: ""`
34548
+ *
34549
+ * **Note:** This function requires the {@link sap.ui.core.IconPool} module. Ensure that the module is loaded
34550
+ * before this function is called to avoid syncXHRs.
34486
34551
  */
34487
34552
  icon(
34488
34553
  /**
@@ -34753,7 +34818,7 @@ declare namespace sap {
34753
34818
  *
34754
34819
  * Writes the attribute and its value into the HTML.
34755
34820
  *
34756
- * For details about the escaping refer to {@link jQuery.sap.encodeHTML}
34821
+ * For details about the escaping refer to {@link sap/base/security/encodeXML}.
34757
34822
  */
34758
34823
  writeAttribute(
34759
34824
  /**
@@ -34831,7 +34896,7 @@ declare namespace sap {
34831
34896
  *
34832
34897
  * Escape text for HTML and write it to the buffer.
34833
34898
  *
34834
- * For details about the escaping refer to {@link jQuery.sap.encodeHTML}
34899
+ * For details about the escaping refer to {@link sap/base/security/encodeXML}.
34835
34900
  */
34836
34901
  writeEscaped(
34837
34902
  /**
@@ -35845,7 +35910,7 @@ declare namespace sap {
35845
35910
  /**
35846
35911
  * Returns this `UIArea`'s id (as determined from provided RootNode).
35847
35912
  */
35848
- getId(): string | null;
35913
+ getId(): string;
35849
35914
  /**
35850
35915
  * @deprecated (since 1.1) - use function {@link #getContent} instead
35851
35916
  *
@@ -36130,7 +36195,7 @@ declare namespace sap {
36130
36195
  * A `sap.ui.core.UIComponent` subclass can additionally implement the {@link sap.ui.core.IAsyncContentCreation}
36131
36196
  * interface. When implementing this interface the loading and processing of an asynchronous `rootView`
36132
36197
  * will be chained into the result Promise of the {@link sap.ui.core.Component.create Component.create}
36133
- * factory. See Sample 1 below.
36198
+ * factory. An additional async flag can be omitted. See Sample 1 below.
36134
36199
  *
36135
36200
  * Samples 2 and 3 show how subclasses can overwrite the `createContent` function to run asynchronously.
36136
36201
  * To create the root control asynchronously, the subclass has to define the `sap.ui.core.IAsyncContentCreation`
@@ -37885,11 +37950,11 @@ declare namespace sap {
37885
37950
  /**
37886
37951
  * The SAPUI5 Data Binding API.
37887
37952
  *
37888
- * The default binding mode for model implementations (if not implemented otherwise) is two way and the
37889
- * supported binding modes by the model are one way, two way and one time. The default binding mode can
37953
+ * The default binding mode for model implementations (if not implemented otherwise) is two-way and the
37954
+ * supported binding modes by the model are one-way, two-way and one-time. The default binding mode can
37890
37955
  * be changed by the application for each model instance. A model implementation should specify its supported
37891
- * binding modes and set the default binding mode accordingly (e.g. if the model supports only one way binding
37892
- * the default binding mode should also be set to one way).
37956
+ * binding modes and set the default binding mode accordingly (e.g. if the model supports only one-way binding
37957
+ * the default binding mode should also be set to one-way).
37893
37958
  *
37894
37959
  * The default size limit for models is 100. The size limit determines the number of entries used for the
37895
37960
  * list bindings.
@@ -40058,7 +40123,9 @@ declare namespace sap {
40058
40123
  ): any[];
40059
40124
  }
40060
40125
  /**
40061
- * Model implementation for JSON format
40126
+ * Model implementation for the JSON format.
40127
+ *
40128
+ * This model is not prepared to be inherited from.
40062
40129
  */
40063
40130
  class JSONModel extends sap.ui.model.ClientModel {
40064
40131
  /**
@@ -40300,7 +40367,9 @@ declare namespace sap {
40300
40367
  */
40301
40368
  namespace message {
40302
40369
  /**
40303
- * Model implementation for Messages
40370
+ * Model implementation for Messages.
40371
+ *
40372
+ * This model is not prepared to be inherited from.
40304
40373
  */
40305
40374
  class MessageModel extends sap.ui.model.ClientModel {
40306
40375
  /**
@@ -40339,17 +40408,17 @@ declare namespace sap {
40339
40408
  */
40340
40409
  static getMetadata(): sap.ui.base.Metadata;
40341
40410
  /**
40342
- * Returns the value for the property with the given `sPropertyName`
40411
+ * Returns the value for the property with the given `sPropertyName`.
40343
40412
  */
40344
40413
  getProperty(
40345
40414
  /**
40346
- * the path to the property
40415
+ * The path to the property
40347
40416
  */
40348
40417
  sPath: string,
40349
40418
  /**
40350
- * the context which will be used to retrieve the property
40419
+ * The context to resolve a relative path with
40351
40420
  */
40352
- oContext?: object
40421
+ oContext?: sap.ui.model.Context
40353
40422
  ): any;
40354
40423
  /**
40355
40424
  * Sets the message data to the model.
@@ -40366,7 +40435,20 @@ declare namespace sap {
40366
40435
  * Other models provide this method to set a new value for a specific property. `MessageModel` does not
40367
40436
  * support it as it supports the `OneWay` mode only.
40368
40437
  */
40369
- setProperty(): void;
40438
+ setProperty(
40439
+ /**
40440
+ * Unused in this implementation
40441
+ */
40442
+ sPath: string,
40443
+ /**
40444
+ * Unused in this implementation
40445
+ */
40446
+ oValue: object,
40447
+ /**
40448
+ * Unused in this implementation
40449
+ */
40450
+ oContext: sap.ui.model.Context
40451
+ ): void;
40370
40452
  }
40371
40453
  }
40372
40454
  /**
@@ -42889,6 +42971,8 @@ declare namespace sap {
42889
42971
  * A context for the OData V2 model cannot be created at will, it has to be retrieved via:
42890
42972
  * - an OData binding
42891
42973
  * - a view element
42974
+ * - {@link sap.ui.model.odata.v2.ODataListBinding#create}
42975
+ * - {@link sap.ui.model.odata.v2.ODataModel#callFunction}
42892
42976
  * - {@link sap.ui.model.odata.v2.ODataModel#createBindingContext}
42893
42977
  * - {@link sap.ui.model.odata.v2.ODataModel#createEntry}
42894
42978
  */
@@ -42920,12 +43004,30 @@ declare namespace sap {
42920
43004
  * Returns a metadata object for class sap.ui.model.odata.v2.Context.
42921
43005
  */
42922
43006
  static getMetadata(): sap.ui.base.Metadata;
43007
+ /**
43008
+ * @SINCE 1.96.0
43009
+ *
43010
+ * Returns a promise on the creation state of this context if it has been created via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
43011
+ * or {@link sap.ui.model.odata.v2.ODataListBinding#create}; otherwise returns `undefined`.
43012
+ *
43013
+ * As long as the promise is not yet resolved or rejected, the entity represented by this context is transient.
43014
+ *
43015
+ * Once the promise is resolved, the entity for this context is stored in the back end and {@link #getPath}
43016
+ * returns a path including the key predicate of the new entity.
43017
+ *
43018
+ * If the context has been created via {@link sap.ui.model.odata.v2.ODataListBinding#create} and the entity
43019
+ * for this context has been stored in the back end, {@link #created} returns `undefined` after the data
43020
+ * has been re-read from the back end and inserted at the right position based on the list binding's filters
43021
+ * and sorters. If the context has been created via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
43022
+ * and the entity for this context has been stored in the back end, {@link #created} returns `undefined`.
43023
+ */
43024
+ created(): Promise<any>;
42923
43025
  /**
42924
43026
  * @SINCE 1.94.0
42925
43027
  *
42926
- * For a context created using {@link sap.ui.model.odata.v2.ODataModel#createEntry}, the method returns
42927
- * `true` if the context is transient or `false` if the context is not transient. A transient context represents
42928
- * an entity created on the client which has not been persisted in the back end.
43028
+ * For a context created using {@link sap.ui.model.odata.v2.ODataModel#createEntry} or {@link sap.ui.model.odata.v2.ODataListBinding#create},
43029
+ * the method returns `true` if the context is transient or `false` if the context is not transient. A transient
43030
+ * context represents an entity created on the client which has not been persisted in the back end.
42929
43031
  */
42930
43032
  isTransient(): boolean;
42931
43033
  }
@@ -43540,6 +43642,14 @@ declare namespace sap {
43540
43642
  * Defines the count mode of this binding; if not specified, the default count mode of the `oModel` is applied
43541
43643
  */
43542
43644
  countMode?: sap.ui.model.odata.CountMode;
43645
+ /**
43646
+ * A key used in combination with the resolved path of this binding to identify the entities created this
43647
+ * binding's {@link #create} method.
43648
+ *
43649
+ * **Note:** Different controls or control aggregation bindings to the same collection must have different
43650
+ * `createdEntitiesKey` values.
43651
+ */
43652
+ createdEntitiesKey?: string;
43543
43653
  /**
43544
43654
  * An optional map of custom query parameters. Custom parameters must not start with `$`
43545
43655
  */
@@ -43617,6 +43727,9 @@ declare namespace sap {
43617
43727
  * with AND. Usually this means, all filters applied to a single table column are combined with OR, while
43618
43728
  * filters on different table columns are combined with AND. Please note that a custom filter function is
43619
43729
  * only supported with operation mode `sap.ui.model.odata.OperationMode.Client`.
43730
+ *
43731
+ * Entities that have been created via {@link #create} and saved in the back end are removed from the creation
43732
+ * rows area and inserted at the right position based on the current filters and sorters.
43620
43733
  */
43621
43734
  filter(
43622
43735
  /**
@@ -43678,6 +43791,9 @@ declare namespace sap {
43678
43791
  * Refreshes the binding, check whether the model data has been changed and fire change event if this is
43679
43792
  * the case. For server side models this should refetch the data from the server. To update a control, even
43680
43793
  * if no data has been changed, e.g. to reset a control after failed validation, use the parameter `bForceUpdate`.
43794
+ *
43795
+ * Entities that have been created via {@link #create} and saved in the back end are removed from the creation
43796
+ * rows area and inserted at the right position based on the current filters and sorters.
43681
43797
  */
43682
43798
  refresh(
43683
43799
  /**
@@ -43709,6 +43825,9 @@ declare namespace sap {
43709
43825
  ): Promise<sap.ui.model.Filter>;
43710
43826
  /**
43711
43827
  * Sorts the list.
43828
+ *
43829
+ * Entities that have been created via {@link #create} and saved in the back end are removed from the creation
43830
+ * rows area and inserted at the right position based on the current filters and sorters.
43712
43831
  */
43713
43832
  sort(
43714
43833
  /**
@@ -43727,6 +43846,8 @@ declare namespace sap {
43727
43846
  * Model implementation based on the OData protocol.
43728
43847
  *
43729
43848
  * See chapter {@link topic:6c47b2b39db9404582994070ec3d57a2 OData V2 Model} for a general introduction.
43849
+ *
43850
+ * This model is not prepared to be inherited from.
43730
43851
  */
43731
43852
  class ODataModel extends sap.ui.model.Model {
43732
43853
  /**
@@ -44250,6 +44371,14 @@ declare namespace sap {
44250
44371
  * Count mode for this binding; if not specified, the default count mode for this model is used
44251
44372
  */
44252
44373
  countMode?: sap.ui.model.odata.CountMode;
44374
+ /**
44375
+ * A key used in combination with the resolved path of the binding to identify the entities created via
44376
+ * the binding's {@link #create} method.
44377
+ *
44378
+ * **Note:** Different controls or control aggregation bindings to the same collection must have different
44379
+ * `createdEntitiesKey` values.
44380
+ */
44381
+ createdEntitiesKey?: string;
44253
44382
  /**
44254
44383
  * Operation mode for this binding; if not specified, the default operation mode of this model is used
44255
44384
  */
@@ -44685,13 +44814,17 @@ declare namespace sap {
44685
44814
  * Whether to reload data
44686
44815
  */
44687
44816
  bReload?: boolean
44688
- ): sap.ui.model.odata.v2.Context;
44817
+ ): sap.ui.model.odata.v2.Context | undefined;
44689
44818
  /**
44690
44819
  * Creates a new entry object which is described by the metadata of the entity type of the specified `sPath`
44691
44820
  * Name. A context object is returned which can be used to bind against the newly created object.
44692
44821
  *
44693
44822
  * For each created entry a request is created and stored in a request queue. The request queue can be submitted
44694
- * by calling {@link #submitChanges}. To delete a created entry from the request queue call {@link #deleteCreatedEntry}.
44823
+ * by calling {@link #submitChanges}. As long as the context is transient (see {@link sap.ui.model.odata.v2.Context#isTransient}),
44824
+ * {@link sap.ui.model.odata.v2.ODataModel#resetChanges} with the `bDeleteCreatedEntities` parameter set
44825
+ * to `true` can be used to delete the created entity again.
44826
+ *
44827
+ * If the creation of the entity on the server failed, it is repeated automatically.
44695
44828
  *
44696
44829
  * The optional parameter `mParameters.properties` can be used as follows:
44697
44830
  * - `properties` could be an array containing the property names which should be included in the new
@@ -44702,7 +44835,7 @@ declare namespace sap {
44702
44835
  *
44703
44836
  * If there are no values specified, the properties will have `undefined` values.
44704
44837
  *
44705
- * Please note that deep creates (including data defined by navigation properties) are not supported.
44838
+ * The `properties` can be modified via property bindings relative to the returned context instance.
44706
44839
  *
44707
44840
  * The parameter `expand` is supported since 1.78.0. If this parameter is set, the given navigation properties
44708
44841
  * are expanded automatically with the same $batch request in which the POST request for the creation is
@@ -44721,6 +44854,14 @@ declare namespace sap {
44721
44854
  * handler is called with the data and the response of the POST request. The response object of the success
44722
44855
  * handler call and the response parameter of the corresponding `requestFailed` and `requestCompleted` events
44723
44856
  * have an additional property `expandAfterCreateFailed` set to `true`.
44857
+ *
44858
+ * Note: If a server requires a property in the request, you must supply this property in the initial data,
44859
+ * for example if the server requires a unit for an amount. This also applies if this property has a default
44860
+ * value.
44861
+ *
44862
+ * Note: A deep create (including data defined by navigation properties) is not supported. The dependent
44863
+ * entity has to be created using a second list binding, after this entity has been saved successfully in
44864
+ * the back-end system.
44724
44865
  */
44725
44866
  createEntry(
44726
44867
  /**
@@ -44806,7 +44947,12 @@ declare namespace sap {
44806
44947
  oKeyProperties: object
44807
44948
  ): string;
44808
44949
  /**
44950
+ * @deprecated - since 1.95.0; use {@link #resetChanges} instead
44951
+ *
44809
44952
  * Deletes a created entry from the request queue and from the model.
44953
+ *
44954
+ * **Note:** Controls are not updated. Use {@link #resetChanges} instead to update also the controls, for
44955
+ * example: `oModel.resetChanges([oContext.getPath()], undefined, true);`
44810
44956
  */
44811
44957
  deleteCreatedEntry(
44812
44958
  /**
@@ -45259,8 +45405,10 @@ declare namespace sap {
45259
45405
  * To get a copy of the entity without internal attributes, use `{select: "*"}` instead.
45260
45406
  *
45261
45407
  * **Note:** If `mParameters.select` is given and not all selected properties are available, this method
45262
- * returns `undefined` instead of incomplete data. If `mParameters.select` is not given, all properties
45263
- * available on the client are returned.
45408
+ * returns `undefined` instead of incomplete data.
45409
+ *
45410
+ * **Note:** If `mParameters.select` is not given, all properties and navigation properties available on
45411
+ * the client are returned.
45264
45412
  *
45265
45413
  * Example:
45266
45414
  * With `mParameters` given as `{select: "Products/ProductName, Products", expand:"Products"}` no properties
@@ -45356,11 +45504,11 @@ declare namespace sap {
45356
45504
  /**
45357
45505
  * Return the parsed XML metadata as a Javascript object.
45358
45506
  *
45359
- * Please note that the metadata is loaded asynchronously and this function might return undefined because
45507
+ * Please note that the metadata is loaded asynchronously and this function might return `undefined` because
45360
45508
  * the metadata has not been loaded yet. In this case attach to the `metadataLoaded` event to get notified
45361
45509
  * when the metadata is available and then call this function.
45362
45510
  */
45363
- getServiceMetadata(): Object;
45511
+ getServiceMetadata(): Object | undefined;
45364
45512
  /**
45365
45513
  * Checks if there exist pending changes in the model.
45366
45514
  *
@@ -45572,7 +45720,7 @@ declare namespace sap {
45572
45720
  *
45573
45721
  * Returns a new promise which can be resolved or rejected depending on the metadata loading state.
45574
45722
  */
45575
- refreshMetadata(): Promise<any>;
45723
+ refreshMetadata(): Promise<any> | undefined;
45576
45724
  /**
45577
45725
  * Refresh XSRF token by performing a GET request against the service root URL.
45578
45726
  */
@@ -45643,31 +45791,38 @@ declare namespace sap {
45643
45791
  */
45644
45792
  changeSetId?: string;
45645
45793
  /**
45646
- * Since 1.46; defines whether to update all bindings after submitting this change operation. See {@link
45647
- * #setRefreshAfterChange} If given, this overrules the model-wide `refreshAfterChange` flag for this operation
45794
+ * Since 1.46; defines whether to update all bindings after submitting this change operation, see {@link
45795
+ * #setRefreshAfterChange}. If given, this overrules the model-wide `refreshAfterChange` flag for this operation
45648
45796
  * only.
45649
45797
  */
45650
45798
  refreshAfterChange?: boolean;
45651
45799
  }
45652
45800
  ): object;
45653
45801
  /**
45654
- * Resets changes that have been collected.
45802
+ * Resets pending changes and aborts corresponding requests.
45655
45803
  *
45656
- * By default, only client data changes triggered through: {@link #createEntry} {@link #setProperty} are
45657
- * taken into account.
45804
+ * By default, only changes triggered through {@link #createEntry} or {@link #setProperty} are taken into
45805
+ * account. If `bAll` is set, also deferred requests triggered through {@link #create}, {@link #update}
45806
+ * or {@link #remove} are taken into account.
45658
45807
  *
45659
- * If `bAll` is set to `true`, also deferred requests triggered through: {@link #create} {@link #update}
45660
- * {@link #remove} are taken into account.
45808
+ * If `bDeleteCreatedEntities` is set, the entity is completely removed, provided it has been created
45809
+ *
45810
+ * - via {@link #createEntry} and it is not yet persisted in the back end, or
45811
+ * - via {@link #callFunction}.
45661
45812
  */
45662
45813
  resetChanges(
45663
45814
  /**
45664
- * Array of paths that should be reset. If no array is passed, all changes will be reset.
45815
+ * Paths to be be reset; if no array is passed, all changes are reset
45665
45816
  */
45666
45817
  aPath?: any[],
45667
45818
  /**
45668
- * If set to true, also deferred requests are taken into account.
45819
+ * Whether also deferred requests are taken into account
45669
45820
  */
45670
- bAll?: boolean
45821
+ bAll?: boolean,
45822
+ /**
45823
+ * Whether to delete the entities created via {@link #createEntry} or {@link #callFunction}; since 1.95.0
45824
+ */
45825
+ bDeleteCreatedEntities?: boolean
45671
45826
  ): Promise<any>;
45672
45827
  /**
45673
45828
  * Returns a promise, which will resolve with the security token as soon as it is available.
@@ -46048,17 +46203,17 @@ declare namespace sap {
46048
46203
  * Applies the given filters to the ODataTreeBinding.
46049
46204
  *
46050
46205
  * Please note that filters of type `FilterType.Control` are not supported for `OperationMode.Server`, here
46051
- * only filters of type `FilterType.Application` are allowed. Filters given via the constructor are always
46052
- * of type `Application` and will be sent with every backend request. See the constructor documentation
46053
- * for more information.
46206
+ * only filters of type `FilterType.Application` are allowed. Filters given via {@link sap.ui.model.odata.v2.ODataModel#bindTree}
46207
+ * are always of type `Application` and will be sent with every back-end request. For more information,
46208
+ * see {@link sap.ui.model.odata.v2.ODataModel#bindTree}.
46054
46209
  *
46055
46210
  * Since 1.34.0, complete client-side filtering is supported for `OperationMode.Client` and also in `OperationMode.Auto`
46056
- * if the backend count is lower than the threshold. In this case, all types of filters will be applied
46057
- * on the client. See also: {@link sap.ui.model.odata.OperationMode.Auto}, {@link sap.ui.model.FilterType}.
46211
+ * if the back-end count is lower than the threshold. In this case, all types of filters will be applied
46212
+ * on the client. See also: {@link sap.ui.model.odata.OperationMode.Auto} and {@link sap.ui.model.FilterType}.
46058
46213
  *
46059
- * For the `OperationMode.Client` and `OperationMode.Auto`, you may also specify the binding parameter `useServersideApplicationFilters`
46060
- * in the constructor. If it is set, the filters of type `Application` will always be applied on the backend
46061
- * and trigger an OData request. See the constructor documentation for more information.
46214
+ * For the `OperationMode.Client` and `OperationMode.Auto`, you may also specify the `useServersideApplicationFilters`
46215
+ * binding parameter when creating an instance. If it is set, the filters of type `Application` will always
46216
+ * be applied on the back end and trigger an OData request. For more information, see {@link sap.ui.model.odata.v2.ODataModel#bindTree}.
46062
46217
  * See:
46063
46218
  * sap.ui.model.TreeBinding.prototype.filter
46064
46219
  */
@@ -46070,7 +46225,11 @@ declare namespace sap {
46070
46225
  /**
46071
46226
  * Type of the filter which should be adjusted. If it is not given, the type `FilterType.Control` is assumed
46072
46227
  */
46073
- sFilterType: sap.ui.model.FilterType
46228
+ sFilterType: sap.ui.model.FilterType,
46229
+ /**
46230
+ * Whether to return `true` or `false`, instead of `this`, depending on whether the filtering has been done
46231
+ */
46232
+ bReturnSuccess?: boolean
46074
46233
  ): this;
46075
46234
  /**
46076
46235
  * Returns the number of child nodes. This function is not available when the annotation "hierarchy-node-descendant-count-for"
@@ -46176,21 +46335,30 @@ declare namespace sap {
46176
46335
  sGroupId?: string
46177
46336
  ): void;
46178
46337
  /**
46179
- * Sets the rootLevel The root level is the level of the topmost tree nodes, which will be used as an entry
46338
+ * Sets the `rootLevel`. The root level is the level of the topmost tree nodes that will be used as an entry
46180
46339
  * point for OData services. This is only possible (and necessary) for OData services implementing the hierarchy
46181
46340
  * annotation specification, or when providing the annotation information locally as a binding parameter.
46182
- * See the constructor for API documentation on this.
46341
+ * For more information, see {@link sap.ui.model.odata.v2.ODataModel#bindTree}.
46183
46342
  */
46184
- setRootLevel(iRootLevel: int): void;
46343
+ setRootLevel(
46344
+ /**
46345
+ * The new `rootLevel`
46346
+ */
46347
+ iRootLevel: int
46348
+ ): void;
46185
46349
  /**
46186
- * Sorts the Tree according to the given Sorter(s). In OperationMode.Client or OperationMode.Auto (if the
46187
- * given threshold is satisfied), the sorters are applied locally on the client.
46350
+ * Sorts the Tree according to the given Sorter(s). In `OperationMode.Client` or `OperationMode.Auto` (if
46351
+ * the given threshold is satisfied), the sorters are applied locally on the client.
46188
46352
  */
46189
46353
  sort(
46190
46354
  /**
46191
- * the Sorter or an Array of sap.ui.model.Sorter instances
46355
+ * The Sorter or an Array of sap.ui.model.Sorter instances
46356
+ */
46357
+ aSorters: sap.ui.model.Sorter[] | sap.ui.model.Sorter,
46358
+ /**
46359
+ * Whether to return `true` or `false`, instead of `this`, depending on whether the sorting has been done
46192
46360
  */
46193
- aSorters: sap.ui.model.Sorter[] | sap.ui.model.Sorter
46361
+ bReturnSuccess?: boolean
46194
46362
  ): this;
46195
46363
  }
46196
46364
  /**
@@ -46913,7 +47081,12 @@ declare namespace sap {
46913
47081
  * binding is used, see {@link #getUpdateGroupId}; the resulting group ID must not have {@link sap.ui.model.odata.v4.SubmitMode.API}.
46914
47082
  * Since 1.81, if this context is transient (see {@link #isTransient}), no group ID needs to be specified.
46915
47083
  */
46916
- sGroupId?: string
47084
+ sGroupId?: string,
47085
+ /**
47086
+ * Whether not to request the new count from the server; useful in case of {@link #replaceWith} where it
47087
+ * is known that the count remains unchanged (since 1.97.0)
47088
+ */
47089
+ bDoNotRequestCount?: boolean
46917
47090
  ): Promise<any>;
46918
47091
  /**
46919
47092
  * @SINCE 1.41.0
@@ -47074,6 +47247,18 @@ declare namespace sap {
47074
47247
  */
47075
47248
  bAllowRemoval?: boolean
47076
47249
  ): void;
47250
+ /**
47251
+ * @SINCE 1.97.0
47252
+ *
47253
+ * Replaces this context with the given other context. You probably want to delete this context afterwards
47254
+ * without requesting the new count from the server, see the `bDoNotRequestCount` parameter of {@link #delete}.
47255
+ */
47256
+ replaceWith(
47257
+ /**
47258
+ * The other context
47259
+ */
47260
+ oOtherContext: sap.ui.model.odata.v4.Context
47261
+ ): void;
47077
47262
  /**
47078
47263
  * @SINCE 1.39.0
47079
47264
  *
@@ -47287,8 +47472,8 @@ declare namespace sap {
47287
47472
  * @SINCE 1.37.0
47288
47473
  *
47289
47474
  * Context binding for an OData V4 model. An event handler can only be attached to this binding for the
47290
- * following events: 'AggregatedDataStateChange', 'change', 'dataReceived', 'dataRequested', and 'DataStateChange'.
47291
- * For other events, an error is thrown.
47475
+ * following events: 'AggregatedDataStateChange', 'change', 'dataReceived', 'dataRequested', 'DataStateChange',
47476
+ * 'patchCompleted', and 'patchSent'. For other events, an error is thrown.
47292
47477
  *
47293
47478
  * A context binding can also be used as an operation binding to support bound actions, action imports,
47294
47479
  * bound functions and function imports. If you want to control the execution time of an operation, for
@@ -47399,10 +47584,10 @@ declare namespace sap {
47399
47584
  *
47400
47585
  * Changes this binding's parameters and refreshes the binding.
47401
47586
  *
47402
- * If there are pending changes an error is thrown. Use {@link #hasPendingChanges} to check if there are
47403
- * pending changes. If there are changes, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit
47404
- * the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before calling
47405
- * {@link #changeParameters}.
47587
+ * If there are pending changes that cannot be ignored, an error is thrown. Use {@link #hasPendingChanges}
47588
+ * to check if there are such pending changes. If there are, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
47589
+ * to submit the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before
47590
+ * calling {@link #changeParameters}.
47406
47591
  *
47407
47592
  * The parameters are changed according to the given map of parameters: Parameters with an `undefined` value
47408
47593
  * are removed, the other parameters are set, and missing parameters remain unchanged.
@@ -47483,7 +47668,19 @@ declare namespace sap {
47483
47668
  * the bound action should either be repeated **without** applying the preference or rejected with an `Error`
47484
47669
  * instance `oError` where `oError.canceled === true`. Since 1.92.0.
47485
47670
  */
47486
- fnOnStrictHandlingFailed?: Function
47671
+ fnOnStrictHandlingFailed?: Function,
47672
+ /**
47673
+ * Whether this operation binding's parent context, which must belong to a list binding, is replaced with
47674
+ * the operation's return value context (see below) and that list context is returned instead. The list
47675
+ * context may be a newly created context or an existing context. A newly created context has the same `keepAlive`
47676
+ * attribute and `fnOnBeforeDestroy` function as the parent context, see {@link sap.ui.model.odata.v4.Context#setKeepAlive};
47677
+ * `fnOnBeforeDestroy` will be called with the new context instance as the only argument in this case. An
47678
+ * existing context does not change its `keepAlive` attribute. In any case, the resulting context takes
47679
+ * the place (index, position) of the parent context {@link sap.ui.model.odata.v4.Context#getIndex}. If
47680
+ * the parent context has requested messages when it was kept alive, they will be inherited if the $$inheritExpandSelect
47681
+ * binding parameter is set to `true`. Since 1.97.0.
47682
+ */
47683
+ bReplaceWithRVC?: boolean
47487
47684
  ): Promise<any>;
47488
47685
  /**
47489
47686
  * @SINCE 1.39.0
@@ -47539,7 +47736,15 @@ declare namespace sap {
47539
47736
  * returns `true` if there are pending changes for the current parent context path of this binding. If this
47540
47737
  * binding is unresolved (see {@link sap.ui.model.Binding#isResolved}), it returns `false`.
47541
47738
  */
47542
- hasPendingChanges(): boolean;
47739
+ hasPendingChanges(
47740
+ /**
47741
+ * Whether to ignore changes which will not be lost by APIs like {@link sap.ui.model.odata.v4.ODataListBinding#changeParameters
47742
+ * changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#sort
47743
+ * sort}, or {@link sap.ui.model.odata.v4.ODataListBinding#suspend suspend} because they relate to a {@link
47744
+ * sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context of this binding.
47745
+ */
47746
+ bIgnoreKeptAlive?: boolean
47747
+ ): boolean;
47543
47748
  /**
47544
47749
  * @SINCE 1.37.0
47545
47750
  *
@@ -47555,6 +47760,20 @@ declare namespace sap {
47555
47760
  * Method not supported
47556
47761
  */
47557
47762
  isInitial(): boolean;
47763
+ /**
47764
+ * @SINCE 1.95.0
47765
+ * @EXPERIMENTAL
47766
+ *
47767
+ * Moves the bound entity into the given list binding. This binding loses its data. The method may only
47768
+ * be called when this binding has finished loading. You can verify this by calling `oBinding.getBoundContext().requestObject()`.
47769
+ * If that promise resolves, the binding has finished loading.
47770
+ */
47771
+ moveEntityTo(
47772
+ /**
47773
+ * The list binding to take the entity
47774
+ */
47775
+ oListBinding: sap.ui.model.odata.v4.ODataListBinding
47776
+ ): void;
47558
47777
  /**
47559
47778
  * @SINCE 1.37.0
47560
47779
  *
@@ -47609,6 +47828,18 @@ declare namespace sap {
47609
47828
  */
47610
47829
  sPath?: string
47611
47830
  ): Promise<any>;
47831
+ /**
47832
+ * @SINCE 1.87.0
47833
+ *
47834
+ * Refreshes the binding and returns a promise to wait for it. See {@link #refresh} for details. Use {@link
47835
+ * #refresh} if you do not need the promise.
47836
+ */
47837
+ requestRefresh(
47838
+ /**
47839
+ * The group ID to be used
47840
+ */
47841
+ sGroupId?: string
47842
+ ): Promise<any>;
47612
47843
  /**
47613
47844
  * @SINCE 1.40.1
47614
47845
  *
@@ -47647,7 +47878,8 @@ declare namespace sap {
47647
47878
  *
47648
47879
  * Suspends this binding. A suspended binding does not fire change events nor does it trigger data service
47649
47880
  * requests. Call {@link #resume} to resume the binding. Before 1.53.0, this method was not supported and
47650
- * threw an error.
47881
+ * threw an error. Since 1.97.0, pending changes are ignored if they relate to a {@link sap.ui.model.odata.v4.Context#setKeepAlive
47882
+ * kept-alive} context of this binding.
47651
47883
  * See:
47652
47884
  * {@link topic:b0f5c531e5034a27952cc748954cbe39 Suspend and Resume}
47653
47885
  * sap.ui.model.Binding#suspend
@@ -47656,13 +47888,20 @@ declare namespace sap {
47656
47888
  * #resume
47657
47889
  */
47658
47890
  suspend(): void;
47891
+ /**
47892
+ * @SINCE 1.37.0
47893
+ *
47894
+ * Returns a string representation of this object including the binding path. If the binding is relative,
47895
+ * the parent path is also given, separated by a '|'.
47896
+ */
47897
+ toString(): string;
47659
47898
  }
47660
47899
  /**
47661
47900
  * @SINCE 1.37.0
47662
47901
  *
47663
47902
  * List binding for an OData V4 model. An event handler can only be attached to this binding for the following
47664
- * events: 'AggregatedDataStateChange', 'change', 'dataReceived', 'dataRequested', 'DataStateChange' and
47665
- * 'refresh'. For other events, an error is thrown.
47903
+ * events: 'AggregatedDataStateChange', 'change', 'createCompleted', 'createSent', 'dataReceived', 'dataRequested',
47904
+ * 'DataStateChange', 'patchCompleted', 'patchSent', and 'refresh'. For other events, an error is thrown.
47666
47905
  */
47667
47906
  class ODataListBinding extends sap.ui.model.ListBinding {
47668
47907
  constructor();
@@ -47779,10 +48018,10 @@ declare namespace sap {
47779
48018
  *
47780
48019
  * Changes this binding's parameters and refreshes the binding.
47781
48020
  *
47782
- * If there are pending changes an error is thrown. Use {@link #hasPendingChanges} to check if there are
47783
- * pending changes. If there are changes, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit
47784
- * the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before calling
47785
- * {@link #changeParameters}.
48021
+ * If there are pending changes that cannot be ignored, an error is thrown. Use {@link #hasPendingChanges}
48022
+ * to check if there are such pending changes. If there are, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
48023
+ * to submit the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before
48024
+ * calling {@link #changeParameters}.
47786
48025
  *
47787
48026
  * The parameters are changed according to the given map of parameters: Parameters with an `undefined` value
47788
48027
  * are removed, the other parameters are set, and missing parameters remain unchanged.
@@ -47852,7 +48091,13 @@ declare namespace sap {
47852
48091
  * Whether the entity is inserted at the end of the list. When creating multiple entities, this parameter
47853
48092
  * must have the same value for each entity. Supported since 1.66.0
47854
48093
  */
47855
- bAtEnd?: boolean
48094
+ bAtEnd?: boolean,
48095
+ /**
48096
+ * Create an inactive context. Such a context will only be sent to the server after the first property update.
48097
+ * From then on it behaves like any other created context. This parameter is experimental and its implementation
48098
+ * may still change. Do not use it in productive code yet. Supported since 1.97.0
48099
+ */
48100
+ bInactive?: boolean
47856
48101
  ): sap.ui.model.odata.v4.Context;
47857
48102
  /**
47858
48103
  * @SINCE 1.40.1
@@ -47925,15 +48170,29 @@ declare namespace sap {
47925
48170
  /**
47926
48171
  * @SINCE 1.39.0
47927
48172
  *
47928
- * Filters the list with the given filters.
48173
+ * Filters the list with the given filters. Since 1.97.0, if filters are unchanged, no request is sent,
48174
+ * regardless of pending changes.
47929
48175
  *
47930
- * If there are pending changes an error is thrown. Use {@link #hasPendingChanges} to check if there are
47931
- * pending changes. If there are changes, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit
47932
- * the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before calling
47933
- * {@link #filter}.
48176
+ * If there are pending changes that cannot be ignored, an error is thrown. Use {@link #hasPendingChanges}
48177
+ * to check if there are such pending changes. If there are, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
48178
+ * to submit the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before
48179
+ * calling {@link #filter}.
47934
48180
  *
47935
48181
  * Filters are case sensitive unless the property `caseSensitive` is set to `false`. This property has to
47936
48182
  * be set on each filter, it is not inherited from a multi-filter.
48183
+ *
48184
+ * Application and Control Filters: Each list binding maintains two separate lists of filters, one for filters
48185
+ * defined by the control that owns the binding, and another list for filters that an application can define
48186
+ * in addition. When executing the filter operation, both sets of filters are combined.
48187
+ *
48188
+ * By using the `sFilterType` parameter of the `filter` method, the caller can control which set of filters
48189
+ * is modified.
48190
+ *
48191
+ * Auto-Grouping of Filters: Filters are first grouped according to their binding path. All filters belonging
48192
+ * to the same path are ORed, and after that the results of all paths are ANDed. Usually this means that
48193
+ * all filters applied to the same property are ORed, while filters on different properties are ANDed. Please
48194
+ * use either the automatic grouping of filters (where applicable) or explicit AND/OR filters, as a mixture
48195
+ * of both is not supported.
47937
48196
  * See:
47938
48197
  * sap.ui.model.ListBinding#filter
47939
48198
  * #setAggregation
@@ -48110,7 +48369,15 @@ declare namespace sap {
48110
48369
  * returns `true` if there are pending changes for the current parent context path of this binding. If this
48111
48370
  * binding is unresolved (see {@link sap.ui.model.Binding#isResolved}), it returns `false`.
48112
48371
  */
48113
- hasPendingChanges(): boolean;
48372
+ hasPendingChanges(
48373
+ /**
48374
+ * Whether to ignore changes which will not be lost by APIs like {@link sap.ui.model.odata.v4.ODataListBinding#changeParameters
48375
+ * changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#sort
48376
+ * sort}, or {@link sap.ui.model.odata.v4.ODataListBinding#suspend suspend} because they relate to a {@link
48377
+ * sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context of this binding.
48378
+ */
48379
+ bIgnoreKeptAlive?: boolean
48380
+ ): boolean;
48114
48381
  /**
48115
48382
  * @SINCE 1.37.0
48116
48383
  *
@@ -48231,6 +48498,18 @@ declare namespace sap {
48231
48498
  */
48232
48499
  fnFilter?: (p1: sap.ui.core.message.Message) => boolean
48233
48500
  ): Promise<sap.ui.model.Filter>;
48501
+ /**
48502
+ * @SINCE 1.87.0
48503
+ *
48504
+ * Refreshes the binding and returns a promise to wait for it. See {@link #refresh} for details. Use {@link
48505
+ * #refresh} if you do not need the promise.
48506
+ */
48507
+ requestRefresh(
48508
+ /**
48509
+ * The group ID to be used
48510
+ */
48511
+ sGroupId?: string
48512
+ ): Promise<any>;
48234
48513
  /**
48235
48514
  * @SINCE 1.40.1
48236
48515
  *
@@ -48320,12 +48599,13 @@ declare namespace sap {
48320
48599
  * @SINCE 1.39.0
48321
48600
  *
48322
48601
  * Sort the entries represented by this list binding according to the given sorters. The sorters are stored
48323
- * at this list binding and they are used for each following data request.
48602
+ * at this list binding and they are used for each following data request. Since 1.97.0, if sorters are
48603
+ * unchanged, no request is sent, regardless of pending changes.
48324
48604
  *
48325
- * If there are pending changes an error is thrown. Use {@link #hasPendingChanges} to check if there are
48326
- * pending changes. If there are changes, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit
48327
- * the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before calling
48328
- * {@link #sort}.
48605
+ * If there are pending changes that cannot be ignored, an error is thrown. Use {@link #hasPendingChanges}
48606
+ * to check if there are such pending changes. If there are, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
48607
+ * to submit the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before
48608
+ * calling {@link #sort}.
48329
48609
  * See:
48330
48610
  * sap.ui.model.ListBinding#sort
48331
48611
  */
@@ -48342,7 +48622,8 @@ declare namespace sap {
48342
48622
  *
48343
48623
  * Suspends this binding. A suspended binding does not fire change events nor does it trigger data service
48344
48624
  * requests. Call {@link #resume} to resume the binding. Before 1.53.0, this method was not supported and
48345
- * threw an error.
48625
+ * threw an error. Since 1.97.0, pending changes are ignored if they relate to a {@link sap.ui.model.odata.v4.Context#setKeepAlive
48626
+ * kept-alive} context of this binding.
48346
48627
  * See:
48347
48628
  * {@link topic:b0f5c531e5034a27952cc748954cbe39 Suspend and Resume}
48348
48629
  * sap.ui.model.Binding#suspend
@@ -48351,6 +48632,13 @@ declare namespace sap {
48351
48632
  * #resume
48352
48633
  */
48353
48634
  suspend(): void;
48635
+ /**
48636
+ * @SINCE 1.37.0
48637
+ *
48638
+ * Returns a string representation of this object including the binding path. If the binding is relative,
48639
+ * the parent path is also given, separated by a '|'.
48640
+ */
48641
+ toString(): string;
48354
48642
  /**
48355
48643
  * @SINCE 1.53.0
48356
48644
  *
@@ -48422,6 +48710,8 @@ declare namespace sap {
48422
48710
  * not support any public events; attaching an event handler leads to an error.
48423
48711
  *
48424
48712
  * This model is read-only.
48713
+ *
48714
+ * This model is not prepared to be inherited from.
48425
48715
  */
48426
48716
  class ODataMetaModel extends sap.ui.model.MetaModel {
48427
48717
  constructor();
@@ -49040,6 +49330,8 @@ declare namespace sap {
49040
49330
  *
49041
49331
  * Model implementation for OData V4.
49042
49332
  *
49333
+ * This model is not prepared to be inherited from.
49334
+ *
49043
49335
  * Every resource path (relative to the service root URL, no query options) according to "4 Resource Path"
49044
49336
  * in specification "OData Version 4.0 Part 2: URL Conventions" is a valid data binding path within this
49045
49337
  * model if a leading slash is added; for example "/" + "SalesOrderList('A%2FB%26C')" to access an entity
@@ -49263,9 +49555,8 @@ declare namespace sap {
49263
49555
  $$groupId?: string;
49264
49556
  /**
49265
49557
  * For operation bindings only: Whether $expand and $select from the parent binding are used in the request
49266
- * sent on {@link #execute}. If set to `true`, the binding must not set the $expand or $select parameter
49267
- * itself, the operation must be bound, and the return value and the binding parameter must belong to the
49268
- * same entity set.
49558
+ * sent on {@link #execute}. If set to `true`, the binding must not set the $expand itself, the operation
49559
+ * must be bound, and the return value and the binding parameter must belong to the same entity set.
49269
49560
  */
49270
49561
  $$inheritExpandSelect?: boolean;
49271
49562
  /**
@@ -49296,7 +49587,7 @@ declare namespace sap {
49296
49587
  */
49297
49588
  bindList(
49298
49589
  /**
49299
- * The binding path in the model; must not be empty or end with a slash
49590
+ * The binding path in the model; must not end with a slash
49300
49591
  */
49301
49592
  sPath: string,
49302
49593
  /**
@@ -49397,8 +49688,7 @@ declare namespace sap {
49397
49688
  * as a separator and splits it into two parts. The part before the separator is resolved with the binding's
49398
49689
  * context and the result is transformed into a metadata context (see {@link sap.ui.model.odata.v4.ODataMetaModel#getMetaContext}).
49399
49690
  * The part following the separator is then interpreted relative to this metadata context, even if it starts
49400
- * with a '/'; a trailing '/' is allowed here, see {@link sap.ui.model.odata.v4.ODataMetaModel#requestObject}
49401
- * for the effect it has.
49691
+ * with a '/'; see {@link sap.ui.model.odata.v4.ODataMetaModel#requestObject} for more details.
49402
49692
  *
49403
49693
  * If the target type specified in the corresponding control property's binding info is "any" and the binding
49404
49694
  * is relative or points to metadata, the binding may have an object value; in this case and unless the
@@ -49410,8 +49700,7 @@ declare namespace sap {
49410
49700
  */
49411
49701
  bindProperty(
49412
49702
  /**
49413
- * The binding path in the model; must not be empty. Must not end with a '/' unless the binding points to
49414
- * metadata.
49703
+ * The binding path in the model; must not end with a slash
49415
49704
  */
49416
49705
  sPath: string,
49417
49706
  /**
@@ -49420,12 +49709,14 @@ declare namespace sap {
49420
49709
  oContext?: sap.ui.model.Context,
49421
49710
  /**
49422
49711
  * Map of binding parameters which can be OData query options as specified in "OData Version 4.0 Part 2:
49423
- * URL Conventions" or the binding-specific parameter "$$groupId". All "5.2 Custom Query Options" are allowed
49424
- * except for those with a name starting with "sap-" (unless starting with "sap-valid-"). All other query
49425
- * options lead to an error. Query options specified for the binding overwrite model query options. Note:
49426
- * The binding only creates its own data service request if it is absolute or if it is relative to a context
49427
- * created via {@link #createBindingContext}. The binding parameters are ignored in case the binding creates
49428
- * no own data service request or in case the binding points to metadata.
49712
+ * URL Conventions" or the binding-specific parameters as specified below. The following OData query options
49713
+ * are allowed:
49714
+ * All "5.2 Custom Query Options" except for those with a name starting with "sap-" (unless starting with
49715
+ * "sap-valid-") The $apply, $filter, and $search "5.1 System Query Options" if the path ends with
49716
+ * a "$count" segment. All other query options lead to an error. Query options specified for the binding
49717
+ * overwrite model query options. Note: The binding only creates its own data service request if it is absolute
49718
+ * or if it is relative to a context created via {@link #createBindingContext}. The binding parameters are
49719
+ * ignored in case the binding creates no own data service request or in case the binding points to metadata.
49429
49720
  */
49430
49721
  mParameters?: {
49431
49722
  /**
@@ -49872,7 +50163,15 @@ declare namespace sap {
49872
50163
  * returns `true` if there are pending changes for the current parent context path of this binding. If this
49873
50164
  * binding is unresolved (see {@link sap.ui.model.Binding#isResolved}), it returns `false`.
49874
50165
  */
49875
- hasPendingChanges(): boolean;
50166
+ hasPendingChanges(
50167
+ /**
50168
+ * Whether to ignore changes which will not be lost by APIs like {@link sap.ui.model.odata.v4.ODataListBinding#changeParameters
50169
+ * changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#sort
50170
+ * sort}, or {@link sap.ui.model.odata.v4.ODataListBinding#suspend suspend} because they relate to a {@link
50171
+ * sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context of this binding.
50172
+ */
50173
+ bIgnoreKeptAlive?: boolean
50174
+ ): boolean;
49876
50175
  /**
49877
50176
  * @SINCE 1.37.0
49878
50177
  *
@@ -49914,6 +50213,18 @@ declare namespace sap {
49914
50213
  */
49915
50214
  sGroupId?: string | boolean
49916
50215
  ): void;
50216
+ /**
50217
+ * @SINCE 1.87.0
50218
+ *
50219
+ * Refreshes the binding and returns a promise to wait for it. See {@link #refresh} for details. Use {@link
50220
+ * #refresh} if you do not need the promise.
50221
+ */
50222
+ requestRefresh(
50223
+ /**
50224
+ * The group ID to be used
50225
+ */
50226
+ sGroupId?: string
50227
+ ): Promise<any>;
49917
50228
  /**
49918
50229
  * @SINCE 1.69
49919
50230
  *
@@ -50009,6 +50320,13 @@ declare namespace sap {
50009
50320
  * sap.ui.model.Binding#suspend
50010
50321
  */
50011
50322
  suspend(): void;
50323
+ /**
50324
+ * @SINCE 1.37.0
50325
+ *
50326
+ * Returns a string representation of this object including the binding path. If the binding is relative,
50327
+ * the parent path is also given, separated by a '|'.
50328
+ */
50329
+ toString(): string;
50012
50330
  }
50013
50331
  /**
50014
50332
  * Modes to control the use of batch requests for a group ID.
@@ -50071,7 +50389,7 @@ declare namespace sap {
50071
50389
  * views, e.g. `<template:with path="meta>Value" helper="sap.ui.model.odata.AnnotationHelper.resolvePath"
50072
50390
  * var="target">`.
50073
50391
  *
50074
- * Since 1.31.0, you DO NOT need to {@link jQuery.sap.require} this module before use.
50392
+ * Since 1.31.0, you DO NOT need to {@link sap.ui.require} this module before use.
50075
50393
  */
50076
50394
  interface AnnotationHelper {
50077
50395
  /**
@@ -50105,7 +50423,7 @@ declare namespace sap {
50105
50423
  * ```javascript
50106
50424
  *
50107
50425
  * function myRootFormatter(oValue1, oValue2, sFullName, sGreeting, iAnswer) {
50108
- * return ...; //TODO compute something useful from the given values
50426
+ * return ...;
50109
50427
  * }
50110
50428
  *
50111
50429
  * oSupplierContext = oMetaModel.getMetaContext("/ProductSet('HT-1021')/ToSupplier");
@@ -50408,15 +50726,15 @@ declare namespace sap {
50408
50726
  */
50409
50727
  formatValue(
50410
50728
  /**
50411
- * the value to format
50729
+ * The value to format
50412
50730
  */
50413
50731
  vValue: any,
50414
50732
  /**
50415
- * the EDM type (e.g. Edm.Decimal)
50733
+ * The EDM type (e.g. Edm.Decimal)
50416
50734
  */
50417
50735
  sType: string,
50418
50736
  /**
50419
- * Wether strings gets compared case sensitive or not
50737
+ * Whether strings gets compared case sensitive or not
50420
50738
  */
50421
50739
  bCaseSensitive: boolean
50422
50740
  ): string;
@@ -50906,7 +51224,7 @@ declare namespace sap {
50906
51224
  /**
50907
51225
  * Filters the list.
50908
51226
  *
50909
- * When using sap.ui.model.Filter the filters are first grouped according to their binding path. All filters
51227
+ * When using `sap.ui.model.Filter` the filters are first grouped according to their binding path. All filters
50910
51228
  * belonging to a group are combined with OR and after that the results of all groups are combined with
50911
51229
  * AND. Usually this means, all filters applied to a single table column are combined with OR, while filters
50912
51230
  * on different table columns are combined with AND. Please note that a custom filter function is not supported.
@@ -50919,21 +51237,28 @@ declare namespace sap {
50919
51237
  /**
50920
51238
  * Type of the filter which should be adjusted, if it is not given, the standard behaviour applies
50921
51239
  */
50922
- sFilterType: sap.ui.model.FilterType
51240
+ sFilterType: sap.ui.model.FilterType,
51241
+ /**
51242
+ * Whether to return `true` or `false`, instead of `this`, depending on whether the filtering has been done
51243
+ */
51244
+ bReturnSuccess?: boolean
50923
51245
  ): this;
50924
51246
  /**
50925
51247
  * Return contexts for the list
50926
51248
  */
50927
51249
  getContexts(
50928
51250
  /**
50929
- * the start index of the requested contexts
51251
+ * The start index of the requested contexts
50930
51252
  */
50931
51253
  iStartIndex?: int,
50932
51254
  /**
50933
- * the requested amount of contexts
51255
+ * The requested amount of contexts
50934
51256
  */
50935
51257
  iLength?: int,
50936
-
51258
+ /**
51259
+ * The maximum number of contexts to read before and after the given range; with this, controls can prefetch
51260
+ * data that is likely to be needed soon, e.g. when scrolling down in a table
51261
+ */
50937
51262
  iThreshold?: int
50938
51263
  ): sap.ui.model.Context[];
50939
51264
  /**
@@ -50962,16 +51287,28 @@ declare namespace sap {
50962
51287
  /**
50963
51288
  * Update the bound control even if no data has been changed
50964
51289
  */
50965
- bForceUpdate?: boolean
51290
+ bForceUpdate?: boolean,
51291
+ /**
51292
+ * A map of changed entities
51293
+ */
51294
+ mChangedEntities?: object,
51295
+ /**
51296
+ * A map of entity types
51297
+ */
51298
+ mEntityTypes?: object
50966
51299
  ): void;
50967
51300
  /**
50968
51301
  * Sorts the list.
50969
51302
  */
50970
51303
  sort(
50971
51304
  /**
50972
- * the Sorter or an array of sorter objects object which define the sort order
51305
+ * The Sorter or an array of sorter objects which define the sort order
51306
+ */
51307
+ aSorters: sap.ui.model.Sorter | sap.ui.model.Sorter[],
51308
+ /**
51309
+ * Whether to return `true` or `false`, instead of `this`, depending on whether the sorting has been done
50973
51310
  */
50974
- aSorters: sap.ui.model.Sorter | any[]
51311
+ bReturnSuccess?: boolean
50975
51312
  ): this;
50976
51313
  }
50977
51314
  /**
@@ -51313,6 +51650,8 @@ declare namespace sap {
51313
51650
  * V4 annotations from the existing {@link sap.ui.model.odata.ODataAnnotations} directly into the corresponding
51314
51651
  * model element.
51315
51652
  *
51653
+ * This model is not prepared to be inherited from.
51654
+ *
51316
51655
  * Also, annotations from the "http://www.sap.com/Protocols/SAPData" namespace are lifted up from the `extensions`
51317
51656
  * array and transformed from objects into simple properties with an "sap:" prefix for their name. Note
51318
51657
  * that this happens in addition, thus the following example shows both representations. This way, such
@@ -51815,19 +52154,18 @@ declare namespace sap {
51815
52154
  bSuppressEvents?: boolean
51816
52155
  ): Promise<any>;
51817
52156
  /**
51818
- * Appends the change batch operations to the end of the batch stack. Only PUT, POST or DELETE batch operations
51819
- * should be included in the specified array. The operations in the array will be included in a single changeset.
51820
- * To embed change operations in different change sets call this method with the corresponding change operations
51821
- * again. If an illegal batch operation is added to the change set nothing will be performed and false will
51822
- * be returned.
52157
+ * Appends the change batch operations to the end of the batch stack. Only `PUTPOST` or `DELETE`
52158
+ * batch operations should be included in the specified array. The operations in the array will be included
52159
+ * in a single changeset. To embed change operations in different change sets call this method with the
52160
+ * corresponding change operations again. If an illegal batch operation is added to the change set nothing
52161
+ * will be performed and false will be returned.
51823
52162
  */
51824
52163
  addBatchChangeOperations(
51825
52164
  /**
51826
- * an array of change batch operations created via `createBatchOperation` and `sMethod` = POST, PUT, MERGE
51827
- * or DELETE
52165
+ * An array of change batch operations created via `createBatchOperation` with parameter `sMethod = "POST"/"PUT"/"MERGE"/"DELETE"`
51828
52166
  */
51829
52167
  aChangeOperations: any[]
51830
- ): void;
52168
+ ): false | undefined;
51831
52169
  /**
51832
52170
  * Appends the read batch operations to the end of the batch stack. Only GET batch operations should be
51833
52171
  * included in the specified array. If an illegal batch operation is added to the batch nothing will be
@@ -51835,10 +52173,10 @@ declare namespace sap {
51835
52173
  */
51836
52174
  addBatchReadOperations(
51837
52175
  /**
51838
- * an array of read batch operations created via `createBatchOperation` and `sMethod` = GET
52176
+ * An array of read batch operations created via `createBatchOperation` with `sMethod = "GET"`
51839
52177
  */
51840
52178
  aReadOperations: any[]
51841
- ): void;
52179
+ ): false | undefined;
51842
52180
  /**
51843
52181
  * Attaches event handler `fnFunction` to the {@link #event:annotationsFailed annotationsFailed} event of
51844
52182
  * this `sap.ui.model.odata.ODataModel`.
@@ -52114,29 +52452,29 @@ declare namespace sap {
52114
52452
  */
52115
52453
  createBatchOperation(
52116
52454
  /**
52117
- * A string containing the path to the collection or entry where the batch operation should be performed.
52118
- * The path is concatenated to the sServiceUrl which was specified in the model constructor.
52455
+ * A string containing the path to the collection or entry where the batch operation should be performed;
52456
+ * the path is concatenated to the `sServiceUrl` which was specified in the model constructor
52119
52457
  */
52120
52458
  sPath: string,
52121
52459
  /**
52122
- * for the batch operation. Possible values are GET, PUT, MERGE, POST, DELETE
52460
+ * For the batch operation; possible values are `GET`, `PUT`, `MERGE`, `POST` or `DELETE`
52123
52461
  */
52124
52462
  sMethod: string,
52125
52463
  /**
52126
- * optional data payload which should be created, updated, deleted in a change batch operation.
52464
+ * Optional data payload which should be created, updated, deleted in a change batch operation
52127
52465
  */
52128
52466
  oData?: object,
52129
52467
  /**
52130
- * optional parameter for additional information introduced in SAPUI5 1.9.1,
52468
+ * Optional parameter for additional information introduced in SAPUI5 1.9.1
52131
52469
  */
52132
52470
  oParameters?: {
52133
52471
  /**
52134
- * an ETag which can be used for concurrency control. If it is specified, it will be used in an If-Match-Header
52472
+ * An ETag which can be used for concurrency control. If it is specified, it will be used in an If-Match-Header
52135
52473
  * in the request to the server for this entry.
52136
52474
  */
52137
52475
  sETag?: string;
52138
52476
  }
52139
- ): void;
52477
+ ): object;
52140
52478
  /**
52141
52479
  * Creates a new entry object which is described by the metadata of the entity type of the specified sPath
52142
52480
  * Name. A context object is returned which can be used to bind against the newly created object.
@@ -52167,7 +52505,7 @@ declare namespace sap {
52167
52505
  vProperties: any[] | object
52168
52506
  ): sap.ui.model.Context;
52169
52507
  /**
52170
- * Creates the key from the given collection name and property map
52508
+ * Creates the key from the given collection name and property map.
52171
52509
  */
52172
52510
  createKey(
52173
52511
  /**
@@ -52177,12 +52515,12 @@ declare namespace sap {
52177
52515
  /**
52178
52516
  * The object containing at least all the key properties of the entity type
52179
52517
  */
52180
- oKeyParameters: object,
52518
+ oKeyProperties: object,
52181
52519
  /**
52182
52520
  * Whether the URI decoding should be applied on the key
52183
52521
  */
52184
52522
  bDecode: boolean
52185
- ): void;
52523
+ ): string;
52186
52524
  /**
52187
52525
  * Deletes a created entry from the request queue and the model.
52188
52526
  */
@@ -52358,19 +52696,19 @@ declare namespace sap {
52358
52696
  */
52359
52697
  getData(
52360
52698
  /**
52361
- * A string containing the path to the data object that should be returned.
52699
+ * A string containing the path to the data object that should be returned
52362
52700
  */
52363
52701
  sPath: string,
52364
52702
  /**
52365
- * the optional context which is used with the sPath to retrieve the requested data.
52703
+ * The optional context which is used with the sPath to retrieve the requested data
52366
52704
  */
52367
52705
  oContext?: object,
52368
52706
  /**
52369
- * This parameter should be set when a URI or custom parameter with a $expand System Query Option was used
52370
- * to retrieve associated entries embedded/inline. If true then the getProperty function returns a desired
52371
- * property value/entry and includes the associated expand entries (if any). If false the associated/expanded
52372
- * entry properties are removed and not included in the desired entry as properties at all. This is useful
52373
- * for performing updates on the base entry only. Note: A copy and not a reference of the entry will be
52707
+ * This parameter should be set when a URI or custom parameter with a `$expand` System Query Option was
52708
+ * used to retrieve associated entries embedded/inline; if true then the `getProperty` function returns
52709
+ * a desired property value/entry and includes the associated expand entries (if any); if false the associated/expanded
52710
+ * entry properties are removed and not included in the desired entry as properties at all; this is useful
52711
+ * for performing updates on the base entry only; note: A copy and not a reference of the entry will be
52374
52712
  * returned.
52375
52713
  */
52376
52714
  bIncludeExpandEntries?: boolean
@@ -52378,7 +52716,7 @@ declare namespace sap {
52378
52716
  /**
52379
52717
  * @SINCE 1.20
52380
52718
  *
52381
- * Returns the default count mode for retrieving the count of collections
52719
+ * Returns the default count mode for retrieving the count of collections.
52382
52720
  */
52383
52721
  getDefaultCountMode(): sap.ui.model.odata.CountMode;
52384
52722
  /**
@@ -52386,7 +52724,7 @@ declare namespace sap {
52386
52724
  */
52387
52725
  getHeaders(): object;
52388
52726
  /**
52389
- * Returns the key part from the entry URI or the given context or object
52727
+ * Returns the key part from the entry URI or the given context or object.
52390
52728
  */
52391
52729
  getKey(
52392
52730
  /**
@@ -52397,7 +52735,7 @@ declare namespace sap {
52397
52735
  * Whether the URI decoding should be applied on the key
52398
52736
  */
52399
52737
  bDecode: boolean
52400
- ): void;
52738
+ ): string;
52401
52739
  /**
52402
52740
  * Returns an instance of an OData meta model which offers a unified access to both OData V2 metadata and
52403
52741
  * V4 annotations. It uses the existing {@link sap.ui.model.odata.ODataMetadata} as a foundation and merges
@@ -52410,47 +52748,47 @@ declare namespace sap {
52410
52748
  getMetaModel(): sap.ui.model.odata.ODataMetaModel;
52411
52749
  /**
52412
52750
  * Returns the value for the property with the given `sPath`. If the path points to a navigation property
52413
- * which has been loaded via $expand then the `bIncludeExpandEntries` parameter determines if the navigation
52751
+ * which has been loaded via `$expand` then the `bIncludeExpandEntries` parameter determines if the navigation
52414
52752
  * property should be included in the returned value or not. Please note that this currently works for 1..1
52415
52753
  * navigation properties only.
52416
52754
  */
52417
52755
  getProperty(
52418
52756
  /**
52419
- * the path/name of the property
52757
+ * The path/name of the property
52420
52758
  */
52421
52759
  sPath: string,
52422
52760
  /**
52423
- * the context if available to access the property value
52761
+ * The context if available to access the property value
52424
52762
  */
52425
52763
  oContext?: object,
52426
52764
  /**
52427
- * This parameter should be set when a URI or custom parameter with a $expand System Query Option was used
52428
- * to retrieve associated entries embedded/inline. If true then the getProperty function returns a desired
52429
- * property value/entry and includes the associated expand entries (if any). If false the associated/expanded
52765
+ * This parameter should be set when a URI or custom parameter with a `$expand` System Query Option was
52766
+ * used to retrieve associated entries embedded/inline. If true then the getProperty function returns a
52767
+ * desired property value/entry and includes the associated expand entries (if any). If false the associated/expanded
52430
52768
  * entry properties are removed and not included in the desired entry as properties at all. This is useful
52431
52769
  * for performing updates on the base entry only. Note: A copy and not a reference of the entry will be
52432
52770
  * returned.
52433
52771
  */
52434
52772
  bIncludeExpandEntries?: boolean
52435
- ): any;
52773
+ ): object;
52436
52774
  /**
52437
52775
  * Returns the current security token. If the token has not been requested from the server it will be requested
52438
52776
  * first.
52439
52777
  */
52440
52778
  getSecurityToken(): string;
52441
52779
  /**
52442
- * Return the annotation object. Please note that when using the model with bLoadMetadataAsync = true then
52443
- * this function might return undefined because the metadata has not been loaded yet. In this case attach
52444
- * to the `annotationsLoaded` event to get notified when the annotations are available and then call this
52445
- * function.
52780
+ * Return the annotation object. Please note that when using the model with `bLoadMetadataAsync = true`
52781
+ * then this function might return undefined because the metadata has not been loaded yet. In this case
52782
+ * attach to the `annotationsLoaded` event to get notified when the annotations are available and then call
52783
+ * this function.
52446
52784
  */
52447
- getServiceAnnotations(): Object;
52785
+ getServiceAnnotations(): Object | undefined;
52448
52786
  /**
52449
- * Return the metadata object. Please note that when using the model with bLoadMetadataAsync = true then
52450
- * this function might return undefined because the metadata has not been loaded yet. In this case attach
52451
- * to the `metadataLoaded` event to get notified when the metadata is available and then call this function.
52787
+ * Return the metadata object. Please note that when using the model with `bLoadMetadataAsync = true` then
52788
+ * this function might return `undefinedmetadataLoaded` event to get notified when the metadata is available and then call
52789
+ * this function.
52452
52790
  */
52453
- getServiceMetadata(): Object;
52791
+ getServiceMetadata(): Object | undefined;
52454
52792
  /**
52455
52793
  * Checks if there exist pending changes in the model created by the setProperty method.
52456
52794
  */
@@ -52458,7 +52796,7 @@ declare namespace sap {
52458
52796
  /**
52459
52797
  * @deprecated (since 1.20) - please use {@link #getDefaultCountMode} instead.
52460
52798
  *
52461
- * Returns whether this model supports the $count on its collections
52799
+ * Returns whether this model supports `$count` on its collections.
52462
52800
  */
52463
52801
  isCountSupported(): boolean;
52464
52802
  /**
@@ -52611,9 +52949,14 @@ declare namespace sap {
52611
52949
  /**
52612
52950
  * @deprecated (since 1.20) - please use {@link #setDefaultCountMode} instead.
52613
52951
  *
52614
- * Sets whether this OData service supports $count on its collections.
52952
+ * Sets whether this OData service supports `$count` on its collections.
52615
52953
  */
52616
- setCountSupported(bCountSupported: boolean): void;
52954
+ setCountSupported(
52955
+ /**
52956
+ * Whether this OData service supports `$count` on its collections
52957
+ */
52958
+ bCountSupported: boolean
52959
+ ): void;
52617
52960
  /**
52618
52961
  * @SINCE 1.20
52619
52962
  *
@@ -52655,33 +52998,33 @@ declare namespace sap {
52655
52998
  ): void;
52656
52999
  /**
52657
53000
  * Sets a new value for the given property `sPropertyName` in the model without triggering a server request.
52658
- * This can be done by the submitChanges method.
53001
+ * This can be done by the `submitChanges` method.
52659
53002
  *
52660
- * Note: Only one entry of one collection can be updated at once. Otherwise a fireRejectChange event is
53003
+ * Note: Only one entry of one collection can be updated at once. Otherwise a `fireRejectChange` event is
52661
53004
  * fired.
52662
53005
  *
52663
- * Before updating a different entry the existing changes of the current entry have to be submitted or resetted
52664
- * by the corresponding methods: submitChanges, resetChanges.
53006
+ * Before updating a different entry the existing changes of the current entry have to be submitted or reset
53007
+ * by the corresponding methods: `submitChanges`, `resetChanges`.
52665
53008
  *
52666
- * IMPORTANT: All pending changes are resetted in the model if the application triggeres any kind of refresh
53009
+ * IMPORTANT: All pending changes are reset in the model if the application triggers any kind of refresh
52667
53010
  * on that entry. Make sure to submit the pending changes first. To determine if there are any pending changes
52668
- * call the hasPendingChanges method.
53011
+ * call the `hasPendingChanges` method.
52669
53012
  */
52670
53013
  setProperty(
52671
53014
  /**
52672
- * path of the property to set
53015
+ * Path of the property to set
52673
53016
  */
52674
53017
  sPath: string,
52675
53018
  /**
52676
- * value to set the property to
53019
+ * Value to set the property to
52677
53020
  */
52678
53021
  oValue: any,
52679
53022
  /**
52680
- * the context which will be used to set the property
53023
+ * The context which will be used to set the property
52681
53024
  */
52682
53025
  oContext?: object,
52683
53026
  /**
52684
- * whether to update other bindings dependent on this property asynchronously
53027
+ * Whether to update other bindings dependent on this property asynchronously
52685
53028
  */
52686
53029
  bAsyncUpdate?: boolean
52687
53030
  ): boolean;
@@ -52690,7 +53033,12 @@ declare namespace sap {
52690
53033
  *
52691
53034
  * Enable/Disable automatic updates of all Bindings after change operations
52692
53035
  */
52693
- setRefreshAfterChange(bRefreshAfterChange: boolean): void;
53036
+ setRefreshAfterChange(
53037
+ /**
53038
+ * Whether automatic updates should be enabled
53039
+ */
53040
+ bRefreshAfterChange: boolean
53041
+ ): void;
52694
53042
  /**
52695
53043
  * Enable/Disable XCSRF-Token handling
52696
53044
  */
@@ -53020,6 +53368,8 @@ declare namespace sap {
53020
53368
  /**
53021
53369
  * Model implementation for resource bundles.
53022
53370
  *
53371
+ * This model is not prepared to be inherited from.
53372
+ *
53023
53373
  * This model allows to bind control properties against translatable texts. Its data is taken from a {@link
53024
53374
  * module:sap/base/i18n/ResourceBundle} and it only supports property bindings.
53025
53375
  *
@@ -53241,7 +53591,9 @@ declare namespace sap {
53241
53591
  */
53242
53592
  namespace xml {
53243
53593
  /**
53244
- * Model implementation for XML format
53594
+ * Model implementation for the XML format.
53595
+ *
53596
+ * This model is not prepared to be inherited from.
53245
53597
  */
53246
53598
  class XMLModel extends sap.ui.model.ClientModel {
53247
53599
  /**
@@ -53280,35 +53632,35 @@ declare namespace sap {
53280
53632
  */
53281
53633
  static getMetadata(): sap.ui.base.Metadata;
53282
53634
  /**
53283
- * Returns the object for the given `path`
53635
+ * Returns the object for the given path and context.
53284
53636
  */
53285
53637
  getObject(
53286
53638
  /**
53287
- * the path to the object
53639
+ * The path to the object
53288
53640
  */
53289
53641
  sPath: string,
53290
53642
  /**
53291
- * the context which will be used to retrieve the object
53643
+ * The context which will be used to retrieve the object
53292
53644
  */
53293
53645
  oContext?: object
53294
- ): any;
53646
+ ): object;
53295
53647
  /**
53296
- * Returns the value for the property with the given `sPropertyName`
53648
+ * Returns the value for the property with the given `sPropertyName`.
53297
53649
  */
53298
53650
  getProperty(
53299
53651
  /**
53300
- * the path to the property
53652
+ * The path to the property
53301
53653
  */
53302
53654
  sPath: string,
53303
53655
  /**
53304
- * the context which will be used to retrieve the property
53656
+ * The context which will be used to retrieve the property
53305
53657
  */
53306
53658
  oContext?: object
53307
- ): any;
53659
+ ): string;
53308
53660
  /**
53309
53661
  * Serializes the current XML data of the model into a string.
53310
53662
  */
53311
- getXML(): undefined;
53663
+ getXML(): string;
53312
53664
  /**
53313
53665
  * Load XML-encoded data from the server using a GET HTTP request and store the resulting XML data in the
53314
53666
  * model. Note: Due to browser security restrictions, most "Ajax" requests are subject to the same origin
@@ -53356,11 +53708,11 @@ declare namespace sap {
53356
53708
  */
53357
53709
  setNameSpace(
53358
53710
  /**
53359
- * the namespace URI
53711
+ * The namespace URI
53360
53712
  */
53361
53713
  sNameSpace: string,
53362
53714
  /**
53363
- * the prefix for the namespace (optional)
53715
+ * The prefix for the namespace
53364
53716
  */
53365
53717
  sPrefix?: string
53366
53718
  ): void;
@@ -53370,19 +53722,19 @@ declare namespace sap {
53370
53722
  */
53371
53723
  setProperty(
53372
53724
  /**
53373
- * path of the property to set
53725
+ * Path of the property to set
53374
53726
  */
53375
53727
  sPath: string,
53376
53728
  /**
53377
- * value to set the property to
53729
+ * Value to set the property to
53378
53730
  */
53379
53731
  oValue: any,
53380
53732
  /**
53381
- * the context which will be used to set the property
53733
+ * The context which will be used to set the property
53382
53734
  */
53383
53735
  oContext?: object,
53384
53736
  /**
53385
- * whether to update other bindings dependent on this property asynchronously
53737
+ * Whether to update other bindings dependent on this property asynchronously
53386
53738
  */
53387
53739
  bAsyncUpdate?: boolean
53388
53740
  ): boolean;
@@ -53771,8 +54123,12 @@ declare namespace sap {
53771
54123
  * Returns a metadata object for class sap.ui.model.type.Date.
53772
54124
  */
53773
54125
  static getMetadata(): sap.ui.base.Metadata;
53774
-
53775
- getOutputPattern(): void;
54126
+ /**
54127
+ * Returns the output pattern.
54128
+ * See:
54129
+ * sap.ui.core.format.DateFormat.getDateInstance
54130
+ */
54131
+ getOutputPattern(): string;
53776
54132
  }
53777
54133
  /**
53778
54134
  * This class represents the Date interval composite type.
@@ -54592,18 +54948,20 @@ declare namespace sap {
54592
54948
  */
54593
54949
  constructor(
54594
54950
  /**
54595
- * the model
54951
+ * The model
54596
54952
  */
54597
54953
  oModel: sap.ui.model.Model,
54598
54954
  /**
54599
- * the path
54955
+ * The path
54600
54956
  */
54601
54957
  sPath: string,
54602
54958
  /**
54603
- * the context object
54959
+ * The context object
54604
54960
  */
54605
54961
  oContext: sap.ui.model.Context,
54606
-
54962
+ /**
54963
+ * Additional, implementation-specific parameters
54964
+ */
54607
54965
  mParameters?: object
54608
54966
  );
54609
54967
 
@@ -54641,27 +54999,27 @@ declare namespace sap {
54641
54999
  */
54642
55000
  attachAggregatedDataStateChange(
54643
55001
  /**
54644
- * The function to be called, when the event occurs
55002
+ * The function to be called when the event occurs
54645
55003
  */
54646
55004
  fnFunction: Function,
54647
55005
  /**
54648
- * Context object to call the event handler with, defaults to this `sap.ui.model.Binding` itself
55006
+ * Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
54649
55007
  */
54650
55008
  oListener?: object
54651
55009
  ): void;
54652
55010
  /**
54653
- * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.model.Model`.
55011
+ * Attaches the `fnFunction` event handler to the {@link #event:change change} event of this `sap.ui.model.Model`.
54654
55012
  *
54655
55013
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
54656
55014
  * otherwise it will be bound to this `sap.ui.model.Binding` itself.
54657
55015
  */
54658
55016
  attachChange(
54659
55017
  /**
54660
- * The function to be called, when the event occurs
55018
+ * The function to be called when the event occurs
54661
55019
  */
54662
55020
  fnFunction: Function,
54663
55021
  /**
54664
- * Context object to call the event handler with, defaults to this `sap.ui.model.Binding` itself
55022
+ * Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
54665
55023
  */
54666
55024
  oListener?: object
54667
55025
  ): void;
@@ -54673,11 +55031,11 @@ declare namespace sap {
54673
55031
  */
54674
55032
  attachDataReceived(
54675
55033
  /**
54676
- * Function to be called, when the event occurs
55034
+ * Function to be called when the event occurs
54677
55035
  */
54678
55036
  fnFunction: Function,
54679
55037
  /**
54680
- * Context object to call the event handler with, defaults to this `sap.ui.model.Binding` itself
55038
+ * Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
54681
55039
  */
54682
55040
  oListener?: object
54683
55041
  ): void;
@@ -54689,35 +55047,40 @@ declare namespace sap {
54689
55047
  */
54690
55048
  attachDataRequested(
54691
55049
  /**
54692
- * The function to be called, when the event occurs
55050
+ * The function to be called when the event occurs
54693
55051
  */
54694
55052
  fnFunction: Function,
54695
55053
  /**
54696
- * Context object to call the event handler with, defaults to this `sap.ui.model.Binding` itself
55054
+ * Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
54697
55055
  */
54698
55056
  oListener?: object
54699
55057
  ): void;
54700
55058
  /**
54701
- * Attaches event handler `fnFunction` to the {@link #event:DataStateChange DataStateChange} event of this
54702
- * `sap.ui.model.Binding`.
55059
+ * Attaches the `fnFunction` event handler to the {@link #event:DataStateChange DataStateChange} event of
55060
+ * thi `sap.ui.model.Binding`.
54703
55061
  *
54704
55062
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
54705
55063
  * otherwise it will be bound to this `sap.ui.model.Binding` itself.
54706
55064
  */
54707
55065
  attachDataStateChange(
54708
55066
  /**
54709
- * Function to be called, when the event occurs
55067
+ * Function to be called when the event occurs
54710
55068
  */
54711
55069
  fnFunction: Function,
54712
55070
  /**
54713
- * Context object to call the event handler with, defaults to this `sap.ui.model.Binding` itself
55071
+ * Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
54714
55072
  */
54715
55073
  oListener?: object
54716
55074
  ): void;
54717
55075
  /**
54718
55076
  * Attach multiple events.
54719
55077
  */
54720
- attachEvents(oEvents: Record<string, Function>): void;
55078
+ attachEvents(
55079
+ /**
55080
+ * Events to attach to this binding
55081
+ */
55082
+ oEvents: Record<string, Function>
55083
+ ): sap.ui.model.Binding;
54721
55084
  /**
54722
55085
  * Attaches event handler `fnFunction` to the {@link #event:refresh refresh} event of this `sap.ui.model.Binding`.
54723
55086
  *
@@ -54726,11 +55089,11 @@ declare namespace sap {
54726
55089
  */
54727
55090
  attachRefresh(
54728
55091
  /**
54729
- * The function to be called, when the event occurs
55092
+ * The function to be called when the event occurs
54730
55093
  */
54731
55094
  fnFunction: Function,
54732
55095
  /**
54733
- * Context object to call the event handler with, defaults to this `sap.ui.model.Binding` itself
55096
+ * Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
54734
55097
  */
54735
55098
  oListener?: object
54736
55099
  ): void;
@@ -54747,7 +55110,7 @@ declare namespace sap {
54747
55110
  */
54748
55111
  detachAggregatedDataStateChange(
54749
55112
  /**
54750
- * The function to be called, when the event occurs
55113
+ * The function to be called when the event occurs
54751
55114
  */
54752
55115
  fnFunction: Function,
54753
55116
  /**
@@ -54760,7 +55123,7 @@ declare namespace sap {
54760
55123
  */
54761
55124
  detachChange(
54762
55125
  /**
54763
- * Function to be called, when the event occurs
55126
+ * Function to be called when the event occurs
54764
55127
  */
54765
55128
  fnFunction: Function,
54766
55129
  /**
@@ -54773,7 +55136,7 @@ declare namespace sap {
54773
55136
  */
54774
55137
  detachDataReceived(
54775
55138
  /**
54776
- * Function to be called, when the event occurs
55139
+ * Function to be called when the event occurs
54777
55140
  */
54778
55141
  fnFunction: Function,
54779
55142
  /**
@@ -54787,7 +55150,7 @@ declare namespace sap {
54787
55150
  */
54788
55151
  detachDataRequested(
54789
55152
  /**
54790
- * The function to be called, when the event occurs
55153
+ * The function to be called when the event occurs
54791
55154
  */
54792
55155
  fnFunction: Function,
54793
55156
  /**
@@ -54801,7 +55164,7 @@ declare namespace sap {
54801
55164
  */
54802
55165
  detachDataStateChange(
54803
55166
  /**
54804
- * The function to be called, when the event occurs
55167
+ * The function to be called when the event occurs
54805
55168
  */
54806
55169
  fnFunction: Function,
54807
55170
  /**
@@ -54812,17 +55175,22 @@ declare namespace sap {
54812
55175
  /**
54813
55176
  * Detach multiple events.
54814
55177
  */
54815
- detachEvents(oEvents: Record<string, Function>): void;
55178
+ detachEvents(
55179
+ /**
55180
+ * Events to detach from this binding
55181
+ */
55182
+ oEvents: Record<string, Function>
55183
+ ): sap.ui.model.Binding;
54816
55184
  /**
54817
55185
  * Detaches event handler `fnFunction` from the {@link #event:refresh refresh} event of this `sap.ui.model.Binding`.
54818
55186
  */
54819
55187
  detachRefresh(
54820
55188
  /**
54821
- * The function to be called, when the event occurs
55189
+ * The function to be called when the event occurs
54822
55190
  */
54823
55191
  fnFunction: Function,
54824
55192
  /**
54825
- * object on which to call the given function.
55193
+ * Object on which to call the given function.
54826
55194
  */
54827
55195
  oListener?: object
54828
55196
  ): void;
@@ -54833,11 +55201,11 @@ declare namespace sap {
54833
55201
  */
54834
55202
  fireDataReceived(
54835
55203
  /**
54836
- * Parameters to pass along with the event.
55204
+ * Parameters to pass along with the event
54837
55205
  */
54838
55206
  oParameters: {
54839
55207
  /**
54840
- * Data received. In error cases it will be undefined.
55208
+ * Data received; on error cases it will be undefined
54841
55209
  */
54842
55210
  data?: object;
54843
55211
  }
@@ -54847,7 +55215,7 @@ declare namespace sap {
54847
55215
  */
54848
55216
  fireDataRequested(
54849
55217
  /**
54850
- * Parameters to pass along with the event.
55218
+ * Parameters to pass along with the event
54851
55219
  */
54852
55220
  oParameters: object
54853
55221
  ): void;
@@ -54893,11 +55261,11 @@ declare namespace sap {
54893
55261
  */
54894
55262
  initialize(): void;
54895
55263
  /**
54896
- * Returns whether the binding is initial, which means it did not get an initial value yet
55264
+ * Returns whether the binding is initial, which means it did not get an initial value yet.
54897
55265
  */
54898
55266
  isInitial(): boolean;
54899
55267
  /**
54900
- * Returns whether the binding is relative, which means its path does not start with a slash ('/')
55268
+ * Returns whether the binding is relative, which means its path does not start with a slash.
54901
55269
  */
54902
55270
  isRelative(): boolean;
54903
55271
  /**
@@ -54930,8 +55298,8 @@ declare namespace sap {
54930
55298
  /**
54931
55299
  * Resumes the binding update. Change events will be fired again.
54932
55300
  *
54933
- * When the binding is resumed, a change event will be fired immediately, if the data has changed while
54934
- * the binding was suspended. For server-side models, a request to the server will be triggered, if a refresh
55301
+ * When the binding is resumed, a change event will be fired immediately if the data has changed while the
55302
+ * binding was suspended. For server-side models, a request to the server will be triggered if a refresh
54935
55303
  * was requested while the binding was suspended.
54936
55304
  */
54937
55305
  resume(): void;
@@ -55379,9 +55747,9 @@ declare namespace sap {
55379
55747
  */
55380
55748
  sort(
55381
55749
  /**
55382
- * array of Sorter instances which will be applied
55750
+ * An array of Sorter instances which will be applied
55383
55751
  */
55384
- an: sap.ui.model.Sorter[]
55752
+ aSorters: sap.ui.model.Sorter[]
55385
55753
  ): this;
55386
55754
  }
55387
55755
 
@@ -55397,7 +55765,7 @@ declare namespace sap {
55397
55765
  *
55398
55766
  * A `CompositeBinding` combines the values from all its binding parts (each an instance of `PropertyBinding`),
55399
55767
  * either by calling a formatter function or by involving a {@link sap.ui.model.CompositeType composite
55400
- * type}. When a formatter function is used, then the composite binding is automatically limited to `OneWay`
55768
+ * type}. When a formatter function is used, the composite binding is automatically limited to `OneWay`
55401
55769
  * mode. When a type is used, the binding can also operate in `TwoWay` mode.
55402
55770
  *
55403
55771
  * Higher layers of the framework derive composite bindings from easy-to-write string representations (the
@@ -55463,7 +55831,7 @@ declare namespace sap {
55463
55831
  */
55464
55832
  fnFunction: Function,
55465
55833
  /**
55466
- * object on which to call the given function.
55834
+ * Object on which to call the given function
55467
55835
  */
55468
55836
  oListener?: object
55469
55837
  ): void;
@@ -55479,7 +55847,7 @@ declare namespace sap {
55479
55847
  */
55480
55848
  fnFunction: Function,
55481
55849
  /**
55482
- * object on which to call the given function
55850
+ * Object on which to call the given function
55483
55851
  */
55484
55852
  oListener?: object
55485
55853
  ): void;
@@ -55495,7 +55863,7 @@ declare namespace sap {
55495
55863
  */
55496
55864
  fnFunction: Function,
55497
55865
  /**
55498
- * object on which to call the given function
55866
+ * Object on which to call the given function
55499
55867
  */
55500
55868
  oListener?: object
55501
55869
  ): void;
@@ -55508,7 +55876,7 @@ declare namespace sap {
55508
55876
  */
55509
55877
  fnFunction: Function,
55510
55878
  /**
55511
- * object on which to call the given function
55879
+ * Object on which to call the given function
55512
55880
  */
55513
55881
  oListener?: object
55514
55882
  ): void;
@@ -55521,7 +55889,7 @@ declare namespace sap {
55521
55889
  */
55522
55890
  fnFunction: Function,
55523
55891
  /**
55524
- * object on which to call the given function
55892
+ * Object on which to call the given function
55525
55893
  */
55526
55894
  oListener?: object
55527
55895
  ): void;
@@ -55534,7 +55902,7 @@ declare namespace sap {
55534
55902
  */
55535
55903
  fnFunction: Function,
55536
55904
  /**
55537
- * object on which to call the given function
55905
+ * Object on which to call the given function
55538
55906
  */
55539
55907
  oListener?: object
55540
55908
  ): void;
@@ -55548,12 +55916,12 @@ declare namespace sap {
55548
55916
  getExternalValue(): object;
55549
55917
  /**
55550
55918
  * Returns the current internal value of the bound target which is an array of the internal (JS native)
55551
- * values of nested bindings
55919
+ * values of nested bindings.
55552
55920
  */
55553
55921
  getInternalValue(): any[];
55554
55922
  /**
55555
55923
  * Returns the current raw value of the bound target which is an array of the raw (model) values of nested
55556
- * bindings
55924
+ * bindings.
55557
55925
  */
55558
55926
  getRawValue(): any[];
55559
55927
  /**
@@ -55562,10 +55930,10 @@ declare namespace sap {
55562
55930
  getValue(): object;
55563
55931
  /**
55564
55932
  * Initialize the binding. The method should be called when creating a binding. The default implementation
55565
- * calls checkUpdate(true). Prevent checkUpdate to be triggered while initializing nestend bindings, it
55566
- * is sufficient to call checkUpdate when all nested bindings are initialized.
55933
+ * calls checkUpdate(true). Prevent checkUpdate to be triggered while initializing nested bindings, it is
55934
+ * sufficient to call checkUpdate when all nested bindings are initialized.
55567
55935
  */
55568
- initialize(): void;
55936
+ initialize(): this;
55569
55937
  /**
55570
55938
  * Suspends the binding update. No change events will be fired.
55571
55939
  *
@@ -55576,12 +55944,12 @@ declare namespace sap {
55576
55944
  resume(): void;
55577
55945
  /**
55578
55946
  * Sets the external value of a composite binding. If no CompositeType is assigned to the binding, the default
55579
- * implementation assumes a space separated list of values. This will cause the setValue to be called for
55947
+ * implementation assumes a space-separated list of values. This will cause the setValue to be called for
55580
55948
  * each nested binding, except for undefined values in the array.
55581
55949
  */
55582
55950
  setExternalValue(
55583
55951
  /**
55584
- * the value to set for this binding
55952
+ * The value to set for this binding
55585
55953
  */
55586
55954
  oValue: object
55587
55955
  ): undefined | Promise<any>;
@@ -55594,7 +55962,7 @@ declare namespace sap {
55594
55962
  * the new values of the nested bindings
55595
55963
  */
55596
55964
  aValues: any[]
55597
- ): void;
55965
+ ): undefined | Promise<any>;
55598
55966
  /**
55599
55967
  * Sets the raw value of the bound target. Parameter must be an array of values matching the raw (model)
55600
55968
  * types of nested bindings.
@@ -55604,7 +55972,7 @@ declare namespace sap {
55604
55972
  * the new values of the nested bindings
55605
55973
  */
55606
55974
  aValues: any[]
55607
- ): void;
55975
+ ): undefined | Promise<any>;
55608
55976
  /**
55609
55977
  * Sets the optional type and internal type for the binding. The type and internal type are used to do the
55610
55978
  * parsing/formatting correctly. The internal type is the property type of the element which the value is
@@ -55612,11 +55980,11 @@ declare namespace sap {
55612
55980
  */
55613
55981
  setType(
55614
55982
  /**
55615
- * the type for the binding
55983
+ * The type for the binding
55616
55984
  */
55617
55985
  oType: sap.ui.model.CompositeType,
55618
55986
  /**
55619
- * the internal type of the element property which this binding is bound against.
55987
+ * The internal type of the element property which this binding is bound against.
55620
55988
  */
55621
55989
  sInternalType: string
55622
55990
  ): void;
@@ -55626,7 +55994,7 @@ declare namespace sap {
55626
55994
  */
55627
55995
  setValue(
55628
55996
  /**
55629
- * the values to set for this binding
55997
+ * The values to set for this binding
55630
55998
  */
55631
55999
  aValues: any[]
55632
56000
  ): void;
@@ -56218,17 +56586,19 @@ declare namespace sap {
56218
56586
  * You either pass a single object literal with the filter parameters or use the individual constructor
56219
56587
  * arguments. No matter which variant is used, only certain combinations of parameters are supported (the
56220
56588
  * following list uses the names from the object literal):
56221
- * - A `path`, `operator` and one or two values (`value1`, `value2`), depending on the operator
56222
- * - A `path` and a custom filter function `test`
56223
- * - An array of other filters named `filters` and a Boolean flag `and` that specifies whether to combine
56224
- * the filters with an AND (`true`) or an OR (`false`) operator. An error will be logged to the console
56225
- * if an invalid combination of parameters is provided. Please note that a model implementation may not
56226
- * support a custom filter function, e.g. if the model does not perform client side filtering. It also depends
56227
- * on the model implementation if the filtering is case sensitive or not. Client models filter case insensitive
56228
- * compared to the OData models which filter case sensitive by default. See particular model documentation
56229
- * for details The filter operators `Any` and `All` are only supported in V4 OData models. When creating
56230
- * a filter instance with these filter operators, the argument `variable` only accepts a string identifier
56231
- * and `condition` needs to be another filter instance.
56589
+ * A `path`, `operator` and one or two values (`value1`, `value2`), depending on the operator A `path`
56590
+ * and a custom filter function `test` An array of other filters named `filters` and a Boolean flag
56591
+ * `and` that specifies whether to combine the filters with an AND (`true`) or an OR (`false`) operator.
56592
+ * An error will be logged to the console if an invalid combination of parameters is provided.
56593
+ *
56594
+ * Please note that a model implementation may not support a custom filter function, e.g. if the model does
56595
+ * not perform client-side filtering. It also depends on the model implementation if the filtering is case
56596
+ * sensitive or not. Client models filter case insensitive compared to the OData models which filter case
56597
+ * sensitive by default. See particular model documentation for details.
56598
+ *
56599
+ * The filter operators {@link sap.ui.model.FilterOperator.Any "Any"} and {@link sap.ui.model.FilterOperator.All
56600
+ * "All"} are only supported in V4 OData models. When creating a filter instance with these filter operators,
56601
+ * the argument `variable` only accepts a string identifier and `condition` needs to be another filter instance.
56232
56602
  */
56233
56603
  constructor(
56234
56604
  /**
@@ -56241,15 +56611,19 @@ declare namespace sap {
56241
56611
  */
56242
56612
  path?: string;
56243
56613
  /**
56244
- * Function which is used to filter the items and which should return a Boolean value to indicate whether
56245
- * the current item passes the filter
56614
+ * Function used for the client-side filtering of items. It should return a Boolean indicating whether the
56615
+ * current item passes the filter. If no test function is given, a default test function is used, based
56616
+ * on the given filter operator and the comparator function.
56246
56617
  */
56247
- test?: Function;
56618
+ test?: (p1: any) => boolean;
56248
56619
  /**
56249
- * Function which is used to compare two values, this is used for processing of equal, less than and greater
56250
- * than operators
56620
+ * Function used to compare two values for equality and order during client-side filtering. Two values are
56621
+ * given as parameters. The function is expected to return:
56622
+ * a negative number if the first value is smaller than the second value, `0` if the two values are
56623
+ * equal, a positive number if the first value is larger than the second value, `NaN` for non-comparable
56624
+ * values. If no function is given, {@link sap.ui.model.Filter.defaultComparator} is used.
56251
56625
  */
56252
- comparator?: Function;
56626
+ comparator?: (p1: any, p2: any) => number;
56253
56627
  /**
56254
56628
  * Operator used for the filter
56255
56629
  */
@@ -56259,44 +56633,52 @@ declare namespace sap {
56259
56633
  */
56260
56634
  value1?: any;
56261
56635
  /**
56262
- * Second value to use with the filter operator (only for some operators)
56636
+ * Second value to use with the given filter operator, used only for the {@link sap.ui.model.FilterOperator.BT
56637
+ * "BT" between} and {@link sap.ui.model.FilterOperator.NB "NB" not between} filter operators
56263
56638
  */
56264
56639
  value2?: any;
56265
56640
  /**
56266
- * The variable used in lambda operators (`Any` and `All`)
56641
+ * The variable name used in lambda operators ({@link sap.ui.model.FilterOperator.Any "Any"} and {@link
56642
+ * sap.ui.model.FilterOperator.All "All"})
56267
56643
  */
56268
56644
  variable?: string;
56269
56645
  /**
56270
- * A `Filter` instance which will be used as the condition for the lambda operator
56646
+ * A filter instance which will be used as the condition for lambda operators ({@link sap.ui.model.FilterOperator.Any
56647
+ * "Any"} and {@link sap.ui.model.FilterOperator.All "All"})
56271
56648
  */
56272
56649
  condition?: sap.ui.model.Filter;
56273
56650
  /**
56274
- * Array of filters on which logical conjunction is applied
56651
+ * An array of filters on which the logical conjunction is applied
56275
56652
  */
56276
56653
  filters?: sap.ui.model.Filter[];
56277
56654
  /**
56278
56655
  * Indicates whether an "AND" logical conjunction is applied on the filters. If it's not set or set to `false`,
56279
- * an "OR" conjunction is applied
56656
+ * an "OR" conjunction is applied.
56280
56657
  */
56281
56658
  and?: boolean;
56282
56659
  /**
56283
- * Indicates whether a string value should be compared case sensitive or not.
56660
+ * Indicates whether a string value should be compared case sensitive or not. The handling of `undefined`
56661
+ * depends on the model implementation.
56284
56662
  */
56285
56663
  caseSensitive?: boolean;
56286
56664
  }
56287
56665
  | string
56288
56666
  | sap.ui.model.Filter[],
56289
56667
  /**
56290
- * Either a filter operator or a custom filter function or a Boolean flag that defines how to combine multiple
56291
- * filters
56668
+ * Either a filter operator or a custom filter function or a `boolean` flag that defines how to combine
56669
+ * multiple filters
56292
56670
  */
56293
- vOperator?: sap.ui.model.FilterOperator | Function | boolean,
56671
+ vOperator?:
56672
+ | sap.ui.model.FilterOperator
56673
+ | ((p1: any) => boolean)
56674
+ | boolean,
56294
56675
  /**
56295
56676
  * First value to use with the given filter operator
56296
56677
  */
56297
56678
  vValue1?: any,
56298
56679
  /**
56299
- * Second value to use with the given filter operator (only for some operators)
56680
+ * Second value to use with the given filter operator, used only for the {@link sap.ui.model.FilterOperator.BT
56681
+ * "BT" between} and {@link sap.ui.model.FilterOperator.NB "NB" not between} filter operators
56300
56682
  */
56301
56683
  vValue2?: any
56302
56684
  );
@@ -56304,7 +56686,7 @@ declare namespace sap {
56304
56686
  /**
56305
56687
  * Compares two values
56306
56688
  *
56307
- * This is the default comparator function used for clientside filtering, if no custom comparator is given
56689
+ * This is the default comparator function used for client-side filtering, if no custom comparator is given
56308
56690
  * in the constructor. It does compare just by using equal/less than/greater than with automatic type casting,
56309
56691
  * except for null values, which are neither less or greater, and string values where localeCompare is used.
56310
56692
  *
@@ -56319,7 +56701,7 @@ declare namespace sap {
56319
56701
  * the second value to compare
56320
56702
  */
56321
56703
  b: any
56322
- ): int;
56704
+ ): number;
56323
56705
  /**
56324
56706
  * Creates a new subclass of class sap.ui.model.Filter with name `sClassName` and enriches it with the information
56325
56707
  * contained in `oClassInfo`.
@@ -56345,6 +56727,83 @@ declare namespace sap {
56345
56727
  * Returns a metadata object for class sap.ui.model.Filter.
56346
56728
  */
56347
56729
  static getMetadata(): sap.ui.base.Metadata;
56730
+ /**
56731
+ * @SINCE 1.96.0
56732
+ *
56733
+ * Returns the comparator function as provided on construction of this filter, see {@link sap.ui.model.Filter#constructor},
56734
+ * parameter `vFilterInfo.comparator`.
56735
+ */
56736
+ getComparator(): ((p1: any) => boolean) | undefined;
56737
+ /**
56738
+ * @SINCE 1.96.0
56739
+ *
56740
+ * Returns the filter instance which is used as the condition for lambda operators, see {@link sap.ui.model.Filter#constructor},
56741
+ * parameter `vFilterInfo.condition`.
56742
+ */
56743
+ getCondition(): sap.ui.model.Filter | undefined;
56744
+ /**
56745
+ * @SINCE 1.96.0
56746
+ *
56747
+ * Returns the array of filters as specified on construction of this filter, see {@link sap.ui.model.Filter#constructor},
56748
+ * parameter `vFilterInfo.filters`
56749
+ */
56750
+ getFilters(): sap.ui.model.Filter[] | undefined;
56751
+ /**
56752
+ * @SINCE 1.96.0
56753
+ *
56754
+ * Returns the filter operator used for this filter, see {@link sap.ui.model.Filter#constructor}, parameter
56755
+ * `vFilterInfo.operator` or `vOperator`.
56756
+ */
56757
+ getOperator(): sap.ui.model.FilterOperator | undefined;
56758
+ /**
56759
+ * @SINCE 1.96.0
56760
+ *
56761
+ * Returns the binding path for this filter, see {@link sap.ui.model.Filter#constructor}, parameter `vFilterInfo`
56762
+ * or `vFilterInfo.path`.
56763
+ */
56764
+ getPath(): string | undefined;
56765
+ /**
56766
+ * @SINCE 1.96.0
56767
+ *
56768
+ * Returns the test function which is used to filter the items, see {@link sap.ui.model.Filter#constructor},
56769
+ * parameter `vFilterInfo.test`.
56770
+ */
56771
+ getTest(): ((p1: any, p2: any) => boolean) | undefined;
56772
+ /**
56773
+ * @SINCE 1.96.0
56774
+ *
56775
+ * Returns the first value that is used with the given filter operator, see {@link sap.ui.model.Filter#constructor},
56776
+ * parameter `vFilterInfo.value1` or `vValue1`.
56777
+ */
56778
+ getValue1(): any;
56779
+ /**
56780
+ * @SINCE 1.96.0
56781
+ *
56782
+ * Returns the second value that is used with the given filter operator, see {@link sap.ui.model.Filter#constructor},
56783
+ * parameter `vFilterInfo.value2` or `vValue2`.
56784
+ */
56785
+ getValue2(): any;
56786
+ /**
56787
+ * @SINCE 1.96.0
56788
+ *
56789
+ * Returns the variable name used in lambda operators, see {@link sap.ui.model.Filter#constructor}, parameter
56790
+ * `vFilterInfo.variable`.
56791
+ */
56792
+ getVariable(): string | undefined;
56793
+ /**
56794
+ * @SINCE 1.96.0
56795
+ *
56796
+ * Indicates whether an "AND" logical conjunction is applied on the filters, see {@link sap.ui.model.Filter#constructor},
56797
+ * parameter `vFilterInfo.and`.
56798
+ */
56799
+ isAnd(): boolean;
56800
+ /**
56801
+ * @SINCE 1.96.0
56802
+ *
56803
+ * Indicates whether a string value should be compared case sensitive, see {@link sap.ui.model.Filter#constructor},
56804
+ * parameter `vFilterInfo.caseSensitive`.
56805
+ */
56806
+ isCaseSensitive(): boolean;
56348
56807
  }
56349
56808
  /**
56350
56809
  * Instances of this exception are thrown when converting a model value to its representation on the UI
@@ -56439,7 +56898,7 @@ declare namespace sap {
56439
56898
  */
56440
56899
  fnFunction: Function,
56441
56900
  /**
56442
- * Context object to call the event handler with, defaults to this `ListBinding` itself
56901
+ * Context object to call the event handler with; defaults to this `ListBinding` itself
56443
56902
  */
56444
56903
  oListener?: object
56445
56904
  ): void;
@@ -56458,7 +56917,7 @@ declare namespace sap {
56458
56917
  */
56459
56918
  fnFunction: Function,
56460
56919
  /**
56461
- * Context object to call the event handler with, defaults to this `ListBinding` itself
56920
+ * Context object to call the event handler with; defaults to this `ListBinding` itself
56462
56921
  */
56463
56922
  oListener?: object
56464
56923
  ): void;
@@ -56473,7 +56932,7 @@ declare namespace sap {
56473
56932
  */
56474
56933
  fnFunction: Function,
56475
56934
  /**
56476
- * on which the given function had to be called
56935
+ * On which object the given function had to be called
56477
56936
  */
56478
56937
  oListener?: object
56479
56938
  ): void;
@@ -56529,7 +56988,11 @@ declare namespace sap {
56529
56988
  * The path of the property containing the key or a function getting the context as only parameter to calculate
56530
56989
  * a key to identify an entry
56531
56990
  */
56532
- vKey: Function | string
56991
+ vKey: Function | string,
56992
+ /**
56993
+ * The configuration for the change detection
56994
+ */
56995
+ oExtendedChangeDetectionConfig: object
56533
56996
  ): void;
56534
56997
  /**
56535
56998
  * Applies a new set of filters to the list represented by this binding.
@@ -56538,18 +57001,18 @@ declare namespace sap {
56538
57001
  * a server and it might execute asynchronously.
56539
57002
  *
56540
57003
  * Application and Control Filters: Each list binding maintains two separate lists of filters, one for filters
56541
- * defined by the control that owns the binding and another list for filters that an application can define
57004
+ * defined by the control that owns the binding, and another list for filters that an application can define
56542
57005
  * in addition. When executing the filter operation, both sets of filters are combined.
56543
57006
  *
56544
- * By using the second parameter `sFilterType` of method `filter`, the caller can control which set of filters
57007
+ * By using the `sFilterType` parameter of the `filter` method, the caller can control which set of filters
56545
57008
  * is modified. If no type is given, then the behavior depends on the model implementation and should be
56546
57009
  * documented in the API reference for that model.
56547
57010
  *
56548
57011
  * Auto-Grouping of Filters: Filters are first grouped according to their binding path. All filters belonging
56549
- * to the same group are ORed and after that the results of all groups are ANDed. Usually this means, all
56550
- * filters applied to a single table column are ORed, while filters on different table columns are ANDed.
56551
- * Please either use the automatic grouping of filters (where applicable) or use explicit AND/OR filters,
56552
- * a mixture of both is not supported.
57012
+ * to the same path are ORed, and after that the results of all paths are ANDed. Usually this means that
57013
+ * all filters applied to the same property are ORed, while filters on different properties are ANDed. Please
57014
+ * use either the automatic grouping of filters (where applicable) or explicit AND/OR filters, as a mixture
57015
+ * of both is not supported.
56553
57016
  */
56554
57017
  filter(
56555
57018
  /**
@@ -56561,6 +57024,15 @@ declare namespace sap {
56561
57024
  */
56562
57025
  sFilterType?: sap.ui.model.FilterType
56563
57026
  ): this;
57027
+ /**
57028
+ * @SINCE 1.97.0
57029
+ *
57030
+ * Returns all current contexts of this list binding in no special order. Just like {@link #getCurrentContexts},
57031
+ * this method does not request any data from a back end and does not change the binding's state. In contrast
57032
+ * to {@link #getCurrentContexts}, it does not only return the contexts as last requested by a control,
57033
+ * but all that are currently available in the binding.
57034
+ */
57035
+ getAllCurrentContexts(): sap.ui.model.Context[];
56564
57036
  /**
56565
57037
  * Returns an array of binding contexts for the bound target list.
56566
57038
  *
@@ -56578,22 +57050,22 @@ declare namespace sap {
56578
57050
  */
56579
57051
  getContexts(
56580
57052
  /**
56581
- * the startIndex where to start the retrieval of contexts
57053
+ * The startIndex where to start the retrieval of contexts
56582
57054
  */
56583
57055
  iStartIndex?: int,
56584
57056
  /**
56585
- * determines how many contexts to retrieve beginning from the start index.
57057
+ * Determines how many contexts to retrieve beginning from the start index.
56586
57058
  */
56587
57059
  iLength?: int,
56588
57060
  /**
56589
57061
  * The maximum number of contexts to read before and after the given range; with this, controls can prefetch
56590
- * data that is likely to be needed soon, e.g. when scrolling down in a table. This parameter is model-specific
56591
- * and not implemented by all models.
57062
+ * data that is likely to be needed soon, e.g. when scrolling down in a table; this parameter is model-specific
57063
+ * and not implemented by all models
56592
57064
  */
56593
57065
  iMaximumPrefetchSize?: int,
56594
57066
  /**
56595
57067
  * Whether this call keeps the result of {@link #getCurrentContexts} untouched; since 1.86.0. This parameter
56596
- * is model-specific and not implemented by all models.
57068
+ * is model-specific and not implemented by all models
56597
57069
  */
56598
57070
  bKeepCurrent?: boolean
56599
57071
  ): sap.ui.model.Context[];
@@ -56613,11 +57085,10 @@ declare namespace sap {
56613
57085
  /**
56614
57086
  * @SINCE 1.28
56615
57087
  *
56616
- * Returns an array of currently used binding contexts of the bound control.
57088
+ * Returns the contexts of this list binding as last requested by the control and in the same order the
57089
+ * control has received them.
56617
57090
  *
56618
- * This method does not trigger any data requests from the backend or delta calculation, but just returns
56619
- * the context array as last requested by the control. This can be used by the application to get access
56620
- * to the data currently displayed by a list control.
57091
+ * This method does not request any data from a back end and does not change the binding's state.
56621
57092
  */
56622
57093
  getCurrentContexts(): sap.ui.model.Context[];
56623
57094
  /**
@@ -56629,6 +57100,17 @@ declare namespace sap {
56629
57100
  */
56630
57101
  sPath: string
56631
57102
  ): any[];
57103
+ /**
57104
+ * @SINCE 1.96.0
57105
+ *
57106
+ * Returns the filters set via the constructor or via {@link #filter} for the given {@link sap.ui.model.FilterType}.
57107
+ */
57108
+ getFilters(
57109
+ /**
57110
+ * The FilterType
57111
+ */
57112
+ sFilterType: sap.ui.model.FilterType
57113
+ ): sap.ui.model.Filter[];
56632
57114
  /**
56633
57115
  * Gets the group for the given context. Must only be called if `isGrouped()` returns that grouping is enabled
56634
57116
  * for this binding. The grouping will be performed using the first sorter (in case multiple sorters are
@@ -56652,8 +57134,8 @@ declare namespace sap {
56652
57134
  */
56653
57135
  getLength(): int;
56654
57136
  /**
56655
- * Indicates whether grouping is enabled for the binding. Grouping is enabled for a list binding, if at
56656
- * least one sorter exists on the binding and the first sorter is a grouping sorter.
57137
+ * Indicates whether grouping is enabled for the binding. Grouping is enabled for a list binding if at least
57138
+ * one sorter exists on the binding and the first sorter is a grouping sorter.
56657
57139
  */
56658
57140
  isGrouped(): boolean;
56659
57141
  /**
@@ -56690,7 +57172,7 @@ declare namespace sap {
56690
57172
  * Instead of a single sorter also an array of sorters can be passed to the sort method. In this case they
56691
57173
  * are processed in the sequence in which they are contained in the array.
56692
57174
  *
56693
- * Grouping: Sorting and grouping are closely related, in case a list should be grouped, it must be sorted
57175
+ * Grouping: Sorting and grouping are closely related. In case a list should be grouped, it must be sorted
56694
57176
  * by the property to group with. Grouping is enabled by setting the `group` property on the sorter object.
56695
57177
  * If it is enabled, you can get the current group of an item using {@link sap.ui.model.ListBinding.prototype.getGroup}.
56696
57178
  * In case multiple sorters are provided, grouping can only be done on the first sorter, nested grouping
@@ -56698,7 +57180,7 @@ declare namespace sap {
56698
57180
  */
56699
57181
  sort(
56700
57182
  /**
56701
- * the Sorter object or an array of sorters which defines the sort order
57183
+ * The Sorter object or an array of sorters which defines the sort order
56702
57184
  */
56703
57185
  aSorters: sap.ui.model.Sorter | any[]
56704
57186
  ): this;
@@ -56788,7 +57270,7 @@ declare namespace sap {
56788
57270
  */
56789
57271
  oData: object,
56790
57272
  /**
56791
- * The function to be called, when the event occurs
57273
+ * The function to be called when the event occurs
56792
57274
  */
56793
57275
  fnFunction: Function,
56794
57276
  /**
@@ -56804,7 +57286,7 @@ declare namespace sap {
56804
57286
  */
56805
57287
  attachParseError(
56806
57288
  /**
56807
- * The function to be called, when the event occurs
57289
+ * The function to be called when the event occurs
56808
57290
  */
56809
57291
  fnFunction: Function,
56810
57292
  /**
@@ -56826,7 +57308,7 @@ declare namespace sap {
56826
57308
  */
56827
57309
  oData: object,
56828
57310
  /**
56829
- * The function to be called, when the event occurs
57311
+ * The function to be called when the event occurs
56830
57312
  */
56831
57313
  fnFunction: Function,
56832
57314
  /**
@@ -56843,7 +57325,7 @@ declare namespace sap {
56843
57325
  */
56844
57326
  attachPropertyChange(
56845
57327
  /**
56846
- * The function to be called, when the event occurs
57328
+ * The function to be called when the event occurs
56847
57329
  */
56848
57330
  fnFunction: Function,
56849
57331
  /**
@@ -56865,7 +57347,7 @@ declare namespace sap {
56865
57347
  */
56866
57348
  oData: object,
56867
57349
  /**
56868
- * The function to be called, when the event occurs
57350
+ * The function to be called when the event occurs
56869
57351
  */
56870
57352
  fnFunction: Function,
56871
57353
  /**
@@ -56882,7 +57364,7 @@ declare namespace sap {
56882
57364
  */
56883
57365
  attachRequestCompleted(
56884
57366
  /**
56885
- * The function to be called, when the event occurs
57367
+ * The function to be called when the event occurs
56886
57368
  */
56887
57369
  fnFunction: Function,
56888
57370
  /**
@@ -56903,7 +57385,7 @@ declare namespace sap {
56903
57385
  */
56904
57386
  oData: object,
56905
57387
  /**
56906
- * The function to be called, when the event occurs
57388
+ * The function to be called when the event occurs
56907
57389
  */
56908
57390
  fnFunction: Function,
56909
57391
  /**
@@ -56919,7 +57401,7 @@ declare namespace sap {
56919
57401
  */
56920
57402
  attachRequestFailed(
56921
57403
  /**
56922
- * The function to be called, when the event occurs
57404
+ * The function to be called when the event occurs
56923
57405
  */
56924
57406
  fnFunction: Function,
56925
57407
  /**
@@ -56940,7 +57422,7 @@ declare namespace sap {
56940
57422
  */
56941
57423
  oData: object,
56942
57424
  /**
56943
- * The function to be called, when the event occurs
57425
+ * The function to be called when the event occurs
56944
57426
  */
56945
57427
  fnFunction: Function,
56946
57428
  /**
@@ -56956,7 +57438,7 @@ declare namespace sap {
56956
57438
  */
56957
57439
  attachRequestSent(
56958
57440
  /**
56959
- * The function to be called, when the event occurs
57441
+ * The function to be called when the event occurs
56960
57442
  */
56961
57443
  fnFunction: Function,
56962
57444
  /**
@@ -56969,111 +57451,103 @@ declare namespace sap {
56969
57451
  */
56970
57452
  bindContext(
56971
57453
  /**
56972
- * the path pointing to the property that should be bound
57454
+ * The path pointing to the property that should be bound
56973
57455
  */
56974
57456
  sPath: string,
56975
57457
  /**
56976
- * the context object for this databinding (optional)
57458
+ * The context object for this databinding
56977
57459
  */
56978
57460
  oContext?: sap.ui.model.Context,
56979
57461
  /**
56980
- * additional model specific parameters (optional)
57462
+ * Additional model-specific parameters
56981
57463
  */
56982
57464
  mParameters?: object,
56983
57465
  /**
56984
- * event handlers can be passed to the binding ({change:myHandler})
57466
+ * Event handlers can be passed to the binding ({change:myHandler})
56985
57467
  */
56986
57468
  oEvents?: object
56987
57469
  ): sap.ui.model.ContextBinding;
56988
- /**
56989
- * Implement in inheriting classes.
56990
- */
57470
+
56991
57471
  bindList(
56992
57472
  /**
56993
- * the path pointing to the list / array that should be bound
57473
+ * The path pointing to the list / array that should be bound
56994
57474
  */
56995
57475
  sPath: string,
56996
57476
  /**
56997
- * the context object for this databinding (optional)
57477
+ * The context object for this databinding
56998
57478
  */
56999
57479
  oContext?: sap.ui.model.Context,
57000
57480
  /**
57001
- * initial sort order (can be either a sorter or an array of sorters) (optional)
57481
+ * Initial sort order (can be either a sorter or an array of sorters)
57002
57482
  */
57003
57483
  aSorters?: sap.ui.model.Sorter | sap.ui.model.Sorter[],
57004
57484
  /**
57005
- * predefined filter/s (can be either a filter or an array of filters) (optional)
57485
+ * Predefined filter/s (can be either a filter or an array of filters)
57006
57486
  */
57007
57487
  aFilters?: sap.ui.model.Filter | sap.ui.model.Filter[],
57008
57488
  /**
57009
- * additional model specific parameters (optional)
57489
+ * Additional model-specific parameters
57010
57490
  */
57011
57491
  mParameters?: object
57012
57492
  ): sap.ui.model.ListBinding;
57013
- /**
57014
- * Implement in inheriting classes.
57015
- */
57493
+
57016
57494
  bindProperty(
57017
57495
  /**
57018
- * the path pointing to the property that should be bound
57496
+ * The path pointing to the property that should be bound
57019
57497
  */
57020
57498
  sPath: string,
57021
57499
  /**
57022
- * the context object for this databinding (optional)
57500
+ * The context object for this databinding
57023
57501
  */
57024
57502
  oContext?: sap.ui.model.Context,
57025
57503
  /**
57026
- * additional model specific parameters (optional)
57504
+ * Additional model-specific parameters
57027
57505
  */
57028
57506
  mParameters?: object
57029
57507
  ): sap.ui.model.PropertyBinding;
57030
- /**
57031
- * Implement in inheriting classes.
57032
- */
57508
+
57033
57509
  bindTree(
57034
57510
  /**
57035
- * the path pointing to the tree / array that should be bound
57511
+ * The path pointing to the tree / array that should be bound
57036
57512
  */
57037
57513
  sPath: string,
57038
57514
  /**
57039
- * the context object for this databinding (optional)
57515
+ * The context object for this databinding
57040
57516
  */
57041
57517
  oContext?: sap.ui.model.Context,
57042
57518
  /**
57043
- * predefined filter/s contained in an array (optional)
57519
+ * Predefined filter/s contained in an array
57044
57520
  */
57045
57521
  aFilters?: sap.ui.model.Filter[],
57046
57522
  /**
57047
- * additional model specific parameters (optional)
57523
+ * Additional model specific parameters
57048
57524
  */
57049
57525
  mParameters?: object,
57050
57526
  /**
57051
- * predefined sap.ui.model.sorter/s contained in an array (optional)
57527
+ * Predefined sap.ui.model.sorter/s contained in an array
57052
57528
  */
57053
57529
  aSorters?: sap.ui.model.Sorter[]
57054
57530
  ): sap.ui.model.TreeBinding;
57055
- /**
57056
- * Implement in inheriting classes.
57057
- */
57531
+
57058
57532
  createBindingContext(
57059
57533
  /**
57060
- * the path to create the new context from
57534
+ * The path to create the new context from
57061
57535
  */
57062
57536
  sPath: string,
57063
57537
  /**
57064
- * the context which should be used to create the new binding context
57538
+ * The context which should be used to create the new binding context
57065
57539
  */
57066
57540
  oContext?: sap.ui.model.Context,
57067
57541
  /**
57068
- * the parameters used to create the new binding context
57542
+ * The parameters used to create the new binding context
57069
57543
  */
57070
57544
  mParameters?: object,
57071
57545
  /**
57072
- * the function which should be called after the binding context has been created
57546
+ * The function which should be called after the binding context has been created
57073
57547
  */
57074
57548
  fnCallBack?: Function,
57075
57549
  /**
57076
- * force reload even if data is already available. For server side models this should refetch the data from
57550
+ * Force reload even if data is already available; for server-side models this should refetch the data from
57077
57551
  * the server
57078
57552
  */
57079
57553
  bReload?: boolean
@@ -57081,18 +57555,16 @@ declare namespace sap {
57081
57555
  /**
57082
57556
  * Destroys the model and clears the model data.
57083
57557
  *
57084
- * A model implementation may override this function and perform model specific cleanup tasks e.g. abort
57558
+ * A model implementation may override this function and perform model-specific cleanup tasks e.g. abort
57085
57559
  * requests, prevent new requests, etc.
57086
57560
  * See:
57087
57561
  * sap.ui.base.Object.prototype.destroy
57088
57562
  */
57089
57563
  destroy(): void;
57090
- /**
57091
- * Implement in inheriting classes.
57092
- */
57564
+
57093
57565
  destroyBindingContext(
57094
57566
  /**
57095
- * to destroy
57567
+ * The context to destroy
57096
57568
  */
57097
57569
  oContext: sap.ui.model.Context
57098
57570
  ): void;
@@ -57103,7 +57575,7 @@ declare namespace sap {
57103
57575
  */
57104
57576
  detachParseError(
57105
57577
  /**
57106
- * The function to be called, when the event occurs
57578
+ * The function to be called when the event occurs
57107
57579
  */
57108
57580
  fnFunction: Function,
57109
57581
  /**
@@ -57119,7 +57591,7 @@ declare namespace sap {
57119
57591
  */
57120
57592
  detachPropertyChange(
57121
57593
  /**
57122
- * The function to be called, when the event occurs
57594
+ * The function to be called when the event occurs
57123
57595
  */
57124
57596
  fnFunction: Function,
57125
57597
  /**
@@ -57151,7 +57623,7 @@ declare namespace sap {
57151
57623
  */
57152
57624
  detachRequestFailed(
57153
57625
  /**
57154
- * The function to be called, when the event occurs
57626
+ * The function to be called when the event occurs
57155
57627
  */
57156
57628
  fnFunction: Function,
57157
57629
  /**
@@ -57179,23 +57651,10 @@ declare namespace sap {
57179
57651
  */
57180
57652
  fireParseError(
57181
57653
  /**
57182
- * Parameters to pass along with the event
57654
+ * Parameters to pass along with the event; May contain the following parameters: `errorCode`, `url`, `reason`,
57655
+ * `srcText`, `line`, `linePos`, `filePos`
57183
57656
  */
57184
- oParameters?: {
57185
- errorCode?: int;
57186
-
57187
- url?: string;
57188
-
57189
- reason?: string;
57190
-
57191
- srcText?: string;
57192
-
57193
- line?: int;
57194
-
57195
- linepos?: int;
57196
-
57197
- filepos?: int;
57198
- }
57657
+ oParameters?: object
57199
57658
  ): this;
57200
57659
  /**
57201
57660
  * Fires event {@link #event:propertyChange propertyChange} to attached listeners.
@@ -57214,11 +57673,11 @@ declare namespace sap {
57214
57673
  */
57215
57674
  path?: string;
57216
57675
  /**
57217
- * the context of the property
57676
+ * The context of the property
57218
57677
  */
57219
57678
  context?: object;
57220
57679
  /**
57221
- * the value of the property
57680
+ * The value of the property
57222
57681
  */
57223
57682
  value?: object;
57224
57683
  }
@@ -57232,7 +57691,7 @@ declare namespace sap {
57232
57691
  */
57233
57692
  oParameters?: {
57234
57693
  /**
57235
- * The url which was sent to the backend.
57694
+ * The url which was sent to the back end.
57236
57695
  */
57237
57696
  url?: string;
57238
57697
  /**
@@ -57274,7 +57733,7 @@ declare namespace sap {
57274
57733
  */
57275
57734
  statusText?: string;
57276
57735
  /**
57277
- * Response that has been received for the request ,as a text string
57736
+ * Response that has been received for the request, as a text string
57278
57737
  */
57279
57738
  responseText?: string;
57280
57739
  }
@@ -57288,7 +57747,7 @@ declare namespace sap {
57288
57747
  */
57289
57748
  oParameters?: {
57290
57749
  /**
57291
- * The url which is sent to the backend.
57750
+ * The url which is sent to the back end.
57292
57751
  */
57293
57752
  url?: string;
57294
57753
  /**
@@ -57300,7 +57759,7 @@ declare namespace sap {
57300
57759
  */
57301
57760
  async?: boolean;
57302
57761
  /**
57303
- * additional information for the request (if available) **deprecated**
57762
+ * Additional information for the request (if available) **deprecated**
57304
57763
  */
57305
57764
  info?: string;
57306
57765
  /**
@@ -57345,9 +57804,7 @@ declare namespace sap {
57345
57804
  * Returns the meta model associated with this model if it is available for the concrete model type.
57346
57805
  */
57347
57806
  getMetaModel(): sap.ui.model.MetaModel;
57348
- /**
57349
- * Implement in inheriting classes.
57350
- */
57807
+
57351
57808
  getObject(
57352
57809
  /**
57353
57810
  * Path to where to read the object
@@ -57358,7 +57815,7 @@ declare namespace sap {
57358
57815
  */
57359
57816
  oContext?: sap.ui.model.Context,
57360
57817
  /**
57361
- * Additional model specific parameters
57818
+ * Additional model-specific parameters
57362
57819
  */
57363
57820
  mParameters?: object
57364
57821
  ): any;
@@ -57377,16 +57834,14 @@ declare namespace sap {
57377
57834
  */
57378
57835
  oContext?: sap.ui.model.Context
57379
57836
  ): any;
57380
- /**
57381
- * Implement in inheriting classes.
57382
- */
57837
+
57383
57838
  getProperty(
57384
57839
  /**
57385
- * the path to where to read the attribute value
57840
+ * The path to where to read the attribute value
57386
57841
  */
57387
57842
  sPath: string,
57388
57843
  /**
57389
- * the context with which the path should be resolved
57844
+ * The context with which the path should be resolved
57390
57845
  */
57391
57846
  oContext?: sap.ui.model.Context
57392
57847
  ): any;
@@ -57527,7 +57982,7 @@ declare namespace sap {
57527
57982
  */
57528
57983
  static getMetadata(): sap.ui.base.Metadata;
57529
57984
  /**
57530
- * Returns the binding mode
57985
+ * Returns the binding mode.
57531
57986
  */
57532
57987
  getBindingMode(): sap.ui.model.BindingMode;
57533
57988
  /**
@@ -57535,7 +57990,7 @@ declare namespace sap {
57535
57990
  */
57536
57991
  getExternalValue(): any;
57537
57992
  /**
57538
- * Returns the formatter function
57993
+ * Returns the formatter function.
57539
57994
  */
57540
57995
  getFormatter(): Function;
57541
57996
  /**
@@ -57543,21 +57998,21 @@ declare namespace sap {
57543
57998
  * model format} of this binding's type. If this binding doesn't have a type, the original value which is
57544
57999
  * stored in the model is returned.
57545
58000
  *
57546
- * This method will be used when targetType if set to "internal" or it's included in a {@link sap.ui.model.CompositeBinding
58001
+ * This method will be used when targetType is set to "internal" or when it's included in a {@link sap.ui.model.CompositeBinding
57547
58002
  * CompositeBinding} and the CompositeBinding needs to have the related JavaScript primitive values for
57548
58003
  * its type or formatter.
57549
58004
  */
57550
58005
  getInternalValue(): any;
57551
58006
  /**
57552
- * Returns the raw model value, as it exists in the model dataset
58007
+ * Returns the raw model value, as it exists in the model dataset.
57553
58008
  *
57554
- * 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
57555
- * CompositeBinding} and the CompositeBinding needs to have the related JavaScript primitive values for
57556
- * its type or formatter.
58009
+ * This method will be used when targetType of a binding is set to "raw" or when it's include in a {@link
58010
+ * sap.ui.model.CompositeBinding CompositeBinding} and the CompositeBinding needs to have the related JavaScript
58011
+ * primitive values for its type or formatter.
57557
58012
  */
57558
58013
  getRawValue(): any;
57559
58014
  /**
57560
- * Returns the type if any for the binding.
58015
+ * Returns the type (if any) for the binding.
57561
58016
  */
57562
58017
  getType(): sap.ui.model.Type;
57563
58018
  /**
@@ -57572,22 +58027,22 @@ declare namespace sap {
57572
58027
  */
57573
58028
  resume(): void;
57574
58029
  /**
57575
- * Sets the binding mode
58030
+ * Sets the binding mode.
57576
58031
  */
57577
58032
  setBindingMode(
57578
58033
  /**
57579
- * the binding mode
58034
+ * The binding mode
57580
58035
  */
57581
58036
  sBindingMode: sap.ui.model.BindingMode
57582
58037
  ): void;
57583
58038
  /**
57584
58039
  * Sets the value for this binding. The value is parsed and validated against its type and then set to the
57585
58040
  * binding. A model implementation should check if the current default binding mode permits setting the
57586
- * binding value and if so set the new value also in the model.
58041
+ * binding value, and if so, set the new value in the model, too.
57587
58042
  */
57588
58043
  setExternalValue(
57589
58044
  /**
57590
- * the value to set for this binding
58045
+ * The value to set for this binding
57591
58046
  */
57592
58047
  vValue: any
57593
58048
  ): undefined | Promise<any>;
@@ -57596,7 +58051,7 @@ declare namespace sap {
57596
58051
  */
57597
58052
  setFormatter(
57598
58053
  /**
57599
- * the formatter function for the binding
58054
+ * The formatter function for the binding
57600
58055
  */
57601
58056
  fnFormatter: Function
57602
58057
  ): void;
@@ -57607,20 +58062,20 @@ declare namespace sap {
57607
58062
  */
57608
58063
  setInternalValue(
57609
58064
  /**
57610
- * the value to set for this binding
58065
+ * The value to set for this binding
57611
58066
  */
57612
58067
  vValue: any
57613
- ): void;
58068
+ ): Promise<any> | undefined;
57614
58069
  /**
57615
58070
  * Sets the value for this binding with the raw model value. This setter will perform type validation, in
57616
58071
  * case a type is defined on the binding.
57617
58072
  */
57618
58073
  setRawValue(
57619
58074
  /**
57620
- * the value to set for this binding
58075
+ * The value to set for this binding
57621
58076
  */
57622
58077
  vValue: any
57623
- ): void;
58078
+ ): Promise<any> | undefined;
57624
58079
  /**
57625
58080
  * Sets the optional type and internal type for the binding. The type and internal type are used to do the
57626
58081
  * parsing/formatting correctly. The internal type is the property type of the element which the value is
@@ -57628,17 +58083,17 @@ declare namespace sap {
57628
58083
  */
57629
58084
  setType(
57630
58085
  /**
57631
- * the type for the binding
58086
+ * The type for the binding
57632
58087
  */
57633
58088
  oType: sap.ui.model.Type,
57634
58089
  /**
57635
- * the internal type of the element property which this binding is bound against.
58090
+ * The internal type of the element property which this binding is bound against.
57636
58091
  */
57637
58092
  sInternalType: string
57638
58093
  ): void;
57639
58094
  /**
57640
58095
  * Sets the value for this binding. A model implementation should check if the current default binding mode
57641
- * permits setting the binding value and if so set the new value also in the model.
58096
+ * permits setting the binding value, and if so, set the new value in the model, too.
57642
58097
  */
57643
58098
  setValue(
57644
58099
  /**
@@ -58348,18 +58803,18 @@ declare namespace sap {
58348
58803
  * @deprecated (since 1.52) - This method is marked as 'protected' which was meant to be overwritten by
58349
58804
  * its subclasses. It may be renamed or deleted and should only be called from this class or its subclasses.
58350
58805
  *
58351
- * Calculate the request length based on the given information
58806
+ * Calculate the request length based on the given information.
58352
58807
  */
58353
58808
  _calculateRequestLength(
58354
58809
  /**
58355
- * the maximum group size
58810
+ * The maximum group size
58356
58811
  */
58357
- iMaxGroupSize: int,
58812
+ iMaxGroupSize: number,
58358
58813
  /**
58359
- * the information of the current section
58814
+ * The information of the current section
58360
58815
  */
58361
58816
  oSection: object
58362
- ): void;
58817
+ ): number;
58363
58818
  /**
58364
58819
  * Attaches event handler `fnFunction` to the {@link #event:selectionChanged selectionChanged} event of
58365
58820
  * this `sap.ui.model.TreeBindingAdapter`.
@@ -58458,6 +58913,10 @@ declare namespace sap {
58458
58913
  */
58459
58914
  iThreshold?: number
58460
58915
  ): sap.ui.model.Context[];
58916
+ /**
58917
+ * Returns the number of entries in the tree.
58918
+ */
58919
+ getLength(): number;
58461
58920
  /**
58462
58921
  * Gets an array of nodes for the requested part of the tree.
58463
58922
  */
@@ -58476,7 +58935,9 @@ declare namespace sap {
58476
58935
  iThreshold?: number
58477
58936
  ): object[];
58478
58937
  }
58479
-
58938
+ /**
58939
+ * @deprecated - use {@link sap.ui.model.TreeBindingAdapter} instead
58940
+ */
58480
58941
  class TreeBindingCompatibilityAdapter {
58481
58942
  /**
58482
58943
  * Adapter for TreeBindings to add the ListBinding functionality and use the tree structure in list based
@@ -58484,7 +58945,16 @@ declare namespace sap {
58484
58945
  *
58485
58946
  * This module is only for experimental and internal use!
58486
58947
  */
58487
- constructor();
58948
+ constructor(
58949
+ /**
58950
+ * The binding to add ListBinding functionality to
58951
+ */
58952
+ oBinding: sap.ui.model.TreeBinding,
58953
+ /**
58954
+ * The tree or tree table control using the given binding; the control is used for selection handling
58955
+ */
58956
+ oControl: object
58957
+ );
58488
58958
  }
58489
58959
  /**
58490
58960
  * This is an abstract base class for type objects.
@@ -58612,7 +59082,9 @@ declare namespace sap {
58612
59082
  * The list was refreshed
58613
59083
  */
58614
59084
  Refresh = "refresh",
58615
-
59085
+ /**
59086
+ * A context was removed from a binding.
59087
+ */
58616
59088
  Remove = "remove",
58617
59089
  /**
58618
59090
  * The list was sorted
@@ -59671,7 +60143,28 @@ declare namespace sap {
59671
60143
  | sap.ui.base.ManagedObject.PropertyBindingInfo;
59672
60144
  }
59673
60145
 
59674
- interface $PressSettings extends sap.ui.test.actions.$ActionSettings {}
60146
+ interface $PressSettings extends sap.ui.test.actions.$ActionSettings {
60147
+ /**
60148
+ * @SINCE 1.97
60149
+ *
60150
+ * If it is set to `true`, the Alt Key modifier will be used
60151
+ */
60152
+ altKey?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
60153
+
60154
+ /**
60155
+ * @SINCE 1.97
60156
+ *
60157
+ * If it is set to `true`, the Shift Key modifier will be used
60158
+ */
60159
+ shiftKey?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
60160
+
60161
+ /**
60162
+ * @SINCE 1.97
60163
+ *
60164
+ * If it is set to `true`, the Control Key modifier will be used
60165
+ */
60166
+ ctrlKey?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
60167
+ }
59675
60168
 
59676
60169
  interface $ScrollSettings extends sap.ui.test.actions.$ActionSettings {
59677
60170
  x?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
@@ -60134,13 +60627,22 @@ declare namespace sap {
60134
60627
  * see {@link sap.ui.test.actions.Press.controlAdapters}.
60135
60628
  */
60136
60629
  class Press extends sap.ui.test.actions.Action {
60630
+ /**
60631
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
60632
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
60633
+ * of the syntax of the settings object.
60634
+ */
60137
60635
  constructor(
60138
60636
  /**
60139
60637
  * Optional object with initial settings for the new instance
60140
60638
  */
60141
60639
  mSettings?: sap.ui.test.actions.$PressSettings
60142
60640
  );
60143
-
60641
+ /**
60642
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
60643
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
60644
+ * of the syntax of the settings object.
60645
+ */
60144
60646
  constructor(
60145
60647
  /**
60146
60648
  * Optional ID for the new instance; generated automatically if no non-empty ID is given. Note: this can
@@ -60188,6 +60690,75 @@ declare namespace sap {
60188
60690
  */
60189
60691
  oControl: sap.ui.core.Control
60190
60692
  ): void;
60693
+ /**
60694
+ * @SINCE 1.97
60695
+ *
60696
+ * Gets current value of property {@link #getAltKey altKey}.
60697
+ *
60698
+ * If it is set to `true`, the Alt Key modifier will be used
60699
+ */
60700
+ getAltKey(): boolean;
60701
+ /**
60702
+ * @SINCE 1.97
60703
+ *
60704
+ * Gets current value of property {@link #getCtrlKey ctrlKey}.
60705
+ *
60706
+ * If it is set to `true`, the Control Key modifier will be used
60707
+ */
60708
+ getCtrlKey(): boolean;
60709
+ /**
60710
+ * @SINCE 1.97
60711
+ *
60712
+ * Gets current value of property {@link #getShiftKey shiftKey}.
60713
+ *
60714
+ * If it is set to `true`, the Shift Key modifier will be used
60715
+ */
60716
+ getShiftKey(): boolean;
60717
+ /**
60718
+ * @SINCE 1.97
60719
+ *
60720
+ * Sets a new value for property {@link #getAltKey altKey}.
60721
+ *
60722
+ * If it is set to `true`, the Alt Key modifier will be used
60723
+ *
60724
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
60725
+ */
60726
+ setAltKey(
60727
+ /**
60728
+ * New value for property `altKey`
60729
+ */
60730
+ bAltKey: boolean
60731
+ ): this;
60732
+ /**
60733
+ * @SINCE 1.97
60734
+ *
60735
+ * Sets a new value for property {@link #getCtrlKey ctrlKey}.
60736
+ *
60737
+ * If it is set to `true`, the Control Key modifier will be used
60738
+ *
60739
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
60740
+ */
60741
+ setCtrlKey(
60742
+ /**
60743
+ * New value for property `ctrlKey`
60744
+ */
60745
+ bCtrlKey: boolean
60746
+ ): this;
60747
+ /**
60748
+ * @SINCE 1.97
60749
+ *
60750
+ * Sets a new value for property {@link #getShiftKey shiftKey}.
60751
+ *
60752
+ * If it is set to `true`, the Shift Key modifier will be used
60753
+ *
60754
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
60755
+ */
60756
+ setShiftKey(
60757
+ /**
60758
+ * New value for property `shiftKey`
60759
+ */
60760
+ bShiftKey: boolean
60761
+ ): this;
60191
60762
  }
60192
60763
  /**
60193
60764
  * @SINCE 1.90
@@ -60689,6 +61260,13 @@ declare namespace sap {
60689
61260
  * The name of the {@link sap.ui.model.resource.ResourceModel} assigned to the control.
60690
61261
  */
60691
61262
  modelName?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
61263
+
61264
+ /**
61265
+ * The boolean flag to indicate whether to utiliize the library bundle of the control
61266
+ */
61267
+ useLibraryBundle?:
61268
+ | boolean
61269
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
60692
61270
  }
60693
61271
 
60694
61272
  interface $InteractableSettings
@@ -61364,7 +61942,8 @@ declare namespace sap {
61364
61942
  * The I18NText matcher checks if a control property has the same value as a text from an I18N file.
61365
61943
  *
61366
61944
  * The matcher automatically:
61367
- * - retrieves the text from the assigned 'i18n' model (name can be changed)
61945
+ * - retrieves the text from the assigned 'i18n' model (name can be changed) or library resource bundle
61946
+ *
61368
61947
  * - checks that the I18N key does actually exist in the file
61369
61948
  * - checks if asynchronously loaded I18N have actually been loaded
61370
61949
  *
@@ -61379,6 +61958,10 @@ declare namespace sap {
61379
61958
  * }
61380
61959
  * }
61381
61960
  * ```
61961
+ *
61962
+ *
61963
+ * As of version 1.95 if the `useLibraryBundle` flag is set to `true`, the library resource bundle of the
61964
+ * control is used to resolve the i18n key.
61382
61965
  */
61383
61966
  class I18NText extends sap.ui.test.matchers.Matcher {
61384
61967
  /**
@@ -61444,6 +62027,12 @@ declare namespace sap {
61444
62027
  * The name of the control property to match the I18N text with.
61445
62028
  */
61446
62029
  getPropertyName(): string;
62030
+ /**
62031
+ * Gets current value of property {@link #getUseLibraryBundle useLibraryBundle}.
62032
+ *
62033
+ * The boolean flag to indicate whether to utiliize the library bundle of the control
62034
+ */
62035
+ getUseLibraryBundle(): boolean;
61447
62036
  /**
61448
62037
  * Checks if the control has a property that matches the I18N text
61449
62038
  */
@@ -61507,6 +62096,19 @@ declare namespace sap {
61507
62096
  */
61508
62097
  sPropertyName: string
61509
62098
  ): this;
62099
+ /**
62100
+ * Sets a new value for property {@link #getUseLibraryBundle useLibraryBundle}.
62101
+ *
62102
+ * The boolean flag to indicate whether to utiliize the library bundle of the control
62103
+ *
62104
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
62105
+ */
62106
+ setUseLibraryBundle(
62107
+ /**
62108
+ * New value for property `useLibraryBundle`
62109
+ */
62110
+ bUseLibraryBundle: boolean
62111
+ ): this;
61510
62112
  }
61511
62113
  /**
61512
62114
  * @SINCE 1.34