@openui5/ts-types 1.118.0 → 1.119.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.
@@ -280,7 +280,7 @@ declare namespace sap {
280
280
  }
281
281
  }
282
282
 
283
- // For Library Version: 1.118.0
283
+ // For Library Version: 1.119.0
284
284
 
285
285
  declare module "sap/base/assert" {
286
286
  /**
@@ -2207,6 +2207,7 @@ declare module "sap/base/util/uid" {
2207
2207
  declare module "sap/base/util/UriParameters" {
2208
2208
  /**
2209
2209
  * @since 1.68
2210
+ * @deprecated (since 1.119) - See class description for details.
2210
2211
  *
2211
2212
  * Provides access to the individual parameters of a URL query string.
2212
2213
  *
@@ -2215,29 +2216,38 @@ declare module "sap/base/util/UriParameters" {
2215
2216
  * for a parameter and to {@link #getAll get a list of all values (`getAll()`)} for a parameter. Another
2216
2217
  * method allows to {@link #keys iterate over all parameter names (`keys()`)}.
2217
2218
  *
2218
- * The signature and behavior of those methods is aligned with the corresponding methods of the upcoming
2219
- * Web API `URLSearchParams`.
2220
- *
2221
2219
  * Decoding:
2222
2220
  *
2223
2221
  * The constructor and the factory methods expect percentage encoded input whereas all other APIs expect
2224
2222
  * and return decoded strings. After parsing the query string, any plus sign (0x2b) in names or values is
2225
2223
  * replaced by a blank (0x20) and the resulting strings are percentage decoded (`decodeURIComponent`).
2226
2224
  *
2227
- * Future Migration:
2225
+ * Deprecation:
2226
+ *
2227
+ * This class is deprecated in favor of the URL web standard classes `URLSearchParams` / `URL`.
2228
+ *
2229
+ * `UriParameters.fromQuery(input)` can be migrated to `new URLSearchParams(input)`
2230
+ *
2231
+ * `UriParameters.fromURL(input)` can be migrated to `new URL(input).searchParams`
2232
+ *
2233
+ * Caveats:
2228
2234
  *
2229
- * **Note:** To simplify a future migration from this class to the standard `URLSearchParams` API, consuming
2230
- * code should follow some recommendations:
2231
- * - do not use the constructor, either use {@link #.fromURL UriParameters.fromURL} when the input is
2232
- * a full URL, or use {@link #.fromQuery UriParameters.fromQuery} when the input only contains the query
2233
- * part of an URL (e.g. `location.search`).
2234
- * - do not use the `get` method with the second parameter `bAll`; use the `getAll` method instead
2235
- * - do not access the internal property `mParams` (you never should access internal properties of UI5
2236
- * classes or objects). With the predecessor of this API, access to `mParams` was often used to check whether
2237
- * a parameter is defined at all. Using the new `has` method or checking the result of `get` against `null`
2238
- * serves the same purpose. Callers using `UriParameters.fromQuery(input)` can be migrated to `new
2239
- * URLSearchParams(input)` once the new API is available in all supported browsers. Callers using `UriParameters.fromURL(input)`
2240
- * can be migrated to `new URL(input).searchParams` then.
2235
+ * The API has already been designed to be a drop-in replacement but there are some important caveats to
2236
+ * consider when switching to the standard APIs `URLSearchParams` / `URL`:
2237
+ * - `new URL(input).searchParams` validates the given URL according to the WHATWG URL Standard ({@link https://url.spec.whatwg.org}).
2238
+ * `UriParameters.fromURL(input)` only extracts the query string from the given input but does not perform
2239
+ * any validation.
2240
+ * - In some edge cases, especially for incomplete/invalid encoding, decoding behaves differently. Decoding
2241
+ * in `UriParameters` is described in the section above. For details about the encoding/decoding of `URLSearchParams`,
2242
+ * see the WHATWG URL Standard ({@link https://url.spec.whatwg.org}).
2243
+ * - The `get` method's second parameter, `bAll`, is not available; use the `getAll` method instead.
2244
+ * - The `keys` method's return value contains an entry for every occurrence of the key within the query,
2245
+ * in the defined order and including duplicates. `UriParameters#keys()` yields unique key values, even
2246
+ * when there are multiple values for the same key.
2247
+ * - The internal `mParams` property is not available anymore (you should never access internal properties
2248
+ * of UI5 classes or objects). With the predecessor of this API, access to `mParams` was often used to check
2249
+ * whether a parameter is defined at all. Using the `has` method or checking the result of `get` against
2250
+ * `null` serves the same purpose.
2241
2251
  */
2242
2252
  export default class UriParameters {
2243
2253
  /**
@@ -3255,6 +3265,24 @@ declare module "sap/ui/core/date/UI5Date" {
3255
3265
  }
3256
3266
  }
3257
3267
 
3268
+ declare module "sap/ui/core/getCompatibilityVersion" {
3269
+ import Version from "sap/base/util/Version";
3270
+
3271
+ /**
3272
+ * @deprecated (since 1.119.0)
3273
+ *
3274
+ * Returns the used compatibility version for the given feature.
3275
+ *
3276
+ * @returns the used compatibility version
3277
+ */
3278
+ export default function getCompatibilityVersion(
3279
+ /**
3280
+ * the key of desired feature
3281
+ */
3282
+ sFeature: string
3283
+ ): Version;
3284
+ }
3285
+
3258
3286
  declare module "sap/ui/core/InvisibleRenderer" {
3259
3287
  /**
3260
3288
  * @since 1.66.0
@@ -3320,6 +3348,37 @@ declare module "sap/ui/core/InvisibleRenderer" {
3320
3348
  export default InvisibleRenderer;
3321
3349
  }
3322
3350
 
3351
+ declare module "sap/ui/core/message/MessageType" {
3352
+ /**
3353
+ * @since 1.118
3354
+ *
3355
+ * Specifies possible message types.
3356
+ */
3357
+ enum MessageType {
3358
+ /**
3359
+ * Message is an error
3360
+ */
3361
+ Error = "Error",
3362
+ /**
3363
+ * Message should be just an information
3364
+ */
3365
+ Information = "Information",
3366
+ /**
3367
+ * Message has no specific level
3368
+ */
3369
+ None = "None",
3370
+ /**
3371
+ * Message is a success message
3372
+ */
3373
+ Success = "Success",
3374
+ /**
3375
+ * Message is a warning
3376
+ */
3377
+ Warning = "Warning",
3378
+ }
3379
+ export default MessageType;
3380
+ }
3381
+
3323
3382
  declare module "sap/ui/core/Messaging" {
3324
3383
  /**
3325
3384
  * @since 1.118.0
@@ -3419,6 +3478,47 @@ declare module "sap/ui/core/Messaging" {
3419
3478
  export default Messaging;
3420
3479
  }
3421
3480
 
3481
+ declare module "sap/ui/core/StaticArea" {
3482
+ /**
3483
+ * Helper module to access the static area.
3484
+ *
3485
+ * The static area is a hidden DOM element with a unique ID and managed by the framework. It is typically
3486
+ * used for hidden or temporarily hidden elements like InvisibleText, Popup, Shadow, Blocklayer etc.
3487
+ *
3488
+ * All methods throw an `Error` when they are called before the document is ready.
3489
+ */
3490
+ interface StaticArea {
3491
+ /**
3492
+ * Checks whether the given DOM element is part of the static area.
3493
+ *
3494
+ * @returns Whether the given DOM reference is part of the static UIArea
3495
+ */
3496
+ contains(
3497
+ /**
3498
+ * The DOM element to check
3499
+ */
3500
+ oDomRef: Element
3501
+ ): boolean;
3502
+ /**
3503
+ * Returns the root element of the static, hidden area.
3504
+ *
3505
+ * It can be used e.g. for hiding elements like Popup, Shadow, Blocklayer etc. If it is not yet available,
3506
+ * a DIV element is created and appended to the body.
3507
+ *
3508
+ * @returns the root DOM element of the static, hidden area
3509
+ */
3510
+ getDomRef(): Element;
3511
+ /**
3512
+ * Returns the `UIArea` instance for the static area. If none exists yet, one gets created.
3513
+ *
3514
+ * @returns The `UIArea` instance for the static area
3515
+ */
3516
+ getUIArea(): sap.ui.core.UIArea;
3517
+ }
3518
+ const StaticArea: StaticArea;
3519
+ export default StaticArea;
3520
+ }
3521
+
3422
3522
  declare module "sap/ui/core/syncStyleClass" {
3423
3523
  /**
3424
3524
  * @since 1.58
@@ -3454,7 +3554,11 @@ declare module "sap/ui/core/Theming" {
3454
3554
  */
3455
3555
  interface Theming {
3456
3556
  /**
3457
- * Attaches event handler `fnFunction` to the {@link #event:applied applied} event
3557
+ * Attaches event handler `fnFunction` to the {@link #event:applied applied} event.
3558
+ *
3559
+ * The given handler is called when the the applied event is fired. If the theme is already applied the
3560
+ * handler will be called immediately. The handler stays attached to the applied event for future theme
3561
+ * changes.
3458
3562
  */
3459
3563
  attachApplied(
3460
3564
  /**
@@ -3479,6 +3583,10 @@ declare module "sap/ui/core/Theming" {
3479
3583
  * @returns the theme name
3480
3584
  */
3481
3585
  getTheme(): string;
3586
+ /**
3587
+ * Notify content density changes
3588
+ */
3589
+ notifyContentDensityChanged(): void;
3482
3590
  /**
3483
3591
  * Allows setting the theme name
3484
3592
  *
@@ -10701,7 +10809,7 @@ declare namespace sap {
10701
10809
  * the same ID as an element or another `ManagedObject`.
10702
10810
  *
10703
10811
  * For the same reason, there is no general lookup for `ManagedObject`s via their ID. Only for subclasses
10704
- * that enforce unique IDs, there might be lookup mechanisms (e.g. {@link sap.ui.core.Core#byId sap.ui.getCore().byId() }
10812
+ * that enforce unique IDs, there might be lookup mechanisms (e.g. {@link sap.ui.core.Element#getElementById sap.ui.core.Element.getElementById }
10705
10813
  * for elements).
10706
10814
  *
10707
10815
  * @returns The objects's ID.
@@ -11611,6 +11719,14 @@ declare namespace sap {
11611
11719
  */
11612
11720
  oAggregatedObject: sap.ui.base.ManagedObject
11613
11721
  ): void;
11722
+ /**
11723
+ * @since 1.119.0
11724
+ *
11725
+ * Get the prefix used for the generated IDs from configuration
11726
+ *
11727
+ * @returns The prefix for the generated IDs
11728
+ */
11729
+ static getUIDPrefix(): string;
11614
11730
  /**
11615
11731
  * Test whether a given ID looks like it was automatically generated.
11616
11732
  *
@@ -13424,7 +13540,7 @@ declare namespace sap {
13424
13540
  /**
13425
13541
  * @since 1.56
13426
13542
  *
13427
- * This event is fired when a drag operation is being ended.
13543
+ * This event is fired when a drag operation is ended.
13428
13544
  */
13429
13545
  dragEnd?: (oEvent: DragInfo$DragEndEvent) => void;
13430
13546
  }
@@ -13499,7 +13615,7 @@ declare namespace sap {
13499
13615
  /**
13500
13616
  * The underlying browser event
13501
13617
  */
13502
- browserEvent?: Event;
13618
+ browserEvent?: DragEvent;
13503
13619
  }
13504
13620
 
13505
13621
  interface DragInfo$DragEndEventParameters {
@@ -13516,7 +13632,7 @@ declare namespace sap {
13516
13632
  /**
13517
13633
  * The underlying browser event
13518
13634
  */
13519
- browserEvent?: Event;
13635
+ browserEvent?: DragEvent;
13520
13636
  }
13521
13637
 
13522
13638
  interface DragInfo$DragStartEventParameters {
@@ -13533,7 +13649,7 @@ declare namespace sap {
13533
13649
  /**
13534
13650
  * The underlying browser event
13535
13651
  */
13536
- browserEvent?: Event;
13652
+ browserEvent?: DragEvent;
13537
13653
  }
13538
13654
 
13539
13655
  interface DropInfo$DragEnterEventParameters {
@@ -13550,7 +13666,7 @@ declare namespace sap {
13550
13666
  /**
13551
13667
  * The underlying browser event
13552
13668
  */
13553
- browserEvent?: Event;
13669
+ browserEvent?: DragEvent;
13554
13670
  }
13555
13671
 
13556
13672
  interface DropInfo$DragOverEventParameters {
@@ -13565,14 +13681,14 @@ declare namespace sap {
13565
13681
  dragSession?: sap.ui.core.dnd.DragSession;
13566
13682
 
13567
13683
  /**
13568
- * The calculated position of the drop action relative to the `target`.
13684
+ * The calculated position of the drop action relative to the `target`
13569
13685
  */
13570
13686
  dropPosition?: sap.ui.core.dnd.RelativeDropPosition;
13571
13687
 
13572
13688
  /**
13573
13689
  * The underlying browser event
13574
13690
  */
13575
- browserEvent?: Event;
13691
+ browserEvent?: DragEvent;
13576
13692
  }
13577
13693
 
13578
13694
  interface DropInfo$DropEventParameters {
@@ -13592,14 +13708,14 @@ declare namespace sap {
13592
13708
  droppedControl?: sap.ui.core.Element;
13593
13709
 
13594
13710
  /**
13595
- * The calculated position of the drop action relative to the `droppedControl`.
13711
+ * The calculated position of the drop action relative to the `droppedControl`
13596
13712
  */
13597
13713
  dropPosition?: sap.ui.core.dnd.RelativeDropPosition;
13598
13714
 
13599
13715
  /**
13600
13716
  * The underlying browser event
13601
13717
  */
13602
- browserEvent?: Event;
13718
+ browserEvent?: DragEvent;
13603
13719
  }
13604
13720
 
13605
13721
  /**
@@ -14095,7 +14211,7 @@ declare namespace sap {
14095
14211
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
14096
14212
  * otherwise it will be bound to this `sap.ui.core.dnd.DragInfo` itself.
14097
14213
  *
14098
- * This event is fired when a drag operation is being ended.
14214
+ * This event is fired when a drag operation is ended.
14099
14215
  *
14100
14216
  * @returns Reference to `this` in order to allow method chaining
14101
14217
  */
@@ -14122,7 +14238,7 @@ declare namespace sap {
14122
14238
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
14123
14239
  * otherwise it will be bound to this `sap.ui.core.dnd.DragInfo` itself.
14124
14240
  *
14125
- * This event is fired when a drag operation is being ended.
14241
+ * This event is fired when a drag operation is ended.
14126
14242
  *
14127
14243
  * @returns Reference to `this` in order to allow method chaining
14128
14244
  */
@@ -16968,17 +17084,28 @@ declare namespace sap {
16968
17084
  ): void;
16969
17085
  }
16970
17086
  /**
16971
- * @deprecated (since 1.118) - Please use {@link sap.ui.core.Messaging Messaging} instead.
17087
+ * @deprecated (since 1.118) - Please use {@link module:sap/ui/core/Messaging Messaging} instead.
16972
17088
  */
16973
17089
  class MessageManager extends sap.ui.base.Object {
16974
17090
  /**
16975
17091
  * Constructor for a new MessageManager.
16976
17092
  *
16977
- * Creating own instances of MessageManager is deprecated. Please require 'sap/ui/core/Messaging' instead
16978
- * and use the module export directly without using 'new'.
17093
+ * Creating own instances of MessageManager is deprecated. Please require {@link module:sap/ui/core/Messaging 'sap/ui/core/Messaging' }
17094
+ * instead and use the module export directly without using 'new'.
16979
17095
  */
16980
17096
  constructor();
16981
17097
 
17098
+ /**
17099
+ * Add messages to Messaging
17100
+ */
17101
+ static addMessages(
17102
+ /**
17103
+ * Array of sap.ui.core.message.Message or single sap.ui.core.message.Message
17104
+ */
17105
+ vMessages:
17106
+ | sap.ui.core.message.Message
17107
+ | sap.ui.core.message.Message[]
17108
+ ): void;
16982
17109
  /**
16983
17110
  * Creates a new subclass of class sap.ui.core.message.MessageManager with name `sClassName` and enriches
16984
17111
  * it with the information contained in `oClassInfo`.
@@ -17002,12 +17129,92 @@ declare namespace sap {
17002
17129
  */
17003
17130
  FNMetaImpl?: Function
17004
17131
  ): Function;
17132
+ /**
17133
+ * Get the MessageModel
17134
+ *
17135
+ * @returns oMessageModel The Message Model
17136
+ */
17137
+ static getMessageModel(): sap.ui.model.message.MessageModel;
17005
17138
  /**
17006
17139
  * Returns a metadata object for class sap.ui.core.message.MessageManager.
17007
17140
  *
17008
17141
  * @returns Metadata object describing this class
17009
17142
  */
17010
17143
  static getMetadata(): sap.ui.base.Metadata;
17144
+ /**
17145
+ * Register MessageProcessor
17146
+ */
17147
+ static registerMessageProcessor(
17148
+ /**
17149
+ * The MessageProcessor
17150
+ */
17151
+ oProcessor: sap.ui.core.message.MessageProcessor
17152
+ ): void;
17153
+ /**
17154
+ * When using the databinding type system, the validation/parsing of a new property value could fail. In
17155
+ * this case, a validationError/parseError event is fired. These events bubble up to the core. For registered
17156
+ * ManagedObjects, the Messaging attaches to these events and creates a `sap.ui.core.message.Message` (bHandleValidation=true)
17157
+ * for each of these errors and cancels the event bubbling.
17158
+ */
17159
+ static registerObject(
17160
+ /**
17161
+ * The sap.ui.base.ManagedObject
17162
+ */
17163
+ oObject: sap.ui.base.ManagedObject,
17164
+ /**
17165
+ * Handle validationError/parseError events for this object. If set to true, the Messaging creates a Message
17166
+ * for each validation/parse error. The event bubbling is canceled in every case.
17167
+ */
17168
+ bHandleValidation: boolean
17169
+ ): void;
17170
+ /**
17171
+ * Remove all messages
17172
+ */
17173
+ static removeAllMessages(): void;
17174
+ /**
17175
+ * Remove given Messages
17176
+ */
17177
+ static removeMessages(
17178
+ /**
17179
+ * The message(s) to be removed.
17180
+ */
17181
+ vMessages:
17182
+ | sap.ui.core.message.Message
17183
+ | sap.ui.core.message.Message[]
17184
+ ): void;
17185
+ /**
17186
+ * Deregister MessageProcessor
17187
+ */
17188
+ static unregisterMessageProcessor(
17189
+ /**
17190
+ * The MessageProcessor
17191
+ */
17192
+ oProcessor: sap.ui.core.message.MessageProcessor
17193
+ ): void;
17194
+ /**
17195
+ * Unregister ManagedObject
17196
+ */
17197
+ static unregisterObject(
17198
+ /**
17199
+ * The sap.ui.base.ManagedObject
17200
+ */
17201
+ oObject: sap.ui.base.ManagedObject
17202
+ ): void;
17203
+ /**
17204
+ * Update Messages by providing two arrays of old and new messages.
17205
+ *
17206
+ * The old ones will be removed, the new ones will be added.
17207
+ */
17208
+ static updateMessages(
17209
+ /**
17210
+ * Array of old messages to be removed
17211
+ */
17212
+ aOldMessages: sap.ui.core.message.Message[],
17213
+ /**
17214
+ * Array of new messages to be added
17215
+ */
17216
+ aNewMessages: sap.ui.core.message.Message[]
17217
+ ): void;
17011
17218
  }
17012
17219
  /**
17013
17220
  * This is an abstract base class for MessageParser objects.
@@ -17184,7 +17391,7 @@ declare namespace sap {
17184
17391
  oListener?: object
17185
17392
  ): this;
17186
17393
  /**
17187
- * @deprecated - 1.115 Use {@link sap.ui.core.Messaging#updateMessages} instead
17394
+ * @deprecated (since 1.115) - Use {@link module:sap/ui/core/Messaging.updateMessages} instead
17188
17395
  * @ui5-protected Do not call from applications (only from related classes in the framework)
17189
17396
  *
17190
17397
  * Fires event {@link #event:messageChange messageChange} to attached listeners.
@@ -17213,31 +17420,6 @@ declare namespace sap {
17213
17420
  mMessages: Record<string, sap.ui.core.message.Message[]>
17214
17421
  ): void;
17215
17422
  }
17216
- /**
17217
- * Specifies possible message types.
17218
- */
17219
- enum MessageType {
17220
- /**
17221
- * Message is an error
17222
- */
17223
- Error = "Error",
17224
- /**
17225
- * Message should be just an information
17226
- */
17227
- Information = "Information",
17228
- /**
17229
- * Message has no specific level
17230
- */
17231
- None = "None",
17232
- /**
17233
- * Message is a success message
17234
- */
17235
- Success = "Success",
17236
- /**
17237
- * Message is a warning
17238
- */
17239
- Warning = "Warning",
17240
- }
17241
17423
 
17242
17424
  type MessageProcessor$MessageChangeEvent = sap.ui.base.Event<
17243
17425
  MessageProcessor$MessageChangeEventParameters,
@@ -18779,7 +18961,7 @@ declare namespace sap {
18779
18961
  * Returns an element by its ID in the context of this view.
18780
18962
  *
18781
18963
  * This method expects a view-local ID of an element (the same as e.g. defined in the *.view.xml of an XMLView).
18782
- * For a search with a global ID (the value returned by `oElement.getId()`) you should rather use {@link sap.ui.core.Core#byId sap.ui.getCore().byId()}.
18964
+ * For a search with a global ID (the value returned by `oElement.getId()`) you should rather use {@link sap.ui.core.Element#getElementById Element.getElementById}.
18783
18965
  *
18784
18966
  * @returns Element by its ID or `undefined`
18785
18967
  */
@@ -20413,20 +20595,6 @@ declare namespace sap {
20413
20595
  */
20414
20596
  thisArg?: Object
20415
20597
  ): void;
20416
- /**
20417
- * Retrieves an Element by its ID.
20418
- *
20419
- * When the ID is `null` or `undefined` or when there's no element with the given ID, then `undefined` is
20420
- * returned.
20421
- *
20422
- * @returns Element with the given ID or `undefined`
20423
- */
20424
- get(
20425
- /**
20426
- * ID of the element to retrieve
20427
- */
20428
- id: sap.ui.core.ID
20429
- ): sap.ui.core.Element | undefined;
20430
20598
  }
20431
20599
 
20432
20600
  /**
@@ -30309,6 +30477,8 @@ declare namespace sap {
30309
30477
  getAccessibility(): boolean;
30310
30478
  /**
30311
30479
  * @since 1.77.0
30480
+ * @deprecated (since 1.118) - Please use {@link module:sap/base/i18n/Localization.getActiveTerminologies }
30481
+ * instead.
30312
30482
  *
30313
30483
  * Returns the list of active terminologies defined via the Configuration.
30314
30484
  *
@@ -30376,6 +30546,8 @@ declare namespace sap {
30376
30546
  */
30377
30547
  getCalendarWeekNumbering(): sap.ui.core.date.CalendarWeekNumbering;
30378
30548
  /**
30549
+ * @deprecated (since 1.119.0)
30550
+ *
30379
30551
  * Returns the used compatibility version for the given feature.
30380
30552
  *
30381
30553
  * @returns the used compatibility version
@@ -30584,6 +30756,9 @@ declare namespace sap {
30584
30756
  */
30585
30757
  getTimezone(): string;
30586
30758
  /**
30759
+ * @deprecated (since 1.119.0) - Please use {@link sap.ui.base.ManagedObjectMetadata.getUIDPrefix ManagedObjectMetadata.getUIDPrefix }
30760
+ * instead.
30761
+ *
30587
30762
  * Prefix to be used for automatically generated control IDs. Default is a double underscore "__".
30588
30763
  *
30589
30764
  * @returns the prefix to be used
@@ -30807,65 +30982,54 @@ declare namespace sap {
30807
30982
  /**
30808
30983
  * Core Class of the SAP UI Library.
30809
30984
  *
30810
- * This class boots the Core framework and makes it available for the application via method `sap.ui.getCore()`.
30811
- *
30812
- * Example:
30813
- * ```javascript
30814
- *
30815
- *
30816
- * var oCore = sap.ui.getCore();
30817
- *
30818
- * ```
30985
+ * This class boots the Core framework and makes it available for the application by requiring `sap.ui.core.Core`.
30819
30986
  *
30820
- *
30821
- * With methods of the Core framework you can {@link #attachInit execute code} after the framework has been
30822
- * initialized. It provides access to the {@link #getConfiguration configuration} and exposes events that
30823
- * an application or a control can register to (e.g. {@link #event:localizationChanged localizationChanged},
30824
- * {@link #event:parseError parseError}, {@link #event:validationError validationError}, {@link #event:formatError formatError},
30825
- * {@link #event:validationSuccess validationSuccess}).
30987
+ * The Core provides a {@link #ready ready function} to execute code after the core was booted.
30826
30988
  *
30827
30989
  * Example:
30828
30990
  * ```javascript
30829
30991
  *
30830
30992
  *
30831
- * oCore.attachInit(function() {
30832
- * if ( oCore.getConfiguration().getRTL() ) {
30993
+ * oCore.ready(function() {
30833
30994
  * ...
30834
- * }
30835
30995
  * });
30836
30996
  *
30837
- * oCore.attachLocalizationChanged(function(oEvent) {
30838
- * ...
30839
- * });
30997
+ * await oCore.ready();
30998
+ * ...
30840
30999
  *
30841
31000
  * ```
30842
31001
  */
30843
31002
  interface Core {
30844
31003
  /**
30845
- * Creates a new subclass of class sap.ui.core.Core with name `sClassName` and enriches it with the information
31004
+ * @deprecated (since 1.119.0)
31005
+ *
31006
+ * Creates a new subclass of class `sap.ui.core.Core` with name `sClassName` and enriches it with the information
30846
31007
  * contained in `oClassInfo`.
30847
31008
  *
30848
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
31009
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.ManagedObject.extend}.
30849
31010
  *
30850
- * @returns Created class / constructor function
31011
+ * @returns The created class / constructor function
30851
31012
  */
30852
31013
  extend(
30853
31014
  /**
30854
- * Name of the class being created
31015
+ * Qualified name of the newly created class
30855
31016
  */
30856
31017
  sClassName: string,
30857
31018
  /**
30858
31019
  * Object literal with information about the class
30859
31020
  */
30860
- oClassInfo?: object,
30861
- /**
30862
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
30863
- * used by this class
30864
- */
30865
- FNMetaImpl?: Function
31021
+ oClassInfo?: {
31022
+ /**
31023
+ * The metadata object describing the class. See {@link sap.ui.core.Component.MetadataOptions MetadataOptions }
31024
+ * for the values allowed in every extend.
31025
+ */
31026
+ metadata?: sap.ui.core.Component.MetadataOptions;
31027
+ }
30866
31028
  ): Function;
30867
31029
  /**
30868
- * Returns a metadata object for class sap.ui.core.Core.
31030
+ * @deprecated (since 1.119.0)
31031
+ *
31032
+ * Returns the metadata for class `sap.ui.core.Core`.
30869
31033
  *
30870
31034
  * @returns Metadata object describing this class
30871
31035
  */
@@ -30880,6 +31044,8 @@ declare namespace sap {
30880
31044
  */
30881
31045
  applyChanges(): void;
30882
31046
  /**
31047
+ * @deprecated (since 1.119) - Please use {@link module:sap/ui/core/Theming.setTheme Theming.setTheme} instead.
31048
+ *
30883
31049
  * Applies the theme with the given name (by loading the respective style sheets, which does not disrupt
30884
31050
  * the application).
30885
31051
  *
@@ -30908,6 +31074,8 @@ declare namespace sap {
30908
31074
  sThemeBaseUrl?: string
30909
31075
  ): void;
30910
31076
  /**
31077
+ * @deprecated (since 1.119)
31078
+ *
30911
31079
  * Registers a listener for control events.
30912
31080
  *
30913
31081
  * When called, the context of the listener (its `this`) will be bound to `oListener` if specified, otherwise
@@ -31233,6 +31401,9 @@ declare namespace sap {
31233
31401
  vFieldGroupIds?: string | string[]
31234
31402
  ): sap.ui.core.Control[];
31235
31403
  /**
31404
+ * @deprecated (since 1.119) - Please use {@link sap.ui.core.Element.getElementById Element.getElementById }
31405
+ * instead.
31406
+ *
31236
31407
  * Returns the registered element with the given ID, if any.
31237
31408
  *
31238
31409
  * The ID must be the globally unique ID of an element, the same as returned by `oElement.getId()`.
@@ -31311,6 +31482,8 @@ declare namespace sap {
31311
31482
  mSettings?: object
31312
31483
  ): sap.ui.core.Component | Promise<sap.ui.core.Component>;
31313
31484
  /**
31485
+ * @deprecated (since 1.119)
31486
+ *
31314
31487
  * Returns a new instance of the RenderManager for exclusive use by the caller.
31315
31488
  *
31316
31489
  * The caller must take care to destroy the render manager when it is no longer needed. Calling this method
@@ -31333,6 +31506,8 @@ declare namespace sap {
31333
31506
  oDomRef: string | /* was Element */ global_Element
31334
31507
  ): sap.ui.core.UIArea;
31335
31508
  /**
31509
+ * @deprecated (since 1.119)
31510
+ *
31336
31511
  * Unregisters a listener for control events.
31337
31512
  *
31338
31513
  * The passed function and listener object must match the ones used for event registration.
@@ -31663,6 +31838,10 @@ declare namespace sap {
31663
31838
  sId: sap.ui.core.ID | null | undefined
31664
31839
  ): sap.ui.core.Element | undefined;
31665
31840
  /**
31841
+ * @deprecated (since 1.119) - Please use {@link sap.ui.core.Element.getActiveElement Element.getActiveElement }
31842
+ * to get the currently focused element. You can then retrieve the ID of that element with {@link sap.ui.core.Element#getId Element#getId}.
31843
+ * Please be aware, {@link sap.ui.core.Element.getActiveElement Element.getActiveElement} can return 'undefined'.
31844
+ *
31666
31845
  * Returns the Id of the control/element currently in focus.
31667
31846
  *
31668
31847
  * @returns the Id of the control/element currently in focus.
@@ -31683,6 +31862,8 @@ declare namespace sap {
31683
31862
  ): sap.ui.core.Element | undefined;
31684
31863
  /**
31685
31864
  * @since 1.8.0
31865
+ * @deprecated (since 1.119.0) - Please use {@link sap.ui.core.EventBus.getInstance EventBus.getInstance }
31866
+ * for global usage instead. Creating an own local instance is the preferred usage.
31686
31867
  *
31687
31868
  * Returns the event bus.
31688
31869
  *
@@ -31690,6 +31871,9 @@ declare namespace sap {
31690
31871
  */
31691
31872
  getEventBus(): sap.ui.core.EventBus;
31692
31873
  /**
31874
+ * @deprecated (since 1.119) - Please use {@link sap.ui.core.Lib.getResourceBundleFor Lib.getResourceBundleFor }
31875
+ * instead.
31876
+ *
31693
31877
  * Retrieves a resource bundle for the given library and locale.
31694
31878
  *
31695
31879
  * If only one argument is given, it is assumed to be the libraryName. The locale then falls back to the
@@ -31740,6 +31924,9 @@ declare namespace sap {
31740
31924
  | undefined
31741
31925
  | Promise<import("sap/base/i18n/ResourceBundle").default | undefined>;
31742
31926
  /**
31927
+ * @deprecated (since 1.119) - Please use {@link sap.ui.core.Lib.getResourceBundleFor Lib.getResourceBundleFor }
31928
+ * instead.
31929
+ *
31743
31930
  * Retrieves a resource bundle for the given library and locale.
31744
31931
  *
31745
31932
  * If only one argument is given, it is assumed to be the libraryName. The locale then falls back to the
@@ -31786,6 +31973,8 @@ declare namespace sap {
31786
31973
  | undefined
31787
31974
  | Promise<import("sap/base/i18n/ResourceBundle").default | undefined>;
31788
31975
  /**
31976
+ * @deprecated (since 1.119)
31977
+ *
31789
31978
  * Returns a map of library info objects for all currently loaded libraries, keyed by their names.
31790
31979
  *
31791
31980
  * The structure of the library info objects matches the structure of the info object that the {@link #initLibrary }
@@ -31801,11 +31990,11 @@ declare namespace sap {
31801
31990
  getLoadedLibraries(): Record<string, Object>;
31802
31991
  /**
31803
31992
  * @since 1.33.0
31804
- * @deprecated (since 1.119) - Please use {@link sap.ui.core.Messaging Messaging} instead.
31993
+ * @deprecated (since 1.118) - Please use {@link module:sap/ui/core/Messaging Messaging} instead.
31805
31994
  *
31806
- * Returns the active `MessageManager` instance.
31995
+ * Returns the `Messaging` module.
31807
31996
  */
31808
- getMessageManager(): sap.ui.core.message.MessageManager;
31997
+ getMessageManager(): import("sap/ui/core/Messaging").default;
31809
31998
  /**
31810
31999
  * @deprecated (since 1.118) - Please use {@link sap.ui.base.ManagedObject#getModel ManagedObject#getModel }
31811
32000
  * instead.
@@ -31842,6 +32031,9 @@ declare namespace sap {
31842
32031
  */
31843
32032
  getRootComponent(): sap.ui.core.Component;
31844
32033
  /**
32034
+ * @deprecated (since 1.119.0) - Please use {@link module:sap/ui/core/StaticArea.getDomRef StaticArea.getDomRef }
32035
+ * instead.
32036
+ *
31845
32037
  * Returns the static, hidden area DOM element belonging to this core instance.
31846
32038
  *
31847
32039
  * It can be used e.g. for hiding elements like Popups, Shadow, Blocklayer etc.
@@ -31861,8 +32053,8 @@ declare namespace sap {
31861
32053
  */
31862
32054
  getTemplate(sId: string): sap.ui.core.Component;
31863
32055
  /**
31864
- * @deprecated (since 1.107) - use {@link sap.ui.core.UIArea.registry#get UIArea.registry#get} instead,
31865
- * but note that `UIArea.registry.get` only accepts the ID of the UIArea as argument.
32056
+ * @deprecated (since 1.107) - For access to the static UIArea, please use the {@link module:sap/ui/core/StaticArea StaticArea }
32057
+ * instead.
31866
32058
  *
31867
32059
  * Returns the {@link sap.ui.core.UIArea UIArea} with the given ID or that belongs to the given DOM element.
31868
32060
  *
@@ -31893,6 +32085,8 @@ declare namespace sap {
31893
32085
  */
31894
32086
  hasModel(): boolean;
31895
32087
  /**
32088
+ * @deprecated (since 1.119)
32089
+ *
31896
32090
  * Includes a library theme into the current page (if a variant is specified it will include the variant
31897
32091
  * library theme)
31898
32092
  */
@@ -31911,6 +32105,8 @@ declare namespace sap {
31911
32105
  sQuery?: string
31912
32106
  ): void;
31913
32107
  /**
32108
+ * @deprecated (since 1.119) - Please use {@link sap.ui.core.Lib.init Lib.init} instead.
32109
+ *
31914
32110
  * Provides the framework with information about a library.
31915
32111
  *
31916
32112
  * This method is intended to be called exactly once while the main module of a library (its `library.js`
@@ -32003,6 +32199,8 @@ declare namespace sap {
32003
32199
  */
32004
32200
  isMobile(): boolean;
32005
32201
  /**
32202
+ * @deprecated (since 1.119.0) - Please use {@link module:sap/ui/core/StaticArea.contains StaticArea.contains }
32203
+ * instead.
32006
32204
  * @ui5-protected Do not call from applications (only from related classes in the framework)
32007
32205
  *
32008
32206
  * Checks whether the given DOM element is the root of the static area.
@@ -32016,6 +32214,9 @@ declare namespace sap {
32016
32214
  oDomRef: /* was Element */ global_Element
32017
32215
  ): boolean;
32018
32216
  /**
32217
+ * @deprecated (since 1.119) - Please use {@link module:sap/ui/core/Theming.attachApplied Theming.attachApplied }
32218
+ * instead.
32219
+ *
32019
32220
  * Returns true, if the styles of the current theme are already applied, false otherwise.
32020
32221
  *
32021
32222
  * This function must not be used before the init event of the Core. If the styles are not yet applied a
@@ -32025,6 +32226,8 @@ declare namespace sap {
32025
32226
  */
32026
32227
  isThemeApplied(): boolean;
32027
32228
  /**
32229
+ * @deprecated (since 1.119) - Please use {@link sap.ui.core.Lib.load Lib.load} instead.
32230
+ *
32028
32231
  * Loads the given library and its dependencies and makes its content available to the application.
32029
32232
  *
32030
32233
  * What it does:
@@ -32125,6 +32328,9 @@ declare namespace sap {
32125
32328
  */
32126
32329
  lock(): void;
32127
32330
  /**
32331
+ * @deprecated (since 1.119) - Please use {@link module:sap/ui/core/Theming.notifyContentDensityChanged Theming.notifyContentDensityChanged }
32332
+ * instead.
32333
+ *
32128
32334
  * Triggers a realignment of controls
32129
32335
  *
32130
32336
  * This method should be called after changing the cozy/compact CSS class of a DOM element at runtime, for
@@ -32216,6 +32422,7 @@ declare namespace sap {
32216
32422
  ): void;
32217
32423
  /**
32218
32424
  * @since 1.10
32425
+ * @deprecated (since 1.119)
32219
32426
  *
32220
32427
  * Defines the root directory from below which UI5 should load the theme with the given name. Optionally
32221
32428
  * allows restricting the setting to parts of a theme covering specific control libraries.
@@ -32285,6 +32492,7 @@ declare namespace sap {
32285
32492
  ): this;
32286
32493
  /**
32287
32494
  * @since 1.10
32495
+ * @deprecated (since 1.119)
32288
32496
  *
32289
32497
  * Defines the root directory from below which UI5 should load the theme with the given name. Optionally
32290
32498
  * allows restricting the setting to parts of a theme covering specific control libraries.
@@ -33844,6 +34052,8 @@ declare namespace sap {
33844
34052
  onDeactivate(): void;
33845
34053
  /**
33846
34054
  * @since 1.15.1
34055
+ * @deprecated (since 1.119) - recommended to use the browser-native page lifecycle API, providing events
34056
+ * such as 'pageshow' and 'pagehide'
33847
34057
  *
33848
34058
  * The window before unload hook. Override this method in your Component class implementation, to handle
33849
34059
  * cleanup before the real unload or to prompt a question to the user, if the component should be exited.
@@ -33854,6 +34064,8 @@ declare namespace sap {
33854
34064
  onWindowBeforeUnload(): string | undefined;
33855
34065
  /**
33856
34066
  * @since 1.15.1
34067
+ * @deprecated (since 1.119) - recommended to use the browser-native API to listen for errors: window.addEventListener("error",
34068
+ * function() { ... })
33857
34069
  *
33858
34070
  * The window error hook. Override this method in your Component class implementation to listen to unhandled
33859
34071
  * errors.
@@ -33874,6 +34086,9 @@ declare namespace sap {
33874
34086
  ): void;
33875
34087
  /**
33876
34088
  * @since 1.15.1
34089
+ * @deprecated (since 1.119) - Newer browser versions deprecate the browser-native 'unload' event. Therefore,
34090
+ * the former API won't reliably work anymore. Please have a look at the browser-native page lifecycle API,
34091
+ * e.g. its events 'pageshow' and 'pagehide'.
33877
34092
  *
33878
34093
  * The window unload hook. Override this method in your Component class implementation, to handle cleanup
33879
34094
  * of the component once the window will be unloaded (e.g. closed).
@@ -35921,7 +36136,7 @@ declare namespace sap {
35921
36136
  * to `data-sap-ui`
35922
36137
  */
35923
36138
  bIncludeRelated?: boolean
35924
- ): sap.ui.core.Element;
36139
+ ): sap.ui.core.Element | undefined;
35925
36140
  /**
35926
36141
  * @deprecated (since 1.3.1) - Use the static `extend` method of the desired base class (e.g. {@link sap.ui.core.Element.extend})
35927
36142
  *
@@ -35988,6 +36203,28 @@ declare namespace sap {
35988
36203
  */
35989
36204
  FNMetaImpl?: Function
35990
36205
  ): Function;
36206
+ /**
36207
+ * @since 1.119
36208
+ *
36209
+ * Returns the element currently in focus.
36210
+ *
36211
+ * @returns The currently focused element
36212
+ */
36213
+ static getActiveElement(): sap.ui.core.Element | undefined;
36214
+ /**
36215
+ * Retrieves an Element by its ID.
36216
+ *
36217
+ * When the ID is `null` or `undefined` or when there's no element with the given ID, then `undefined` is
36218
+ * returned.
36219
+ *
36220
+ * @returns Element with the given ID or `undefined`
36221
+ */
36222
+ static getElementById(
36223
+ /**
36224
+ * ID of the element to retrieve
36225
+ */
36226
+ id: sap.ui.core.ID
36227
+ ): sap.ui.core.Element | undefined;
35991
36228
  /**
35992
36229
  * Returns a metadata object for class sap.ui.core.Element.
35993
36230
  *
@@ -36903,6 +37140,14 @@ declare namespace sap {
36903
37140
  */
36904
37141
  FNMetaImpl?: Function
36905
37142
  ): Function;
37143
+ /**
37144
+ * @since 1.119.0
37145
+ *
37146
+ * Returns the singleton instance of the EventBus for global usage.
37147
+ *
37148
+ * @returns the event bus
37149
+ */
37150
+ static getInstance(): sap.ui.core.EventBus;
36906
37151
  /**
36907
37152
  * Returns a metadata object for class sap.ui.core.EventBus.
36908
37153
  *
@@ -38907,17 +39152,11 @@ declare namespace sap {
38907
39152
  /**
38908
39153
  * @since 1.118
38909
39154
  *
38910
- * Library Loading: To load a library, {@link #.load} can be used directly without creating a library instance
38911
- * in advance.
39155
+ * Constructor must not be used: To load a library, please use the static method {@link #.load}.
38912
39156
  *
38913
- * What a library does:
38914
- * - preload: {@link #preload} loads the library-preload bundle and its resource bundle and apply the
38915
- * same for its dependencies
38916
- * - theming: {@link #_includeTheme} creates a <link> in the page referring to the corresponding
38917
- * `library.css`
38918
- * - resource bundle: {@link #getResourceBundle} returns the resource bundle directly when it's already
38919
- * loaded or triggers a synchronous request to load it. {@link #loadResourceBundle} loads a library's resource
38920
- * bundle file asynchronously. The resource bundle file is also loaded when the `preload` function is called
39157
+ * This class also provides other static methods which are related to a library, such as {@link #.getResourceBundleFor }
39158
+ * to retrieve the resource bundle of a library, {@link #.init} to provide information for a library and
39159
+ * so on.
38921
39160
  */
38922
39161
  class Lib extends sap.ui.base.Object {
38923
39162
  constructor();
@@ -38954,9 +39193,26 @@ declare namespace sap {
38954
39193
  /**
38955
39194
  * Retrieves a resource bundle for the given library and locale.
38956
39195
  *
39196
+ * This method returns the resource bundle directly. When the resource bundle for the given locale isn't
39197
+ * loaded yet, synchronous request will be used to load the resource bundle.
39198
+ *
38957
39199
  * If only one argument is given, it is assumed to be the library name. The locale then falls back to the
38958
39200
  * current {@link sap.ui.core.Configuration#getLanguage session locale}.
38959
39201
  *
39202
+ * Configuration via App Descriptor: When the App Descriptor for the library is available without further
39203
+ * request (manifest.json has been preloaded) and when the App Descriptor is at least of version 1.9.0 or
39204
+ * higher, then this method will evaluate the App Descriptor entry `"sap.ui5" / "library" / "i18n"`.
39205
+ *
39206
+ * - When the entry is `true`, a bundle with the default name "messagebundle.properties" will be loaded
39207
+ *
39208
+ * - If it is a string, then that string will be used as name of the bundle
39209
+ * - If it is `false`, no bundle will be loaded and the result will be `undefined`
39210
+ *
39211
+ * Caching: Once a resource bundle for a library has been loaded, it will be cached. Further calls for the
39212
+ * same locale won't create new requests, but return the already loaded bundle. There's therefore no need
39213
+ * for control code to cache the returned bundle for a longer period of time. Not further caching the result
39214
+ * also prevents stale texts after a locale change.
39215
+ *
38960
39216
  * @returns The best matching resource bundle for the given parameters or `undefined`
38961
39217
  */
38962
39218
  static getResourceBundleFor(
@@ -41883,16 +42139,6 @@ declare namespace sap {
41883
42139
  * rendering optimization.
41884
42140
  */
41885
42141
  class RenderManager extends Object {
41886
- /**
41887
- * Creates an instance of the RenderManager.
41888
- *
41889
- * Applications or controls must not call the `RenderManager` constructor on their own but should use the
41890
- * {@link sap.ui.core.Core#createRenderManager sap.ui.getCore().createRenderManager()} method to create
41891
- * an instance for their exclusive use.
41892
- * See:
41893
- * sap.ui.core.Core
41894
- * sap.ui.getCore
41895
- */
41896
42142
  constructor();
41897
42143
 
41898
42144
  /**
@@ -45478,7 +45724,28 @@ declare namespace sap {
45478
45724
  /**
45479
45725
  * Specifies possible message types.
45480
45726
  */
45481
- enum MessageType {}
45727
+ enum MessageType {
45728
+ /**
45729
+ * Message is an error
45730
+ */
45731
+ Error = "Error",
45732
+ /**
45733
+ * Message should be just an information
45734
+ */
45735
+ Information = "Information",
45736
+ /**
45737
+ * Message has no specific level
45738
+ */
45739
+ None = "None",
45740
+ /**
45741
+ * Message is a success message
45742
+ */
45743
+ Success = "Success",
45744
+ /**
45745
+ * Message is a warning
45746
+ */
45747
+ Warning = "Warning",
45748
+ }
45482
45749
  /**
45483
45750
  * Defines the different possible states of an element that can be open or closed and does not only toggle
45484
45751
  * between these states, but also spends some time in between (e.g. because of an animation).
@@ -49195,12 +49462,7 @@ declare namespace sap {
49195
49462
  /**
49196
49463
  * Constructor for a new JSONModel.
49197
49464
  */
49198
- constructor(
49199
- /**
49200
- * The MessageManager instance
49201
- */
49202
- oMessageManager: sap.ui.core.message.MessageManager
49203
- );
49465
+ constructor();
49204
49466
 
49205
49467
  /**
49206
49468
  * Creates a new subclass of class sap.ui.model.message.MessageModel with name `sClassName` and enriches
@@ -50320,8 +50582,6 @@ declare namespace sap {
50320
50582
  */
50321
50583
  getPartsIgnoringMessages(): number[];
50322
50584
  /**
50323
- * @experimental (since 1.114.0)
50324
- *
50325
50585
  * Returns a language-dependent placeholder text such as "e.g. " where is formatted
50326
50586
  * using this type.
50327
50587
  *
@@ -51222,8 +51482,6 @@ declare namespace sap {
51222
51482
  */
51223
51483
  static getMetadata(): sap.ui.base.Metadata;
51224
51484
  /**
51225
- * @experimental (since 1.114.0)
51226
- *
51227
51485
  * Returns a language-dependent placeholder text such as "e.g. " where is formatted
51228
51486
  * using this type.
51229
51487
  *
@@ -53935,9 +54193,12 @@ declare namespace sap {
53935
54193
  */
53936
54194
  serviceUrlParams?: Record<string, string>;
53937
54195
  /**
53938
- * Enable/disable security token handling
54196
+ * Enable/disable security token handling. If the "skipServerCache" string value is provided, the security
54197
+ * token is not cached with the server as key in order to avoid failing $batch requests when accessing services
54198
+ * running on different back-end systems behind a reverse proxy (since 1.119).
54199
+ * Use this option only if the system landscape is known.
53939
54200
  */
53940
- tokenHandling?: boolean;
54201
+ tokenHandling?: boolean | "skipServerCache";
53941
54202
  /**
53942
54203
  * Send security token for GET requests in case read access logging is activated for the OData Service in
53943
54204
  * the backend.
@@ -55595,13 +55856,14 @@ declare namespace sap {
55595
55856
  */
55596
55857
  getRefreshAfterChange(): boolean;
55597
55858
  /**
55598
- * Returns the current security token.
55859
+ * @deprecated (since 1.119.0) - use {@link #securityTokenAvailable} instead
55599
55860
  *
55600
- * If the token has not been requested from the server it will be requested first (synchronously).
55861
+ * Returns the current security token if available; triggers a request to fetch the security token if it
55862
+ * is not available.
55601
55863
  *
55602
- * @returns The security token
55864
+ * @returns The security token; `undefined` if it is not available
55603
55865
  */
55604
- getSecurityToken(): string;
55866
+ getSecurityToken(): string | undefined;
55605
55867
  /**
55606
55868
  * Return the annotation object. Please note that the metadata is loaded asynchronously and this function
55607
55869
  * might return undefined because the metadata has not been loaded yet. In this case attach to the `annotationsLoaded`
@@ -57844,6 +58106,31 @@ declare namespace sap {
57844
58106
  * `undefined` if it is not created using {@link sap.ui.model.odata.v4.ODataListBinding#create}
57845
58107
  */
57846
58108
  isTransient(): boolean | undefined;
58109
+ /**
58110
+ * @experimental (since 1.119.0)
58111
+ *
58112
+ * Moves this node to the given parent (in case of a recursive hierarchy, see {@link #setAggregation}, where
58113
+ * `oAggregation.expandTo` must be one). No other {@link sap.ui.model.odata.v4.ODataListBinding#create creation},
58114
+ * {@link #delete deletion}, or move must be pending, and no other modification (including collapse of some
58115
+ * ancestor node) must happen while this move is pending!
58116
+ *
58117
+ * This context's {@link #getIndex index} may change and it becomes "created persisted", with {@link #isTransient }
58118
+ * returning `false` etc.
58119
+ *
58120
+ * @returns A promise which is resolved without a defined result when the move is finished, or rejected
58121
+ * in case of an error
58122
+ */
58123
+ move(
58124
+ /**
58125
+ * A parameter object
58126
+ */
58127
+ oParameters: {
58128
+ /**
58129
+ * The new parent's context
58130
+ */
58131
+ parent: sap.ui.model.odata.v4.Context;
58132
+ }
58133
+ ): Promise<void>;
57847
58134
  /**
57848
58135
  * @since 1.53.0
57849
58136
  *
@@ -58398,13 +58685,21 @@ declare namespace sap {
58398
58685
  * also rejected if `bReplaceWithRVC` is supplied, and there is no return value context at all or the existing
58399
58686
  * context as described above is currently part of the list's collection (that is, has an index).
58400
58687
  * A return value context is an {@link sap.ui.model.odata.v4.Context} which represents a bound operation
58401
- * response. It is created only if the operation is bound and has a single entity return value from the
58402
- * same entity set as the operation's binding parameter and has a parent context which is an {@link sap.ui.model.odata.v4.Context }
58403
- * and points to an entity from an entity set. It is destroyed the next time this operation binding is executed
58404
- * again!
58688
+ * response. It is created only if the operation is bound and these conditions apply:
58689
+ * The operation has a single entity return value from the same entity set as the operation's binding
58690
+ * parameter. It has a parent context which is an {@link sap.ui.model.odata.v4.Context} and points
58691
+ * to (an entity from) an entity set. The path of the parent context must not contain a navigation property
58692
+ * (but see last paragraph). **Note:** A return value context is destroyed the next time the operation
58693
+ * binding is executed again.
58405
58694
  * If a return value context is created, it must be used instead of `this.getBoundContext()`. All bound
58406
58695
  * messages will be related to the return value context only. Such a message can only be connected to a
58407
58696
  * corresponding control if the control's property bindings use the return value context as binding context.
58697
+ *
58698
+ * A return value context may also be provided if the parent context's path contains a maximum of one navigation
58699
+ * property. In addition to the existing preconditions for a return value context, the metadata has to specify
58700
+ * a partner attribute for the navigation property and the partner relationship has to be bi-directional.
58701
+ * Also the navigation property binding has to be available in the entity set of the first segment in the
58702
+ * parent context's path (@experimental as of version 1.119.0).
58408
58703
  */
58409
58704
  execute(
58410
58705
  /**
@@ -58915,8 +59210,8 @@ declare namespace sap {
58915
59210
  * (see {@link #setAggregation}). The parent node must be identified via a {@link sap.ui.model.odata.v4.Context }
58916
59211
  * instance given as `oInitialData["@$ui5.node.parent"]`. `oAggregation.expandTo` (see {@link #setAggregation})
58917
59212
  * must be one, `bSkipRefresh` must be set, but both `bAtEnd` and `bInactive` must not be set. No other
58918
- * creation must be pending, and no other modification (including collapse of some ancestor node) must happen
58919
- * while this creation is pending!
59213
+ * creation or {@link sap.ui.model.odata.v4.Context#move move} must be pending, and no other modification
59214
+ * (including collapse of some ancestor node) must happen while this creation is pending!
58920
59215
  *
58921
59216
  * @returns The context object for the created entity; its method {@link sap.ui.model.odata.v4.Context#created }
58922
59217
  * returns a promise that is resolved when the creation is finished
@@ -59105,8 +59400,10 @@ declare namespace sap {
59105
59400
  * identified via the `hierarchyQualifier` given to {@link #setAggregation}.
59106
59401
  * "$DistanceFromRootProperty" holds the path to the property which provides the raw value for "@$ui5.node.level"
59107
59402
  * (minus one) and should be used only to interpret the response retrieved via {@link #getDownloadUrl}.
59108
- * "$NodeProperty" holds the path to the property which provides the hierarchy node value. That property
59109
- * is always $select'ed automatically and can be accessed as usual.
59403
+ * "$DrillStateProperty" holds the path to the property which provides the raw value for "@$ui5.node.isExpanded"
59404
+ * and should be used only to interpret the response retrieved via {@link #getDownloadUrl}. "$NodeProperty"
59405
+ * holds the path to the property which provides the hierarchy node value. That property is always $select'ed
59406
+ * automatically and can be accessed as usual.
59110
59407
  */
59111
59408
  bVerbose?: boolean
59112
59409
  ): object | undefined;
@@ -67096,8 +67393,6 @@ declare namespace sap {
67096
67393
  */
67097
67394
  getOutputPattern(): string;
67098
67395
  /**
67099
- * @experimental (since 1.114.0)
67100
- *
67101
67396
  * Returns a language-dependent placeholder text such as "e.g. " where is formatted
67102
67397
  * using this type.
67103
67398
  *
@@ -67230,8 +67525,6 @@ declare namespace sap {
67230
67525
  sTargetType: string
67231
67526
  ): string;
67232
67527
  /**
67233
- * @experimental (since 1.114.0)
67234
- *
67235
67528
  * Returns a language-dependent placeholder text such as "e.g. " where is formatted
67236
67529
  * using this type.
67237
67530
  *
@@ -68881,6 +69174,41 @@ declare namespace sap {
68881
69174
  * @returns Metadata object describing this class
68882
69175
  */
68883
69176
  static getMetadata(): sap.ui.base.Metadata;
69177
+ /**
69178
+ * Creates a new property binding for this model.
69179
+ * See:
69180
+ * sap.ui.model.Model#bindProperty
69181
+ * #getProperty
69182
+ *
69183
+ * @returns The new property binding
69184
+ */
69185
+ bindProperty(
69186
+ /**
69187
+ * The path pointing to the property that should be bound; either an absolute path or a path relative to
69188
+ * a given `oContext`
69189
+ */
69190
+ sPath: string,
69191
+ /**
69192
+ * A context object for the new binding
69193
+ */
69194
+ oContext?: object,
69195
+ /**
69196
+ * Map of optional parameters for the binding
69197
+ */
69198
+ mParameters?: {
69199
+ /**
69200
+ * Whether this binding does not propagate model messages to the control; supported since 1.119.0. Some
69201
+ * composite types like {@link sap.ui.model.type.Currency} automatically ignore model messages for some
69202
+ * of their parts depending on their format options; setting this parameter to `true` or `false` overrules
69203
+ * the automatism of the type.
69204
+ *
69205
+ * For example, a binding for a currency code is used in a composite binding for rendering the proper number
69206
+ * of decimals, but the currency code is not displayed in the attached control. In that case, messages for
69207
+ * the currency code shall not be displayed at that control, only messages for the amount.
69208
+ */
69209
+ ignoreMessages?: boolean;
69210
+ }
69211
+ ): sap.ui.model.PropertyBinding;
68884
69212
  /**
68885
69213
  * See:
68886
69214
  * sap.ui.model.Model.prototype.destroy
@@ -68982,6 +69310,17 @@ declare namespace sap {
68982
69310
  * @returns Metadata object describing this class
68983
69311
  */
68984
69312
  static getMetadata(): sap.ui.base.Metadata;
69313
+ /**
69314
+ * @since 1.119.0
69315
+ *
69316
+ * Returns `true`, as this binding supports the feature of not propagating model messages to the control.
69317
+ * See:
69318
+ * sap.ui.model.Binding#getIgnoreMessages
69319
+ * sap.ui.model.Binding#setIgnoreMessages
69320
+ *
69321
+ * @returns `true`
69322
+ */
69323
+ supportsIgnoreMessages(): boolean;
68985
69324
  }
68986
69325
  /**
68987
69326
  * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
@@ -70291,7 +70630,8 @@ declare namespace sap {
70291
70630
  */
70292
70631
  vOperator?:
70293
70632
  | sap.ui.model.FilterOperator
70294
- | ((p1: any) => boolean | boolean),
70633
+ | boolean
70634
+ | ((p1: any) => boolean),
70295
70635
  /**
70296
70636
  * First value to use with the given filter operator
70297
70637
  */
@@ -80077,6 +80417,8 @@ declare namespace sap {
80077
80417
 
80078
80418
  "sap/ui/core/Fragment": undefined;
80079
80419
 
80420
+ "sap/ui/core/getCompatibilityVersion": undefined;
80421
+
80080
80422
  "sap/ui/core/History": undefined;
80081
80423
 
80082
80424
  "sap/ui/core/HTML": undefined;