@openui5/ts-types-esm 1.96.1 → 1.97.1

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.96.1
267
+ // For Library Version: 1.97.1
268
268
 
269
269
  declare module "sap/base/assert" {
270
270
  /**
@@ -4877,8 +4877,8 @@ declare module "sap/ui/base/ManagedObject" {
4877
4877
  * **'library'** : string
4878
4878
  * Name of the library that the new subclass should belong to. If the subclass is a control or element,
4879
4879
  * it will automatically register with that library so that authoring tools can discover it. By convention,
4880
- * the name of the subclass should have the library name as a prefix, e.g. 'sap.ui.commons.Panel' belongs
4881
- * to library 'sap.ui.commons'.
4880
+ * the name of the subclass should have the library name as a prefix, but subfolders are allowed, e.g. `sap.ui.layout.form.Form`
4881
+ * belongs to library `sap.ui.layout`.
4882
4882
  *
4883
4883
  * **'properties'** : object
4884
4884
  * An object literal whose properties each define a new managed property in the ManagedObject subclass.
@@ -10354,6 +10354,8 @@ declare module "sap/ui/core/Component" {
10354
10354
  ): any;
10355
10355
  }
10356
10356
  /**
10357
+ * @SINCE 1.67
10358
+ *
10357
10359
  * Registry of all `Component`s that currently exist.
10358
10360
  */
10359
10361
  export interface registry {
@@ -12316,9 +12318,9 @@ declare module "sap/ui/core/Control" {
12316
12318
  * **IMPORTANT:**
12317
12319
  * This should be only used as FALLBACK when the Control events do not cover a specific use-case! Always
12318
12320
  * try using SAPUI5 control events, as e.g. accessibility-related functionality is then provided automatically.
12319
- * E.g. when working with a `sap.ui.commons.Button`, always use the Button's "press" event, not the native
12320
- * "click" event, because "press" is also guaranteed to be fired when certain keyboard activity is supposed
12321
- * to trigger the Button.
12321
+ * E.g. when working with a `sap.m.Button`, always use the Button's "press" event, not the native "click"
12322
+ * event, because "press" is also guaranteed to be fired when certain keyboard activity is supposed to trigger
12323
+ * the Button.
12322
12324
  *
12323
12325
  * In the event handler, `this` refers to the Control - not to the root DOM element like in jQuery. While
12324
12326
  * the DOM element can be used and modified, the general caveats for working with SAPUI5 control DOM elements
@@ -17197,6 +17199,8 @@ declare module "sap/ui/core/Element" {
17197
17199
  unbindElement(sModelName: string): ManagedObject;
17198
17200
  }
17199
17201
  /**
17202
+ * @SINCE 1.67
17203
+ *
17200
17204
  * Registry of all `sap.ui.core.Element`s that currently exist.
17201
17205
  */
17202
17206
  export interface registry {
@@ -23152,6 +23156,8 @@ declare module "sap/ui/core/message/ControlMessageProcessor" {
23152
23156
 
23153
23157
  import Metadata from "sap/ui/base/Metadata";
23154
23158
 
23159
+ import Message from "sap/ui/core/message/Message";
23160
+
23155
23161
  /**
23156
23162
  * The ControlMessageProcessor implementation. This MessageProcessor is able to handle Messages with the
23157
23163
  * following target syntax: 'ControlID/PropertyName'. Creating an instance of this class using the "new"
@@ -23197,9 +23203,9 @@ declare module "sap/ui/core/message/ControlMessageProcessor" {
23197
23203
  */
23198
23204
  setMessages(
23199
23205
  /**
23200
- * map of messages: {'target': [array of messages],...}
23206
+ * map of messages: {'target': [sap.ui.core.message.Message],...}
23201
23207
  */
23202
- vMessages: Record<string, any[]>
23208
+ mMessages: Record<string, Message[]>
23203
23209
  ): void;
23204
23210
  }
23205
23211
  }
@@ -23708,6 +23714,8 @@ declare module "sap/ui/core/message/MessageParser" {
23708
23714
  declare module "sap/ui/core/message/MessageProcessor" {
23709
23715
  import EventProvider from "sap/ui/base/EventProvider";
23710
23716
 
23717
+ import Message from "sap/ui/core/message/Message";
23718
+
23711
23719
  import Metadata from "sap/ui/base/Metadata";
23712
23720
 
23713
23721
  /**
@@ -23812,7 +23820,16 @@ declare module "sap/ui/core/message/MessageProcessor" {
23812
23820
  /**
23813
23821
  * Parameters to pass along with the event
23814
23822
  */
23815
- oParameters?: object
23823
+ mParameters: {
23824
+ /**
23825
+ * Messages already existing before the `messageChange` event was fired.
23826
+ */
23827
+ oldMessages: Message;
23828
+ /**
23829
+ * New messages added by the trigger of the `messageChange` event.
23830
+ */
23831
+ newMessages: Message;
23832
+ }
23816
23833
  ): this;
23817
23834
  /**
23818
23835
  * Returns the ID of the MessageProcessor instance
@@ -23823,9 +23840,9 @@ declare module "sap/ui/core/message/MessageProcessor" {
23823
23840
  */
23824
23841
  setMessages(
23825
23842
  /**
23826
- * map of messages: {'target': [array of messages],...}
23843
+ * map of messages: {'target': [sap.ui.core.message.Message],...}
23827
23844
  */
23828
- vMessages: Record<string, any[]>
23845
+ mMessages: Record<string, Message[]>
23829
23846
  ): void;
23830
23847
  }
23831
23848
  }
@@ -23918,7 +23935,7 @@ declare module "sap/ui/core/mvc/Controller" {
23918
23935
  * **Example for a callback module definition (sync):**
23919
23936
  * ```javascript
23920
23937
  *
23921
- * sap.ui.define("my/custom/sync/ExtensionProvider", ['jquery.sap.global'], function(jQuery) {
23938
+ * sap.ui.define("my/custom/sync/ExtensionProvider", [], function() {
23922
23939
  * var ExtensionProvider = function() {};
23923
23940
  * ExtensionProvider.prototype.getControllerExtensions = function(sControllerName, sComponentId, bAsync) {
23924
23941
  * if (!bAsync && sControllerName == "my.own.Controller") {
@@ -23937,14 +23954,14 @@ declare module "sap/ui/core/mvc/Controller" {
23937
23954
  * }];
23938
23955
  * };
23939
23956
  * return ExtensionProvider;
23940
- * }, true);
23957
+ * });
23941
23958
  * ```
23942
23959
  *
23943
23960
  *
23944
23961
  * **Example for a callback module definition (async):**
23945
23962
  * ```javascript
23946
23963
  *
23947
- * sap.ui.define("my/custom/async/ExtensionProvider", ['jquery.sap.global'], function(jQuery) {
23964
+ * sap.ui.define("my/custom/async/ExtensionProvider", [], function() {
23948
23965
  * var ExtensionProvider = function() {};
23949
23966
  * ExtensionProvider.prototype.getControllerExtensions = function(sControllerName, sComponentId, bAsync) {
23950
23967
  * if (bAsync && sControllerName == "my.own.Controller") {
@@ -23968,7 +23985,7 @@ declare module "sap/ui/core/mvc/Controller" {
23968
23985
  * };
23969
23986
  * };
23970
23987
  * return ExtensionProvider;
23971
- * }, true);
23988
+ * });
23972
23989
  * ```
23973
23990
  *
23974
23991
  *
@@ -27631,7 +27648,7 @@ declare module "sap/ui/core/RenderManager" {
27631
27648
  *
27632
27649
  * Writes the attribute and its value into the HTML.
27633
27650
  *
27634
- * For details about the escaping refer to {@link jQuery.sap.encodeHTML}
27651
+ * For details about the escaping refer to {@link sap/base/security/encodeXML}.
27635
27652
  */
27636
27653
  writeAttribute(
27637
27654
  /**
@@ -27709,7 +27726,7 @@ declare module "sap/ui/core/RenderManager" {
27709
27726
  *
27710
27727
  * Escape text for HTML and write it to the buffer.
27711
27728
  *
27712
- * For details about the escaping refer to {@link jQuery.sap.encodeHTML}
27729
+ * For details about the escaping refer to {@link sap/base/security/encodeXML}.
27713
27730
  */
27714
27731
  writeEscaped(
27715
27732
  /**
@@ -33174,7 +33191,7 @@ declare module "sap/ui/core/UIArea" {
33174
33191
  /**
33175
33192
  * Returns this `UIArea`'s id (as determined from provided RootNode).
33176
33193
  */
33177
- getId(): string | null;
33194
+ getId(): string;
33178
33195
  /**
33179
33196
  * @deprecated (since 1.1) - use function {@link #getContent} instead
33180
33197
  *
@@ -39662,7 +39679,9 @@ declare module "sap/ui/model/ChangeReason" {
39662
39679
  * The list was refreshed
39663
39680
  */
39664
39681
  Refresh = "refresh",
39665
-
39682
+ /**
39683
+ * A context was removed from a binding.
39684
+ */
39666
39685
  Remove = "remove",
39667
39686
  /**
39668
39687
  * The list was sorted
@@ -41985,6 +42004,15 @@ declare module "sap/ui/model/ListBinding" {
41985
42004
  */
41986
42005
  sFilterType?: FilterType | keyof typeof FilterType
41987
42006
  ): this;
42007
+ /**
42008
+ * @SINCE 1.97.0
42009
+ *
42010
+ * Returns all current contexts of this list binding in no special order. Just like {@link #getCurrentContexts},
42011
+ * this method does not request any data from a back end and does not change the binding's state. In contrast
42012
+ * to {@link #getCurrentContexts}, it does not only return the contexts as last requested by a control,
42013
+ * but all that are currently available in the binding.
42014
+ */
42015
+ getAllCurrentContexts(): Context[];
41988
42016
  /**
41989
42017
  * Returns an array of binding contexts for the bound target list.
41990
42018
  *
@@ -42037,11 +42065,10 @@ declare module "sap/ui/model/ListBinding" {
42037
42065
  /**
42038
42066
  * @SINCE 1.28
42039
42067
  *
42040
- * Returns an array of currently used binding contexts of the bound control.
42068
+ * Returns the contexts of this list binding as last requested by the control and in the same order the
42069
+ * control has received them.
42041
42070
  *
42042
- * This method does not trigger any data requests from the back end or a delta calculation, but just returns
42043
- * the context array as last requested by the control. This can be used by the application to get access
42044
- * to the data currently displayed by a list control.
42071
+ * This method does not request any data from a back end and does not change the binding's state.
42045
42072
  */
42046
42073
  getCurrentContexts(): Context[];
42047
42074
  /**
@@ -42735,23 +42762,10 @@ declare module "sap/ui/model/Model" {
42735
42762
  */
42736
42763
  fireParseError(
42737
42764
  /**
42738
- * Parameters to pass along with the event
42765
+ * Parameters to pass along with the event; May contain the following parameters: `errorCode`, `url`, `reason`,
42766
+ * `srcText`, `line`, `linePos`, `filePos`
42739
42767
  */
42740
- oParameters?: {
42741
- errorCode?: int;
42742
-
42743
- url?: string;
42744
-
42745
- reason?: string;
42746
-
42747
- srcText?: string;
42748
-
42749
- line?: int;
42750
-
42751
- linepos?: int;
42752
-
42753
- filepos?: int;
42754
- }
42768
+ oParameters?: object
42755
42769
  ): this;
42756
42770
  /**
42757
42771
  * Fires event {@link #event:propertyChange propertyChange} to attached listeners.
@@ -43041,7 +43055,7 @@ declare module "sap/ui/model/odata/AnnotationHelper" {
43041
43055
  * views, e.g. `<template:with path="meta>Value" helper="sap.ui.model.odata.AnnotationHelper.resolvePath"
43042
43056
  * var="target">`.
43043
43057
  *
43044
- * Since 1.31.0, you DO NOT need to {@link jQuery.sap.require} this module before use.
43058
+ * Since 1.31.0, you DO NOT need to {@link sap.ui.require} this module before use.
43045
43059
  */
43046
43060
  interface AnnotationHelper {
43047
43061
  /**
@@ -43075,7 +43089,7 @@ declare module "sap/ui/model/odata/AnnotationHelper" {
43075
43089
  * ```javascript
43076
43090
  *
43077
43091
  * function myRootFormatter(oValue1, oValue2, sFullName, sGreeting, iAnswer) {
43078
- * return ...; //TODO compute something useful from the given values
43092
+ * return ...;
43079
43093
  * }
43080
43094
  *
43081
43095
  * oSupplierContext = oMetaModel.getMetaContext("/ProductSet('HT-1021')/ToSupplier");
@@ -43875,7 +43889,7 @@ declare module "sap/ui/model/odata/ODataListBinding" {
43875
43889
  /**
43876
43890
  * Filters the list.
43877
43891
  *
43878
- * When using sap.ui.model.Filter the filters are first grouped according to their binding path. All filters
43892
+ * When using `sap.ui.model.Filter` the filters are first grouped according to their binding path. All filters
43879
43893
  * belonging to a group are combined with OR and after that the results of all groups are combined with
43880
43894
  * AND. Usually this means, all filters applied to a single table column are combined with OR, while filters
43881
43895
  * on different table columns are combined with AND. Please note that a custom filter function is not supported.
@@ -43888,21 +43902,28 @@ declare module "sap/ui/model/odata/ODataListBinding" {
43888
43902
  /**
43889
43903
  * Type of the filter which should be adjusted, if it is not given, the standard behaviour applies
43890
43904
  */
43891
- sFilterType: FilterType | keyof typeof FilterType
43905
+ sFilterType: FilterType | keyof typeof FilterType,
43906
+ /**
43907
+ * Whether to return `true` or `false`, instead of `this`, depending on whether the filtering has been done
43908
+ */
43909
+ bReturnSuccess?: boolean
43892
43910
  ): this;
43893
43911
  /**
43894
43912
  * Return contexts for the list
43895
43913
  */
43896
43914
  getContexts(
43897
43915
  /**
43898
- * the start index of the requested contexts
43916
+ * The start index of the requested contexts
43899
43917
  */
43900
43918
  iStartIndex?: int,
43901
43919
  /**
43902
- * the requested amount of contexts
43920
+ * The requested amount of contexts
43903
43921
  */
43904
43922
  iLength?: int,
43905
-
43923
+ /**
43924
+ * The maximum number of contexts to read before and after the given range; with this, controls can prefetch
43925
+ * data that is likely to be needed soon, e.g. when scrolling down in a table
43926
+ */
43906
43927
  iThreshold?: int
43907
43928
  ): Context[];
43908
43929
  /**
@@ -43931,16 +43952,28 @@ declare module "sap/ui/model/odata/ODataListBinding" {
43931
43952
  /**
43932
43953
  * Update the bound control even if no data has been changed
43933
43954
  */
43934
- bForceUpdate?: boolean
43955
+ bForceUpdate?: boolean,
43956
+ /**
43957
+ * A map of changed entities
43958
+ */
43959
+ mChangedEntities?: object,
43960
+ /**
43961
+ * A map of entity types
43962
+ */
43963
+ mEntityTypes?: object
43935
43964
  ): void;
43936
43965
  /**
43937
43966
  * Sorts the list.
43938
43967
  */
43939
43968
  sort(
43940
43969
  /**
43941
- * the Sorter or an array of sorter objects object which define the sort order
43970
+ * The Sorter or an array of sorter objects which define the sort order
43942
43971
  */
43943
- aSorters: Sorter | any[]
43972
+ aSorters: Sorter | Sorter[],
43973
+ /**
43974
+ * Whether to return `true` or `false`, instead of `this`, depending on whether the sorting has been done
43975
+ */
43976
+ bReturnSuccess?: boolean
43944
43977
  ): this;
43945
43978
  }
43946
43979
  }
@@ -44837,19 +44870,18 @@ declare module "sap/ui/model/odata/ODataModel" {
44837
44870
  bSuppressEvents?: boolean
44838
44871
  ): Promise<any>;
44839
44872
  /**
44840
- * Appends the change batch operations to the end of the batch stack. Only PUT, POST or DELETE batch operations
44841
- * should be included in the specified array. The operations in the array will be included in a single changeset.
44842
- * To embed change operations in different change sets call this method with the corresponding change operations
44843
- * again. If an illegal batch operation is added to the change set nothing will be performed and false will
44844
- * be returned.
44873
+ * Appends the change batch operations to the end of the batch stack. Only `PUTPOST` or `DELETE`
44874
+ * batch operations should be included in the specified array. The operations in the array will be included
44875
+ * in a single changeset. To embed change operations in different change sets call this method with the
44876
+ * corresponding change operations again. If an illegal batch operation is added to the change set nothing
44877
+ * will be performed and false will be returned.
44845
44878
  */
44846
44879
  addBatchChangeOperations(
44847
44880
  /**
44848
- * an array of change batch operations created via `createBatchOperation` and `sMethod` = POST, PUT, MERGE
44849
- * or DELETE
44881
+ * An array of change batch operations created via `createBatchOperation` with parameter `sMethod = "POST"/"PUT"/"MERGE"/"DELETE"`
44850
44882
  */
44851
44883
  aChangeOperations: any[]
44852
- ): void;
44884
+ ): false | undefined;
44853
44885
  /**
44854
44886
  * Appends the read batch operations to the end of the batch stack. Only GET batch operations should be
44855
44887
  * included in the specified array. If an illegal batch operation is added to the batch nothing will be
@@ -44857,10 +44889,10 @@ declare module "sap/ui/model/odata/ODataModel" {
44857
44889
  */
44858
44890
  addBatchReadOperations(
44859
44891
  /**
44860
- * an array of read batch operations created via `createBatchOperation` and `sMethod` = GET
44892
+ * An array of read batch operations created via `createBatchOperation` with `sMethod = "GET"`
44861
44893
  */
44862
44894
  aReadOperations: any[]
44863
- ): void;
44895
+ ): false | undefined;
44864
44896
  /**
44865
44897
  * Attaches event handler `fnFunction` to the {@link #event:annotationsFailed annotationsFailed} event of
44866
44898
  * this `sap.ui.model.odata.ODataModel`.
@@ -45136,29 +45168,29 @@ declare module "sap/ui/model/odata/ODataModel" {
45136
45168
  */
45137
45169
  createBatchOperation(
45138
45170
  /**
45139
- * A string containing the path to the collection or entry where the batch operation should be performed.
45140
- * The path is concatenated to the sServiceUrl which was specified in the model constructor.
45171
+ * A string containing the path to the collection or entry where the batch operation should be performed;
45172
+ * the path is concatenated to the `sServiceUrl` which was specified in the model constructor
45141
45173
  */
45142
45174
  sPath: string,
45143
45175
  /**
45144
- * for the batch operation. Possible values are GET, PUT, MERGE, POST, DELETE
45176
+ * For the batch operation; possible values are `GET`, `PUT`, `MERGE`, `POST` or `DELETE`
45145
45177
  */
45146
45178
  sMethod: string,
45147
45179
  /**
45148
- * optional data payload which should be created, updated, deleted in a change batch operation.
45180
+ * Optional data payload which should be created, updated, deleted in a change batch operation
45149
45181
  */
45150
45182
  oData?: object,
45151
45183
  /**
45152
- * optional parameter for additional information introduced in SAPUI5 1.9.1,
45184
+ * Optional parameter for additional information introduced in SAPUI5 1.9.1
45153
45185
  */
45154
45186
  oParameters?: {
45155
45187
  /**
45156
- * an ETag which can be used for concurrency control. If it is specified, it will be used in an If-Match-Header
45188
+ * An ETag which can be used for concurrency control. If it is specified, it will be used in an If-Match-Header
45157
45189
  * in the request to the server for this entry.
45158
45190
  */
45159
45191
  sETag?: string;
45160
45192
  }
45161
- ): void;
45193
+ ): object;
45162
45194
  /**
45163
45195
  * Creates a new entry object which is described by the metadata of the entity type of the specified sPath
45164
45196
  * Name. A context object is returned which can be used to bind against the newly created object.
@@ -45189,7 +45221,7 @@ declare module "sap/ui/model/odata/ODataModel" {
45189
45221
  vProperties: any[] | object
45190
45222
  ): Context;
45191
45223
  /**
45192
- * Creates the key from the given collection name and property map
45224
+ * Creates the key from the given collection name and property map.
45193
45225
  */
45194
45226
  createKey(
45195
45227
  /**
@@ -45199,12 +45231,12 @@ declare module "sap/ui/model/odata/ODataModel" {
45199
45231
  /**
45200
45232
  * The object containing at least all the key properties of the entity type
45201
45233
  */
45202
- oKeyParameters: object,
45234
+ oKeyProperties: object,
45203
45235
  /**
45204
45236
  * Whether the URI decoding should be applied on the key
45205
45237
  */
45206
45238
  bDecode: boolean
45207
- ): void;
45239
+ ): string;
45208
45240
  /**
45209
45241
  * Deletes a created entry from the request queue and the model.
45210
45242
  */
@@ -45380,19 +45412,19 @@ declare module "sap/ui/model/odata/ODataModel" {
45380
45412
  */
45381
45413
  getData(
45382
45414
  /**
45383
- * A string containing the path to the data object that should be returned.
45415
+ * A string containing the path to the data object that should be returned
45384
45416
  */
45385
45417
  sPath: string,
45386
45418
  /**
45387
- * the optional context which is used with the sPath to retrieve the requested data.
45419
+ * The optional context which is used with the sPath to retrieve the requested data
45388
45420
  */
45389
45421
  oContext?: object,
45390
45422
  /**
45391
- * This parameter should be set when a URI or custom parameter with a $expand System Query Option was used
45392
- * to retrieve associated entries embedded/inline. If true then the getProperty function returns a desired
45393
- * property value/entry and includes the associated expand entries (if any). If false the associated/expanded
45394
- * entry properties are removed and not included in the desired entry as properties at all. This is useful
45395
- * for performing updates on the base entry only. Note: A copy and not a reference of the entry will be
45423
+ * This parameter should be set when a URI or custom parameter with a `$expand` System Query Option was
45424
+ * used to retrieve associated entries embedded/inline; if true then the `getProperty` function returns
45425
+ * a desired property value/entry and includes the associated expand entries (if any); if false the associated/expanded
45426
+ * entry properties are removed and not included in the desired entry as properties at all; this is useful
45427
+ * for performing updates on the base entry only; note: A copy and not a reference of the entry will be
45396
45428
  * returned.
45397
45429
  */
45398
45430
  bIncludeExpandEntries?: boolean
@@ -45400,7 +45432,7 @@ declare module "sap/ui/model/odata/ODataModel" {
45400
45432
  /**
45401
45433
  * @SINCE 1.20
45402
45434
  *
45403
- * Returns the default count mode for retrieving the count of collections
45435
+ * Returns the default count mode for retrieving the count of collections.
45404
45436
  */
45405
45437
  getDefaultCountMode(): CountMode | keyof typeof CountMode;
45406
45438
  /**
@@ -45408,7 +45440,7 @@ declare module "sap/ui/model/odata/ODataModel" {
45408
45440
  */
45409
45441
  getHeaders(): object;
45410
45442
  /**
45411
- * Returns the key part from the entry URI or the given context or object
45443
+ * Returns the key part from the entry URI or the given context or object.
45412
45444
  */
45413
45445
  getKey(
45414
45446
  /**
@@ -45419,7 +45451,7 @@ declare module "sap/ui/model/odata/ODataModel" {
45419
45451
  * Whether the URI decoding should be applied on the key
45420
45452
  */
45421
45453
  bDecode: boolean
45422
- ): void;
45454
+ ): string;
45423
45455
  /**
45424
45456
  * Returns an instance of an OData meta model which offers a unified access to both OData V2 metadata and
45425
45457
  * V4 annotations. It uses the existing {@link sap.ui.model.odata.ODataMetadata} as a foundation and merges
@@ -45432,47 +45464,47 @@ declare module "sap/ui/model/odata/ODataModel" {
45432
45464
  getMetaModel(): ODataMetaModel;
45433
45465
  /**
45434
45466
  * Returns the value for the property with the given `sPath`. If the path points to a navigation property
45435
- * which has been loaded via $expand then the `bIncludeExpandEntries` parameter determines if the navigation
45467
+ * which has been loaded via `$expand` then the `bIncludeExpandEntries` parameter determines if the navigation
45436
45468
  * property should be included in the returned value or not. Please note that this currently works for 1..1
45437
45469
  * navigation properties only.
45438
45470
  */
45439
45471
  getProperty(
45440
45472
  /**
45441
- * the path/name of the property
45473
+ * The path/name of the property
45442
45474
  */
45443
45475
  sPath: string,
45444
45476
  /**
45445
- * the context if available to access the property value
45477
+ * The context if available to access the property value
45446
45478
  */
45447
45479
  oContext?: object,
45448
45480
  /**
45449
- * This parameter should be set when a URI or custom parameter with a $expand System Query Option was used
45450
- * to retrieve associated entries embedded/inline. If true then the getProperty function returns a desired
45451
- * property value/entry and includes the associated expand entries (if any). If false the associated/expanded
45481
+ * This parameter should be set when a URI or custom parameter with a `$expand` System Query Option was
45482
+ * used to retrieve associated entries embedded/inline. If true then the getProperty function returns a
45483
+ * desired property value/entry and includes the associated expand entries (if any). If false the associated/expanded
45452
45484
  * entry properties are removed and not included in the desired entry as properties at all. This is useful
45453
45485
  * for performing updates on the base entry only. Note: A copy and not a reference of the entry will be
45454
45486
  * returned.
45455
45487
  */
45456
45488
  bIncludeExpandEntries?: boolean
45457
- ): any;
45489
+ ): object;
45458
45490
  /**
45459
45491
  * Returns the current security token. If the token has not been requested from the server it will be requested
45460
45492
  * first.
45461
45493
  */
45462
45494
  getSecurityToken(): string;
45463
45495
  /**
45464
- * Return the annotation object. Please note that when using the model with bLoadMetadataAsync = true then
45465
- * this function might return undefined because the metadata has not been loaded yet. In this case attach
45466
- * to the `annotationsLoaded` event to get notified when the annotations are available and then call this
45467
- * function.
45496
+ * Return the annotation object. Please note that when using the model with `bLoadMetadataAsync = true`
45497
+ * then this function might return undefined because the metadata has not been loaded yet. In this case
45498
+ * attach to the `annotationsLoaded` event to get notified when the annotations are available and then call
45499
+ * this function.
45468
45500
  */
45469
- getServiceAnnotations(): Object;
45501
+ getServiceAnnotations(): Object | undefined;
45470
45502
  /**
45471
- * Return the metadata object. Please note that when using the model with bLoadMetadataAsync = true then
45472
- * this function might return undefined because the metadata has not been loaded yet. In this case attach
45473
- * to the `metadataLoaded` event to get notified when the metadata is available and then call this function.
45503
+ * Return the metadata object. Please note that when using the model with `bLoadMetadataAsync = true` then
45504
+ * this function might return `undefinedmetadataLoaded` event to get notified when the metadata is available and then call
45505
+ * this function.
45474
45506
  */
45475
- getServiceMetadata(): Object;
45507
+ getServiceMetadata(): Object | undefined;
45476
45508
  /**
45477
45509
  * Checks if there exist pending changes in the model created by the setProperty method.
45478
45510
  */
@@ -45480,7 +45512,7 @@ declare module "sap/ui/model/odata/ODataModel" {
45480
45512
  /**
45481
45513
  * @deprecated (since 1.20) - please use {@link #getDefaultCountMode} instead.
45482
45514
  *
45483
- * Returns whether this model supports the $count on its collections
45515
+ * Returns whether this model supports `$count` on its collections.
45484
45516
  */
45485
45517
  isCountSupported(): boolean;
45486
45518
  /**
@@ -45633,9 +45665,14 @@ declare module "sap/ui/model/odata/ODataModel" {
45633
45665
  /**
45634
45666
  * @deprecated (since 1.20) - please use {@link #setDefaultCountMode} instead.
45635
45667
  *
45636
- * Sets whether this OData service supports $count on its collections.
45668
+ * Sets whether this OData service supports `$count` on its collections.
45637
45669
  */
45638
- setCountSupported(bCountSupported: boolean): void;
45670
+ setCountSupported(
45671
+ /**
45672
+ * Whether this OData service supports `$count` on its collections
45673
+ */
45674
+ bCountSupported: boolean
45675
+ ): void;
45639
45676
  /**
45640
45677
  * @SINCE 1.20
45641
45678
  *
@@ -45677,33 +45714,33 @@ declare module "sap/ui/model/odata/ODataModel" {
45677
45714
  ): void;
45678
45715
  /**
45679
45716
  * Sets a new value for the given property `sPropertyName` in the model without triggering a server request.
45680
- * This can be done by the submitChanges method.
45717
+ * This can be done by the `submitChanges` method.
45681
45718
  *
45682
- * Note: Only one entry of one collection can be updated at once. Otherwise a fireRejectChange event is
45719
+ * Note: Only one entry of one collection can be updated at once. Otherwise a `fireRejectChange` event is
45683
45720
  * fired.
45684
45721
  *
45685
- * Before updating a different entry the existing changes of the current entry have to be submitted or resetted
45686
- * by the corresponding methods: submitChanges, resetChanges.
45722
+ * Before updating a different entry the existing changes of the current entry have to be submitted or reset
45723
+ * by the corresponding methods: `submitChanges`, `resetChanges`.
45687
45724
  *
45688
- * IMPORTANT: All pending changes are resetted in the model if the application triggeres any kind of refresh
45725
+ * IMPORTANT: All pending changes are reset in the model if the application triggers any kind of refresh
45689
45726
  * on that entry. Make sure to submit the pending changes first. To determine if there are any pending changes
45690
- * call the hasPendingChanges method.
45727
+ * call the `hasPendingChanges` method.
45691
45728
  */
45692
45729
  setProperty(
45693
45730
  /**
45694
- * path of the property to set
45731
+ * Path of the property to set
45695
45732
  */
45696
45733
  sPath: string,
45697
45734
  /**
45698
- * value to set the property to
45735
+ * Value to set the property to
45699
45736
  */
45700
45737
  oValue: any,
45701
45738
  /**
45702
- * the context which will be used to set the property
45739
+ * The context which will be used to set the property
45703
45740
  */
45704
45741
  oContext?: object,
45705
45742
  /**
45706
- * whether to update other bindings dependent on this property asynchronously
45743
+ * Whether to update other bindings dependent on this property asynchronously
45707
45744
  */
45708
45745
  bAsyncUpdate?: boolean
45709
45746
  ): boolean;
@@ -45712,7 +45749,12 @@ declare module "sap/ui/model/odata/ODataModel" {
45712
45749
  *
45713
45750
  * Enable/Disable automatic updates of all Bindings after change operations
45714
45751
  */
45715
- setRefreshAfterChange(bRefreshAfterChange: boolean): void;
45752
+ setRefreshAfterChange(
45753
+ /**
45754
+ * Whether automatic updates should be enabled
45755
+ */
45756
+ bRefreshAfterChange: boolean
45757
+ ): void;
45716
45758
  /**
45717
45759
  * Enable/Disable XCSRF-Token handling
45718
45760
  */
@@ -48724,6 +48766,7 @@ declare module "sap/ui/model/odata/v2/Context" {
48724
48766
  * A context for the OData V2 model cannot be created at will, it has to be retrieved via:
48725
48767
  * - an OData binding
48726
48768
  * - a view element
48769
+ * - {@link sap.ui.model.odata.v2.ODataListBinding#create}
48727
48770
  * - {@link sap.ui.model.odata.v2.ODataModel#callFunction}
48728
48771
  * - {@link sap.ui.model.odata.v2.ODataModel#createBindingContext}
48729
48772
  * - {@link sap.ui.model.odata.v2.ODataModel#createEntry}
@@ -48759,21 +48802,27 @@ declare module "sap/ui/model/odata/v2/Context" {
48759
48802
  /**
48760
48803
  * @SINCE 1.96.0
48761
48804
  *
48762
- * Returns a promise on the creation state of this context if it has been created via {@link sap.ui.model.odata.v2.ODataModel#createEntry};
48763
- * otherwise returns `undefined`.
48805
+ * Returns a promise on the creation state of this context if it has been created via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
48806
+ * or {@link sap.ui.model.odata.v2.ODataListBinding#create}; otherwise returns `undefined`.
48764
48807
  *
48765
48808
  * As long as the promise is not yet resolved or rejected, the entity represented by this context is transient.
48766
48809
  *
48767
48810
  * Once the promise is resolved, the entity for this context is stored in the back end and {@link #getPath}
48768
48811
  * returns a path including the key predicate of the new entity.
48812
+ *
48813
+ * If the context has been created via {@link sap.ui.model.odata.v2.ODataListBinding#create} and the entity
48814
+ * for this context has been stored in the back end, {@link #created} returns `undefined` after the data
48815
+ * has been re-read from the back end and inserted at the right position based on the list binding's filters
48816
+ * and sorters. If the context has been created via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
48817
+ * and the entity for this context has been stored in the back end, {@link #created} returns `undefined`.
48769
48818
  */
48770
48819
  created(): Promise<any>;
48771
48820
  /**
48772
48821
  * @SINCE 1.94.0
48773
48822
  *
48774
- * For a context created using {@link sap.ui.model.odata.v2.ODataModel#createEntry}, the method returns
48775
- * `true` if the context is transient or `false` if the context is not transient. A transient context represents
48776
- * an entity created on the client which has not been persisted in the back end.
48823
+ * For a context created using {@link sap.ui.model.odata.v2.ODataModel#createEntry} or {@link sap.ui.model.odata.v2.ODataListBinding#create},
48824
+ * the method returns `true` if the context is transient or `false` if the context is not transient. A transient
48825
+ * context represents an entity created on the client which has not been persisted in the back end.
48777
48826
  */
48778
48827
  isTransient(): boolean;
48779
48828
  }
@@ -49576,6 +49625,9 @@ declare module "sap/ui/model/odata/v2/ODataListBinding" {
49576
49625
  * with AND. Usually this means, all filters applied to a single table column are combined with OR, while
49577
49626
  * filters on different table columns are combined with AND. Please note that a custom filter function is
49578
49627
  * only supported with operation mode `sap.ui.model.odata.OperationMode.Client`.
49628
+ *
49629
+ * Entities that have been created via {@link #create} and saved in the back end are removed from the creation
49630
+ * rows area and inserted at the right position based on the current filters and sorters.
49579
49631
  */
49580
49632
  filter(
49581
49633
  /**
@@ -49637,6 +49689,9 @@ declare module "sap/ui/model/odata/v2/ODataListBinding" {
49637
49689
  * Refreshes the binding, check whether the model data has been changed and fire change event if this is
49638
49690
  * the case. For server side models this should refetch the data from the server. To update a control, even
49639
49691
  * if no data has been changed, e.g. to reset a control after failed validation, use the parameter `bForceUpdate`.
49692
+ *
49693
+ * Entities that have been created via {@link #create} and saved in the back end are removed from the creation
49694
+ * rows area and inserted at the right position based on the current filters and sorters.
49640
49695
  */
49641
49696
  refresh(
49642
49697
  /**
@@ -49668,6 +49723,9 @@ declare module "sap/ui/model/odata/v2/ODataListBinding" {
49668
49723
  ): Promise<Filter>;
49669
49724
  /**
49670
49725
  * Sorts the list.
49726
+ *
49727
+ * Entities that have been created via {@link #create} and saved in the back end are removed from the creation
49728
+ * rows area and inserted at the right position based on the current filters and sorters.
49671
49729
  */
49672
49730
  sort(
49673
49731
  /**
@@ -50693,7 +50751,7 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
50693
50751
  * Whether to reload data
50694
50752
  */
50695
50753
  bReload?: boolean
50696
- ): Context1;
50754
+ ): Context1 | undefined;
50697
50755
  /**
50698
50756
  * Creates a new entry object which is described by the metadata of the entity type of the specified `sPath`
50699
50757
  * Name. A context object is returned which can be used to bind against the newly created object.
@@ -51377,11 +51435,11 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
51377
51435
  /**
51378
51436
  * Return the parsed XML metadata as a Javascript object.
51379
51437
  *
51380
- * Please note that the metadata is loaded asynchronously and this function might return undefined because
51438
+ * Please note that the metadata is loaded asynchronously and this function might return `undefined` because
51381
51439
  * the metadata has not been loaded yet. In this case attach to the `metadataLoaded` event to get notified
51382
51440
  * when the metadata is available and then call this function.
51383
51441
  */
51384
- getServiceMetadata(): Object;
51442
+ getServiceMetadata(): Object | undefined;
51385
51443
  /**
51386
51444
  * Checks if there exist pending changes in the model.
51387
51445
  *
@@ -51593,7 +51651,7 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
51593
51651
  *
51594
51652
  * Returns a new promise which can be resolved or rejected depending on the metadata loading state.
51595
51653
  */
51596
- refreshMetadata(): Promise<any>;
51654
+ refreshMetadata(): Promise<any> | undefined;
51597
51655
  /**
51598
51656
  * Refresh XSRF token by performing a GET request against the service root URL.
51599
51657
  */
@@ -52123,7 +52181,11 @@ declare module "sap/ui/model/odata/v2/ODataTreeBinding" {
52123
52181
  /**
52124
52182
  * Type of the filter which should be adjusted. If it is not given, the type `FilterType.Control` is assumed
52125
52183
  */
52126
- sFilterType: FilterType | keyof typeof FilterType
52184
+ sFilterType: FilterType | keyof typeof FilterType,
52185
+ /**
52186
+ * Whether to return `true` or `false`, instead of `this`, depending on whether the filtering has been done
52187
+ */
52188
+ bReturnSuccess?: boolean
52127
52189
  ): this;
52128
52190
  /**
52129
52191
  * Returns the number of child nodes. This function is not available when the annotation "hierarchy-node-descendant-count-for"
@@ -52234,16 +52296,25 @@ declare module "sap/ui/model/odata/v2/ODataTreeBinding" {
52234
52296
  * annotation specification, or when providing the annotation information locally as a binding parameter.
52235
52297
  * For more information, see {@link sap.ui.model.odata.v2.ODataModel#bindTree}.
52236
52298
  */
52237
- setRootLevel(iRootLevel: int): void;
52299
+ setRootLevel(
52300
+ /**
52301
+ * The new `rootLevel`
52302
+ */
52303
+ iRootLevel: int
52304
+ ): void;
52238
52305
  /**
52239
- * Sorts the Tree according to the given Sorter(s). In OperationMode.Client or OperationMode.Auto (if the
52240
- * given threshold is satisfied), the sorters are applied locally on the client.
52306
+ * Sorts the Tree according to the given Sorter(s). In `OperationMode.Client` or `OperationMode.Auto` (if
52307
+ * the given threshold is satisfied), the sorters are applied locally on the client.
52241
52308
  */
52242
52309
  sort(
52243
52310
  /**
52244
- * the Sorter or an Array of sap.ui.model.Sorter instances
52311
+ * The Sorter or an Array of sap.ui.model.Sorter instances
52245
52312
  */
52246
- aSorters: Sorter[] | Sorter
52313
+ aSorters: Sorter[] | Sorter,
52314
+ /**
52315
+ * Whether to return `true` or `false`, instead of `this`, depending on whether the sorting has been done
52316
+ */
52317
+ bReturnSuccess?: boolean
52247
52318
  ): this;
52248
52319
  }
52249
52320
  }
@@ -52872,7 +52943,12 @@ declare module "sap/ui/model/odata/v4/Context" {
52872
52943
  * binding is used, see {@link #getUpdateGroupId}; the resulting group ID must not have {@link sap.ui.model.odata.v4.SubmitMode.API}.
52873
52944
  * Since 1.81, if this context is transient (see {@link #isTransient}), no group ID needs to be specified.
52874
52945
  */
52875
- sGroupId?: string
52946
+ sGroupId?: string,
52947
+ /**
52948
+ * Whether not to request the new count from the server; useful in case of {@link #replaceWith} where it
52949
+ * is known that the count remains unchanged (since 1.97.0)
52950
+ */
52951
+ bDoNotRequestCount?: boolean
52876
52952
  ): Promise<any>;
52877
52953
  /**
52878
52954
  * @SINCE 1.41.0
@@ -53031,6 +53107,18 @@ declare module "sap/ui/model/odata/v4/Context" {
53031
53107
  */
53032
53108
  bAllowRemoval?: boolean
53033
53109
  ): void;
53110
+ /**
53111
+ * @SINCE 1.97.0
53112
+ *
53113
+ * Replaces this context with the given other context. You probably want to delete this context afterwards
53114
+ * without requesting the new count from the server, see the `bDoNotRequestCount` parameter of {@link #delete}.
53115
+ */
53116
+ replaceWith(
53117
+ /**
53118
+ * The other context
53119
+ */
53120
+ oOtherContext: Context
53121
+ ): void;
53034
53122
  /**
53035
53123
  * @SINCE 1.39.0
53036
53124
  *
@@ -53366,10 +53454,10 @@ declare module "sap/ui/model/odata/v4/ODataContextBinding" {
53366
53454
  *
53367
53455
  * Changes this binding's parameters and refreshes the binding.
53368
53456
  *
53369
- * If there are pending changes an error is thrown. Use {@link #hasPendingChanges} to check if there are
53370
- * pending changes. If there are changes, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit
53371
- * the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before calling
53372
- * {@link #changeParameters}.
53457
+ * If there are pending changes that cannot be ignored, an error is thrown. Use {@link #hasPendingChanges}
53458
+ * to check if there are such pending changes. If there are, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
53459
+ * to submit the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before
53460
+ * calling {@link #changeParameters}.
53373
53461
  *
53374
53462
  * The parameters are changed according to the given map of parameters: Parameters with an `undefined` value
53375
53463
  * are removed, the other parameters are set, and missing parameters remain unchanged.
@@ -53450,7 +53538,19 @@ declare module "sap/ui/model/odata/v4/ODataContextBinding" {
53450
53538
  * the bound action should either be repeated **without** applying the preference or rejected with an `Error`
53451
53539
  * instance `oError` where `oError.canceled === true`. Since 1.92.0.
53452
53540
  */
53453
- fnOnStrictHandlingFailed?: Function
53541
+ fnOnStrictHandlingFailed?: Function,
53542
+ /**
53543
+ * Whether this operation binding's parent context, which must belong to a list binding, is replaced with
53544
+ * the operation's return value context (see below) and that list context is returned instead. The list
53545
+ * context may be a newly created context or an existing context. A newly created context has the same `keepAlive`
53546
+ * attribute and `fnOnBeforeDestroy` function as the parent context, see {@link sap.ui.model.odata.v4.Context#setKeepAlive};
53547
+ * `fnOnBeforeDestroy` will be called with the new context instance as the only argument in this case. An
53548
+ * existing context does not change its `keepAlive` attribute. In any case, the resulting context takes
53549
+ * the place (index, position) of the parent context {@link sap.ui.model.odata.v4.Context#getIndex}. If
53550
+ * the parent context has requested messages when it was kept alive, they will be inherited if the $$inheritExpandSelect
53551
+ * binding parameter is set to `true`. Since 1.97.0.
53552
+ */
53553
+ bReplaceWithRVC?: boolean
53454
53554
  ): Promise<any>;
53455
53555
  /**
53456
53556
  * @SINCE 1.39.0
@@ -53506,7 +53606,15 @@ declare module "sap/ui/model/odata/v4/ODataContextBinding" {
53506
53606
  * returns `true` if there are pending changes for the current parent context path of this binding. If this
53507
53607
  * binding is unresolved (see {@link sap.ui.model.Binding#isResolved}), it returns `false`.
53508
53608
  */
53509
- hasPendingChanges(): boolean;
53609
+ hasPendingChanges(
53610
+ /**
53611
+ * Whether to ignore changes which will not be lost by APIs like {@link sap.ui.model.odata.v4.ODataListBinding#changeParameters
53612
+ * changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#sort
53613
+ * sort}, or {@link sap.ui.model.odata.v4.ODataListBinding#suspend suspend} because they relate to a {@link
53614
+ * sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context of this binding.
53615
+ */
53616
+ bIgnoreKeptAlive?: boolean
53617
+ ): boolean;
53510
53618
  /**
53511
53619
  * @SINCE 1.37.0
53512
53620
  *
@@ -53640,7 +53748,8 @@ declare module "sap/ui/model/odata/v4/ODataContextBinding" {
53640
53748
  *
53641
53749
  * Suspends this binding. A suspended binding does not fire change events nor does it trigger data service
53642
53750
  * requests. Call {@link #resume} to resume the binding. Before 1.53.0, this method was not supported and
53643
- * threw an error.
53751
+ * threw an error. Since 1.97.0, pending changes are ignored if they relate to a {@link sap.ui.model.odata.v4.Context#setKeepAlive
53752
+ * kept-alive} context of this binding.
53644
53753
  * See:
53645
53754
  * {@link topic:b0f5c531e5034a27952cc748954cbe39 Suspend and Resume}
53646
53755
  * sap.ui.model.Binding#suspend
@@ -53797,10 +53906,10 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
53797
53906
  *
53798
53907
  * Changes this binding's parameters and refreshes the binding.
53799
53908
  *
53800
- * If there are pending changes an error is thrown. Use {@link #hasPendingChanges} to check if there are
53801
- * pending changes. If there are changes, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit
53802
- * the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before calling
53803
- * {@link #changeParameters}.
53909
+ * If there are pending changes that cannot be ignored, an error is thrown. Use {@link #hasPendingChanges}
53910
+ * to check if there are such pending changes. If there are, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
53911
+ * to submit the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before
53912
+ * calling {@link #changeParameters}.
53804
53913
  *
53805
53914
  * The parameters are changed according to the given map of parameters: Parameters with an `undefined` value
53806
53915
  * are removed, the other parameters are set, and missing parameters remain unchanged.
@@ -53870,7 +53979,13 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
53870
53979
  * Whether the entity is inserted at the end of the list. When creating multiple entities, this parameter
53871
53980
  * must have the same value for each entity. Supported since 1.66.0
53872
53981
  */
53873
- bAtEnd?: boolean
53982
+ bAtEnd?: boolean,
53983
+ /**
53984
+ * Create an inactive context. Such a context will only be sent to the server after the first property update.
53985
+ * From then on it behaves like any other created context. This parameter is experimental and its implementation
53986
+ * may still change. Do not use it in productive code yet. Supported since 1.97.0
53987
+ */
53988
+ bInactive?: boolean
53874
53989
  ): Context;
53875
53990
  /**
53876
53991
  * @SINCE 1.40.1
@@ -53943,12 +54058,13 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
53943
54058
  /**
53944
54059
  * @SINCE 1.39.0
53945
54060
  *
53946
- * Filters the list with the given filters.
54061
+ * Filters the list with the given filters. Since 1.97.0, if filters are unchanged, no request is sent,
54062
+ * regardless of pending changes.
53947
54063
  *
53948
- * If there are pending changes an error is thrown. Use {@link #hasPendingChanges} to check if there are
53949
- * pending changes. If there are changes, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit
53950
- * the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before calling
53951
- * {@link #filter}.
54064
+ * If there are pending changes that cannot be ignored, an error is thrown. Use {@link #hasPendingChanges}
54065
+ * to check if there are such pending changes. If there are, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
54066
+ * to submit the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before
54067
+ * calling {@link #filter}.
53952
54068
  *
53953
54069
  * Filters are case sensitive unless the property `caseSensitive` is set to `false`. This property has to
53954
54070
  * be set on each filter, it is not inherited from a multi-filter.
@@ -54141,7 +54257,15 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
54141
54257
  * returns `true` if there are pending changes for the current parent context path of this binding. If this
54142
54258
  * binding is unresolved (see {@link sap.ui.model.Binding#isResolved}), it returns `false`.
54143
54259
  */
54144
- hasPendingChanges(): boolean;
54260
+ hasPendingChanges(
54261
+ /**
54262
+ * Whether to ignore changes which will not be lost by APIs like {@link sap.ui.model.odata.v4.ODataListBinding#changeParameters
54263
+ * changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#sort
54264
+ * sort}, or {@link sap.ui.model.odata.v4.ODataListBinding#suspend suspend} because they relate to a {@link
54265
+ * sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context of this binding.
54266
+ */
54267
+ bIgnoreKeptAlive?: boolean
54268
+ ): boolean;
54145
54269
  /**
54146
54270
  * @SINCE 1.37.0
54147
54271
  *
@@ -54363,12 +54487,13 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
54363
54487
  * @SINCE 1.39.0
54364
54488
  *
54365
54489
  * Sort the entries represented by this list binding according to the given sorters. The sorters are stored
54366
- * at this list binding and they are used for each following data request.
54490
+ * at this list binding and they are used for each following data request. Since 1.97.0, if sorters are
54491
+ * unchanged, no request is sent, regardless of pending changes.
54367
54492
  *
54368
- * If there are pending changes an error is thrown. Use {@link #hasPendingChanges} to check if there are
54369
- * pending changes. If there are changes, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit
54370
- * the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before calling
54371
- * {@link #sort}.
54493
+ * If there are pending changes that cannot be ignored, an error is thrown. Use {@link #hasPendingChanges}
54494
+ * to check if there are such pending changes. If there are, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
54495
+ * to submit the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before
54496
+ * calling {@link #sort}.
54372
54497
  * See:
54373
54498
  * sap.ui.model.ListBinding#sort
54374
54499
  */
@@ -54385,7 +54510,8 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
54385
54510
  *
54386
54511
  * Suspends this binding. A suspended binding does not fire change events nor does it trigger data service
54387
54512
  * requests. Call {@link #resume} to resume the binding. Before 1.53.0, this method was not supported and
54388
- * threw an error.
54513
+ * threw an error. Since 1.97.0, pending changes are ignored if they relate to a {@link sap.ui.model.odata.v4.Context#setKeepAlive
54514
+ * kept-alive} context of this binding.
54389
54515
  * See:
54390
54516
  * {@link topic:b0f5c531e5034a27952cc748954cbe39 Suspend and Resume}
54391
54517
  * sap.ui.model.Binding#suspend
@@ -55992,7 +56118,15 @@ declare module "sap/ui/model/odata/v4/ODataPropertyBinding" {
55992
56118
  * returns `true` if there are pending changes for the current parent context path of this binding. If this
55993
56119
  * binding is unresolved (see {@link sap.ui.model.Binding#isResolved}), it returns `false`.
55994
56120
  */
55995
- hasPendingChanges(): boolean;
56121
+ hasPendingChanges(
56122
+ /**
56123
+ * Whether to ignore changes which will not be lost by APIs like {@link sap.ui.model.odata.v4.ODataListBinding#changeParameters
56124
+ * changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#sort
56125
+ * sort}, or {@link sap.ui.model.odata.v4.ODataListBinding#suspend suspend} because they relate to a {@link
56126
+ * sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context of this binding.
56127
+ */
56128
+ bIgnoreKeptAlive?: boolean
56129
+ ): boolean;
55996
56130
  /**
55997
56131
  * @SINCE 1.37.0
55998
56132
  *
@@ -59672,6 +59806,8 @@ declare module "sap/ui/test/actions/Press" {
59672
59806
 
59673
59807
  import ManagedObjectMetadata from "sap/ui/base/ManagedObjectMetadata";
59674
59808
 
59809
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
59810
+
59675
59811
  /**
59676
59812
  * @SINCE 1.34
59677
59813
  *
@@ -59688,13 +59824,22 @@ declare module "sap/ui/test/actions/Press" {
59688
59824
  * see {@link sap.ui.test.actions.Press.controlAdapters}.
59689
59825
  */
59690
59826
  export default class Press extends Action {
59827
+ /**
59828
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
59829
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
59830
+ * of the syntax of the settings object.
59831
+ */
59691
59832
  constructor(
59692
59833
  /**
59693
59834
  * Optional object with initial settings for the new instance
59694
59835
  */
59695
59836
  mSettings?: $PressSettings
59696
59837
  );
59697
-
59838
+ /**
59839
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
59840
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
59841
+ * of the syntax of the settings object.
59842
+ */
59698
59843
  constructor(
59699
59844
  /**
59700
59845
  * Optional ID for the new instance; generated automatically if no non-empty ID is given. Note: this can
@@ -59742,9 +59887,99 @@ declare module "sap/ui/test/actions/Press" {
59742
59887
  */
59743
59888
  oControl: Control
59744
59889
  ): void;
59890
+ /**
59891
+ * @SINCE 1.97
59892
+ *
59893
+ * Gets current value of property {@link #getAltKey altKey}.
59894
+ *
59895
+ * If it is set to `true`, the Alt Key modifier will be used
59896
+ */
59897
+ getAltKey(): boolean;
59898
+ /**
59899
+ * @SINCE 1.97
59900
+ *
59901
+ * Gets current value of property {@link #getCtrlKey ctrlKey}.
59902
+ *
59903
+ * If it is set to `true`, the Control Key modifier will be used
59904
+ */
59905
+ getCtrlKey(): boolean;
59906
+ /**
59907
+ * @SINCE 1.97
59908
+ *
59909
+ * Gets current value of property {@link #getShiftKey shiftKey}.
59910
+ *
59911
+ * If it is set to `true`, the Shift Key modifier will be used
59912
+ */
59913
+ getShiftKey(): boolean;
59914
+ /**
59915
+ * @SINCE 1.97
59916
+ *
59917
+ * Sets a new value for property {@link #getAltKey altKey}.
59918
+ *
59919
+ * If it is set to `true`, the Alt Key modifier will be used
59920
+ *
59921
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
59922
+ */
59923
+ setAltKey(
59924
+ /**
59925
+ * New value for property `altKey`
59926
+ */
59927
+ bAltKey: boolean
59928
+ ): this;
59929
+ /**
59930
+ * @SINCE 1.97
59931
+ *
59932
+ * Sets a new value for property {@link #getCtrlKey ctrlKey}.
59933
+ *
59934
+ * If it is set to `true`, the Control Key modifier will be used
59935
+ *
59936
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
59937
+ */
59938
+ setCtrlKey(
59939
+ /**
59940
+ * New value for property `ctrlKey`
59941
+ */
59942
+ bCtrlKey: boolean
59943
+ ): this;
59944
+ /**
59945
+ * @SINCE 1.97
59946
+ *
59947
+ * Sets a new value for property {@link #getShiftKey shiftKey}.
59948
+ *
59949
+ * If it is set to `true`, the Shift Key modifier will be used
59950
+ *
59951
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
59952
+ */
59953
+ setShiftKey(
59954
+ /**
59955
+ * New value for property `shiftKey`
59956
+ */
59957
+ bShiftKey: boolean
59958
+ ): this;
59745
59959
  }
59746
59960
 
59747
- export interface $PressSettings extends $ActionSettings {}
59961
+ export interface $PressSettings extends $ActionSettings {
59962
+ /**
59963
+ * @SINCE 1.97
59964
+ *
59965
+ * If it is set to `true`, the Alt Key modifier will be used
59966
+ */
59967
+ altKey?: boolean | PropertyBindingInfo;
59968
+
59969
+ /**
59970
+ * @SINCE 1.97
59971
+ *
59972
+ * If it is set to `true`, the Shift Key modifier will be used
59973
+ */
59974
+ shiftKey?: boolean | PropertyBindingInfo;
59975
+
59976
+ /**
59977
+ * @SINCE 1.97
59978
+ *
59979
+ * If it is set to `true`, the Control Key modifier will be used
59980
+ */
59981
+ ctrlKey?: boolean | PropertyBindingInfo;
59982
+ }
59748
59983
  }
59749
59984
 
59750
59985
  declare module "sap/ui/test/actions/Scroll" {
@@ -65890,8 +66125,8 @@ declare namespace sap {
65890
66125
  * to represent an individual folder. In other words: when a resource name is converted to a URL, any dots
65891
66126
  * ('.') are converted to slashes ('/').
65892
66127
  *
65893
- * **Limitation:** For the time being, the **application root folder** is assumed to be the same as the
65894
- * folder where the current page resides in.
66128
+ * **Note:** The **application root folder** is assumed to be the same as the folder where the current page
66129
+ * resides in.
65895
66130
  *
65896
66131
  * Usage sample:
65897
66132
  * ```javascript
@@ -65909,12 +66144,7 @@ declare namespace sap {
65909
66144
  *
65910
66145
  *
65911
66146
  * When applications need a more flexible mapping between resource names and their location, they can use
65912
- * {@link jQuery.sap.registerModulePath}.
65913
- *
65914
- * It is intended to make this configuration obsolete in future releases, but for the time being, applications
65915
- * must call this method when they want to store resources relative to the assumed application root folder.
65916
- * See:
65917
- * jQuery.sap.registerModulePath
66147
+ * {@link sap.ui.loader.config} with option `paths`.
65918
66148
  */
65919
66149
  function localResources(
65920
66150
  /**
@@ -66000,13 +66230,13 @@ declare namespace sap {
66000
66230
  * Returns the URL of a resource that belongs to the given library and has the given relative location within
66001
66231
  * the library. This is mainly meant for static resources like images that are inside the library. It is
66002
66232
  * NOT meant for access to JavaScript modules or anything for which a different URL has been registered
66003
- * with jQuery.sap.registerModulePath(). For these cases use jQuery.sap.getModulePath(). It DOES work, however,
66233
+ * with sap.ui.loader.config({paths:...}). For these cases use sap.ui.require.toUrl(). It DOES work, however,
66004
66234
  * when the given sResourcePath starts with "themes/" (= when it is a theme-dependent resource). Even when
66005
66235
  * for this theme a different location outside the normal library location is configured.
66006
66236
  */
66007
66237
  function resource(
66008
66238
  /**
66009
- * the name of a library, like "sap.ui.commons"
66239
+ * the name of a library, like "sap.ui.layout"
66010
66240
  */
66011
66241
  sLibraryName: string,
66012
66242
  /**
@@ -66025,7 +66255,7 @@ declare namespace sap {
66025
66255
  *
66026
66256
  * <div id="SAPUI5UiArea"></div>
66027
66257
  * <script>
66028
- * var oRoot = new sap.ui.commons.Label();
66258
+ * var oRoot = new sap.m.Label();
66029
66259
  * oRoot.setText("Hello world!");
66030
66260
  * sap.ui.setRoot("SAPUI5UiArea", oRoot);
66031
66261
  * </script>
@@ -66538,8 +66768,8 @@ declare namespace sap {
66538
66768
  *
66539
66769
  * The SAPUI5 Core Runtime.
66540
66770
  *
66541
- * Contains the UI5 jQuery plugins (jQuery.sap.*), the Core and all its components, base classes for Controls,
66542
- * Components and the Model View Controller classes.
66771
+ * Contains the UI5 Core and all its components, base classes for Controls, Components and the Model View
66772
+ * Controller classes.
66543
66773
  */
66544
66774
  namespace core {
66545
66775
  /**