@sapui5/ts-types 1.112.3 → 1.113.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 (63) 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 +59 -2
  4. package/types/sap.chart.d.ts +15 -1
  5. package/types/sap.collaboration.d.ts +33 -1
  6. package/types/sap.esh.search.ui.d.ts +405 -1
  7. package/types/sap.f.d.ts +75 -38
  8. package/types/sap.fe.core.d.ts +28 -2
  9. package/types/sap.fe.macros.d.ts +52 -69
  10. package/types/sap.fe.navigation.d.ts +2 -0
  11. package/types/sap.fe.templates.d.ts +6 -0
  12. package/types/sap.fe.test.d.ts +7 -1
  13. package/types/sap.feedback.ui.d.ts +2 -6
  14. package/types/sap.gantt.d.ts +238 -16
  15. package/types/sap.insights.d.ts +1 -1
  16. package/types/sap.landvisz.d.ts +27 -1
  17. package/types/sap.m.d.ts +1854 -85
  18. package/types/sap.makit.d.ts +13 -1
  19. package/types/sap.me.d.ts +17 -1
  20. package/types/sap.ndc.d.ts +10 -2
  21. package/types/sap.ovp.d.ts +7 -1
  22. package/types/sap.rules.ui.d.ts +9 -1
  23. package/types/sap.sac.df.d.ts +62 -1
  24. package/types/sap.sac.grid.d.ts +1 -1
  25. package/types/sap.suite.ui.commons.d.ts +272 -2
  26. package/types/sap.suite.ui.generic.template.d.ts +180 -1
  27. package/types/sap.suite.ui.microchart.d.ts +37 -1
  28. package/types/sap.tnt.d.ts +7 -1
  29. package/types/sap.ui.codeeditor.d.ts +5 -1
  30. package/types/sap.ui.commons.d.ts +197 -1
  31. package/types/sap.ui.comp.d.ts +314 -7
  32. package/types/sap.ui.core.d.ts +1508 -518
  33. package/types/sap.ui.dt.d.ts +1 -1
  34. package/types/sap.ui.export.d.ts +1 -1
  35. package/types/sap.ui.fl.d.ts +13 -1
  36. package/types/sap.ui.generic.app.d.ts +20 -7
  37. package/types/sap.ui.generic.template.d.ts +1 -1
  38. package/types/sap.ui.integration.d.ts +52 -19
  39. package/types/sap.ui.layout.d.ts +43 -1
  40. package/types/sap.ui.mdc.d.ts +1 -1
  41. package/types/sap.ui.richtexteditor.d.ts +11 -1
  42. package/types/sap.ui.rta.d.ts +1 -1
  43. package/types/sap.ui.suite.d.ts +5 -1
  44. package/types/sap.ui.support.d.ts +1 -1
  45. package/types/sap.ui.table.d.ts +63 -7
  46. package/types/sap.ui.testrecorder.d.ts +1 -1
  47. package/types/sap.ui.unified.d.ts +308 -4
  48. package/types/sap.ui.ux3.d.ts +147 -1
  49. package/types/sap.ui.vbm.d.ts +122 -1
  50. package/types/sap.ui.vk.d.ts +375 -2
  51. package/types/sap.ui.vtm.d.ts +73 -1
  52. package/types/sap.ui.webc.common.d.ts +1 -1
  53. package/types/sap.ui.webc.fiori.d.ts +63 -1
  54. package/types/sap.ui.webc.main.d.ts +189 -5
  55. package/types/sap.uiext.inbox.d.ts +27 -1
  56. package/types/sap.ushell.d.ts +375 -79
  57. package/types/sap.ushell_abap.d.ts +1 -1
  58. package/types/sap.uxap.d.ts +26 -1
  59. package/types/sap.viz.d.ts +229 -1
  60. package/types/sap.webanalytics.core.d.ts +1 -1
  61. package/types/sap.zen.commons.d.ts +1 -1
  62. package/types/sap.zen.crosstab.d.ts +1 -1
  63. package/types/sap.zen.dsh.d.ts +10 -1
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.112.3
1
+ // For Library Version: 1.113.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ushell {
@@ -12,6 +12,7 @@ declare namespace sap {
12
12
  /**
13
13
  * @SINCE 1.62.0
14
14
  * @EXPERIMENTAL
15
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
15
16
  */
16
17
  export const ContentExtensionAdapterFactory: undefined;
17
18
 
@@ -424,8 +425,13 @@ declare namespace sap {
424
425
  * @SINCE 1.18.0
425
426
  *
426
427
  * Wrapper object to expose a variant interface on a ContextContainer object obtained from the Peronalization
427
- * service: ` getContainer(...).done( function(oContainer) { that.oVariantSetContainer = new VariantSetAdapater(oContainer);
428
- * }); `
428
+ * service:
429
+ * ```javascript
430
+ *
431
+ * getContainer(...).done( function(oContainer) {
432
+ * that.oVariantSetContainer = new VariantSetAdapater(oContainer);
433
+ * });
434
+ * ```
429
435
  */
430
436
  class VariantSetAdapter {
431
437
  /**
@@ -636,6 +642,15 @@ declare namespace sap {
636
642
  * The type of the serviceURL's service. Only "OData" is supported.
637
643
  */
638
644
  type?: string;
645
+ /**
646
+ * Additional settings for the data source.
647
+ */
648
+ settings?: {
649
+ /**
650
+ * The OData version of parameter serviceURL. Valid values are "2.0" and "4.0".
651
+ */
652
+ odataVersion?: object;
653
+ };
639
654
  };
640
655
  /**
641
656
  * The refresh interval for the `serviceUrl` in seconds.
@@ -812,7 +827,7 @@ declare namespace sap {
812
827
  * ```javascript
813
828
  *
814
829
  * sap.ushell.Container.getServiceAsync("CrossApplicationNavigation").then(function (CrossApplicationNavigationService) {
815
- * // Do whatever you want...!
830
+ * // Use the CrossApplicationNavigation service
816
831
  * });
817
832
  * ```
818
833
  *
@@ -921,7 +936,7 @@ declare namespace sap {
921
936
  * shortTitle: "Perform" // optional
922
937
  * tags: ["tag-1", "tag-2"] // optional
923
938
  * }
924
- * ```
939
+ * ```
925
940
  *
926
941
  *
927
942
  * Properties marked as 'optional' in the example above may not be present in the returned result.
@@ -929,12 +944,15 @@ declare namespace sap {
929
944
  * **NOTE:** the intents returned are in **internal** format and cannot be directly put into a link
930
945
  * tag. Example: Let the string `"C&A != H&M"` be a parameter value.
931
946
  *
932
- * Intent will be encoded as`#AnObject-action?text=C%26A%20!%3D%20H%26M. Note that the intent is in
933
- * **internal** format, before putting it into a link tag, you must invoke: externalHash = oCrossApplicationNavigationService.hrefForExternal({
934
- * target : { shellHash : oLink.intent} }, that.oComponent); ` NOTE: in case the mass invocation
935
- * interface is used (see `vArgs` parameter explanation above), the promise will resolve to an array of
936
- * arrays of arrays. For example, if the mass interface specified two arguments, the promise would resolve
937
- * as follows:
947
+ * Intent will be encoded as#AnObject-action?text=C%26A%20!%3D%20H%26M. Note that the intent
948
+ * is in **internal** format, before putting it into a link tag, you must invoke:
949
+ * ```javascript
950
+ *
951
+ * externalHash = oCrossApplicationNavigationService.hrefForExternal({ target : { shellHash : oLink.intent} }, that.oComponent);
952
+ * ```
953
+ * NOTE: in case the mass invocation interface is used (see `vArgs` parameter explanation above),
954
+ * the promise will resolve to an array of arrays of arrays. For example, if the mass interface specified
955
+ * two arguments, the promise would resolve as follows:
938
956
  * ```javascript
939
957
  *
940
958
  * [ // mass interface was used, so return multiple values
@@ -1042,7 +1060,7 @@ declare namespace sap {
1042
1060
  * { action: "someAction" }
1043
1061
  * ]
1044
1062
  * // ... and so on
1045
- * ]);
1063
+ * ]).done(…);
1046
1064
  * ```
1047
1065
  *
1048
1066
  *
@@ -1104,14 +1122,16 @@ declare namespace sap {
1104
1122
  * subTitle: "Action", //optional
1105
1123
  * shortTitle: "Perform" //optional
1106
1124
  * }
1107
- * ```
1125
+ * ```
1108
1126
  *
1109
1127
  *
1110
1128
  * **NOTE:** the intents returned are in **internal** format and cannot be directly put into a link tag.
1111
- * Example: Let the string `"C&A != H&M"` be a parameter value. Intent will be encoded as`#AnObject-action?text=C%26A%20!%3D%20H%26M.
1129
+ * Example: Let the string `"C&A != H&M"` be a parameter value. Intent will be encoded as#AnObject-action?text=C%26A%20!%3D%20H%26M.
1112
1130
  * Note that the intent is in **internal** format, before putting it into a link tag, you must invoke:
1113
- * externalHash = oCrossApplicationNavigationService.hrefForExternal({ target : { shellHash : oLink.intent}
1114
- * }, that.oComponent); `
1131
+ * ```javascript
1132
+ *
1133
+ * externalHash = oCrossApplicationNavigationService.hrefForExternal({ target : { shellHash : oLink.intent} }, that.oComponent);
1134
+ * ```
1115
1135
  */
1116
1136
  getSemanticObjectLinks(
1117
1137
  /**
@@ -1126,7 +1146,7 @@ declare namespace sap {
1126
1146
  * A: "B",
1127
1147
  * c: "e"
1128
1148
  * }
1129
- * ```
1149
+ * ```
1130
1150
  */
1131
1151
  mParameters?: object,
1132
1152
  /**
@@ -1366,7 +1386,8 @@ declare namespace sap {
1366
1386
  /**
1367
1387
  * @SINCE 1.94.0
1368
1388
  *
1369
- * Returns a Promise which resolves a string. That string can be put into the DOM (e.g. in a link tag)
1389
+ * Returns a promise resolving to a URL that launches an app with certain parameters. The URL can be used
1390
+ * to define a link to a Fiori application, for example.
1370
1391
  *
1371
1392
  * @returns A Promise which resolves href for the specified parameters as an *external* shell hash; always
1372
1393
  * starting with a hash character; all parameters and parameter names are URL-encoded (via encodeURIComponent)
@@ -1384,25 +1405,68 @@ declare namespace sap {
1384
1405
  * when serialized as UTF-8.
1385
1406
  *
1386
1407
  * The function can be used to convert an shell hash internal format commonly encountered into the URL format
1387
- * to use in link tags: ` sap.ushell.Container.getServiceAsync("CrossApplicationNavigation").then( function
1388
- * (oService) { oService.hrefForExternalAsync({ target: { shellHash: oLink.intent } }, that.oComponent).then(
1389
- * function (sExternalHref) { // do something with the resolved sExternalHref. }); }); `
1408
+ * to use in link tags:
1409
+ * ```javascript
1410
+ *
1411
+ * sap.ushell.Container.getServiceAsync("CrossApplicationNavigation").then( function (oService) {
1412
+ * oService.hrefForExternalAsync({
1413
+ * target: { shellHash: oLink.intent }
1414
+ * }, that.oComponent).then( function (sExternalHref) {
1415
+ * // do something with the resolved sExternalHref.
1416
+ * });
1417
+ * });
1418
+ * ```
1419
+ *
1390
1420
  *
1391
1421
  * This API accepts a sap-xapp-state-data parameter that can be used generate a url that can be used to
1392
1422
  * launch and application with certain data, for example:
1393
1423
  *
1394
- * ` { target : { semanticObject : "AnObject", action: "action" }, params : { "sap-xapp-state-data" : JSON.stringify({
1395
- * a: "b", c: "d" }) } } `
1424
+ *
1425
+ * ```javascript
1426
+ *
1427
+ * {
1428
+ * target : { semanticObject : "AnObject", action: "action" },
1429
+ * params : { "sap-xapp-state-data" : JSON.stringify({ a: "b", c: "d" }) }
1430
+ * }
1431
+ * ```
1432
+ *
1396
1433
  *
1397
1434
  * Using the arguments as in the example above, a link with a sap-xapp-state parameter that encodes the
1398
1435
  * provided data is returned. The sap-xapp-state-data parameter does not appear in the generated link.
1399
1436
  */
1400
1437
  hrefForExternalAsync(
1401
1438
  /**
1402
- * object encoding a semantic object and action, e.g. ` { target : { semanticObject : "AnObject", action:
1403
- * "action" }, params : { A : "B" } } ` or e.g. ` { target : { semanticObject : "AnObject", action: "action",
1404
- * context : "AB7F3C" }, params : { A : "B", c : "e" } } ` or `{ target : { shellHash : "SO-36?jumper=postman"
1405
- * } }`
1439
+ * object encoding a semantic object and action, e.g.
1440
+ * ```javascript
1441
+ *
1442
+ * {
1443
+ * target : { semanticObject : "AnObject", action: "action" },
1444
+ * params : { A : "B" }
1445
+ * }
1446
+ * ```
1447
+ * or e.g.
1448
+ * ```javascript
1449
+ *
1450
+ * {
1451
+ * target : {
1452
+ * semanticObject : "AnObject",
1453
+ * action: "action", context : "AB7F3C"
1454
+ * },
1455
+ * params : {
1456
+ * A : "B",
1457
+ * c : "e"
1458
+ * }
1459
+ * }
1460
+ * ```
1461
+ * or
1462
+ * ```javascript
1463
+ *
1464
+ * {
1465
+ * target : {
1466
+ * shellHash : "SO-36?jumper=postman"
1467
+ * }
1468
+ * }
1469
+ * ```
1406
1470
  */
1407
1471
  oArgs: object,
1408
1472
  /**
@@ -1452,9 +1516,23 @@ declare namespace sap {
1452
1516
  * ```
1453
1517
  *
1454
1518
  *
1455
- * Example usage: ` this.oCrossAppNav.isIntentSupported(["SalesOrder-approve?SOId=1234"]) .done(function(aResponses)
1456
- * { if (oResponse["SalesOrder-approve?SOId=1234"].supported===true){ // enable link } else { // disable
1457
- * link } }) .fail(function() { // disable link // request failed or other error }); `
1519
+ * Example usage:
1520
+ * ```javascript
1521
+ *
1522
+ * this.oCrossAppNav.isIntentSupported(["SalesOrder-approve?SOId=1234"])
1523
+ * .done(function(aResponses) {
1524
+ * if (oResponse["SalesOrder-approve?SOId=1234"].supported===true){
1525
+ * // enable link
1526
+ * }
1527
+ * else {
1528
+ * // disable link
1529
+ * }
1530
+ * })
1531
+ * .fail(function() {
1532
+ * // disable link
1533
+ * // request failed or other error
1534
+ * });
1535
+ * ```
1458
1536
  */
1459
1537
  isIntentSupported(
1460
1538
  /**
@@ -1469,19 +1547,22 @@ declare namespace sap {
1469
1547
  /**
1470
1548
  * @SINCE 1.32
1471
1549
  *
1472
- * Tells whether the given navigation intent(s) are supported for the given parameters, form factor etc.
1473
- * "Supported" means that a valid navigation target is configured for the user for the given device.
1550
+ * Tells whether the given navigation intents are supported for the given parameters, form factor etc. .
1551
+ * "Supported" means that a valid navigation target is configured for the user and for the given device.
1474
1552
  *
1475
- * This is effectively a test function for {@link sap.ushell.services.CrossApplicationNavigation#toExternal}/
1476
- * {@link sap.ushell.services.CrossApplicationNavigation#hrefForExternal}. It is functionally equivalent
1477
- * to {@link sap.ushell.services.CrossApplicationNavigation#isIntentSupported} but accepts the same interface
1478
- * as {@link sap.ushell.services.CrossApplicationNavigation#toExternal}/ {@link sap.ushell.services.CrossApplicationNavigation#hrefForExternal}.
1553
+ * `isNavigationSupported` is effectively a test function for {@link sap.ushell.services.CrossApplicationNavigation#toExternal}
1554
+ * and {@link sap.ushell.services.CrossApplicationNavigation#hrefForExternal}.
1479
1555
  *
1480
- * @returns A `jQuery.Deferred` object's promise which is resolved with an array (!) of objects representing
1481
- * whether the intent is supported or not objects with a property `supported` of type `boolean`.
1482
- * representing Example:
1556
+ * It is functionally equivalent to {@link sap.ushell.services.CrossApplicationNavigation#isIntentSupported}
1557
+ * but accepts the same interface as {@link sap.ushell.services.CrossApplicationNavigation#toExternal} and
1558
+ * {@link sap.ushell.services.CrossApplicationNavigation#hrefForExternal}.
1483
1559
  *
1484
- * aIntents:
1560
+ * @returns Promise of a `jQuery.Deferred` object that resolves to an array of objects indicating whether
1561
+ * the intent is supported or not. Each object has a property `supported` of type `boolean`.
1562
+ *
1563
+ * Example:
1564
+ *
1565
+ * `aIntents`:
1485
1566
  * ```javascript
1486
1567
  *
1487
1568
  * [
@@ -1503,7 +1584,7 @@ declare namespace sap {
1503
1584
  * ```
1504
1585
  *
1505
1586
  *
1506
- * response: [Indices correspond]
1587
+ * `response`:
1507
1588
  * ```javascript
1508
1589
  *
1509
1590
  * [
@@ -1513,24 +1594,73 @@ declare namespace sap {
1513
1594
  * ```
1514
1595
  *
1515
1596
  *
1516
- * Example usage: ` this.oCrossAppNav.isNavigationSupported([ ]) .done(function(aResponses) { if (oResponse[0].supported===true){
1517
- * // enable link } else { // disable link } }) .fail(function() { // disable link // request failed or
1518
- * other fatal error }); `
1597
+ * Example usage:
1598
+ * ```javascript
1599
+ *
1600
+ * this.oCrossAppNav.isNavigationSupported([
1601
+ * target: { shellHash: "SalesOrder-approve?SOId=1234" }
1602
+ * ])
1603
+ * .done(function(aResponses) {
1604
+ * if (oResponse[0].supported===true){
1605
+ * // enable link
1606
+ * }
1607
+ * else {
1608
+ * // disable link
1609
+ * }
1610
+ * })
1611
+ * .fail(function() {
1612
+ * // disable link
1613
+ * // request failed or other fatal error
1614
+ * });
1615
+ * ```
1519
1616
  */
1520
1617
  isNavigationSupported(
1521
1618
  /**
1522
- * the intents to be checked with object being instances the oArgs object of toExternal, hrefForExternal
1523
- * etc. e.g. ` { target: { semanticObject: "AnObject", action: "action" }, params: { A: "B" } } ` or e.g.
1524
- * ` { target: { semanticObject: "AnObject", action: "action" }, params: { A: "B", c: "e" } } ` or `{ target:
1525
- * { shellHash: "SO-36&jumper=postman" } }`
1619
+ * The intents to be checked, with `object[]` being instances of the `oArgs` argument of the `toExternal`
1620
+ * or `hrefForExternal` methods, e.g.
1621
+ * ```javascript
1622
+ *
1623
+ * {
1624
+ * target: {
1625
+ * semanticObject: "AnObject",
1626
+ * action: "action"
1627
+ * },
1628
+ * params: { A: "B" }
1629
+ * }
1630
+ * ```
1631
+ * or e.g.
1632
+ * ```javascript
1633
+ *
1634
+ * {
1635
+ * target: {
1636
+ * semanticObject: "AnObject",
1637
+ * action: "action"
1638
+ * },
1639
+ * params: {
1640
+ * A: "B",
1641
+ * c: "e"
1642
+ * }
1643
+ * }
1644
+ * ```
1645
+ * or
1646
+ * ```javascript
1647
+ *
1648
+ * {
1649
+ * target: {
1650
+ * shellHash: "SalesOrder-approve?SOId=1234"
1651
+ * }
1652
+ * }
1653
+ * ```
1526
1654
  */
1527
1655
  aIntents: object[],
1528
1656
  /**
1529
- * the root component of the application
1657
+ * The root component of the application
1530
1658
  */
1531
1659
  oComponent?: object
1532
1660
  ): jQuery.Promise;
1533
1661
  /**
1662
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1663
+ *
1534
1664
  * Resolves the URL hash fragment.
1535
1665
  *
1536
1666
  * This function gets the hash part of the URL and returns the URL of the target application.
@@ -2057,7 +2187,7 @@ declare namespace sap {
2057
2187
  * The group whose tiles are returned
2058
2188
  */
2059
2189
  oGroup: object
2060
- ): any[];
2190
+ ): object[];
2061
2191
  /**
2062
2192
  * Returns the title of the given group.
2063
2193
  *
@@ -2080,7 +2210,7 @@ declare namespace sap {
2080
2210
  * The group whose link tiles are returned
2081
2211
  */
2082
2212
  oGroup: object
2083
- ): any[];
2213
+ ): object[];
2084
2214
  /**
2085
2215
  * Returns the tile's unique identifier
2086
2216
  *
@@ -2477,6 +2607,7 @@ declare namespace sap {
2477
2607
  ): void;
2478
2608
  /**
2479
2609
  * @SINCE 1.81.0
2610
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2480
2611
  *
2481
2612
  * Shows an error message with details on the screen. If more than one control should be shown, an {sap.m.VBox}
2482
2613
  * can be used. The default title is "error". If no custom buttons are given, an emphasized "close" button
@@ -2609,16 +2740,44 @@ declare namespace sap {
2609
2740
  * ```
2610
2741
  *
2611
2742
  *
2612
- * Example usage: ` this.oCrossAppNav.isNavigationSupported([ ]) .done(function(aResponses) { if (oResponse[0].supported===true){
2613
- * // enable link } else { // disable link } }) .fail(function() { // disable link // request failed or
2614
- * other fatal error }); `
2743
+ * Example usage:
2744
+ * ```javascript
2745
+ *
2746
+ * this.oCrossAppNav.isNavigationSupported([ ])
2747
+ * .done(function(aResponses) {
2748
+ * if (oResponse[0].supported===true){
2749
+ * // enable link
2750
+ * }
2751
+ * else {
2752
+ * // disable link
2753
+ * }
2754
+ * })
2755
+ * .fail(function() {
2756
+ * // disable link
2757
+ * // request failed or other fatal error
2758
+ * });
2759
+ * ```
2615
2760
  */
2616
2761
  isNavigationSupported(
2617
2762
  /**
2618
2763
  * the intents (such as `["#AnObject-action?A=B&c=e"]`) to be checked with object being instances the oArgs
2619
- * object of toExternal, hrefForExternal etc. e.g. ` { target : { semanticObject : "AnObject", action: "action"
2620
- * }, params : { A : "B" } } ` or e.g. ` { target : { semanticObject : "AnObject", action: "action" }, params
2621
- * : { A : "B", c : "e" } } ` or `{ target : { shellHash : "AnObject-action?A=B&c=e" } }`
2764
+ * object of toExternal, hrefForExternal etc. e.g.
2765
+ * ```javascript
2766
+ *
2767
+ * {
2768
+ * target : { semanticObject : "AnObject", action: "action" },
2769
+ * params : { A : "B" }
2770
+ * }
2771
+ * ```
2772
+ * or e.g.
2773
+ * ```javascript
2774
+ *
2775
+ * {
2776
+ * target : { semanticObject : "AnObject", action: "action" },
2777
+ * params : { A : "B", c : "e" }
2778
+ * }
2779
+ * ```
2780
+ * or `{ target : { shellHash : "AnObject-action?A=B&c=e" } }`
2622
2781
  */
2623
2782
  aIntents: object[]
2624
2783
  ): object;
@@ -2669,6 +2828,8 @@ declare namespace sap {
2669
2828
  sHashFragment: string
2670
2829
  ): object;
2671
2830
  /**
2831
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2832
+ *
2672
2833
  * Resolves a navigation target taking into account the sap-system
2673
2834
  *
2674
2835
  * This function should be used by the NWBC browser in order to get a resolved target corresponding to a
@@ -2687,8 +2848,22 @@ declare namespace sap {
2687
2848
  */
2688
2849
  resolveTarget(
2689
2850
  /**
2690
- * ` { target : { semanticObject : "semantic object", action : "action", }, params : { "sap-system-src":
2691
- * "e.g. sid(UR5.120)", "sap-system": { ... data related to the sap-system } } } `
2851
+ *
2852
+ * ```javascript
2853
+ *
2854
+ * {
2855
+ * target : {
2856
+ * semanticObject : "semantic object",
2857
+ * action : "action",
2858
+ * },
2859
+ * params : {
2860
+ * "sap-system-src": "e.g. sid(UR5.120)",
2861
+ * "sap-system": {
2862
+ * ... data related to the sap-system
2863
+ * }
2864
+ * }
2865
+ * }
2866
+ * ```
2692
2867
  */
2693
2868
  oArgs: object
2694
2869
  ): jQuery.Promise;
@@ -3102,8 +3277,14 @@ declare namespace sap {
3102
3277
  * without loss of data. One may even run mixed set of applications on the same container keys. The sole
3103
3278
  * differences are w.r.t. client side handling of the Context data within one session.
3104
3279
  *
3105
- * If you want to use the variant interface, use the following pattern ` getContainer(sContainerKey).done(function(oContainer)
3106
- * { var variantSetAdapter = new Personalization.VariantSetAdapter(oContainer); } `
3280
+ * If you want to use the variant interface, use the following pattern
3281
+ * ```javascript
3282
+ *
3283
+ * getContainer(sContainerKey).done(function(oContainer) {
3284
+ * var variantSetAdapter = new Personalization.VariantSetAdapter(oContainer);
3285
+ * }
3286
+ * ```
3287
+ *
3107
3288
  *
3108
3289
  * Factory method to obtain a personalization container object which is a client-local buffer for personalization
3109
3290
  * data. The Container data is asynchronously read on creation (if present, otherwise an initial object
@@ -3174,7 +3355,7 @@ declare namespace sap {
3174
3355
  * Since 1.27.0. SAPUI5 component which uses the personalizer. This allows to associate the stored data
3175
3356
  * with the application.
3176
3357
  */
3177
- oComponent: sap.ui.core.Component
3358
+ oComponent?: sap.ui.core.Component
3178
3359
  ): object;
3179
3360
  /**
3180
3361
  * @SINCE 1.18.0
@@ -3850,9 +4031,22 @@ declare namespace sap {
3850
4031
  constructShellHash(
3851
4032
  /**
3852
4033
  * The action must be a valid action, it may not contain "?" or directly a parameter string `undefined`
3853
- * if not a parsable hash ` { target: { semanticObject: string, action: string, contextRaw: string }, params:
3854
- * MapObject, appStateKey: string appSpecificRoute: string } ` xor `{ target: { shellHash
3855
- * } }` Note: in general it is preferred to add an appStateKey directly to the params object
4034
+ * if not a parsable hash
4035
+ * ```javascript
4036
+ *
4037
+ * {
4038
+ * target: {
4039
+ * semanticObject: string,
4040
+ * action: string,
4041
+ * contextRaw: string
4042
+ * },
4043
+ * params: MapObject,
4044
+ * appStateKey: string
4045
+ * appSpecificRoute: string
4046
+ * }
4047
+ * ```
4048
+ * xor `{ target: { shellHash } }` Note: in general it is preferred to add an appStateKey directly to the
4049
+ * params object
3856
4050
  */
3857
4051
  oShellHash: object
3858
4052
  ): string;
@@ -3971,12 +4165,23 @@ declare namespace sap {
3971
4165
  * Decompose a shell hash into the respective parts
3972
4166
  *
3973
4167
  * @returns `undefined` if not a parsable hash
3974
- * ` { semanticObject : string,
3975
- * action : string,
3976
- * contextRaw : string,
3977
- * params : MapObject,
3978
- * appSpecificRoute : string
3979
- * } ` Note that params always has an Array for each parameter value!
4168
+ *
4169
+ * ```javascript
4170
+ *
4171
+ * {
4172
+ * semanticObject : string,
4173
+ *
4174
+ * action : string,
4175
+ *
4176
+ * contextRaw : string,
4177
+ *
4178
+ * params : MapObject,
4179
+ *
4180
+ * appSpecificRoute : string
4181
+ *
4182
+ * }
4183
+ * ```
4184
+ * Note that params always has an Array for each parameter value!
3980
4185
  */
3981
4186
  parseShellHash(
3982
4187
  /**
@@ -3993,9 +4198,15 @@ declare namespace sap {
3993
4198
  * parts
3994
4199
  * for non compliant hash strings, the empty object {} is returned. an optional leading # is stripped
3995
4200
  *
3996
- * @returns `{}`(empty object) if not a parsable hash ` { shellPart : "Object-name~AFE2==?PV1=PV2&PV4=V5",
3997
- * appSpecificRoute : "display/detail/7?UU=HH" } ` otherwise Note that params always has an Array for each
3998
- * parameter value!
4201
+ * @returns `{}`(empty object) if not a parsable hash
4202
+ * ```javascript
4203
+ *
4204
+ * {
4205
+ * shellPart : "Object-name~AFE2==?PV1=PV2&PV4=V5",
4206
+ * appSpecificRoute : "display/detail/7?UU=HH"
4207
+ * }
4208
+ * ```
4209
+ * otherwise Note that params always has an Array for each parameter value!
3999
4210
  */
4000
4211
  splitHash(
4001
4212
  /**
@@ -4368,6 +4579,8 @@ declare namespace sap {
4368
4579
  oListener?: object
4369
4580
  ): this;
4370
4581
  /**
4582
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
4583
+ *
4371
4584
  * Fires event {@link #event:pictureDelete pictureDelete} to attached listeners.
4372
4585
  *
4373
4586
  * @returns Reference to `this` in order to allow method chaining
@@ -4610,6 +4823,8 @@ declare namespace sap {
4610
4823
  oListener?: object
4611
4824
  ): this;
4612
4825
  /**
4826
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
4827
+ *
4613
4828
  * Fires event {@link #event:pictureDeleted pictureDeleted} to attached listeners.
4614
4829
  *
4615
4830
  * @returns Reference to `this` in order to allow method chaining
@@ -5559,7 +5774,7 @@ declare namespace sap {
5559
5774
  bIsVisible: boolean,
5560
5775
  /**
5561
5776
  * If `true`, add the item to the currently rendered shell. If `false`, add the item to the given LaunchPadStates
5562
- * This causes the items to be rendered everytime the given states are active.
5777
+ * This causes the items to be rendered every time the given states are active.
5563
5778
  */
5564
5779
  bCurrentState: boolean,
5565
5780
  /**
@@ -5871,7 +6086,7 @@ declare namespace sap {
5871
6086
  vIds: string | string[],
5872
6087
  /**
5873
6088
  * If `true`, remove the items from the currently rendered shell. If `false`, remove the items from the
5874
- * LaunchPadState itself, causing the items to be removed everytime the given states are active.
6089
+ * LaunchPadState itself, causing the items to be removed every time the given states are active.
5875
6090
  */
5876
6091
  bCurrentState: boolean,
5877
6092
  /**
@@ -5960,7 +6175,7 @@ declare namespace sap {
5960
6175
  /**
5961
6176
  * @SINCE 1.38
5962
6177
  *
5963
- * Sets the header visibility accrding to the given value and shell states. (see sap.ushell.renderers.fiori2.renderer.LaunchpadState).
6178
+ * Sets the header visibility according to the given value and shell states. (see sap.ushell.renderers.fiori2.renderer.LaunchpadState).
5964
6179
  *
5965
6180
  * **Example:**
5966
6181
  * ```javascript
@@ -6277,7 +6492,7 @@ declare namespace sap {
6277
6492
  vIds: string | string[],
6278
6493
  /**
6279
6494
  * If `true`, add the items to the currently rendered shell. If `false`, add the items to the LaunchPadState
6280
- * itself, causing the items to be rendered everytime the given states are active.
6495
+ * itself, causing the items to be rendered every time the given states are active.
6281
6496
  */
6282
6497
  bCurrentState: boolean,
6283
6498
  /**
@@ -6534,6 +6749,8 @@ declare namespace sap {
6534
6749
  oListener?: object
6535
6750
  ): this;
6536
6751
  /**
6752
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
6753
+ *
6537
6754
  * Fires event {@link #event:afterRendering afterRendering} to attached listeners.
6538
6755
  *
6539
6756
  * @returns Reference to `this` in order to allow method chaining
@@ -6545,6 +6762,8 @@ declare namespace sap {
6545
6762
  mParameters?: object
6546
6763
  ): this;
6547
6764
  /**
6765
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
6766
+ *
6548
6767
  * Fires event {@link #event:press press} to attached listeners.
6549
6768
  *
6550
6769
  * @returns Reference to `this` in order to allow method chaining
@@ -6754,6 +6973,15 @@ declare namespace sap {
6754
6973
  | sap.ui.base.ManagedObject.PropertyBindingInfo
6755
6974
  | `{${string}}`;
6756
6975
 
6976
+ /**
6977
+ * Data source of the OData service. See same parameter of {@link sap.ushell.services.Bookmark#addBookmark}
6978
+ * for details
6979
+ */
6980
+ dataSource?:
6981
+ | any
6982
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
6983
+ | `{${string}}`;
6984
+
6757
6985
  /**
6758
6986
  * Number of seconds after which dynamic content is read from the data source and the display is refreshed.
6759
6987
  */
@@ -6892,6 +7120,15 @@ declare namespace sap {
6892
7120
  * @returns Value of property `customUrl`
6893
7121
  */
6894
7122
  getCustomUrl(): any;
7123
+ /**
7124
+ * Gets current value of property {@link #getDataSource dataSource}.
7125
+ *
7126
+ * Data source of the OData service. See same parameter of {@link sap.ushell.services.Bookmark#addBookmark}
7127
+ * for details
7128
+ *
7129
+ * @returns Value of property `dataSource`
7130
+ */
7131
+ getDataSource(): any;
6895
7132
  /**
6896
7133
  * Gets current value of property {@link #getInfo info}.
6897
7134
  *
@@ -7039,6 +7276,22 @@ declare namespace sap {
7039
7276
  */
7040
7277
  oCustomUrl?: any
7041
7278
  ): this;
7279
+ /**
7280
+ * Sets a new value for property {@link #getDataSource dataSource}.
7281
+ *
7282
+ * Data source of the OData service. See same parameter of {@link sap.ushell.services.Bookmark#addBookmark}
7283
+ * for details
7284
+ *
7285
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7286
+ *
7287
+ * @returns Reference to `this` in order to allow method chaining
7288
+ */
7289
+ setDataSource(
7290
+ /**
7291
+ * New value for property `dataSource`
7292
+ */
7293
+ oDataSource?: any
7294
+ ): this;
7042
7295
  /**
7043
7296
  * Sets a new value for property {@link #getInfo info}.
7044
7297
  *
@@ -7233,6 +7486,10 @@ declare namespace sap {
7233
7486
  | string
7234
7487
  | sap.ui.base.ManagedObject.PropertyBindingInfo;
7235
7488
 
7489
+ tileCatalogIdStable?:
7490
+ | string
7491
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
7492
+
7236
7493
  target?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
7237
7494
 
7238
7495
  visible?:
@@ -7474,6 +7731,8 @@ declare namespace sap {
7474
7731
  oListener?: object
7475
7732
  ): this;
7476
7733
  /**
7734
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
7735
+ *
7477
7736
  * Fires event {@link #event:afterRendering afterRendering} to attached listeners.
7478
7737
  *
7479
7738
  * @returns Reference to `this` in order to allow method chaining
@@ -7485,6 +7744,8 @@ declare namespace sap {
7485
7744
  mParameters?: object
7486
7745
  ): this;
7487
7746
  /**
7747
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
7748
+ *
7488
7749
  * Fires event {@link #event:press press} to attached listeners.
7489
7750
  *
7490
7751
  * @returns Reference to `this` in order to allow method chaining
@@ -7665,6 +7926,8 @@ declare namespace sap {
7665
7926
  oListener?: object
7666
7927
  ): this;
7667
7928
  /**
7929
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
7930
+ *
7668
7931
  * Fires event {@link #event:afterRendering afterRendering} to attached listeners.
7669
7932
  *
7670
7933
  * @returns Reference to `this` in order to allow method chaining
@@ -8116,6 +8379,8 @@ declare namespace sap {
8116
8379
  oListener?: object
8117
8380
  ): this;
8118
8381
  /**
8382
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
8383
+ *
8119
8384
  * Fires event {@link #event:afterRendering afterRendering} to attached listeners.
8120
8385
  *
8121
8386
  * @returns Reference to `this` in order to allow method chaining
@@ -8127,6 +8392,8 @@ declare namespace sap {
8127
8392
  mParameters?: object
8128
8393
  ): this;
8129
8394
  /**
8395
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
8396
+ *
8130
8397
  * Fires event {@link #event:coverDivPress coverDivPress} to attached listeners.
8131
8398
  *
8132
8399
  * @returns Reference to `this` in order to allow method chaining
@@ -8138,6 +8405,8 @@ declare namespace sap {
8138
8405
  mParameters?: object
8139
8406
  ): this;
8140
8407
  /**
8408
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
8409
+ *
8141
8410
  * Fires event {@link #event:press press} to attached listeners.
8142
8411
  *
8143
8412
  * @returns Reference to `this` in order to allow method chaining
@@ -8149,6 +8418,8 @@ declare namespace sap {
8149
8418
  mParameters?: object
8150
8419
  ): this;
8151
8420
  /**
8421
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
8422
+ *
8152
8423
  * Fires event {@link #event:showActions showActions} to attached listeners.
8153
8424
  *
8154
8425
  * @returns Reference to `this` in order to allow method chaining
@@ -8213,6 +8484,12 @@ declare namespace sap {
8213
8484
  * @returns Value of property `tileCatalogId`
8214
8485
  */
8215
8486
  getTileCatalogId(): string;
8487
+ /**
8488
+ * Gets current value of property {@link #getTileCatalogIdStable tileCatalogIdStable}.
8489
+ *
8490
+ * @returns Value of property `tileCatalogIdStable`
8491
+ */
8492
+ getTileCatalogIdStable(): string;
8216
8493
  /**
8217
8494
  * Gets content of aggregation {@link #getTileViews tileViews}.
8218
8495
  */
@@ -8426,6 +8703,19 @@ declare namespace sap {
8426
8703
  */
8427
8704
  sTileCatalogId?: string
8428
8705
  ): this;
8706
+ /**
8707
+ * Sets a new value for property {@link #getTileCatalogIdStable tileCatalogIdStable}.
8708
+ *
8709
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8710
+ *
8711
+ * @returns Reference to `this` in order to allow method chaining
8712
+ */
8713
+ setTileCatalogIdStable(
8714
+ /**
8715
+ * New value for property `tileCatalogIdStable`
8716
+ */
8717
+ sTileCatalogIdStable?: string
8718
+ ): this;
8429
8719
  /**
8430
8720
  * Sets a new value for property {@link #getUuid uuid}.
8431
8721
  *
@@ -8578,6 +8868,8 @@ declare namespace sap {
8578
8868
  oListener?: object
8579
8869
  ): this;
8580
8870
  /**
8871
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
8872
+ *
8581
8873
  * Fires event {@link #event:press press} to attached listeners.
8582
8874
  *
8583
8875
  * @returns Reference to `this` in order to allow method chaining
@@ -8861,6 +9153,8 @@ declare namespace sap {
8861
9153
  oListener?: object
8862
9154
  ): this;
8863
9155
  /**
9156
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
9157
+ *
8864
9158
  * Fires event {@link #event:expand expand} to attached listeners.
8865
9159
  *
8866
9160
  * @returns Reference to `this` in order to allow method chaining
@@ -8872,6 +9166,8 @@ declare namespace sap {
8872
9166
  mParameters?: object
8873
9167
  ): this;
8874
9168
  /**
9169
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
9170
+ *
8875
9171
  * Fires event {@link #event:press press} to attached listeners.
8876
9172
  *
8877
9173
  * @returns Reference to `this` in order to allow method chaining
@@ -9693,7 +9989,7 @@ declare namespace sap {
9693
9989
  *
9694
9990
  * Register the work protection dirty callback function. In the work protect mechanism, each platform can
9695
9991
  * register their own method in order to check if data was changed during the session, and notify the container
9696
- * about the change. Multiple registerings of the same function are allowed.
9992
+ * about the change. Registering multiple times the same function is allowed.
9697
9993
  *
9698
9994
  * Use `Function.prototype.bind()` to determine the callback's `this` or some of its arguments.
9699
9995
  */