@openui5/ts-types 1.96.5 → 1.99.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.5
267
+ // For Library Version: 1.99.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
@@ -2325,9 +2395,14 @@ declare module "sap/ui/dom/includeStylesheet" {
2325
2395
  /**
2326
2396
  * @SINCE 1.58
2327
2397
  *
2328
- * Includes the specified stylesheet via a <link>-tag in the head of the current document. If there
2329
- * is call to `includeStylesheet` providing the sId of an already included stylesheet, the existing element
2330
- * will be replaced.
2398
+ * Includes the specified stylesheet via a <link>-tag in the head of the current document.
2399
+ *
2400
+ * If `includeStylesheet` is called with an `sId` of an already included stylesheet and:
2401
+ * - either `fnLoadCallback` or `fnErrorCallback` is given: the old stylesheet is deleted and a new one
2402
+ * is inserted
2403
+ * - `vUrl` is different from the existing one's: the old stylesheet is deleted and a new one is inserted
2404
+ *
2405
+ * - otherwise: no action
2331
2406
  */
2332
2407
  export default function includeStylesheet(
2333
2408
  /**
@@ -3267,6 +3342,49 @@ declare module "sap/ui/test/opaQunit" {
3267
3342
  */
3268
3343
  async?: boolean
3269
3344
  ): void;
3345
+ /**
3346
+ * QUnit test adapter for OPA: add a test to be executed by QUnit Has the same signature as QUnit.test (QUnit
3347
+ * version is also considered) Suggested usage:
3348
+ * ```javascript
3349
+ *
3350
+ * sap.ui.require(["sap/ui/test/Opa5", "sap/ui/test/opaQunit"], function (Opa5, opaTest) {
3351
+ *
3352
+ * Opa5.extendConfig({
3353
+ * assertions: new Opa5({
3354
+ * checkIfSomethingIsOk : function () {
3355
+ * this.waitFor({
3356
+ * success: function () {
3357
+ * Opa5.assert.ok(true, "Everything is fine");
3358
+ * }
3359
+ * });
3360
+ * }
3361
+ * })
3362
+ * });
3363
+ *
3364
+ * opaTest("Should test something", function (Given, When, Then) {
3365
+ * // Implementation of the test
3366
+ * Then.checkIfSomethingIsOk();
3367
+ * });
3368
+ *
3369
+ * });
3370
+ * ```
3371
+ */
3372
+ export default function opaQunit(
3373
+ /**
3374
+ * name of the QUnit test.
3375
+ */
3376
+ testName: string,
3377
+ /**
3378
+ * the test function. Expects 3 arguments, in order: {@link sap.ui.test.Opa.config}.arrangements, {@link
3379
+ * sap.ui.test.Opa.config}.actions, {@link sap.ui.test.Opa.config}.assertions. These arguments will be prefilled
3380
+ * by OPA
3381
+ */
3382
+ callback: Function,
3383
+ /**
3384
+ * available only in QUnit v1.x. Indicates whether the test is asynchronous. False by default.
3385
+ */
3386
+ async?: boolean
3387
+ ): void;
3270
3388
  }
3271
3389
 
3272
3390
  declare module "sap/ui/util/Mobile" {
@@ -3527,51 +3645,6 @@ declare module "sap/ui/util/Storage" {
3527
3645
  }
3528
3646
  }
3529
3647
 
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
3648
  declare module "sap/ui/VersionInfo" {
3576
3649
  /**
3577
3650
  * @SINCE 1.56.0
@@ -3580,24 +3653,25 @@ declare module "sap/ui/VersionInfo" {
3580
3653
  /**
3581
3654
  * @SINCE 1.56.0
3582
3655
  *
3583
- * Loads the version info file (resources/sap-ui-version.json) asynchronously and returns a Promise. The
3584
- * returned Promise resolves with the version info files content.
3656
+ * Loads the version info asynchronously from resource "sap-ui-version.json".
3585
3657
  *
3586
- * If a library name is specified then the version info of the individual library will be retrieved.
3658
+ * By default, the returned promise will resolve with the whole version info file's content. If a library
3659
+ * name is specified in the options, then the promise will resolve with the version info for that library
3660
+ * only or with `undefined`, if the named library is not listed in the version info file.
3587
3661
  *
3588
- * In case of the version info file is not available an error will occur when calling this function.
3662
+ * If loading the version info file fails, the promise will be rejected with the corresponding error.
3589
3663
  */
3590
3664
  load(
3591
3665
  /**
3592
- * an object map (see below)
3666
+ * Map of options
3593
3667
  */
3594
- mOptions: {
3668
+ mOptions?: {
3595
3669
  /**
3596
- * name of the library (e.g. "sap.ui.core")
3670
+ * Name of a library (e.g. "sap.ui.core")
3597
3671
  */
3598
- library: string;
3672
+ library?: string;
3599
3673
  }
3600
- ): Promise<any>;
3674
+ ): Promise<object | undefined>;
3601
3675
  }
3602
3676
  const VersionInfo: VersionInfo;
3603
3677
  export default VersionInfo;
@@ -3974,8 +4048,8 @@ declare namespace sap {
3974
4048
  * using `sap.ui.require("something")` are automagically converted into `sap.ui.define` dependencies before
3975
4049
  * executing the factory function.
3976
4050
  *
3977
- * Limitations, Design Considerations:
3978
- * - **Limitation**: as dependency management is not supported for Non-UI5 modules, the only way to ensure
4051
+ * Restrictions, Design Considerations:
4052
+ * - **Restriction**: as dependency management is not supported for Non-UI5 modules, the only way to ensure
3979
4053
  * proper execution order for such modules currently is to rely on the order in the dependency array. Obviously,
3980
4054
  * this only works as long as `sap.ui.define` uses synchronous loading. It will be enhanced when asynchronous
3981
4055
  * loading is implemented.
@@ -4223,8 +4297,8 @@ declare namespace sap {
4223
4297
  * using `sap.ui.require("something")` are automagically converted into `sap.ui.define` dependencies before
4224
4298
  * executing the factory function.
4225
4299
  *
4226
- * Limitations, Design Considerations:
4227
- * - **Limitation**: as dependency management is not supported for Non-UI5 modules, the only way to ensure
4300
+ * Restrictions, Design Considerations:
4301
+ * - **Restriction**: as dependency management is not supported for Non-UI5 modules, the only way to ensure
4228
4302
  * proper execution order for such modules currently is to rely on the order in the dependency array. Obviously,
4229
4303
  * this only works as long as `sap.ui.define` uses synchronous loading. It will be enhanced when asynchronous
4230
4304
  * loading is implemented.
@@ -4466,8 +4540,8 @@ declare namespace sap {
4466
4540
  * using `sap.ui.require("something")` are automagically converted into `sap.ui.define` dependencies before
4467
4541
  * executing the factory function.
4468
4542
  *
4469
- * Limitations, Design Considerations:
4470
- * - **Limitation**: as dependency management is not supported for Non-UI5 modules, the only way to ensure
4543
+ * Restrictions, Design Considerations:
4544
+ * - **Restriction**: as dependency management is not supported for Non-UI5 modules, the only way to ensure
4471
4545
  * proper execution order for such modules currently is to rely on the order in the dependency array. Obviously,
4472
4546
  * this only works as long as `sap.ui.define` uses synchronous loading. It will be enhanced when asynchronous
4473
4547
  * loading is implemented.
@@ -4710,8 +4784,8 @@ declare namespace sap {
4710
4784
  * using `sap.ui.require("something")` are automagically converted into `sap.ui.define` dependencies before
4711
4785
  * executing the factory function.
4712
4786
  *
4713
- * Limitations, Design Considerations:
4714
- * - **Limitation**: as dependency management is not supported for Non-UI5 modules, the only way to ensure
4787
+ * Restrictions, Design Considerations:
4788
+ * - **Restriction**: as dependency management is not supported for Non-UI5 modules, the only way to ensure
4715
4789
  * proper execution order for such modules currently is to rely on the order in the dependency array. Obviously,
4716
4790
  * this only works as long as `sap.ui.define` uses synchronous loading. It will be enhanced when asynchronous
4717
4791
  * loading is implemented.
@@ -5348,8 +5422,8 @@ declare namespace sap {
5348
5422
  * to represent an individual folder. In other words: when a resource name is converted to a URL, any dots
5349
5423
  * ('.') are converted to slashes ('/').
5350
5424
  *
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.
5425
+ * **Note:** The **application root folder** is assumed to be the same as the folder where the current page
5426
+ * resides in.
5353
5427
  *
5354
5428
  * Usage sample:
5355
5429
  * ```javascript
@@ -5367,12 +5441,7 @@ declare namespace sap {
5367
5441
  *
5368
5442
  *
5369
5443
  * 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
5444
+ * {@link sap.ui.loader.config} with option `paths`.
5376
5445
  */
5377
5446
  function localResources(
5378
5447
  /**
@@ -5447,7 +5516,7 @@ declare namespace sap {
5447
5516
  fnCallback?: Function,
5448
5517
  /**
5449
5518
  * 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.
5519
+ * factory function. Note that due to browser restrictions not all errors will be reported via this callback.
5451
5520
  * In general, module loading is designed for the non-error case. Error handling is not complete.
5452
5521
  */
5453
5522
  fnErrback?: Function
@@ -5458,13 +5527,13 @@ declare namespace sap {
5458
5527
  * Returns the URL of a resource that belongs to the given library and has the given relative location within
5459
5528
  * the library. This is mainly meant for static resources like images that are inside the library. It is
5460
5529
  * 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,
5530
+ * with sap.ui.loader.config({paths:...}). For these cases use sap.ui.require.toUrl(). It DOES work, however,
5462
5531
  * when the given sResourcePath starts with "themes/" (= when it is a theme-dependent resource). Even when
5463
5532
  * for this theme a different location outside the normal library location is configured.
5464
5533
  */
5465
5534
  function resource(
5466
5535
  /**
5467
- * the name of a library, like "sap.ui.commons"
5536
+ * the name of a library, like "sap.ui.layout"
5468
5537
  */
5469
5538
  sLibraryName: string,
5470
5539
  /**
@@ -5483,7 +5552,7 @@ declare namespace sap {
5483
5552
  *
5484
5553
  * <div id="SAPUI5UiArea"></div>
5485
5554
  * <script>
5486
- * var oRoot = new sap.ui.commons.Label();
5555
+ * var oRoot = new sap.m.Label();
5487
5556
  * oRoot.setText("Hello world!");
5488
5557
  * sap.ui.setRoot("SAPUI5UiArea", oRoot);
5489
5558
  * </script>
@@ -6289,6 +6358,38 @@ declare namespace sap {
6289
6358
  events?: Record<string, Function>;
6290
6359
  };
6291
6360
 
6361
+ /**
6362
+ * Configuration for the binding of a managed object
6363
+ *
6364
+ * `path` is the only mandatory property, all others are optional.
6365
+ */
6366
+ type ObjectBindingInfo = {
6367
+ /**
6368
+ * Path in the model to bind to, either an absolute path or relative to the binding context for the corresponding
6369
+ * model. If the path contains a '>' sign, the string preceding it will override the `model` property,
6370
+ * and the remainder after the '>' sign will be used as binding path
6371
+ */
6372
+ path: string;
6373
+ /**
6374
+ * Name of the model to bind against; when `undefined` or omitted, the default model is used
6375
+ */
6376
+ model?: string;
6377
+ /**
6378
+ * Whether the binding is initially suspended
6379
+ */
6380
+ suspended?: boolean;
6381
+ /**
6382
+ * Map of additional parameters for this binding; the names and value ranges of the supported parameters
6383
+ * depend on the model implementation and should be documented with the `bindContext` method of the corresponding
6384
+ * model class or with the model-specific subclass of `sap.ui.model.ContextBinding`
6385
+ */
6386
+ parameters?: object;
6387
+ /**
6388
+ * Map of event handler functions keyed by the name of the binding events that they are attached to
6389
+ */
6390
+ events?: Record<string, Function>;
6391
+ };
6392
+
6292
6393
  /**
6293
6394
  * Configuration for the binding of a managed property.
6294
6395
  *
@@ -7426,8 +7527,8 @@ declare namespace sap {
7426
7527
  * **'library'** : string
7427
7528
  * Name of the library that the new subclass should belong to. If the subclass is a control or element,
7428
7529
  * 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'.
7530
+ * the name of the subclass should have the library name as a prefix, but subfolders are allowed, e.g. `sap.ui.layout.form.Form`
7531
+ * belongs to library `sap.ui.layout`.
7431
7532
  *
7432
7533
  * **'properties'** : object
7433
7534
  * An object literal whose properties each define a new managed property in the ManagedObject subclass.
@@ -7444,15 +7545,14 @@ declare namespace sap {
7444
7545
  * - `byValue: boolean` (either can be omitted or set to the boolean value `true`) If set to `true`,
7445
7546
  * the property value will be {@link module:sap/base/util/deepClone deep cloned} on write and read operations
7446
7547
  * 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
7548
+ * restricted to a `boolean` value. Other types are reserved for future use. Class definitions must only
7549
+ * use boolean values for the flag (or omit it), but readers of ManagedObject metadata should handle any
7550
+ * truthy value as `true` to be future safe. Note that using `byValue:true` has a performance impact on
7551
+ * property access and therefore should be used carefully. It also doesn't make sense to set this option
7552
+ * for properties with a primitive type (they have value semantic anyhow) or for properties with arrays
7553
+ * of primitive types (they are already cloned with a less expensive implementation). `group:string`
7554
+ * a semantic grouping of the properties, intended to be used in design time tools. Allowed values are (case
7555
+ * sensitive): Accessibility, Appearance, Behavior, Data, Designtime, Dimension, Identification, Misc
7456
7556
  * - `defaultValue: any` the default value for the property or null if there is no defaultValue.
7457
7557
  *
7458
7558
  * - `bindable: boolean|string` (either can be omitted or set to the boolean value `true` or the
@@ -8073,34 +8173,9 @@ declare namespace sap {
8073
8173
  */
8074
8174
  bindObject(
8075
8175
  /**
8076
- * An object describing the binding
8176
+ * Binding info
8077
8177
  */
8078
- oBindingInfo: {
8079
- /**
8080
- * Path in the model to bind to, either an absolute path or relative to the binding context for the corresponding
8081
- * model; when the path contains a '>' sign, the string preceding it will override the `model` property
8082
- * and the remainder after the '>' will be used as binding path
8083
- */
8084
- path: string;
8085
- /**
8086
- * Name of the model to bind against; when `undefined` or omitted, the default model is used
8087
- */
8088
- model?: string;
8089
- /**
8090
- * Map of additional parameters for this binding; the names and value ranges of the supported parameters
8091
- * depend on the model implementation, they should be documented with the `bindContext` method of the corresponding
8092
- * model class or with the model specific subclass of `sap.ui.model.ContextBinding`
8093
- */
8094
- parameters?: object;
8095
- /**
8096
- * Whether the binding should be suspended initially
8097
- */
8098
- suspended?: boolean;
8099
- /**
8100
- * Map of event handler functions keyed by the name of the binding events that they should be attached to
8101
- */
8102
- events?: object;
8103
- }
8178
+ oBindingInfo: sap.ui.base.ManagedObject.ObjectBindingInfo
8104
8179
  ): this;
8105
8180
  /**
8106
8181
  * Binds a property to the model.
@@ -8923,11 +8998,7 @@ declare namespace sap {
8923
8998
  /**
8924
8999
  * name of the aggregation to refresh
8925
9000
  */
8926
- sName: string,
8927
- /**
8928
- * the change reason
8929
- */
8930
- sChangeReason: sap.ui.model.ChangeReason
9001
+ sName: string
8931
9002
  ): void;
8932
9003
  /**
8933
9004
  * Removes an object from the aggregation named `sAggregationName` with cardinality 0..n.
@@ -10201,8 +10272,8 @@ declare namespace sap {
10201
10272
  *
10202
10273
  * The SAPUI5 Core Runtime.
10203
10274
  *
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.
10275
+ * Contains the UI5 Core and all its components, base classes for Controls, Components and the Model View
10276
+ * Controller classes.
10206
10277
  */
10207
10278
  namespace core {
10208
10279
  /**
@@ -10609,18 +10680,18 @@ declare namespace sap {
10609
10680
  /**
10610
10681
  * Horizontal position of the scrollbar
10611
10682
  */
10612
- iHorizontalPosition: int,
10683
+ x: int,
10613
10684
  /**
10614
10685
  * Vertical position of the scrollbar
10615
10686
  */
10616
- iVerticalPosition: int,
10687
+ y: int,
10617
10688
  /**
10618
10689
  * The duration of animated scrolling in milliseconds. To scroll immediately without animation, give 0 as
10619
10690
  * value.
10620
10691
  */
10621
- iTime: int,
10692
+ time: int,
10622
10693
 
10623
- fnCallback: Function
10694
+ fnScrollEndCallback: Function
10624
10695
  ): this;
10625
10696
  /**
10626
10697
  * Scrolls to a specific position in scroll container.
@@ -10629,13 +10700,13 @@ declare namespace sap {
10629
10700
  /**
10630
10701
  * Horizontal position of the scrollbar
10631
10702
  */
10632
- iHorizontalPosition: int,
10703
+ x: int,
10633
10704
  /**
10634
10705
  * Vertical position of the scrollbar
10635
10706
  */
10636
- iVerticalPosition: int,
10707
+ y: int,
10637
10708
 
10638
- fnCallback: Function
10709
+ fnScrollEndCallback: Function
10639
10710
  ): this;
10640
10711
  /**
10641
10712
  * Scrolls to an element within a container.
@@ -12028,6 +12099,63 @@ declare namespace sap {
12028
12099
  * Format classes
12029
12100
  */
12030
12101
  namespace format {
12102
+ namespace DateFormat {
12103
+ /**
12104
+ * @SINCE 1.99
12105
+ *
12106
+ * Interface for a timezone-specific DateFormat, which is able to format and parse a date based on a given
12107
+ * timezone. The timezone is used to convert the given date, and also for timezone-related pattern symbols.
12108
+ * The timezone is an IANA timezone ID, e.g. "America/New_York".
12109
+ * See:
12110
+ * sap.ui.core.format.DateFormat
12111
+ */
12112
+ interface DateTimeWithTimezone {
12113
+ __implements__sap_ui_core_format_DateFormat_DateTimeWithTimezone: boolean;
12114
+
12115
+ /**
12116
+ * @SINCE 1.99
12117
+ * @EXPERIMENTAL (since 1.99.0)
12118
+ *
12119
+ * Format a date object to a string according to the given timezone and format options.
12120
+ */
12121
+ format(
12122
+ /**
12123
+ * The date to format
12124
+ */
12125
+ oJSDate: Date,
12126
+ /**
12127
+ * The IANA timezone ID in which the date will be calculated and formatted e.g. "America/New_York". If omitted,
12128
+ * the timezone will be taken from {@link sap.ui.core.Configuration#getTimezone}.
12129
+ */
12130
+ sTimezone?: string
12131
+ ): string;
12132
+ /**
12133
+ * @SINCE 1.99
12134
+ * @EXPERIMENTAL (since 1.99.0)
12135
+ *
12136
+ * Parse a string which is formatted according to the given format options to an array containing a date
12137
+ * object and the timezone.
12138
+ */
12139
+ parse(
12140
+ /**
12141
+ * the string containing a formatted date/time value
12142
+ */
12143
+ sValue: string,
12144
+ /**
12145
+ * The IANA timezone ID which should be used to convert the date e.g. "America/New_York". If omitted, the
12146
+ * timezone will be taken from {@link sap.ui.core.Configuration#getTimezone}.
12147
+ */
12148
+ sTimezone?: string,
12149
+ /**
12150
+ * Whether to be strict with regards to the value ranges of date fields, e.g. for a month pattern of `MM`
12151
+ * and a value range of [1-12] `strict` ensures that the value is within the range; if it is larger than
12152
+ * `12` it cannot be parsed and `null` is returned
12153
+ */
12154
+ bStrict?: boolean
12155
+ ): any[];
12156
+ }
12157
+ }
12158
+
12031
12159
  namespace NumberFormat {
12032
12160
  /**
12033
12161
  * Specifies a rounding behavior for numerical operations capable of discarding precision. Each rounding
@@ -12077,6 +12205,9 @@ declare namespace sap {
12077
12205
  * The DateFormat is a static class for formatting and parsing single date and time values or date and time
12078
12206
  * intervals according to a set of format options.
12079
12207
  *
12208
+ * Important: Every Date is converted with the timezone taken from {@link sap.ui.core.Configuration#getTimezone}.
12209
+ * The timezone falls back to the browser's local timezone.
12210
+ *
12080
12211
  * Supported format options are pattern based on Unicode LDML Date Format notation. Please note that only
12081
12212
  * a subset of the LDML date symbols is supported. If no pattern is specified a default pattern according
12082
12213
  * to the locale settings is used.
@@ -12191,9 +12322,8 @@ declare namespace sap {
12191
12322
  */
12192
12323
  strictParsing?: boolean;
12193
12324
  /**
12194
- * if true, the date is formatted relatively to todays date if it is within the given day range, e.g. "today",
12195
- * "yesterday", "in 5 days"@param {boolean} [oFormatOptions.UTC] if true, the date is formatted and parsed
12196
- * as UTC instead of the local timezone
12325
+ * if true, the date is formatted relatively to today's date if it is within the given day range, e.g. "today",
12326
+ * "yesterday", "in 5 days"
12197
12327
  */
12198
12328
  relative?: boolean;
12199
12329
  /**
@@ -12239,6 +12369,77 @@ declare namespace sap {
12239
12369
  */
12240
12370
  oLocale?: sap.ui.core.Locale
12241
12371
  ): sap.ui.core.format.DateFormat;
12372
+ /**
12373
+ * @SINCE 1.99.0
12374
+ *
12375
+ * Get a datetimeWithTimezone instance of the DateFormat, which can be used for formatting.
12376
+ */
12377
+ static getDateTimeWithTimezoneInstance(
12378
+ /**
12379
+ * An object which defines the format options
12380
+ */
12381
+ oFormatOptions?: {
12382
+ /**
12383
+ * A string containing pattern symbols (e.g. "yMMMd" or "Hms") which will be converted into a pattern for
12384
+ * the used locale that matches the wanted symbols best. The symbols must be in canonical order, that is:
12385
+ * Era (G), Year (y/Y), Quarter (q/Q), Month (M/L), Week (w), Day-Of-Week (E/e/c), Day (d), Hour (h/H/k/K/j/J),
12386
+ * Minute (m), Second (s), Timezone (z/Z/v/V/O/X/x) See http://unicode.org/reports/tr35/tr35-dates.html#availableFormats_appendItems
12387
+ */
12388
+ format?: string;
12389
+ /**
12390
+ * a datetime pattern in LDML format. It is not verified whether the pattern represents a full datetime.
12391
+ */
12392
+ pattern?: string;
12393
+ /**
12394
+ * Specifies the display of the timezone:
12395
+ * - "Show": display both datetime and timezone
12396
+ * - "Hide": display only datetime
12397
+ * - "Only": display only timezone It is ignored for formatting when an options pattern or a format
12398
+ * are supplied.
12399
+ */
12400
+ showTimezone?: /* was: sap.ui.core.format.DateFormatTimezoneDisplay */ any;
12401
+ /**
12402
+ * Can be either 'short, 'medium', 'long' or 'full'. For datetime you can also define mixed styles, separated
12403
+ * with a slash, where the first part is the date style and the second part is the time style (e.g. "medium/short").
12404
+ * If no pattern is given, a locale-dependent default datetime pattern of that style from the LocaleData
12405
+ * class is used.
12406
+ */
12407
+ style?: string;
12408
+ /**
12409
+ * Whether to check by parsing if the value is a valid datetime
12410
+ */
12411
+ strictParsing?: boolean;
12412
+ /**
12413
+ * Whether the date is formatted relatively to today's date if it is within the given day range, e.g. "today",
12414
+ * "yesterday", "in 5 days"
12415
+ */
12416
+ relative?: boolean;
12417
+ /**
12418
+ * The day range used for relative formatting. If `oFormatOptions.relativeScale` is set to the default value
12419
+ * 'day', the `relativeRange is by default [-6, 6], which means that only the previous 6 and the following
12420
+ * 6 days are formatted relatively. If oFormatOptions.relativeScale` is set to 'auto', all dates are
12421
+ * formatted relatively.
12422
+ */
12423
+ relativeRange?: int[];
12424
+ /**
12425
+ * If 'auto' is set, a new relative time format is switched on for all Date/Time instances.
12426
+ */
12427
+ relativeScale?: string;
12428
+ /**
12429
+ * The style of the relative format. The valid values are "wide", "short", "narrow"
12430
+ */
12431
+ relativeStyle?: string;
12432
+ /**
12433
+ * The calendar type which is used to format and parse the date. This value is by default either set in
12434
+ * the configuration or calculated based on the current locale.
12435
+ */
12436
+ calendarType?: sap.ui.core.CalendarType;
12437
+ },
12438
+ /**
12439
+ * Locale to ask for locale-specific texts/settings
12440
+ */
12441
+ oLocale?: sap.ui.core.Locale
12442
+ ): sap.ui.core.format.DateFormat.DateTimeWithTimezone;
12242
12443
  /**
12243
12444
  * Get a time instance of the DateFormat, which can be used for formatting.
12244
12445
  */
@@ -12317,6 +12518,9 @@ declare namespace sap {
12317
12518
  ): sap.ui.core.format.DateFormat;
12318
12519
  /**
12319
12520
  * Format a date according to the given format options.
12521
+ *
12522
+ * Uses the timezone from {@link sap.ui.core.Configuration#getTimezone}, which falls back to the browser's
12523
+ * local timezone to convert the given date.
12320
12524
  */
12321
12525
  format(
12322
12526
  /**
@@ -12330,6 +12534,9 @@ declare namespace sap {
12330
12534
  ): string;
12331
12535
  /**
12332
12536
  * Parse a string which is formatted according to the given format options.
12537
+ *
12538
+ * Uses the timezone from {@link sap.ui.core.Configuration#getTimezone}, which falls back to the browser's
12539
+ * local timezone to convert the given date.
12333
12540
  */
12334
12541
  parse(
12335
12542
  /**
@@ -12341,7 +12548,7 @@ declare namespace sap {
12341
12548
  */
12342
12549
  bUTC: boolean,
12343
12550
  /**
12344
- * to use strict value check
12551
+ * whether to use strict value check
12345
12552
  */
12346
12553
  bStrict: boolean
12347
12554
  ): Date | Date[];
@@ -13351,9 +13558,9 @@ declare namespace sap {
13351
13558
  */
13352
13559
  setMessages(
13353
13560
  /**
13354
- * map of messages: {'target': [array of messages],...}
13561
+ * map of messages: {'target': [sap.ui.core.message.Message],...}
13355
13562
  */
13356
- vMessages: Record<string, any[]>
13563
+ mMessages: Record<string, sap.ui.core.message.Message[]>
13357
13564
  ): void;
13358
13565
  }
13359
13566
 
@@ -13930,7 +14137,16 @@ declare namespace sap {
13930
14137
  /**
13931
14138
  * Parameters to pass along with the event
13932
14139
  */
13933
- oParameters?: object
14140
+ mParameters: {
14141
+ /**
14142
+ * Messages already existing before the `messageChange` event was fired.
14143
+ */
14144
+ oldMessages: sap.ui.core.message.Message;
14145
+ /**
14146
+ * New messages added by the trigger of the `messageChange` event.
14147
+ */
14148
+ newMessages: sap.ui.core.message.Message;
14149
+ }
13934
14150
  ): this;
13935
14151
  /**
13936
14152
  * Returns the ID of the MessageProcessor instance
@@ -13941,9 +14157,9 @@ declare namespace sap {
13941
14157
  */
13942
14158
  setMessages(
13943
14159
  /**
13944
- * map of messages: {'target': [array of messages],...}
14160
+ * map of messages: {'target': [sap.ui.core.message.Message],...}
13945
14161
  */
13946
- vMessages: Record<string, any[]>
14162
+ mMessages: Record<string, sap.ui.core.message.Message[]>
13947
14163
  ): void;
13948
14164
  }
13949
14165
  }
@@ -14036,6 +14252,8 @@ declare namespace sap {
14036
14252
 
14037
14253
  namespace XMLView {
14038
14254
  /**
14255
+ * @SINCE 1.34
14256
+ *
14039
14257
  * Specifies the available preprocessor types for XMLViews
14040
14258
  * See:
14041
14259
  * sap.ui.core.mvc.XMLView
@@ -14213,7 +14431,7 @@ declare namespace sap {
14213
14431
  * **Example for a callback module definition (sync):**
14214
14432
  * ```javascript
14215
14433
  *
14216
- * sap.ui.define("my/custom/sync/ExtensionProvider", ['jquery.sap.global'], function(jQuery) {
14434
+ * sap.ui.define("my/custom/sync/ExtensionProvider", [], function() {
14217
14435
  * var ExtensionProvider = function() {};
14218
14436
  * ExtensionProvider.prototype.getControllerExtensions = function(sControllerName, sComponentId, bAsync) {
14219
14437
  * if (!bAsync && sControllerName == "my.own.Controller") {
@@ -14232,14 +14450,14 @@ declare namespace sap {
14232
14450
  * }];
14233
14451
  * };
14234
14452
  * return ExtensionProvider;
14235
- * }, true);
14453
+ * });
14236
14454
  * ```
14237
14455
  *
14238
14456
  *
14239
14457
  * **Example for a callback module definition (async):**
14240
14458
  * ```javascript
14241
14459
  *
14242
- * sap.ui.define("my/custom/async/ExtensionProvider", ['jquery.sap.global'], function(jQuery) {
14460
+ * sap.ui.define("my/custom/async/ExtensionProvider", [], function() {
14243
14461
  * var ExtensionProvider = function() {};
14244
14462
  * ExtensionProvider.prototype.getControllerExtensions = function(sControllerName, sComponentId, bAsync) {
14245
14463
  * if (bAsync && sControllerName == "my.own.Controller") {
@@ -14263,7 +14481,7 @@ declare namespace sap {
14263
14481
  * };
14264
14482
  * };
14265
14483
  * return ExtensionProvider;
14266
- * }, true);
14484
+ * });
14267
14485
  * ```
14268
14486
  *
14269
14487
  *
@@ -14673,6 +14891,8 @@ declare namespace sap {
14673
14891
  static asyncSupport: boolean;
14674
14892
 
14675
14893
  /**
14894
+ * @SINCE 1.56.0
14895
+ *
14676
14896
  * Creates a JSON view of the given configuration.
14677
14897
  */
14678
14898
  static create(
@@ -15142,6 +15362,8 @@ declare namespace sap {
15142
15362
  */
15143
15363
  static getMetadata(): sap.ui.core.ElementMetadata;
15144
15364
  /**
15365
+ * @SINCE 1.30
15366
+ *
15145
15367
  * Register a preprocessor for all views of a specific type.
15146
15368
  *
15147
15369
  * The preprocessor can be registered for several stages of view initialization, which are dependent on
@@ -15812,6 +16034,8 @@ declare namespace sap {
15812
16034
  static asyncSupport: boolean;
15813
16035
 
15814
16036
  /**
16037
+ * @SINCE 1.56.0
16038
+ *
15815
16039
  * Instantiates an XMLView from the given configuration options.
15816
16040
  *
15817
16041
  * If a `viewName` is given, it must be a dot-separated name of an XML view resource (without the mandatory
@@ -15897,6 +16121,8 @@ declare namespace sap {
15897
16121
  */
15898
16122
  static getMetadata(): sap.ui.core.ElementMetadata;
15899
16123
  /**
16124
+ * @SINCE 1.30
16125
+ *
15900
16126
  * Register a preprocessor for all views of a specific type.
15901
16127
  *
15902
16128
  * The preprocessor can be registered for several stages of view initialization, for xml views these are
@@ -15943,6 +16169,8 @@ declare namespace sap {
15943
16169
  mSettings?: object
15944
16170
  ): void;
15945
16171
  /**
16172
+ * @SINCE 1.30
16173
+ *
15946
16174
  * Register a preprocessor for all views of a specific type.
15947
16175
  *
15948
16176
  * The preprocessor can be registered for several stages of view initialization, for xml views these are
@@ -16147,6 +16375,8 @@ declare namespace sap {
16147
16375
 
16148
16376
  namespace Component {
16149
16377
  /**
16378
+ * @SINCE 1.67
16379
+ *
16150
16380
  * Registry of all `Component`s that currently exist.
16151
16381
  */
16152
16382
  interface registry {
@@ -16498,7 +16728,7 @@ declare namespace sap {
16498
16728
  /**
16499
16729
  * must be one of decimal, group, plusSign, minusSign.
16500
16730
  */
16501
- sStyle: string,
16731
+ sType: string,
16502
16732
  /**
16503
16733
  * will be used to represent the given symbol type
16504
16734
  */
@@ -16577,6 +16807,8 @@ declare namespace sap {
16577
16807
 
16578
16808
  namespace Element {
16579
16809
  /**
16810
+ * @SINCE 1.67
16811
+ *
16580
16812
  * Registry of all `sap.ui.core.Element`s that currently exist.
16581
16813
  */
16582
16814
  interface registry {
@@ -17169,7 +17401,7 @@ declare namespace sap {
17169
17401
 
17170
17402
  class Route extends sap.ui.base.EventProvider {
17171
17403
  /**
17172
- * Instantiates an SAPUI5 Route
17404
+ * Instantiates a route
17173
17405
  */
17174
17406
  constructor(
17175
17407
  /**
@@ -17248,21 +17480,21 @@ declare namespace sap {
17248
17480
  targetParent?: string;
17249
17481
  /**
17250
17482
  * **Deprecated since 1.28, use `target.controlId` instead.**
17251
- * Views will be put into a container Control, this might be a {@link sap.ui.ux3.Shell} control or a {@link
17252
- * sap.m.NavContainer} if working with mobile, or any other container. The id of this control has to be
17253
- * put in here
17483
+ * Views will be put into a container Control, this might be an {@link sap.ui.ux3.Shell} control or an
17484
+ * {@link sap.m.NavContainer} if working with mobile, or any other container. The id of this control has
17485
+ * to be put in here
17254
17486
  */
17255
17487
  targetControl?: string;
17256
17488
  /**
17257
17489
  * **Deprecated since 1.28, use `target.controlAggregation` instead.**
17258
- * The name of an aggregation of the targetControl, that contains views. Eg: a {@link sap.m.NavContainer}
17490
+ * The name of an aggregation of the targetControl, that contains views. Eg: an {@link sap.m.NavContainer}
17259
17491
  * has an aggregation "pages", another Example is the {@link sap.ui.ux3.Shell} it has "content".
17260
17492
  */
17261
17493
  targetAggregation?: string;
17262
17494
  /**
17263
17495
  * **Deprecated since 1.28, use `target.clearControlAggregation` instead.**
17264
17496
  * Defines a boolean that can be passed to specify if the aggregation should be cleared before adding the
17265
- * View to it. When using a {@link sap.ui.ux3.Shell} this should be true. For a {@link sap.m.NavContainer}
17497
+ * View to it. When using an {@link sap.ui.ux3.Shell} this should be true. For an {@link sap.m.NavContainer}
17266
17498
  * it should be false
17267
17499
  */
17268
17500
  clearTarget?: boolean;
@@ -17527,7 +17759,7 @@ declare namespace sap {
17527
17759
 
17528
17760
  class Router extends sap.ui.base.EventProvider {
17529
17761
  /**
17530
- * Instantiates a SAPUI5 Router
17762
+ * Instantiates a router
17531
17763
  */
17532
17764
  constructor(
17533
17765
  /**
@@ -17665,7 +17897,8 @@ declare namespace sap {
17665
17897
  * {
17666
17898
  * //same name as in the config.bypassed.target
17667
17899
  * notFound: {
17668
- * viewName: "notFound",
17900
+ * type: "View"
17901
+ * name: "notFound",
17669
17902
  * ...
17670
17903
  * // more properties to place the view in the correct container
17671
17904
  * }
@@ -18737,8 +18970,8 @@ declare namespace sap {
18737
18970
  */
18738
18971
  constructor(oOptions: {
18739
18972
  /**
18740
- * the views instance will create the views of all the targets defined, so if 2 targets have the same viewName,
18741
- * the same instance of the view will be displayed.
18973
+ * the views instance will create the instances of all the targets defined, so if 2 targets have the same
18974
+ * `type` and `name` set, the same instance of the target will be displayed.
18742
18975
  */
18743
18976
  views: sap.ui.core.routing.Views;
18744
18977
  /**
@@ -18876,8 +19109,8 @@ declare namespace sap {
18876
19109
  /**
18877
19110
  * Defines the name of the View or Component that will be created. For type 'Component', use option 'usage'
18878
19111
  * instead if an owner component exists. To place the view or component into a Control, use the options
18879
- * 'controlAggregation' and 'controlId'. Instance of View or Component will only be created once per 'name'
18880
- * or 'usage' combined with 'id'.
19112
+ * `controlAggregation` and `controlId`. Instance of View or Component will only be created once per `name`
19113
+ * or `usage` combined with `id`.
18881
19114
  * ```javascript
18882
19115
  *
18883
19116
  *
@@ -18912,21 +19145,22 @@ declare namespace sap {
18912
19145
  *
18913
19146
  * {
18914
19147
  * targets: {
18915
- * // If display("masterWelcome") is called, the master viewName will be placed in the 'MasterPages' of a control with the id splitContainter
19148
+ * // If display("masterWelcome") is called, the view with name "Welcome" will be placed in the 'MasterPages' of a control with the id splitContainter
18916
19149
  * masterWelcome: {
18917
19150
  * type: "View",
18918
19151
  * name: "Welcome",
18919
- * controlId: "splitContainer",
18920
- * controlAggregation: "masterPages",
18921
19152
  * id: "masterWelcome",
19153
+ * controlId: "splitContainer",
19154
+ * controlAggregation: "masterPages"
18922
19155
  * },
18923
- * // If display("detailWelcome") is called after the masterWelcome, a second instance with an own controller instance will be added in the detail pages.
19156
+ * // 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.
18924
19157
  * detailWelcome: {
18925
19158
  * type: "View",
18926
- * name: "WelcomeWithAlias",
19159
+ * name: "Welcome",
19160
+ * // another instance will be created because a different id is used
19161
+ * id: "detailWelcome",
18927
19162
  * controlId: "splitContainer",
18928
- * controlAggregation: "detailPages",
18929
- * id: "detailWelcome"
19163
+ * controlAggregation: "detailPages"
18930
19164
  * }
18931
19165
  * }
18932
19166
  * }
@@ -18946,8 +19180,9 @@ declare namespace sap {
18946
19180
  */
18947
19181
  viewType?: string;
18948
19182
  /**
18949
- * A prefix that will be prepended in front of the name.
18950
- * **Example:** name is set to "myView" and path is set to "myApp" - the created view name will be "myApp.myView".
19183
+ * A prefix that will be prepended in front of the `name`.
19184
+ * **Example:** `name` is set to "myView" and `path` is set to "myApp" - the created view's name will be
19185
+ * "myApp.myView".
18951
19186
  */
18952
19187
  path?: string;
18953
19188
  /**
@@ -21043,6 +21278,153 @@ declare namespace sap {
21043
21278
 
21044
21279
  namespace util {
21045
21280
  namespace MockServer {
21281
+ /**
21282
+ * Methods that can be used to respond to a request.
21283
+ */
21284
+ interface Response {
21285
+ __implements__sap_ui_core_util_MockServer_Response: boolean;
21286
+
21287
+ /**
21288
+ * Responds to the incoming request with the given `iStatusCode`, `mHeaders` and `sBody`.
21289
+ */
21290
+ respond(
21291
+ /**
21292
+ * HTTP status code to send with the response
21293
+ */
21294
+ StatusCode?: int,
21295
+ /**
21296
+ * HTTP headers to send with the response
21297
+ */
21298
+ mHeaders?: Record<string, string>,
21299
+ /**
21300
+ * A string that will be sent as response body
21301
+ */
21302
+ sBody?: string
21303
+ ): void;
21304
+ /**
21305
+ * Convenience variant of {@link #respond} which allows to send the content of an external resource as response.
21306
+ *
21307
+ * This method first synchronously fetches the given `sFileUrl`. Depending on the extension and path of
21308
+ * the `sFileUrl`, it propagates the received response body to {@link #respondJSON}, {@link #respondXML}
21309
+ * or {@link #respond}, using the given `iStatus` and `mHeaders`.
21310
+ *
21311
+ * The status code and headers of the received response are ignored. In particular, the `Content-Type` header
21312
+ * is not used for the mock server's response.
21313
+ */
21314
+ respondFile(
21315
+ /**
21316
+ * HTTP status code to send with the response
21317
+ */
21318
+ iStatusCode: int,
21319
+ /**
21320
+ * HTTP Headers to send with the response
21321
+ */
21322
+ mHeaders: Record<string, string>,
21323
+ /**
21324
+ * URL to get the response body from
21325
+ */
21326
+ sFileUrl: string
21327
+ ): void;
21328
+ /**
21329
+ * Convenience variant of {@link #respond} which allows to send the content of an external resource as response.
21330
+ *
21331
+ * This method first synchronously fetches the given `sFileUrl`. Depending on the extension and path of
21332
+ * the `sFileUrl`, it propagates the received response body to {@link #respondJSON}, {@link #respondXML}
21333
+ * or {@link #respond}, using the given `iStatus` and `mHeaders`.
21334
+ *
21335
+ * The status code and headers of the received response are ignored. In particular, the `Content-Type` header
21336
+ * is not used for the mock server's response.
21337
+ */
21338
+ respondFile(
21339
+ /**
21340
+ * HTTP status code to send with the response
21341
+ */
21342
+ iStatusCode: int,
21343
+ /**
21344
+ * URL to get the response body from
21345
+ */
21346
+ sFileUrl: string
21347
+ ): void;
21348
+ /**
21349
+ * Convenience variant of {@link #respond} which allows to send the content of an external resource as response.
21350
+ *
21351
+ * This method first synchronously fetches the given `sFileUrl`. Depending on the extension and path of
21352
+ * the `sFileUrl`, it propagates the received response body to {@link #respondJSON}, {@link #respondXML}
21353
+ * or {@link #respond}, using the given `iStatus` and `mHeaders`.
21354
+ *
21355
+ * The status code and headers of the received response are ignored. In particular, the `Content-Type` header
21356
+ * is not used for the mock server's response.
21357
+ */
21358
+ respondFile(
21359
+ /**
21360
+ * HTTP Headers to send with the response
21361
+ */
21362
+ mHeaders: Record<string, string>,
21363
+ /**
21364
+ * URL to get the response body from
21365
+ */
21366
+ sFileUrl: string
21367
+ ): void;
21368
+ /**
21369
+ * Convenience variant of {@link #respond} which allows to send the content of an external resource as response.
21370
+ *
21371
+ * This method first synchronously fetches the given `sFileUrl`. Depending on the extension and path of
21372
+ * the `sFileUrl`, it propagates the received response body to {@link #respondJSON}, {@link #respondXML}
21373
+ * or {@link #respond}, using the given `iStatus` and `mHeaders`.
21374
+ *
21375
+ * The status code and headers of the received response are ignored. In particular, the `Content-Type` header
21376
+ * is not used for the mock server's response.
21377
+ */
21378
+ respondFile(
21379
+ /**
21380
+ * URL to get the response body from
21381
+ */
21382
+ sFileUrl: string
21383
+ ): void;
21384
+ /**
21385
+ * Convenience variant of {@link #respond} which simplifies sending a JSON response.
21386
+ *
21387
+ * The response content `vBody` can either be given as a string, which is then assumed to be in JSON format.
21388
+ * Or it can be any JSON-stringifiable value which then will be converted to a string using `JSON.stringify`.
21389
+ * If no `vBody` is given, an empty response will be sent.
21390
+ *
21391
+ * If no `Content-Type` header is given, it will be set to `application/json`.
21392
+ */
21393
+ respondJSON(
21394
+ /**
21395
+ * HTTP status code to send with the response
21396
+ */
21397
+ iStatusCode?: int,
21398
+ /**
21399
+ * HTTP Headers to send with the response
21400
+ */
21401
+ mHeaders?: Record<string, string>,
21402
+ /**
21403
+ * A valid JSON-string or a JSON-stringifiable object that should be sent as response body
21404
+ */
21405
+ vBody?: object | string
21406
+ ): void;
21407
+ /**
21408
+ * Convenience variant of {@link #respond} which simplifies sending an XML response.
21409
+ *
21410
+ * If no `Content-Type` header is given, it will be set to `application/xml`.
21411
+ */
21412
+ respondXML(
21413
+ /**
21414
+ * HTTP status code to send with the response
21415
+ */
21416
+ iStatusCode?: int,
21417
+ /**
21418
+ * HTTP Headers to send with the response
21419
+ */
21420
+ mHeaders?: Record<string, string>,
21421
+ /**
21422
+ * XML string to send as response body
21423
+ */
21424
+ sXmlString?: string
21425
+ ): void;
21426
+ }
21427
+
21046
21428
  /**
21047
21429
  * Enum for the method.
21048
21430
  */
@@ -21059,6 +21441,29 @@ declare namespace sap {
21059
21441
 
21060
21442
  PUT = "PUT",
21061
21443
  }
21444
+
21445
+ type RequestHandler = {
21446
+ /**
21447
+ * Any HTTP verb
21448
+ */
21449
+ method: sap.ui.core.util.MockServer.HTTPMETHOD;
21450
+ /**
21451
+ * A string path is converted to a regular expression, so it can contain normal regular expression syntax.
21452
+ *
21453
+ * All regular expression groups are forwarded as arguments to the `response` function. In addition to this,
21454
+ * parameters can be written in this notation: `:param`. These placeholders will be replaced by regular
21455
+ * expression groups.
21456
+ */
21457
+ path: string | RegExp;
21458
+ /**
21459
+ * A response handler function that will be called when an incoming request matches `method` and `path`.
21460
+ * The first parameter of the handler will be a `Response` object which can be used to respond on the request.
21461
+ */
21462
+ response: (
21463
+ p1: sap.ui.core.util.MockServer.Response,
21464
+ p2: any
21465
+ ) => void;
21466
+ };
21062
21467
  }
21063
21468
 
21064
21469
  namespace XMLPreprocessor {
@@ -21102,9 +21507,6 @@ declare namespace sap {
21102
21507
  * refers to ".../Value". This means, the root formatter can access the ith part of the composite binding
21103
21508
  * at will (since 1.31.0); see also {@link #.getInterface getInterface}. The function `foo` is called with
21104
21509
  * arguments such that ` oInterface.getModel(i).getObject(oInterface.getPath(i)) === arguments[i + 1]` holds.
21105
- * This use is not supported within an expression binding, that is, `<Text text="{= ${parts: [{path:
21106
- * 'Label'}, {path: 'Value'}], formatter: 'foo'} }"/>` does not work as expected because the property `requiresIContext
21107
- * = true` is ignored.
21108
21510
  *
21109
21511
  * To distinguish those two use cases, just check whether `oInterface.getModel() === undefined`, in which
21110
21512
  * case the formatter is called on root level of a composite binding. To find out the number of parts, probe
@@ -22314,9 +22716,9 @@ declare namespace sap {
22314
22716
  */
22315
22717
  attachAfter(
22316
22718
  /**
22317
- * type according to HTTP Method
22719
+ * event type according to HTTP Method
22318
22720
  */
22319
- event: string,
22721
+ sHttpMethod: string,
22320
22722
  /**
22321
22723
  * the name of the function that will be called at this exit The callback function exposes an event with
22322
22724
  * parameters, depending on the type of the request. oEvent.getParameters() lists the parameters as per
@@ -22335,9 +22737,9 @@ declare namespace sap {
22335
22737
  */
22336
22738
  attachBefore(
22337
22739
  /**
22338
- * type according to HTTP Method
22740
+ * event type according to HTTP Method
22339
22741
  */
22340
- event: string,
22742
+ sHttpMethod: string,
22341
22743
  /**
22342
22744
  * the name of the function that will be called at this exit. The callback function exposes an event with
22343
22745
  * parameters, depending on the type of the request. oEvent.getParameters() lists the parameters as per
@@ -22370,9 +22772,9 @@ declare namespace sap {
22370
22772
  */
22371
22773
  detachAfter(
22372
22774
  /**
22373
- * type according to HTTP Method
22775
+ * event type according to HTTP Method
22374
22776
  */
22375
- event: string,
22777
+ sHttpMethod: string,
22376
22778
  /**
22377
22779
  * the name of the function that will be called at this exit
22378
22780
  */
@@ -22387,9 +22789,9 @@ declare namespace sap {
22387
22789
  */
22388
22790
  detachBefore(
22389
22791
  /**
22390
- * type according to HTTP Method
22792
+ * event type according to HTTP Method
22391
22793
  */
22392
- event: string,
22794
+ sHttpMethod: string,
22393
22795
  /**
22394
22796
  * the name of the function that will be called at this exit
22395
22797
  */
@@ -22420,7 +22822,7 @@ declare namespace sap {
22420
22822
  *
22421
22823
  * Default value is `[]`
22422
22824
  */
22423
- getRequests(): object[];
22825
+ getRequests(): sap.ui.core.util.MockServer.RequestHandler[];
22424
22826
  /**
22425
22827
  * Getter for property `rootUri`. Has to be relative and requires a trailing '/'. It also needs to match
22426
22828
  * the URI set in OData/JSON models or simple XHR calls in order for the mock server to intercept them.
@@ -22458,34 +22860,14 @@ declare namespace sap {
22458
22860
  /**
22459
22861
  * Setter for property `requests`.
22460
22862
  *
22461
- * Default value is is `[]`
22462
- *
22463
- * Each array entry should consist of an object with the following properties / values:
22464
- *
22465
- *
22466
- * - **method : "GET"|"POST"|"DELETE|"PUT"**
22467
- * (any HTTP verb)
22468
- * - **path : "/path/to/resource"**
22469
- * The path is converted to a regular expression, so it can contain normal regular expression syntax. All
22470
- * regular expression groups are forwarded as arguments to the `response` function. In addition to this,
22471
- * parameters can be written in this notation: `:param`. These placeholder will be replaced by regular expression
22472
- * groups.
22473
- * - **response : function(xhr, param1, param2, ...) { }**
22474
- * The xhr object can be used to respond on the request. Supported methods are:
22475
- * `xhr.respond(iStatusCode, mHeaders, sBody)`
22476
- * `xhr.respondJSON(iStatusCode, mHeaders, oJsonObjectOrString)`. By default a JSON header is set for response
22477
- * header
22478
- * `xhr.respondXML(iStatusCode, mHeaders, sXmlString)`. By default an XML header is set for response header
22479
- *
22480
- * `xhr.respondFile(iStatusCode, mHeaders, sFileUrl)`. By default the mime type of the file is set for
22481
- * response header
22863
+ * Default value is `[]`
22482
22864
  */
22483
22865
  setRequests(
22484
22866
  /**
22485
- * new value for property `requests`
22867
+ * new value for the `requests` property
22486
22868
  */
22487
- requests: object[]
22488
- ): void;
22869
+ requests: sap.ui.core.util.MockServer.RequestHandler[]
22870
+ ): this;
22489
22871
  /**
22490
22872
  * Setter for property `rootUri`. All request path URI are prefixed with this root URI if set.
22491
22873
  *
@@ -23011,7 +23393,7 @@ declare namespace sap {
23011
23393
  * Marker interface for subclasses of `sap.ui.core.UIComponent`.
23012
23394
  *
23013
23395
  * Implementing this interface allows a {@link sap.ui.core.UIComponent} to be created fully asynchronously.
23014
- * This interface will implicitily set the component's rootView and router configuration to async. Nested
23396
+ * This interface will implicitly set the component's rootView and router configuration to async. Nested
23015
23397
  * views will also be handled asynchronously. Additionally the error handling during the processing of views
23016
23398
  * is stricter and will fail if a view definition contains errors, e.g. broken binding strings.
23017
23399
  *
@@ -23031,6 +23413,38 @@ declare namespace sap {
23031
23413
  __implements__sap_ui_core_IAsyncContentCreation: boolean;
23032
23414
  }
23033
23415
 
23416
+ /**
23417
+ * @SINCE 1.98.0
23418
+ * @EXPERIMENTAL (since 1.98)
23419
+ *
23420
+ * Marker interface for controls that can serve as a menu for a table column header.
23421
+ *
23422
+ * Implementation of this interface implements the `openBy` and `getAriaHasPopupType` methods.
23423
+ */
23424
+ interface IColumnHeaderMenu {
23425
+ __implements__sap_ui_core_IColumnHeaderMenu: boolean;
23426
+
23427
+ /**
23428
+ * @SINCE 1.98.0
23429
+ * @EXPERIMENTAL (since 1.98)
23430
+ *
23431
+ * Returns the sap.ui.core.aria.HasPopup<\code> type of the menu.
23432
+ */
23433
+ getAriaHasPopupType(): sap.ui.core.aria.HasPopup;
23434
+ /**
23435
+ * @SINCE 1.98.0
23436
+ * @EXPERIMENTAL (since 1.98)
23437
+ *
23438
+ * Opens the menu using the column header.
23439
+ */
23440
+ openBy(
23441
+ /**
23442
+ * Specifies the control where the menu is placed.
23443
+ */
23444
+ oControl: sap.ui.core.Control
23445
+ ): void;
23446
+ }
23447
+
23034
23448
  /**
23035
23449
  * Marker interface for controls that can serve as a context menu.
23036
23450
  *
@@ -27813,8 +28227,7 @@ declare namespace sap {
27813
28227
  /**
27814
28228
  * @SINCE 1.27.0
27815
28229
  *
27816
- * Returns whether the framework automatically adds automatically the ARIA role 'application' to the HTML
27817
- * body or not.
28230
+ * Returns whether the framework automatically adds the ARIA role 'application' to the HTML body or not.
27818
28231
  */
27819
28232
  getAutoAriaBodyRole(): boolean;
27820
28233
  /**
@@ -27862,7 +28275,7 @@ declare namespace sap {
27862
28275
  /**
27863
28276
  * Returns a string that identifies the current language.
27864
28277
  *
27865
- * The value returned by this methods in most cases corresponds to the exact value that has been configured
28278
+ * The value returned by this method in most cases corresponds to the exact value that has been configured
27866
28279
  * by the user or application or that has been determined from the user agent settings. It has not been
27867
28280
  * normalized, but has been validated against a relaxed version of {@link http://www.ietf.org/rfc/bcp/bcp47.txt
27868
28281
  * BCP47}, allowing underscores ('_') instead of the suggested dashes ('-') and not taking the case of letters
@@ -27950,6 +28363,13 @@ declare namespace sap {
27950
28363
  * Returns the theme name
27951
28364
  */
27952
28365
  getTheme(): string;
28366
+ /**
28367
+ * @SINCE 1.99.0
28368
+ * @EXPERIMENTAL (since 1.99.0)
28369
+ *
28370
+ * Retrieves the configured IANA timezone ID
28371
+ */
28372
+ getTimezone(): string;
27953
28373
  /**
27954
28374
  * Prefix to be used for automatically generated control IDs. Default is a double underscore "__".
27955
28375
  */
@@ -28099,8 +28519,8 @@ declare namespace sap {
28099
28519
  /**
28100
28520
  * @SINCE 1.95.0
28101
28521
  *
28102
- * Sets the security token handlers for an OData V4 model. See chapter "Security Token Handling" in {@link
28103
- * topic:9613f1f2d88747cab21896f7216afdac Model Instantiation and Data Access}.
28522
+ * Sets the security token handlers for an OData V4 model. See chapter {@link topic:9613f1f2d88747cab21896f7216afdac/section_STH
28523
+ * Security Token Handling}.
28104
28524
  * See:
28105
28525
  * #getSecurityTokenHandlers
28106
28526
  */
@@ -28110,6 +28530,22 @@ declare namespace sap {
28110
28530
  */
28111
28531
  aSecurityTokenHandlers: Function[]
28112
28532
  ): void;
28533
+ /**
28534
+ * @SINCE 1.99.0
28535
+ * @EXPERIMENTAL (since 1.99.0)
28536
+ *
28537
+ * Sets the timezone such that all date and time based calculations use this timezone.
28538
+ *
28539
+ * When the timezone has changed, the Core will fire its {@link sap.ui.core.Core#event:localizationChanged
28540
+ * localizationChanged} event.
28541
+ */
28542
+ setTimezone(
28543
+ /**
28544
+ * IANA timezone ID, e.g. "America/New_York". Use `null` to reset the timezone to the browser's local timezone.
28545
+ * An invalid IANA timezone ID will fall back to the browser's timezone.
28546
+ */
28547
+ sTimezone?: string | null
28548
+ ): this;
28113
28549
  }
28114
28550
  /**
28115
28551
  * Base Class for Controls.
@@ -28312,9 +28748,9 @@ declare namespace sap {
28312
28748
  * **IMPORTANT:**
28313
28749
  * This should be only used as FALLBACK when the Control events do not cover a specific use-case! Always
28314
28750
  * try using SAPUI5 control events, as e.g. accessibility-related functionality is then provided automatically.
28315
- * E.g. when working with a `sap.ui.commons.Button`, always use the Button's "press" event, not the native
28316
- * "click" event, because "press" is also guaranteed to be fired when certain keyboard activity is supposed
28317
- * to trigger the Button.
28751
+ * E.g. when working with a `sap.m.Button`, always use the Button's "press" event, not the native "click"
28752
+ * event, because "press" is also guaranteed to be fired when certain keyboard activity is supposed to trigger
28753
+ * the Button.
28318
28754
  *
28319
28755
  * In the event handler, `this` refers to the Control - not to the root DOM element like in jQuery. While
28320
28756
  * the DOM element can be used and modified, the general caveats for working with SAPUI5 control DOM elements
@@ -28415,24 +28851,6 @@ declare namespace sap {
28415
28851
  */
28416
28852
  vFieldGroupIds?: string | string[]
28417
28853
  ): boolean;
28418
- /**
28419
- * Overrides {@link sap.ui.core.Element#clone Element.clone} to clone additional internal state.
28420
- *
28421
- * The additionally cloned information contains:
28422
- * - browser event handlers attached with {@link #attachBrowserEvent}
28423
- * - text selection behavior
28424
- * - style classes added with {@link #addStyleClass}
28425
- */
28426
- clone(
28427
- /**
28428
- * a suffix to be appended to the cloned element id
28429
- */
28430
- sIdSuffix?: string,
28431
- /**
28432
- * an array of local IDs within the cloned hierarchy (internally used)
28433
- */
28434
- aLocalIds?: string[]
28435
- ): this;
28436
28854
  /**
28437
28855
  * Removes event handlers which have been previously attached using {@link #attachBrowserEvent}.
28438
28856
  *
@@ -29385,30 +29803,11 @@ declare namespace sap {
29385
29803
  /**
29386
29804
  * the binding path or an object with more detailed binding options
29387
29805
  */
29388
- vPath:
29389
- | string
29390
- | {
29391
- /**
29392
- * the binding path
29393
- */
29394
- path: string;
29395
- /**
29396
- * map of additional parameters for this binding
29397
- */
29398
- parameters?: object;
29399
- /**
29400
- * name of the model
29401
- */
29402
- model?: string;
29403
- /**
29404
- * map of event listeners for the binding events
29405
- */
29406
- events?: object;
29407
- },
29806
+ vPath: string | sap.ui.base.ManagedObject.ObjectBindingInfo,
29408
29807
  /**
29409
- * map of additional parameters for this binding (only taken into account when vPath is a string in that
29410
- * case it corresponds to vPath.parameters). The supported parameters are listed in the corresponding model-specific
29411
- * implementation of `sap.ui.model.ContextBinding`.
29808
+ * map of additional parameters for this binding. Only taken into account when `vPath` is a string. In that
29809
+ * case it corresponds to `mParameters` of {@link sap.ui.base.ManagedObject.ObjectBindingInfo}. The supported
29810
+ * parameters are listed in the corresponding model-specific implementation of `sap.ui.model.ContextBinding`.
29412
29811
  */
29413
29812
  mParameters?: object
29414
29813
  ): this;
@@ -29609,6 +30008,10 @@ declare namespace sap {
29609
30008
  * visible before the focus is set
29610
30009
  */
29611
30010
  preventScroll?: boolean;
30011
+ /**
30012
+ * Further control-specific setting of the focus target within the control @since 1.98
30013
+ */
30014
+ targetInfo?: any;
29612
30015
  }
29613
30016
  ): void;
29614
30017
  /**
@@ -32241,7 +32644,7 @@ declare namespace sap {
32241
32644
  iWeekNumber: int
32242
32645
  ): string;
32243
32646
  /**
32244
- * Get combined datetime pattern with given date and and time style.
32647
+ * Get combined datetime pattern with given date and time style.
32245
32648
  */
32246
32649
  getCombinedDateTimePattern(
32247
32650
  /**
@@ -34802,7 +35205,7 @@ declare namespace sap {
34802
35205
  *
34803
35206
  * Writes the attribute and its value into the HTML.
34804
35207
  *
34805
- * For details about the escaping refer to {@link jQuery.sap.encodeHTML}
35208
+ * For details about the escaping refer to {@link sap/base/security/encodeXML}.
34806
35209
  */
34807
35210
  writeAttribute(
34808
35211
  /**
@@ -34880,7 +35283,7 @@ declare namespace sap {
34880
35283
  *
34881
35284
  * Escape text for HTML and write it to the buffer.
34882
35285
  *
34883
- * For details about the escaping refer to {@link jQuery.sap.encodeHTML}
35286
+ * For details about the escaping refer to {@link sap/base/security/encodeXML}.
34884
35287
  */
34885
35288
  writeEscaped(
34886
35289
  /**
@@ -35894,7 +36297,7 @@ declare namespace sap {
35894
36297
  /**
35895
36298
  * Returns this `UIArea`'s id (as determined from provided RootNode).
35896
36299
  */
35897
- getId(): string | null;
36300
+ getId(): string;
35898
36301
  /**
35899
36302
  * @deprecated (since 1.1) - use function {@link #getContent} instead
35900
36303
  *
@@ -37619,7 +38022,7 @@ declare namespace sap {
37619
38022
  *
37620
38023
  * Noteworthy details:
37621
38024
  * - whitespace is mandatory around a '-' or '+' operator and optional otherwise
37622
- * - parentheses are accepted but not checked for being balanced (a limitation of regexp based checks)
38025
+ * - parentheses are accepted but not checked for being balanced (a restriction of regexp based checks)
37623
38026
  *
37624
38027
  * - semantic constraints like type restrictions are not checked
37625
38028
  *
@@ -37677,7 +38080,7 @@ declare namespace sap {
37677
38080
  *
37678
38081
  * Noteworthy details:
37679
38082
  * - whitespace is mandatory around a '-' or '+' operator and optional otherwise
37680
- * - parentheses are accepted but not checked for being balanced (a limitation of regexp based checks)
38083
+ * - parentheses are accepted but not checked for being balanced (a restriction of regexp based checks)
37681
38084
  *
37682
38085
  * - semantic constraints like type restrictions are not checked
37683
38086
  *
@@ -41254,6 +41657,124 @@ declare namespace sap {
41254
41657
  vValue: any
41255
41658
  ): void;
41256
41659
  }
41660
+ /**
41661
+ * @SINCE 1.99.0
41662
+ * @EXPERIMENTAL
41663
+ *
41664
+ * This class represents the `DateTimeWithTimezone` composite type which has the parts timestamp and time
41665
+ * zone. The type formats the timestamp part using the time zone part. For this, the timestamp part has
41666
+ * to be provided in the UTC time zone.
41667
+ */
41668
+ class DateTimeWithTimezone extends sap.ui.model.CompositeType {
41669
+ /**
41670
+ * Constructor for a `DateTimeWithTimezone` composite type.
41671
+ */
41672
+ constructor(
41673
+ /**
41674
+ * Format options. For a list of all available options, see {@link sap.ui.core.format.DateFormat.getDateTimeWithTimezoneInstance
41675
+ * DateFormat}. Format options are immutable, that is, they can only be set once on construction.
41676
+ */
41677
+ oFormatOptions?: object,
41678
+ /**
41679
+ * Constraints are not supported
41680
+ */
41681
+ oConstraints?: object
41682
+ );
41683
+
41684
+ /**
41685
+ * Creates a new subclass of class sap.ui.model.odata.type.DateTimeWithTimezone with name `sClassName` and
41686
+ * enriches it with the information contained in `oClassInfo`.
41687
+ *
41688
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.CompositeType.extend}.
41689
+ */
41690
+ static extend<T extends Record<string, unknown>>(
41691
+ /**
41692
+ * Name of the class being created
41693
+ */
41694
+ sClassName: string,
41695
+ /**
41696
+ * Object literal with information about the class
41697
+ */
41698
+ oClassInfo?: sap.ClassInfo<
41699
+ T,
41700
+ sap.ui.model.odata.type.DateTimeWithTimezone
41701
+ >,
41702
+ /**
41703
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
41704
+ * used by this class
41705
+ */
41706
+ FNMetaImpl?: Function
41707
+ ): Function;
41708
+ /**
41709
+ * Returns a metadata object for class sap.ui.model.odata.type.DateTimeWithTimezone.
41710
+ */
41711
+ static getMetadata(): sap.ui.base.Metadata;
41712
+ /**
41713
+ * Formats the given values of the parts of the `DateTimeWithTimezone` composite type to the given target
41714
+ * type.
41715
+ */
41716
+ formatValue(
41717
+ /**
41718
+ * The array of the part values to be formatted; the first entry has to be a `Date` object for the timestamp,
41719
+ * and the second entry has to be a string representing a time zone ID
41720
+ */
41721
+ aValues: any[],
41722
+ /**
41723
+ * The target type, must be "object", "string", or a type with one of these types as its {@link sap.ui.base.DataType#getPrimitiveType
41724
+ * primitive type}; see {@link sap.ui.model.odata.type} for more information
41725
+ */
41726
+ sTargetType: string
41727
+ ): any;
41728
+ /**
41729
+ * Returns the type's name.
41730
+ */
41731
+ getName(): string;
41732
+ /**
41733
+ * Gets an array of indices that determine which parts of this type shall not propagate their model messages
41734
+ * to the attached control. Prerequisite is that the corresponding binding supports this feature, see {@link
41735
+ * sap.ui.model.Binding#supportsIgnoreMessages}. If the `showTimezone` format option is set to `sap.ui.core.format.DateFormatTimezoneDisplay.Hide`
41736
+ * and the time zone is not shown in the control, the part for the time zone shall not propagate model messages
41737
+ * to the control. Analogously, if the format option `showTimezone` is set to `sap.ui.core.format.DateFormatTimezoneDisplay.Only`,
41738
+ * the date and time are not shown in the control and the parts for the date and time shall not propagate
41739
+ * model messages to the control.
41740
+ * See:
41741
+ * sap.ui.model.Binding#supportsIgnoreMessages
41742
+ */
41743
+ getPartsIgnoringMessages(): number[];
41744
+ /**
41745
+ * Parses the given value.
41746
+ */
41747
+ parseValue(
41748
+ /**
41749
+ * The value to be parsed
41750
+ */
41751
+ vValue: string | Date,
41752
+ /**
41753
+ * The source type (the expected type of `vValue`); must be "object", "string", or a type with one of these
41754
+ * types as its {@link sap.ui.base.DataType#getPrimitiveType primitive type}; see {@link sap.ui.model.odata.type}
41755
+ * for more information
41756
+ */
41757
+ sSourceType: string,
41758
+ /**
41759
+ * The array of current part values; the first entry has to be a `Date` object for the timestamp, and the
41760
+ * second entry has to be a string representing a time zone ID; **Note:** This parameter is required, see
41761
+ * definition of this parameter in {@link sap.ui.model.CompositeType#parseValue}
41762
+ */
41763
+ aCurrentValues?: any[]
41764
+ ): any[];
41765
+ /**
41766
+ * Validates whether the given raw values meet the defined constraints. This method does nothing as no constraints
41767
+ * are supported.
41768
+ * See:
41769
+ * sap.ui.model.SimpleType#validateValue
41770
+ */
41771
+ validateValue(
41772
+ /**
41773
+ * The set of values to be validated
41774
+ */
41775
+ aValues: any[]
41776
+ ): void;
41777
+ }
41257
41778
  /**
41258
41779
  * @SINCE 1.27.0
41259
41780
  *
@@ -42961,6 +43482,7 @@ declare namespace sap {
42961
43482
  * A context for the OData V2 model cannot be created at will, it has to be retrieved via:
42962
43483
  * - an OData binding
42963
43484
  * - a view element
43485
+ * - {@link sap.ui.model.odata.v2.ODataListBinding#create}
42964
43486
  * - {@link sap.ui.model.odata.v2.ODataModel#callFunction}
42965
43487
  * - {@link sap.ui.model.odata.v2.ODataModel#createBindingContext}
42966
43488
  * - {@link sap.ui.model.odata.v2.ODataModel#createEntry}
@@ -42996,21 +43518,37 @@ declare namespace sap {
42996
43518
  /**
42997
43519
  * @SINCE 1.96.0
42998
43520
  *
42999
- * Returns a promise on the creation state of this context if it has been created via {@link sap.ui.model.odata.v2.ODataModel#createEntry};
43000
- * otherwise returns `undefined`.
43521
+ * Returns a promise on the creation state of this context if it has been created via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
43522
+ * or {@link sap.ui.model.odata.v2.ODataListBinding#create}; otherwise returns `undefined`.
43001
43523
  *
43002
43524
  * As long as the promise is not yet resolved or rejected, the entity represented by this context is transient.
43003
43525
  *
43004
43526
  * Once the promise is resolved, the entity for this context is stored in the back end and {@link #getPath}
43005
43527
  * returns a path including the key predicate of the new entity.
43528
+ *
43529
+ * If the context has been created via {@link sap.ui.model.odata.v2.ODataListBinding#create} and the entity
43530
+ * for this context has been stored in the back end, {@link #created} returns `undefined` after the data
43531
+ * has been re-read from the back end and inserted at the right position based on the list binding's filters
43532
+ * and sorters. If the context has been created via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
43533
+ * and the entity for this context has been stored in the back end, {@link #created} returns `undefined`.
43006
43534
  */
43007
43535
  created(): Promise<any>;
43536
+ /**
43537
+ * @SINCE 1.98.0
43538
+ *
43539
+ * Returns whether this context is inactive. An inactive context will only be sent to the server after the
43540
+ * first property update. From then on it behaves like any other created context.
43541
+ * See:
43542
+ * sap.ui.model.odata.v2.ODataListBinding#create
43543
+ * sap.ui.model.odata.v2.ODataModel#createEntry
43544
+ */
43545
+ isInactive(): boolean;
43008
43546
  /**
43009
43547
  * @SINCE 1.94.0
43010
43548
  *
43011
- * For a context created using {@link sap.ui.model.odata.v2.ODataModel#createEntry}, the method returns
43012
- * `true` if the context is transient or `false` if the context is not transient. A transient context represents
43013
- * an entity created on the client which has not been persisted in the back end.
43549
+ * For a context created using {@link sap.ui.model.odata.v2.ODataModel#createEntry} or {@link sap.ui.model.odata.v2.ODataListBinding#create},
43550
+ * the method returns `true` if the context is transient or `false` if the context is not transient. A transient
43551
+ * context represents an entity created on the client which has not been persisted in the back end.
43014
43552
  */
43015
43553
  isTransient(): boolean;
43016
43554
  }
@@ -43626,8 +44164,8 @@ declare namespace sap {
43626
44164
  */
43627
44165
  countMode?: sap.ui.model.odata.CountMode;
43628
44166
  /**
43629
- * A key used in combination with the resolved path of this binding to identify the entities created this
43630
- * binding's {@link #create} method.
44167
+ * A key used in combination with the resolved path of this binding to identify the entities created by
44168
+ * this binding's {@link #create} method.
43631
44169
  *
43632
44170
  * **Note:** Different controls or control aggregation bindings to the same collection must have different
43633
44171
  * `createdEntitiesKey` values.
@@ -43702,6 +44240,234 @@ declare namespace sap {
43702
44240
  * Returns a metadata object for class sap.ui.model.odata.v2.ODataListBinding.
43703
44241
  */
43704
44242
  static getMetadata(): sap.ui.base.Metadata;
44243
+ /**
44244
+ * @SINCE 1.98.0
44245
+ *
44246
+ * Attach event handler `fnFunction` to the 'createActivate' event of this binding.
44247
+ */
44248
+ attachCreateActivate(
44249
+ /**
44250
+ * The function to call when the event occurs
44251
+ */
44252
+ fnFunction: Function,
44253
+ /**
44254
+ * Object on which to call the given function
44255
+ */
44256
+ oListener?: object
44257
+ ): void;
44258
+ /**
44259
+ * @SINCE 1.98.0
44260
+ *
44261
+ * Creates a new entity for this binding's collection via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
44262
+ * using the parameters given in `mParameters` and inserts it at the list position specified by the `bAtEnd`
44263
+ * parameter. See {@link topic:6c47b2b39db9404582994070ec3d57a2#loio4c4cd99af9b14e08bb72470cc7cabff4 Creating
44264
+ * Entities documentation} for comprehensive information on the topic.
44265
+ *
44266
+ * Note: This method requires that the model metadata has been loaded; see {@link sap.ui.model.odata.v2.ODataModel#metadataLoaded}.
44267
+ */
44268
+ create(
44269
+ /**
44270
+ * The initial data for the created entity; see the `mParameters.properties` parameter of {@link sap.ui.model.odata.v2.ODataModel#createEntry}
44271
+ */
44272
+ oInitialData: object,
44273
+ /**
44274
+ * Whether the entity is inserted at the end of the list. The first insertion determines the overall position
44275
+ * of created contexts within the list. Every succeeding insertion is relative to the created contexts within
44276
+ * this list. Note: the order of created contexts in the binding does not necessarily correspond to the
44277
+ * order of the resulting back end creation requests.
44278
+ */
44279
+ bAtEnd: boolean,
44280
+ /**
44281
+ * A map of parameters as specified for {@link sap.ui.model.odata.v2.ODataModel#createEntry} where only
44282
+ * the following subset of these is supported.
44283
+ */
44284
+ mParameters: {
44285
+ /**
44286
+ * The ID of the `ChangeSet` that this request should belong to
44287
+ */
44288
+ changeSetId?: string;
44289
+ /**
44290
+ * The error callback function
44291
+ */
44292
+ error?: Function;
44293
+ /**
44294
+ * A comma-separated list of navigation properties to be expanded for the newly created entity; see {@link
44295
+ * sap.ui.model.odata.v2.ODataModel#createEntry}
44296
+ */
44297
+ expand?: string;
44298
+ /**
44299
+ * The ID of a request group; requests belonging to the same group will be bundled in one batch request
44300
+ */
44301
+ groupId?: string;
44302
+ /**
44303
+ * Whether the created context is inactive. An inactive context will only be sent to the server after the
44304
+ * first property update. From then on it behaves like any other created context.
44305
+ */
44306
+ inactive?: boolean;
44307
+ /**
44308
+ * The success callback function
44309
+ */
44310
+ success?: Function;
44311
+ }
44312
+ ): sap.ui.model.odata.v2.Context;
44313
+ /**
44314
+ * @SINCE 1.98.0
44315
+ *
44316
+ * Creates a new entity for this binding's collection via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
44317
+ * using the parameters given in `mParameters` and inserts it at the list position specified by the `bAtEnd`
44318
+ * parameter. See {@link topic:6c47b2b39db9404582994070ec3d57a2#loio4c4cd99af9b14e08bb72470cc7cabff4 Creating
44319
+ * Entities documentation} for comprehensive information on the topic.
44320
+ *
44321
+ * Note: This method requires that the model metadata has been loaded; see {@link sap.ui.model.odata.v2.ODataModel#metadataLoaded}.
44322
+ */
44323
+ create(
44324
+ /**
44325
+ * The initial data for the created entity; see the `mParameters.properties` parameter of {@link sap.ui.model.odata.v2.ODataModel#createEntry}
44326
+ */
44327
+ oInitialData: object,
44328
+ /**
44329
+ * A map of parameters as specified for {@link sap.ui.model.odata.v2.ODataModel#createEntry} where only
44330
+ * the following subset of these is supported.
44331
+ */
44332
+ mParameters: {
44333
+ /**
44334
+ * The ID of the `ChangeSet` that this request should belong to
44335
+ */
44336
+ changeSetId?: string;
44337
+ /**
44338
+ * The error callback function
44339
+ */
44340
+ error?: Function;
44341
+ /**
44342
+ * A comma-separated list of navigation properties to be expanded for the newly created entity; see {@link
44343
+ * sap.ui.model.odata.v2.ODataModel#createEntry}
44344
+ */
44345
+ expand?: string;
44346
+ /**
44347
+ * The ID of a request group; requests belonging to the same group will be bundled in one batch request
44348
+ */
44349
+ groupId?: string;
44350
+ /**
44351
+ * Whether the created context is inactive. An inactive context will only be sent to the server after the
44352
+ * first property update. From then on it behaves like any other created context.
44353
+ */
44354
+ inactive?: boolean;
44355
+ /**
44356
+ * The success callback function
44357
+ */
44358
+ success?: Function;
44359
+ }
44360
+ ): sap.ui.model.odata.v2.Context;
44361
+ /**
44362
+ * @SINCE 1.98.0
44363
+ *
44364
+ * Creates a new entity for this binding's collection via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
44365
+ * using the parameters given in `mParameters` and inserts it at the list position specified by the `bAtEnd`
44366
+ * parameter. See {@link topic:6c47b2b39db9404582994070ec3d57a2#loio4c4cd99af9b14e08bb72470cc7cabff4 Creating
44367
+ * Entities documentation} for comprehensive information on the topic.
44368
+ *
44369
+ * Note: This method requires that the model metadata has been loaded; see {@link sap.ui.model.odata.v2.ODataModel#metadataLoaded}.
44370
+ */
44371
+ create(
44372
+ /**
44373
+ * Whether the entity is inserted at the end of the list. The first insertion determines the overall position
44374
+ * of created contexts within the list. Every succeeding insertion is relative to the created contexts within
44375
+ * this list. Note: the order of created contexts in the binding does not necessarily correspond to the
44376
+ * order of the resulting back end creation requests.
44377
+ */
44378
+ bAtEnd: boolean,
44379
+ /**
44380
+ * A map of parameters as specified for {@link sap.ui.model.odata.v2.ODataModel#createEntry} where only
44381
+ * the following subset of these is supported.
44382
+ */
44383
+ mParameters: {
44384
+ /**
44385
+ * The ID of the `ChangeSet` that this request should belong to
44386
+ */
44387
+ changeSetId?: string;
44388
+ /**
44389
+ * The error callback function
44390
+ */
44391
+ error?: Function;
44392
+ /**
44393
+ * A comma-separated list of navigation properties to be expanded for the newly created entity; see {@link
44394
+ * sap.ui.model.odata.v2.ODataModel#createEntry}
44395
+ */
44396
+ expand?: string;
44397
+ /**
44398
+ * The ID of a request group; requests belonging to the same group will be bundled in one batch request
44399
+ */
44400
+ groupId?: string;
44401
+ /**
44402
+ * Whether the created context is inactive. An inactive context will only be sent to the server after the
44403
+ * first property update. From then on it behaves like any other created context.
44404
+ */
44405
+ inactive?: boolean;
44406
+ /**
44407
+ * The success callback function
44408
+ */
44409
+ success?: Function;
44410
+ }
44411
+ ): sap.ui.model.odata.v2.Context;
44412
+ /**
44413
+ * @SINCE 1.98.0
44414
+ *
44415
+ * Creates a new entity for this binding's collection via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
44416
+ * using the parameters given in `mParameters` and inserts it at the list position specified by the `bAtEnd`
44417
+ * parameter. See {@link topic:6c47b2b39db9404582994070ec3d57a2#loio4c4cd99af9b14e08bb72470cc7cabff4 Creating
44418
+ * Entities documentation} for comprehensive information on the topic.
44419
+ *
44420
+ * Note: This method requires that the model metadata has been loaded; see {@link sap.ui.model.odata.v2.ODataModel#metadataLoaded}.
44421
+ */
44422
+ create(
44423
+ /**
44424
+ * A map of parameters as specified for {@link sap.ui.model.odata.v2.ODataModel#createEntry} where only
44425
+ * the following subset of these is supported.
44426
+ */
44427
+ mParameters: {
44428
+ /**
44429
+ * The ID of the `ChangeSet` that this request should belong to
44430
+ */
44431
+ changeSetId?: string;
44432
+ /**
44433
+ * The error callback function
44434
+ */
44435
+ error?: Function;
44436
+ /**
44437
+ * A comma-separated list of navigation properties to be expanded for the newly created entity; see {@link
44438
+ * sap.ui.model.odata.v2.ODataModel#createEntry}
44439
+ */
44440
+ expand?: string;
44441
+ /**
44442
+ * The ID of a request group; requests belonging to the same group will be bundled in one batch request
44443
+ */
44444
+ groupId?: string;
44445
+ /**
44446
+ * Whether the created context is inactive. An inactive context will only be sent to the server after the
44447
+ * first property update. From then on it behaves like any other created context.
44448
+ */
44449
+ inactive?: boolean;
44450
+ /**
44451
+ * The success callback function
44452
+ */
44453
+ success?: Function;
44454
+ }
44455
+ ): sap.ui.model.odata.v2.Context;
44456
+ /**
44457
+ * @SINCE 1.98.0
44458
+ *
44459
+ * Detach event handler `fnFunction` from the 'createActivate' event of this binding.
44460
+ */
44461
+ detachCreateActivate(
44462
+ /**
44463
+ * The function to call when the event occurs
44464
+ */
44465
+ fnFunction: Function,
44466
+ /**
44467
+ * Object on which to call the given function
44468
+ */
44469
+ oListener?: object
44470
+ ): void;
43705
44471
  /**
43706
44472
  * Filters the list.
43707
44473
  *
@@ -43710,6 +44476,9 @@ declare namespace sap {
43710
44476
  * with AND. Usually this means, all filters applied to a single table column are combined with OR, while
43711
44477
  * filters on different table columns are combined with AND. Please note that a custom filter function is
43712
44478
  * only supported with operation mode `sap.ui.model.odata.OperationMode.Client`.
44479
+ *
44480
+ * Entities that have been created via {@link #create} and saved in the back end are removed from the creation
44481
+ * rows area and inserted at the right position based on the current filters and sorters.
43713
44482
  */
43714
44483
  filter(
43715
44484
  /**
@@ -43725,6 +44494,15 @@ declare namespace sap {
43725
44494
  */
43726
44495
  bReturnSuccess?: boolean
43727
44496
  ): this;
44497
+ /**
44498
+ * @SINCE 1.98.0
44499
+ *
44500
+ * Returns all current contexts of this list binding in no special order. Just like {@link #getCurrentContexts},
44501
+ * this method does not request any data from a back end and does not change the binding's state. In contrast
44502
+ * to {@link #getCurrentContexts}, it does not only return those contexts that were last requested by a
44503
+ * control, but all contexts that are currently available in the binding.
44504
+ */
44505
+ getAllCurrentContexts(): sap.ui.model.odata.v2.Context[];
43728
44506
  /**
43729
44507
  * Return contexts for the list.
43730
44508
  */
@@ -43742,6 +44520,18 @@ declare namespace sap {
43742
44520
  */
43743
44521
  iThreshold?: int
43744
44522
  ): sap.ui.model.odata.v2.Context[];
44523
+ /**
44524
+ * @SINCE 1.98.0
44525
+ *
44526
+ * Returns the count of active entries in the list if the list length is final, otherwise `undefined`. Contrary
44527
+ * to {#getLength}, this method does not consider inactive entries which are created via {#create}.
44528
+ * See:
44529
+ * #create
44530
+ * #getLength
44531
+ * #isLengthFinal
44532
+ * sap.ui.model.odata.v2.Context#isInactive
44533
+ */
44534
+ getCount(): number | undefined;
43745
44535
  /**
43746
44536
  * @SINCE 1.24
43747
44537
  *
@@ -43767,10 +44557,20 @@ declare namespace sap {
43767
44557
  * do nothing, method will be called again when metadata is loaded.
43768
44558
  */
43769
44559
  initialize(): sap.ui.model.odata.v2.ODataListBinding;
44560
+ /**
44561
+ * @SINCE 1.98.0
44562
+ *
44563
+ * Returns whether the overall position of created entries is at the end of the list; this is determined
44564
+ * by the first call to {@link sap.ui.model.odata.v2.ODataListBinding#create}.
44565
+ */
44566
+ isFirstCreateAtEnd(): boolean | undefined;
43770
44567
  /**
43771
44568
  * Refreshes the binding, check whether the model data has been changed and fire change event if this is
43772
44569
  * the case. For server side models this should refetch the data from the server. To update a control, even
43773
44570
  * if no data has been changed, e.g. to reset a control after failed validation, use the parameter `bForceUpdate`.
44571
+ *
44572
+ * Entities that have been created via {@link #create} and saved in the back end are removed from the creation
44573
+ * rows area and inserted at the right position based on the current filters and sorters.
43774
44574
  */
43775
44575
  refresh(
43776
44576
  /**
@@ -43802,6 +44602,9 @@ declare namespace sap {
43802
44602
  ): Promise<sap.ui.model.Filter>;
43803
44603
  /**
43804
44604
  * Sorts the list.
44605
+ *
44606
+ * Entities that have been created via {@link #create} and saved in the back end are removed from the creation
44607
+ * rows area and inserted at the right position based on the current filters and sorters.
43805
44608
  */
43806
44609
  sort(
43807
44610
  /**
@@ -44660,7 +45463,7 @@ declare namespace sap {
44660
45463
  * Maps the function import parameter name as specified in the function import's metadata to its value;
44661
45464
  * the value is formatted based on the parameter's type as specified in the metadata
44662
45465
  */
44663
- urlParameters?: Record<string, string>;
45466
+ urlParameters?: Record<string, any>;
44664
45467
  /**
44665
45468
  * **Deprecated - use `groupId` instead**
44666
45469
  */
@@ -44673,7 +45476,9 @@ declare namespace sap {
44673
45476
  */
44674
45477
  canonicalRequestsEnabled(): boolean;
44675
45478
  /**
44676
- * Trigger a `POST` request to the OData service that was specified in the model constructor.
45479
+ * Trigger a `POST` request to the OData service that was specified in the model constructor; see {@link
45480
+ * topic:6c47b2b39db9404582994070ec3d57a2#loio4c4cd99af9b14e08bb72470cc7cabff4 Creating Entities documentation}
45481
+ * for comprehensive information on the topic.
44677
45482
  *
44678
45483
  * Please note that deep creates are not supported and may not work.
44679
45484
  */
@@ -44788,10 +45593,12 @@ declare namespace sap {
44788
45593
  * Whether to reload data
44789
45594
  */
44790
45595
  bReload?: boolean
44791
- ): sap.ui.model.odata.v2.Context;
45596
+ ): sap.ui.model.odata.v2.Context | undefined;
44792
45597
  /**
44793
45598
  * Creates a new entry object which is described by the metadata of the entity type of the specified `sPath`
44794
- * Name. A context object is returned which can be used to bind against the newly created object.
45599
+ * Name. A context object is returned which can be used to bind against the newly created object. See {@link
45600
+ * topic:6c47b2b39db9404582994070ec3d57a2#loio4c4cd99af9b14e08bb72470cc7cabff4 Creating Entities documentation}
45601
+ * for comprehensive information on the topic.
44795
45602
  *
44796
45603
  * For each created entry a request is created and stored in a request queue. The request queue can be submitted
44797
45604
  * by calling {@link #submitChanges}. As long as the context is transient (see {@link sap.ui.model.odata.v2.Context#isTransient}),
@@ -44886,6 +45693,11 @@ declare namespace sap {
44886
45693
  * A map of headers
44887
45694
  */
44888
45695
  headers?: Record<string, string>;
45696
+ /**
45697
+ * Whether the created context is inactive. An inactive context will only be sent to the server after the
45698
+ * first property update. From then on it behaves like any other created context. Supported since 1.98.0
45699
+ */
45700
+ inactive?: boolean;
44889
45701
  /**
44890
45702
  * An array that specifies a set of properties or the entry
44891
45703
  */
@@ -44921,7 +45733,7 @@ declare namespace sap {
44921
45733
  oKeyProperties: object
44922
45734
  ): string;
44923
45735
  /**
44924
- * @deprecated - since 1.95.0; use {@link #resetChanges} instead
45736
+ * @deprecated (since 1.95.0) - use {@link #resetChanges} instead
44925
45737
  *
44926
45738
  * Deletes a created entry from the request queue and from the model.
44927
45739
  *
@@ -45478,11 +46290,11 @@ declare namespace sap {
45478
46290
  /**
45479
46291
  * Return the parsed XML metadata as a Javascript object.
45480
46292
  *
45481
- * Please note that the metadata is loaded asynchronously and this function might return undefined because
46293
+ * Please note that the metadata is loaded asynchronously and this function might return `undefined` because
45482
46294
  * the metadata has not been loaded yet. In this case attach to the `metadataLoaded` event to get notified
45483
46295
  * when the metadata is available and then call this function.
45484
46296
  */
45485
- getServiceMetadata(): Object;
46297
+ getServiceMetadata(): Object | undefined;
45486
46298
  /**
45487
46299
  * Checks if there exist pending changes in the model.
45488
46300
  *
@@ -45694,7 +46506,7 @@ declare namespace sap {
45694
46506
  *
45695
46507
  * Returns a new promise which can be resolved or rejected depending on the metadata loading state.
45696
46508
  */
45697
- refreshMetadata(): Promise<any>;
46509
+ refreshMetadata(): Promise<any> | undefined;
45698
46510
  /**
45699
46511
  * Refresh XSRF token by performing a GET request against the service root URL.
45700
46512
  */
@@ -45786,7 +46598,7 @@ declare namespace sap {
45786
46598
  */
45787
46599
  resetChanges(
45788
46600
  /**
45789
- * Paths to be be reset; if no array is passed, all changes are reset
46601
+ * Paths to be reset; if no array is passed, all changes are reset
45790
46602
  */
45791
46603
  aPath?: any[],
45792
46604
  /**
@@ -46199,7 +47011,11 @@ declare namespace sap {
46199
47011
  /**
46200
47012
  * Type of the filter which should be adjusted. If it is not given, the type `FilterType.Control` is assumed
46201
47013
  */
46202
- sFilterType: sap.ui.model.FilterType
47014
+ sFilterType: sap.ui.model.FilterType,
47015
+ /**
47016
+ * Whether to return `true` or `false`, instead of `this`, depending on whether the filtering has been done
47017
+ */
47018
+ bReturnSuccess?: boolean
46203
47019
  ): this;
46204
47020
  /**
46205
47021
  * Returns the number of child nodes. This function is not available when the annotation "hierarchy-node-descendant-count-for"
@@ -46310,16 +47126,25 @@ declare namespace sap {
46310
47126
  * annotation specification, or when providing the annotation information locally as a binding parameter.
46311
47127
  * For more information, see {@link sap.ui.model.odata.v2.ODataModel#bindTree}.
46312
47128
  */
46313
- setRootLevel(iRootLevel: int): void;
47129
+ setRootLevel(
47130
+ /**
47131
+ * The new `rootLevel`
47132
+ */
47133
+ iRootLevel: int
47134
+ ): void;
46314
47135
  /**
46315
- * Sorts the Tree according to the given Sorter(s). In OperationMode.Client or OperationMode.Auto (if the
46316
- * given threshold is satisfied), the sorters are applied locally on the client.
47136
+ * Sorts the Tree according to the given Sorter(s). In `OperationMode.Client` or `OperationMode.Auto` (if
47137
+ * the given threshold is satisfied), the sorters are applied locally on the client.
46317
47138
  */
46318
47139
  sort(
46319
47140
  /**
46320
- * the Sorter or an Array of sap.ui.model.Sorter instances
47141
+ * The Sorter or an Array of sap.ui.model.Sorter instances
47142
+ */
47143
+ aSorters: sap.ui.model.Sorter[] | sap.ui.model.Sorter,
47144
+ /**
47145
+ * Whether to return `true` or `false`, instead of `this`, depending on whether the sorting has been done
46321
47146
  */
46322
- aSorters: sap.ui.model.Sorter[] | sap.ui.model.Sorter
47147
+ bReturnSuccess?: boolean
46323
47148
  ): this;
46324
47149
  }
46325
47150
  /**
@@ -46420,16 +47245,16 @@ declare namespace sap {
46420
47245
  * ```javascript
46421
47246
  *
46422
47247
  * <Annotations Target="com.sap.gateway.default.iwbep.tea_busi.v0001.EQUIPMENT">
46423
- * <Annotation Term="com.sap.vocabularies.UI.v1.Facets">
46424
- * <Collection>
46425
- * <Record Type="com.sap.vocabularies.UI.v1.ReferenceFacet">
46426
- * <PropertyValue Property="Target" AnnotationPath="EQUIPMENT_2_PRODUCT/@com.sap.vocabularies.Common.v1.QuickInfo" />
46427
- * </Record>
46428
- * </Collection>
46429
- * </Annotation>
47248
+ * <Annotation Term="com.sap.vocabularies.UI.v1.Facets">
47249
+ * <Collection>
47250
+ * <Record Type="com.sap.vocabularies.UI.v1.ReferenceFacet">
47251
+ * <PropertyValue Property="Target" AnnotationPath="EQUIPMENT_2_PRODUCT/@com.sap.vocabularies.Common.v1.QuickInfo" />
47252
+ * </Record>
47253
+ * </Collection>
47254
+ * </Annotation>
46430
47255
  * </Annotations>
46431
47256
  * <Annotations Target="com.sap.gateway.default.iwbep.tea_busi_product.v0001.Product">
46432
- * <Annotation Term="com.sap.vocabularies.Common.v1.QuickInfo" Path="Name" />
47257
+ * <Annotation Term="com.sap.vocabularies.Common.v1.QuickInfo" Path="Name" />
46433
47258
  * </Annotations>
46434
47259
  * ```
46435
47260
  *
@@ -46443,16 +47268,16 @@ declare namespace sap {
46443
47268
  * ```javascript
46444
47269
  *
46445
47270
  * <Annotations Target="com.sap.gateway.default.iwbep.tea_busi.v0001.EQUIPMENT">
46446
- * <Annotation Term="com.sap.vocabularies.UI.v1.LineItem">
46447
- * <Collection>
46448
- * <Record Type="com.sap.vocabularies.UI.v1.DataField">
46449
- * <PropertyValue Property="Value" Path="EQUIPMENT_2_PRODUCT/Name" />
46450
- * </Record>
46451
- * </Collection>
46452
- * </Annotation>
47271
+ * <Annotation Term="com.sap.vocabularies.UI.v1.LineItem">
47272
+ * <Collection>
47273
+ * <Record Type="com.sap.vocabularies.UI.v1.DataField">
47274
+ * <PropertyValue Property="Value" Path="EQUIPMENT_2_PRODUCT/Name" />
47275
+ * </Record>
47276
+ * </Collection>
47277
+ * </Annotation>
46453
47278
  * </Annotations>
46454
47279
  * <Annotations Target="com.sap.gateway.default.iwbep.tea_busi_product.v0001.Product/Name">
46455
- * <Annotation Term="com.sap.vocabularies.Common.v1.QuickInfo" Path="PRODUCT_2_SUPPLIER/Supplier_Name" />
47280
+ * <Annotation Term="com.sap.vocabularies.Common.v1.QuickInfo" Path="PRODUCT_2_SUPPLIER/Supplier_Name" />
46456
47281
  * </Annotations>
46457
47282
  * ```
46458
47283
  *
@@ -46710,7 +47535,7 @@ declare namespace sap {
46710
47535
  */
46711
47536
  context: sap.ui.model.Context;
46712
47537
  }
46713
- ): string | Promise<any>;
47538
+ ): string | Promise<any> | undefined;
46714
47539
  /**
46715
47540
  * @SINCE 1.63.0
46716
47541
  *
@@ -47041,8 +47866,17 @@ declare namespace sap {
47041
47866
  * The group ID to be used for the DELETE request; if not specified, the update group ID for the context's
47042
47867
  * binding is used, see {@link #getUpdateGroupId}; the resulting group ID must not have {@link sap.ui.model.odata.v4.SubmitMode.API}.
47043
47868
  * Since 1.81, if this context is transient (see {@link #isTransient}), no group ID needs to be specified.
47869
+ * Since 1.98.0, you can use `null` to prevent the DELETE request in case of a kept-alive context that is
47870
+ * not in the collection and of which you know that it does not exist on the server anymore (for example,
47871
+ * a draft after activation).
47044
47872
  */
47045
- sGroupId?: string
47873
+ sGroupId?: string,
47874
+ /**
47875
+ * Whether not to request the new count from the server; useful in case of {@link #replaceWith} where it
47876
+ * is known that the count remains unchanged (since 1.97.0). Since 1.98.0, this is implied if a `null` group
47877
+ * ID is used.
47878
+ */
47879
+ bDoNotRequestCount?: boolean
47046
47880
  ): Promise<any>;
47047
47881
  /**
47048
47882
  * @SINCE 1.41.0
@@ -47107,6 +47941,8 @@ declare namespace sap {
47107
47941
  *
47108
47942
  * Returns `undefined` if the data is not (yet) available; no request is triggered. Use {@link #requestObject}
47109
47943
  * for asynchronous access.
47944
+ *
47945
+ * The header context of a list binding only delivers `$count` (wrapped in an object if `sPath` is "").
47110
47946
  * See:
47111
47947
  * sap.ui.model.Context#getObject
47112
47948
  */
@@ -47150,7 +47986,8 @@ declare namespace sap {
47150
47986
  *
47151
47987
  * Returns whether there are pending changes for bindings dependent on this context, or for unresolved bindings
47152
47988
  * (see {@link sap.ui.model.Binding#isResolved}) which were dependent on this context at the time the pending
47153
- * change was created. This includes the context itself being transient (see {@link #isTransient}).
47989
+ * change was created. This includes the context itself being {@link #isTransient transient}. Since 1.98.0,
47990
+ * {@link #isInactive inactive} contexts are ignored.
47154
47991
  */
47155
47992
  hasPendingChanges(): boolean;
47156
47993
  /**
@@ -47162,6 +47999,17 @@ declare namespace sap {
47162
47999
  * #expand
47163
48000
  */
47164
48001
  isExpanded(): boolean | undefined;
48002
+ /**
48003
+ * @SINCE 1.98.0
48004
+ *
48005
+ * Returns whether this context is inactive. The result of this function can also be accessed via instance
48006
+ * annotation "@$ui5.context.isInactive" at the entity.
48007
+ * See:
48008
+ * #isTransient
48009
+ * sap.ui.model.odata.v4.ODataListBinding#create
48010
+ * sap.ui.model.odata.v4.ODataListBinding#event:createActivate
48011
+ */
48012
+ isInactive(): boolean;
47165
48013
  /**
47166
48014
  * @SINCE 1.81.0
47167
48015
  *
@@ -47177,6 +48025,8 @@ declare namespace sap {
47177
48025
  * `true` if the context is transient, meaning that the promise returned by {@link #created} is not yet
47178
48026
  * resolved or rejected, and returns `false` if the context is not transient. The result of this function
47179
48027
  * can also be accessed via instance annotation "@$ui5.context.isTransient" at the entity.
48028
+ * See:
48029
+ * #isInactive
47180
48030
  */
47181
48031
  isTransient(): boolean;
47182
48032
  /**
@@ -47203,6 +48053,19 @@ declare namespace sap {
47203
48053
  */
47204
48054
  bAllowRemoval?: boolean
47205
48055
  ): void;
48056
+ /**
48057
+ * @SINCE 1.97.0
48058
+ *
48059
+ * Replaces this context with the given other context "in situ", that is, at the index it currently has
48060
+ * in its list binding's collection. You probably want to delete this context afterwards without requesting
48061
+ * the new count from the server, see the `bDoNotRequestCount` parameter of {@link #delete}.
48062
+ */
48063
+ replaceWith(
48064
+ /**
48065
+ * The other context
48066
+ */
48067
+ oOtherContext: sap.ui.model.odata.v4.Context
48068
+ ): void;
47206
48069
  /**
47207
48070
  * @SINCE 1.39.0
47208
48071
  *
@@ -47223,6 +48086,8 @@ declare namespace sap {
47223
48086
  * "OData JSON Format Version 4.0". Note that the function clones the result. Modify values via {@link
47224
48087
  * sap.ui.model.odata.v4.Context#setProperty}.
47225
48088
  *
48089
+ * The header context of a list binding only delivers `$count` (wrapped in an object if `sPath` is "").
48090
+ *
47226
48091
  * If you want {@link #requestObject} to read fresh data, call {@link #refresh} first.
47227
48092
  * See:
47228
48093
  * #getBinding
@@ -47342,6 +48207,12 @@ declare namespace sap {
47342
48207
  * Sets this context's `keepAlive` attribute. If `true` the context is kept alive even when it is removed
47343
48208
  * from its binding's collection, for example if a filter is applied and the entity represented by this
47344
48209
  * context does not match the filter criteria.
48210
+ *
48211
+ * Normally, a context's lifecycle is managed implicitly. It is created once it is needed and destroyed
48212
+ * if it is not needed anymore, for example, because it is no longer part of its list binding's collection.
48213
+ * It is thus unsafe to keep a reference to a context instance which is not explicitly kept alive. Once
48214
+ * a context is not kept alive anymore, the implicit lifecycle management again takes control and destroys
48215
+ * the context if it is no longer needed.
47345
48216
  * See:
47346
48217
  * #isKeepAlive
47347
48218
  */
@@ -47528,10 +48399,10 @@ declare namespace sap {
47528
48399
  *
47529
48400
  * Changes this binding's parameters and refreshes the binding.
47530
48401
  *
47531
- * If there are pending changes an error is thrown. Use {@link #hasPendingChanges} to check if there are
47532
- * pending changes. If there are changes, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit
47533
- * the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before calling
47534
- * {@link #changeParameters}.
48402
+ * If there are pending changes that cannot be ignored, an error is thrown. Use {@link #hasPendingChanges}
48403
+ * to check if there are such pending changes. If there are, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
48404
+ * to submit the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before
48405
+ * calling {@link #changeParameters}.
47535
48406
  *
47536
48407
  * The parameters are changed according to the given map of parameters: Parameters with an `undefined` value
47537
48408
  * are removed, the other parameters are set, and missing parameters remain unchanged.
@@ -47590,6 +48461,12 @@ declare namespace sap {
47590
48461
  * The value of this binding is the result of the operation. To access a result of primitive type, bind
47591
48462
  * a control to the path "value", for example `<Text text="{value}"/>`. If the result has a complex or
47592
48463
  * entity type, you can bind properties as usual, for example `<Text text="{street}"/>`.
48464
+ *
48465
+ * Since 1.98.0, a single-valued navigation property can be treated like a function if
48466
+ * it has the same type as the operation binding's parent context, that parent context is in the
48467
+ * collection (has an index, see {@link sap.ui.model.odata.v4.Context#getIndex}) of a list binding for a
48468
+ * top-level entity set, there is a navigation property binding which points to that same entity set,
48469
+ * no operation parameters have been set, the `bReplaceWithRVC` parameter is used.
47593
48470
  */
47594
48471
  execute(
47595
48472
  /**
@@ -47612,7 +48489,19 @@ declare namespace sap {
47612
48489
  * the bound action should either be repeated **without** applying the preference or rejected with an `Error`
47613
48490
  * instance `oError` where `oError.canceled === true`. Since 1.92.0.
47614
48491
  */
47615
- fnOnStrictHandlingFailed?: Function
48492
+ fnOnStrictHandlingFailed?: Function,
48493
+ /**
48494
+ * Whether this operation binding's parent context, which must belong to a list binding, is replaced with
48495
+ * the operation's return value context (see below) and that list context is returned instead. The list
48496
+ * context may be a newly created context or an existing context. A newly created context has the same `keepAlive`
48497
+ * attribute and `fnOnBeforeDestroy` function as the parent context, see {@link sap.ui.model.odata.v4.Context#setKeepAlive};
48498
+ * `fnOnBeforeDestroy` will be called with the new context instance as the only argument in this case. An
48499
+ * existing context does not change its `keepAlive` attribute. In any case, the resulting context takes
48500
+ * the place (index, position) of the parent context {@link sap.ui.model.odata.v4.Context#getIndex}. If
48501
+ * the parent context has requested messages when it was kept alive, they will be inherited if the $$inheritExpandSelect
48502
+ * binding parameter is set to `true`. Since 1.97.0.
48503
+ */
48504
+ bReplaceWithRVC?: boolean
47616
48505
  ): Promise<any>;
47617
48506
  /**
47618
48507
  * @SINCE 1.39.0
@@ -47645,7 +48534,8 @@ declare namespace sap {
47645
48534
  getRootBinding():
47646
48535
  | sap.ui.model.odata.v4.ODataContextBinding
47647
48536
  | sap.ui.model.odata.v4.ODataListBinding
47648
- | sap.ui.model.odata.v4.ODataPropertyBinding;
48537
+ | sap.ui.model.odata.v4.ODataPropertyBinding
48538
+ | undefined;
47649
48539
  /**
47650
48540
  * @SINCE 1.81.0
47651
48541
  *
@@ -47662,13 +48552,25 @@ declare namespace sap {
47662
48552
  * Returns `true` if this binding or its dependent bindings have pending property changes or created entities
47663
48553
  * which have not been sent successfully to the server. This function does not take into account the deletion
47664
48554
  * of entities (see {@link sap.ui.model.odata.v4.Context#delete}) and the execution of OData operations
47665
- * (see {@link sap.ui.model.odata.v4.ODataContextBinding#execute}).
48555
+ * (see {@link sap.ui.model.odata.v4.ODataContextBinding#execute}). Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isInactive
48556
+ * inactive} contexts are ignored.
47666
48557
  *
47667
48558
  * Note: If this binding is relative, its data is cached separately for each parent context path. This method
47668
48559
  * returns `true` if there are pending changes for the current parent context path of this binding. If this
47669
48560
  * binding is unresolved (see {@link sap.ui.model.Binding#isResolved}), it returns `false`.
47670
48561
  */
47671
- hasPendingChanges(): boolean;
48562
+ hasPendingChanges(
48563
+ /**
48564
+ * Whether to ignore changes which will not be lost by APIs like {@link sap.ui.model.odata.v4.ODataListBinding#changeParameters
48565
+ * changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#sort
48566
+ * sort}, or {@link sap.ui.model.odata.v4.ODataListBinding#suspend suspend} because they relate to a {@link
48567
+ * sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context of this binding. Since 1.98.0, {@link
48568
+ * sap.ui.model.odata.v4.Context#isTransient transient} contexts of a {@link #getRootBinding root binding}
48569
+ * are treated as kept-alive by this flag. Since 1.99.0, the same happens for bindings using the `$$ownRequest`
48570
+ * parameter (see {@link sap.ui.model.odata.v4.ODataModel#bindList}).
48571
+ */
48572
+ bIgnoreKeptAlive?: boolean
48573
+ ): boolean;
47672
48574
  /**
47673
48575
  * @SINCE 1.37.0
47674
48576
  *
@@ -47684,21 +48586,6 @@ declare namespace sap {
47684
48586
  * Method not supported
47685
48587
  */
47686
48588
  isInitial(): boolean;
47687
- /**
47688
- * @SINCE 1.95.0
47689
- * @deprecated (since 1.96.5)
47690
- * @EXPERIMENTAL
47691
- *
47692
- * Moves the bound entity into the given list binding. This binding loses its data. The method may only
47693
- * be called when this binding has finished loading. You can verify this by calling `oBinding.getBoundContext().requestObject()`.
47694
- * If that promise resolves, the binding has finished loading.
47695
- */
47696
- moveEntityTo(
47697
- /**
47698
- * The list binding to take the entity
47699
- */
47700
- oListBinding: sap.ui.model.odata.v4.ODataListBinding
47701
- ): void;
47702
48589
  /**
47703
48590
  * @SINCE 1.37.0
47704
48591
  *
@@ -47803,7 +48690,9 @@ declare namespace sap {
47803
48690
  *
47804
48691
  * Suspends this binding. A suspended binding does not fire change events nor does it trigger data service
47805
48692
  * requests. Call {@link #resume} to resume the binding. Before 1.53.0, this method was not supported and
47806
- * threw an error.
48693
+ * threw an error. Since 1.97.0, pending changes are ignored if they relate to a {@link sap.ui.model.odata.v4.Context#setKeepAlive
48694
+ * kept-alive} context of this binding. Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isTransient transient}
48695
+ * contexts of a {@link #getRootBinding root binding} do not count as pending changes.
47807
48696
  * See:
47808
48697
  * {@link topic:b0f5c531e5034a27952cc748954cbe39 Suspend and Resume}
47809
48698
  * sap.ui.model.Binding#suspend
@@ -47824,8 +48713,9 @@ declare namespace sap {
47824
48713
  * @SINCE 1.37.0
47825
48714
  *
47826
48715
  * List binding for an OData V4 model. An event handler can only be attached to this binding for the following
47827
- * events: 'AggregatedDataStateChange', 'change', 'createCompleted', 'createSent', 'dataReceived', 'dataRequested',
47828
- * 'DataStateChange', 'patchCompleted', 'patchSent', and 'refresh'. For other events, an error is thrown.
48716
+ * events: 'AggregatedDataStateChange', 'change', 'createActivate', 'createCompleted', 'createSent', 'dataReceived',
48717
+ * 'dataRequested', 'DataStateChange', 'patchCompleted', 'patchSent', and 'refresh'. For other events, an
48718
+ * error is thrown.
47829
48719
  */
47830
48720
  class ODataListBinding extends sap.ui.model.ListBinding {
47831
48721
  constructor();
@@ -47858,6 +48748,21 @@ declare namespace sap {
47858
48748
  * Returns a metadata object for class sap.ui.model.odata.v4.ODataListBinding.
47859
48749
  */
47860
48750
  static getMetadata(): sap.ui.base.Metadata;
48751
+ /**
48752
+ * @SINCE 1.98.0
48753
+ *
48754
+ * Attach event handler `fnFunction` to the 'createActivate' event of this binding.
48755
+ */
48756
+ attachCreateActivate(
48757
+ /**
48758
+ * The function to call when the event occurs
48759
+ */
48760
+ fnFunction: Function,
48761
+ /**
48762
+ * Object on which to call the given function
48763
+ */
48764
+ oListener?: object
48765
+ ): void;
47861
48766
  /**
47862
48767
  * @SINCE 1.66.0
47863
48768
  *
@@ -47942,10 +48847,10 @@ declare namespace sap {
47942
48847
  *
47943
48848
  * Changes this binding's parameters and refreshes the binding.
47944
48849
  *
47945
- * If there are pending changes an error is thrown. Use {@link #hasPendingChanges} to check if there are
47946
- * pending changes. If there are changes, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit
47947
- * the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before calling
47948
- * {@link #changeParameters}.
48850
+ * If there are pending changes that cannot be ignored, an error is thrown. Use {@link #hasPendingChanges}
48851
+ * to check if there are such pending changes. If there are, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
48852
+ * to submit the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before
48853
+ * calling {@link #changeParameters}.
47949
48854
  *
47950
48855
  * The parameters are changed according to the given map of parameters: Parameters with an `undefined` value
47951
48856
  * are removed, the other parameters are set, and missing parameters remain unchanged.
@@ -47964,9 +48869,9 @@ declare namespace sap {
47964
48869
  * For creating the new entity, the binding's update group ID is used, see {@link #getUpdateGroupId}.
47965
48870
  *
47966
48871
  * You can call {@link sap.ui.model.odata.v4.Context#delete} to delete the created context again. As long
47967
- * as the context is transient (see {@link sap.ui.model.odata.v4.Context#isTransient}), {@link #resetChanges}
47968
- * and a call to {@link sap.ui.model.odata.v4.ODataModel#resetChanges} with the update group ID as parameter
47969
- * also delete the created context together with other changes.
48872
+ * as the context is {@link sap.ui.model.odata.v4.Context#isTransient transient} and {@link sap.ui.model.odata.v4.Context#isInactive
48873
+ * active}, {@link #resetChanges} and a call to {@link sap.ui.model.odata.v4.ODataModel#resetChanges} with
48874
+ * the update group ID as parameter also delete the created context together with other changes.
47970
48875
  *
47971
48876
  * If the creation of the entity on the server failed, the creation is repeated automatically. If the binding's
47972
48877
  * update group ID has {@link sap.ui.model.odata.v4.SubmitMode.API}, it is repeated with the next call of
@@ -48012,10 +48917,21 @@ declare namespace sap {
48012
48917
  */
48013
48918
  bSkipRefresh?: boolean,
48014
48919
  /**
48015
- * Whether the entity is inserted at the end of the list. When creating multiple entities, this parameter
48016
- * must have the same value for each entity. Supported since 1.66.0
48920
+ * Whether the entity is inserted at the end of the list. Supported since 1.66.0. Since 1.99.0 the first
48921
+ * insertion determines the overall position of created contexts within the binding's context list. Every
48922
+ * succeeding insertion is relative to the created contexts within this list.
48923
+ */
48924
+ bAtEnd?: boolean,
48925
+ /**
48926
+ * Create an inactive context. Such a context will only be sent to the server after the first property update.
48927
+ * From then on it behaves like any other created context. This parameter is experimental and its implementation
48928
+ * may still change. Do not use it in productive code yet. Supported since 1.97.0 Since 1.98.0, when
48929
+ * the first property updates happens, the context is no longer {@link sap.ui.model.odata.v4.Context#isInactive
48930
+ * inactive} and the {@link sap.ui.model.odata.v4.ODataListBinding#event:createActivate createActivate}
48931
+ * event is fired. While inactive, it does not count as a {@link #hasPendingChanges pending change} and
48932
+ * does not contribute to the {@link #getCount count}.
48017
48933
  */
48018
- bAtEnd?: boolean
48934
+ bInactive?: boolean
48019
48935
  ): sap.ui.model.odata.v4.Context;
48020
48936
  /**
48021
48937
  * @SINCE 1.40.1
@@ -48025,6 +48941,21 @@ declare namespace sap {
48025
48941
  * sap.ui.model.Binding#destroy
48026
48942
  */
48027
48943
  destroy(): void;
48944
+ /**
48945
+ * @SINCE 1.98.0
48946
+ *
48947
+ * Detach event handler `fnFunction` from the 'createActivate' event of this binding.
48948
+ */
48949
+ detachCreateActivate(
48950
+ /**
48951
+ * The function to call when the event occurs
48952
+ */
48953
+ fnFunction: Function,
48954
+ /**
48955
+ * Object on which to call the given function
48956
+ */
48957
+ oListener?: object
48958
+ ): void;
48028
48959
  /**
48029
48960
  * @SINCE 1.66.0
48030
48961
  *
@@ -48088,12 +49019,13 @@ declare namespace sap {
48088
49019
  /**
48089
49020
  * @SINCE 1.39.0
48090
49021
  *
48091
- * Filters the list with the given filters.
49022
+ * Filters the list with the given filters. Since 1.97.0, if filters are unchanged, no request is sent,
49023
+ * regardless of pending changes.
48092
49024
  *
48093
- * If there are pending changes an error is thrown. Use {@link #hasPendingChanges} to check if there are
48094
- * pending changes. If there are changes, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit
48095
- * the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before calling
48096
- * {@link #filter}.
49025
+ * If there are pending changes that cannot be ignored, an error is thrown. Use {@link #hasPendingChanges}
49026
+ * to check if there are such pending changes. If there are, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
49027
+ * to submit the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before
49028
+ * calling {@link #filter}.
48097
49029
  *
48098
49030
  * Filters are case sensitive unless the property `caseSensitive` is set to `false`. This property has to
48099
49031
  * be set on each filter, it is not inherited from a multi-filter.
@@ -48128,6 +49060,17 @@ declare namespace sap {
48128
49060
  */
48129
49061
  sFilterType?: sap.ui.model.FilterType
48130
49062
  ): this;
49063
+ /**
49064
+ * @SINCE 1.98.0
49065
+ *
49066
+ * Returns all current contexts of this list binding in no special order. Just like {@link #getCurrentContexts},
49067
+ * this method does not request any data from a back end and does not change the binding's state. In contrast
49068
+ * to {@link #getCurrentContexts}, it does not only return those contexts that were last requested by a
49069
+ * control, but all contexts that are currently available in the binding, including kept-alive contexts.
49070
+ * To filter out kept-alive contexts that are not part of the list, you could check whether the index is
49071
+ * `undefined`, as described in {@link sap.ui.model.odata.v4.Context#getIndex}.
49072
+ */
49073
+ getAllCurrentContexts(): sap.ui.model.odata.v4.Context[];
48131
49074
  /**
48132
49075
  * @SINCE 1.37.0
48133
49076
  *
@@ -48165,7 +49108,8 @@ declare namespace sap {
48165
49108
  * Returns the count of elements.
48166
49109
  *
48167
49110
  * If known, the value represents the sum of the element count of the collection on the server and the number
48168
- * of transient entities created on the client. Otherwise, it is `undefined`. The value is a number of type
49111
+ * of {@link sap.ui.model.odata.v4.Context#isInactive active} {@link sap.ui.model.odata.v4.Context#isTransient
49112
+ * transient} entities created on the client. Otherwise, it is `undefined`. The value is a number of type
48169
49113
  * `Edm.Int64`. Since 1.91.0, in case of data aggregation with group levels, the count is the leaf count
48170
49114
  * on the server; it is only determined if the `$count` system query option is given.
48171
49115
  *
@@ -48234,6 +49178,24 @@ declare namespace sap {
48234
49178
  * #getCount
48235
49179
  */
48236
49180
  getHeaderContext(): sap.ui.model.odata.v4.Context;
49181
+ /**
49182
+ * @SINCE 1.99.0
49183
+ *
49184
+ * Calls {@link sap.ui.model.odata.v4.Context#setKeepAlive} at the context for the given path and returns
49185
+ * it.
49186
+ * See:
49187
+ * sap.ui.model.odata.v4.Model#getKeepAliveContext
49188
+ */
49189
+ getKeepAliveContext(
49190
+ /**
49191
+ * The path of the context to be kept alive
49192
+ */
49193
+ sPath: string,
49194
+ /**
49195
+ * Whether to request messages for the context's entity
49196
+ */
49197
+ bRequestMessages?: boolean
49198
+ ): sap.ui.model.odata.v4.Context | undefined;
48237
49199
  /**
48238
49200
  * @SINCE 1.37.0
48239
49201
  *
@@ -48263,7 +49225,8 @@ declare namespace sap {
48263
49225
  getRootBinding():
48264
49226
  | sap.ui.model.odata.v4.ODataContextBinding
48265
49227
  | sap.ui.model.odata.v4.ODataListBinding
48266
- | sap.ui.model.odata.v4.ODataPropertyBinding;
49228
+ | sap.ui.model.odata.v4.ODataPropertyBinding
49229
+ | undefined;
48267
49230
  /**
48268
49231
  * @SINCE 1.81.0
48269
49232
  *
@@ -48280,13 +49243,25 @@ declare namespace sap {
48280
49243
  * Returns `true` if this binding or its dependent bindings have pending property changes or created entities
48281
49244
  * which have not been sent successfully to the server. This function does not take into account the deletion
48282
49245
  * of entities (see {@link sap.ui.model.odata.v4.Context#delete}) and the execution of OData operations
48283
- * (see {@link sap.ui.model.odata.v4.ODataContextBinding#execute}).
49246
+ * (see {@link sap.ui.model.odata.v4.ODataContextBinding#execute}). Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isInactive
49247
+ * inactive} contexts are ignored.
48284
49248
  *
48285
49249
  * Note: If this binding is relative, its data is cached separately for each parent context path. This method
48286
49250
  * returns `true` if there are pending changes for the current parent context path of this binding. If this
48287
49251
  * binding is unresolved (see {@link sap.ui.model.Binding#isResolved}), it returns `false`.
48288
49252
  */
48289
- hasPendingChanges(): boolean;
49253
+ hasPendingChanges(
49254
+ /**
49255
+ * Whether to ignore changes which will not be lost by APIs like {@link sap.ui.model.odata.v4.ODataListBinding#changeParameters
49256
+ * changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#sort
49257
+ * sort}, or {@link sap.ui.model.odata.v4.ODataListBinding#suspend suspend} because they relate to a {@link
49258
+ * sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context of this binding. Since 1.98.0, {@link
49259
+ * sap.ui.model.odata.v4.Context#isTransient transient} contexts of a {@link #getRootBinding root binding}
49260
+ * are treated as kept-alive by this flag. Since 1.99.0, the same happens for bindings using the `$$ownRequest`
49261
+ * parameter (see {@link sap.ui.model.odata.v4.ODataModel#bindList}).
49262
+ */
49263
+ bIgnoreKeptAlive?: boolean
49264
+ ): boolean;
48290
49265
  /**
48291
49266
  * @SINCE 1.37.0
48292
49267
  *
@@ -48297,6 +49272,13 @@ declare namespace sap {
48297
49272
  * #getRootBinding
48298
49273
  */
48299
49274
  initialize(): void;
49275
+ /**
49276
+ * @SINCE 1.99.0
49277
+ *
49278
+ * Returns whether the overall position of created entries is at the end of the list; this is determined
49279
+ * by the first call to {@link #create}.
49280
+ */
49281
+ isFirstCreateAtEnd(): boolean | undefined;
48300
49282
  /**
48301
49283
  * @SINCE 1.37.0
48302
49284
  *
@@ -48508,12 +49490,13 @@ declare namespace sap {
48508
49490
  * @SINCE 1.39.0
48509
49491
  *
48510
49492
  * Sort the entries represented by this list binding according to the given sorters. The sorters are stored
48511
- * at this list binding and they are used for each following data request.
49493
+ * at this list binding and they are used for each following data request. Since 1.97.0, if sorters are
49494
+ * unchanged, no request is sent, regardless of pending changes.
48512
49495
  *
48513
- * If there are pending changes an error is thrown. Use {@link #hasPendingChanges} to check if there are
48514
- * pending changes. If there are changes, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit
48515
- * the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before calling
48516
- * {@link #sort}.
49496
+ * If there are pending changes that cannot be ignored, an error is thrown. Use {@link #hasPendingChanges}
49497
+ * to check if there are such pending changes. If there are, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
49498
+ * to submit the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before
49499
+ * calling {@link #sort}.
48517
49500
  * See:
48518
49501
  * sap.ui.model.ListBinding#sort
48519
49502
  */
@@ -48530,7 +49513,9 @@ declare namespace sap {
48530
49513
  *
48531
49514
  * Suspends this binding. A suspended binding does not fire change events nor does it trigger data service
48532
49515
  * requests. Call {@link #resume} to resume the binding. Before 1.53.0, this method was not supported and
48533
- * threw an error.
49516
+ * threw an error. Since 1.97.0, pending changes are ignored if they relate to a {@link sap.ui.model.odata.v4.Context#setKeepAlive
49517
+ * kept-alive} context of this binding. Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isTransient transient}
49518
+ * contexts of a {@link #getRootBinding root binding} do not count as pending changes.
48534
49519
  * See:
48535
49520
  * {@link topic:b0f5c531e5034a27952cc748954cbe39 Suspend and Resume}
48536
49521
  * sap.ui.model.Binding#suspend
@@ -48608,7 +49593,7 @@ declare namespace sap {
48608
49593
  */
48609
49594
  as?: string;
48610
49595
  }>
48611
- ): object;
49596
+ ): object | undefined;
48612
49597
  }
48613
49598
  /**
48614
49599
  * @SINCE 1.37.0
@@ -48776,7 +49761,7 @@ declare namespace sap {
48776
49761
  * See:
48777
49762
  * #requestData
48778
49763
  */
48779
- getData(): object;
49764
+ getData(): object | undefined;
48780
49765
  /**
48781
49766
  * @SINCE 1.51.0
48782
49767
  *
@@ -49354,7 +50339,7 @@ declare namespace sap {
49354
50339
  */
49355
50340
  synchronizationMode: string;
49356
50341
  /**
49357
- * The group ID that is used for update requests. If no update group ID is specified, ` mParameters.groupId`
50342
+ * The group ID that is used for update requests. If no update group ID is specified, `mParameters.groupId`
49358
50343
  * is used. Valid update group IDs are `undefined`, '$auto', '$direct' or an application group ID.
49359
50344
  */
49360
50345
  updateGroupId?: string;
@@ -49535,6 +50520,11 @@ declare namespace sap {
49535
50520
  * from its context's path for data service requests; only the value `true` is allowed.
49536
50521
  */
49537
50522
  $$canonicalPath?: boolean;
50523
+ /**
50524
+ * Whether this binding is considered for a match when {@link #getKeepAliveContext} is called; only the
50525
+ * value `true` is allowed. Supported since 1.99.0
50526
+ */
50527
+ $$getKeepAliveContext?: boolean;
49538
50528
  /**
49539
50529
  * The group ID to be used for **read** requests triggered by this binding; if not specified, either the
49540
50530
  * parent binding's group ID (if the binding is relative) or the model's group ID is used, see {@link sap.ui.model.odata.v4.ODataModel#constructor}.
@@ -49792,6 +50782,25 @@ declare namespace sap {
49792
50782
  */
49793
50783
  bIncludeContextId?: boolean
49794
50784
  ): object;
50785
+ /**
50786
+ * @SINCE 1.99.0
50787
+ *
50788
+ * Returns a context with the given path belonging to a matching list binding that has been marked with
50789
+ * `$$getKeepAliveContext` (see {@link #bindList}). If such a context exists, it is returned and kept alive
50790
+ * (see {@link sap.ui.model.odata.v4.Context#setKeepAlive}).
50791
+ * See:
50792
+ * sap.ui.model.odata.v4.ODataListBinding#getKeepAliveContext
50793
+ */
50794
+ getKeepAliveContext(
50795
+ /**
50796
+ * A list context path to an entity
50797
+ */
50798
+ sPath: string,
50799
+ /**
50800
+ * Whether to request messages for the context's entity
50801
+ */
50802
+ bRequestMessages?: boolean
50803
+ ): sap.ui.model.odata.v4.Context | undefined;
49795
50804
  /**
49796
50805
  * @SINCE 1.85.0
49797
50806
  *
@@ -49852,7 +50861,8 @@ declare namespace sap {
49852
50861
  * @SINCE 1.39.0
49853
50862
  *
49854
50863
  * Returns `true` if there are pending changes, meaning updates or created entities (see {@link sap.ui.model.odata.v4.ODataListBinding#create})
49855
- * that have not yet been successfully sent to the server.
50864
+ * that have not yet been successfully sent to the server. Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isInactive
50865
+ * inactive} contexts are ignored.
49856
50866
  */
49857
50867
  hasPendingChanges(
49858
50868
  /**
@@ -50033,7 +51043,8 @@ declare namespace sap {
50033
51043
  getRootBinding():
50034
51044
  | sap.ui.model.odata.v4.ODataContextBinding
50035
51045
  | sap.ui.model.odata.v4.ODataListBinding
50036
- | sap.ui.model.odata.v4.ODataPropertyBinding;
51046
+ | sap.ui.model.odata.v4.ODataPropertyBinding
51047
+ | undefined;
50037
51048
  /**
50038
51049
  * @SINCE 1.81.0
50039
51050
  *
@@ -50064,13 +51075,25 @@ declare namespace sap {
50064
51075
  * Returns `true` if this binding or its dependent bindings have pending property changes or created entities
50065
51076
  * which have not been sent successfully to the server. This function does not take into account the deletion
50066
51077
  * of entities (see {@link sap.ui.model.odata.v4.Context#delete}) and the execution of OData operations
50067
- * (see {@link sap.ui.model.odata.v4.ODataContextBinding#execute}).
51078
+ * (see {@link sap.ui.model.odata.v4.ODataContextBinding#execute}). Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isInactive
51079
+ * inactive} contexts are ignored.
50068
51080
  *
50069
51081
  * Note: If this binding is relative, its data is cached separately for each parent context path. This method
50070
51082
  * returns `true` if there are pending changes for the current parent context path of this binding. If this
50071
51083
  * binding is unresolved (see {@link sap.ui.model.Binding#isResolved}), it returns `false`.
50072
51084
  */
50073
- hasPendingChanges(): boolean;
51085
+ hasPendingChanges(
51086
+ /**
51087
+ * Whether to ignore changes which will not be lost by APIs like {@link sap.ui.model.odata.v4.ODataListBinding#changeParameters
51088
+ * changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#sort
51089
+ * sort}, or {@link sap.ui.model.odata.v4.ODataListBinding#suspend suspend} because they relate to a {@link
51090
+ * sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context of this binding. Since 1.98.0, {@link
51091
+ * sap.ui.model.odata.v4.Context#isTransient transient} contexts of a {@link #getRootBinding root binding}
51092
+ * are treated as kept-alive by this flag. Since 1.99.0, the same happens for bindings using the `$$ownRequest`
51093
+ * parameter (see {@link sap.ui.model.odata.v4.ODataModel#bindList}).
51094
+ */
51095
+ bIgnoreKeptAlive?: boolean
51096
+ ): boolean;
50074
51097
  /**
50075
51098
  * @SINCE 1.37.0
50076
51099
  *
@@ -50288,7 +51311,7 @@ declare namespace sap {
50288
51311
  * views, e.g. `<template:with path="meta>Value" helper="sap.ui.model.odata.AnnotationHelper.resolvePath"
50289
51312
  * var="target">`.
50290
51313
  *
50291
- * Since 1.31.0, you DO NOT need to {@link jQuery.sap.require} this module before use.
51314
+ * Since 1.31.0, you DO NOT need to {@link sap.ui.require} this module before use.
50292
51315
  */
50293
51316
  interface AnnotationHelper {
50294
51317
  /**
@@ -50322,7 +51345,7 @@ declare namespace sap {
50322
51345
  * ```javascript
50323
51346
  *
50324
51347
  * function myRootFormatter(oValue1, oValue2, sFullName, sGreeting, iAnswer) {
50325
- * return ...; //TODO compute something useful from the given values
51348
+ * return ...;
50326
51349
  * }
50327
51350
  *
50328
51351
  * oSupplierContext = oMetaModel.getMetaContext("/ProductSet('HT-1021')/ToSupplier");
@@ -51123,7 +52146,7 @@ declare namespace sap {
51123
52146
  /**
51124
52147
  * Filters the list.
51125
52148
  *
51126
- * When using sap.ui.model.Filter the filters are first grouped according to their binding path. All filters
52149
+ * When using `sap.ui.model.Filter` the filters are first grouped according to their binding path. All filters
51127
52150
  * belonging to a group are combined with OR and after that the results of all groups are combined with
51128
52151
  * AND. Usually this means, all filters applied to a single table column are combined with OR, while filters
51129
52152
  * on different table columns are combined with AND. Please note that a custom filter function is not supported.
@@ -51136,21 +52159,28 @@ declare namespace sap {
51136
52159
  /**
51137
52160
  * Type of the filter which should be adjusted, if it is not given, the standard behaviour applies
51138
52161
  */
51139
- sFilterType: sap.ui.model.FilterType
52162
+ sFilterType: sap.ui.model.FilterType,
52163
+ /**
52164
+ * Whether to return `true` or `false`, instead of `this`, depending on whether the filtering has been done
52165
+ */
52166
+ bReturnSuccess?: boolean
51140
52167
  ): this;
51141
52168
  /**
51142
52169
  * Return contexts for the list
51143
52170
  */
51144
52171
  getContexts(
51145
52172
  /**
51146
- * the start index of the requested contexts
52173
+ * The start index of the requested contexts
51147
52174
  */
51148
52175
  iStartIndex?: int,
51149
52176
  /**
51150
- * the requested amount of contexts
52177
+ * The requested amount of contexts
51151
52178
  */
51152
52179
  iLength?: int,
51153
-
52180
+ /**
52181
+ * The maximum number of contexts to read before and after the given range; with this, controls can prefetch
52182
+ * data that is likely to be needed soon, e.g. when scrolling down in a table
52183
+ */
51154
52184
  iThreshold?: int
51155
52185
  ): sap.ui.model.Context[];
51156
52186
  /**
@@ -51179,16 +52209,28 @@ declare namespace sap {
51179
52209
  /**
51180
52210
  * Update the bound control even if no data has been changed
51181
52211
  */
51182
- bForceUpdate?: boolean
52212
+ bForceUpdate?: boolean,
52213
+ /**
52214
+ * A map of changed entities
52215
+ */
52216
+ mChangedEntities?: object,
52217
+ /**
52218
+ * A map of entity types
52219
+ */
52220
+ mEntityTypes?: object
51183
52221
  ): void;
51184
52222
  /**
51185
52223
  * Sorts the list.
51186
52224
  */
51187
52225
  sort(
51188
52226
  /**
51189
- * the Sorter or an array of sorter objects object which define the sort order
52227
+ * The Sorter or an array of sorter objects which define the sort order
51190
52228
  */
51191
- aSorters: sap.ui.model.Sorter | any[]
52229
+ aSorters: sap.ui.model.Sorter | sap.ui.model.Sorter[],
52230
+ /**
52231
+ * Whether to return `true` or `false`, instead of `this`, depending on whether the sorting has been done
52232
+ */
52233
+ bReturnSuccess?: boolean
51192
52234
  ): this;
51193
52235
  }
51194
52236
  /**
@@ -52034,19 +53076,18 @@ declare namespace sap {
52034
53076
  bSuppressEvents?: boolean
52035
53077
  ): Promise<any>;
52036
53078
  /**
52037
- * Appends the change batch operations to the end of the batch stack. Only PUT, POST or DELETE batch operations
52038
- * should be included in the specified array. The operations in the array will be included in a single changeset.
52039
- * To embed change operations in different change sets call this method with the corresponding change operations
52040
- * again. If an illegal batch operation is added to the change set nothing will be performed and false will
52041
- * be returned.
53079
+ * Appends the change batch operations to the end of the batch stack. Only `PUTPOST` or `DELETE`
53080
+ * batch operations should be included in the specified array. The operations in the array will be included
53081
+ * in a single changeset. To embed change operations in different change sets call this method with the
53082
+ * corresponding change operations again. If an illegal batch operation is added to the change set nothing
53083
+ * will be performed and false will be returned.
52042
53084
  */
52043
53085
  addBatchChangeOperations(
52044
53086
  /**
52045
- * an array of change batch operations created via `createBatchOperation` and `sMethod` = POST, PUT, MERGE
52046
- * or DELETE
53087
+ * An array of change batch operations created via `createBatchOperation` with parameter `sMethod = "POST"/"PUT"/"MERGE"/"DELETE"`
52047
53088
  */
52048
53089
  aChangeOperations: any[]
52049
- ): void;
53090
+ ): false | undefined;
52050
53091
  /**
52051
53092
  * Appends the read batch operations to the end of the batch stack. Only GET batch operations should be
52052
53093
  * included in the specified array. If an illegal batch operation is added to the batch nothing will be
@@ -52054,10 +53095,10 @@ declare namespace sap {
52054
53095
  */
52055
53096
  addBatchReadOperations(
52056
53097
  /**
52057
- * an array of read batch operations created via `createBatchOperation` and `sMethod` = GET
53098
+ * An array of read batch operations created via `createBatchOperation` with `sMethod = "GET"`
52058
53099
  */
52059
53100
  aReadOperations: any[]
52060
- ): void;
53101
+ ): false | undefined;
52061
53102
  /**
52062
53103
  * Attaches event handler `fnFunction` to the {@link #event:annotationsFailed annotationsFailed} event of
52063
53104
  * this `sap.ui.model.odata.ODataModel`.
@@ -52333,29 +53374,29 @@ declare namespace sap {
52333
53374
  */
52334
53375
  createBatchOperation(
52335
53376
  /**
52336
- * A string containing the path to the collection or entry where the batch operation should be performed.
52337
- * The path is concatenated to the sServiceUrl which was specified in the model constructor.
53377
+ * A string containing the path to the collection or entry where the batch operation should be performed;
53378
+ * the path is concatenated to the `sServiceUrl` which was specified in the model constructor
52338
53379
  */
52339
53380
  sPath: string,
52340
53381
  /**
52341
- * for the batch operation. Possible values are GET, PUT, MERGE, POST, DELETE
53382
+ * For the batch operation; possible values are `GET`, `PUT`, `MERGE`, `POST` or `DELETE`
52342
53383
  */
52343
53384
  sMethod: string,
52344
53385
  /**
52345
- * optional data payload which should be created, updated, deleted in a change batch operation.
53386
+ * Optional data payload which should be created, updated, deleted in a change batch operation
52346
53387
  */
52347
53388
  oData?: object,
52348
53389
  /**
52349
- * optional parameter for additional information introduced in SAPUI5 1.9.1,
53390
+ * Optional parameter for additional information introduced in SAPUI5 1.9.1
52350
53391
  */
52351
53392
  oParameters?: {
52352
53393
  /**
52353
- * an ETag which can be used for concurrency control. If it is specified, it will be used in an If-Match-Header
53394
+ * An ETag which can be used for concurrency control. If it is specified, it will be used in an If-Match-Header
52354
53395
  * in the request to the server for this entry.
52355
53396
  */
52356
53397
  sETag?: string;
52357
53398
  }
52358
- ): void;
53399
+ ): object;
52359
53400
  /**
52360
53401
  * Creates a new entry object which is described by the metadata of the entity type of the specified sPath
52361
53402
  * Name. A context object is returned which can be used to bind against the newly created object.
@@ -52386,7 +53427,7 @@ declare namespace sap {
52386
53427
  vProperties: any[] | object
52387
53428
  ): sap.ui.model.Context;
52388
53429
  /**
52389
- * Creates the key from the given collection name and property map
53430
+ * Creates the key from the given collection name and property map.
52390
53431
  */
52391
53432
  createKey(
52392
53433
  /**
@@ -52396,12 +53437,12 @@ declare namespace sap {
52396
53437
  /**
52397
53438
  * The object containing at least all the key properties of the entity type
52398
53439
  */
52399
- oKeyParameters: object,
53440
+ oKeyProperties: object,
52400
53441
  /**
52401
53442
  * Whether the URI decoding should be applied on the key
52402
53443
  */
52403
53444
  bDecode: boolean
52404
- ): void;
53445
+ ): string;
52405
53446
  /**
52406
53447
  * Deletes a created entry from the request queue and the model.
52407
53448
  */
@@ -52577,19 +53618,19 @@ declare namespace sap {
52577
53618
  */
52578
53619
  getData(
52579
53620
  /**
52580
- * A string containing the path to the data object that should be returned.
53621
+ * A string containing the path to the data object that should be returned
52581
53622
  */
52582
53623
  sPath: string,
52583
53624
  /**
52584
- * the optional context which is used with the sPath to retrieve the requested data.
53625
+ * The optional context which is used with the sPath to retrieve the requested data
52585
53626
  */
52586
53627
  oContext?: object,
52587
53628
  /**
52588
- * This parameter should be set when a URI or custom parameter with a $expand System Query Option was used
52589
- * to retrieve associated entries embedded/inline. If true then the getProperty function returns a desired
52590
- * property value/entry and includes the associated expand entries (if any). If false the associated/expanded
52591
- * entry properties are removed and not included in the desired entry as properties at all. This is useful
52592
- * for performing updates on the base entry only. Note: A copy and not a reference of the entry will be
53629
+ * This parameter should be set when a URI or custom parameter with a `$expand` System Query Option was
53630
+ * used to retrieve associated entries embedded/inline; if true then the `getProperty` function returns
53631
+ * a desired property value/entry and includes the associated expand entries (if any); if false the associated/expanded
53632
+ * entry properties are removed and not included in the desired entry as properties at all; this is useful
53633
+ * for performing updates on the base entry only; note: A copy and not a reference of the entry will be
52593
53634
  * returned.
52594
53635
  */
52595
53636
  bIncludeExpandEntries?: boolean
@@ -52597,7 +53638,7 @@ declare namespace sap {
52597
53638
  /**
52598
53639
  * @SINCE 1.20
52599
53640
  *
52600
- * Returns the default count mode for retrieving the count of collections
53641
+ * Returns the default count mode for retrieving the count of collections.
52601
53642
  */
52602
53643
  getDefaultCountMode(): sap.ui.model.odata.CountMode;
52603
53644
  /**
@@ -52605,7 +53646,7 @@ declare namespace sap {
52605
53646
  */
52606
53647
  getHeaders(): object;
52607
53648
  /**
52608
- * Returns the key part from the entry URI or the given context or object
53649
+ * Returns the key part from the entry URI or the given context or object.
52609
53650
  */
52610
53651
  getKey(
52611
53652
  /**
@@ -52616,7 +53657,7 @@ declare namespace sap {
52616
53657
  * Whether the URI decoding should be applied on the key
52617
53658
  */
52618
53659
  bDecode: boolean
52619
- ): void;
53660
+ ): string;
52620
53661
  /**
52621
53662
  * Returns an instance of an OData meta model which offers a unified access to both OData V2 metadata and
52622
53663
  * V4 annotations. It uses the existing {@link sap.ui.model.odata.ODataMetadata} as a foundation and merges
@@ -52629,47 +53670,47 @@ declare namespace sap {
52629
53670
  getMetaModel(): sap.ui.model.odata.ODataMetaModel;
52630
53671
  /**
52631
53672
  * Returns the value for the property with the given `sPath`. If the path points to a navigation property
52632
- * which has been loaded via $expand then the `bIncludeExpandEntries` parameter determines if the navigation
53673
+ * which has been loaded via `$expand` then the `bIncludeExpandEntries` parameter determines if the navigation
52633
53674
  * property should be included in the returned value or not. Please note that this currently works for 1..1
52634
53675
  * navigation properties only.
52635
53676
  */
52636
53677
  getProperty(
52637
53678
  /**
52638
- * the path/name of the property
53679
+ * The path/name of the property
52639
53680
  */
52640
53681
  sPath: string,
52641
53682
  /**
52642
- * the context if available to access the property value
53683
+ * The context if available to access the property value
52643
53684
  */
52644
53685
  oContext?: object,
52645
53686
  /**
52646
- * This parameter should be set when a URI or custom parameter with a $expand System Query Option was used
52647
- * to retrieve associated entries embedded/inline. If true then the getProperty function returns a desired
52648
- * property value/entry and includes the associated expand entries (if any). If false the associated/expanded
53687
+ * This parameter should be set when a URI or custom parameter with a `$expand` System Query Option was
53688
+ * used to retrieve associated entries embedded/inline. If true then the getProperty function returns a
53689
+ * desired property value/entry and includes the associated expand entries (if any). If false the associated/expanded
52649
53690
  * entry properties are removed and not included in the desired entry as properties at all. This is useful
52650
53691
  * for performing updates on the base entry only. Note: A copy and not a reference of the entry will be
52651
53692
  * returned.
52652
53693
  */
52653
53694
  bIncludeExpandEntries?: boolean
52654
- ): any;
53695
+ ): object;
52655
53696
  /**
52656
53697
  * Returns the current security token. If the token has not been requested from the server it will be requested
52657
53698
  * first.
52658
53699
  */
52659
53700
  getSecurityToken(): string;
52660
53701
  /**
52661
- * Return the annotation object. Please note that when using the model with bLoadMetadataAsync = true then
52662
- * this function might return undefined because the metadata has not been loaded yet. In this case attach
52663
- * to the `annotationsLoaded` event to get notified when the annotations are available and then call this
52664
- * function.
53702
+ * Return the annotation object. Please note that when using the model with `bLoadMetadataAsync = true`
53703
+ * then this function might return undefined because the metadata has not been loaded yet. In this case
53704
+ * attach to the `annotationsLoaded` event to get notified when the annotations are available and then call
53705
+ * this function.
52665
53706
  */
52666
- getServiceAnnotations(): Object;
53707
+ getServiceAnnotations(): Object | undefined;
52667
53708
  /**
52668
- * Return the metadata object. Please note that when using the model with bLoadMetadataAsync = true then
52669
- * this function might return undefined because the metadata has not been loaded yet. In this case attach
52670
- * to the `metadataLoaded` event to get notified when the metadata is available and then call this function.
53709
+ * Return the metadata object. Please note that when using the model with `bLoadMetadataAsync = true` then
53710
+ * this function might return `undefinedmetadataLoaded` event to get notified when the metadata is available and then call
53711
+ * this function.
52671
53712
  */
52672
- getServiceMetadata(): Object;
53713
+ getServiceMetadata(): Object | undefined;
52673
53714
  /**
52674
53715
  * Checks if there exist pending changes in the model created by the setProperty method.
52675
53716
  */
@@ -52677,7 +53718,7 @@ declare namespace sap {
52677
53718
  /**
52678
53719
  * @deprecated (since 1.20) - please use {@link #getDefaultCountMode} instead.
52679
53720
  *
52680
- * Returns whether this model supports the $count on its collections
53721
+ * Returns whether this model supports `$count` on its collections.
52681
53722
  */
52682
53723
  isCountSupported(): boolean;
52683
53724
  /**
@@ -52830,9 +53871,14 @@ declare namespace sap {
52830
53871
  /**
52831
53872
  * @deprecated (since 1.20) - please use {@link #setDefaultCountMode} instead.
52832
53873
  *
52833
- * Sets whether this OData service supports $count on its collections.
53874
+ * Sets whether this OData service supports `$count` on its collections.
52834
53875
  */
52835
- setCountSupported(bCountSupported: boolean): void;
53876
+ setCountSupported(
53877
+ /**
53878
+ * Whether this OData service supports `$count` on its collections
53879
+ */
53880
+ bCountSupported: boolean
53881
+ ): void;
52836
53882
  /**
52837
53883
  * @SINCE 1.20
52838
53884
  *
@@ -52874,33 +53920,33 @@ declare namespace sap {
52874
53920
  ): void;
52875
53921
  /**
52876
53922
  * Sets a new value for the given property `sPropertyName` in the model without triggering a server request.
52877
- * This can be done by the submitChanges method.
53923
+ * This can be done by the `submitChanges` method.
52878
53924
  *
52879
- * Note: Only one entry of one collection can be updated at once. Otherwise a fireRejectChange event is
53925
+ * Note: Only one entry of one collection can be updated at once. Otherwise a `fireRejectChange` event is
52880
53926
  * fired.
52881
53927
  *
52882
- * Before updating a different entry the existing changes of the current entry have to be submitted or resetted
52883
- * by the corresponding methods: submitChanges, resetChanges.
53928
+ * Before updating a different entry the existing changes of the current entry have to be submitted or reset
53929
+ * by the corresponding methods: `submitChanges`, `resetChanges`.
52884
53930
  *
52885
- * IMPORTANT: All pending changes are resetted in the model if the application triggeres any kind of refresh
53931
+ * IMPORTANT: All pending changes are reset in the model if the application triggers any kind of refresh
52886
53932
  * on that entry. Make sure to submit the pending changes first. To determine if there are any pending changes
52887
- * call the hasPendingChanges method.
53933
+ * call the `hasPendingChanges` method.
52888
53934
  */
52889
53935
  setProperty(
52890
53936
  /**
52891
- * path of the property to set
53937
+ * Path of the property to set
52892
53938
  */
52893
53939
  sPath: string,
52894
53940
  /**
52895
- * value to set the property to
53941
+ * Value to set the property to
52896
53942
  */
52897
53943
  oValue: any,
52898
53944
  /**
52899
- * the context which will be used to set the property
53945
+ * The context which will be used to set the property
52900
53946
  */
52901
53947
  oContext?: object,
52902
53948
  /**
52903
- * whether to update other bindings dependent on this property asynchronously
53949
+ * Whether to update other bindings dependent on this property asynchronously
52904
53950
  */
52905
53951
  bAsyncUpdate?: boolean
52906
53952
  ): boolean;
@@ -52909,7 +53955,12 @@ declare namespace sap {
52909
53955
  *
52910
53956
  * Enable/Disable automatic updates of all Bindings after change operations
52911
53957
  */
52912
- setRefreshAfterChange(bRefreshAfterChange: boolean): void;
53958
+ setRefreshAfterChange(
53959
+ /**
53960
+ * Whether automatic updates should be enabled
53961
+ */
53962
+ bRefreshAfterChange: boolean
53963
+ ): void;
52913
53964
  /**
52914
53965
  * Enable/Disable XCSRF-Token handling
52915
53966
  */
@@ -53745,6 +54796,17 @@ declare namespace sap {
53745
54796
  */
53746
54797
  fnFilter: Function
53747
54798
  ): void;
54799
+ /**
54800
+ * Private method iterating the registered bindings of this model instance and initiating their check for
54801
+ * update
54802
+ */
54803
+ checkUpdate(
54804
+ bAsync: boolean,
54805
+ /**
54806
+ * an optional test function to filter the binding
54807
+ */
54808
+ fnFilter: Function
54809
+ ): void;
53748
54810
  /**
53749
54811
  * Inserts the user-defined custom data into the model.
53750
54812
  */
@@ -55164,7 +56226,7 @@ declare namespace sap {
55164
56226
  /**
55165
56227
  * Update the bound control even if no data has been changed
55166
56228
  */
55167
- bForceUpdate: boolean
56229
+ bForceUpdate?: boolean
55168
56230
  ): void;
55169
56231
  /**
55170
56232
  * Resumes the binding update. Change events will be fired again.
@@ -55929,6 +56991,13 @@ declare namespace sap {
55929
56991
  */
55930
56992
  bNewState?: boolean
55931
56993
  ): boolean;
56994
+ /**
56995
+ * @SINCE 1.98.0
56996
+ *
56997
+ * Returns an array of all model and control messages of all parts of the composite binding, regardless
56998
+ * of whether they are old or new.
56999
+ */
57000
+ getAllMessages(): sap.ui.core.Message[];
55932
57001
  /**
55933
57002
  * Returns the changes of the data state in a map that the control can use in the `refreshDataState` method.
55934
57003
  * The changed property's name is the key in the map. Each element in the map contains an object of below
@@ -55951,7 +57020,7 @@ declare namespace sap {
55951
57020
  }
55952
57021
  >;
55953
57022
  /**
55954
- * Returns the array of state messages of the control.
57023
+ * Returns the array of current state messages of the control.
55955
57024
  */
55956
57025
  getControlMessages(): sap.ui.core.Message[];
55957
57026
  /**
@@ -55970,11 +57039,11 @@ declare namespace sap {
55970
57039
  */
55971
57040
  getInvalidValue(): any;
55972
57041
  /**
55973
- * Returns the array of all state messages combining the model and control messages.
57042
+ * Returns the array of all current state messages combining the model and control messages.
55974
57043
  */
55975
57044
  getMessages(): sap.ui.core.Message[];
55976
57045
  /**
55977
- * Returns the array of state messages of the model or undefined.
57046
+ * Returns the array of current state messages of the model.
55978
57047
  */
55979
57048
  getModelMessages(): sap.ui.core.Message[];
55980
57049
  /**
@@ -56343,6 +57412,12 @@ declare namespace sap {
56343
57412
  */
56344
57413
  bNewState?: boolean
56345
57414
  ): boolean;
57415
+ /**
57416
+ * @SINCE 1.98.0
57417
+ *
57418
+ * Returns an array of all model and control messages, regardless of whether they are old or new.
57419
+ */
57420
+ getAllMessages(): sap.ui.core.Message[];
56346
57421
  /**
56347
57422
  * Returns the changes of the data state in a map that the control can use in the `refreshDataState` method.
56348
57423
  * The changed property's name is the key in the map. Each element in the map contains an object with the
@@ -56351,7 +57426,7 @@ declare namespace sap {
56351
57426
  */
56352
57427
  getChanges(): object;
56353
57428
  /**
56354
- * Returns the array of state messages of the control.
57429
+ * Returns the array of this data state's current control messages.
56355
57430
  */
56356
57431
  getControlMessages(): sap.ui.core.Message[];
56357
57432
  /**
@@ -56361,12 +57436,12 @@ declare namespace sap {
56361
57436
  */
56362
57437
  getInvalidValue(): any;
56363
57438
  /**
56364
- * Returns the array of this data state's messages combining the model and control messages. The array is
56365
- * sorted descendingly by message severity.
57439
+ * Returns the array of this data state's current messages combining the model and control messages. The
57440
+ * array is sorted descendingly by message severity.
56366
57441
  */
56367
57442
  getMessages(): sap.ui.core.Message[];
56368
57443
  /**
56369
- * Returns the array of state messages of the model or undefined.
57444
+ * Returns the array of this data state's current model messages.
56370
57445
  */
56371
57446
  getModelMessages(): sap.ui.core.Message[];
56372
57447
  /**
@@ -56895,6 +57970,15 @@ declare namespace sap {
56895
57970
  */
56896
57971
  sFilterType?: sap.ui.model.FilterType
56897
57972
  ): this;
57973
+ /**
57974
+ * @SINCE 1.97.0
57975
+ *
57976
+ * Returns all current contexts of this list binding in no special order. Just like {@link #getCurrentContexts},
57977
+ * this method does not request any data from a back end and does not change the binding's state. In contrast
57978
+ * to {@link #getCurrentContexts}, it does not only return those contexts that were last requested by a
57979
+ * control, but all contexts that are currently available in the binding.
57980
+ */
57981
+ getAllCurrentContexts(): sap.ui.model.Context[];
56898
57982
  /**
56899
57983
  * Returns an array of binding contexts for the bound target list.
56900
57984
  *
@@ -56947,11 +58031,10 @@ declare namespace sap {
56947
58031
  /**
56948
58032
  * @SINCE 1.28
56949
58033
  *
56950
- * Returns an array of currently used binding contexts of the bound control.
58034
+ * Returns the contexts of this list binding as last requested by the control and in the same order the
58035
+ * control has received them.
56951
58036
  *
56952
- * This method does not trigger any data requests from the back end or a delta calculation, but just returns
56953
- * the context array as last requested by the control. This can be used by the application to get access
56954
- * to the data currently displayed by a list control.
58037
+ * This method does not request any data from a back end and does not change the binding's state.
56955
58038
  */
56956
58039
  getCurrentContexts(): sap.ui.model.Context[];
56957
58040
  /**
@@ -57414,7 +58497,7 @@ declare namespace sap {
57414
58497
  * the server
57415
58498
  */
57416
58499
  bReload?: boolean
57417
- ): sap.ui.model.Context;
58500
+ ): sap.ui.model.Context | undefined;
57418
58501
  /**
57419
58502
  * Destroys the model and clears the model data.
57420
58503
  *
@@ -57514,23 +58597,10 @@ declare namespace sap {
57514
58597
  */
57515
58598
  fireParseError(
57516
58599
  /**
57517
- * Parameters to pass along with the event
58600
+ * Parameters to pass along with the event; May contain the following parameters: `errorCode`, `url`, `reason`,
58601
+ * `srcText`, `line`, `linePos`, `filePos`
57518
58602
  */
57519
- oParameters?: {
57520
- errorCode?: int;
57521
-
57522
- url?: string;
57523
-
57524
- reason?: string;
57525
-
57526
- srcText?: string;
57527
-
57528
- line?: int;
57529
-
57530
- linepos?: int;
57531
-
57532
- filepos?: int;
57533
- }
58603
+ oParameters?: object
57534
58604
  ): this;
57535
58605
  /**
57536
58606
  * Fires event {@link #event:propertyChange propertyChange} to attached listeners.
@@ -58958,7 +60028,9 @@ declare namespace sap {
58958
60028
  * The list was refreshed
58959
60029
  */
58960
60030
  Refresh = "refresh",
58961
-
60031
+ /**
60032
+ * A context was removed from a binding.
60033
+ */
58962
60034
  Remove = "remove",
58963
60035
  /**
58964
60036
  * The list was sorted
@@ -59225,9 +60297,8 @@ declare namespace sap {
59225
60297
  *
59226
60298
  * If this flag is set to `true`, the Safari browser runs in standalone fullscreen mode on iOS.
59227
60299
  *
59228
- * **Note:** This flag is only available if the Safari browser was detected. Furthermore, if this mode is
59229
- * detected, technically not a standard Safari is used. There might be slight differences in behavior and
59230
- * detection, e.g. the availability of {@link sap.ui.Device.browser.version}.
60300
+ * **Note:** This flag is only available if the Safari browser was detected. There might be slight differences
60301
+ * in behavior and detection, e.g. regarding the availability of {@link sap.ui.Device.browser.version}.
59231
60302
  */
59232
60303
  export const fullscreen: boolean;
59233
60304
 
@@ -59288,12 +60359,13 @@ declare namespace sap {
59288
60359
 
59289
60360
  /**
59290
60361
  * @SINCE 1.31.0
60362
+ * @deprecated (since 1.98)
59291
60363
  *
59292
60364
  * If this flag is set to `true`, the Safari browser runs in webview mode on iOS.
59293
60365
  *
59294
- * **Note:** This flag is only available if the Safari browser was detected. Furthermore, if this mode is
59295
- * detected, technically not a standard Safari is used. There might be slight differences in behavior and
59296
- * detection, e.g. the availability of {@link sap.ui.Device.browser.version}.
60366
+ * **Note:** Since iOS 11 it is no longer reliably possible to detect whether an application runs in `webview`.
60367
+ * The flag is `true` if the browser's user agent contains 'SAPFioriClient'. Applications using WKWebView
60368
+ * have the possibility to customize the user agent, and to explicitly add this information.
59297
60369
  */
59298
60370
  export const webview: boolean;
59299
60371
 
@@ -59674,11 +60746,6 @@ declare namespace sap {
59674
60746
  */
59675
60747
  export const android: boolean;
59676
60748
 
59677
- /**
59678
- * If this flag is set to `true`, a Blackberry operating system is used.
59679
- */
59680
- export const blackberry: boolean;
59681
-
59682
60749
  /**
59683
60750
  * If this flag is set to `true`, an iOS operating system is used.
59684
60751
  */
@@ -59706,14 +60773,14 @@ declare namespace sap {
59706
60773
  /**
59707
60774
  * The version of the operating system as `float`.
59708
60775
  *
59709
- * Might be `-1` if no version can be determined.
60776
+ * Might be `-1` if no version can reliably be determined.
59710
60777
  */
59711
60778
  export const version: float;
59712
60779
 
59713
60780
  /**
59714
60781
  * The version of the operating system as `string`.
59715
60782
  *
59716
- * Might be empty if no version can be determined.
60783
+ * Might be empty if no version can reliably be determined.
59717
60784
  */
59718
60785
  export const versionStr: string;
59719
60786
 
@@ -59722,11 +60789,6 @@ declare namespace sap {
59722
60789
  */
59723
60790
  export const windows: boolean;
59724
60791
 
59725
- /**
59726
- * If this flag is set to `true`, a Windows Phone operating system is used.
59727
- */
59728
- export const windows_phone: boolean;
59729
-
59730
60792
  /**
59731
60793
  * Enumeration containing the names of known operating systems.
59732
60794
  */
@@ -59738,13 +60800,6 @@ declare namespace sap {
59738
60800
  */
59739
60801
  export const ANDROID: undefined;
59740
60802
 
59741
- /**
59742
- * Blackberry operating system name.
59743
- * See:
59744
- * sap.ui.Device.os.name
59745
- */
59746
- export const BLACKBERRY: undefined;
59747
-
59748
60803
  /**
59749
60804
  * iOS operating system name.
59750
60805
  * See:
@@ -59772,13 +60827,6 @@ declare namespace sap {
59772
60827
  * sap.ui.Device.os.name
59773
60828
  */
59774
60829
  export const WINDOWS: undefined;
59775
-
59776
- /**
59777
- * Windows Phone operating system name.
59778
- * See:
59779
- * sap.ui.Device.os.name
59780
- */
59781
- export const WINDOWS_PHONE: undefined;
59782
60830
  }
59783
60831
  }
59784
60832
  /**
@@ -60017,7 +61065,44 @@ declare namespace sap {
60017
61065
  | sap.ui.base.ManagedObject.PropertyBindingInfo;
60018
61066
  }
60019
61067
 
60020
- interface $PressSettings extends sap.ui.test.actions.$ActionSettings {}
61068
+ interface $PressSettings extends sap.ui.test.actions.$ActionSettings {
61069
+ /**
61070
+ * @SINCE 1.97
61071
+ *
61072
+ * If it is set to `true`, the Alt Key modifier will be used
61073
+ */
61074
+ altKey?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
61075
+
61076
+ /**
61077
+ * @SINCE 1.97
61078
+ *
61079
+ * If it is set to `true`, the Shift Key modifier will be used
61080
+ */
61081
+ shiftKey?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
61082
+
61083
+ /**
61084
+ * @SINCE 1.97
61085
+ *
61086
+ * If it is set to `true`, the Control Key modifier will be used
61087
+ */
61088
+ ctrlKey?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
61089
+
61090
+ /**
61091
+ * @SINCE 1.98
61092
+ *
61093
+ * Provide percent value for the X coordinate axis to calculate the position of the click event. The value
61094
+ * must be in the range [0 - 100]
61095
+ */
61096
+ xPercentage?: float | sap.ui.base.ManagedObject.PropertyBindingInfo;
61097
+
61098
+ /**
61099
+ * @SINCE 1.98
61100
+ *
61101
+ * Provide percent value for the Y coordinate axis to calculate the position of the click event. The value
61102
+ * must be in the range [0 - 100]
61103
+ */
61104
+ yPercentage?: float | sap.ui.base.ManagedObject.PropertyBindingInfo;
61105
+ }
60021
61106
 
60022
61107
  interface $ScrollSettings extends sap.ui.test.actions.$ActionSettings {
60023
61108
  x?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
@@ -60480,13 +61565,22 @@ declare namespace sap {
60480
61565
  * see {@link sap.ui.test.actions.Press.controlAdapters}.
60481
61566
  */
60482
61567
  class Press extends sap.ui.test.actions.Action {
61568
+ /**
61569
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
61570
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
61571
+ * of the syntax of the settings object.
61572
+ */
60483
61573
  constructor(
60484
61574
  /**
60485
61575
  * Optional object with initial settings for the new instance
60486
61576
  */
60487
61577
  mSettings?: sap.ui.test.actions.$PressSettings
60488
61578
  );
60489
-
61579
+ /**
61580
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
61581
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
61582
+ * of the syntax of the settings object.
61583
+ */
60490
61584
  constructor(
60491
61585
  /**
60492
61586
  * Optional ID for the new instance; generated automatically if no non-empty ID is given. Note: this can
@@ -60534,6 +61628,125 @@ declare namespace sap {
60534
61628
  */
60535
61629
  oControl: sap.ui.core.Control
60536
61630
  ): void;
61631
+ /**
61632
+ * @SINCE 1.97
61633
+ *
61634
+ * Gets current value of property {@link #getAltKey altKey}.
61635
+ *
61636
+ * If it is set to `true`, the Alt Key modifier will be used
61637
+ */
61638
+ getAltKey(): boolean;
61639
+ /**
61640
+ * @SINCE 1.97
61641
+ *
61642
+ * Gets current value of property {@link #getCtrlKey ctrlKey}.
61643
+ *
61644
+ * If it is set to `true`, the Control Key modifier will be used
61645
+ */
61646
+ getCtrlKey(): boolean;
61647
+ /**
61648
+ * @SINCE 1.97
61649
+ *
61650
+ * Gets current value of property {@link #getShiftKey shiftKey}.
61651
+ *
61652
+ * If it is set to `true`, the Shift Key modifier will be used
61653
+ */
61654
+ getShiftKey(): boolean;
61655
+ /**
61656
+ * @SINCE 1.98
61657
+ *
61658
+ * Gets current value of property {@link #getXPercentage xPercentage}.
61659
+ *
61660
+ * Provide percent value for the X coordinate axis to calculate the position of the click event. The value
61661
+ * must be in the range [0 - 100]
61662
+ */
61663
+ getXPercentage(): float;
61664
+ /**
61665
+ * @SINCE 1.98
61666
+ *
61667
+ * Gets current value of property {@link #getYPercentage yPercentage}.
61668
+ *
61669
+ * Provide percent value for the Y coordinate axis to calculate the position of the click event. The value
61670
+ * must be in the range [0 - 100]
61671
+ */
61672
+ getYPercentage(): float;
61673
+ /**
61674
+ * @SINCE 1.97
61675
+ *
61676
+ * Sets a new value for property {@link #getAltKey altKey}.
61677
+ *
61678
+ * If it is set to `true`, the Alt Key modifier will be used
61679
+ *
61680
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
61681
+ */
61682
+ setAltKey(
61683
+ /**
61684
+ * New value for property `altKey`
61685
+ */
61686
+ bAltKey: boolean
61687
+ ): this;
61688
+ /**
61689
+ * @SINCE 1.97
61690
+ *
61691
+ * Sets a new value for property {@link #getCtrlKey ctrlKey}.
61692
+ *
61693
+ * If it is set to `true`, the Control Key modifier will be used
61694
+ *
61695
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
61696
+ */
61697
+ setCtrlKey(
61698
+ /**
61699
+ * New value for property `ctrlKey`
61700
+ */
61701
+ bCtrlKey: boolean
61702
+ ): this;
61703
+ /**
61704
+ * @SINCE 1.97
61705
+ *
61706
+ * Sets a new value for property {@link #getShiftKey shiftKey}.
61707
+ *
61708
+ * If it is set to `true`, the Shift Key modifier will be used
61709
+ *
61710
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
61711
+ */
61712
+ setShiftKey(
61713
+ /**
61714
+ * New value for property `shiftKey`
61715
+ */
61716
+ bShiftKey: boolean
61717
+ ): this;
61718
+ /**
61719
+ * @SINCE 1.98
61720
+ *
61721
+ * Sets a new value for property {@link #getXPercentage xPercentage}.
61722
+ *
61723
+ * Provide percent value for the X coordinate axis to calculate the position of the click event. The value
61724
+ * must be in the range [0 - 100]
61725
+ *
61726
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
61727
+ */
61728
+ setXPercentage(
61729
+ /**
61730
+ * New value for property `xPercentage`
61731
+ */
61732
+ fXPercentage: float
61733
+ ): this;
61734
+ /**
61735
+ * @SINCE 1.98
61736
+ *
61737
+ * Sets a new value for property {@link #getYPercentage yPercentage}.
61738
+ *
61739
+ * Provide percent value for the Y coordinate axis to calculate the position of the click event. The value
61740
+ * must be in the range [0 - 100]
61741
+ *
61742
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
61743
+ */
61744
+ setYPercentage(
61745
+ /**
61746
+ * New value for property `yPercentage`
61747
+ */
61748
+ fYPercentage: float
61749
+ ): this;
60537
61750
  }
60538
61751
  /**
60539
61752
  * @SINCE 1.90
@@ -64995,6 +66208,8 @@ declare namespace sap {
64995
66208
 
64996
66209
  "sap/ui/core/format/NumberFormat": undefined;
64997
66210
 
66211
+ "sap/ui/core/format/TimezoneUtil": undefined;
66212
+
64998
66213
  "sap/ui/core/Fragment": undefined;
64999
66214
 
65000
66215
  "sap/ui/core/History": undefined;
@@ -65071,6 +66286,8 @@ declare namespace sap {
65071
66286
 
65072
66287
  "sap/ui/core/Patcher": undefined;
65073
66288
 
66289
+ "sap/ui/core/Placeholder": undefined;
66290
+
65074
66291
  "sap/ui/core/Popup": undefined;
65075
66292
 
65076
66293
  "sap/ui/core/postmessage/Bus": undefined;
@@ -65377,6 +66594,8 @@ declare namespace sap {
65377
66594
 
65378
66595
  "sap/ui/model/odata/type/DateTimeOffset": undefined;
65379
66596
 
66597
+ "sap/ui/model/odata/type/DateTimeWithTimezone": undefined;
66598
+
65380
66599
  "sap/ui/model/odata/type/Decimal": undefined;
65381
66600
 
65382
66601
  "sap/ui/model/odata/type/Double": undefined;