@openui5/ts-types 1.98.0 → 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.98.0
267
+ // For Library Version: 1.99.0
268
268
 
269
269
  declare module "sap/base/assert" {
270
270
  /**
@@ -2395,9 +2395,14 @@ declare module "sap/ui/dom/includeStylesheet" {
2395
2395
  /**
2396
2396
  * @SINCE 1.58
2397
2397
  *
2398
- * Includes the specified stylesheet via a <link>-tag in the head of the current document. If there
2399
- * is call to `includeStylesheet` providing the sId of an already included stylesheet, the existing element
2400
- * 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
2401
2406
  */
2402
2407
  export default function includeStylesheet(
2403
2408
  /**
@@ -3337,6 +3342,49 @@ declare module "sap/ui/test/opaQunit" {
3337
3342
  */
3338
3343
  async?: boolean
3339
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;
3340
3388
  }
3341
3389
 
3342
3390
  declare module "sap/ui/util/Mobile" {
@@ -3605,24 +3653,25 @@ declare module "sap/ui/VersionInfo" {
3605
3653
  /**
3606
3654
  * @SINCE 1.56.0
3607
3655
  *
3608
- * Loads the version info file (resources/sap-ui-version.json) asynchronously and returns a Promise. The
3609
- * returned Promise resolves with the version info files content.
3656
+ * Loads the version info asynchronously from resource "sap-ui-version.json".
3610
3657
  *
3611
- * 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.
3612
3661
  *
3613
- * 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.
3614
3663
  */
3615
3664
  load(
3616
3665
  /**
3617
- * an object map (see below)
3666
+ * Map of options
3618
3667
  */
3619
- mOptions: {
3668
+ mOptions?: {
3620
3669
  /**
3621
- * name of the library (e.g. "sap.ui.core")
3670
+ * Name of a library (e.g. "sap.ui.core")
3622
3671
  */
3623
- library: string;
3672
+ library?: string;
3624
3673
  }
3625
- ): Promise<any>;
3674
+ ): Promise<object | undefined>;
3626
3675
  }
3627
3676
  const VersionInfo: VersionInfo;
3628
3677
  export default VersionInfo;
@@ -6309,6 +6358,38 @@ declare namespace sap {
6309
6358
  events?: Record<string, Function>;
6310
6359
  };
6311
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
+
6312
6393
  /**
6313
6394
  * Configuration for the binding of a managed property.
6314
6395
  *
@@ -8092,34 +8173,9 @@ declare namespace sap {
8092
8173
  */
8093
8174
  bindObject(
8094
8175
  /**
8095
- * An object describing the binding
8176
+ * Binding info
8096
8177
  */
8097
- oBindingInfo: {
8098
- /**
8099
- * Path in the model to bind to, either an absolute path or relative to the binding context for the corresponding
8100
- * model; when the path contains a '>' sign, the string preceding it will override the `model` property
8101
- * and the remainder after the '>' will be used as binding path
8102
- */
8103
- path: string;
8104
- /**
8105
- * Name of the model to bind against; when `undefined` or omitted, the default model is used
8106
- */
8107
- model?: string;
8108
- /**
8109
- * Map of additional parameters for this binding; the names and value ranges of the supported parameters
8110
- * depend on the model implementation, they should be documented with the `bindContext` method of the corresponding
8111
- * model class or with the model specific subclass of `sap.ui.model.ContextBinding`
8112
- */
8113
- parameters?: object;
8114
- /**
8115
- * Whether the binding should be suspended initially
8116
- */
8117
- suspended?: boolean;
8118
- /**
8119
- * Map of event handler functions keyed by the name of the binding events that they should be attached to
8120
- */
8121
- events?: object;
8122
- }
8178
+ oBindingInfo: sap.ui.base.ManagedObject.ObjectBindingInfo
8123
8179
  ): this;
8124
8180
  /**
8125
8181
  * Binds a property to the model.
@@ -8942,11 +8998,7 @@ declare namespace sap {
8942
8998
  /**
8943
8999
  * name of the aggregation to refresh
8944
9000
  */
8945
- sName: string,
8946
- /**
8947
- * the change reason
8948
- */
8949
- sChangeReason: sap.ui.model.ChangeReason
9001
+ sName: string
8950
9002
  ): void;
8951
9003
  /**
8952
9004
  * Removes an object from the aggregation named `sAggregationName` with cardinality 0..n.
@@ -10628,18 +10680,18 @@ declare namespace sap {
10628
10680
  /**
10629
10681
  * Horizontal position of the scrollbar
10630
10682
  */
10631
- iHorizontalPosition: int,
10683
+ x: int,
10632
10684
  /**
10633
10685
  * Vertical position of the scrollbar
10634
10686
  */
10635
- iVerticalPosition: int,
10687
+ y: int,
10636
10688
  /**
10637
10689
  * The duration of animated scrolling in milliseconds. To scroll immediately without animation, give 0 as
10638
10690
  * value.
10639
10691
  */
10640
- iTime: int,
10692
+ time: int,
10641
10693
 
10642
- fnCallback: Function
10694
+ fnScrollEndCallback: Function
10643
10695
  ): this;
10644
10696
  /**
10645
10697
  * Scrolls to a specific position in scroll container.
@@ -10648,13 +10700,13 @@ declare namespace sap {
10648
10700
  /**
10649
10701
  * Horizontal position of the scrollbar
10650
10702
  */
10651
- iHorizontalPosition: int,
10703
+ x: int,
10652
10704
  /**
10653
10705
  * Vertical position of the scrollbar
10654
10706
  */
10655
- iVerticalPosition: int,
10707
+ y: int,
10656
10708
 
10657
- fnCallback: Function
10709
+ fnScrollEndCallback: Function
10658
10710
  ): this;
10659
10711
  /**
10660
10712
  * Scrolls to an element within a container.
@@ -12047,6 +12099,63 @@ declare namespace sap {
12047
12099
  * Format classes
12048
12100
  */
12049
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
+
12050
12159
  namespace NumberFormat {
12051
12160
  /**
12052
12161
  * Specifies a rounding behavior for numerical operations capable of discarding precision. Each rounding
@@ -12096,6 +12205,9 @@ declare namespace sap {
12096
12205
  * The DateFormat is a static class for formatting and parsing single date and time values or date and time
12097
12206
  * intervals according to a set of format options.
12098
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
+ *
12099
12211
  * Supported format options are pattern based on Unicode LDML Date Format notation. Please note that only
12100
12212
  * a subset of the LDML date symbols is supported. If no pattern is specified a default pattern according
12101
12213
  * to the locale settings is used.
@@ -12210,9 +12322,8 @@ declare namespace sap {
12210
12322
  */
12211
12323
  strictParsing?: boolean;
12212
12324
  /**
12213
- * if true, the date is formatted relatively to todays date if it is within the given day range, e.g. "today",
12214
- * "yesterday", "in 5 days"@param {boolean} [oFormatOptions.UTC] if true, the date is formatted and parsed
12215
- * 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"
12216
12327
  */
12217
12328
  relative?: boolean;
12218
12329
  /**
@@ -12258,6 +12369,77 @@ declare namespace sap {
12258
12369
  */
12259
12370
  oLocale?: sap.ui.core.Locale
12260
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;
12261
12443
  /**
12262
12444
  * Get a time instance of the DateFormat, which can be used for formatting.
12263
12445
  */
@@ -12336,6 +12518,9 @@ declare namespace sap {
12336
12518
  ): sap.ui.core.format.DateFormat;
12337
12519
  /**
12338
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.
12339
12524
  */
12340
12525
  format(
12341
12526
  /**
@@ -12349,6 +12534,9 @@ declare namespace sap {
12349
12534
  ): string;
12350
12535
  /**
12351
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.
12352
12540
  */
12353
12541
  parse(
12354
12542
  /**
@@ -12360,7 +12548,7 @@ declare namespace sap {
12360
12548
  */
12361
12549
  bUTC: boolean,
12362
12550
  /**
12363
- * to use strict value check
12551
+ * whether to use strict value check
12364
12552
  */
12365
12553
  bStrict: boolean
12366
12554
  ): Date | Date[];
@@ -12621,8 +12809,8 @@ declare namespace sap {
12621
12809
  */
12622
12810
  groupingEnabled?: boolean;
12623
12811
  /**
12624
- * defines the used grouping separator, note that the groupingSeparator must always be different than the
12625
- * used decimalSeparator.
12812
+ * defines the character used as grouping separator. Note: `groupingSeparator` must always be different
12813
+ * from `decimalSeparator`.
12626
12814
  */
12627
12815
  groupingSeparator?: string;
12628
12816
  /**
@@ -12635,8 +12823,8 @@ declare namespace sap {
12635
12823
  */
12636
12824
  groupingBaseSize?: int;
12637
12825
  /**
12638
- * defines the used decimal separator, note that the decimalSeparator must always be different than the
12639
- * used groupingSeparator.
12826
+ * defines the character used as decimal separator. Note: `decimalSeparator` must always be different from
12827
+ * `groupingSeparator`.
12640
12828
  */
12641
12829
  decimalSeparator?: string;
12642
12830
  /**
@@ -12791,8 +12979,8 @@ declare namespace sap {
12791
12979
  */
12792
12980
  groupingEnabled?: boolean;
12793
12981
  /**
12794
- * defines the used grouping separator, note that the groupingSeparator must always be different than the
12795
- * used decimalSeparator.
12982
+ * defines the character used as grouping separator. Note: `groupingSeparator` must always be different
12983
+ * from `decimalSeparator`.
12796
12984
  */
12797
12985
  groupingSeparator?: string;
12798
12986
  /**
@@ -12805,8 +12993,8 @@ declare namespace sap {
12805
12993
  */
12806
12994
  groupingBaseSize?: int;
12807
12995
  /**
12808
- * defines the used decimal separator, note that the decimalSeparator must always be different than the
12809
- * used groupingSeparator.
12996
+ * defines the character used as decimal separator. Note: `decimalSeparator` must always be different from
12997
+ * `groupingSeparator`.
12810
12998
  */
12811
12999
  decimalSeparator?: string;
12812
13000
  /**
@@ -12927,8 +13115,8 @@ declare namespace sap {
12927
13115
  */
12928
13116
  groupingEnabled?: boolean;
12929
13117
  /**
12930
- * defines the used grouping separator, note that the groupingSeparator must always be different than the
12931
- * used decimalSeparator.
13118
+ * defines the character used as grouping separator. Note: `groupingSeparator` must always be different
13119
+ * from `decimalSeparator`.
12932
13120
  */
12933
13121
  groupingSeparator?: string;
12934
13122
  /**
@@ -12941,8 +13129,8 @@ declare namespace sap {
12941
13129
  */
12942
13130
  groupingBaseSize?: int;
12943
13131
  /**
12944
- * defines the used decimal separator, note that the decimalSeparator must always be different than the
12945
- * used groupingSeparator.
13132
+ * defines the character used as decimal separator. Note: `decimalSeparator` must always be different from
13133
+ * `groupingSeparator`.
12946
13134
  */
12947
13135
  decimalSeparator?: string;
12948
13136
  /**
@@ -13066,8 +13254,8 @@ declare namespace sap {
13066
13254
  */
13067
13255
  groupingEnabled?: boolean;
13068
13256
  /**
13069
- * defines the used grouping separator, note that the groupingSeparator must always be different than the
13070
- * used decimalSeparator.
13257
+ * defines the character used as grouping separator. Note: `groupingSeparator` must always be different
13258
+ * from `decimalSeparator`.
13071
13259
  */
13072
13260
  groupingSeparator?: string;
13073
13261
  /**
@@ -13080,8 +13268,8 @@ declare namespace sap {
13080
13268
  */
13081
13269
  groupingBaseSize?: int;
13082
13270
  /**
13083
- * defines the used decimal separator, note that the decimalSeparator must always be different than the
13084
- * used groupingSeparator.
13271
+ * defines the character used as decimal separator. Note: `decimalSeparator` must always be different from
13272
+ * `groupingSeparator`.
13085
13273
  */
13086
13274
  decimalSeparator?: string;
13087
13275
  /**
@@ -13206,8 +13394,8 @@ declare namespace sap {
13206
13394
  */
13207
13395
  groupingEnabled?: boolean;
13208
13396
  /**
13209
- * defines the used grouping separator, note that the groupingSeparator must always be different than the
13210
- * used decimalSeparator.
13397
+ * defines the character used as grouping separator. Note: `groupingSeparator` must always be different
13398
+ * from `decimalSeparator`.
13211
13399
  */
13212
13400
  groupingSeparator?: string;
13213
13401
  /**
@@ -13220,8 +13408,8 @@ declare namespace sap {
13220
13408
  */
13221
13409
  groupingBaseSize?: int;
13222
13410
  /**
13223
- * defines the used decimal separator, note that the decimalSeparator must always be different than the
13224
- * used groupingSeparator.
13411
+ * defines the character used as decimal separator. Note: `decimalSeparator` must always be different from
13412
+ * `groupingSeparator`.
13225
13413
  */
13226
13414
  decimalSeparator?: string;
13227
13415
  /**
@@ -16540,7 +16728,7 @@ declare namespace sap {
16540
16728
  /**
16541
16729
  * must be one of decimal, group, plusSign, minusSign.
16542
16730
  */
16543
- sStyle: string,
16731
+ sType: string,
16544
16732
  /**
16545
16733
  * will be used to represent the given symbol type
16546
16734
  */
@@ -21319,9 +21507,6 @@ declare namespace sap {
21319
21507
  * refers to ".../Value". This means, the root formatter can access the ith part of the composite binding
21320
21508
  * at will (since 1.31.0); see also {@link #.getInterface getInterface}. The function `foo` is called with
21321
21509
  * arguments such that ` oInterface.getModel(i).getObject(oInterface.getPath(i)) === arguments[i + 1]` holds.
21322
- * This use is not supported within an expression binding, that is, `<Text text="{= ${parts: [{path:
21323
- * 'Label'}, {path: 'Value'}], formatter: 'foo'} }"/>` does not work as expected because the property `requiresIContext
21324
- * = true` is ignored.
21325
21510
  *
21326
21511
  * To distinguish those two use cases, just check whether `oInterface.getModel() === undefined`, in which
21327
21512
  * case the formatter is called on root level of a composite binding. To find out the number of parts, probe
@@ -22531,9 +22716,9 @@ declare namespace sap {
22531
22716
  */
22532
22717
  attachAfter(
22533
22718
  /**
22534
- * type according to HTTP Method
22719
+ * event type according to HTTP Method
22535
22720
  */
22536
- event: string,
22721
+ sHttpMethod: string,
22537
22722
  /**
22538
22723
  * the name of the function that will be called at this exit The callback function exposes an event with
22539
22724
  * parameters, depending on the type of the request. oEvent.getParameters() lists the parameters as per
@@ -22552,9 +22737,9 @@ declare namespace sap {
22552
22737
  */
22553
22738
  attachBefore(
22554
22739
  /**
22555
- * type according to HTTP Method
22740
+ * event type according to HTTP Method
22556
22741
  */
22557
- event: string,
22742
+ sHttpMethod: string,
22558
22743
  /**
22559
22744
  * the name of the function that will be called at this exit. The callback function exposes an event with
22560
22745
  * parameters, depending on the type of the request. oEvent.getParameters() lists the parameters as per
@@ -22587,9 +22772,9 @@ declare namespace sap {
22587
22772
  */
22588
22773
  detachAfter(
22589
22774
  /**
22590
- * type according to HTTP Method
22775
+ * event type according to HTTP Method
22591
22776
  */
22592
- event: string,
22777
+ sHttpMethod: string,
22593
22778
  /**
22594
22779
  * the name of the function that will be called at this exit
22595
22780
  */
@@ -22604,9 +22789,9 @@ declare namespace sap {
22604
22789
  */
22605
22790
  detachBefore(
22606
22791
  /**
22607
- * type according to HTTP Method
22792
+ * event type according to HTTP Method
22608
22793
  */
22609
- event: string,
22794
+ sHttpMethod: string,
22610
22795
  /**
22611
22796
  * the name of the function that will be called at this exit
22612
22797
  */
@@ -23208,7 +23393,7 @@ declare namespace sap {
23208
23393
  * Marker interface for subclasses of `sap.ui.core.UIComponent`.
23209
23394
  *
23210
23395
  * Implementing this interface allows a {@link sap.ui.core.UIComponent} to be created fully asynchronously.
23211
- * 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
23212
23397
  * views will also be handled asynchronously. Additionally the error handling during the processing of views
23213
23398
  * is stricter and will fail if a view definition contains errors, e.g. broken binding strings.
23214
23399
  *
@@ -28042,8 +28227,7 @@ declare namespace sap {
28042
28227
  /**
28043
28228
  * @SINCE 1.27.0
28044
28229
  *
28045
- * Returns whether the framework automatically adds automatically the ARIA role 'application' to the HTML
28046
- * body or not.
28230
+ * Returns whether the framework automatically adds the ARIA role 'application' to the HTML body or not.
28047
28231
  */
28048
28232
  getAutoAriaBodyRole(): boolean;
28049
28233
  /**
@@ -28091,7 +28275,7 @@ declare namespace sap {
28091
28275
  /**
28092
28276
  * Returns a string that identifies the current language.
28093
28277
  *
28094
- * 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
28095
28279
  * by the user or application or that has been determined from the user agent settings. It has not been
28096
28280
  * normalized, but has been validated against a relaxed version of {@link http://www.ietf.org/rfc/bcp/bcp47.txt
28097
28281
  * BCP47}, allowing underscores ('_') instead of the suggested dashes ('-') and not taking the case of letters
@@ -28179,6 +28363,13 @@ declare namespace sap {
28179
28363
  * Returns the theme name
28180
28364
  */
28181
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;
28182
28373
  /**
28183
28374
  * Prefix to be used for automatically generated control IDs. Default is a double underscore "__".
28184
28375
  */
@@ -28339,6 +28530,22 @@ declare namespace sap {
28339
28530
  */
28340
28531
  aSecurityTokenHandlers: Function[]
28341
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;
28342
28549
  }
28343
28550
  /**
28344
28551
  * Base Class for Controls.
@@ -28644,24 +28851,6 @@ declare namespace sap {
28644
28851
  */
28645
28852
  vFieldGroupIds?: string | string[]
28646
28853
  ): boolean;
28647
- /**
28648
- * Overrides {@link sap.ui.core.Element#clone Element.clone} to clone additional internal state.
28649
- *
28650
- * The additionally cloned information contains:
28651
- * - browser event handlers attached with {@link #attachBrowserEvent}
28652
- * - text selection behavior
28653
- * - style classes added with {@link #addStyleClass}
28654
- */
28655
- clone(
28656
- /**
28657
- * a suffix to be appended to the cloned element id
28658
- */
28659
- sIdSuffix?: string,
28660
- /**
28661
- * an array of local IDs within the cloned hierarchy (internally used)
28662
- */
28663
- aLocalIds?: string[]
28664
- ): this;
28665
28854
  /**
28666
28855
  * Removes event handlers which have been previously attached using {@link #attachBrowserEvent}.
28667
28856
  *
@@ -29614,30 +29803,11 @@ declare namespace sap {
29614
29803
  /**
29615
29804
  * the binding path or an object with more detailed binding options
29616
29805
  */
29617
- vPath:
29618
- | string
29619
- | {
29620
- /**
29621
- * the binding path
29622
- */
29623
- path: string;
29624
- /**
29625
- * map of additional parameters for this binding
29626
- */
29627
- parameters?: object;
29628
- /**
29629
- * name of the model
29630
- */
29631
- model?: string;
29632
- /**
29633
- * map of event listeners for the binding events
29634
- */
29635
- events?: object;
29636
- },
29806
+ vPath: string | sap.ui.base.ManagedObject.ObjectBindingInfo,
29637
29807
  /**
29638
- * map of additional parameters for this binding (only taken into account when vPath is a string in that
29639
- * case it corresponds to vPath.parameters). The supported parameters are listed in the corresponding model-specific
29640
- * 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`.
29641
29811
  */
29642
29812
  mParameters?: object
29643
29813
  ): this;
@@ -32474,7 +32644,7 @@ declare namespace sap {
32474
32644
  iWeekNumber: int
32475
32645
  ): string;
32476
32646
  /**
32477
- * Get combined datetime pattern with given date and and time style.
32647
+ * Get combined datetime pattern with given date and time style.
32478
32648
  */
32479
32649
  getCombinedDateTimePattern(
32480
32650
  /**
@@ -41487,6 +41657,124 @@ declare namespace sap {
41487
41657
  vValue: any
41488
41658
  ): void;
41489
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
+ }
41490
41778
  /**
41491
41779
  * @SINCE 1.27.0
41492
41780
  *
@@ -43972,7 +44260,8 @@ declare namespace sap {
43972
44260
  *
43973
44261
  * Creates a new entity for this binding's collection via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
43974
44262
  * using the parameters given in `mParameters` and inserts it at the list position specified by the `bAtEnd`
43975
- * parameter.
44263
+ * parameter. See {@link topic:6c47b2b39db9404582994070ec3d57a2#loio4c4cd99af9b14e08bb72470cc7cabff4 Creating
44264
+ * Entities documentation} for comprehensive information on the topic.
43976
44265
  *
43977
44266
  * Note: This method requires that the model metadata has been loaded; see {@link sap.ui.model.odata.v2.ODataModel#metadataLoaded}.
43978
44267
  */
@@ -44026,7 +44315,8 @@ declare namespace sap {
44026
44315
  *
44027
44316
  * Creates a new entity for this binding's collection via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
44028
44317
  * using the parameters given in `mParameters` and inserts it at the list position specified by the `bAtEnd`
44029
- * parameter.
44318
+ * parameter. See {@link topic:6c47b2b39db9404582994070ec3d57a2#loio4c4cd99af9b14e08bb72470cc7cabff4 Creating
44319
+ * Entities documentation} for comprehensive information on the topic.
44030
44320
  *
44031
44321
  * Note: This method requires that the model metadata has been loaded; see {@link sap.ui.model.odata.v2.ODataModel#metadataLoaded}.
44032
44322
  */
@@ -44073,7 +44363,8 @@ declare namespace sap {
44073
44363
  *
44074
44364
  * Creates a new entity for this binding's collection via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
44075
44365
  * using the parameters given in `mParameters` and inserts it at the list position specified by the `bAtEnd`
44076
- * parameter.
44366
+ * parameter. See {@link topic:6c47b2b39db9404582994070ec3d57a2#loio4c4cd99af9b14e08bb72470cc7cabff4 Creating
44367
+ * Entities documentation} for comprehensive information on the topic.
44077
44368
  *
44078
44369
  * Note: This method requires that the model metadata has been loaded; see {@link sap.ui.model.odata.v2.ODataModel#metadataLoaded}.
44079
44370
  */
@@ -44123,7 +44414,8 @@ declare namespace sap {
44123
44414
  *
44124
44415
  * Creates a new entity for this binding's collection via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
44125
44416
  * using the parameters given in `mParameters` and inserts it at the list position specified by the `bAtEnd`
44126
- * parameter.
44417
+ * parameter. See {@link topic:6c47b2b39db9404582994070ec3d57a2#loio4c4cd99af9b14e08bb72470cc7cabff4 Creating
44418
+ * Entities documentation} for comprehensive information on the topic.
44127
44419
  *
44128
44420
  * Note: This method requires that the model metadata has been loaded; see {@link sap.ui.model.odata.v2.ODataModel#metadataLoaded}.
44129
44421
  */
@@ -45184,7 +45476,9 @@ declare namespace sap {
45184
45476
  */
45185
45477
  canonicalRequestsEnabled(): boolean;
45186
45478
  /**
45187
- * 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.
45188
45482
  *
45189
45483
  * Please note that deep creates are not supported and may not work.
45190
45484
  */
@@ -45302,7 +45596,9 @@ declare namespace sap {
45302
45596
  ): sap.ui.model.odata.v2.Context | undefined;
45303
45597
  /**
45304
45598
  * Creates a new entry object which is described by the metadata of the entity type of the specified `sPath`
45305
- * 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.
45306
45602
  *
45307
45603
  * For each created entry a request is created and stored in a request queue. The request queue can be submitted
45308
45604
  * by calling {@link #submitChanges}. As long as the context is transient (see {@link sap.ui.model.odata.v2.Context#isTransient}),
@@ -46949,16 +47245,16 @@ declare namespace sap {
46949
47245
  * ```javascript
46950
47246
  *
46951
47247
  * <Annotations Target="com.sap.gateway.default.iwbep.tea_busi.v0001.EQUIPMENT">
46952
- * <Annotation Term="com.sap.vocabularies.UI.v1.Facets">
46953
- * <Collection>
46954
- * <Record Type="com.sap.vocabularies.UI.v1.ReferenceFacet">
46955
- * <PropertyValue Property="Target" AnnotationPath="EQUIPMENT_2_PRODUCT/@com.sap.vocabularies.Common.v1.QuickInfo" />
46956
- * </Record>
46957
- * </Collection>
46958
- * </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>
46959
47255
  * </Annotations>
46960
47256
  * <Annotations Target="com.sap.gateway.default.iwbep.tea_busi_product.v0001.Product">
46961
- * <Annotation Term="com.sap.vocabularies.Common.v1.QuickInfo" Path="Name" />
47257
+ * <Annotation Term="com.sap.vocabularies.Common.v1.QuickInfo" Path="Name" />
46962
47258
  * </Annotations>
46963
47259
  * ```
46964
47260
  *
@@ -46972,16 +47268,16 @@ declare namespace sap {
46972
47268
  * ```javascript
46973
47269
  *
46974
47270
  * <Annotations Target="com.sap.gateway.default.iwbep.tea_busi.v0001.EQUIPMENT">
46975
- * <Annotation Term="com.sap.vocabularies.UI.v1.LineItem">
46976
- * <Collection>
46977
- * <Record Type="com.sap.vocabularies.UI.v1.DataField">
46978
- * <PropertyValue Property="Value" Path="EQUIPMENT_2_PRODUCT/Name" />
46979
- * </Record>
46980
- * </Collection>
46981
- * </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>
46982
47278
  * </Annotations>
46983
47279
  * <Annotations Target="com.sap.gateway.default.iwbep.tea_busi_product.v0001.Product/Name">
46984
- * <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" />
46985
47281
  * </Annotations>
46986
47282
  * ```
46987
47283
  *
@@ -47645,6 +47941,8 @@ declare namespace sap {
47645
47941
  *
47646
47942
  * Returns `undefined` if the data is not (yet) available; no request is triggered. Use {@link #requestObject}
47647
47943
  * for asynchronous access.
47944
+ *
47945
+ * The header context of a list binding only delivers `$count` (wrapped in an object if `sPath` is "").
47648
47946
  * See:
47649
47947
  * sap.ui.model.Context#getObject
47650
47948
  */
@@ -47688,7 +47986,8 @@ declare namespace sap {
47688
47986
  *
47689
47987
  * Returns whether there are pending changes for bindings dependent on this context, or for unresolved bindings
47690
47988
  * (see {@link sap.ui.model.Binding#isResolved}) which were dependent on this context at the time the pending
47691
- * 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.
47692
47991
  */
47693
47992
  hasPendingChanges(): boolean;
47694
47993
  /**
@@ -47706,6 +48005,7 @@ declare namespace sap {
47706
48005
  * Returns whether this context is inactive. The result of this function can also be accessed via instance
47707
48006
  * annotation "@$ui5.context.isInactive" at the entity.
47708
48007
  * See:
48008
+ * #isTransient
47709
48009
  * sap.ui.model.odata.v4.ODataListBinding#create
47710
48010
  * sap.ui.model.odata.v4.ODataListBinding#event:createActivate
47711
48011
  */
@@ -47725,6 +48025,8 @@ declare namespace sap {
47725
48025
  * `true` if the context is transient, meaning that the promise returned by {@link #created} is not yet
47726
48026
  * resolved or rejected, and returns `false` if the context is not transient. The result of this function
47727
48027
  * can also be accessed via instance annotation "@$ui5.context.isTransient" at the entity.
48028
+ * See:
48029
+ * #isInactive
47728
48030
  */
47729
48031
  isTransient(): boolean;
47730
48032
  /**
@@ -47784,6 +48086,8 @@ declare namespace sap {
47784
48086
  * "OData JSON Format Version 4.0". Note that the function clones the result. Modify values via {@link
47785
48087
  * sap.ui.model.odata.v4.Context#setProperty}.
47786
48088
  *
48089
+ * The header context of a list binding only delivers `$count` (wrapped in an object if `sPath` is "").
48090
+ *
47787
48091
  * If you want {@link #requestObject} to read fresh data, call {@link #refresh} first.
47788
48092
  * See:
47789
48093
  * #getBinding
@@ -48248,7 +48552,8 @@ declare namespace sap {
48248
48552
  * Returns `true` if this binding or its dependent bindings have pending property changes or created entities
48249
48553
  * which have not been sent successfully to the server. This function does not take into account the deletion
48250
48554
  * of entities (see {@link sap.ui.model.odata.v4.Context#delete}) and the execution of OData operations
48251
- * (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.
48252
48557
  *
48253
48558
  * Note: If this binding is relative, its data is cached separately for each parent context path. This method
48254
48559
  * returns `true` if there are pending changes for the current parent context path of this binding. If this
@@ -48259,7 +48564,10 @@ declare namespace sap {
48259
48564
  * Whether to ignore changes which will not be lost by APIs like {@link sap.ui.model.odata.v4.ODataListBinding#changeParameters
48260
48565
  * changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#sort
48261
48566
  * sort}, or {@link sap.ui.model.odata.v4.ODataListBinding#suspend suspend} because they relate to a {@link
48262
- * sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context of this binding.
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}).
48263
48571
  */
48264
48572
  bIgnoreKeptAlive?: boolean
48265
48573
  ): boolean;
@@ -48278,21 +48586,6 @@ declare namespace sap {
48278
48586
  * Method not supported
48279
48587
  */
48280
48588
  isInitial(): boolean;
48281
- /**
48282
- * @SINCE 1.95.0
48283
- * @deprecated (since 1.96.5)
48284
- * @EXPERIMENTAL
48285
- *
48286
- * Moves the bound entity into the given list binding. This binding loses its data. The method may only
48287
- * be called when this binding has finished loading. You can verify this by calling `oBinding.getBoundContext().requestObject()`.
48288
- * If that promise resolves, the binding has finished loading.
48289
- */
48290
- moveEntityTo(
48291
- /**
48292
- * The list binding to take the entity
48293
- */
48294
- oListBinding: sap.ui.model.odata.v4.ODataListBinding
48295
- ): void;
48296
48589
  /**
48297
48590
  * @SINCE 1.37.0
48298
48591
  *
@@ -48398,7 +48691,8 @@ declare namespace sap {
48398
48691
  * Suspends this binding. A suspended binding does not fire change events nor does it trigger data service
48399
48692
  * requests. Call {@link #resume} to resume the binding. Before 1.53.0, this method was not supported and
48400
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
48401
- * kept-alive} context of this binding.
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.
48402
48696
  * See:
48403
48697
  * {@link topic:b0f5c531e5034a27952cc748954cbe39 Suspend and Resume}
48404
48698
  * sap.ui.model.Binding#suspend
@@ -48575,9 +48869,9 @@ declare namespace sap {
48575
48869
  * For creating the new entity, the binding's update group ID is used, see {@link #getUpdateGroupId}.
48576
48870
  *
48577
48871
  * You can call {@link sap.ui.model.odata.v4.Context#delete} to delete the created context again. As long
48578
- * as the context is transient (see {@link sap.ui.model.odata.v4.Context#isTransient}), {@link #resetChanges}
48579
- * and a call to {@link sap.ui.model.odata.v4.ODataModel#resetChanges} with the update group ID as parameter
48580
- * 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.
48581
48875
  *
48582
48876
  * If the creation of the entity on the server failed, the creation is repeated automatically. If the binding's
48583
48877
  * update group ID has {@link sap.ui.model.odata.v4.SubmitMode.API}, it is repeated with the next call of
@@ -48623,14 +48917,19 @@ declare namespace sap {
48623
48917
  */
48624
48918
  bSkipRefresh?: boolean,
48625
48919
  /**
48626
- * Whether the entity is inserted at the end of the list. When creating multiple entities, this parameter
48627
- * 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.
48628
48923
  */
48629
48924
  bAtEnd?: boolean,
48630
48925
  /**
48631
48926
  * Create an inactive context. Such a context will only be sent to the server after the first property update.
48632
48927
  * From then on it behaves like any other created context. This parameter is experimental and its implementation
48633
- * may still change. Do not use it in productive code yet. Supported since 1.97.0
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}.
48634
48933
  */
48635
48934
  bInactive?: boolean
48636
48935
  ): sap.ui.model.odata.v4.Context;
@@ -48809,7 +49108,8 @@ declare namespace sap {
48809
49108
  * Returns the count of elements.
48810
49109
  *
48811
49110
  * If known, the value represents the sum of the element count of the collection on the server and the number
48812
- * 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
48813
49113
  * `Edm.Int64`. Since 1.91.0, in case of data aggregation with group levels, the count is the leaf count
48814
49114
  * on the server; it is only determined if the `$count` system query option is given.
48815
49115
  *
@@ -48878,6 +49178,24 @@ declare namespace sap {
48878
49178
  * #getCount
48879
49179
  */
48880
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;
48881
49199
  /**
48882
49200
  * @SINCE 1.37.0
48883
49201
  *
@@ -48925,7 +49243,8 @@ declare namespace sap {
48925
49243
  * Returns `true` if this binding or its dependent bindings have pending property changes or created entities
48926
49244
  * which have not been sent successfully to the server. This function does not take into account the deletion
48927
49245
  * of entities (see {@link sap.ui.model.odata.v4.Context#delete}) and the execution of OData operations
48928
- * (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.
48929
49248
  *
48930
49249
  * Note: If this binding is relative, its data is cached separately for each parent context path. This method
48931
49250
  * returns `true` if there are pending changes for the current parent context path of this binding. If this
@@ -48936,7 +49255,10 @@ declare namespace sap {
48936
49255
  * Whether to ignore changes which will not be lost by APIs like {@link sap.ui.model.odata.v4.ODataListBinding#changeParameters
48937
49256
  * changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#sort
48938
49257
  * sort}, or {@link sap.ui.model.odata.v4.ODataListBinding#suspend suspend} because they relate to a {@link
48939
- * sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context of this binding.
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}).
48940
49262
  */
48941
49263
  bIgnoreKeptAlive?: boolean
48942
49264
  ): boolean;
@@ -48950,6 +49272,13 @@ declare namespace sap {
48950
49272
  * #getRootBinding
48951
49273
  */
48952
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;
48953
49282
  /**
48954
49283
  * @SINCE 1.37.0
48955
49284
  *
@@ -49185,7 +49514,8 @@ declare namespace sap {
49185
49514
  * Suspends this binding. A suspended binding does not fire change events nor does it trigger data service
49186
49515
  * requests. Call {@link #resume} to resume the binding. Before 1.53.0, this method was not supported and
49187
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
49188
- * kept-alive} context of this binding.
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.
49189
49519
  * See:
49190
49520
  * {@link topic:b0f5c531e5034a27952cc748954cbe39 Suspend and Resume}
49191
49521
  * sap.ui.model.Binding#suspend
@@ -50009,7 +50339,7 @@ declare namespace sap {
50009
50339
  */
50010
50340
  synchronizationMode: string;
50011
50341
  /**
50012
- * 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`
50013
50343
  * is used. Valid update group IDs are `undefined`, '$auto', '$direct' or an application group ID.
50014
50344
  */
50015
50345
  updateGroupId?: string;
@@ -50190,6 +50520,11 @@ declare namespace sap {
50190
50520
  * from its context's path for data service requests; only the value `true` is allowed.
50191
50521
  */
50192
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;
50193
50528
  /**
50194
50529
  * The group ID to be used for **read** requests triggered by this binding; if not specified, either the
50195
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}.
@@ -50447,6 +50782,25 @@ declare namespace sap {
50447
50782
  */
50448
50783
  bIncludeContextId?: boolean
50449
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;
50450
50804
  /**
50451
50805
  * @SINCE 1.85.0
50452
50806
  *
@@ -50507,7 +50861,8 @@ declare namespace sap {
50507
50861
  * @SINCE 1.39.0
50508
50862
  *
50509
50863
  * Returns `true` if there are pending changes, meaning updates or created entities (see {@link sap.ui.model.odata.v4.ODataListBinding#create})
50510
- * 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.
50511
50866
  */
50512
50867
  hasPendingChanges(
50513
50868
  /**
@@ -50720,7 +51075,8 @@ declare namespace sap {
50720
51075
  * Returns `true` if this binding or its dependent bindings have pending property changes or created entities
50721
51076
  * which have not been sent successfully to the server. This function does not take into account the deletion
50722
51077
  * of entities (see {@link sap.ui.model.odata.v4.Context#delete}) and the execution of OData operations
50723
- * (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.
50724
51080
  *
50725
51081
  * Note: If this binding is relative, its data is cached separately for each parent context path. This method
50726
51082
  * returns `true` if there are pending changes for the current parent context path of this binding. If this
@@ -50731,7 +51087,10 @@ declare namespace sap {
50731
51087
  * Whether to ignore changes which will not be lost by APIs like {@link sap.ui.model.odata.v4.ODataListBinding#changeParameters
50732
51088
  * changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#sort
50733
51089
  * sort}, or {@link sap.ui.model.odata.v4.ODataListBinding#suspend suspend} because they relate to a {@link
50734
- * sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context of this binding.
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}).
50735
51094
  */
50736
51095
  bIgnoreKeptAlive?: boolean
50737
51096
  ): boolean;
@@ -54437,6 +54796,17 @@ declare namespace sap {
54437
54796
  */
54438
54797
  fnFilter: Function
54439
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;
54440
54810
  /**
54441
54811
  * Inserts the user-defined custom data into the model.
54442
54812
  */
@@ -55856,7 +56226,7 @@ declare namespace sap {
55856
56226
  /**
55857
56227
  * Update the bound control even if no data has been changed
55858
56228
  */
55859
- bForceUpdate: boolean
56229
+ bForceUpdate?: boolean
55860
56230
  ): void;
55861
56231
  /**
55862
56232
  * Resumes the binding update. Change events will be fired again.
@@ -65838,6 +66208,8 @@ declare namespace sap {
65838
66208
 
65839
66209
  "sap/ui/core/format/NumberFormat": undefined;
65840
66210
 
66211
+ "sap/ui/core/format/TimezoneUtil": undefined;
66212
+
65841
66213
  "sap/ui/core/Fragment": undefined;
65842
66214
 
65843
66215
  "sap/ui/core/History": undefined;
@@ -66222,6 +66594,8 @@ declare namespace sap {
66222
66594
 
66223
66595
  "sap/ui/model/odata/type/DateTimeOffset": undefined;
66224
66596
 
66597
+ "sap/ui/model/odata/type/DateTimeWithTimezone": undefined;
66598
+
66225
66599
  "sap/ui/model/odata/type/Decimal": undefined;
66226
66600
 
66227
66601
  "sap/ui/model/odata/type/Double": undefined;