@openui5/ts-types 1.96.2 → 1.98.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.96.2
267
+ // For Library Version: 1.98.0
268
268
 
269
269
  declare module "sap/base/assert" {
270
270
  /**
@@ -2001,6 +2001,76 @@ declare module "sap/base/util/Version" {
2001
2001
  }
2002
2002
  }
2003
2003
 
2004
+ declare module "sap/ui/util/XMLHelper" {
2005
+ /**
2006
+ * Error information as provided by the `DOMParser`.
2007
+ *
2008
+ * Note that the set of properties with meaningful content differs between browsers.
2009
+ */
2010
+ export type XMLParseErrorInfo = {
2011
+ errorCode?: int;
2012
+
2013
+ url?: sap.ui.core.URI;
2014
+
2015
+ reason?: string;
2016
+
2017
+ srcText?: string;
2018
+
2019
+ line?: int;
2020
+
2021
+ linepos?: int;
2022
+
2023
+ filepos?: int;
2024
+
2025
+ type?: "error" | "warning";
2026
+ };
2027
+
2028
+ /**
2029
+ * @SINCE 1.58
2030
+ *
2031
+ * Provides functionality for parsing XML formatted strings and serializing XML documents.
2032
+ */
2033
+ interface XMLHelper {
2034
+ /**
2035
+ * Extracts parse error information from the specified document (if any).
2036
+ *
2037
+ * If an error was found, the returned object contains a browser-specific subset of the properties described
2038
+ * in {@link module:sap/base/util/XMLHelper.XMLParseErrorInfo XMLParseErrorInfo}. Otherwise, it just contains
2039
+ * an `errorCode` property with value 0.
2040
+ */
2041
+ getParseError(
2042
+ /**
2043
+ * The parsed XML document
2044
+ */
2045
+ oDocument: XMLDocument
2046
+ ): XMLParseErrorInfo;
2047
+ /**
2048
+ * Parses the specified XML string into an XML document, using the native parsing functionality of the browser.
2049
+ * If an error occurs during parsing, a {@link module:sap/base/util/XMLHelper.XMLParseErrorInfo parse error
2050
+ * info object} is attached as the `parseError` property of the returned document.
2051
+ */
2052
+ parse(
2053
+ /**
2054
+ * An XML string
2055
+ */
2056
+ sXMLText: string
2057
+ ): XMLDocument;
2058
+ /**
2059
+ * Serializes the specified DOM tree into a string representation.
2060
+ * See:
2061
+ * {@link https://developer.mozilla.org/en-US/docs/Web/API/XMLSerializer/serializeToString}
2062
+ */
2063
+ serialize(
2064
+ /**
2065
+ * the XML document object to be serialized as string
2066
+ */
2067
+ oXMLDocument: Node | Attr
2068
+ ): string;
2069
+ }
2070
+ const XMLHelper: XMLHelper;
2071
+ export default XMLHelper;
2072
+ }
2073
+
2004
2074
  declare module "sap/ui/core/ComponentSupport" {
2005
2075
  /**
2006
2076
  * @SINCE 1.58.0
@@ -3527,51 +3597,6 @@ declare module "sap/ui/util/Storage" {
3527
3597
  }
3528
3598
  }
3529
3599
 
3530
- declare module "sap/ui/util/XMLHelper" {
3531
- /**
3532
- * @SINCE 1.58
3533
- *
3534
- * Provides functionality for parsing XML formatted strings and serializing XML documents.
3535
- */
3536
- interface XMLHelper {
3537
- /**
3538
- * Extracts parse error information from the specified document (if any).
3539
- *
3540
- * If an error was found the returned object has the following error information parameters: errorCode,
3541
- * url, reason, srcText, line, linepos, filepos
3542
- */
3543
- getParseError(
3544
- /**
3545
- * the parsed XML document
3546
- */
3547
- oDocument: string
3548
- ): object;
3549
- /**
3550
- * Parses the specified XML formatted string text using native parsing function of the browser and returns
3551
- * a valid XML document. If an error occurred during parsing a parse error xobject is returned as property
3552
- * (parseError) of the returned XML document object. The parse error object has the following error information
3553
- * parameters: errorCode, url, reason, srcText, line, linepos, filepos
3554
- */
3555
- parse(
3556
- /**
3557
- * the XML data as string
3558
- */
3559
- sXMLText: string
3560
- ): object;
3561
- /**
3562
- * Serializes the specified XML document into a string representation.
3563
- */
3564
- serialize(
3565
- /**
3566
- * the XML document object to be serialized as string
3567
- */
3568
- oXMLDocument: string
3569
- ): object;
3570
- }
3571
- const XMLHelper: XMLHelper;
3572
- export default XMLHelper;
3573
- }
3574
-
3575
3600
  declare module "sap/ui/VersionInfo" {
3576
3601
  /**
3577
3602
  * @SINCE 1.56.0
@@ -3974,8 +3999,8 @@ declare namespace sap {
3974
3999
  * using `sap.ui.require("something")` are automagically converted into `sap.ui.define` dependencies before
3975
4000
  * executing the factory function.
3976
4001
  *
3977
- * Limitations, Design Considerations:
3978
- * - **Limitation**: as dependency management is not supported for Non-UI5 modules, the only way to ensure
4002
+ * Restrictions, Design Considerations:
4003
+ * - **Restriction**: as dependency management is not supported for Non-UI5 modules, the only way to ensure
3979
4004
  * proper execution order for such modules currently is to rely on the order in the dependency array. Obviously,
3980
4005
  * this only works as long as `sap.ui.define` uses synchronous loading. It will be enhanced when asynchronous
3981
4006
  * loading is implemented.
@@ -4223,8 +4248,8 @@ declare namespace sap {
4223
4248
  * using `sap.ui.require("something")` are automagically converted into `sap.ui.define` dependencies before
4224
4249
  * executing the factory function.
4225
4250
  *
4226
- * Limitations, Design Considerations:
4227
- * - **Limitation**: as dependency management is not supported for Non-UI5 modules, the only way to ensure
4251
+ * Restrictions, Design Considerations:
4252
+ * - **Restriction**: as dependency management is not supported for Non-UI5 modules, the only way to ensure
4228
4253
  * proper execution order for such modules currently is to rely on the order in the dependency array. Obviously,
4229
4254
  * this only works as long as `sap.ui.define` uses synchronous loading. It will be enhanced when asynchronous
4230
4255
  * loading is implemented.
@@ -4466,8 +4491,8 @@ declare namespace sap {
4466
4491
  * using `sap.ui.require("something")` are automagically converted into `sap.ui.define` dependencies before
4467
4492
  * executing the factory function.
4468
4493
  *
4469
- * Limitations, Design Considerations:
4470
- * - **Limitation**: as dependency management is not supported for Non-UI5 modules, the only way to ensure
4494
+ * Restrictions, Design Considerations:
4495
+ * - **Restriction**: as dependency management is not supported for Non-UI5 modules, the only way to ensure
4471
4496
  * proper execution order for such modules currently is to rely on the order in the dependency array. Obviously,
4472
4497
  * this only works as long as `sap.ui.define` uses synchronous loading. It will be enhanced when asynchronous
4473
4498
  * loading is implemented.
@@ -4710,8 +4735,8 @@ declare namespace sap {
4710
4735
  * using `sap.ui.require("something")` are automagically converted into `sap.ui.define` dependencies before
4711
4736
  * executing the factory function.
4712
4737
  *
4713
- * Limitations, Design Considerations:
4714
- * - **Limitation**: as dependency management is not supported for Non-UI5 modules, the only way to ensure
4738
+ * Restrictions, Design Considerations:
4739
+ * - **Restriction**: as dependency management is not supported for Non-UI5 modules, the only way to ensure
4715
4740
  * proper execution order for such modules currently is to rely on the order in the dependency array. Obviously,
4716
4741
  * this only works as long as `sap.ui.define` uses synchronous loading. It will be enhanced when asynchronous
4717
4742
  * loading is implemented.
@@ -5348,8 +5373,8 @@ declare namespace sap {
5348
5373
  * to represent an individual folder. In other words: when a resource name is converted to a URL, any dots
5349
5374
  * ('.') are converted to slashes ('/').
5350
5375
  *
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.
5376
+ * **Note:** The **application root folder** is assumed to be the same as the folder where the current page
5377
+ * resides in.
5353
5378
  *
5354
5379
  * Usage sample:
5355
5380
  * ```javascript
@@ -5367,12 +5392,7 @@ declare namespace sap {
5367
5392
  *
5368
5393
  *
5369
5394
  * 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
5395
+ * {@link sap.ui.loader.config} with option `paths`.
5376
5396
  */
5377
5397
  function localResources(
5378
5398
  /**
@@ -5447,7 +5467,7 @@ declare namespace sap {
5447
5467
  fnCallback?: Function,
5448
5468
  /**
5449
5469
  * Callback function to execute if an error was detected while loading the dependencies or executing the
5450
- * factory function. Note that due to browser limitations not all errors will be reported via this callback.
5470
+ * factory function. Note that due to browser restrictions not all errors will be reported via this callback.
5451
5471
  * In general, module loading is designed for the non-error case. Error handling is not complete.
5452
5472
  */
5453
5473
  fnErrback?: Function
@@ -5458,13 +5478,13 @@ declare namespace sap {
5458
5478
  * Returns the URL of a resource that belongs to the given library and has the given relative location within
5459
5479
  * the library. This is mainly meant for static resources like images that are inside the library. It is
5460
5480
  * 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,
5481
+ * with sap.ui.loader.config({paths:...}). For these cases use sap.ui.require.toUrl(). It DOES work, however,
5462
5482
  * when the given sResourcePath starts with "themes/" (= when it is a theme-dependent resource). Even when
5463
5483
  * for this theme a different location outside the normal library location is configured.
5464
5484
  */
5465
5485
  function resource(
5466
5486
  /**
5467
- * the name of a library, like "sap.ui.commons"
5487
+ * the name of a library, like "sap.ui.layout"
5468
5488
  */
5469
5489
  sLibraryName: string,
5470
5490
  /**
@@ -5483,7 +5503,7 @@ declare namespace sap {
5483
5503
  *
5484
5504
  * <div id="SAPUI5UiArea"></div>
5485
5505
  * <script>
5486
- * var oRoot = new sap.ui.commons.Label();
5506
+ * var oRoot = new sap.m.Label();
5487
5507
  * oRoot.setText("Hello world!");
5488
5508
  * sap.ui.setRoot("SAPUI5UiArea", oRoot);
5489
5509
  * </script>
@@ -7426,8 +7446,8 @@ declare namespace sap {
7426
7446
  * **'library'** : string
7427
7447
  * Name of the library that the new subclass should belong to. If the subclass is a control or element,
7428
7448
  * 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'.
7449
+ * the name of the subclass should have the library name as a prefix, but subfolders are allowed, e.g. `sap.ui.layout.form.Form`
7450
+ * belongs to library `sap.ui.layout`.
7431
7451
  *
7432
7452
  * **'properties'** : object
7433
7453
  * An object literal whose properties each define a new managed property in the ManagedObject subclass.
@@ -7444,15 +7464,14 @@ declare namespace sap {
7444
7464
  * - `byValue: boolean` (either can be omitted or set to the boolean value `true`) If set to `true`,
7445
7465
  * the property value will be {@link module:sap/base/util/deepClone deep cloned} on write and read operations
7446
7466
  * to ensure that the internal value can't be modified by the outside. The property `byValue` is currently
7447
- * limited to a `boolean` value. Other types are reserved for future use. Class definitions must only use
7448
- * boolean values for the flag (or omit it), but readers of ManagedObject metadata should handle any truthy
7449
- * value as `true` to be future safe. Note that using `byValue:true` has a performance impact on property
7450
- * access and therefore should be used carefully. It also doesn't make sense to set this option for properties
7451
- * with a primitive type (they have value semantic anyhow) or for properties with arrays of primitive types
7452
- * (they have been cloned already in the past with a cheaper implementation). Future versions of UI5 might
7453
- * encourage this as a limitation during class definition. `group:string` a semantic grouping
7454
- * of the properties, intended to be used in design time tools. Allowed values are (case sensitive): Accessibility,
7455
- * Appearance, Behavior, Data, Designtime, Dimension, Identification, Misc
7467
+ * restricted to a `boolean` value. Other types are reserved for future use. Class definitions must only
7468
+ * use boolean values for the flag (or omit it), but readers of ManagedObject metadata should handle any
7469
+ * truthy value as `true` to be future safe. Note that using `byValue:true` has a performance impact on
7470
+ * property access and therefore should be used carefully. It also doesn't make sense to set this option
7471
+ * for properties with a primitive type (they have value semantic anyhow) or for properties with arrays
7472
+ * of primitive types (they are already cloned with a less expensive implementation). `group:string`
7473
+ * a semantic grouping of the properties, intended to be used in design time tools. Allowed values are (case
7474
+ * sensitive): Accessibility, Appearance, Behavior, Data, Designtime, Dimension, Identification, Misc
7456
7475
  * - `defaultValue: any` the default value for the property or null if there is no defaultValue.
7457
7476
  *
7458
7477
  * - `bindable: boolean|string` (either can be omitted or set to the boolean value `true` or the
@@ -10201,8 +10220,8 @@ declare namespace sap {
10201
10220
  *
10202
10221
  * The SAPUI5 Core Runtime.
10203
10222
  *
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.
10223
+ * Contains the UI5 Core and all its components, base classes for Controls, Components and the Model View
10224
+ * Controller classes.
10206
10225
  */
10207
10226
  namespace core {
10208
10227
  /**
@@ -13351,9 +13370,9 @@ declare namespace sap {
13351
13370
  */
13352
13371
  setMessages(
13353
13372
  /**
13354
- * map of messages: {'target': [array of messages],...}
13373
+ * map of messages: {'target': [sap.ui.core.message.Message],...}
13355
13374
  */
13356
- vMessages: Record<string, any[]>
13375
+ mMessages: Record<string, sap.ui.core.message.Message[]>
13357
13376
  ): void;
13358
13377
  }
13359
13378
 
@@ -13930,7 +13949,16 @@ declare namespace sap {
13930
13949
  /**
13931
13950
  * Parameters to pass along with the event
13932
13951
  */
13933
- oParameters?: object
13952
+ mParameters: {
13953
+ /**
13954
+ * Messages already existing before the `messageChange` event was fired.
13955
+ */
13956
+ oldMessages: sap.ui.core.message.Message;
13957
+ /**
13958
+ * New messages added by the trigger of the `messageChange` event.
13959
+ */
13960
+ newMessages: sap.ui.core.message.Message;
13961
+ }
13934
13962
  ): this;
13935
13963
  /**
13936
13964
  * Returns the ID of the MessageProcessor instance
@@ -13941,9 +13969,9 @@ declare namespace sap {
13941
13969
  */
13942
13970
  setMessages(
13943
13971
  /**
13944
- * map of messages: {'target': [array of messages],...}
13972
+ * map of messages: {'target': [sap.ui.core.message.Message],...}
13945
13973
  */
13946
- vMessages: Record<string, any[]>
13974
+ mMessages: Record<string, sap.ui.core.message.Message[]>
13947
13975
  ): void;
13948
13976
  }
13949
13977
  }
@@ -14036,6 +14064,8 @@ declare namespace sap {
14036
14064
 
14037
14065
  namespace XMLView {
14038
14066
  /**
14067
+ * @SINCE 1.34
14068
+ *
14039
14069
  * Specifies the available preprocessor types for XMLViews
14040
14070
  * See:
14041
14071
  * sap.ui.core.mvc.XMLView
@@ -14213,7 +14243,7 @@ declare namespace sap {
14213
14243
  * **Example for a callback module definition (sync):**
14214
14244
  * ```javascript
14215
14245
  *
14216
- * sap.ui.define("my/custom/sync/ExtensionProvider", ['jquery.sap.global'], function(jQuery) {
14246
+ * sap.ui.define("my/custom/sync/ExtensionProvider", [], function() {
14217
14247
  * var ExtensionProvider = function() {};
14218
14248
  * ExtensionProvider.prototype.getControllerExtensions = function(sControllerName, sComponentId, bAsync) {
14219
14249
  * if (!bAsync && sControllerName == "my.own.Controller") {
@@ -14232,14 +14262,14 @@ declare namespace sap {
14232
14262
  * }];
14233
14263
  * };
14234
14264
  * return ExtensionProvider;
14235
- * }, true);
14265
+ * });
14236
14266
  * ```
14237
14267
  *
14238
14268
  *
14239
14269
  * **Example for a callback module definition (async):**
14240
14270
  * ```javascript
14241
14271
  *
14242
- * sap.ui.define("my/custom/async/ExtensionProvider", ['jquery.sap.global'], function(jQuery) {
14272
+ * sap.ui.define("my/custom/async/ExtensionProvider", [], function() {
14243
14273
  * var ExtensionProvider = function() {};
14244
14274
  * ExtensionProvider.prototype.getControllerExtensions = function(sControllerName, sComponentId, bAsync) {
14245
14275
  * if (bAsync && sControllerName == "my.own.Controller") {
@@ -14263,7 +14293,7 @@ declare namespace sap {
14263
14293
  * };
14264
14294
  * };
14265
14295
  * return ExtensionProvider;
14266
- * }, true);
14296
+ * });
14267
14297
  * ```
14268
14298
  *
14269
14299
  *
@@ -14673,6 +14703,8 @@ declare namespace sap {
14673
14703
  static asyncSupport: boolean;
14674
14704
 
14675
14705
  /**
14706
+ * @SINCE 1.56.0
14707
+ *
14676
14708
  * Creates a JSON view of the given configuration.
14677
14709
  */
14678
14710
  static create(
@@ -15142,6 +15174,8 @@ declare namespace sap {
15142
15174
  */
15143
15175
  static getMetadata(): sap.ui.core.ElementMetadata;
15144
15176
  /**
15177
+ * @SINCE 1.30
15178
+ *
15145
15179
  * Register a preprocessor for all views of a specific type.
15146
15180
  *
15147
15181
  * The preprocessor can be registered for several stages of view initialization, which are dependent on
@@ -15812,6 +15846,8 @@ declare namespace sap {
15812
15846
  static asyncSupport: boolean;
15813
15847
 
15814
15848
  /**
15849
+ * @SINCE 1.56.0
15850
+ *
15815
15851
  * Instantiates an XMLView from the given configuration options.
15816
15852
  *
15817
15853
  * If a `viewName` is given, it must be a dot-separated name of an XML view resource (without the mandatory
@@ -15897,6 +15933,8 @@ declare namespace sap {
15897
15933
  */
15898
15934
  static getMetadata(): sap.ui.core.ElementMetadata;
15899
15935
  /**
15936
+ * @SINCE 1.30
15937
+ *
15900
15938
  * Register a preprocessor for all views of a specific type.
15901
15939
  *
15902
15940
  * The preprocessor can be registered for several stages of view initialization, for xml views these are
@@ -15943,6 +15981,8 @@ declare namespace sap {
15943
15981
  mSettings?: object
15944
15982
  ): void;
15945
15983
  /**
15984
+ * @SINCE 1.30
15985
+ *
15946
15986
  * Register a preprocessor for all views of a specific type.
15947
15987
  *
15948
15988
  * The preprocessor can be registered for several stages of view initialization, for xml views these are
@@ -16051,14 +16091,6 @@ declare namespace sap {
16051
16091
  * The theming parameters are immutable and cannot be changed at runtime. Multiple `Parameters.get()`
16052
16092
  * API calls for the same parameter name will always result in the same parameter value.
16053
16093
  *
16054
- * **Important, since 1.93:** When using the `Parameters.get()` API to retrieve theming parameters defined
16055
- * as CSS variables, please be aware that the API can also unknowingly retrieve arbitrary CSS variables
16056
- * defined in the DOM. All CSS variables defined via the `:root` pseudo-class can be retrieved this way.
16057
- * Please make sure to only access theming parameters defined in a UI5 theme/library.
16058
- *
16059
- *
16060
- *
16061
- *
16062
16094
  * The following API variants are available (see also the below examples):
16063
16095
  * - **(deprecated since 1.92)** If no parameter is given a key-value map containing all parameters is
16064
16096
  * returned
@@ -16155,6 +16187,8 @@ declare namespace sap {
16155
16187
 
16156
16188
  namespace Component {
16157
16189
  /**
16190
+ * @SINCE 1.67
16191
+ *
16158
16192
  * Registry of all `Component`s that currently exist.
16159
16193
  */
16160
16194
  interface registry {
@@ -16585,6 +16619,8 @@ declare namespace sap {
16585
16619
 
16586
16620
  namespace Element {
16587
16621
  /**
16622
+ * @SINCE 1.67
16623
+ *
16588
16624
  * Registry of all `sap.ui.core.Element`s that currently exist.
16589
16625
  */
16590
16626
  interface registry {
@@ -17177,7 +17213,7 @@ declare namespace sap {
17177
17213
 
17178
17214
  class Route extends sap.ui.base.EventProvider {
17179
17215
  /**
17180
- * Instantiates an SAPUI5 Route
17216
+ * Instantiates a route
17181
17217
  */
17182
17218
  constructor(
17183
17219
  /**
@@ -17256,21 +17292,21 @@ declare namespace sap {
17256
17292
  targetParent?: string;
17257
17293
  /**
17258
17294
  * **Deprecated since 1.28, use `target.controlId` instead.**
17259
- * Views will be put into a container Control, this might be a {@link sap.ui.ux3.Shell} control or a {@link
17260
- * sap.m.NavContainer} if working with mobile, or any other container. The id of this control has to be
17261
- * put in here
17295
+ * Views will be put into a container Control, this might be an {@link sap.ui.ux3.Shell} control or an
17296
+ * {@link sap.m.NavContainer} if working with mobile, or any other container. The id of this control has
17297
+ * to be put in here
17262
17298
  */
17263
17299
  targetControl?: string;
17264
17300
  /**
17265
17301
  * **Deprecated since 1.28, use `target.controlAggregation` instead.**
17266
- * The name of an aggregation of the targetControl, that contains views. Eg: a {@link sap.m.NavContainer}
17302
+ * The name of an aggregation of the targetControl, that contains views. Eg: an {@link sap.m.NavContainer}
17267
17303
  * has an aggregation "pages", another Example is the {@link sap.ui.ux3.Shell} it has "content".
17268
17304
  */
17269
17305
  targetAggregation?: string;
17270
17306
  /**
17271
17307
  * **Deprecated since 1.28, use `target.clearControlAggregation` instead.**
17272
17308
  * Defines a boolean that can be passed to specify if the aggregation should be cleared before adding the
17273
- * View to it. When using a {@link sap.ui.ux3.Shell} this should be true. For a {@link sap.m.NavContainer}
17309
+ * View to it. When using an {@link sap.ui.ux3.Shell} this should be true. For an {@link sap.m.NavContainer}
17274
17310
  * it should be false
17275
17311
  */
17276
17312
  clearTarget?: boolean;
@@ -17535,7 +17571,7 @@ declare namespace sap {
17535
17571
 
17536
17572
  class Router extends sap.ui.base.EventProvider {
17537
17573
  /**
17538
- * Instantiates a SAPUI5 Router
17574
+ * Instantiates a router
17539
17575
  */
17540
17576
  constructor(
17541
17577
  /**
@@ -17673,7 +17709,8 @@ declare namespace sap {
17673
17709
  * {
17674
17710
  * //same name as in the config.bypassed.target
17675
17711
  * notFound: {
17676
- * viewName: "notFound",
17712
+ * type: "View"
17713
+ * name: "notFound",
17677
17714
  * ...
17678
17715
  * // more properties to place the view in the correct container
17679
17716
  * }
@@ -18745,8 +18782,8 @@ declare namespace sap {
18745
18782
  */
18746
18783
  constructor(oOptions: {
18747
18784
  /**
18748
- * the views instance will create the views of all the targets defined, so if 2 targets have the same viewName,
18749
- * the same instance of the view will be displayed.
18785
+ * the views instance will create the instances of all the targets defined, so if 2 targets have the same
18786
+ * `type` and `name` set, the same instance of the target will be displayed.
18750
18787
  */
18751
18788
  views: sap.ui.core.routing.Views;
18752
18789
  /**
@@ -18884,8 +18921,8 @@ declare namespace sap {
18884
18921
  /**
18885
18922
  * Defines the name of the View or Component that will be created. For type 'Component', use option 'usage'
18886
18923
  * instead if an owner component exists. To place the view or component into a Control, use the options
18887
- * 'controlAggregation' and 'controlId'. Instance of View or Component will only be created once per 'name'
18888
- * or 'usage' combined with 'id'.
18924
+ * `controlAggregation` and `controlId`. Instance of View or Component will only be created once per `name`
18925
+ * or `usage` combined with `id`.
18889
18926
  * ```javascript
18890
18927
  *
18891
18928
  *
@@ -18920,21 +18957,22 @@ declare namespace sap {
18920
18957
  *
18921
18958
  * {
18922
18959
  * targets: {
18923
- * // If display("masterWelcome") is called, the master viewName will be placed in the 'MasterPages' of a control with the id splitContainter
18960
+ * // If display("masterWelcome") is called, the view with name "Welcome" will be placed in the 'MasterPages' of a control with the id splitContainter
18924
18961
  * masterWelcome: {
18925
18962
  * type: "View",
18926
18963
  * name: "Welcome",
18927
- * controlId: "splitContainer",
18928
- * controlAggregation: "masterPages",
18929
18964
  * id: "masterWelcome",
18965
+ * controlId: "splitContainer",
18966
+ * controlAggregation: "masterPages"
18930
18967
  * },
18931
- * // If display("detailWelcome") is called after the masterWelcome, a second instance with an own controller instance will be added in the detail pages.
18968
+ * // If display("detailWelcome") is called after the "masterWelcome" target, a second instance of the same view with its own controller instance will be added in the detail pages.
18932
18969
  * detailWelcome: {
18933
18970
  * type: "View",
18934
- * name: "WelcomeWithAlias",
18971
+ * name: "Welcome",
18972
+ * // another instance will be created because a different id is used
18973
+ * id: "detailWelcome",
18935
18974
  * controlId: "splitContainer",
18936
- * controlAggregation: "detailPages",
18937
- * id: "detailWelcome"
18975
+ * controlAggregation: "detailPages"
18938
18976
  * }
18939
18977
  * }
18940
18978
  * }
@@ -18954,8 +18992,9 @@ declare namespace sap {
18954
18992
  */
18955
18993
  viewType?: string;
18956
18994
  /**
18957
- * A prefix that will be prepended in front of the name.
18958
- * **Example:** name is set to "myView" and path is set to "myApp" - the created view name will be "myApp.myView".
18995
+ * A prefix that will be prepended in front of the `name`.
18996
+ * **Example:** `name` is set to "myView" and `path` is set to "myApp" - the created view's name will be
18997
+ * "myApp.myView".
18959
18998
  */
18960
18999
  path?: string;
18961
19000
  /**
@@ -21051,6 +21090,153 @@ declare namespace sap {
21051
21090
 
21052
21091
  namespace util {
21053
21092
  namespace MockServer {
21093
+ /**
21094
+ * Methods that can be used to respond to a request.
21095
+ */
21096
+ interface Response {
21097
+ __implements__sap_ui_core_util_MockServer_Response: boolean;
21098
+
21099
+ /**
21100
+ * Responds to the incoming request with the given `iStatusCode`, `mHeaders` and `sBody`.
21101
+ */
21102
+ respond(
21103
+ /**
21104
+ * HTTP status code to send with the response
21105
+ */
21106
+ StatusCode?: int,
21107
+ /**
21108
+ * HTTP headers to send with the response
21109
+ */
21110
+ mHeaders?: Record<string, string>,
21111
+ /**
21112
+ * A string that will be sent as response body
21113
+ */
21114
+ sBody?: string
21115
+ ): void;
21116
+ /**
21117
+ * Convenience variant of {@link #respond} which allows to send the content of an external resource as response.
21118
+ *
21119
+ * This method first synchronously fetches the given `sFileUrl`. Depending on the extension and path of
21120
+ * the `sFileUrl`, it propagates the received response body to {@link #respondJSON}, {@link #respondXML}
21121
+ * or {@link #respond}, using the given `iStatus` and `mHeaders`.
21122
+ *
21123
+ * The status code and headers of the received response are ignored. In particular, the `Content-Type` header
21124
+ * is not used for the mock server's response.
21125
+ */
21126
+ respondFile(
21127
+ /**
21128
+ * HTTP status code to send with the response
21129
+ */
21130
+ iStatusCode: int,
21131
+ /**
21132
+ * HTTP Headers to send with the response
21133
+ */
21134
+ mHeaders: Record<string, string>,
21135
+ /**
21136
+ * URL to get the response body from
21137
+ */
21138
+ sFileUrl: string
21139
+ ): void;
21140
+ /**
21141
+ * Convenience variant of {@link #respond} which allows to send the content of an external resource as response.
21142
+ *
21143
+ * This method first synchronously fetches the given `sFileUrl`. Depending on the extension and path of
21144
+ * the `sFileUrl`, it propagates the received response body to {@link #respondJSON}, {@link #respondXML}
21145
+ * or {@link #respond}, using the given `iStatus` and `mHeaders`.
21146
+ *
21147
+ * The status code and headers of the received response are ignored. In particular, the `Content-Type` header
21148
+ * is not used for the mock server's response.
21149
+ */
21150
+ respondFile(
21151
+ /**
21152
+ * HTTP status code to send with the response
21153
+ */
21154
+ iStatusCode: int,
21155
+ /**
21156
+ * URL to get the response body from
21157
+ */
21158
+ sFileUrl: string
21159
+ ): void;
21160
+ /**
21161
+ * Convenience variant of {@link #respond} which allows to send the content of an external resource as response.
21162
+ *
21163
+ * This method first synchronously fetches the given `sFileUrl`. Depending on the extension and path of
21164
+ * the `sFileUrl`, it propagates the received response body to {@link #respondJSON}, {@link #respondXML}
21165
+ * or {@link #respond}, using the given `iStatus` and `mHeaders`.
21166
+ *
21167
+ * The status code and headers of the received response are ignored. In particular, the `Content-Type` header
21168
+ * is not used for the mock server's response.
21169
+ */
21170
+ respondFile(
21171
+ /**
21172
+ * HTTP Headers to send with the response
21173
+ */
21174
+ mHeaders: Record<string, string>,
21175
+ /**
21176
+ * URL to get the response body from
21177
+ */
21178
+ sFileUrl: string
21179
+ ): void;
21180
+ /**
21181
+ * Convenience variant of {@link #respond} which allows to send the content of an external resource as response.
21182
+ *
21183
+ * This method first synchronously fetches the given `sFileUrl`. Depending on the extension and path of
21184
+ * the `sFileUrl`, it propagates the received response body to {@link #respondJSON}, {@link #respondXML}
21185
+ * or {@link #respond}, using the given `iStatus` and `mHeaders`.
21186
+ *
21187
+ * The status code and headers of the received response are ignored. In particular, the `Content-Type` header
21188
+ * is not used for the mock server's response.
21189
+ */
21190
+ respondFile(
21191
+ /**
21192
+ * URL to get the response body from
21193
+ */
21194
+ sFileUrl: string
21195
+ ): void;
21196
+ /**
21197
+ * Convenience variant of {@link #respond} which simplifies sending a JSON response.
21198
+ *
21199
+ * The response content `vBody` can either be given as a string, which is then assumed to be in JSON format.
21200
+ * Or it can be any JSON-stringifiable value which then will be converted to a string using `JSON.stringify`.
21201
+ * If no `vBody` is given, an empty response will be sent.
21202
+ *
21203
+ * If no `Content-Type` header is given, it will be set to `application/json`.
21204
+ */
21205
+ respondJSON(
21206
+ /**
21207
+ * HTTP status code to send with the response
21208
+ */
21209
+ iStatusCode?: int,
21210
+ /**
21211
+ * HTTP Headers to send with the response
21212
+ */
21213
+ mHeaders?: Record<string, string>,
21214
+ /**
21215
+ * A valid JSON-string or a JSON-stringifiable object that should be sent as response body
21216
+ */
21217
+ vBody?: object | string
21218
+ ): void;
21219
+ /**
21220
+ * Convenience variant of {@link #respond} which simplifies sending an XML response.
21221
+ *
21222
+ * If no `Content-Type` header is given, it will be set to `application/xml`.
21223
+ */
21224
+ respondXML(
21225
+ /**
21226
+ * HTTP status code to send with the response
21227
+ */
21228
+ iStatusCode?: int,
21229
+ /**
21230
+ * HTTP Headers to send with the response
21231
+ */
21232
+ mHeaders?: Record<string, string>,
21233
+ /**
21234
+ * XML string to send as response body
21235
+ */
21236
+ sXmlString?: string
21237
+ ): void;
21238
+ }
21239
+
21054
21240
  /**
21055
21241
  * Enum for the method.
21056
21242
  */
@@ -21067,6 +21253,29 @@ declare namespace sap {
21067
21253
 
21068
21254
  PUT = "PUT",
21069
21255
  }
21256
+
21257
+ type RequestHandler = {
21258
+ /**
21259
+ * Any HTTP verb
21260
+ */
21261
+ method: sap.ui.core.util.MockServer.HTTPMETHOD;
21262
+ /**
21263
+ * A string path is converted to a regular expression, so it can contain normal regular expression syntax.
21264
+ *
21265
+ * All regular expression groups are forwarded as arguments to the `response` function. In addition to this,
21266
+ * parameters can be written in this notation: `:param`. These placeholders will be replaced by regular
21267
+ * expression groups.
21268
+ */
21269
+ path: string | RegExp;
21270
+ /**
21271
+ * A response handler function that will be called when an incoming request matches `method` and `path`.
21272
+ * The first parameter of the handler will be a `Response` object which can be used to respond on the request.
21273
+ */
21274
+ response: (
21275
+ p1: sap.ui.core.util.MockServer.Response,
21276
+ p2: any
21277
+ ) => void;
21278
+ };
21070
21279
  }
21071
21280
 
21072
21281
  namespace XMLPreprocessor {
@@ -22428,7 +22637,7 @@ declare namespace sap {
22428
22637
  *
22429
22638
  * Default value is `[]`
22430
22639
  */
22431
- getRequests(): object[];
22640
+ getRequests(): sap.ui.core.util.MockServer.RequestHandler[];
22432
22641
  /**
22433
22642
  * Getter for property `rootUri`. Has to be relative and requires a trailing '/'. It also needs to match
22434
22643
  * the URI set in OData/JSON models or simple XHR calls in order for the mock server to intercept them.
@@ -22466,34 +22675,14 @@ declare namespace sap {
22466
22675
  /**
22467
22676
  * Setter for property `requests`.
22468
22677
  *
22469
- * Default value is is `[]`
22470
- *
22471
- * Each array entry should consist of an object with the following properties / values:
22472
- *
22473
- *
22474
- * - **method : "GET"|"POST"|"DELETE|"PUT"**
22475
- * (any HTTP verb)
22476
- * - **path : "/path/to/resource"**
22477
- * The path is converted to a regular expression, so it can contain normal regular expression syntax. All
22478
- * regular expression groups are forwarded as arguments to the `response` function. In addition to this,
22479
- * parameters can be written in this notation: `:param`. These placeholder will be replaced by regular expression
22480
- * groups.
22481
- * - **response : function(xhr, param1, param2, ...) { }**
22482
- * The xhr object can be used to respond on the request. Supported methods are:
22483
- * `xhr.respond(iStatusCode, mHeaders, sBody)`
22484
- * `xhr.respondJSON(iStatusCode, mHeaders, oJsonObjectOrString)`. By default a JSON header is set for response
22485
- * header
22486
- * `xhr.respondXML(iStatusCode, mHeaders, sXmlString)`. By default an XML header is set for response header
22487
- *
22488
- * `xhr.respondFile(iStatusCode, mHeaders, sFileUrl)`. By default the mime type of the file is set for
22489
- * response header
22678
+ * Default value is `[]`
22490
22679
  */
22491
22680
  setRequests(
22492
22681
  /**
22493
- * new value for property `requests`
22682
+ * new value for the `requests` property
22494
22683
  */
22495
- requests: object[]
22496
- ): void;
22684
+ requests: sap.ui.core.util.MockServer.RequestHandler[]
22685
+ ): this;
22497
22686
  /**
22498
22687
  * Setter for property `rootUri`. All request path URI are prefixed with this root URI if set.
22499
22688
  *
@@ -23039,6 +23228,38 @@ declare namespace sap {
23039
23228
  __implements__sap_ui_core_IAsyncContentCreation: boolean;
23040
23229
  }
23041
23230
 
23231
+ /**
23232
+ * @SINCE 1.98.0
23233
+ * @EXPERIMENTAL (since 1.98)
23234
+ *
23235
+ * Marker interface for controls that can serve as a menu for a table column header.
23236
+ *
23237
+ * Implementation of this interface implements the `openBy` and `getAriaHasPopupType` methods.
23238
+ */
23239
+ interface IColumnHeaderMenu {
23240
+ __implements__sap_ui_core_IColumnHeaderMenu: boolean;
23241
+
23242
+ /**
23243
+ * @SINCE 1.98.0
23244
+ * @EXPERIMENTAL (since 1.98)
23245
+ *
23246
+ * Returns the sap.ui.core.aria.HasPopup<\code> type of the menu.
23247
+ */
23248
+ getAriaHasPopupType(): sap.ui.core.aria.HasPopup;
23249
+ /**
23250
+ * @SINCE 1.98.0
23251
+ * @EXPERIMENTAL (since 1.98)
23252
+ *
23253
+ * Opens the menu using the column header.
23254
+ */
23255
+ openBy(
23256
+ /**
23257
+ * Specifies the control where the menu is placed.
23258
+ */
23259
+ oControl: sap.ui.core.Control
23260
+ ): void;
23261
+ }
23262
+
23042
23263
  /**
23043
23264
  * Marker interface for controls that can serve as a context menu.
23044
23265
  *
@@ -28107,8 +28328,8 @@ declare namespace sap {
28107
28328
  /**
28108
28329
  * @SINCE 1.95.0
28109
28330
  *
28110
- * Sets the security token handlers for an OData V4 model. See chapter "Security Token Handling" in {@link
28111
- * topic:9613f1f2d88747cab21896f7216afdac Model Instantiation and Data Access}.
28331
+ * Sets the security token handlers for an OData V4 model. See chapter {@link topic:9613f1f2d88747cab21896f7216afdac/section_STH
28332
+ * Security Token Handling}.
28112
28333
  * See:
28113
28334
  * #getSecurityTokenHandlers
28114
28335
  */
@@ -28320,9 +28541,9 @@ declare namespace sap {
28320
28541
  * **IMPORTANT:**
28321
28542
  * This should be only used as FALLBACK when the Control events do not cover a specific use-case! Always
28322
28543
  * try using SAPUI5 control events, as e.g. accessibility-related functionality is then provided automatically.
28323
- * E.g. when working with a `sap.ui.commons.Button`, always use the Button's "press" event, not the native
28324
- * "click" event, because "press" is also guaranteed to be fired when certain keyboard activity is supposed
28325
- * to trigger the Button.
28544
+ * E.g. when working with a `sap.m.Button`, always use the Button's "press" event, not the native "click"
28545
+ * event, because "press" is also guaranteed to be fired when certain keyboard activity is supposed to trigger
28546
+ * the Button.
28326
28547
  *
28327
28548
  * In the event handler, `this` refers to the Control - not to the root DOM element like in jQuery. While
28328
28549
  * the DOM element can be used and modified, the general caveats for working with SAPUI5 control DOM elements
@@ -29617,6 +29838,10 @@ declare namespace sap {
29617
29838
  * visible before the focus is set
29618
29839
  */
29619
29840
  preventScroll?: boolean;
29841
+ /**
29842
+ * Further control-specific setting of the focus target within the control @since 1.98
29843
+ */
29844
+ targetInfo?: any;
29620
29845
  }
29621
29846
  ): void;
29622
29847
  /**
@@ -34810,7 +35035,7 @@ declare namespace sap {
34810
35035
  *
34811
35036
  * Writes the attribute and its value into the HTML.
34812
35037
  *
34813
- * For details about the escaping refer to {@link jQuery.sap.encodeHTML}
35038
+ * For details about the escaping refer to {@link sap/base/security/encodeXML}.
34814
35039
  */
34815
35040
  writeAttribute(
34816
35041
  /**
@@ -34888,7 +35113,7 @@ declare namespace sap {
34888
35113
  *
34889
35114
  * Escape text for HTML and write it to the buffer.
34890
35115
  *
34891
- * For details about the escaping refer to {@link jQuery.sap.encodeHTML}
35116
+ * For details about the escaping refer to {@link sap/base/security/encodeXML}.
34892
35117
  */
34893
35118
  writeEscaped(
34894
35119
  /**
@@ -35902,7 +36127,7 @@ declare namespace sap {
35902
36127
  /**
35903
36128
  * Returns this `UIArea`'s id (as determined from provided RootNode).
35904
36129
  */
35905
- getId(): string | null;
36130
+ getId(): string;
35906
36131
  /**
35907
36132
  * @deprecated (since 1.1) - use function {@link #getContent} instead
35908
36133
  *
@@ -37627,7 +37852,7 @@ declare namespace sap {
37627
37852
  *
37628
37853
  * Noteworthy details:
37629
37854
  * - whitespace is mandatory around a '-' or '+' operator and optional otherwise
37630
- * - parentheses are accepted but not checked for being balanced (a limitation of regexp based checks)
37855
+ * - parentheses are accepted but not checked for being balanced (a restriction of regexp based checks)
37631
37856
  *
37632
37857
  * - semantic constraints like type restrictions are not checked
37633
37858
  *
@@ -37685,7 +37910,7 @@ declare namespace sap {
37685
37910
  *
37686
37911
  * Noteworthy details:
37687
37912
  * - whitespace is mandatory around a '-' or '+' operator and optional otherwise
37688
- * - parentheses are accepted but not checked for being balanced (a limitation of regexp based checks)
37913
+ * - parentheses are accepted but not checked for being balanced (a restriction of regexp based checks)
37689
37914
  *
37690
37915
  * - semantic constraints like type restrictions are not checked
37691
37916
  *
@@ -39556,10 +39781,9 @@ declare namespace sap {
39556
39781
  /**
39557
39782
  * A comma-separated list of property names that need to be selected.
39558
39783
  * If the `select` parameter is given, it has to contain all properties that are contained in the analytical
39559
- * information (see {@link sap.ui.model.analytics.AnalyticalBinding#updateAnalyticalInfo}) and their associated
39560
- * dimensions and measures. It must not contain additional dimensions or measures or associated properties
39561
- * for additional dimensions or measures. But it may contain additional properties like a text property
39562
- * of a dimension that is also selected.
39784
+ * information (see {@link sap.ui.model.analytics.AnalyticalBinding#updateAnalyticalInfo}). It must not
39785
+ * contain additional dimensions or measures or associated properties for additional dimensions or measures.
39786
+ * But it may contain additional properties like a text property of a dimension that is also selected.
39563
39787
  * All properties of the `select` parameter are also considered in {@link sap.ui.model.analytics.AnalyticalBinding#getDownloadUrl}.
39564
39788
  * The `select` parameter must not contain any duplicate entry.
39565
39789
  * If the `select` parameter does not fit to the analytical information or if the `select` parameter contains
@@ -39918,34 +40142,41 @@ declare namespace sap {
39918
40142
  * Updates the binding's structure with new analytical information.
39919
40143
  *
39920
40144
  * Analytical information is the mapping of UI columns to properties in the bound OData entity set. Every
39921
- * column object contains the name of the bound property and in addition:
40145
+ * column object contains the `name` of the bound property and in addition:
39922
40146
  * - A column bound to a dimension property has further boolean properties:
39923
- * grouped: dimension will be used for building groups
39924
- * - visible: if the column is visible, values for the related property will be fetched from the OData
39925
- * service
40147
+ * grouped: dimension is used for building groups
39926
40148
  * - inResult: if the column is not visible, but declared to be part of the result, values for the related
39927
- * property will also be fetched from the OData service
40149
+ * property are also fetched from the OData service
40150
+ * - visible: if the column is visible, values for the related property are fetched from the OData service
40151
+ *
39928
40152
  * - A column bound to a measure property has further boolean properties:
39929
- * total: totals and sub-totals will be provided for the measure at all aggregation levels
40153
+ * inResult: if the column is not visible, but declared to be part of the result, values for the related
40154
+ * property are also fetched from the OData service
40155
+ * - total: totals and sub-totals are provided for the measure at all aggregation levels
40156
+ * - visible: if the column is visible, values for the related property are fetched from the OData service
39930
40157
  *
39931
40158
  * - A column bound to a hierarchy property has further properties:
39932
- * grouped: boolean value; indicates whether the hierarchy will be used for building groups
40159
+ * grouped: boolean value; indicates whether the hierarchy is used for building groups
39933
40160
  * - level: integer value; the hierarchy level is mandatory for at least one of those columns that represent
39934
- * the same hierarchy.
40161
+ * the same hierarchy
39935
40162
  *
39936
40163
  * Invoking this function resets the state of the binding and subsequent data requests such as calls to
39937
- * getNodeContexts() will need to trigger OData requests in order to fetch the data that are in line with
39938
- * this analytical information.
40164
+ * getNodeContexts() trigger OData requests in order to fetch the data that are in line with this analytical
40165
+ * information.
39939
40166
  *
39940
- * Please be aware that a call of this function might lead to additional back-end requests, as well as a
39941
- * control re-rendering later on. Whenever possible use the API of the analytical control, instead of relying
39942
- * on the binding.
40167
+ * Be aware that a call of this function might lead to additional back-end requests, as well as a control
40168
+ * re-rendering later on. Whenever possible use the API of the analytical control, instead of relying on
40169
+ * the binding.
39943
40170
  */
39944
40171
  updateAnalyticalInfo(
39945
40172
  /**
39946
- * an array with objects holding the analytical information for every column, from left to right.
40173
+ * An array with objects holding the analytical information for every column
39947
40174
  */
39948
- aColumns: any[]
40175
+ aColumns: object[],
40176
+ /**
40177
+ * Whether to fire a change event asynchronously even if columns didn't change
40178
+ */
40179
+ bForceChange: boolean
39949
40180
  ): void;
39950
40181
  }
39951
40182
 
@@ -42963,6 +43194,7 @@ declare namespace sap {
42963
43194
  * A context for the OData V2 model cannot be created at will, it has to be retrieved via:
42964
43195
  * - an OData binding
42965
43196
  * - a view element
43197
+ * - {@link sap.ui.model.odata.v2.ODataListBinding#create}
42966
43198
  * - {@link sap.ui.model.odata.v2.ODataModel#callFunction}
42967
43199
  * - {@link sap.ui.model.odata.v2.ODataModel#createBindingContext}
42968
43200
  * - {@link sap.ui.model.odata.v2.ODataModel#createEntry}
@@ -42998,21 +43230,37 @@ declare namespace sap {
42998
43230
  /**
42999
43231
  * @SINCE 1.96.0
43000
43232
  *
43001
- * Returns a promise on the creation state of this context if it has been created via {@link sap.ui.model.odata.v2.ODataModel#createEntry};
43002
- * otherwise returns `undefined`.
43233
+ * Returns a promise on the creation state of this context if it has been created via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
43234
+ * or {@link sap.ui.model.odata.v2.ODataListBinding#create}; otherwise returns `undefined`.
43003
43235
  *
43004
43236
  * As long as the promise is not yet resolved or rejected, the entity represented by this context is transient.
43005
43237
  *
43006
43238
  * Once the promise is resolved, the entity for this context is stored in the back end and {@link #getPath}
43007
43239
  * returns a path including the key predicate of the new entity.
43240
+ *
43241
+ * If the context has been created via {@link sap.ui.model.odata.v2.ODataListBinding#create} and the entity
43242
+ * for this context has been stored in the back end, {@link #created} returns `undefined` after the data
43243
+ * has been re-read from the back end and inserted at the right position based on the list binding's filters
43244
+ * and sorters. If the context has been created via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
43245
+ * and the entity for this context has been stored in the back end, {@link #created} returns `undefined`.
43008
43246
  */
43009
43247
  created(): Promise<any>;
43248
+ /**
43249
+ * @SINCE 1.98.0
43250
+ *
43251
+ * Returns whether this context is inactive. An inactive context will only be sent to the server after the
43252
+ * first property update. From then on it behaves like any other created context.
43253
+ * See:
43254
+ * sap.ui.model.odata.v2.ODataListBinding#create
43255
+ * sap.ui.model.odata.v2.ODataModel#createEntry
43256
+ */
43257
+ isInactive(): boolean;
43010
43258
  /**
43011
43259
  * @SINCE 1.94.0
43012
43260
  *
43013
- * For a context created using {@link sap.ui.model.odata.v2.ODataModel#createEntry}, the method returns
43014
- * `true` if the context is transient or `false` if the context is not transient. A transient context represents
43015
- * an entity created on the client which has not been persisted in the back end.
43261
+ * For a context created using {@link sap.ui.model.odata.v2.ODataModel#createEntry} or {@link sap.ui.model.odata.v2.ODataListBinding#create},
43262
+ * the method returns `true` if the context is transient or `false` if the context is not transient. A transient
43263
+ * context represents an entity created on the client which has not been persisted in the back end.
43016
43264
  */
43017
43265
  isTransient(): boolean;
43018
43266
  }
@@ -43628,8 +43876,8 @@ declare namespace sap {
43628
43876
  */
43629
43877
  countMode?: sap.ui.model.odata.CountMode;
43630
43878
  /**
43631
- * A key used in combination with the resolved path of this binding to identify the entities created this
43632
- * binding's {@link #create} method.
43879
+ * A key used in combination with the resolved path of this binding to identify the entities created by
43880
+ * this binding's {@link #create} method.
43633
43881
  *
43634
43882
  * **Note:** Different controls or control aggregation bindings to the same collection must have different
43635
43883
  * `createdEntitiesKey` values.
@@ -43704,6 +43952,230 @@ declare namespace sap {
43704
43952
  * Returns a metadata object for class sap.ui.model.odata.v2.ODataListBinding.
43705
43953
  */
43706
43954
  static getMetadata(): sap.ui.base.Metadata;
43955
+ /**
43956
+ * @SINCE 1.98.0
43957
+ *
43958
+ * Attach event handler `fnFunction` to the 'createActivate' event of this binding.
43959
+ */
43960
+ attachCreateActivate(
43961
+ /**
43962
+ * The function to call when the event occurs
43963
+ */
43964
+ fnFunction: Function,
43965
+ /**
43966
+ * Object on which to call the given function
43967
+ */
43968
+ oListener?: object
43969
+ ): void;
43970
+ /**
43971
+ * @SINCE 1.98.0
43972
+ *
43973
+ * Creates a new entity for this binding's collection via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
43974
+ * using the parameters given in `mParameters` and inserts it at the list position specified by the `bAtEnd`
43975
+ * parameter.
43976
+ *
43977
+ * Note: This method requires that the model metadata has been loaded; see {@link sap.ui.model.odata.v2.ODataModel#metadataLoaded}.
43978
+ */
43979
+ create(
43980
+ /**
43981
+ * The initial data for the created entity; see the `mParameters.properties` parameter of {@link sap.ui.model.odata.v2.ODataModel#createEntry}
43982
+ */
43983
+ oInitialData: object,
43984
+ /**
43985
+ * Whether the entity is inserted at the end of the list. The first insertion determines the overall position
43986
+ * of created contexts within the list. Every succeeding insertion is relative to the created contexts within
43987
+ * this list. Note: the order of created contexts in the binding does not necessarily correspond to the
43988
+ * order of the resulting back end creation requests.
43989
+ */
43990
+ bAtEnd: boolean,
43991
+ /**
43992
+ * A map of parameters as specified for {@link sap.ui.model.odata.v2.ODataModel#createEntry} where only
43993
+ * the following subset of these is supported.
43994
+ */
43995
+ mParameters: {
43996
+ /**
43997
+ * The ID of the `ChangeSet` that this request should belong to
43998
+ */
43999
+ changeSetId?: string;
44000
+ /**
44001
+ * The error callback function
44002
+ */
44003
+ error?: Function;
44004
+ /**
44005
+ * A comma-separated list of navigation properties to be expanded for the newly created entity; see {@link
44006
+ * sap.ui.model.odata.v2.ODataModel#createEntry}
44007
+ */
44008
+ expand?: string;
44009
+ /**
44010
+ * The ID of a request group; requests belonging to the same group will be bundled in one batch request
44011
+ */
44012
+ groupId?: string;
44013
+ /**
44014
+ * Whether the created context is inactive. An inactive context will only be sent to the server after the
44015
+ * first property update. From then on it behaves like any other created context.
44016
+ */
44017
+ inactive?: boolean;
44018
+ /**
44019
+ * The success callback function
44020
+ */
44021
+ success?: Function;
44022
+ }
44023
+ ): sap.ui.model.odata.v2.Context;
44024
+ /**
44025
+ * @SINCE 1.98.0
44026
+ *
44027
+ * Creates a new entity for this binding's collection via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
44028
+ * using the parameters given in `mParameters` and inserts it at the list position specified by the `bAtEnd`
44029
+ * parameter.
44030
+ *
44031
+ * Note: This method requires that the model metadata has been loaded; see {@link sap.ui.model.odata.v2.ODataModel#metadataLoaded}.
44032
+ */
44033
+ create(
44034
+ /**
44035
+ * The initial data for the created entity; see the `mParameters.properties` parameter of {@link sap.ui.model.odata.v2.ODataModel#createEntry}
44036
+ */
44037
+ oInitialData: object,
44038
+ /**
44039
+ * A map of parameters as specified for {@link sap.ui.model.odata.v2.ODataModel#createEntry} where only
44040
+ * the following subset of these is supported.
44041
+ */
44042
+ mParameters: {
44043
+ /**
44044
+ * The ID of the `ChangeSet` that this request should belong to
44045
+ */
44046
+ changeSetId?: string;
44047
+ /**
44048
+ * The error callback function
44049
+ */
44050
+ error?: Function;
44051
+ /**
44052
+ * A comma-separated list of navigation properties to be expanded for the newly created entity; see {@link
44053
+ * sap.ui.model.odata.v2.ODataModel#createEntry}
44054
+ */
44055
+ expand?: string;
44056
+ /**
44057
+ * The ID of a request group; requests belonging to the same group will be bundled in one batch request
44058
+ */
44059
+ groupId?: string;
44060
+ /**
44061
+ * Whether the created context is inactive. An inactive context will only be sent to the server after the
44062
+ * first property update. From then on it behaves like any other created context.
44063
+ */
44064
+ inactive?: boolean;
44065
+ /**
44066
+ * The success callback function
44067
+ */
44068
+ success?: Function;
44069
+ }
44070
+ ): sap.ui.model.odata.v2.Context;
44071
+ /**
44072
+ * @SINCE 1.98.0
44073
+ *
44074
+ * Creates a new entity for this binding's collection via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
44075
+ * using the parameters given in `mParameters` and inserts it at the list position specified by the `bAtEnd`
44076
+ * parameter.
44077
+ *
44078
+ * Note: This method requires that the model metadata has been loaded; see {@link sap.ui.model.odata.v2.ODataModel#metadataLoaded}.
44079
+ */
44080
+ create(
44081
+ /**
44082
+ * Whether the entity is inserted at the end of the list. The first insertion determines the overall position
44083
+ * of created contexts within the list. Every succeeding insertion is relative to the created contexts within
44084
+ * this list. Note: the order of created contexts in the binding does not necessarily correspond to the
44085
+ * order of the resulting back end creation requests.
44086
+ */
44087
+ bAtEnd: boolean,
44088
+ /**
44089
+ * A map of parameters as specified for {@link sap.ui.model.odata.v2.ODataModel#createEntry} where only
44090
+ * the following subset of these is supported.
44091
+ */
44092
+ mParameters: {
44093
+ /**
44094
+ * The ID of the `ChangeSet` that this request should belong to
44095
+ */
44096
+ changeSetId?: string;
44097
+ /**
44098
+ * The error callback function
44099
+ */
44100
+ error?: Function;
44101
+ /**
44102
+ * A comma-separated list of navigation properties to be expanded for the newly created entity; see {@link
44103
+ * sap.ui.model.odata.v2.ODataModel#createEntry}
44104
+ */
44105
+ expand?: string;
44106
+ /**
44107
+ * The ID of a request group; requests belonging to the same group will be bundled in one batch request
44108
+ */
44109
+ groupId?: string;
44110
+ /**
44111
+ * Whether the created context is inactive. An inactive context will only be sent to the server after the
44112
+ * first property update. From then on it behaves like any other created context.
44113
+ */
44114
+ inactive?: boolean;
44115
+ /**
44116
+ * The success callback function
44117
+ */
44118
+ success?: Function;
44119
+ }
44120
+ ): sap.ui.model.odata.v2.Context;
44121
+ /**
44122
+ * @SINCE 1.98.0
44123
+ *
44124
+ * Creates a new entity for this binding's collection via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
44125
+ * using the parameters given in `mParameters` and inserts it at the list position specified by the `bAtEnd`
44126
+ * parameter.
44127
+ *
44128
+ * Note: This method requires that the model metadata has been loaded; see {@link sap.ui.model.odata.v2.ODataModel#metadataLoaded}.
44129
+ */
44130
+ create(
44131
+ /**
44132
+ * A map of parameters as specified for {@link sap.ui.model.odata.v2.ODataModel#createEntry} where only
44133
+ * the following subset of these is supported.
44134
+ */
44135
+ mParameters: {
44136
+ /**
44137
+ * The ID of the `ChangeSet` that this request should belong to
44138
+ */
44139
+ changeSetId?: string;
44140
+ /**
44141
+ * The error callback function
44142
+ */
44143
+ error?: Function;
44144
+ /**
44145
+ * A comma-separated list of navigation properties to be expanded for the newly created entity; see {@link
44146
+ * sap.ui.model.odata.v2.ODataModel#createEntry}
44147
+ */
44148
+ expand?: string;
44149
+ /**
44150
+ * The ID of a request group; requests belonging to the same group will be bundled in one batch request
44151
+ */
44152
+ groupId?: string;
44153
+ /**
44154
+ * Whether the created context is inactive. An inactive context will only be sent to the server after the
44155
+ * first property update. From then on it behaves like any other created context.
44156
+ */
44157
+ inactive?: boolean;
44158
+ /**
44159
+ * The success callback function
44160
+ */
44161
+ success?: Function;
44162
+ }
44163
+ ): sap.ui.model.odata.v2.Context;
44164
+ /**
44165
+ * @SINCE 1.98.0
44166
+ *
44167
+ * Detach event handler `fnFunction` from the 'createActivate' event of this binding.
44168
+ */
44169
+ detachCreateActivate(
44170
+ /**
44171
+ * The function to call when the event occurs
44172
+ */
44173
+ fnFunction: Function,
44174
+ /**
44175
+ * Object on which to call the given function
44176
+ */
44177
+ oListener?: object
44178
+ ): void;
43707
44179
  /**
43708
44180
  * Filters the list.
43709
44181
  *
@@ -43712,6 +44184,9 @@ declare namespace sap {
43712
44184
  * with AND. Usually this means, all filters applied to a single table column are combined with OR, while
43713
44185
  * filters on different table columns are combined with AND. Please note that a custom filter function is
43714
44186
  * only supported with operation mode `sap.ui.model.odata.OperationMode.Client`.
44187
+ *
44188
+ * Entities that have been created via {@link #create} and saved in the back end are removed from the creation
44189
+ * rows area and inserted at the right position based on the current filters and sorters.
43715
44190
  */
43716
44191
  filter(
43717
44192
  /**
@@ -43727,6 +44202,15 @@ declare namespace sap {
43727
44202
  */
43728
44203
  bReturnSuccess?: boolean
43729
44204
  ): this;
44205
+ /**
44206
+ * @SINCE 1.98.0
44207
+ *
44208
+ * Returns all current contexts of this list binding in no special order. Just like {@link #getCurrentContexts},
44209
+ * this method does not request any data from a back end and does not change the binding's state. In contrast
44210
+ * to {@link #getCurrentContexts}, it does not only return those contexts that were last requested by a
44211
+ * control, but all contexts that are currently available in the binding.
44212
+ */
44213
+ getAllCurrentContexts(): sap.ui.model.odata.v2.Context[];
43730
44214
  /**
43731
44215
  * Return contexts for the list.
43732
44216
  */
@@ -43744,6 +44228,18 @@ declare namespace sap {
43744
44228
  */
43745
44229
  iThreshold?: int
43746
44230
  ): sap.ui.model.odata.v2.Context[];
44231
+ /**
44232
+ * @SINCE 1.98.0
44233
+ *
44234
+ * Returns the count of active entries in the list if the list length is final, otherwise `undefined`. Contrary
44235
+ * to {#getLength}, this method does not consider inactive entries which are created via {#create}.
44236
+ * See:
44237
+ * #create
44238
+ * #getLength
44239
+ * #isLengthFinal
44240
+ * sap.ui.model.odata.v2.Context#isInactive
44241
+ */
44242
+ getCount(): number | undefined;
43747
44243
  /**
43748
44244
  * @SINCE 1.24
43749
44245
  *
@@ -43769,10 +44265,20 @@ declare namespace sap {
43769
44265
  * do nothing, method will be called again when metadata is loaded.
43770
44266
  */
43771
44267
  initialize(): sap.ui.model.odata.v2.ODataListBinding;
44268
+ /**
44269
+ * @SINCE 1.98.0
44270
+ *
44271
+ * Returns whether the overall position of created entries is at the end of the list; this is determined
44272
+ * by the first call to {@link sap.ui.model.odata.v2.ODataListBinding#create}.
44273
+ */
44274
+ isFirstCreateAtEnd(): boolean | undefined;
43772
44275
  /**
43773
44276
  * Refreshes the binding, check whether the model data has been changed and fire change event if this is
43774
44277
  * the case. For server side models this should refetch the data from the server. To update a control, even
43775
44278
  * if no data has been changed, e.g. to reset a control after failed validation, use the parameter `bForceUpdate`.
44279
+ *
44280
+ * Entities that have been created via {@link #create} and saved in the back end are removed from the creation
44281
+ * rows area and inserted at the right position based on the current filters and sorters.
43776
44282
  */
43777
44283
  refresh(
43778
44284
  /**
@@ -43804,6 +44310,9 @@ declare namespace sap {
43804
44310
  ): Promise<sap.ui.model.Filter>;
43805
44311
  /**
43806
44312
  * Sorts the list.
44313
+ *
44314
+ * Entities that have been created via {@link #create} and saved in the back end are removed from the creation
44315
+ * rows area and inserted at the right position based on the current filters and sorters.
43807
44316
  */
43808
44317
  sort(
43809
44318
  /**
@@ -44662,7 +45171,7 @@ declare namespace sap {
44662
45171
  * Maps the function import parameter name as specified in the function import's metadata to its value;
44663
45172
  * the value is formatted based on the parameter's type as specified in the metadata
44664
45173
  */
44665
- urlParameters?: Record<string, string>;
45174
+ urlParameters?: Record<string, any>;
44666
45175
  /**
44667
45176
  * **Deprecated - use `groupId` instead**
44668
45177
  */
@@ -44790,7 +45299,7 @@ declare namespace sap {
44790
45299
  * Whether to reload data
44791
45300
  */
44792
45301
  bReload?: boolean
44793
- ): sap.ui.model.odata.v2.Context;
45302
+ ): sap.ui.model.odata.v2.Context | undefined;
44794
45303
  /**
44795
45304
  * Creates a new entry object which is described by the metadata of the entity type of the specified `sPath`
44796
45305
  * Name. A context object is returned which can be used to bind against the newly created object.
@@ -44888,6 +45397,11 @@ declare namespace sap {
44888
45397
  * A map of headers
44889
45398
  */
44890
45399
  headers?: Record<string, string>;
45400
+ /**
45401
+ * Whether the created context is inactive. An inactive context will only be sent to the server after the
45402
+ * first property update. From then on it behaves like any other created context. Supported since 1.98.0
45403
+ */
45404
+ inactive?: boolean;
44891
45405
  /**
44892
45406
  * An array that specifies a set of properties or the entry
44893
45407
  */
@@ -44923,7 +45437,7 @@ declare namespace sap {
44923
45437
  oKeyProperties: object
44924
45438
  ): string;
44925
45439
  /**
44926
- * @deprecated - since 1.95.0; use {@link #resetChanges} instead
45440
+ * @deprecated (since 1.95.0) - use {@link #resetChanges} instead
44927
45441
  *
44928
45442
  * Deletes a created entry from the request queue and from the model.
44929
45443
  *
@@ -45480,11 +45994,11 @@ declare namespace sap {
45480
45994
  /**
45481
45995
  * Return the parsed XML metadata as a Javascript object.
45482
45996
  *
45483
- * Please note that the metadata is loaded asynchronously and this function might return undefined because
45997
+ * Please note that the metadata is loaded asynchronously and this function might return `undefined` because
45484
45998
  * the metadata has not been loaded yet. In this case attach to the `metadataLoaded` event to get notified
45485
45999
  * when the metadata is available and then call this function.
45486
46000
  */
45487
- getServiceMetadata(): Object;
46001
+ getServiceMetadata(): Object | undefined;
45488
46002
  /**
45489
46003
  * Checks if there exist pending changes in the model.
45490
46004
  *
@@ -45696,7 +46210,7 @@ declare namespace sap {
45696
46210
  *
45697
46211
  * Returns a new promise which can be resolved or rejected depending on the metadata loading state.
45698
46212
  */
45699
- refreshMetadata(): Promise<any>;
46213
+ refreshMetadata(): Promise<any> | undefined;
45700
46214
  /**
45701
46215
  * Refresh XSRF token by performing a GET request against the service root URL.
45702
46216
  */
@@ -45788,7 +46302,7 @@ declare namespace sap {
45788
46302
  */
45789
46303
  resetChanges(
45790
46304
  /**
45791
- * Paths to be be reset; if no array is passed, all changes are reset
46305
+ * Paths to be reset; if no array is passed, all changes are reset
45792
46306
  */
45793
46307
  aPath?: any[],
45794
46308
  /**
@@ -46201,7 +46715,11 @@ declare namespace sap {
46201
46715
  /**
46202
46716
  * Type of the filter which should be adjusted. If it is not given, the type `FilterType.Control` is assumed
46203
46717
  */
46204
- sFilterType: sap.ui.model.FilterType
46718
+ sFilterType: sap.ui.model.FilterType,
46719
+ /**
46720
+ * Whether to return `true` or `false`, instead of `this`, depending on whether the filtering has been done
46721
+ */
46722
+ bReturnSuccess?: boolean
46205
46723
  ): this;
46206
46724
  /**
46207
46725
  * Returns the number of child nodes. This function is not available when the annotation "hierarchy-node-descendant-count-for"
@@ -46312,16 +46830,25 @@ declare namespace sap {
46312
46830
  * annotation specification, or when providing the annotation information locally as a binding parameter.
46313
46831
  * For more information, see {@link sap.ui.model.odata.v2.ODataModel#bindTree}.
46314
46832
  */
46315
- setRootLevel(iRootLevel: int): void;
46833
+ setRootLevel(
46834
+ /**
46835
+ * The new `rootLevel`
46836
+ */
46837
+ iRootLevel: int
46838
+ ): void;
46316
46839
  /**
46317
- * Sorts the Tree according to the given Sorter(s). In OperationMode.Client or OperationMode.Auto (if the
46318
- * given threshold is satisfied), the sorters are applied locally on the client.
46840
+ * Sorts the Tree according to the given Sorter(s). In `OperationMode.Client` or `OperationMode.Auto` (if
46841
+ * the given threshold is satisfied), the sorters are applied locally on the client.
46319
46842
  */
46320
46843
  sort(
46321
46844
  /**
46322
- * the Sorter or an Array of sap.ui.model.Sorter instances
46845
+ * The Sorter or an Array of sap.ui.model.Sorter instances
46846
+ */
46847
+ aSorters: sap.ui.model.Sorter[] | sap.ui.model.Sorter,
46848
+ /**
46849
+ * Whether to return `true` or `false`, instead of `this`, depending on whether the sorting has been done
46323
46850
  */
46324
- aSorters: sap.ui.model.Sorter[] | sap.ui.model.Sorter
46851
+ bReturnSuccess?: boolean
46325
46852
  ): this;
46326
46853
  }
46327
46854
  /**
@@ -46712,7 +47239,7 @@ declare namespace sap {
46712
47239
  */
46713
47240
  context: sap.ui.model.Context;
46714
47241
  }
46715
- ): string | Promise<any>;
47242
+ ): string | Promise<any> | undefined;
46716
47243
  /**
46717
47244
  * @SINCE 1.63.0
46718
47245
  *
@@ -47043,8 +47570,17 @@ declare namespace sap {
47043
47570
  * The group ID to be used for the DELETE request; if not specified, the update group ID for the context's
47044
47571
  * binding is used, see {@link #getUpdateGroupId}; the resulting group ID must not have {@link sap.ui.model.odata.v4.SubmitMode.API}.
47045
47572
  * Since 1.81, if this context is transient (see {@link #isTransient}), no group ID needs to be specified.
47573
+ * Since 1.98.0, you can use `null` to prevent the DELETE request in case of a kept-alive context that is
47574
+ * not in the collection and of which you know that it does not exist on the server anymore (for example,
47575
+ * a draft after activation).
47046
47576
  */
47047
- sGroupId?: string
47577
+ sGroupId?: string,
47578
+ /**
47579
+ * Whether not to request the new count from the server; useful in case of {@link #replaceWith} where it
47580
+ * is known that the count remains unchanged (since 1.97.0). Since 1.98.0, this is implied if a `null` group
47581
+ * ID is used.
47582
+ */
47583
+ bDoNotRequestCount?: boolean
47048
47584
  ): Promise<any>;
47049
47585
  /**
47050
47586
  * @SINCE 1.41.0
@@ -47164,6 +47700,16 @@ declare namespace sap {
47164
47700
  * #expand
47165
47701
  */
47166
47702
  isExpanded(): boolean | undefined;
47703
+ /**
47704
+ * @SINCE 1.98.0
47705
+ *
47706
+ * Returns whether this context is inactive. The result of this function can also be accessed via instance
47707
+ * annotation "@$ui5.context.isInactive" at the entity.
47708
+ * See:
47709
+ * sap.ui.model.odata.v4.ODataListBinding#create
47710
+ * sap.ui.model.odata.v4.ODataListBinding#event:createActivate
47711
+ */
47712
+ isInactive(): boolean;
47167
47713
  /**
47168
47714
  * @SINCE 1.81.0
47169
47715
  *
@@ -47205,6 +47751,19 @@ declare namespace sap {
47205
47751
  */
47206
47752
  bAllowRemoval?: boolean
47207
47753
  ): void;
47754
+ /**
47755
+ * @SINCE 1.97.0
47756
+ *
47757
+ * Replaces this context with the given other context "in situ", that is, at the index it currently has
47758
+ * in its list binding's collection. You probably want to delete this context afterwards without requesting
47759
+ * the new count from the server, see the `bDoNotRequestCount` parameter of {@link #delete}.
47760
+ */
47761
+ replaceWith(
47762
+ /**
47763
+ * The other context
47764
+ */
47765
+ oOtherContext: sap.ui.model.odata.v4.Context
47766
+ ): void;
47208
47767
  /**
47209
47768
  * @SINCE 1.39.0
47210
47769
  *
@@ -47344,6 +47903,12 @@ declare namespace sap {
47344
47903
  * Sets this context's `keepAlive` attribute. If `true` the context is kept alive even when it is removed
47345
47904
  * from its binding's collection, for example if a filter is applied and the entity represented by this
47346
47905
  * context does not match the filter criteria.
47906
+ *
47907
+ * Normally, a context's lifecycle is managed implicitly. It is created once it is needed and destroyed
47908
+ * if it is not needed anymore, for example, because it is no longer part of its list binding's collection.
47909
+ * It is thus unsafe to keep a reference to a context instance which is not explicitly kept alive. Once
47910
+ * a context is not kept alive anymore, the implicit lifecycle management again takes control and destroys
47911
+ * the context if it is no longer needed.
47347
47912
  * See:
47348
47913
  * #isKeepAlive
47349
47914
  */
@@ -47530,10 +48095,10 @@ declare namespace sap {
47530
48095
  *
47531
48096
  * Changes this binding's parameters and refreshes the binding.
47532
48097
  *
47533
- * If there are pending changes an error is thrown. Use {@link #hasPendingChanges} to check if there are
47534
- * pending changes. If there are changes, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit
47535
- * the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before calling
47536
- * {@link #changeParameters}.
48098
+ * If there are pending changes that cannot be ignored, an error is thrown. Use {@link #hasPendingChanges}
48099
+ * to check if there are such pending changes. If there are, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
48100
+ * to submit the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before
48101
+ * calling {@link #changeParameters}.
47537
48102
  *
47538
48103
  * The parameters are changed according to the given map of parameters: Parameters with an `undefined` value
47539
48104
  * are removed, the other parameters are set, and missing parameters remain unchanged.
@@ -47592,6 +48157,12 @@ declare namespace sap {
47592
48157
  * The value of this binding is the result of the operation. To access a result of primitive type, bind
47593
48158
  * a control to the path "value", for example `<Text text="{value}"/>`. If the result has a complex or
47594
48159
  * entity type, you can bind properties as usual, for example `<Text text="{street}"/>`.
48160
+ *
48161
+ * Since 1.98.0, a single-valued navigation property can be treated like a function if
48162
+ * it has the same type as the operation binding's parent context, that parent context is in the
48163
+ * collection (has an index, see {@link sap.ui.model.odata.v4.Context#getIndex}) of a list binding for a
48164
+ * top-level entity set, there is a navigation property binding which points to that same entity set,
48165
+ * no operation parameters have been set, the `bReplaceWithRVC` parameter is used.
47595
48166
  */
47596
48167
  execute(
47597
48168
  /**
@@ -47614,7 +48185,19 @@ declare namespace sap {
47614
48185
  * the bound action should either be repeated **without** applying the preference or rejected with an `Error`
47615
48186
  * instance `oError` where `oError.canceled === true`. Since 1.92.0.
47616
48187
  */
47617
- fnOnStrictHandlingFailed?: Function
48188
+ fnOnStrictHandlingFailed?: Function,
48189
+ /**
48190
+ * Whether this operation binding's parent context, which must belong to a list binding, is replaced with
48191
+ * the operation's return value context (see below) and that list context is returned instead. The list
48192
+ * context may be a newly created context or an existing context. A newly created context has the same `keepAlive`
48193
+ * attribute and `fnOnBeforeDestroy` function as the parent context, see {@link sap.ui.model.odata.v4.Context#setKeepAlive};
48194
+ * `fnOnBeforeDestroy` will be called with the new context instance as the only argument in this case. An
48195
+ * existing context does not change its `keepAlive` attribute. In any case, the resulting context takes
48196
+ * the place (index, position) of the parent context {@link sap.ui.model.odata.v4.Context#getIndex}. If
48197
+ * the parent context has requested messages when it was kept alive, they will be inherited if the $$inheritExpandSelect
48198
+ * binding parameter is set to `true`. Since 1.97.0.
48199
+ */
48200
+ bReplaceWithRVC?: boolean
47618
48201
  ): Promise<any>;
47619
48202
  /**
47620
48203
  * @SINCE 1.39.0
@@ -47647,7 +48230,8 @@ declare namespace sap {
47647
48230
  getRootBinding():
47648
48231
  | sap.ui.model.odata.v4.ODataContextBinding
47649
48232
  | sap.ui.model.odata.v4.ODataListBinding
47650
- | sap.ui.model.odata.v4.ODataPropertyBinding;
48233
+ | sap.ui.model.odata.v4.ODataPropertyBinding
48234
+ | undefined;
47651
48235
  /**
47652
48236
  * @SINCE 1.81.0
47653
48237
  *
@@ -47670,7 +48254,15 @@ declare namespace sap {
47670
48254
  * returns `true` if there are pending changes for the current parent context path of this binding. If this
47671
48255
  * binding is unresolved (see {@link sap.ui.model.Binding#isResolved}), it returns `false`.
47672
48256
  */
47673
- hasPendingChanges(): boolean;
48257
+ hasPendingChanges(
48258
+ /**
48259
+ * Whether to ignore changes which will not be lost by APIs like {@link sap.ui.model.odata.v4.ODataListBinding#changeParameters
48260
+ * changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#sort
48261
+ * sort}, or {@link sap.ui.model.odata.v4.ODataListBinding#suspend suspend} because they relate to a {@link
48262
+ * sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context of this binding.
48263
+ */
48264
+ bIgnoreKeptAlive?: boolean
48265
+ ): boolean;
47674
48266
  /**
47675
48267
  * @SINCE 1.37.0
47676
48268
  *
@@ -47688,6 +48280,7 @@ declare namespace sap {
47688
48280
  isInitial(): boolean;
47689
48281
  /**
47690
48282
  * @SINCE 1.95.0
48283
+ * @deprecated (since 1.96.5)
47691
48284
  * @EXPERIMENTAL
47692
48285
  *
47693
48286
  * Moves the bound entity into the given list binding. This binding loses its data. The method may only
@@ -47804,7 +48397,8 @@ declare namespace sap {
47804
48397
  *
47805
48398
  * Suspends this binding. A suspended binding does not fire change events nor does it trigger data service
47806
48399
  * requests. Call {@link #resume} to resume the binding. Before 1.53.0, this method was not supported and
47807
- * threw an error.
48400
+ * threw an error. Since 1.97.0, pending changes are ignored if they relate to a {@link sap.ui.model.odata.v4.Context#setKeepAlive
48401
+ * kept-alive} context of this binding.
47808
48402
  * See:
47809
48403
  * {@link topic:b0f5c531e5034a27952cc748954cbe39 Suspend and Resume}
47810
48404
  * sap.ui.model.Binding#suspend
@@ -47825,8 +48419,9 @@ declare namespace sap {
47825
48419
  * @SINCE 1.37.0
47826
48420
  *
47827
48421
  * List binding for an OData V4 model. An event handler can only be attached to this binding for the following
47828
- * events: 'AggregatedDataStateChange', 'change', 'createCompleted', 'createSent', 'dataReceived', 'dataRequested',
47829
- * 'DataStateChange', 'patchCompleted', 'patchSent', and 'refresh'. For other events, an error is thrown.
48422
+ * events: 'AggregatedDataStateChange', 'change', 'createActivate', 'createCompleted', 'createSent', 'dataReceived',
48423
+ * 'dataRequested', 'DataStateChange', 'patchCompleted', 'patchSent', and 'refresh'. For other events, an
48424
+ * error is thrown.
47830
48425
  */
47831
48426
  class ODataListBinding extends sap.ui.model.ListBinding {
47832
48427
  constructor();
@@ -47859,6 +48454,21 @@ declare namespace sap {
47859
48454
  * Returns a metadata object for class sap.ui.model.odata.v4.ODataListBinding.
47860
48455
  */
47861
48456
  static getMetadata(): sap.ui.base.Metadata;
48457
+ /**
48458
+ * @SINCE 1.98.0
48459
+ *
48460
+ * Attach event handler `fnFunction` to the 'createActivate' event of this binding.
48461
+ */
48462
+ attachCreateActivate(
48463
+ /**
48464
+ * The function to call when the event occurs
48465
+ */
48466
+ fnFunction: Function,
48467
+ /**
48468
+ * Object on which to call the given function
48469
+ */
48470
+ oListener?: object
48471
+ ): void;
47862
48472
  /**
47863
48473
  * @SINCE 1.66.0
47864
48474
  *
@@ -47943,10 +48553,10 @@ declare namespace sap {
47943
48553
  *
47944
48554
  * Changes this binding's parameters and refreshes the binding.
47945
48555
  *
47946
- * If there are pending changes an error is thrown. Use {@link #hasPendingChanges} to check if there are
47947
- * pending changes. If there are changes, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit
47948
- * the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before calling
47949
- * {@link #changeParameters}.
48556
+ * If there are pending changes that cannot be ignored, an error is thrown. Use {@link #hasPendingChanges}
48557
+ * to check if there are such pending changes. If there are, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
48558
+ * to submit the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before
48559
+ * calling {@link #changeParameters}.
47950
48560
  *
47951
48561
  * The parameters are changed according to the given map of parameters: Parameters with an `undefined` value
47952
48562
  * are removed, the other parameters are set, and missing parameters remain unchanged.
@@ -48016,7 +48626,13 @@ declare namespace sap {
48016
48626
  * Whether the entity is inserted at the end of the list. When creating multiple entities, this parameter
48017
48627
  * must have the same value for each entity. Supported since 1.66.0
48018
48628
  */
48019
- bAtEnd?: boolean
48629
+ bAtEnd?: boolean,
48630
+ /**
48631
+ * Create an inactive context. Such a context will only be sent to the server after the first property update.
48632
+ * From then on it behaves like any other created context. This parameter is experimental and its implementation
48633
+ * may still change. Do not use it in productive code yet. Supported since 1.97.0
48634
+ */
48635
+ bInactive?: boolean
48020
48636
  ): sap.ui.model.odata.v4.Context;
48021
48637
  /**
48022
48638
  * @SINCE 1.40.1
@@ -48026,6 +48642,21 @@ declare namespace sap {
48026
48642
  * sap.ui.model.Binding#destroy
48027
48643
  */
48028
48644
  destroy(): void;
48645
+ /**
48646
+ * @SINCE 1.98.0
48647
+ *
48648
+ * Detach event handler `fnFunction` from the 'createActivate' event of this binding.
48649
+ */
48650
+ detachCreateActivate(
48651
+ /**
48652
+ * The function to call when the event occurs
48653
+ */
48654
+ fnFunction: Function,
48655
+ /**
48656
+ * Object on which to call the given function
48657
+ */
48658
+ oListener?: object
48659
+ ): void;
48029
48660
  /**
48030
48661
  * @SINCE 1.66.0
48031
48662
  *
@@ -48089,12 +48720,13 @@ declare namespace sap {
48089
48720
  /**
48090
48721
  * @SINCE 1.39.0
48091
48722
  *
48092
- * Filters the list with the given filters.
48723
+ * Filters the list with the given filters. Since 1.97.0, if filters are unchanged, no request is sent,
48724
+ * regardless of pending changes.
48093
48725
  *
48094
- * If there are pending changes an error is thrown. Use {@link #hasPendingChanges} to check if there are
48095
- * pending changes. If there are changes, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit
48096
- * the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before calling
48097
- * {@link #filter}.
48726
+ * If there are pending changes that cannot be ignored, an error is thrown. Use {@link #hasPendingChanges}
48727
+ * to check if there are such pending changes. If there are, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
48728
+ * to submit the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before
48729
+ * calling {@link #filter}.
48098
48730
  *
48099
48731
  * Filters are case sensitive unless the property `caseSensitive` is set to `false`. This property has to
48100
48732
  * be set on each filter, it is not inherited from a multi-filter.
@@ -48129,6 +48761,17 @@ declare namespace sap {
48129
48761
  */
48130
48762
  sFilterType?: sap.ui.model.FilterType
48131
48763
  ): this;
48764
+ /**
48765
+ * @SINCE 1.98.0
48766
+ *
48767
+ * Returns all current contexts of this list binding in no special order. Just like {@link #getCurrentContexts},
48768
+ * this method does not request any data from a back end and does not change the binding's state. In contrast
48769
+ * to {@link #getCurrentContexts}, it does not only return those contexts that were last requested by a
48770
+ * control, but all contexts that are currently available in the binding, including kept-alive contexts.
48771
+ * To filter out kept-alive contexts that are not part of the list, you could check whether the index is
48772
+ * `undefined`, as described in {@link sap.ui.model.odata.v4.Context#getIndex}.
48773
+ */
48774
+ getAllCurrentContexts(): sap.ui.model.odata.v4.Context[];
48132
48775
  /**
48133
48776
  * @SINCE 1.37.0
48134
48777
  *
@@ -48264,7 +48907,8 @@ declare namespace sap {
48264
48907
  getRootBinding():
48265
48908
  | sap.ui.model.odata.v4.ODataContextBinding
48266
48909
  | sap.ui.model.odata.v4.ODataListBinding
48267
- | sap.ui.model.odata.v4.ODataPropertyBinding;
48910
+ | sap.ui.model.odata.v4.ODataPropertyBinding
48911
+ | undefined;
48268
48912
  /**
48269
48913
  * @SINCE 1.81.0
48270
48914
  *
@@ -48287,7 +48931,15 @@ declare namespace sap {
48287
48931
  * returns `true` if there are pending changes for the current parent context path of this binding. If this
48288
48932
  * binding is unresolved (see {@link sap.ui.model.Binding#isResolved}), it returns `false`.
48289
48933
  */
48290
- hasPendingChanges(): boolean;
48934
+ hasPendingChanges(
48935
+ /**
48936
+ * Whether to ignore changes which will not be lost by APIs like {@link sap.ui.model.odata.v4.ODataListBinding#changeParameters
48937
+ * changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#sort
48938
+ * sort}, or {@link sap.ui.model.odata.v4.ODataListBinding#suspend suspend} because they relate to a {@link
48939
+ * sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context of this binding.
48940
+ */
48941
+ bIgnoreKeptAlive?: boolean
48942
+ ): boolean;
48291
48943
  /**
48292
48944
  * @SINCE 1.37.0
48293
48945
  *
@@ -48509,12 +49161,13 @@ declare namespace sap {
48509
49161
  * @SINCE 1.39.0
48510
49162
  *
48511
49163
  * Sort the entries represented by this list binding according to the given sorters. The sorters are stored
48512
- * at this list binding and they are used for each following data request.
49164
+ * at this list binding and they are used for each following data request. Since 1.97.0, if sorters are
49165
+ * unchanged, no request is sent, regardless of pending changes.
48513
49166
  *
48514
- * If there are pending changes an error is thrown. Use {@link #hasPendingChanges} to check if there are
48515
- * pending changes. If there are changes, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit
48516
- * the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before calling
48517
- * {@link #sort}.
49167
+ * If there are pending changes that cannot be ignored, an error is thrown. Use {@link #hasPendingChanges}
49168
+ * to check if there are such pending changes. If there are, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
49169
+ * to submit the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before
49170
+ * calling {@link #sort}.
48518
49171
  * See:
48519
49172
  * sap.ui.model.ListBinding#sort
48520
49173
  */
@@ -48531,7 +49184,8 @@ declare namespace sap {
48531
49184
  *
48532
49185
  * Suspends this binding. A suspended binding does not fire change events nor does it trigger data service
48533
49186
  * requests. Call {@link #resume} to resume the binding. Before 1.53.0, this method was not supported and
48534
- * threw an error.
49187
+ * threw an error. Since 1.97.0, pending changes are ignored if they relate to a {@link sap.ui.model.odata.v4.Context#setKeepAlive
49188
+ * kept-alive} context of this binding.
48535
49189
  * See:
48536
49190
  * {@link topic:b0f5c531e5034a27952cc748954cbe39 Suspend and Resume}
48537
49191
  * sap.ui.model.Binding#suspend
@@ -48609,7 +49263,7 @@ declare namespace sap {
48609
49263
  */
48610
49264
  as?: string;
48611
49265
  }>
48612
- ): object;
49266
+ ): object | undefined;
48613
49267
  }
48614
49268
  /**
48615
49269
  * @SINCE 1.37.0
@@ -48777,7 +49431,7 @@ declare namespace sap {
48777
49431
  * See:
48778
49432
  * #requestData
48779
49433
  */
48780
- getData(): object;
49434
+ getData(): object | undefined;
48781
49435
  /**
48782
49436
  * @SINCE 1.51.0
48783
49437
  *
@@ -50034,7 +50688,8 @@ declare namespace sap {
50034
50688
  getRootBinding():
50035
50689
  | sap.ui.model.odata.v4.ODataContextBinding
50036
50690
  | sap.ui.model.odata.v4.ODataListBinding
50037
- | sap.ui.model.odata.v4.ODataPropertyBinding;
50691
+ | sap.ui.model.odata.v4.ODataPropertyBinding
50692
+ | undefined;
50038
50693
  /**
50039
50694
  * @SINCE 1.81.0
50040
50695
  *
@@ -50071,7 +50726,15 @@ declare namespace sap {
50071
50726
  * returns `true` if there are pending changes for the current parent context path of this binding. If this
50072
50727
  * binding is unresolved (see {@link sap.ui.model.Binding#isResolved}), it returns `false`.
50073
50728
  */
50074
- hasPendingChanges(): boolean;
50729
+ hasPendingChanges(
50730
+ /**
50731
+ * Whether to ignore changes which will not be lost by APIs like {@link sap.ui.model.odata.v4.ODataListBinding#changeParameters
50732
+ * changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#sort
50733
+ * sort}, or {@link sap.ui.model.odata.v4.ODataListBinding#suspend suspend} because they relate to a {@link
50734
+ * sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context of this binding.
50735
+ */
50736
+ bIgnoreKeptAlive?: boolean
50737
+ ): boolean;
50075
50738
  /**
50076
50739
  * @SINCE 1.37.0
50077
50740
  *
@@ -50289,7 +50952,7 @@ declare namespace sap {
50289
50952
  * views, e.g. `<template:with path="meta>Value" helper="sap.ui.model.odata.AnnotationHelper.resolvePath"
50290
50953
  * var="target">`.
50291
50954
  *
50292
- * Since 1.31.0, you DO NOT need to {@link jQuery.sap.require} this module before use.
50955
+ * Since 1.31.0, you DO NOT need to {@link sap.ui.require} this module before use.
50293
50956
  */
50294
50957
  interface AnnotationHelper {
50295
50958
  /**
@@ -50323,7 +50986,7 @@ declare namespace sap {
50323
50986
  * ```javascript
50324
50987
  *
50325
50988
  * function myRootFormatter(oValue1, oValue2, sFullName, sGreeting, iAnswer) {
50326
- * return ...; //TODO compute something useful from the given values
50989
+ * return ...;
50327
50990
  * }
50328
50991
  *
50329
50992
  * oSupplierContext = oMetaModel.getMetaContext("/ProductSet('HT-1021')/ToSupplier");
@@ -51124,7 +51787,7 @@ declare namespace sap {
51124
51787
  /**
51125
51788
  * Filters the list.
51126
51789
  *
51127
- * When using sap.ui.model.Filter the filters are first grouped according to their binding path. All filters
51790
+ * When using `sap.ui.model.Filter` the filters are first grouped according to their binding path. All filters
51128
51791
  * belonging to a group are combined with OR and after that the results of all groups are combined with
51129
51792
  * AND. Usually this means, all filters applied to a single table column are combined with OR, while filters
51130
51793
  * on different table columns are combined with AND. Please note that a custom filter function is not supported.
@@ -51137,21 +51800,28 @@ declare namespace sap {
51137
51800
  /**
51138
51801
  * Type of the filter which should be adjusted, if it is not given, the standard behaviour applies
51139
51802
  */
51140
- sFilterType: sap.ui.model.FilterType
51803
+ sFilterType: sap.ui.model.FilterType,
51804
+ /**
51805
+ * Whether to return `true` or `false`, instead of `this`, depending on whether the filtering has been done
51806
+ */
51807
+ bReturnSuccess?: boolean
51141
51808
  ): this;
51142
51809
  /**
51143
51810
  * Return contexts for the list
51144
51811
  */
51145
51812
  getContexts(
51146
51813
  /**
51147
- * the start index of the requested contexts
51814
+ * The start index of the requested contexts
51148
51815
  */
51149
51816
  iStartIndex?: int,
51150
51817
  /**
51151
- * the requested amount of contexts
51818
+ * The requested amount of contexts
51152
51819
  */
51153
51820
  iLength?: int,
51154
-
51821
+ /**
51822
+ * The maximum number of contexts to read before and after the given range; with this, controls can prefetch
51823
+ * data that is likely to be needed soon, e.g. when scrolling down in a table
51824
+ */
51155
51825
  iThreshold?: int
51156
51826
  ): sap.ui.model.Context[];
51157
51827
  /**
@@ -51180,16 +51850,28 @@ declare namespace sap {
51180
51850
  /**
51181
51851
  * Update the bound control even if no data has been changed
51182
51852
  */
51183
- bForceUpdate?: boolean
51853
+ bForceUpdate?: boolean,
51854
+ /**
51855
+ * A map of changed entities
51856
+ */
51857
+ mChangedEntities?: object,
51858
+ /**
51859
+ * A map of entity types
51860
+ */
51861
+ mEntityTypes?: object
51184
51862
  ): void;
51185
51863
  /**
51186
51864
  * Sorts the list.
51187
51865
  */
51188
51866
  sort(
51189
51867
  /**
51190
- * the Sorter or an array of sorter objects object which define the sort order
51868
+ * The Sorter or an array of sorter objects which define the sort order
51869
+ */
51870
+ aSorters: sap.ui.model.Sorter | sap.ui.model.Sorter[],
51871
+ /**
51872
+ * Whether to return `true` or `false`, instead of `this`, depending on whether the sorting has been done
51191
51873
  */
51192
- aSorters: sap.ui.model.Sorter | any[]
51874
+ bReturnSuccess?: boolean
51193
51875
  ): this;
51194
51876
  }
51195
51877
  /**
@@ -52035,19 +52717,18 @@ declare namespace sap {
52035
52717
  bSuppressEvents?: boolean
52036
52718
  ): Promise<any>;
52037
52719
  /**
52038
- * Appends the change batch operations to the end of the batch stack. Only PUT, POST or DELETE batch operations
52039
- * should be included in the specified array. The operations in the array will be included in a single changeset.
52040
- * To embed change operations in different change sets call this method with the corresponding change operations
52041
- * again. If an illegal batch operation is added to the change set nothing will be performed and false will
52042
- * be returned.
52720
+ * Appends the change batch operations to the end of the batch stack. Only `PUTPOST` or `DELETE`
52721
+ * batch operations should be included in the specified array. The operations in the array will be included
52722
+ * in a single changeset. To embed change operations in different change sets call this method with the
52723
+ * corresponding change operations again. If an illegal batch operation is added to the change set nothing
52724
+ * will be performed and false will be returned.
52043
52725
  */
52044
52726
  addBatchChangeOperations(
52045
52727
  /**
52046
- * an array of change batch operations created via `createBatchOperation` and `sMethod` = POST, PUT, MERGE
52047
- * or DELETE
52728
+ * An array of change batch operations created via `createBatchOperation` with parameter `sMethod = "POST"/"PUT"/"MERGE"/"DELETE"`
52048
52729
  */
52049
52730
  aChangeOperations: any[]
52050
- ): void;
52731
+ ): false | undefined;
52051
52732
  /**
52052
52733
  * Appends the read batch operations to the end of the batch stack. Only GET batch operations should be
52053
52734
  * included in the specified array. If an illegal batch operation is added to the batch nothing will be
@@ -52055,10 +52736,10 @@ declare namespace sap {
52055
52736
  */
52056
52737
  addBatchReadOperations(
52057
52738
  /**
52058
- * an array of read batch operations created via `createBatchOperation` and `sMethod` = GET
52739
+ * An array of read batch operations created via `createBatchOperation` with `sMethod = "GET"`
52059
52740
  */
52060
52741
  aReadOperations: any[]
52061
- ): void;
52742
+ ): false | undefined;
52062
52743
  /**
52063
52744
  * Attaches event handler `fnFunction` to the {@link #event:annotationsFailed annotationsFailed} event of
52064
52745
  * this `sap.ui.model.odata.ODataModel`.
@@ -52334,29 +53015,29 @@ declare namespace sap {
52334
53015
  */
52335
53016
  createBatchOperation(
52336
53017
  /**
52337
- * A string containing the path to the collection or entry where the batch operation should be performed.
52338
- * The path is concatenated to the sServiceUrl which was specified in the model constructor.
53018
+ * A string containing the path to the collection or entry where the batch operation should be performed;
53019
+ * the path is concatenated to the `sServiceUrl` which was specified in the model constructor
52339
53020
  */
52340
53021
  sPath: string,
52341
53022
  /**
52342
- * for the batch operation. Possible values are GET, PUT, MERGE, POST, DELETE
53023
+ * For the batch operation; possible values are `GET`, `PUT`, `MERGE`, `POST` or `DELETE`
52343
53024
  */
52344
53025
  sMethod: string,
52345
53026
  /**
52346
- * optional data payload which should be created, updated, deleted in a change batch operation.
53027
+ * Optional data payload which should be created, updated, deleted in a change batch operation
52347
53028
  */
52348
53029
  oData?: object,
52349
53030
  /**
52350
- * optional parameter for additional information introduced in SAPUI5 1.9.1,
53031
+ * Optional parameter for additional information introduced in SAPUI5 1.9.1
52351
53032
  */
52352
53033
  oParameters?: {
52353
53034
  /**
52354
- * an ETag which can be used for concurrency control. If it is specified, it will be used in an If-Match-Header
53035
+ * An ETag which can be used for concurrency control. If it is specified, it will be used in an If-Match-Header
52355
53036
  * in the request to the server for this entry.
52356
53037
  */
52357
53038
  sETag?: string;
52358
53039
  }
52359
- ): void;
53040
+ ): object;
52360
53041
  /**
52361
53042
  * Creates a new entry object which is described by the metadata of the entity type of the specified sPath
52362
53043
  * Name. A context object is returned which can be used to bind against the newly created object.
@@ -52387,7 +53068,7 @@ declare namespace sap {
52387
53068
  vProperties: any[] | object
52388
53069
  ): sap.ui.model.Context;
52389
53070
  /**
52390
- * Creates the key from the given collection name and property map
53071
+ * Creates the key from the given collection name and property map.
52391
53072
  */
52392
53073
  createKey(
52393
53074
  /**
@@ -52397,12 +53078,12 @@ declare namespace sap {
52397
53078
  /**
52398
53079
  * The object containing at least all the key properties of the entity type
52399
53080
  */
52400
- oKeyParameters: object,
53081
+ oKeyProperties: object,
52401
53082
  /**
52402
53083
  * Whether the URI decoding should be applied on the key
52403
53084
  */
52404
53085
  bDecode: boolean
52405
- ): void;
53086
+ ): string;
52406
53087
  /**
52407
53088
  * Deletes a created entry from the request queue and the model.
52408
53089
  */
@@ -52578,19 +53259,19 @@ declare namespace sap {
52578
53259
  */
52579
53260
  getData(
52580
53261
  /**
52581
- * A string containing the path to the data object that should be returned.
53262
+ * A string containing the path to the data object that should be returned
52582
53263
  */
52583
53264
  sPath: string,
52584
53265
  /**
52585
- * the optional context which is used with the sPath to retrieve the requested data.
53266
+ * The optional context which is used with the sPath to retrieve the requested data
52586
53267
  */
52587
53268
  oContext?: object,
52588
53269
  /**
52589
- * This parameter should be set when a URI or custom parameter with a $expand System Query Option was used
52590
- * to retrieve associated entries embedded/inline. If true then the getProperty function returns a desired
52591
- * property value/entry and includes the associated expand entries (if any). If false the associated/expanded
52592
- * entry properties are removed and not included in the desired entry as properties at all. This is useful
52593
- * for performing updates on the base entry only. Note: A copy and not a reference of the entry will be
53270
+ * This parameter should be set when a URI or custom parameter with a `$expand` System Query Option was
53271
+ * used to retrieve associated entries embedded/inline; if true then the `getProperty` function returns
53272
+ * a desired property value/entry and includes the associated expand entries (if any); if false the associated/expanded
53273
+ * entry properties are removed and not included in the desired entry as properties at all; this is useful
53274
+ * for performing updates on the base entry only; note: A copy and not a reference of the entry will be
52594
53275
  * returned.
52595
53276
  */
52596
53277
  bIncludeExpandEntries?: boolean
@@ -52598,7 +53279,7 @@ declare namespace sap {
52598
53279
  /**
52599
53280
  * @SINCE 1.20
52600
53281
  *
52601
- * Returns the default count mode for retrieving the count of collections
53282
+ * Returns the default count mode for retrieving the count of collections.
52602
53283
  */
52603
53284
  getDefaultCountMode(): sap.ui.model.odata.CountMode;
52604
53285
  /**
@@ -52606,7 +53287,7 @@ declare namespace sap {
52606
53287
  */
52607
53288
  getHeaders(): object;
52608
53289
  /**
52609
- * Returns the key part from the entry URI or the given context or object
53290
+ * Returns the key part from the entry URI or the given context or object.
52610
53291
  */
52611
53292
  getKey(
52612
53293
  /**
@@ -52617,7 +53298,7 @@ declare namespace sap {
52617
53298
  * Whether the URI decoding should be applied on the key
52618
53299
  */
52619
53300
  bDecode: boolean
52620
- ): void;
53301
+ ): string;
52621
53302
  /**
52622
53303
  * Returns an instance of an OData meta model which offers a unified access to both OData V2 metadata and
52623
53304
  * V4 annotations. It uses the existing {@link sap.ui.model.odata.ODataMetadata} as a foundation and merges
@@ -52630,47 +53311,47 @@ declare namespace sap {
52630
53311
  getMetaModel(): sap.ui.model.odata.ODataMetaModel;
52631
53312
  /**
52632
53313
  * Returns the value for the property with the given `sPath`. If the path points to a navigation property
52633
- * which has been loaded via $expand then the `bIncludeExpandEntries` parameter determines if the navigation
53314
+ * which has been loaded via `$expand` then the `bIncludeExpandEntries` parameter determines if the navigation
52634
53315
  * property should be included in the returned value or not. Please note that this currently works for 1..1
52635
53316
  * navigation properties only.
52636
53317
  */
52637
53318
  getProperty(
52638
53319
  /**
52639
- * the path/name of the property
53320
+ * The path/name of the property
52640
53321
  */
52641
53322
  sPath: string,
52642
53323
  /**
52643
- * the context if available to access the property value
53324
+ * The context if available to access the property value
52644
53325
  */
52645
53326
  oContext?: object,
52646
53327
  /**
52647
- * This parameter should be set when a URI or custom parameter with a $expand System Query Option was used
52648
- * to retrieve associated entries embedded/inline. If true then the getProperty function returns a desired
52649
- * property value/entry and includes the associated expand entries (if any). If false the associated/expanded
53328
+ * This parameter should be set when a URI or custom parameter with a `$expand` System Query Option was
53329
+ * used to retrieve associated entries embedded/inline. If true then the getProperty function returns a
53330
+ * desired property value/entry and includes the associated expand entries (if any). If false the associated/expanded
52650
53331
  * entry properties are removed and not included in the desired entry as properties at all. This is useful
52651
53332
  * for performing updates on the base entry only. Note: A copy and not a reference of the entry will be
52652
53333
  * returned.
52653
53334
  */
52654
53335
  bIncludeExpandEntries?: boolean
52655
- ): any;
53336
+ ): object;
52656
53337
  /**
52657
53338
  * Returns the current security token. If the token has not been requested from the server it will be requested
52658
53339
  * first.
52659
53340
  */
52660
53341
  getSecurityToken(): string;
52661
53342
  /**
52662
- * Return the annotation object. Please note that when using the model with bLoadMetadataAsync = true then
52663
- * this function might return undefined because the metadata has not been loaded yet. In this case attach
52664
- * to the `annotationsLoaded` event to get notified when the annotations are available and then call this
52665
- * function.
53343
+ * Return the annotation object. Please note that when using the model with `bLoadMetadataAsync = true`
53344
+ * then this function might return undefined because the metadata has not been loaded yet. In this case
53345
+ * attach to the `annotationsLoaded` event to get notified when the annotations are available and then call
53346
+ * this function.
52666
53347
  */
52667
- getServiceAnnotations(): Object;
53348
+ getServiceAnnotations(): Object | undefined;
52668
53349
  /**
52669
- * Return the metadata object. Please note that when using the model with bLoadMetadataAsync = true then
52670
- * this function might return undefined because the metadata has not been loaded yet. In this case attach
52671
- * to the `metadataLoaded` event to get notified when the metadata is available and then call this function.
53350
+ * Return the metadata object. Please note that when using the model with `bLoadMetadataAsync = true` then
53351
+ * this function might return `undefinedmetadataLoaded` event to get notified when the metadata is available and then call
53352
+ * this function.
52672
53353
  */
52673
- getServiceMetadata(): Object;
53354
+ getServiceMetadata(): Object | undefined;
52674
53355
  /**
52675
53356
  * Checks if there exist pending changes in the model created by the setProperty method.
52676
53357
  */
@@ -52678,7 +53359,7 @@ declare namespace sap {
52678
53359
  /**
52679
53360
  * @deprecated (since 1.20) - please use {@link #getDefaultCountMode} instead.
52680
53361
  *
52681
- * Returns whether this model supports the $count on its collections
53362
+ * Returns whether this model supports `$count` on its collections.
52682
53363
  */
52683
53364
  isCountSupported(): boolean;
52684
53365
  /**
@@ -52831,9 +53512,14 @@ declare namespace sap {
52831
53512
  /**
52832
53513
  * @deprecated (since 1.20) - please use {@link #setDefaultCountMode} instead.
52833
53514
  *
52834
- * Sets whether this OData service supports $count on its collections.
53515
+ * Sets whether this OData service supports `$count` on its collections.
52835
53516
  */
52836
- setCountSupported(bCountSupported: boolean): void;
53517
+ setCountSupported(
53518
+ /**
53519
+ * Whether this OData service supports `$count` on its collections
53520
+ */
53521
+ bCountSupported: boolean
53522
+ ): void;
52837
53523
  /**
52838
53524
  * @SINCE 1.20
52839
53525
  *
@@ -52875,33 +53561,33 @@ declare namespace sap {
52875
53561
  ): void;
52876
53562
  /**
52877
53563
  * Sets a new value for the given property `sPropertyName` in the model without triggering a server request.
52878
- * This can be done by the submitChanges method.
53564
+ * This can be done by the `submitChanges` method.
52879
53565
  *
52880
- * Note: Only one entry of one collection can be updated at once. Otherwise a fireRejectChange event is
53566
+ * Note: Only one entry of one collection can be updated at once. Otherwise a `fireRejectChange` event is
52881
53567
  * fired.
52882
53568
  *
52883
- * Before updating a different entry the existing changes of the current entry have to be submitted or resetted
52884
- * by the corresponding methods: submitChanges, resetChanges.
53569
+ * Before updating a different entry the existing changes of the current entry have to be submitted or reset
53570
+ * by the corresponding methods: `submitChanges`, `resetChanges`.
52885
53571
  *
52886
- * IMPORTANT: All pending changes are resetted in the model if the application triggeres any kind of refresh
53572
+ * IMPORTANT: All pending changes are reset in the model if the application triggers any kind of refresh
52887
53573
  * on that entry. Make sure to submit the pending changes first. To determine if there are any pending changes
52888
- * call the hasPendingChanges method.
53574
+ * call the `hasPendingChanges` method.
52889
53575
  */
52890
53576
  setProperty(
52891
53577
  /**
52892
- * path of the property to set
53578
+ * Path of the property to set
52893
53579
  */
52894
53580
  sPath: string,
52895
53581
  /**
52896
- * value to set the property to
53582
+ * Value to set the property to
52897
53583
  */
52898
53584
  oValue: any,
52899
53585
  /**
52900
- * the context which will be used to set the property
53586
+ * The context which will be used to set the property
52901
53587
  */
52902
53588
  oContext?: object,
52903
53589
  /**
52904
- * whether to update other bindings dependent on this property asynchronously
53590
+ * Whether to update other bindings dependent on this property asynchronously
52905
53591
  */
52906
53592
  bAsyncUpdate?: boolean
52907
53593
  ): boolean;
@@ -52910,7 +53596,12 @@ declare namespace sap {
52910
53596
  *
52911
53597
  * Enable/Disable automatic updates of all Bindings after change operations
52912
53598
  */
52913
- setRefreshAfterChange(bRefreshAfterChange: boolean): void;
53599
+ setRefreshAfterChange(
53600
+ /**
53601
+ * Whether automatic updates should be enabled
53602
+ */
53603
+ bRefreshAfterChange: boolean
53604
+ ): void;
52914
53605
  /**
52915
53606
  * Enable/Disable XCSRF-Token handling
52916
53607
  */
@@ -55930,6 +56621,13 @@ declare namespace sap {
55930
56621
  */
55931
56622
  bNewState?: boolean
55932
56623
  ): boolean;
56624
+ /**
56625
+ * @SINCE 1.98.0
56626
+ *
56627
+ * Returns an array of all model and control messages of all parts of the composite binding, regardless
56628
+ * of whether they are old or new.
56629
+ */
56630
+ getAllMessages(): sap.ui.core.Message[];
55933
56631
  /**
55934
56632
  * Returns the changes of the data state in a map that the control can use in the `refreshDataState` method.
55935
56633
  * The changed property's name is the key in the map. Each element in the map contains an object of below
@@ -55952,7 +56650,7 @@ declare namespace sap {
55952
56650
  }
55953
56651
  >;
55954
56652
  /**
55955
- * Returns the array of state messages of the control.
56653
+ * Returns the array of current state messages of the control.
55956
56654
  */
55957
56655
  getControlMessages(): sap.ui.core.Message[];
55958
56656
  /**
@@ -55971,11 +56669,11 @@ declare namespace sap {
55971
56669
  */
55972
56670
  getInvalidValue(): any;
55973
56671
  /**
55974
- * Returns the array of all state messages combining the model and control messages.
56672
+ * Returns the array of all current state messages combining the model and control messages.
55975
56673
  */
55976
56674
  getMessages(): sap.ui.core.Message[];
55977
56675
  /**
55978
- * Returns the array of state messages of the model or undefined.
56676
+ * Returns the array of current state messages of the model.
55979
56677
  */
55980
56678
  getModelMessages(): sap.ui.core.Message[];
55981
56679
  /**
@@ -56344,6 +57042,12 @@ declare namespace sap {
56344
57042
  */
56345
57043
  bNewState?: boolean
56346
57044
  ): boolean;
57045
+ /**
57046
+ * @SINCE 1.98.0
57047
+ *
57048
+ * Returns an array of all model and control messages, regardless of whether they are old or new.
57049
+ */
57050
+ getAllMessages(): sap.ui.core.Message[];
56347
57051
  /**
56348
57052
  * Returns the changes of the data state in a map that the control can use in the `refreshDataState` method.
56349
57053
  * The changed property's name is the key in the map. Each element in the map contains an object with the
@@ -56352,7 +57056,7 @@ declare namespace sap {
56352
57056
  */
56353
57057
  getChanges(): object;
56354
57058
  /**
56355
- * Returns the array of state messages of the control.
57059
+ * Returns the array of this data state's current control messages.
56356
57060
  */
56357
57061
  getControlMessages(): sap.ui.core.Message[];
56358
57062
  /**
@@ -56362,12 +57066,12 @@ declare namespace sap {
56362
57066
  */
56363
57067
  getInvalidValue(): any;
56364
57068
  /**
56365
- * Returns the array of this data state's messages combining the model and control messages. The array is
56366
- * sorted descendingly by message severity.
57069
+ * Returns the array of this data state's current messages combining the model and control messages. The
57070
+ * array is sorted descendingly by message severity.
56367
57071
  */
56368
57072
  getMessages(): sap.ui.core.Message[];
56369
57073
  /**
56370
- * Returns the array of state messages of the model or undefined.
57074
+ * Returns the array of this data state's current model messages.
56371
57075
  */
56372
57076
  getModelMessages(): sap.ui.core.Message[];
56373
57077
  /**
@@ -56896,6 +57600,15 @@ declare namespace sap {
56896
57600
  */
56897
57601
  sFilterType?: sap.ui.model.FilterType
56898
57602
  ): this;
57603
+ /**
57604
+ * @SINCE 1.97.0
57605
+ *
57606
+ * Returns all current contexts of this list binding in no special order. Just like {@link #getCurrentContexts},
57607
+ * this method does not request any data from a back end and does not change the binding's state. In contrast
57608
+ * to {@link #getCurrentContexts}, it does not only return those contexts that were last requested by a
57609
+ * control, but all contexts that are currently available in the binding.
57610
+ */
57611
+ getAllCurrentContexts(): sap.ui.model.Context[];
56899
57612
  /**
56900
57613
  * Returns an array of binding contexts for the bound target list.
56901
57614
  *
@@ -56948,11 +57661,10 @@ declare namespace sap {
56948
57661
  /**
56949
57662
  * @SINCE 1.28
56950
57663
  *
56951
- * Returns an array of currently used binding contexts of the bound control.
57664
+ * Returns the contexts of this list binding as last requested by the control and in the same order the
57665
+ * control has received them.
56952
57666
  *
56953
- * This method does not trigger any data requests from the back end or a delta calculation, but just returns
56954
- * the context array as last requested by the control. This can be used by the application to get access
56955
- * to the data currently displayed by a list control.
57667
+ * This method does not request any data from a back end and does not change the binding's state.
56956
57668
  */
56957
57669
  getCurrentContexts(): sap.ui.model.Context[];
56958
57670
  /**
@@ -57415,7 +58127,7 @@ declare namespace sap {
57415
58127
  * the server
57416
58128
  */
57417
58129
  bReload?: boolean
57418
- ): sap.ui.model.Context;
58130
+ ): sap.ui.model.Context | undefined;
57419
58131
  /**
57420
58132
  * Destroys the model and clears the model data.
57421
58133
  *
@@ -57515,23 +58227,10 @@ declare namespace sap {
57515
58227
  */
57516
58228
  fireParseError(
57517
58229
  /**
57518
- * Parameters to pass along with the event
58230
+ * Parameters to pass along with the event; May contain the following parameters: `errorCode`, `url`, `reason`,
58231
+ * `srcText`, `line`, `linePos`, `filePos`
57519
58232
  */
57520
- oParameters?: {
57521
- errorCode?: int;
57522
-
57523
- url?: string;
57524
-
57525
- reason?: string;
57526
-
57527
- srcText?: string;
57528
-
57529
- line?: int;
57530
-
57531
- linepos?: int;
57532
-
57533
- filepos?: int;
57534
- }
58233
+ oParameters?: object
57535
58234
  ): this;
57536
58235
  /**
57537
58236
  * Fires event {@link #event:propertyChange propertyChange} to attached listeners.
@@ -58959,7 +59658,9 @@ declare namespace sap {
58959
59658
  * The list was refreshed
58960
59659
  */
58961
59660
  Refresh = "refresh",
58962
-
59661
+ /**
59662
+ * A context was removed from a binding.
59663
+ */
58963
59664
  Remove = "remove",
58964
59665
  /**
58965
59666
  * The list was sorted
@@ -59226,9 +59927,8 @@ declare namespace sap {
59226
59927
  *
59227
59928
  * If this flag is set to `true`, the Safari browser runs in standalone fullscreen mode on iOS.
59228
59929
  *
59229
- * **Note:** This flag is only available if the Safari browser was detected. Furthermore, if this mode is
59230
- * detected, technically not a standard Safari is used. There might be slight differences in behavior and
59231
- * detection, e.g. the availability of {@link sap.ui.Device.browser.version}.
59930
+ * **Note:** This flag is only available if the Safari browser was detected. There might be slight differences
59931
+ * in behavior and detection, e.g. regarding the availability of {@link sap.ui.Device.browser.version}.
59232
59932
  */
59233
59933
  export const fullscreen: boolean;
59234
59934
 
@@ -59289,12 +59989,13 @@ declare namespace sap {
59289
59989
 
59290
59990
  /**
59291
59991
  * @SINCE 1.31.0
59992
+ * @deprecated (since 1.98)
59292
59993
  *
59293
59994
  * If this flag is set to `true`, the Safari browser runs in webview mode on iOS.
59294
59995
  *
59295
- * **Note:** This flag is only available if the Safari browser was detected. Furthermore, if this mode is
59296
- * detected, technically not a standard Safari is used. There might be slight differences in behavior and
59297
- * detection, e.g. the availability of {@link sap.ui.Device.browser.version}.
59996
+ * **Note:** Since iOS 11 it is no longer reliably possible to detect whether an application runs in `webview`.
59997
+ * The flag is `true` if the browser's user agent contains 'SAPFioriClient'. Applications using WKWebView
59998
+ * have the possibility to customize the user agent, and to explicitly add this information.
59298
59999
  */
59299
60000
  export const webview: boolean;
59300
60001
 
@@ -59675,11 +60376,6 @@ declare namespace sap {
59675
60376
  */
59676
60377
  export const android: boolean;
59677
60378
 
59678
- /**
59679
- * If this flag is set to `true`, a Blackberry operating system is used.
59680
- */
59681
- export const blackberry: boolean;
59682
-
59683
60379
  /**
59684
60380
  * If this flag is set to `true`, an iOS operating system is used.
59685
60381
  */
@@ -59707,14 +60403,14 @@ declare namespace sap {
59707
60403
  /**
59708
60404
  * The version of the operating system as `float`.
59709
60405
  *
59710
- * Might be `-1` if no version can be determined.
60406
+ * Might be `-1` if no version can reliably be determined.
59711
60407
  */
59712
60408
  export const version: float;
59713
60409
 
59714
60410
  /**
59715
60411
  * The version of the operating system as `string`.
59716
60412
  *
59717
- * Might be empty if no version can be determined.
60413
+ * Might be empty if no version can reliably be determined.
59718
60414
  */
59719
60415
  export const versionStr: string;
59720
60416
 
@@ -59723,11 +60419,6 @@ declare namespace sap {
59723
60419
  */
59724
60420
  export const windows: boolean;
59725
60421
 
59726
- /**
59727
- * If this flag is set to `true`, a Windows Phone operating system is used.
59728
- */
59729
- export const windows_phone: boolean;
59730
-
59731
60422
  /**
59732
60423
  * Enumeration containing the names of known operating systems.
59733
60424
  */
@@ -59739,13 +60430,6 @@ declare namespace sap {
59739
60430
  */
59740
60431
  export const ANDROID: undefined;
59741
60432
 
59742
- /**
59743
- * Blackberry operating system name.
59744
- * See:
59745
- * sap.ui.Device.os.name
59746
- */
59747
- export const BLACKBERRY: undefined;
59748
-
59749
60433
  /**
59750
60434
  * iOS operating system name.
59751
60435
  * See:
@@ -59773,13 +60457,6 @@ declare namespace sap {
59773
60457
  * sap.ui.Device.os.name
59774
60458
  */
59775
60459
  export const WINDOWS: undefined;
59776
-
59777
- /**
59778
- * Windows Phone operating system name.
59779
- * See:
59780
- * sap.ui.Device.os.name
59781
- */
59782
- export const WINDOWS_PHONE: undefined;
59783
60460
  }
59784
60461
  }
59785
60462
  /**
@@ -60018,7 +60695,44 @@ declare namespace sap {
60018
60695
  | sap.ui.base.ManagedObject.PropertyBindingInfo;
60019
60696
  }
60020
60697
 
60021
- interface $PressSettings extends sap.ui.test.actions.$ActionSettings {}
60698
+ interface $PressSettings extends sap.ui.test.actions.$ActionSettings {
60699
+ /**
60700
+ * @SINCE 1.97
60701
+ *
60702
+ * If it is set to `true`, the Alt Key modifier will be used
60703
+ */
60704
+ altKey?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
60705
+
60706
+ /**
60707
+ * @SINCE 1.97
60708
+ *
60709
+ * If it is set to `true`, the Shift Key modifier will be used
60710
+ */
60711
+ shiftKey?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
60712
+
60713
+ /**
60714
+ * @SINCE 1.97
60715
+ *
60716
+ * If it is set to `true`, the Control Key modifier will be used
60717
+ */
60718
+ ctrlKey?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
60719
+
60720
+ /**
60721
+ * @SINCE 1.98
60722
+ *
60723
+ * Provide percent value for the X coordinate axis to calculate the position of the click event. The value
60724
+ * must be in the range [0 - 100]
60725
+ */
60726
+ xPercentage?: float | sap.ui.base.ManagedObject.PropertyBindingInfo;
60727
+
60728
+ /**
60729
+ * @SINCE 1.98
60730
+ *
60731
+ * Provide percent value for the Y coordinate axis to calculate the position of the click event. The value
60732
+ * must be in the range [0 - 100]
60733
+ */
60734
+ yPercentage?: float | sap.ui.base.ManagedObject.PropertyBindingInfo;
60735
+ }
60022
60736
 
60023
60737
  interface $ScrollSettings extends sap.ui.test.actions.$ActionSettings {
60024
60738
  x?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
@@ -60481,13 +61195,22 @@ declare namespace sap {
60481
61195
  * see {@link sap.ui.test.actions.Press.controlAdapters}.
60482
61196
  */
60483
61197
  class Press extends sap.ui.test.actions.Action {
61198
+ /**
61199
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
61200
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
61201
+ * of the syntax of the settings object.
61202
+ */
60484
61203
  constructor(
60485
61204
  /**
60486
61205
  * Optional object with initial settings for the new instance
60487
61206
  */
60488
61207
  mSettings?: sap.ui.test.actions.$PressSettings
60489
61208
  );
60490
-
61209
+ /**
61210
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
61211
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
61212
+ * of the syntax of the settings object.
61213
+ */
60491
61214
  constructor(
60492
61215
  /**
60493
61216
  * Optional ID for the new instance; generated automatically if no non-empty ID is given. Note: this can
@@ -60535,6 +61258,125 @@ declare namespace sap {
60535
61258
  */
60536
61259
  oControl: sap.ui.core.Control
60537
61260
  ): void;
61261
+ /**
61262
+ * @SINCE 1.97
61263
+ *
61264
+ * Gets current value of property {@link #getAltKey altKey}.
61265
+ *
61266
+ * If it is set to `true`, the Alt Key modifier will be used
61267
+ */
61268
+ getAltKey(): boolean;
61269
+ /**
61270
+ * @SINCE 1.97
61271
+ *
61272
+ * Gets current value of property {@link #getCtrlKey ctrlKey}.
61273
+ *
61274
+ * If it is set to `true`, the Control Key modifier will be used
61275
+ */
61276
+ getCtrlKey(): boolean;
61277
+ /**
61278
+ * @SINCE 1.97
61279
+ *
61280
+ * Gets current value of property {@link #getShiftKey shiftKey}.
61281
+ *
61282
+ * If it is set to `true`, the Shift Key modifier will be used
61283
+ */
61284
+ getShiftKey(): boolean;
61285
+ /**
61286
+ * @SINCE 1.98
61287
+ *
61288
+ * Gets current value of property {@link #getXPercentage xPercentage}.
61289
+ *
61290
+ * Provide percent value for the X coordinate axis to calculate the position of the click event. The value
61291
+ * must be in the range [0 - 100]
61292
+ */
61293
+ getXPercentage(): float;
61294
+ /**
61295
+ * @SINCE 1.98
61296
+ *
61297
+ * Gets current value of property {@link #getYPercentage yPercentage}.
61298
+ *
61299
+ * Provide percent value for the Y coordinate axis to calculate the position of the click event. The value
61300
+ * must be in the range [0 - 100]
61301
+ */
61302
+ getYPercentage(): float;
61303
+ /**
61304
+ * @SINCE 1.97
61305
+ *
61306
+ * Sets a new value for property {@link #getAltKey altKey}.
61307
+ *
61308
+ * If it is set to `true`, the Alt Key modifier will be used
61309
+ *
61310
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
61311
+ */
61312
+ setAltKey(
61313
+ /**
61314
+ * New value for property `altKey`
61315
+ */
61316
+ bAltKey: boolean
61317
+ ): this;
61318
+ /**
61319
+ * @SINCE 1.97
61320
+ *
61321
+ * Sets a new value for property {@link #getCtrlKey ctrlKey}.
61322
+ *
61323
+ * If it is set to `true`, the Control Key modifier will be used
61324
+ *
61325
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
61326
+ */
61327
+ setCtrlKey(
61328
+ /**
61329
+ * New value for property `ctrlKey`
61330
+ */
61331
+ bCtrlKey: boolean
61332
+ ): this;
61333
+ /**
61334
+ * @SINCE 1.97
61335
+ *
61336
+ * Sets a new value for property {@link #getShiftKey shiftKey}.
61337
+ *
61338
+ * If it is set to `true`, the Shift Key modifier will be used
61339
+ *
61340
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
61341
+ */
61342
+ setShiftKey(
61343
+ /**
61344
+ * New value for property `shiftKey`
61345
+ */
61346
+ bShiftKey: boolean
61347
+ ): this;
61348
+ /**
61349
+ * @SINCE 1.98
61350
+ *
61351
+ * Sets a new value for property {@link #getXPercentage xPercentage}.
61352
+ *
61353
+ * Provide percent value for the X coordinate axis to calculate the position of the click event. The value
61354
+ * must be in the range [0 - 100]
61355
+ *
61356
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
61357
+ */
61358
+ setXPercentage(
61359
+ /**
61360
+ * New value for property `xPercentage`
61361
+ */
61362
+ fXPercentage: float
61363
+ ): this;
61364
+ /**
61365
+ * @SINCE 1.98
61366
+ *
61367
+ * Sets a new value for property {@link #getYPercentage yPercentage}.
61368
+ *
61369
+ * Provide percent value for the Y coordinate axis to calculate the position of the click event. The value
61370
+ * must be in the range [0 - 100]
61371
+ *
61372
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
61373
+ */
61374
+ setYPercentage(
61375
+ /**
61376
+ * New value for property `yPercentage`
61377
+ */
61378
+ fYPercentage: float
61379
+ ): this;
60538
61380
  }
60539
61381
  /**
60540
61382
  * @SINCE 1.90
@@ -65072,6 +65914,8 @@ declare namespace sap {
65072
65914
 
65073
65915
  "sap/ui/core/Patcher": undefined;
65074
65916
 
65917
+ "sap/ui/core/Placeholder": undefined;
65918
+
65075
65919
  "sap/ui/core/Popup": undefined;
65076
65920
 
65077
65921
  "sap/ui/core/postmessage/Bus": undefined;