@sapui5/ts-types 1.113.0 → 1.115.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 (64) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +0 -1
  3. package/types/sap.apf.d.ts +2 -2
  4. package/types/sap.ca.ui.d.ts +135 -67
  5. package/types/sap.chart.d.ts +154 -125
  6. package/types/sap.collaboration.d.ts +80 -78
  7. package/types/sap.esh.search.ui.d.ts +137 -1
  8. package/types/sap.f.d.ts +1357 -926
  9. package/types/sap.fe.core.d.ts +45 -155
  10. package/types/sap.fe.macros.d.ts +80 -9
  11. package/types/sap.fe.navigation.d.ts +34 -27
  12. package/types/sap.fe.templates.d.ts +8 -275
  13. package/types/sap.fe.test.d.ts +4 -10
  14. package/types/sap.feedback.ui.d.ts +1 -1
  15. package/types/sap.gantt.d.ts +1716 -1087
  16. package/types/sap.insights.d.ts +1 -1
  17. package/types/sap.landvisz.d.ts +35 -9
  18. package/types/sap.m.d.ts +7689 -5451
  19. package/types/sap.makit.d.ts +17 -5
  20. package/types/sap.me.d.ts +122 -63
  21. package/types/sap.ndc.d.ts +99 -39
  22. package/types/sap.ovp.d.ts +1 -2
  23. package/types/sap.rules.ui.d.ts +43 -19
  24. package/types/sap.sac.df.d.ts +31 -579
  25. package/types/sap.suite.ui.commons.d.ts +2060 -1282
  26. package/types/sap.suite.ui.generic.template.d.ts +29 -40
  27. package/types/sap.suite.ui.microchart.d.ts +188 -136
  28. package/types/sap.tnt.d.ts +134 -54
  29. package/types/sap.ui.codeeditor.d.ts +51 -29
  30. package/types/sap.ui.commons.d.ts +1017 -599
  31. package/types/sap.ui.comp.d.ts +2755 -1772
  32. package/types/sap.ui.core.d.ts +5398 -3172
  33. package/types/sap.ui.dt.d.ts +1 -1
  34. package/types/sap.ui.export.d.ts +32 -29
  35. package/types/sap.ui.fl.d.ts +123 -82
  36. package/types/sap.ui.generic.app.d.ts +41 -40
  37. package/types/sap.ui.generic.template.d.ts +1 -1
  38. package/types/sap.ui.integration.d.ts +344 -163
  39. package/types/sap.ui.layout.d.ts +312 -355
  40. package/types/sap.ui.mdc.d.ts +21839 -8
  41. package/types/sap.ui.richtexteditor.d.ts +61 -49
  42. package/types/sap.ui.rta.d.ts +1 -2
  43. package/types/sap.ui.suite.d.ts +9 -9
  44. package/types/sap.ui.support.d.ts +5 -7
  45. package/types/sap.ui.table.d.ts +713 -452
  46. package/types/sap.ui.testrecorder.d.ts +1 -1
  47. package/types/sap.ui.unified.d.ts +1077 -727
  48. package/types/sap.ui.ux3.d.ts +1038 -549
  49. package/types/sap.ui.vbm.d.ts +1262 -710
  50. package/types/sap.ui.vk.d.ts +3020 -1751
  51. package/types/sap.ui.vtm.d.ts +704 -457
  52. package/types/sap.ui.webc.common.d.ts +1 -1
  53. package/types/sap.ui.webc.fiori.d.ts +532 -301
  54. package/types/sap.ui.webc.main.d.ts +1222 -720
  55. package/types/sap.uiext.inbox.d.ts +47 -24
  56. package/types/sap.ushell.d.ts +360 -174
  57. package/types/sap.ushell_abap.d.ts +1 -1
  58. package/types/sap.uxap.d.ts +287 -199
  59. package/types/sap.viz.d.ts +678 -391
  60. package/types/sap.webanalytics.core.d.ts +1 -1
  61. package/types/sap.zen.commons.d.ts +5 -5
  62. package/types/sap.zen.crosstab.d.ts +1 -1
  63. package/types/sap.zen.dsh.d.ts +147 -81
  64. package/types/sap.sac.grid.d.ts +0 -760
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.113.0
1
+ // For Library Version: 1.115.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ushell {
@@ -11,7 +11,7 @@ declare namespace sap {
11
11
  namespace services {
12
12
  /**
13
13
  * @SINCE 1.62.0
14
- * @EXPERIMENTAL
14
+ * @deprecated
15
15
  * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
16
16
  */
17
17
  export const ContentExtensionAdapterFactory: undefined;
@@ -475,33 +475,14 @@ declare namespace sap {
475
475
  }
476
476
  /**
477
477
  * @SINCE 1.38
478
+ *
479
+ * The Unified Shell's AppLifeCycle service.
480
+ *
481
+ * **Please note:** To retrieve a valid instance of this service you must call `sap.ushell.Container.getServiceAsync("AppLifeCycle")`.
482
+ * For details see {@link sap.ushell.services.Container#getServiceAsync}.
478
483
  */
479
484
  class AppLifeCycle {
480
- /**
481
- * The Unified Shell's AppLifeCycle service This method MUST be called by the Unified Shell's container
482
- * only, others MUST call `sap.ushell.Container.getServiceAsync("AppLifeCycle").then(function (AppLifeCycle)
483
- * {});`. Constructs a new instance of the AppLifeCycle service.
484
- * See:
485
- * sap.ushell.services.Container#getServiceAsync
486
- */
487
- constructor(
488
- /**
489
- * The service adapter for the AppLifeCycle service, as already provided by the container
490
- */
491
- oAdapter: object,
492
- /**
493
- * interface
494
- */
495
- oContainerInterface: object,
496
- /**
497
- * Service instantiation
498
- */
499
- sParameter: string,
500
- /**
501
- * service configuration (not in use)
502
- */
503
- oConfig: object
504
- );
485
+ constructor();
505
486
 
506
487
  /**
507
488
  * @SINCE 1.38
@@ -547,18 +528,18 @@ declare namespace sap {
547
528
  * - applicationType: “UI5|WDA|NWBC|URL|TR”
548
529
  * - componentInstance: reference to component (only for applicationType "UI5").
549
530
  * - homePage: `true` when root intent (normally #Shell-home) or Appfinder (#Shell-appfinder) is currently
550
- * displayed.
531
+ * displayed.
551
532
  * - getTechnicalParameter: `function` that returns the value of a technical parameter for the given
552
- * application. This method is for SAP internal usage only.
533
+ * application. This method is for SAP internal usage only.
553
534
  * - getIntent: `function` that returns a `Promise` that resolves with the current shell hash as an `Object`.
554
- * See {@link sap.ushell.services.URLParsing#parseShellHash} for details. This property is for SAP-internal
555
- * use only!
535
+ * See {@link sap.ushell.services.URLParsing#parseShellHash} for details. This property is for SAP-internal
536
+ * use only!
556
537
  * - getInfo: `function` that is called with an `Array` with following optional elements of type `String`
557
538
  *
558
539
  * ` productName ` A human readable free form text maintained on the platform where FLP runs, and identifying
559
540
  * the current product.
560
541
  * - ` theme ` Current FLP theme. Includes the path to the theme resources if the theme is not an sap
561
- * theme (does not start with sap_)
542
+ * theme (does not start with sap_)
562
543
  * - ` languageTag ` Current Language (BCP47 format)
563
544
  * - ` appIntent ` Intent that was used to launch the application (including parameters)
564
545
  * - ` appFrameworkId `ID of the framework
@@ -567,8 +548,8 @@ declare namespace sap {
567
548
  * - ` appVersion ` Version of the app
568
549
  * - ` appSupportInfo ` The name of an organizational component that handles support incidents.
569
550
  * - ` appFrameworkVersion ` Version of the framework The `function` returns a `Promise` that
570
- * resolves with an `Object` with properties corresponding to the elements of the `Array` passed as input.
571
- * Each of these properties holds its value or undefined if not configured.
551
+ * resolves with an `Object` with properties corresponding to the elements of the `Array` passed as input.
552
+ * Each of these properties holds its value or undefined if not configured.
572
553
  *
573
554
  * **Note:** Return value is only valid after app is loaded. See {@link #attachAppLoaded} for details. Before
574
555
  * an app is loaded, `undefined` is returned.
@@ -580,15 +561,12 @@ declare namespace sap {
580
561
  /**
581
562
  * @SINCE 1.15.0
582
563
  *
583
- * The unified shell's bookmark service, which allows you to create shortcuts on the user's home page.
564
+ * The Unified Shell's bookmark service, which allows you to create shortcuts on the user's home page.
565
+ *
566
+ * **Please note:** To retrieve a valid instance of this service you must call `sap.ushell.Container.getServiceAsync("Bookmark")`.
567
+ * For details see {@link sap.ushell.services.Container#getServiceAsync}.
584
568
  */
585
569
  class Bookmark {
586
- /**
587
- * This method MUST be called by the Unified Shell's container only, others MUST call `sap.ushell.Container.getServiceAsync("Bookmark").then(function
588
- * (Bookmark) {});`. Constructs a new instance of the bookmark service.
589
- * See:
590
- * sap.ushell.services.Container#getServiceAsync
591
- */
592
570
  constructor();
593
571
 
594
572
  /**
@@ -662,9 +640,9 @@ declare namespace sap {
662
640
  numberUnit?: string;
663
641
  },
664
642
  /**
665
- * Either a legacy launchpad home page group, one content node or an array of content nodes. (See {@link
666
- * #getContentNodes}) If not provided, the bookmark will be added to the default group if spaces mode is
667
- * not active or to the default page if spaces mode is active.
643
+ * Either a legacy launchpad home page group, one content node or an array of content nodes. (See {@link #getContentNodes})
644
+ * If not provided, the bookmark will be added to the default group if spaces mode is not active or to the
645
+ * default page if spaces mode is active.
668
646
  */
669
647
  vContainer?:
670
648
  | object
@@ -726,7 +704,11 @@ declare namespace sap {
726
704
  /**
727
705
  * The URL of the bookmarks to be counted, exactly as specified to {@link #addBookmark}.
728
706
  */
729
- sUrl: string
707
+ sUrl: string,
708
+ /**
709
+ * The Content Provider ID.
710
+ */
711
+ sContentProviderId: string
730
712
  ): jQuery.Promise;
731
713
  /**
732
714
  * @SINCE 1.17.1
@@ -763,7 +745,7 @@ declare namespace sap {
763
745
  * It has the following properties:
764
746
  * - id: ID of the content node
765
747
  * - label: Human-readable representation of a content node which can be displayed in a control
766
- * - type: Specifies the content node type. E.g: space, page, group, etc. See {@link sap.ushell.ContentNodeType}
748
+ * - type: Specifies the content node type. E.g: space, page, group, etc. See {@link sap.ushell.ContentNodeType }
767
749
  *
768
750
  * - isContainer: Specifies if a bookmark can be added
769
751
  * - children: Specifies sub-nodes
@@ -792,9 +774,64 @@ declare namespace sap {
792
774
  */
793
775
  sUrl: string,
794
776
  /**
795
- * The bookmark parameters as documented in {@link #addBookmark}.
777
+ * Bookmark parameters. In addition to title and URL, a bookmark might allow additional settings, such as
778
+ * an icon or a subtitle. Which settings are supported depends on the environment in which the application
779
+ * is running. Unsupported parameters will be ignored.
796
780
  */
797
- oParameters: object,
781
+ oParameters: {
782
+ /**
783
+ * The title of the bookmark.
784
+ */
785
+ title: string;
786
+ /**
787
+ * The target URL or intent of the bookmark. If the target application shall run in the current shell, the
788
+ * URL has to be a valid intent, i.e. in the format like `"#SO-Action?P1=a&P2=x&/route?RPV=1"`.
789
+ */
790
+ url: string;
791
+ /**
792
+ * The optional icon URL of the bookmark (e.g. `"sap-icon://home"`).
793
+ */
794
+ icon?: string;
795
+ /**
796
+ * The information text of the bookmark.
797
+ */
798
+ info?: string;
799
+ /**
800
+ * The subtitle of the bookmark.
801
+ */
802
+ subtitle?: string;
803
+ /**
804
+ * The URL to a REST or OData service that provides some dynamic information for the bookmark.
805
+ */
806
+ serviceUrl?: string;
807
+ /**
808
+ * Metadata for parameter serviceUrl. Mandatory to specify if parameter serviceURL contains semantic date
809
+ * ranges. This does not influence the data source of the app itself.
810
+ */
811
+ dataSource?: {
812
+ /**
813
+ * The type of the serviceURL's service. Only "OData" is supported.
814
+ */
815
+ type?: string;
816
+ /**
817
+ * Additional settings for the data source.
818
+ */
819
+ settings?: {
820
+ /**
821
+ * The OData version of parameter serviceURL. Valid values are "2.0" and "4.0".
822
+ */
823
+ odataVersion?: object;
824
+ };
825
+ };
826
+ /**
827
+ * The refresh interval for the `serviceUrl` in seconds.
828
+ */
829
+ serviceRefreshInterval?: string;
830
+ /**
831
+ * The unit for the number retrieved from `serviceUrl`.
832
+ */
833
+ numberUnit?: string;
834
+ },
798
835
  /**
799
836
  * The contentProviderId or undefined outside the cFLP
800
837
  */
@@ -948,7 +985,7 @@ declare namespace sap {
948
985
  * is in **internal** format, before putting it into a link tag, you must invoke:
949
986
  * ```javascript
950
987
  *
951
- * externalHash = oCrossApplicationNavigationService.hrefForExternal({ target : { shellHash : oLink.intent} }, that.oComponent);
988
+ * externalHash = oCrossApplicationNavigationService.hrefForExternal({ target : { shellHash : oLink.intent } }, that.oComponent);
952
989
  * ```
953
990
  * NOTE: in case the mass invocation interface is used (see `vArgs` parameter explanation above),
954
991
  * the promise will resolve to an array of arrays of arrays. For example, if the mass interface specified
@@ -976,6 +1013,8 @@ declare namespace sap {
976
1013
  getLinks(
977
1014
  /**
978
1015
  * An object containing nominal arguments for the method, having the following structure:
1016
+ *
1017
+ *
979
1018
  * ```javascript
980
1019
  *
981
1020
  * {
@@ -994,19 +1033,16 @@ declare namespace sap {
994
1033
  * // - "text" lexicographical sort on returned 'text' field
995
1034
  * // - "priority" experimental - top intents are returned first
996
1035
  *
997
- * treatTechHintAsFilter : true, // optional, defaults to false
998
- * // if true, only apps that match
999
- * // exactly the supplied technology
1000
- * // (e.g. sap-ui-tech-hint=WDA) will be considered
1036
+ * treatTechHintAsFilter : true, // optional, defaults to false.
1037
+ * // if true, only apps that match exactly the supplied technology (e.g. sap-ui-tech-hint=WDA) will be considered.
1001
1038
  *
1002
1039
  * ui5Component: UI5Component, // mandatory, the UI5 component invoking the service, shall be a root component!
1003
1040
  *
1004
- * appStateKey: "abc123...", // optional, application state key to add to the generated links, SAP internal usage only
1041
+ * appStateKey: "abc123...", // optional, application state key to add to the generated links, SAP internal usage only.
1005
1042
  *
1006
- * compactIntents: true // optional, whether intents should be returned in compact format.
1007
- * // Defaults to false.
1043
+ * compactIntents: true // optional, whether intents should be returned in compact format. Defaults to false.
1008
1044
  *
1009
- * ignoreFormFactor: true, // optional, defaults to false, deprecated, do not use, may have no effect in the future
1045
+ * ignoreFormFactor: true, // optional, defaults to false, deprecated, do not use, may have no effect in the future.
1010
1046
  *
1011
1047
  * tags: ["tag-1", "tag-2"] // optional, if specified, only returns links that match inbound with certain tags.
1012
1048
  * }
@@ -1067,7 +1103,95 @@ declare namespace sap {
1067
1103
  * Calling this method with no arguments will produce the same result as if the method was called with
1068
1104
  * an empty object.
1069
1105
  */
1070
- vArgs?: object | object[]
1106
+ vArgs?:
1107
+ | {
1108
+ /**
1109
+ * Optional, matches any semantic objects if undefined
1110
+ */
1111
+ semanticObject?: string;
1112
+ /**
1113
+ * Optional, matches any actions if undefined
1114
+ */
1115
+ action?: string;
1116
+ /**
1117
+ * Optional business parameters
1118
+ */
1119
+ params?: object;
1120
+ /**
1121
+ * Optional, defaults to false. If true, returns only the links that use at least one (non sap-) parameter
1122
+ * from 'params'.
1123
+ */
1124
+ withAtLeastOneUsedParam?: boolean;
1125
+ /**
1126
+ * Optional parameter that decides on how the returned results will be sorted.
1127
+ */
1128
+ sortResultsBy?: string;
1129
+ /**
1130
+ * Optional, defaults to false. If true, only apps that match exactly the supplied technology (e.g. sap-ui-tech-hint=WDA)
1131
+ * will be considered.
1132
+ */
1133
+ treatTechHintAsFilter?: boolean;
1134
+ /**
1135
+ * Mandatory, the UI5 component invoking the service, shall be a root component.
1136
+ */
1137
+ ui5Component: sap.ui.core.Component;
1138
+ /**
1139
+ * Optional, application state key to add to the generated links, SAP internal usage only.
1140
+ */
1141
+ appStateKey?: string;
1142
+ /**
1143
+ * Optional, whether intents should be returned in compact format. Defaults to false.
1144
+ */
1145
+ compactIntents?: boolean;
1146
+ /**
1147
+ * Optional, if specified, only returns links that match inbound with certain tags.
1148
+ */
1149
+ tags?: string[];
1150
+ }
1151
+ | Array<{
1152
+ /**
1153
+ * Optional, matches any semantic objects if undefined
1154
+ */
1155
+ semanticObject?: string;
1156
+ /**
1157
+ * Optional, matches any actions if undefined
1158
+ */
1159
+ action?: string;
1160
+ /**
1161
+ * Optional business parameters
1162
+ */
1163
+ params?: object;
1164
+ /**
1165
+ * Optional, defaults to false. If true, returns only the links that use at least one (non sap-) parameter
1166
+ * from 'params'.
1167
+ */
1168
+ withAtLeastOneUsedParam?: boolean;
1169
+ /**
1170
+ * Optional parameter that decides on how the returned results will be sorted.
1171
+ */
1172
+ sortResultsBy?: string;
1173
+ /**
1174
+ * Optional, defaults to false. If true, only apps that match exactly the supplied technology (e.g. sap-ui-tech-hint=WDA)
1175
+ * will be considered.
1176
+ */
1177
+ treatTechHintAsFilter?: boolean;
1178
+ /**
1179
+ * Mandatory, the UI5 component invoking the service, shall be a root component.
1180
+ */
1181
+ ui5Component: sap.ui.core.Component;
1182
+ /**
1183
+ * Optional, application state key to add to the generated links, SAP internal usage only.
1184
+ */
1185
+ appStateKey?: string;
1186
+ /**
1187
+ * Optional, whether intents should be returned in compact format. Defaults to false.
1188
+ */
1189
+ compactIntents?: boolean;
1190
+ /**
1191
+ * Optional, if specified, only returns links that match inbound with certain tags.
1192
+ */
1193
+ tags?: string[];
1194
+ }>
1071
1195
  ): jQuery.Promise;
1072
1196
  /**
1073
1197
  * @SINCE 1.48
@@ -1076,7 +1200,7 @@ declare namespace sap {
1076
1200
  * returns the one tagged as a "primaryAction". If no inbound tagged as "primaryAction" exists, then the
1077
1201
  * intent of the first inbound (after sorting has been applied) matching the action "displayFactSheet".
1078
1202
  *
1079
- * The primary intent is determined by querying {@link sap.ushell.services.CrossApplicationNavigation#getLinks}
1203
+ * The primary intent is determined by querying {@link sap.ushell.services.CrossApplicationNavigation#getLinks }
1080
1204
  * with the given semantic object and optional parameter. Then the resulting list is filtered to the outcome
1081
1205
  * that a single item remains.
1082
1206
  *
@@ -1130,7 +1254,7 @@ declare namespace sap {
1130
1254
  * Note that the intent is in **internal** format, before putting it into a link tag, you must invoke:
1131
1255
  * ```javascript
1132
1256
  *
1133
- * externalHash = oCrossApplicationNavigationService.hrefForExternal({ target : { shellHash : oLink.intent} }, that.oComponent);
1257
+ * externalHash = oCrossApplicationNavigationService.hrefForExternal({ target : { shellHash : oLink.intent } }, that.oComponent);
1134
1258
  * ```
1135
1259
  */
1136
1260
  getSemanticObjectLinks(
@@ -1550,10 +1674,10 @@ declare namespace sap {
1550
1674
  * Tells whether the given navigation intents are supported for the given parameters, form factor etc. .
1551
1675
  * "Supported" means that a valid navigation target is configured for the user and for the given device.
1552
1676
  *
1553
- * `isNavigationSupported` is effectively a test function for {@link sap.ushell.services.CrossApplicationNavigation#toExternal}
1677
+ * `isNavigationSupported` is effectively a test function for {@link sap.ushell.services.CrossApplicationNavigation#toExternal }
1554
1678
  * and {@link sap.ushell.services.CrossApplicationNavigation#hrefForExternal}.
1555
1679
  *
1556
- * It is functionally equivalent to {@link sap.ushell.services.CrossApplicationNavigation#isIntentSupported}
1680
+ * It is functionally equivalent to {@link sap.ushell.services.CrossApplicationNavigation#isIntentSupported }
1557
1681
  * but accepts the same interface as {@link sap.ushell.services.CrossApplicationNavigation#toExternal} and
1558
1682
  * {@link sap.ushell.services.CrossApplicationNavigation#hrefForExternal}.
1559
1683
  *
@@ -2609,7 +2733,7 @@ declare namespace sap {
2609
2733
  * @SINCE 1.81.0
2610
2734
  * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2611
2735
  *
2612
- * Shows an error message with details on the screen. If more than one control should be shown, an {sap.m.VBox}
2736
+ * Shows an error message with details on the screen. If more than one control should be shown, an {sap.m.VBox }
2613
2737
  * can be used. The default title is "error". If no custom buttons are given, an emphasized "close" button
2614
2738
  * is shown.
2615
2739
  *
@@ -2652,7 +2776,10 @@ declare namespace sap {
2652
2776
  /**
2653
2777
  * @SINCE 1.15.0
2654
2778
  *
2655
- * The Unified Shell's internal navigation target resolution service
2779
+ * The Unified Shell's internal navigation target resolution service.
2780
+ *
2781
+ * **Please note:** To retrieve a valid instance of this service you must call `sap.ushell.Container.getServiceAsync("NavTargetResolution")`.
2782
+ * For details see {@link sap.ushell.services.Container#getServiceAsync}.
2656
2783
  *
2657
2784
  * Methods in this class deal with *internal* representations of the shell hash.
2658
2785
  *
@@ -2661,18 +2788,7 @@ declare namespace sap {
2661
2788
  * ... )
2662
2789
  */
2663
2790
  class NavTargetResolution {
2664
- /**
2665
- * This method MUST be called by the Unified Shell's container only, others MUST call `sap.ushell.Container.getServiceAsync("NavTargetResolution").then(function
2666
- * (NavTargetResolution) {});`. Constructs a new instance of the navigation target resolution service.
2667
- * See:
2668
- * sap.ushell.services.Container#getServiceAsync
2669
- */
2670
- constructor(
2671
- /**
2672
- * a Service configuration
2673
- */
2674
- oServiceConfiguration: object
2675
- );
2791
+ constructor();
2676
2792
 
2677
2793
  /**
2678
2794
  * expands a URL hash fragment
@@ -2704,7 +2820,7 @@ declare namespace sap {
2704
2820
  * Example:
2705
2821
  *
2706
2822
  * aIntents: an array of parameterized (parsed) Intent objects, in the corresponding structure to arguments
2707
- * to {@link sap.ushell.services.CrossApplicationNavigation.toExternal}, {@link sap.ushell.services.CrossApplicationNavigation.hrefForExternal}
2823
+ * to {@link sap.ushell.services.CrossApplicationNavigation.toExternal}, {@link sap.ushell.services.CrossApplicationNavigation.hrefForExternal }
2708
2824
  *
2709
2825
  * ```javascript
2710
2826
  *
@@ -2803,7 +2919,7 @@ declare namespace sap {
2803
2919
  *
2804
2920
  * This is an asynchronous operation.
2805
2921
  *
2806
- * @returns A jQuery.Promise. Its `done()` function gets an object that you can use to create a {@link sap.ushell.components.container.ApplicationContainer}
2922
+ * @returns A jQuery.Promise. Its `done()` function gets an object that you can use to create a {@link sap.ushell.components.container.ApplicationContainer }
2807
2923
  * or `undefined` in case the hash fragment was empty. Typically it contains the following information:
2808
2924
  *
2809
2925
  * ```javascript
@@ -3102,7 +3218,7 @@ declare namespace sap {
3102
3218
  *
3103
3219
  * An initial object is returned.
3104
3220
  *
3105
- * @returns Promise object whose done function returns a {@link sap.ushell.services.Personalization.ContextContainer}
3221
+ * @returns Promise object whose done function returns a {@link sap.ushell.services.Personalization.ContextContainer }
3106
3222
  * object as parameter. The personalization container provides two different interfaces to synchronously
3107
3223
  * operate on personalization data. In the item mode the container contains items as name value pairs for
3108
3224
  * personalization data. In the variant mode the container contains variant sets which contain variants
@@ -3239,7 +3355,7 @@ declare namespace sap {
3239
3355
  * server persistent storage. Thus a sequence delete( [validity 0])/wait for promise, getContainer(sKey,{
3240
3356
  * validity : Infinity}) may return a valid dataset.
3241
3357
  *
3242
- * @returns Promise object whose done function returns a {@link sap.ushell.services.Personalization.ContextContainer}
3358
+ * @returns Promise object whose done function returns a {@link sap.ushell.services.Personalization.ContextContainer }
3243
3359
  * object as parameter. The container provides setItemValue / getItemValue methods to synchronously operate
3244
3360
  * on personalization data. By wrapping it in a VariantSetAdapter, an alternate interface to maintain variants
3245
3361
  * can be obtained.
@@ -3307,7 +3423,7 @@ declare namespace sap {
3307
3423
  *
3308
3424
  * Do not mix up the usage of a personalizer and a personalization container for one containerKey.
3309
3425
  *
3310
- * @returns Promise object whose done function returns a {@link sap.ushell.services.PersonalizationContainer}
3426
+ * @returns Promise object whose done function returns a {@link sap.ushell.services.PersonalizationContainer }
3311
3427
  * object as parameter. The personalization container provides two different interfaces to synchronously
3312
3428
  * operate on personalization data. In the item mode the container contains items as name-value pairs for
3313
3429
  * personalization data. In the variant mode the container contains variant sets which contain variants
@@ -3327,8 +3443,8 @@ declare namespace sap {
3327
3443
  *
3328
3444
  * Do not mix the usage of a personalizer and a personalization container for one containerKey.
3329
3445
  *
3330
- * Fetching multiple Personalizer for the same container, but different items is not supported. Use {@link
3331
- * sap.ushell.services.Personalizer#getContainer} instead for this scenario.
3446
+ * Fetching multiple Personalizer for the same container, but different items is not supported. Use {@link sap.ushell.services.Personalizer#getContainer }
3447
+ * instead for this scenario.
3332
3448
  *
3333
3449
  * @returns {@link sap.ushell.services.Personalizer} which provides generic read and write access to the
3334
3450
  * currently logged on user's personalization settings.
@@ -3740,7 +3856,7 @@ declare namespace sap {
3740
3856
  * Thus it is crucial to use appropriate interfaces and not directly invoke window.location.hash.
3741
3857
  *
3742
3858
  * - internal construction methods for a "current" App specific and non-app specific hash (invoked by CrossApplicationNavigation),
3743
- * not to be invoked directly!
3859
+ * not to be invoked directly!
3744
3860
  * See:
3745
3861
  * sap.ushell.services.Container#getServiceAsync
3746
3862
  */
@@ -4066,7 +4182,7 @@ declare namespace sap {
4066
4182
  /**
4067
4183
  * @SINCE 1.16.0
4068
4184
  *
4069
- * Extract the Shell hash# part from an URL The application specific route part is removed See {@link #getHash}
4185
+ * Extract the Shell hash# part from an URL The application specific route part is removed See {@link #getHash }
4070
4186
  * for a function which retains the app specific route.
4071
4187
  *
4072
4188
  * Shell services shall use this service to extract relevant parts of an URL from an actual URL string (which
@@ -4443,6 +4559,10 @@ declare namespace sap {
4443
4559
  image?: sap.m.Image;
4444
4560
  }
4445
4561
 
4562
+ interface $PictureTilePictureDeleteEventParameters {}
4563
+
4564
+ interface $PictureViewerPictureDeletedEventParameters {}
4565
+
4446
4566
  /**
4447
4567
  * @deprecated (since 1.22) - Please use {@link sap.m.Carousel} instead.
4448
4568
  *
@@ -5213,7 +5333,7 @@ declare namespace sap {
5213
5333
  * control. Valid only if bCurrentState is set to false.
5214
5334
  */
5215
5335
  aStates: string[]
5216
- ): object;
5336
+ ): sap.ui.core.Control;
5217
5337
  /**
5218
5338
  * @SINCE 1.30
5219
5339
  * @deprecated (since 1.93)
@@ -5395,7 +5515,7 @@ declare namespace sap {
5395
5515
  * in which to add the control.
5396
5516
  */
5397
5517
  aStates: string[]
5398
- ): object;
5518
+ ): sap.ui.core.Control;
5399
5519
  /**
5400
5520
  * @SINCE 1.30
5401
5521
  *
@@ -5457,7 +5577,7 @@ declare namespace sap {
5457
5577
  * If no launchpad state is provided the control is added in all states.
5458
5578
  */
5459
5579
  aStates: string[]
5460
- ): object;
5580
+ ): sap.ui.core.Control;
5461
5581
  /**
5462
5582
  * @SINCE 1.30
5463
5583
  *
@@ -5514,7 +5634,7 @@ declare namespace sap {
5514
5634
  * If no launchpad state is provided the control is added in all states.
5515
5635
  */
5516
5636
  aStates: string[]
5517
- ): object;
5637
+ ): sap.ui.core.Control;
5518
5638
  /**
5519
5639
  * @SINCE 1.30
5520
5640
  * @deprecated (since 1.48) - Please use {@link #addSidePaneContent} instead.
@@ -5593,27 +5713,37 @@ declare namespace sap {
5593
5713
  * ```
5594
5714
  *
5595
5715
  *
5596
- * @returns jQuery.deferred.promise object that when resolved, returns the newly created control
5716
+ * @returns jQuery.Deferred.promise object that when resolved, returns the newly created control
5597
5717
  */
5598
5718
  addShellSubHeader(
5599
5719
  /**
5600
- * Contains the required parameters for creating and showing the new control object:
5601
- * Properties:
5602
- * - {string} controlType
5603
- * The (class) name of the control type to create.
5604
- * - {object} oControlProperties
5605
- * The properties that will be passed to the created control.
5606
- * - {boolean} bIsVisible
5607
- * Specify whether to display the control.
5608
- * - {boolean} bCurrentState
5609
- * If true, add the current control only to the current rendered shell state.
5610
- * Once the user navigates to another app or back to the Home page, this control will be removed.
5611
- * - {string[]} aStates
5612
- * (only valid if bCurrentState is set to false) - list of the sap.ushell.renderers.fiori2.Renderer.LaunchpadState
5613
- * in which to add the control.
5720
+ * Contains the required parameters for creating and showing the new control object.
5614
5721
  */
5615
- oParameters: object
5616
- ): object;
5722
+ oParameters: {
5723
+ /**
5724
+ * The (class) name of the control type to create.
5725
+ */
5726
+ controlType: string;
5727
+ /**
5728
+ * The properties that will be passed to the created control.
5729
+ */
5730
+ oControlProperties: object;
5731
+ /**
5732
+ * Specify whether to display the control.
5733
+ */
5734
+ bIsVisible: boolean;
5735
+ /**
5736
+ * If true, add the current control only to the current rendered shell state. Once the user navigates to
5737
+ * another app or back to the Home page, this control will be removed.
5738
+ */
5739
+ bCurrentState: boolean;
5740
+ /**
5741
+ * (only valid if bCurrentState is set to false) - list of the sap.ushell.renderers.fiori2.Renderer.LaunchpadState
5742
+ * in which to add the control.
5743
+ */
5744
+ aStates: string[];
5745
+ }
5746
+ ): jQuery.Promise;
5617
5747
  /**
5618
5748
  * @SINCE 1.48
5619
5749
  *
@@ -5641,7 +5771,7 @@ declare namespace sap {
5641
5771
  * LaunchpadState
5642
5772
  * If no launchpad state is provided the content is added in all states.
5643
5773
  *
5644
- * @returns jQuery.deferred.promise object that when resolved, returns the newly created control.
5774
+ * @returns jQuery.Deferred.promise object that when resolved, returns the newly created control.
5645
5775
  */
5646
5776
  addSidePaneContent(
5647
5777
  /**
@@ -5671,7 +5801,7 @@ declare namespace sap {
5671
5801
  */
5672
5802
  aStates: string[];
5673
5803
  }
5674
- ): object;
5804
+ ): jQuery.Promise;
5675
5805
  /**
5676
5806
  * @SINCE 1.30
5677
5807
  * @deprecated (since 1.48) - Please use {@link #addShellSubHeader} instead.
@@ -5782,7 +5912,7 @@ declare namespace sap {
5782
5912
  * in which the controls are added. If no launchpad state is provided the items are added in all states.
5783
5913
  */
5784
5914
  aStates: string[]
5785
- ): object;
5915
+ ): sap.ui.core.Control;
5786
5916
  /**
5787
5917
  * @SINCE 1.48
5788
5918
  *
@@ -5809,31 +5939,39 @@ declare namespace sap {
5809
5939
  * oRenderer.addUserAction(oAddActionButtonProperties);
5810
5940
  * ```
5811
5941
  *
5812
- * See:
5813
- * LaunchpadState
5814
- * If no launchpad state is provided the content is added in all states.
5815
5942
  *
5816
- * @returns jQuery.deferred.promise object that when resolved, returns the newly created control
5943
+ * @returns jQuery.Deferred.promise object that when resolved, returns the newly created control
5817
5944
  */
5818
5945
  addUserAction(
5819
5946
  /**
5820
- * Contains the required parameters for creating and showing the new control object:
5821
- * Properties:
5822
- * - {string} controlType
5823
- * The (class) name of the control type to create.
5824
- * - {object} oControlProperties
5825
- * The properties that will be passed to the created control.
5826
- * - {boolean} bIsVisible
5827
- * Specify whether to display the control.
5828
- * - {boolean} bCurrentState
5829
- * If true, add the current control only to the current rendered shell state.
5830
- * Once the user navigates to another app or back to the Home page, this control will be removed.
5831
- * - {string[]} aStates
5832
- * (only valid if bCurrentState is set to false) - list of the sap.ushell.renderers.fiori2.Renderer.LaunchpadState
5833
- * in which to add the control.
5947
+ * Contains the required parameters for creating and showing the new control object.
5834
5948
  */
5835
- oParameters: object
5836
- ): object;
5949
+ oParameters: {
5950
+ /**
5951
+ * The (class) name of the control type to create.
5952
+ */
5953
+ controlType: string;
5954
+ /**
5955
+ * The properties that will be passed to the created control.
5956
+ */
5957
+ oControlProperties: object;
5958
+ /**
5959
+ * Specify whether to display the control.
5960
+ */
5961
+ bIsVisible: boolean;
5962
+ /**
5963
+ * If true, add the current control only to the current rendered shell state. Once the user navigates to
5964
+ * another app or back to the Home page, this control will be removed.
5965
+ */
5966
+ bCurrentState: boolean;
5967
+ /**
5968
+ * (only valid if bCurrentState is set to false) - list of the sap.ushell.renderers.fiori2.Renderer.LaunchpadState
5969
+ * in which to add the control. If no launchpad state is provided the content is added in all states. @see
5970
+ * LaunchpadState
5971
+ */
5972
+ aStates: string[];
5973
+ }
5974
+ ): jQuery.Promise;
5837
5975
  /**
5838
5976
  * @SINCE 1.30
5839
5977
  *
@@ -5858,33 +5996,49 @@ declare namespace sap {
5858
5996
  * };
5859
5997
  * oRenderer.addUserPreferencesEntry(oEntry);
5860
5998
  * ```
5861
- *
5862
- *
5863
- * @returns User Preference Entry.
5864
5999
  */
5865
6000
  addUserPreferencesEntry(
5866
6001
  /**
5867
- * The data of the new added User Preference entry Including:
5868
- * {string} entryHelpID (Optional) - The ID of the object.
5869
- * {string} title - The title of the entry to be presented in the list in the User Preferences dialog
5870
- * box.
5871
- * We recommend using a string from the translation bundle.
5872
- * {string}/{Function} value - A string to be presented as the value of the entry
5873
- * OR a function to be called which returns a {jQuery.Deferred.promise} object.
5874
- * {Function} content - A function to be called that returns a {jQuery.Deferred.promise} object
5875
- * which consists of a {sap.ui.core.Control} to be displayed in a follow-on dialog box. A SAPUI5 view instance
5876
- * can also be returned. The functions is called on each time the user opens the User Preferences dialog
5877
- * box. {Function} onSave - A function to be called which returns a {jQuery.Deferred.promise} object
5878
- * when the user clicks Save in the User Preferences dialog box.
5879
- * If an error occurs, pass the error message via the {jQuery.Deferred.promise} object. Errors are displayed
5880
- * in the log.
5881
- * {Function} onCancel - A function to be called that closes the User Preferences dialog box without
5882
- * saving any changes.
5883
- * {Boolean} provideEmptyWrapper - Experimental. Set this value to true if you want that your content
5884
- * is displayed without the standard header
5885
- */
5886
- entryObject: object
5887
- ): object;
6002
+ * The data of the new added User Preference entry.
6003
+ */
6004
+ entryObject: {
6005
+ /**
6006
+ * (Optional) - The ID of the object.
6007
+ */
6008
+ entryHelpID: string;
6009
+ /**
6010
+ * The title of the entry to be presented in the list in the User Preferences dialog box. We recommend using
6011
+ * a string from the translation bundle.
6012
+ */
6013
+ title: string;
6014
+ /**
6015
+ * A function to be called that returns a {jQuery.Deferred.promise} object which consists of a {sap.ui.core.Control }
6016
+ * to be displayed in a follow-on dialog box. A SAPUI5 view instance can also be returned. The function
6017
+ * is called on each time the user opens the User Preferences dialog box.
6018
+ */
6019
+ content: Function;
6020
+ /**
6021
+ * A function to be called which returns a {jQuery.Deferred.promise} object when the user clicks "save"
6022
+ * in the User Preferences dialog box. If an error occurs, pass the error message via the {jQuery.Deferred.promise }
6023
+ * object. Errors are displayed in the log.
6024
+ */
6025
+ onSave: Function;
6026
+ /**
6027
+ * A function to be called that closes the User Preferences dialog box without saving any changes.
6028
+ */
6029
+ onCancel: Function;
6030
+ /**
6031
+ * Experimental. Set this value to true if you want that your content is displayed without the standard
6032
+ * header.
6033
+ */
6034
+ provideEmptyWrapper: boolean;
6035
+ },
6036
+ /**
6037
+ * A string to be presented as the value of the entry OR a function to be called which returns a {jQuery.Deferred.promise }
6038
+ * object.
6039
+ */
6040
+ value: string | Function
6041
+ ): void;
5888
6042
  /**
5889
6043
  * @SINCE 1.37
5890
6044
  *
@@ -5892,7 +6046,7 @@ declare namespace sap {
5892
6046
  *
5893
6047
  * @returns The current Viewport State.
5894
6048
  */
5895
- getCurrentViewportState(): object;
6049
+ getCurrentViewportState(): string;
5896
6050
  /**
5897
6051
  * @SINCE 1.30
5898
6052
  *
@@ -6119,7 +6273,7 @@ declare namespace sap {
6119
6273
  /**
6120
6274
  * sap.m.Bar, the control to be added as the footer of the Fiori Launchpad
6121
6275
  */
6122
- oFooter: Object
6276
+ oFooter: sap.m.Bar
6123
6277
  ): void;
6124
6278
  /**
6125
6279
  * @SINCE 1.42
@@ -6160,7 +6314,7 @@ declare namespace sap {
6160
6314
  * For example: `{id: "testBar"}`
6161
6315
  */
6162
6316
  oControlProperties: object
6163
- ): object;
6317
+ ): sap.ui.core.Control;
6164
6318
  /**
6165
6319
  * @SINCE 1.30
6166
6320
  *
@@ -6255,15 +6409,19 @@ declare namespace sap {
6255
6409
  */
6256
6410
  setShellFooter(
6257
6411
  /**
6258
- * Contains the required parameters for creating and showing the new control object:
6259
- * Properties:
6260
- * - {string} controlType
6261
- * The (class) name of the control type to create, for example: `"sap.m.Bar"`
6262
- * - {object} oControlProperties
6263
- * The properties that will be passed to the created control, for example: `{id: "testBar"}`
6412
+ * Contains the required parameters for creating and showing the new control object.
6264
6413
  */
6265
- oParameters: object
6266
- ): object;
6414
+ oParameters: {
6415
+ /**
6416
+ * The (class) name of the control type to create, for example: `sap.m.Bar`
6417
+ */
6418
+ controlType: string;
6419
+ /**
6420
+ * The properties that will be passed to the created control, for example: `{id: "testBar"}`
6421
+ */
6422
+ oControlProperties: object;
6423
+ }
6424
+ ): jQuery.Promise;
6267
6425
  /**
6268
6426
  * @SINCE 1.30
6269
6427
  *
@@ -6551,6 +6709,10 @@ declare namespace sap {
6551
6709
  afterRendering?: (oEvent: sap.ui.base.Event) => void;
6552
6710
  }
6553
6711
 
6712
+ interface $AppBoxAfterRenderingEventParameters {}
6713
+
6714
+ interface $AppBoxPressEventParameters {}
6715
+
6554
6716
  /**
6555
6717
  * Add your documentation for the new ui/appfinder/AppBox
6556
6718
  */
@@ -6974,7 +7136,7 @@ declare namespace sap {
6974
7136
  | `{${string}}`;
6975
7137
 
6976
7138
  /**
6977
- * Data source of the OData service. See same parameter of {@link sap.ushell.services.Bookmark#addBookmark}
7139
+ * Data source of the OData service. See same parameter of {@link sap.ushell.services.Bookmark#addBookmark }
6978
7140
  * for details
6979
7141
  */
6980
7142
  dataSource?:
@@ -7123,7 +7285,7 @@ declare namespace sap {
7123
7285
  /**
7124
7286
  * Gets current value of property {@link #getDataSource dataSource}.
7125
7287
  *
7126
- * Data source of the OData service. See same parameter of {@link sap.ushell.services.Bookmark#addBookmark}
7288
+ * Data source of the OData service. See same parameter of {@link sap.ushell.services.Bookmark#addBookmark }
7127
7289
  * for details
7128
7290
  *
7129
7291
  * @returns Value of property `dataSource`
@@ -7279,7 +7441,7 @@ declare namespace sap {
7279
7441
  /**
7280
7442
  * Sets a new value for property {@link #getDataSource dataSource}.
7281
7443
  *
7282
- * Data source of the OData service. See same parameter of {@link sap.ushell.services.Bookmark#addBookmark}
7444
+ * Data source of the OData service. See same parameter of {@link sap.ushell.services.Bookmark#addBookmark }
7283
7445
  * for details
7284
7446
  *
7285
7447
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
@@ -7546,6 +7708,23 @@ declare namespace sap {
7546
7708
  press?: (oEvent: sap.ui.base.Event) => void;
7547
7709
  }
7548
7710
 
7711
+ interface $ActionItemAfterRenderingEventParameters {}
7712
+
7713
+ interface $ActionItemPressEventParameters
7714
+ extends sap.m.$ButtonPressEventParameters {}
7715
+
7716
+ interface $DashboardGroupsContainerAfterRenderingEventParameters {}
7717
+
7718
+ interface $LinkTileWrapperAfterRenderingEventParameters {}
7719
+
7720
+ interface $LinkTileWrapperCoverDivPressEventParameters {}
7721
+
7722
+ interface $LinkTileWrapperPressEventParameters {}
7723
+
7724
+ interface $LinkTileWrapperShowActionsEventParameters {}
7725
+
7726
+ interface $TileStatePressEventParameters {}
7727
+
7549
7728
  class ActionItem extends sap.m.Button {
7550
7729
  /**
7551
7730
  * Constructor for a new ui/launchpad/ActionItem.
@@ -8962,6 +9141,10 @@ declare namespace sap {
8962
9141
  expand?: (oEvent: sap.ui.base.Event) => void;
8963
9142
  }
8964
9143
 
9144
+ interface $ToolAreaItemExpandEventParameters {}
9145
+
9146
+ interface $ToolAreaItemPressEventParameters {}
9147
+
8965
9148
  /**
8966
9149
  * @SINCE 1.30.5
8967
9150
  *
@@ -9349,8 +9532,8 @@ declare namespace sap {
9349
9532
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
9350
9533
  * of the syntax of the settings object.
9351
9534
  *
9352
- * This class does not have its own settings, but all settings applicable to the base type {@link sap.ushell.ui.tile.TileBase#constructor
9353
- * sap.ushell.ui.tile.TileBase} can be used.
9535
+ * This class does not have its own settings, but all settings applicable to the base type {@link sap.ushell.ui.tile.TileBase#constructor sap.ushell.ui.tile.TileBase }
9536
+ * can be used.
9354
9537
  */
9355
9538
  constructor(
9356
9539
  /**
@@ -9431,7 +9614,6 @@ declare namespace sap {
9431
9614
  */
9432
9615
  getMetadata(): sap.ui.base.Metadata;
9433
9616
  }
9434
- const UserStatus: UserStatus;
9435
9617
 
9436
9618
  /**
9437
9619
  * @SINCE 1.38.0
@@ -9767,7 +9949,11 @@ declare namespace sap {
9767
9949
  * If `true`, the renderer is created asynchronously and a `Promise` is returned.
9768
9950
  */
9769
9951
  bAsync?: boolean
9770
- ): sap.ui.core.Control | Promise<any>;
9952
+ ):
9953
+ | sap.ui.core.Control
9954
+ | Promise<sap.ui.core.Control>
9955
+ | sap.ui.core.ComponentContainer
9956
+ | Promise<sap.ui.core.ComponentContainer>;
9771
9957
  /**
9772
9958
  * @SINCE 1.67.0
9773
9959
  *
@@ -9840,7 +10026,7 @@ declare namespace sap {
9840
10026
  * if not given here.
9841
10027
  */
9842
10028
  sRendererName?: string
9843
- ): object;
10029
+ ): sap.ui.core.Control | sap.ui.core.Component;
9844
10030
  /**
9845
10031
  * @SINCE 1.15.0
9846
10032
  * @deprecated (since 1.77) - Please use {@link #getServiceAsync} instead.
@@ -9915,7 +10101,7 @@ declare namespace sap {
9915
10101
  * if true, the adapter is loaded asynchronously and a Promise is returned. (since 1.55.0)
9916
10102
  */
9917
10103
  bAsync?: boolean
9918
- ): object | Promise<any>;
10104
+ ): object | Promise<object>;
9919
10105
  /**
9920
10106
  * @SINCE 1.55.0
9921
10107
  *
@@ -9983,7 +10169,7 @@ declare namespace sap {
9983
10169
  * A parameter which is passed to the service constructor and every adapter constructor.
9984
10170
  */
9985
10171
  sParameter?: string
9986
- ): Promise<any>;
10172
+ ): Promise<object>;
9987
10173
  /**
9988
10174
  * @SINCE 1.31.0
9989
10175
  *