@sapui5/ts-types 1.151.0 → 1.152.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.
Files changed (67) hide show
  1. package/package.json +1 -1
  2. package/types/sap.apf.d.ts +1 -1
  3. package/types/sap.ca.ui.d.ts +1 -1
  4. package/types/sap.chart.d.ts +1 -1
  5. package/types/sap.collaboration.d.ts +1 -1
  6. package/types/sap.esh.search.ui.d.ts +18 -1
  7. package/types/sap.f.d.ts +1189 -292
  8. package/types/sap.fe.ariba.d.ts +1 -1
  9. package/types/sap.fe.base.d.ts +1 -1
  10. package/types/sap.fe.controls.d.ts +1 -1
  11. package/types/sap.fe.core.d.ts +61 -9
  12. package/types/sap.fe.ina.d.ts +1 -1
  13. package/types/sap.fe.macros.d.ts +40 -34
  14. package/types/sap.fe.navigation.d.ts +1 -1
  15. package/types/sap.fe.placeholder.d.ts +1 -1
  16. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  17. package/types/sap.fe.templates.d.ts +12 -2
  18. package/types/sap.fe.test.d.ts +1 -1
  19. package/types/sap.fe.tools.d.ts +1 -1
  20. package/types/sap.feedback.ui.d.ts +1 -1
  21. package/types/sap.gantt.d.ts +14 -1
  22. package/types/sap.insights.d.ts +1 -1
  23. package/types/sap.m.d.ts +114 -3
  24. package/types/sap.makit.d.ts +1 -1
  25. package/types/sap.me.d.ts +1 -1
  26. package/types/sap.ndc.d.ts +1 -1
  27. package/types/sap.ovp.d.ts +1 -1
  28. package/types/sap.rules.ui.d.ts +1 -1
  29. package/types/sap.sac.df.d.ts +1 -1
  30. package/types/sap.suite.ui.commons.d.ts +915 -3
  31. package/types/sap.suite.ui.generic.template.d.ts +1 -1
  32. package/types/sap.suite.ui.microchart.d.ts +1 -1
  33. package/types/sap.tnt.d.ts +1 -1
  34. package/types/sap.ui.codeeditor.d.ts +1 -1
  35. package/types/sap.ui.commons.d.ts +1 -1
  36. package/types/sap.ui.comp.d.ts +4 -2
  37. package/types/sap.ui.core.d.ts +175 -12
  38. package/types/sap.ui.dt.d.ts +1 -1
  39. package/types/sap.ui.export.d.ts +7 -1
  40. package/types/sap.ui.fl.d.ts +1 -1
  41. package/types/sap.ui.generic.app.d.ts +1 -1
  42. package/types/sap.ui.generic.template.d.ts +1 -1
  43. package/types/sap.ui.geomap.d.ts +1 -1
  44. package/types/sap.ui.integration.d.ts +101 -325
  45. package/types/sap.ui.joule.frontend.d.ts +1 -1
  46. package/types/sap.ui.layout.d.ts +33 -7
  47. package/types/sap.ui.mdc.d.ts +26 -1
  48. package/types/sap.ui.richtexteditor.d.ts +1 -1
  49. package/types/sap.ui.rta.d.ts +3 -3
  50. package/types/sap.ui.suite.d.ts +1 -1
  51. package/types/sap.ui.support.d.ts +1 -1
  52. package/types/sap.ui.table.d.ts +1 -1
  53. package/types/sap.ui.testrecorder.d.ts +1 -1
  54. package/types/sap.ui.unified.d.ts +60 -1
  55. package/types/sap.ui.ux3.d.ts +1 -1
  56. package/types/sap.ui.vbm.d.ts +1 -1
  57. package/types/sap.ui.vk.d.ts +1 -1
  58. package/types/sap.ui.vtm.d.ts +1 -1
  59. package/types/sap.uiext.inbox.d.ts +1 -1
  60. package/types/sap.ushell.d.ts +63 -46
  61. package/types/sap.ushell_abap.d.ts +1 -1
  62. package/types/sap.uxap.d.ts +1 -1
  63. package/types/sap.viz.d.ts +1 -1
  64. package/types/sap.webanalytics.core.d.ts +1 -1
  65. package/types/sap.zen.commons.d.ts +1 -1
  66. package/types/sap.zen.crosstab.d.ts +1 -1
  67. package/types/sap.zen.dsh.d.ts +1 -1
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.151.0
1
+ // For Library Version: 1.152.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -450,6 +450,7 @@ declare namespace sap {
450
450
  *
451
451
  * - Use when developing a Component card.
452
452
  *
453
+ * @deprecated As of version 1.152. Use `getResolvedParameters()` instead.
453
454
  * @experimental As of version 1.77.
454
455
  *
455
456
  * @returns Object containing parameters in format `{parameterKey: parameterValue}`.
@@ -465,7 +466,7 @@ declare namespace sap {
465
466
  *
466
467
  * **Note** Use this method when the manifest is ready. Check `manifestReady` event.
467
468
  *
468
- * @experimental As of version 1.77.
469
+ * @since 1.77
469
470
  *
470
471
  * @returns The value at the specified path.
471
472
  */
@@ -485,11 +486,25 @@ declare namespace sap {
485
486
  * Overrides the default values of the parameters, which are defined in the manifest. The returned value
486
487
  * is an object containing parameters in format `{parameterKey: parameterValue}`.
487
488
  *
488
- * @deprecated As of version 1.143. Use `getCombinedParameters()` instead.
489
+ * @deprecated As of version 1.143. Use `getResolvedParameters()` instead.
489
490
  *
490
491
  * @returns Value of property parameters
491
492
  */
492
493
  getParameters(): object;
494
+ /**
495
+ * Gets values of manifest parameters combined with the parameters from `parameters` property.
496
+ *
497
+ * **Notes**
498
+ *
499
+ * - Use this method when the manifest is ready. Check `manifestReady` event.
500
+ *
501
+ * - Use when developing a Component card.
502
+ *
503
+ * @since 1.152
504
+ *
505
+ * @returns Object containing parameters in format `{parameterKey: parameterValue}`.
506
+ */
507
+ getResolvedParameters(): Record<string, any>;
493
508
  /**
494
509
  * Gets translated text from the i18n properties files configured for this card.
495
510
  *
@@ -576,7 +591,7 @@ declare namespace sap {
576
591
  /**
577
592
  * Refreshes the card by re-applying the manifest settings and triggering all data requests.
578
593
  *
579
- * @experimental As of version 1.65.
594
+ * @since 1.65
580
595
  */
581
596
  refresh(): void;
582
597
  /**
@@ -748,7 +763,7 @@ declare namespace sap {
748
763
  * ```
749
764
  *
750
765
  *
751
- * @experimental As of version 1.84.
766
+ * @since 1.84
752
767
  */
753
768
  triggerAction(
754
769
  /**
@@ -768,7 +783,7 @@ declare namespace sap {
768
783
  /**
769
784
  * Causes all the controls within the Card that support validation to validate their data.
770
785
  *
771
- * @experimental As of version 1.106.
786
+ * @since 1.106
772
787
  *
773
788
  * @returns if all the controls validated successfully; otherwise, false
774
789
  */
@@ -797,7 +812,7 @@ declare namespace sap {
797
812
  * Overrides the default values of the parameters, which are defined in the manifest. The value is an object
798
813
  * containing parameters in format `{parameterKey: parameterValue}`.
799
814
  *
800
- * @experimental As of version 1.65.
815
+ * @since 1.65
801
816
  */
802
817
  parameters?:
803
818
  | object
@@ -869,9 +884,7 @@ declare namespace sap {
869
884
  * ```
870
885
  *
871
886
  *
872
- * Disclaimer: this API might be removed when a permanent solution for flexibility changes is implemented.
873
- *
874
- * @experimental As of version 1.76.
887
+ * @since 1.76
875
888
  */
876
889
  manifestChanges?:
877
890
  | object[]
@@ -951,22 +964,14 @@ declare namespace sap {
951
964
  * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
952
965
  * one to handle the action by calling `oEvent.preventDefault()`.
953
966
  *
954
- * @experimental As of version 1.64.
967
+ * @since 1.64
955
968
  */
956
969
  action?: (oEvent: Card$ActionEvent) => void;
957
970
 
958
- /**
959
- * Fired when some configuration settings are changed as a result of user interaction. For example - filter
960
- * value is changed.
961
- *
962
- * @experimental As of version 1.96.
963
- */
964
- configurationChange?: (oEvent: Card$ConfigurationChangeEvent) => void;
965
-
966
971
  /**
967
972
  * Fired when the manifest is loaded.
968
973
  *
969
- * @experimental As of version 1.72.
974
+ * @since 1.72
970
975
  */
971
976
  manifestReady?: (oEvent: sap.ui.base.Event) => void;
972
977
 
@@ -974,15 +979,13 @@ declare namespace sap {
974
979
  * Fired when the state of the card is changed. For example - the card is ready, new page is selected, a
975
980
  * filter is changed or data is refreshed.
976
981
  *
977
- * @experimental As of version 1.107.
982
+ * @since 1.107
978
983
  */
979
984
  stateChanged?: (oEvent: sap.ui.base.Event) => void;
980
985
  }
981
986
 
982
987
  /**
983
988
  * Parameters of the Card#action event.
984
- *
985
- * @experimental As of version 1.64.
986
989
  */
987
990
  interface Card$ActionEventParameters {
988
991
  /**
@@ -1020,8 +1023,6 @@ declare namespace sap {
1020
1023
 
1021
1024
  /**
1022
1025
  * Parameters of the Card#configurationChange event.
1023
- *
1024
- * @experimental As of version 1.96.
1025
1026
  */
1026
1027
  interface Card$ConfigurationChangeEventParameters {
1027
1028
  /**
@@ -1046,15 +1047,11 @@ declare namespace sap {
1046
1047
 
1047
1048
  /**
1048
1049
  * Parameters of the Card#manifestReady event.
1049
- *
1050
- * @experimental As of version 1.72.
1051
1050
  */
1052
1051
  interface Card$ManifestReadyEventParameters {}
1053
1052
 
1054
1053
  /**
1055
1054
  * Parameters of the Card#stateChanged event.
1056
- *
1057
- * @experimental As of version 1.107.
1058
1055
  */
1059
1056
  interface Card$StateChangedEventParameters {}
1060
1057
 
@@ -1199,7 +1196,7 @@ declare namespace sap {
1199
1196
  * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
1200
1197
  * one to handle the action by calling `oEvent.preventDefault()`.
1201
1198
  *
1202
- * @experimental As of version 1.64.
1199
+ * @since 1.64
1203
1200
  *
1204
1201
  * @returns Reference to `this` in order to allow method chaining
1205
1202
  */
@@ -1230,7 +1227,7 @@ declare namespace sap {
1230
1227
  * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
1231
1228
  * one to handle the action by calling `oEvent.preventDefault()`.
1232
1229
  *
1233
- * @experimental As of version 1.64.
1230
+ * @since 1.64
1234
1231
  *
1235
1232
  * @returns Reference to `this` in order to allow method chaining
1236
1233
  */
@@ -1244,59 +1241,6 @@ declare namespace sap {
1244
1241
  */
1245
1242
  oListener?: object
1246
1243
  ): this;
1247
- /**
1248
- * Attaches event handler `fnFunction` to the {@link #event:configurationChange configurationChange} event
1249
- * of this `sap.ui.integration.widgets.Card`.
1250
- *
1251
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1252
- * otherwise it will be bound to this `sap.ui.integration.widgets.Card` itself.
1253
- *
1254
- * Fired when some configuration settings are changed as a result of user interaction. For example - filter
1255
- * value is changed.
1256
- *
1257
- * @experimental As of version 1.96.
1258
- *
1259
- * @returns Reference to `this` in order to allow method chaining
1260
- */
1261
- attachConfigurationChange(
1262
- /**
1263
- * An application-specific payload object that will be passed to the event handler along with the event
1264
- * object when firing the event
1265
- */
1266
- oData: object,
1267
- /**
1268
- * The function to be called when the event occurs
1269
- */
1270
- fnFunction: (p1: Card$ConfigurationChangeEvent) => void,
1271
- /**
1272
- * Context object to call the event handler with. Defaults to this `sap.ui.integration.widgets.Card` itself
1273
- */
1274
- oListener?: object
1275
- ): this;
1276
- /**
1277
- * Attaches event handler `fnFunction` to the {@link #event:configurationChange configurationChange} event
1278
- * of this `sap.ui.integration.widgets.Card`.
1279
- *
1280
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1281
- * otherwise it will be bound to this `sap.ui.integration.widgets.Card` itself.
1282
- *
1283
- * Fired when some configuration settings are changed as a result of user interaction. For example - filter
1284
- * value is changed.
1285
- *
1286
- * @experimental As of version 1.96.
1287
- *
1288
- * @returns Reference to `this` in order to allow method chaining
1289
- */
1290
- attachConfigurationChange(
1291
- /**
1292
- * The function to be called when the event occurs
1293
- */
1294
- fnFunction: (p1: Card$ConfigurationChangeEvent) => void,
1295
- /**
1296
- * Context object to call the event handler with. Defaults to this `sap.ui.integration.widgets.Card` itself
1297
- */
1298
- oListener?: object
1299
- ): this;
1300
1244
  /**
1301
1245
  * Attaches event handler `fnFunction` to the {@link #event:manifestReady manifestReady} event of this `sap.ui.integration.widgets.Card`.
1302
1246
  *
@@ -1305,7 +1249,7 @@ declare namespace sap {
1305
1249
  *
1306
1250
  * Fired when the manifest is loaded.
1307
1251
  *
1308
- * @experimental As of version 1.72.
1252
+ * @since 1.72
1309
1253
  *
1310
1254
  * @returns Reference to `this` in order to allow method chaining
1311
1255
  */
@@ -1332,7 +1276,7 @@ declare namespace sap {
1332
1276
  *
1333
1277
  * Fired when the manifest is loaded.
1334
1278
  *
1335
- * @experimental As of version 1.72.
1279
+ * @since 1.72
1336
1280
  *
1337
1281
  * @returns Reference to `this` in order to allow method chaining
1338
1282
  */
@@ -1355,7 +1299,7 @@ declare namespace sap {
1355
1299
  * Fired when the state of the card is changed. For example - the card is ready, new page is selected, a
1356
1300
  * filter is changed or data is refreshed.
1357
1301
  *
1358
- * @experimental As of version 1.107.
1302
+ * @since 1.107
1359
1303
  *
1360
1304
  * @returns Reference to `this` in order to allow method chaining
1361
1305
  */
@@ -1383,7 +1327,7 @@ declare namespace sap {
1383
1327
  * Fired when the state of the card is changed. For example - the card is ready, new page is selected, a
1384
1328
  * filter is changed or data is refreshed.
1385
1329
  *
1386
- * @experimental As of version 1.107.
1330
+ * @since 1.107
1387
1331
  *
1388
1332
  * @returns Reference to `this` in order to allow method chaining
1389
1333
  */
@@ -1410,7 +1354,7 @@ declare namespace sap {
1410
1354
  *
1411
1355
  * The passed function and listener object must match the ones used for event registration.
1412
1356
  *
1413
- * @experimental As of version 1.64.
1357
+ * @since 1.64
1414
1358
  *
1415
1359
  * @returns Reference to `this` in order to allow method chaining
1416
1360
  */
@@ -1424,33 +1368,13 @@ declare namespace sap {
1424
1368
  */
1425
1369
  oListener?: object
1426
1370
  ): this;
1427
- /**
1428
- * Detaches event handler `fnFunction` from the {@link #event:configurationChange configurationChange} event
1429
- * of this `sap.ui.integration.widgets.Card`.
1430
- *
1431
- * The passed function and listener object must match the ones used for event registration.
1432
- *
1433
- * @experimental As of version 1.96.
1434
- *
1435
- * @returns Reference to `this` in order to allow method chaining
1436
- */
1437
- detachConfigurationChange(
1438
- /**
1439
- * The function to be called, when the event occurs
1440
- */
1441
- fnFunction: (p1: Card$ConfigurationChangeEvent) => void,
1442
- /**
1443
- * Context object on which the given function had to be called
1444
- */
1445
- oListener?: object
1446
- ): this;
1447
1371
  /**
1448
1372
  * Detaches event handler `fnFunction` from the {@link #event:manifestReady manifestReady} event of this
1449
1373
  * `sap.ui.integration.widgets.Card`.
1450
1374
  *
1451
1375
  * The passed function and listener object must match the ones used for event registration.
1452
1376
  *
1453
- * @experimental As of version 1.72.
1377
+ * @since 1.72
1454
1378
  *
1455
1379
  * @returns Reference to `this` in order to allow method chaining
1456
1380
  */
@@ -1469,7 +1393,7 @@ declare namespace sap {
1469
1393
  *
1470
1394
  * The passed function and listener object must match the ones used for event registration.
1471
1395
  *
1472
- * @experimental As of version 1.107.
1396
+ * @since 1.107
1473
1397
  *
1474
1398
  * @returns Reference to `this` in order to allow method chaining
1475
1399
  */
@@ -1489,7 +1413,7 @@ declare namespace sap {
1489
1413
  * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
1490
1414
  * event object. The return value of this method indicates whether the default action should be executed.
1491
1415
  *
1492
- * @experimental As of version 1.64.
1416
+ * @since 1.64
1493
1417
  * @ui5-protected Do not call from applications (only from related classes in the framework)
1494
1418
  *
1495
1419
  * @returns Whether or not to prevent the default action
@@ -1500,24 +1424,10 @@ declare namespace sap {
1500
1424
  */
1501
1425
  mParameters?: sap.ui.integration.widgets.Card$ActionEventParameters
1502
1426
  ): boolean;
1503
- /**
1504
- * Fires event {@link #event:configurationChange configurationChange} to attached listeners.
1505
- *
1506
- * @experimental As of version 1.96.
1507
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1508
- *
1509
- * @returns Reference to `this` in order to allow method chaining
1510
- */
1511
- fireConfigurationChange(
1512
- /**
1513
- * Parameters to pass along with the event
1514
- */
1515
- mParameters?: sap.ui.integration.widgets.Card$ConfigurationChangeEventParameters
1516
- ): this;
1517
1427
  /**
1518
1428
  * Fires event {@link #event:manifestReady manifestReady} to attached listeners.
1519
1429
  *
1520
- * @experimental As of version 1.72.
1430
+ * @since 1.72
1521
1431
  * @ui5-protected Do not call from applications (only from related classes in the framework)
1522
1432
  *
1523
1433
  * @returns Reference to `this` in order to allow method chaining
@@ -1531,7 +1441,7 @@ declare namespace sap {
1531
1441
  /**
1532
1442
  * Fires event {@link #event:stateChanged stateChanged} to attached listeners.
1533
1443
  *
1534
- * @experimental As of version 1.107.
1444
+ * @since 1.107
1535
1445
  * @ui5-protected Do not call from applications (only from related classes in the framework)
1536
1446
  *
1537
1447
  * @returns Reference to `this` in order to allow method chaining
@@ -1585,6 +1495,7 @@ declare namespace sap {
1585
1495
  *
1586
1496
  * - Use when developing a Component card.
1587
1497
  *
1498
+ * @deprecated As of version 1.152. Use `getResolvedParameters()` instead.
1588
1499
  * @experimental As of version 1.77.
1589
1500
  *
1590
1501
  * @returns Object containing parameters in format `{parameterKey: parameterValue}`.
@@ -1602,7 +1513,7 @@ declare namespace sap {
1602
1513
  * inside an extension or component will not be returned. If context needs to be used from an extension,
1603
1514
  * assign it to a parameter first.
1604
1515
  *
1605
- * @experimental As of version 1.151.
1516
+ * @since 1.151
1606
1517
  *
1607
1518
  * @returns An array of context paths found in the manifest (for example, `["/sample/currentUser/id", "/sample/supplier/id/value"]`).
1608
1519
  * Returns an empty array if no context dependencies are found or if the manifest is not ready.
@@ -1647,7 +1558,7 @@ declare namespace sap {
1647
1558
  /**
1648
1559
  * Gets the instance of the `host` association.
1649
1560
  *
1650
- * @experimental As of version 1.77.
1561
+ * @since 1.77
1651
1562
  *
1652
1563
  * @returns The host object associated with this card.
1653
1564
  */
@@ -1699,11 +1610,9 @@ declare namespace sap {
1699
1610
  * ```
1700
1611
  *
1701
1612
  *
1702
- * Disclaimer: this API might be removed when a permanent solution for flexibility changes is implemented.
1703
- *
1704
1613
  * Default value is `[]`.
1705
1614
  *
1706
- * @experimental As of version 1.76.
1615
+ * @since 1.76
1707
1616
  *
1708
1617
  * @returns Value of property `manifestChanges`
1709
1618
  */
@@ -1713,7 +1622,7 @@ declare namespace sap {
1713
1622
  *
1714
1623
  * **Note** Use this method when the manifest is ready. Check `manifestReady` event.
1715
1624
  *
1716
- * @experimental As of version 1.77.
1625
+ * @since 1.77
1717
1626
  *
1718
1627
  * @returns The value at the specified path.
1719
1628
  */
@@ -1744,7 +1653,7 @@ declare namespace sap {
1744
1653
  * Overrides the default values of the parameters, which are defined in the manifest. The value is an object
1745
1654
  * containing parameters in format `{parameterKey: parameterValue}`.
1746
1655
  *
1747
- * @experimental As of version 1.65.
1656
+ * @since 1.65
1748
1657
  *
1749
1658
  * @returns Value of property `parameters`
1750
1659
  */
@@ -1778,6 +1687,20 @@ declare namespace sap {
1778
1687
  * @returns Value of property `referenceId`
1779
1688
  */
1780
1689
  getReferenceId(): string;
1690
+ /**
1691
+ * Gets values of manifest parameters combined with the parameters from `parameters` property.
1692
+ *
1693
+ * **Notes**
1694
+ *
1695
+ * - Use this method when the manifest is ready. Check `manifestReady` event.
1696
+ *
1697
+ * - Use when developing a Component card.
1698
+ *
1699
+ * @since 1.152
1700
+ *
1701
+ * @returns Object containing parameters in format `{parameterKey: parameterValue}`.
1702
+ */
1703
+ getResolvedParameters(): Record<string, any>;
1781
1704
  /**
1782
1705
  * Gets translated text from the i18n properties files configured for this card.
1783
1706
  *
@@ -1875,7 +1798,11 @@ declare namespace sap {
1875
1798
  iIndex: int
1876
1799
  ): this;
1877
1800
  /**
1878
- * @experimental As of version 1.65.
1801
+ * Checks if the card is ready.
1802
+ *
1803
+ * The card is ready when all of its content, header, filters and data are loaded and rendered.
1804
+ *
1805
+ * @since 1.65
1879
1806
  *
1880
1807
  * @returns If the card is ready or not.
1881
1808
  */
@@ -1888,7 +1815,7 @@ declare namespace sap {
1888
1815
  * the complete manifest json } The promise is rejected if the module cannot be loaded with an object: {
1889
1816
  * error: "Card.designtime not found" }
1890
1817
  *
1891
- * @experimental As of version 1.73.
1818
+ * @since 1.73
1892
1819
  *
1893
1820
  * @returns Promise resolves after the designtime configuration is loaded.
1894
1821
  */
@@ -1896,7 +1823,7 @@ declare namespace sap {
1896
1823
  /**
1897
1824
  * Refreshes the card by re-applying the manifest settings and triggering all data requests.
1898
1825
  *
1899
- * @experimental As of version 1.65.
1826
+ * @since 1.65
1900
1827
  */
1901
1828
  refresh(): void;
1902
1829
  /**
@@ -2134,13 +2061,11 @@ declare namespace sap {
2134
2061
  * ```
2135
2062
  *
2136
2063
  *
2137
- * Disclaimer: this API might be removed when a permanent solution for flexibility changes is implemented.
2138
- *
2139
2064
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2140
2065
  *
2141
2066
  * Default value is `[]`.
2142
2067
  *
2143
- * @experimental As of version 1.76.
2068
+ * @since 1.76
2144
2069
  *
2145
2070
  * @returns Reference to `this` in order to allow method chaining
2146
2071
  */
@@ -2180,7 +2105,7 @@ declare namespace sap {
2180
2105
  *
2181
2106
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2182
2107
  *
2183
- * @experimental As of version 1.65.
2108
+ * @since 1.65
2184
2109
  *
2185
2110
  * @returns Reference to `this` in order to allow method chaining
2186
2111
  */
@@ -2319,7 +2244,7 @@ declare namespace sap {
2319
2244
  * ```
2320
2245
  *
2321
2246
  *
2322
- * @experimental As of version 1.84.
2247
+ * @since 1.84
2323
2248
  */
2324
2249
  triggerAction(
2325
2250
  /**
@@ -2339,7 +2264,7 @@ declare namespace sap {
2339
2264
  /**
2340
2265
  * Causes all the controls within the Card that support validation to validate their data.
2341
2266
  *
2342
- * @experimental As of version 1.106.
2267
+ * @since 1.106
2343
2268
  *
2344
2269
  * @returns if all the controls validated successfully; otherwise, false
2345
2270
  */
@@ -2348,8 +2273,6 @@ declare namespace sap {
2348
2273
 
2349
2274
  /**
2350
2275
  * Event object of the Card#action event.
2351
- *
2352
- * @experimental As of version 1.64.
2353
2276
  */
2354
2277
  type Card$ActionEvent = sap.ui.base.Event<
2355
2278
  Card$ActionEventParameters,
@@ -2358,8 +2281,6 @@ declare namespace sap {
2358
2281
 
2359
2282
  /**
2360
2283
  * Event object of the Card#configurationChange event.
2361
- *
2362
- * @experimental As of version 1.96.
2363
2284
  */
2364
2285
  type Card$ConfigurationChangeEvent = sap.ui.base.Event<
2365
2286
  Card$ConfigurationChangeEventParameters,
@@ -2376,8 +2297,6 @@ declare namespace sap {
2376
2297
 
2377
2298
  /**
2378
2299
  * Event object of the Card#manifestReady event.
2379
- *
2380
- * @experimental As of version 1.72.
2381
2300
  */
2382
2301
  type Card$ManifestReadyEvent = sap.ui.base.Event<
2383
2302
  Card$ManifestReadyEventParameters,
@@ -2386,8 +2305,6 @@ declare namespace sap {
2386
2305
 
2387
2306
  /**
2388
2307
  * Event object of the Card#stateChanged event.
2389
- *
2390
- * @experimental As of version 1.107.
2391
2308
  */
2392
2309
  type Card$StateChangedEvent = sap.ui.base.Event<
2393
2310
  Card$StateChangedEventParameters,
@@ -2505,7 +2422,7 @@ declare namespace sap {
2505
2422
  /**
2506
2423
  * The formatters that can be used in the manifest.
2507
2424
  *
2508
- * @experimental As of version 1.79.
2425
+ * @since 1.79
2509
2426
  */
2510
2427
  formatters?:
2511
2428
  | object
@@ -2519,7 +2436,7 @@ declare namespace sap {
2519
2436
  * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
2520
2437
  * one to handle the action by calling `oEvent.preventDefault()`.
2521
2438
  *
2522
- * @experimental As of version 1.75.
2439
+ * @since 1.75
2523
2440
  */
2524
2441
  action?: (oEvent: Extension$ActionEvent) => void;
2525
2442
  }
@@ -2561,25 +2478,15 @@ declare namespace sap {
2561
2478
  * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
2562
2479
  * one to handle the action by calling `oEvent.preventDefault()`.
2563
2480
  *
2564
- * @experimental As of version 1.75.
2481
+ * @since 1.75
2565
2482
  */
2566
2483
  action?: (oEvent: Host$ActionEvent) => void;
2567
2484
 
2568
- /**
2569
- * Fired when some card configuration settings are changed as a result of user interaction. For example
2570
- * - filter value is changed.
2571
- *
2572
- * @experimental As of version 1.96.
2573
- */
2574
- cardConfigurationChange?: (
2575
- oEvent: Host$CardConfigurationChangeEvent
2576
- ) => void;
2577
-
2578
2485
  /**
2579
2486
  * Fired when the state of a card is changed. For example - the card is ready, new page is selected inside
2580
2487
  * the card, a filter is changed or data is refreshed.
2581
2488
  *
2582
- * @experimental As of version 1.107.
2489
+ * @since 1.107
2583
2490
  */
2584
2491
  cardStateChanged?: (oEvent: Host$CardStateChangedEvent) => void;
2585
2492
 
@@ -2587,7 +2494,7 @@ declare namespace sap {
2587
2494
  * Fired when the card is initially ready for the first time. Will not be fired for consecutive refreshes
2588
2495
  * or data changes.
2589
2496
  *
2590
- * @experimental As of version 1.116.
2497
+ * @since 1.116
2591
2498
  */
2592
2499
  cardInitialized?: (oEvent: Host$CardInitializedEvent) => void;
2593
2500
 
@@ -2606,8 +2513,6 @@ declare namespace sap {
2606
2513
 
2607
2514
  /**
2608
2515
  * Parameters of the Extension#action event.
2609
- *
2610
- * @experimental As of version 1.75.
2611
2516
  */
2612
2517
  interface Extension$ActionEventParameters {
2613
2518
  /**
@@ -2650,8 +2555,6 @@ declare namespace sap {
2650
2555
 
2651
2556
  /**
2652
2557
  * Parameters of the Host#action event.
2653
- *
2654
- * @experimental As of version 1.75.
2655
2558
  */
2656
2559
  interface Host$ActionEventParameters {
2657
2560
  /**
@@ -2694,8 +2597,6 @@ declare namespace sap {
2694
2597
 
2695
2598
  /**
2696
2599
  * Parameters of the Host#cardConfigurationChange event.
2697
- *
2698
- * @experimental As of version 1.96.
2699
2600
  */
2700
2601
  interface Host$CardConfigurationChangeEventParameters {
2701
2602
  /**
@@ -2720,8 +2621,6 @@ declare namespace sap {
2720
2621
 
2721
2622
  /**
2722
2623
  * Parameters of the Host#cardInitialized event.
2723
- *
2724
- * @experimental As of version 1.116.
2725
2624
  */
2726
2625
  interface Host$CardInitializedEventParameters {
2727
2626
  /**
@@ -2732,8 +2631,6 @@ declare namespace sap {
2732
2631
 
2733
2632
  /**
2734
2633
  * Parameters of the Host#cardStateChanged event.
2735
- *
2736
- * @experimental As of version 1.107.
2737
2634
  */
2738
2635
  interface Host$CardStateChangedEventParameters {
2739
2636
  /**
@@ -3371,7 +3268,7 @@ declare namespace sap {
3371
3268
  * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
3372
3269
  * one to handle the action by calling `oEvent.preventDefault()`.
3373
3270
  *
3374
- * @experimental As of version 1.75.
3271
+ * @since 1.75
3375
3272
  *
3376
3273
  * @returns Reference to `this` in order to allow method chaining
3377
3274
  */
@@ -3402,7 +3299,7 @@ declare namespace sap {
3402
3299
  * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
3403
3300
  * one to handle the action by calling `oEvent.preventDefault()`.
3404
3301
  *
3405
- * @experimental As of version 1.75.
3302
+ * @since 1.75
3406
3303
  *
3407
3304
  * @returns Reference to `this` in order to allow method chaining
3408
3305
  */
@@ -3421,7 +3318,7 @@ declare namespace sap {
3421
3318
  *
3422
3319
  * The passed function and listener object must match the ones used for event registration.
3423
3320
  *
3424
- * @experimental As of version 1.75.
3321
+ * @since 1.75
3425
3322
  *
3426
3323
  * @returns Reference to `this` in order to allow method chaining
3427
3324
  */
@@ -3435,37 +3332,13 @@ declare namespace sap {
3435
3332
  */
3436
3333
  oListener?: object
3437
3334
  ): this;
3438
- /**
3439
- * Starts the process of fetching a resource from the network, returning a promise that is fulfilled once
3440
- * the response is available. Use this method to override the default behavior when fetching network resources.
3441
- * Mimics the browser native Fetch API.
3442
- *
3443
- * @experimental As of version 1.113.
3444
- *
3445
- * @returns A `Promise` that resolves to a `Response` object.
3446
- */
3447
- fetch(
3448
- /**
3449
- * This defines the resource that you wish to fetch.
3450
- */
3451
- sResource: string,
3452
- /**
3453
- * An object containing any custom settings that you want to apply to the request.
3454
- */
3455
- mOptions: object,
3456
- /**
3457
- * The map of request settings defined in the card manifest. Use this only for reading, they can not be
3458
- * modified.
3459
- */
3460
- mRequestSettings: object
3461
- ): Promise<Response>;
3462
3335
  /**
3463
3336
  * Fires event {@link #event:action action} to attached listeners.
3464
3337
  *
3465
3338
  * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
3466
3339
  * event object. The return value of this method indicates whether the default action should be executed.
3467
3340
  *
3468
- * @experimental As of version 1.75.
3341
+ * @since 1.75
3469
3342
  * @ui5-protected Do not call from applications (only from related classes in the framework)
3470
3343
  *
3471
3344
  * @returns Whether or not to prevent the default action
@@ -3505,10 +3378,14 @@ declare namespace sap {
3505
3378
  /**
3506
3379
  * Override this method to lazy load dependencies for the extension.
3507
3380
  *
3508
- * @experimental As of version 1.108.
3381
+ * The card waits for the returned promise to resolve before it continues with its initialization. If the
3382
+ * promise is rejected, the card initialization fails and an error message is shown.
3509
3383
  *
3510
- * @returns Returns a promise. The card will wait for this promise to be resolved before continuing with
3511
- * the initialization.
3384
+ * The default implementation loads no dependencies and returns an already resolved promise.
3385
+ *
3386
+ * @since 1.108
3387
+ *
3388
+ * @returns A promise which resolves when all dependencies of the extension are loaded.
3512
3389
  */
3513
3390
  loadDependencies(): Promise<any>;
3514
3391
  /**
@@ -3630,7 +3507,7 @@ declare namespace sap {
3630
3507
  * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
3631
3508
  * one to handle the action by calling `oEvent.preventDefault()`.
3632
3509
  *
3633
- * @experimental As of version 1.75.
3510
+ * @since 1.75
3634
3511
  *
3635
3512
  * @returns Reference to `this` in order to allow method chaining
3636
3513
  */
@@ -3661,7 +3538,7 @@ declare namespace sap {
3661
3538
  * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
3662
3539
  * one to handle the action by calling `oEvent.preventDefault()`.
3663
3540
  *
3664
- * @experimental As of version 1.75.
3541
+ * @since 1.75
3665
3542
  *
3666
3543
  * @returns Reference to `this` in order to allow method chaining
3667
3544
  */
@@ -3675,59 +3552,6 @@ declare namespace sap {
3675
3552
  */
3676
3553
  oListener?: object
3677
3554
  ): this;
3678
- /**
3679
- * Attaches event handler `fnFunction` to the {@link #event:cardConfigurationChange cardConfigurationChange }
3680
- * event of this `sap.ui.integration.Host`.
3681
- *
3682
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
3683
- * otherwise it will be bound to this `sap.ui.integration.Host` itself.
3684
- *
3685
- * Fired when some card configuration settings are changed as a result of user interaction. For example
3686
- * - filter value is changed.
3687
- *
3688
- * @experimental As of version 1.96.
3689
- *
3690
- * @returns Reference to `this` in order to allow method chaining
3691
- */
3692
- attachCardConfigurationChange(
3693
- /**
3694
- * An application-specific payload object that will be passed to the event handler along with the event
3695
- * object when firing the event
3696
- */
3697
- oData: object,
3698
- /**
3699
- * The function to be called when the event occurs
3700
- */
3701
- fnFunction: (p1: Host$CardConfigurationChangeEvent) => void,
3702
- /**
3703
- * Context object to call the event handler with. Defaults to this `sap.ui.integration.Host` itself
3704
- */
3705
- oListener?: object
3706
- ): this;
3707
- /**
3708
- * Attaches event handler `fnFunction` to the {@link #event:cardConfigurationChange cardConfigurationChange }
3709
- * event of this `sap.ui.integration.Host`.
3710
- *
3711
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
3712
- * otherwise it will be bound to this `sap.ui.integration.Host` itself.
3713
- *
3714
- * Fired when some card configuration settings are changed as a result of user interaction. For example
3715
- * - filter value is changed.
3716
- *
3717
- * @experimental As of version 1.96.
3718
- *
3719
- * @returns Reference to `this` in order to allow method chaining
3720
- */
3721
- attachCardConfigurationChange(
3722
- /**
3723
- * The function to be called when the event occurs
3724
- */
3725
- fnFunction: (p1: Host$CardConfigurationChangeEvent) => void,
3726
- /**
3727
- * Context object to call the event handler with. Defaults to this `sap.ui.integration.Host` itself
3728
- */
3729
- oListener?: object
3730
- ): this;
3731
3555
  /**
3732
3556
  * Attaches event handler `fnFunction` to the {@link #event:cardInitialized cardInitialized} event of this
3733
3557
  * `sap.ui.integration.Host`.
@@ -3738,7 +3562,7 @@ declare namespace sap {
3738
3562
  * Fired when the card is initially ready for the first time. Will not be fired for consecutive refreshes
3739
3563
  * or data changes.
3740
3564
  *
3741
- * @experimental As of version 1.116.
3565
+ * @since 1.116
3742
3566
  *
3743
3567
  * @returns Reference to `this` in order to allow method chaining
3744
3568
  */
@@ -3767,7 +3591,7 @@ declare namespace sap {
3767
3591
  * Fired when the card is initially ready for the first time. Will not be fired for consecutive refreshes
3768
3592
  * or data changes.
3769
3593
  *
3770
- * @experimental As of version 1.116.
3594
+ * @since 1.116
3771
3595
  *
3772
3596
  * @returns Reference to `this` in order to allow method chaining
3773
3597
  */
@@ -3791,7 +3615,7 @@ declare namespace sap {
3791
3615
  * Fired when the state of a card is changed. For example - the card is ready, new page is selected inside
3792
3616
  * the card, a filter is changed or data is refreshed.
3793
3617
  *
3794
- * @experimental As of version 1.107.
3618
+ * @since 1.107
3795
3619
  *
3796
3620
  * @returns Reference to `this` in order to allow method chaining
3797
3621
  */
@@ -3820,7 +3644,7 @@ declare namespace sap {
3820
3644
  * Fired when the state of a card is changed. For example - the card is ready, new page is selected inside
3821
3645
  * the card, a filter is changed or data is refreshed.
3822
3646
  *
3823
- * @experimental As of version 1.107.
3647
+ * @since 1.107
3824
3648
  *
3825
3649
  * @returns Reference to `this` in order to allow method chaining
3826
3650
  */
@@ -3918,7 +3742,7 @@ declare namespace sap {
3918
3742
  *
3919
3743
  * The passed function and listener object must match the ones used for event registration.
3920
3744
  *
3921
- * @experimental As of version 1.75.
3745
+ * @since 1.75
3922
3746
  *
3923
3747
  * @returns Reference to `this` in order to allow method chaining
3924
3748
  */
@@ -3932,33 +3756,13 @@ declare namespace sap {
3932
3756
  */
3933
3757
  oListener?: object
3934
3758
  ): this;
3935
- /**
3936
- * Detaches event handler `fnFunction` from the {@link #event:cardConfigurationChange cardConfigurationChange }
3937
- * event of this `sap.ui.integration.Host`.
3938
- *
3939
- * The passed function and listener object must match the ones used for event registration.
3940
- *
3941
- * @experimental As of version 1.96.
3942
- *
3943
- * @returns Reference to `this` in order to allow method chaining
3944
- */
3945
- detachCardConfigurationChange(
3946
- /**
3947
- * The function to be called, when the event occurs
3948
- */
3949
- fnFunction: (p1: Host$CardConfigurationChangeEvent) => void,
3950
- /**
3951
- * Context object on which the given function had to be called
3952
- */
3953
- oListener?: object
3954
- ): this;
3955
3759
  /**
3956
3760
  * Detaches event handler `fnFunction` from the {@link #event:cardInitialized cardInitialized} event of
3957
3761
  * this `sap.ui.integration.Host`.
3958
3762
  *
3959
3763
  * The passed function and listener object must match the ones used for event registration.
3960
3764
  *
3961
- * @experimental As of version 1.116.
3765
+ * @since 1.116
3962
3766
  *
3963
3767
  * @returns Reference to `this` in order to allow method chaining
3964
3768
  */
@@ -3978,7 +3782,7 @@ declare namespace sap {
3978
3782
  *
3979
3783
  * The passed function and listener object must match the ones used for event registration.
3980
3784
  *
3981
- * @experimental As of version 1.107.
3785
+ * @since 1.107
3982
3786
  *
3983
3787
  * @returns Reference to `this` in order to allow method chaining
3984
3788
  */
@@ -4017,7 +3821,7 @@ declare namespace sap {
4017
3821
  * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
4018
3822
  * event object. The return value of this method indicates whether the default action should be executed.
4019
3823
  *
4020
- * @experimental As of version 1.75.
3824
+ * @since 1.75
4021
3825
  * @ui5-protected Do not call from applications (only from related classes in the framework)
4022
3826
  *
4023
3827
  * @returns Whether or not to prevent the default action
@@ -4028,24 +3832,10 @@ declare namespace sap {
4028
3832
  */
4029
3833
  mParameters?: sap.ui.integration.Host$ActionEventParameters
4030
3834
  ): boolean;
4031
- /**
4032
- * Fires event {@link #event:cardConfigurationChange cardConfigurationChange} to attached listeners.
4033
- *
4034
- * @experimental As of version 1.96.
4035
- * @ui5-protected Do not call from applications (only from related classes in the framework)
4036
- *
4037
- * @returns Reference to `this` in order to allow method chaining
4038
- */
4039
- fireCardConfigurationChange(
4040
- /**
4041
- * Parameters to pass along with the event
4042
- */
4043
- mParameters?: sap.ui.integration.Host$CardConfigurationChangeEventParameters
4044
- ): this;
4045
3835
  /**
4046
3836
  * Fires event {@link #event:cardInitialized cardInitialized} to attached listeners.
4047
3837
  *
4048
- * @experimental As of version 1.116.
3838
+ * @since 1.116
4049
3839
  * @ui5-protected Do not call from applications (only from related classes in the framework)
4050
3840
  *
4051
3841
  * @returns Reference to `this` in order to allow method chaining
@@ -4059,7 +3849,7 @@ declare namespace sap {
4059
3849
  /**
4060
3850
  * Fires event {@link #event:cardStateChanged cardStateChanged} to attached listeners.
4061
3851
  *
4062
- * @experimental As of version 1.107.
3852
+ * @since 1.107
4063
3853
  * @ui5-protected Do not call from applications (only from related classes in the framework)
4064
3854
  *
4065
3855
  * @returns Reference to `this` in order to allow method chaining
@@ -4106,7 +3896,7 @@ declare namespace sap {
4106
3896
  * The context information and texts should be translated as they appear in the design-time UI of the Card
4107
3897
  * Editor.
4108
3898
  *
4109
- * @experimental As of version 1.143.
3899
+ * @since 1.143
4110
3900
  *
4111
3901
  * @returns A promise which contains the context structure.
4112
3902
  */
@@ -4122,7 +3912,7 @@ declare namespace sap {
4122
3912
  * Example path to the current user id of the context sPath = "sap.workzone/currentUser/id" parameter: {
4123
3913
  * userId: { value: "{context>sap.workzone/currentUser/id}" resolves to UserId } }
4124
3914
  *
4125
- * @experimental As of version 1.143.
3915
+ * @since 1.143
4126
3916
  *
4127
3917
  * @returns A promise which resolves with the value of this context.
4128
3918
  */
@@ -4244,19 +4034,17 @@ declare namespace sap {
4244
4034
  * This enum is part of the 'sap/ui/integration/library' module export and must be accessed by the property
4245
4035
  * 'CardActionType'.
4246
4036
  *
4247
- * @experimental As of version 1.64.
4037
+ * @since 1.64
4248
4038
  */
4249
4039
  enum CardActionType {
4250
4040
  /**
4251
4041
  * Used for custom actions.
4252
4042
  *
4253
- * @experimental As of version 1.76.
4043
+ * @since 1.76
4254
4044
  */
4255
4045
  Custom = "Custom",
4256
4046
  /**
4257
4047
  * Date selection. Available only for Calendar cards.
4258
- *
4259
- * @experimental As of version 1.87.
4260
4048
  */
4261
4049
  DateChange = "DateChange",
4262
4050
  /**
@@ -4267,8 +4055,6 @@ declare namespace sap {
4267
4055
  HideCard = "HideCard",
4268
4056
  /**
4269
4057
  * Month selection. Available only for Calendar cards.
4270
- *
4271
- * @experimental As of version 1.87.
4272
4058
  */
4273
4059
  MonthChange = "MonthChange",
4274
4060
  /**
@@ -4586,8 +4372,6 @@ declare namespace sap {
4586
4372
 
4587
4373
  /**
4588
4374
  * Event object of the Extension#action event.
4589
- *
4590
- * @experimental As of version 1.75.
4591
4375
  */
4592
4376
  type Extension$ActionEvent = sap.ui.base.Event<
4593
4377
  Extension$ActionEventParameters,
@@ -4596,8 +4380,6 @@ declare namespace sap {
4596
4380
 
4597
4381
  /**
4598
4382
  * Event object of the Host#action event.
4599
- *
4600
- * @experimental As of version 1.75.
4601
4383
  */
4602
4384
  type Host$ActionEvent = sap.ui.base.Event<
4603
4385
  Host$ActionEventParameters,
@@ -4606,8 +4388,6 @@ declare namespace sap {
4606
4388
 
4607
4389
  /**
4608
4390
  * Event object of the Host#cardConfigurationChange event.
4609
- *
4610
- * @experimental As of version 1.96.
4611
4391
  */
4612
4392
  type Host$CardConfigurationChangeEvent = sap.ui.base.Event<
4613
4393
  Host$CardConfigurationChangeEventParameters,
@@ -4616,8 +4396,6 @@ declare namespace sap {
4616
4396
 
4617
4397
  /**
4618
4398
  * Event object of the Host#cardInitialized event.
4619
- *
4620
- * @experimental As of version 1.116.
4621
4399
  */
4622
4400
  type Host$CardInitializedEvent = sap.ui.base.Event<
4623
4401
  Host$CardInitializedEventParameters,
@@ -4626,8 +4404,6 @@ declare namespace sap {
4626
4404
 
4627
4405
  /**
4628
4406
  * Event object of the Host#cardStateChanged event.
4629
- *
4630
- * @experimental As of version 1.107.
4631
4407
  */
4632
4408
  type Host$CardStateChangedEvent = sap.ui.base.Event<
4633
4409
  Host$CardStateChangedEventParameters,