@sapui5/ts-types 1.101.1 → 1.102.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 (62) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +1 -0
  3. package/types/sap.apf.d.ts +89 -1
  4. package/types/sap.ca.ui.d.ts +1747 -124
  5. package/types/sap.chart.d.ts +375 -29
  6. package/types/sap.collaboration.d.ts +320 -40
  7. package/types/sap.esh.search.ui.d.ts +1 -669
  8. package/types/sap.f.d.ts +1785 -100
  9. package/types/sap.fe.common.d.ts +1 -1
  10. package/types/sap.fe.core.d.ts +70 -2
  11. package/types/sap.fe.macros.d.ts +78 -34
  12. package/types/sap.fe.navigation.d.ts +144 -4
  13. package/types/sap.fe.templates.d.ts +26 -5
  14. package/types/sap.fe.test.d.ts +497 -2
  15. package/types/sap.feedback.ui.d.ts +1 -1
  16. package/types/sap.gantt.d.ts +7203 -502
  17. package/types/sap.insights.d.ts +80 -0
  18. package/types/sap.landvisz.d.ts +1015 -66
  19. package/types/sap.m.d.ts +16491 -1149
  20. package/types/sap.makit.d.ts +575 -54
  21. package/types/sap.me.d.ts +578 -51
  22. package/types/sap.ndc.d.ts +63 -5
  23. package/types/sap.ovp.d.ts +5 -6
  24. package/types/sap.rules.ui.d.ts +171 -15
  25. package/types/sap.sac.df.d.ts +1430 -215
  26. package/types/sap.sac.grid.d.ts +91 -8
  27. package/types/sap.suite.ui.commons.d.ts +5515 -396
  28. package/types/sap.suite.ui.generic.template.d.ts +157 -69
  29. package/types/sap.suite.ui.microchart.d.ts +1801 -160
  30. package/types/sap.tnt.d.ts +279 -19
  31. package/types/sap.ui.codeeditor.d.ts +89 -8
  32. package/types/sap.ui.commons.d.ts +3784 -313
  33. package/types/sap.ui.comp.d.ts +3853 -276
  34. package/types/sap.ui.core.d.ts +6248 -313
  35. package/types/sap.ui.dt.d.ts +1 -1
  36. package/types/sap.ui.export.d.ts +61 -6
  37. package/types/sap.ui.fl.d.ts +1 -1
  38. package/types/sap.ui.generic.app.d.ts +238 -64
  39. package/types/sap.ui.generic.template.d.ts +1 -1
  40. package/types/sap.ui.integration.d.ts +316 -23
  41. package/types/sap.ui.layout.d.ts +1851 -199
  42. package/types/sap.ui.mdc.d.ts +1 -1
  43. package/types/sap.ui.richtexteditor.d.ts +340 -49
  44. package/types/sap.ui.rta.d.ts +5 -1
  45. package/types/sap.ui.suite.d.ts +87 -6
  46. package/types/sap.ui.support.d.ts +30 -1
  47. package/types/sap.ui.table.d.ts +1050 -80
  48. package/types/sap.ui.testrecorder.d.ts +1 -1
  49. package/types/sap.ui.unified.d.ts +2704 -202
  50. package/types/sap.ui.ux3.d.ts +2379 -181
  51. package/types/sap.ui.vbm.d.ts +2002 -197
  52. package/types/sap.ui.vk.d.ts +5353 -310
  53. package/types/sap.ui.vtm.d.ts +1130 -41
  54. package/types/sap.uiext.inbox.d.ts +423 -22
  55. package/types/sap.ushell.d.ts +1488 -49
  56. package/types/sap.ushell_abap.d.ts +4 -1
  57. package/types/sap.uxap.d.ts +902 -87
  58. package/types/sap.viz.d.ts +5514 -380
  59. package/types/sap.webanalytics.core.d.ts +1 -1
  60. package/types/sap.zen.commons.d.ts +165 -20
  61. package/types/sap.zen.crosstab.d.ts +217 -21
  62. package/types/sap.zen.dsh.d.ts +227 -14
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.101.0
1
+ // For Library Version: 1.102.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ushell {
@@ -60,6 +60,8 @@ declare namespace sap {
60
60
  * @SINCE 1.22.0
61
61
  *
62
62
  * Returns an array with all internal keys of direct items in the container.
63
+ *
64
+ * @returns item keys
63
65
  */
64
66
  _getInternalKeys(): any[];
65
67
  /**
@@ -72,6 +74,8 @@ declare namespace sap {
72
74
  * @SINCE 1.22.0
73
75
  *
74
76
  * Checks if a specific direct item is contained in the container.
77
+ *
78
+ * @returns true if the container contains a direct item with the key
75
79
  */
76
80
  containsItem(
77
81
  /**
@@ -94,18 +98,25 @@ declare namespace sap {
94
98
  * @SINCE 1.22.0
95
99
  *
96
100
  * flush all pending request; The result of the promise may reflect the last pending operation in the queue
101
+ *
102
+ * @returns promise
97
103
  */
98
104
  flush(): object;
99
105
  /**
100
106
  * @SINCE 1.22.0
101
107
  *
102
108
  * Returns an array with the keys of direct items in the container.
109
+ *
110
+ * @returns item keys
103
111
  */
104
112
  getItemKeys(): any[];
105
113
  /**
106
114
  * @SINCE 1.22.0
107
115
  *
108
116
  * Returns the value for a direct item from the container. (Value semantics, new copy is returned)
117
+ *
118
+ * @returns item value (JSON object). In case the container does not contain a direct item with this key
119
+ * `undefined` is returned.
109
120
  */
110
121
  getItemValue(
111
122
  /**
@@ -117,6 +128,8 @@ declare namespace sap {
117
128
  * @SINCE 1.28.0
118
129
  *
119
130
  * return the container key as a string variable
131
+ *
132
+ * @returns the container key
120
133
  */
121
134
  getKey(): string;
122
135
  /**
@@ -124,6 +137,8 @@ declare namespace sap {
124
137
  *
125
138
  * Return an instance unmodifiable container instance. There is one instance of this wrapper per container.
126
139
  * It will permit all read accesses to the container, but block all modifying accesses.
140
+ *
141
+ * @returns unmodifiable wrapper instance
127
142
  */
128
143
  getUnmodifiableContainer(): object;
129
144
  /**
@@ -143,6 +158,8 @@ declare namespace sap {
143
158
  * operation may fail! (wait for the other promise).
144
159
  *
145
160
  * Synchronous read and write operations before the load is done have undefined effects.
161
+ *
162
+ * @returns Promise object
146
163
  */
147
164
  load(): object;
148
165
  /**
@@ -150,6 +167,10 @@ declare namespace sap {
150
167
  *
151
168
  * Attempts to save the current container data at the underlying storage asynchronously. The current state
152
169
  * is serialized.
170
+ *
171
+ * @returns Promise object
172
+ *
173
+ * If another save/load/delete operation is not completed, the operation may fail! (wait for the other promise).
153
174
  */
154
175
  save(): object;
155
176
  /**
@@ -157,6 +178,10 @@ declare namespace sap {
157
178
  *
158
179
  * Save the current container data at the underlying storage asynchronously at the earlies nDelayInMilliseconds
159
180
  * seconds before. The current state is serialized.
181
+ *
182
+ * @returns Promise object
183
+ *
184
+ * The operation may wait for completion of another pending operation.
160
185
  */
161
186
  saveDeferred(): object;
162
187
  /**
@@ -193,6 +218,8 @@ declare namespace sap {
193
218
  * @SINCE 1.18.0
194
219
  *
195
220
  * Checks if a specific item is contained in this variant.
221
+ *
222
+ * @returns true if the variant contains an item with the key
196
223
  */
197
224
  containsItem(
198
225
  /**
@@ -215,12 +242,17 @@ declare namespace sap {
215
242
  * @SINCE 1.22.0
216
243
  *
217
244
  * Returns an array with the keys of all items in this variant.
245
+ *
246
+ * @returns item keys
218
247
  */
219
248
  getItemKeys(): any[];
220
249
  /**
221
250
  * @SINCE 1.18.0
222
251
  *
223
252
  * Returns the value for an item in this variant.
253
+ *
254
+ * @returns item value (JSON object). In case the variant does not contain an item with this key `undefined`
255
+ * is returned.
224
256
  */
225
257
  getItemValue(
226
258
  /**
@@ -232,12 +264,16 @@ declare namespace sap {
232
264
  * @SINCE 1.22.0
233
265
  *
234
266
  * Returns the key of this variant.
267
+ *
268
+ * @returns variant key.
235
269
  */
236
270
  getVariantKey(): string;
237
271
  /**
238
272
  * @SINCE 1.22.0
239
273
  *
240
274
  * Returns the name of this variant.
275
+ *
276
+ * @returns variant name.
241
277
  */
242
278
  getVariantName(): string;
243
279
  /**
@@ -292,6 +328,8 @@ declare namespace sap {
292
328
  *
293
329
  * Creates a new variant in the variant set. In case a variant with this name is already existing an exception
294
330
  * is thrown.
331
+ *
332
+ * @returns {@link sap.ushell.services.PersonalizationContainerVariant}
295
333
  */
296
334
  addVariant(
297
335
  /**
@@ -303,6 +341,8 @@ declare namespace sap {
303
341
  * @SINCE 1.22.0
304
342
  *
305
343
  * Checks if a specific variant is contained in the variant set.
344
+ *
345
+ * @returns true if the variant set contains a variant with the key
306
346
  */
307
347
  containsVariant(
308
348
  /**
@@ -325,12 +365,17 @@ declare namespace sap {
325
365
  * @SINCE 1.22.0
326
366
  *
327
367
  * Returns the current variant key.
368
+ *
369
+ * @returns current variant key. In case the current variant was never set `null` is returned.
328
370
  */
329
371
  getCurrentVariantKey(): string;
330
372
  /**
331
373
  * @SINCE 1.22.0
332
374
  *
333
375
  * Returns a variant object.
376
+ *
377
+ * @returns {@link sap.ushell.services.PersonalizationContainerVariant}. In case the variant set does not
378
+ * contain a variant with this key `undefined` is returned.
334
379
  */
335
380
  getVariant(
336
381
  /**
@@ -342,6 +387,9 @@ declare namespace sap {
342
387
  * @SINCE 1.22.0
343
388
  *
344
389
  * Returns the variant key corresponding to a variant name.
390
+ *
391
+ * @returns variant key. In case the variant set does not contain a variant with this name `undefined` is
392
+ * returned.
345
393
  */
346
394
  getVariantKeyByName(
347
395
  /**
@@ -353,6 +401,8 @@ declare namespace sap {
353
401
  * @SINCE 1.22.0
354
402
  *
355
403
  * Returns an array with the keys of the variants in the variant set.
404
+ *
405
+ * @returns variant keys
356
406
  */
357
407
  getVariantKeys(): any[];
358
408
  /**
@@ -391,6 +441,8 @@ declare namespace sap {
391
441
  *
392
442
  * Creates a new variant set in the container. In case a variant set with this key is already existing an
393
443
  * exception is thrown.
444
+ *
445
+ * @returns {@link ontainerVariantSet}
394
446
  */
395
447
  addVariantSet(
396
448
  /**
@@ -402,6 +454,8 @@ declare namespace sap {
402
454
  * @SINCE 1.18.0
403
455
  *
404
456
  * Checks if a specific variant set is contained in the container.
457
+ *
458
+ * @returns true if the container contains a variant set with the key
405
459
  */
406
460
  containsVariantSet(
407
461
  /**
@@ -424,6 +478,9 @@ declare namespace sap {
424
478
  * @SINCE 1.22.0
425
479
  *
426
480
  * Returns the variant set object from the container.
481
+ *
482
+ * @returns {@link ontainerVariantSet}. In case the container does not contain a variant set with this key
483
+ * `undefined` is returned.
427
484
  */
428
485
  getVariantSet(
429
486
  /**
@@ -435,6 +492,8 @@ declare namespace sap {
435
492
  * @SINCE 1.18.0
436
493
  *
437
494
  * Returns an array with the keys of the variant sets in the container.
495
+ *
496
+ * @returns variant set keys
438
497
  */
439
498
  getVariantSetKeys(): any[];
440
499
  }
@@ -560,6 +619,8 @@ declare namespace sap {
560
619
  *
561
620
  * **Note:** Return value is only valid after app is loaded. See {@link #attachAppLoaded} for details. Before
562
621
  * an app is loaded, `undefined` is returned.
622
+ *
623
+ * @returns Information object about currently running application or `undefined` if no application is running.
563
624
  */
564
625
  getCurrentApplication(): object | undefined;
565
626
  }
@@ -583,6 +644,9 @@ declare namespace sap {
583
644
  * Adds a bookmark tile to one of the user's classic homepage groups or to multiple provided content nodes.
584
645
  * See:
585
646
  * sap.ushell.services.URLParsing#getShellHash
647
+ *
648
+ * @returns A `jQuery.Promise` which resolves on success, but rejects with a reason-message on failure to
649
+ * add the bookmark to the specified or implied group. The promise gets resolved if personalization is disabled.
586
650
  */
587
651
  addBookmark(
588
652
  /**
@@ -644,6 +708,10 @@ declare namespace sap {
644
708
  *
645
709
  * Adds the catalog tile with the given ID to given group. The catalog tile is looked up in the legacy SAP
646
710
  * HANA catalog unless data to look up a remote catalog is provided.
711
+ *
712
+ * @returns A `jQuery.Promise` which informs about success or failure of this asynchronous operation. In
713
+ * case of success, no further details are passed. In case of failure, an error message is passed. In launchpad
714
+ * spaces mode the promise gets rejected.
647
715
  */
648
716
  addCatalogTileToGroup(
649
717
  /**
@@ -676,6 +744,10 @@ declare namespace sap {
676
744
  * pages have not yet been loaded completely!
677
745
  * See:
678
746
  * #addBookmark
747
+ *
748
+ * @returns A `jQuery.Promise` which informs about success or failure of this asynchronous operation. In
749
+ * case of success, the count of existing bookmarks is provided (which might be zero). In case of failure,
750
+ * an error message is passed.
679
751
  */
680
752
  countBookmarks(
681
753
  /**
@@ -690,6 +762,10 @@ declare namespace sap {
690
762
  * See:
691
763
  * #addBookmark
692
764
  * #countBookmarks
765
+ *
766
+ * @returns A `jQuery.Promise` which informs about success or failure of this asynchronous operation. In
767
+ * case of success, the number of deleted bookmarks is provided (which might be zero). In case of failure,
768
+ * an error message is passed.
693
769
  */
694
770
  deleteBookmarks(
695
771
  /**
@@ -718,6 +794,8 @@ declare namespace sap {
718
794
  *
719
795
  * - isContainer: Specifies if a bookmark can be added
720
796
  * - children: Specifies sub-nodes
797
+ *
798
+ * @returns Promise resolving the currently available content nodes.
721
799
  */
722
800
  getContentNodes(): Promise<sap.ushell.services.Bookmark.ContentNode[]>;
723
801
  /**
@@ -729,6 +807,10 @@ declare namespace sap {
729
807
  * #addBookmark
730
808
  * #countBookmarks
731
809
  * #deleteBookmarks
810
+ *
811
+ * @returns A `jQuery.Promise` which informs about success or failure of this asynchronous operation. In
812
+ * case of success, the number of updated bookmarks is provided (which might be zero). In case of failure,
813
+ * an error message is passed.
732
814
  */
733
815
  updateBookmarks(
734
816
  /**
@@ -833,11 +915,15 @@ declare namespace sap {
833
915
  * simply performs a browser back navigation. Please note that the behavior of this method is subject
834
916
  * to change and therefore it may not yield to the expected results especially on mobile devices where "back"
835
917
  * is the previous inner app state iff these are put into the history!
918
+ *
919
+ * @returns A promise which resolves once the back navigation was triggered
836
920
  */
837
921
  backToPreviousApp(): Promise<void>;
838
922
  /**
839
923
  * if sHashFragment is a compacted hash (sap-intent-param is present), in a hash, this function replaces
840
924
  * it into a long url with all parameters expanded
925
+ *
926
+ * @returns promise the success handler of the resolve promise get an expanded shell hash as first argument
841
927
  */
842
928
  expandCompactHash(
843
929
  /**
@@ -849,6 +935,11 @@ declare namespace sap {
849
935
  * @SINCE 1.38.0
850
936
  *
851
937
  * Returns a list of semantic objects of the intents the current user can navigate to.
938
+ *
939
+ * @returns A promise that resolves with an array of strings representing the semantic objects of the intents
940
+ * the current user can navigate to, or rejects with an error message. The returned array will not contain
941
+ * duplicates. NOTE: the caller should not rely on the specific order the semantic objects appear in
942
+ * the returned array.
852
943
  */
853
944
  getDistinctSemanticObjects(): jQuery.Promise;
854
945
  /**
@@ -856,6 +947,52 @@ declare namespace sap {
856
947
  *
857
948
  * Resolves the given semantic object (and action) and business parameters to a list of links available
858
949
  * to the user.
950
+ *
951
+ * @returns A promise that resolves with an array of link objects containing (at least) the following properties:
952
+ *
953
+ * ```javascript
954
+ *
955
+ * {
956
+ * intent: "#AnObject-Action?A=B&C=e&C=j",
957
+ * text: "Perform action",
958
+ * icon: "sap-icon://Fiori2/F0018", // optional
959
+ * subTitle: "Action", //optional
960
+ * shortTitle: "Perform" // optional
961
+ * tags: ["tag-1", "tag-2"] // optional
962
+ * }
963
+ * ```
964
+ *
965
+ *
966
+ * Properties marked as 'optional' in the example above may not be present in the returned result.
967
+ *
968
+ * **NOTE:** the intents returned are in **internal** format and cannot be directly put into a link
969
+ * tag. Example: Let the string `"C&A != H&M"` be a parameter value.
970
+ *
971
+ * Intent will be encoded as`#AnObject-action?text=C%26A%20!%3D%20H%26M. Note that the intent is in
972
+ * **internal** format, before putting it into a link tag, you must invoke: externalHash = oCrossApplicationNavigationService.hrefForExternal({
973
+ * target : { shellHash : oLink.intent} }, that.oComponent); ` NOTE: in case the mass invocation
974
+ * interface is used (see `vArgs` parameter explanation above), the promise will resolve to an array of
975
+ * arrays of arrays. For example, if the mass interface specified two arguments, the promise would resolve
976
+ * as follows:
977
+ * ```javascript
978
+ *
979
+ * [ // mass interface was used, so return multiple values
980
+ * [ // values returned from the first call (functions may return multiple values)
981
+ * // value returned from first getLinks call (as returned by single getLinks call)
982
+ * [
983
+ * {intent: "#SO-something1", text: "Perform navigation"},
984
+ * {intent: "#SO-something2", text: "Perform action"} ],
985
+ * ]
986
+ * ],
987
+ * [
988
+ * // value returned from second getLinks call (as returned by single getLinks call)
989
+ * [
990
+ * {intent: "#Object-someAction", text: "Some action1"}
991
+ * ]
992
+ * ]
993
+ * // ... and so on
994
+ * ]
995
+ * ```
859
996
  */
860
997
  getLinks(
861
998
  /**
@@ -963,6 +1100,20 @@ declare namespace sap {
963
1100
  * The primary intent is determined by querying {@link sap.ushell.services.CrossApplicationNavigation#getLinks}
964
1101
  * with the given semantic object and optional parameter. Then the resulting list is filtered to the outcome
965
1102
  * that a single item remains.
1103
+ *
1104
+ * @returns When a relevant link object exists, it will return a promise that resolves to an object of the
1105
+ * following form:
1106
+ * ```javascript
1107
+ *
1108
+ * {
1109
+ * intent: "#AnObject-Action?A=B&C=e&C=j",
1110
+ * text: "Perform action",
1111
+ * icon: "sap-icon://Fiori2/F0018", // optional
1112
+ * shortTitle: "Perform" // optional
1113
+ * tags: ["tag-1", "tag-2"] // optional
1114
+ * }
1115
+ * ```
1116
+ * Otherwise, the returned promise will resolve to null when no relevant link object exists.
966
1117
  */
967
1118
  getPrimaryIntent(
968
1119
  /**
@@ -980,6 +1131,26 @@ declare namespace sap {
980
1131
  *
981
1132
  * Resolves a given semantic object and business parameters to a list of links, taking into account the
982
1133
  * form factor of the current device.
1134
+ *
1135
+ * @returns A `jQuery.Deferred` object's promise which is resolved with an array of link objects containing
1136
+ * (at least) the following properties:
1137
+ * ```javascript
1138
+ *
1139
+ * {
1140
+ * intent: "#AnObject-action?A=B&C=e",
1141
+ * text: "Perform action",
1142
+ * icon: "sap-icon://Fiori2/F0018", //optional
1143
+ * subTitle: "Action", //optional
1144
+ * shortTitle: "Perform" //optional
1145
+ * }
1146
+ * ```
1147
+ *
1148
+ *
1149
+ * **NOTE:** the intents returned are in **internal** format and cannot be directly put into a link tag.
1150
+ * 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.
1151
+ * Note that the intent is in **internal** format, before putting it into a link tag, you must invoke:
1152
+ * externalHash = oCrossApplicationNavigationService.hrefForExternal({ target : { shellHash : oLink.intent}
1153
+ * }, that.oComponent); `
983
1154
  */
984
1155
  getSemanticObjectLinks(
985
1156
  /**
@@ -1034,6 +1205,9 @@ declare namespace sap {
1034
1205
  * Example: `hrefForAppSpecificHash("View1/details/0/")` returns `#SemanticObject-action&/View1/details/0/`
1035
1206
  * if the current application runs in the shell and was started using "SemanticObject-action" as shell navigation
1036
1207
  * hash
1208
+ *
1209
+ * @returns A string which can be put into the link tag, containing the current shell navigation target
1210
+ * and the specified application specific hash suffix
1037
1211
  */
1038
1212
  hrefForAppSpecificHash(
1039
1213
  /**
@@ -1051,6 +1225,9 @@ declare namespace sap {
1051
1225
  * Example: `hrefForAppSpecificHashAsync("View1/details/0/")` returns a Promise that resolves: `#SemanticObject-action&/View1/details/0/`
1052
1226
  * if the current application runs in the shell and was started using "SemanticObject-action" as shell navigation
1053
1227
  * hash
1228
+ *
1229
+ * @returns A promise which resolves a string which can be put into the link tag, containing the current
1230
+ * shell navigation target and the specified application specific hash suffix
1054
1231
  */
1055
1232
  hrefForAppSpecificHashAsync(
1056
1233
  /**
@@ -1066,6 +1243,45 @@ declare namespace sap {
1066
1243
  *
1067
1244
  * Returns a string which can be put into the DOM (e.g. in a link tag). **Note:** The generated url / url
1068
1245
  * segment must not be used as `shellHash` in the target definition of {@link sap.ushell.services.CrossApplicationNavigation#toExternal}
1246
+ *
1247
+ * @returns the href for the specified parameters as an external shell hash; always starting with a hash
1248
+ * character; all parameters and parameter names are URL-encoded (via encodeURIComponent) and the complete
1249
+ * string is encoded via encodeURI (!). The generated string can not be used in the majority of interfaces
1250
+ * which expect a internal shell hash.
1251
+ *
1252
+ * A proper way for an application to generate a link to return to the home page of the Fiori launchpad
1253
+ * is: `hrefForExternal( { target : { shellHash : "#" }})`
1254
+ *
1255
+ * Do not use "#Shell-home" to navigate to a specific homepage!
1256
+ *
1257
+ * Note: if object is undefined, the current shell hash is returned.
1258
+ *
1259
+ * Note that the application parameter length (including SemanticObject/Action) shall not exceed 512 bytes
1260
+ * when serialized as UTF-8.
1261
+ *
1262
+ * The function can be used to convert an shell hash internal format commonly encountered into the URL format
1263
+ * to use in link tags:
1264
+ * ```javascript
1265
+ *
1266
+ * externalHash = oCrossApplicationNavigationService.hrefForExternal({
1267
+ * target: { shellHash: oLink.intent }
1268
+ * }, that.oComponent);
1269
+ * ```
1270
+ *
1271
+ *
1272
+ * Since version 1.56 this API accepts a sap-xapp-state-data parameter that can be used generate a url that
1273
+ * can be used to launch and application with certain data, for example:
1274
+ * ```javascript
1275
+ *
1276
+ * {
1277
+ * target : { semanticObject : "AnObject", action: "action" },
1278
+ * params : { "sap-xapp-state-data" : JSON.stringify({ a: "b", c: "d" }) }
1279
+ * }
1280
+ * ```
1281
+ *
1282
+ *
1283
+ * Using the arguments as in the example above, a link with a sap-xapp-state parameter that encodes the
1284
+ * provided data is returned. The sap-xapp-state-data parameter does not appear in the generated link.
1069
1285
  */
1070
1286
  hrefForExternal(
1071
1287
  /**
@@ -1113,6 +1329,45 @@ declare namespace sap {
1113
1329
  *
1114
1330
  * Returns a string which can be put into the DOM (e.g. in a link tag). **Note:** The generated url / url
1115
1331
  * segment must not be used as `shellHash` in the target definition of {@link sap.ushell.services.CrossApplicationNavigation#toExternal}
1332
+ *
1333
+ * @returns the href for the specified parameters as an external shell hash; always starting with a hash
1334
+ * character; all parameters and parameter names are URL-encoded (via encodeURIComponent) and the complete
1335
+ * string is encoded via encodeURI (!). The generated string can not be used in the majority of interfaces
1336
+ * which expect a internal shell hash.
1337
+ *
1338
+ * A proper way for an application to generate a link to return to the home page of the Fiori launchpad
1339
+ * is: `hrefForExternal( { target : { shellHash : "#" }})`
1340
+ *
1341
+ * Do not use "#Shell-home" to navigate to a specific homepage!
1342
+ *
1343
+ * Note: if object is undefined, the current shell hash is returned.
1344
+ *
1345
+ * Note that the application parameter length (including SemanticObject/Action) shall not exceed 512 bytes
1346
+ * when serialized as UTF-8.
1347
+ *
1348
+ * The function can be used to convert an shell hash internal format commonly encountered into the URL format
1349
+ * to use in link tags:
1350
+ * ```javascript
1351
+ *
1352
+ * externalHash = oCrossApplicationNavigationService.hrefForExternal({
1353
+ * target: { shellHash: oLink.intent }
1354
+ * }, that.oComponent);
1355
+ * ```
1356
+ *
1357
+ *
1358
+ * Since version 1.56 this API accepts a sap-xapp-state-data parameter that can be used generate a url that
1359
+ * can be used to launch and application with certain data, for example:
1360
+ * ```javascript
1361
+ *
1362
+ * {
1363
+ * target : { semanticObject : "AnObject", action: "action" },
1364
+ * params : { "sap-xapp-state-data" : JSON.stringify({ a: "b", c: "d" }) }
1365
+ * }
1366
+ * ```
1367
+ *
1368
+ *
1369
+ * Using the arguments as in the example above, a link with a sap-xapp-state parameter that encodes the
1370
+ * provided data is returned. The sap-xapp-state-data parameter does not appear in the generated link.
1116
1371
  */
1117
1372
  hrefForExternal(
1118
1373
  /**
@@ -1153,6 +1408,35 @@ declare namespace sap {
1153
1408
  * @SINCE 1.94.0
1154
1409
  *
1155
1410
  * Returns a Promise which resolves a string. That string can be put into the DOM (e.g. in a link tag)
1411
+ *
1412
+ * @returns A Promise which resolves href for the specified parameters as an *external* shell hash; always
1413
+ * starting with a hash character; all parameters and parameter names are URL-encoded (via encodeURIComponent)
1414
+ * and the complete string is encoded via encodeURI (!). The generated string can not be used in the majority
1415
+ * of interfaces which expect a internal shell hash.
1416
+ *
1417
+ * A proper way for an application to generate a link to return to the home page of the Fiori launchpad
1418
+ * is: `hrefForExternalAsync( { target : { shellHash : "#" }})`
1419
+ *
1420
+ * Do *not* use "#Shell-home" to navigate to a specific homepage!
1421
+ *
1422
+ * Note: if object is undefined, the current shell hash is returned.
1423
+ *
1424
+ * Note that the application parameter length (including SemanticObject/Action) shall not exceed 512 bytes
1425
+ * when serialized as UTF-8.
1426
+ *
1427
+ * The function can be used to convert an shell hash internal format commonly encountered into the URL format
1428
+ * to use in link tags: ` sap.ushell.Container.getServiceAsync("CrossApplicationNavigation").then( function
1429
+ * (oService) { oService.hrefForExternalAsync({ target: { shellHash: oLink.intent } }, that.oComponent).then(
1430
+ * function (sExternalHref) { // do something with the resolved sExternalHref. }); }); `
1431
+ *
1432
+ * This API accepts a sap-xapp-state-data parameter that can be used generate a url that can be used to
1433
+ * launch and application with certain data, for example:
1434
+ *
1435
+ * ` { target : { semanticObject : "AnObject", action: "action" }, params : { "sap-xapp-state-data" : JSON.stringify({
1436
+ * a: "b", c: "d" }) } } `
1437
+ *
1438
+ * Using the arguments as in the example above, a link with a sap-xapp-state parameter that encodes the
1439
+ * provided data is returned. The sap-xapp-state-data parameter does not appear in the generated link.
1156
1440
  */
1157
1441
  hrefForExternalAsync(
1158
1442
  /**
@@ -1174,6 +1458,8 @@ declare namespace sap {
1174
1458
  * Checks whether the FLP has performed the first navigation. This method can be used to detect whether
1175
1459
  * the current app was started directly, that is, without a previous navigation to another app, to the FLP
1176
1460
  * home, or another target that adds an entry in the browser history.
1461
+ *
1462
+ * @returns Whether the initial navigation occurred.
1177
1463
  */
1178
1464
  isInitialNavigation(): boolean;
1179
1465
  /**
@@ -1182,6 +1468,8 @@ declare namespace sap {
1182
1468
  * Checks whether the FLP has performed the first navigation. This method can be used to detect whether
1183
1469
  * the current app was started directly, that is, without a previous navigation to another app, to the FLP
1184
1470
  * home, or another target that adds an entry in the browser history.
1471
+ *
1472
+ * @returns This promise resolves with a boolean indicating if the current navigation is considered initial
1185
1473
  */
1186
1474
  isInitialNavigationAsync(): Promise<boolean>;
1187
1475
  /**
@@ -1191,6 +1479,22 @@ declare namespace sap {
1191
1479
  * Tells whether the given intent(s) are supported, taking into account the form factor of the current device.
1192
1480
  * "Supported" means that navigation to the intent is possible. Note that the intents are assumed to be
1193
1481
  * in internal format and expanded.
1482
+ *
1483
+ * @returns A `jQuery.Deferred` object's promise which is resolved with a map containing the intents from
1484
+ * `aIntents` as keys. The map values are objects with a property `supported` of type `boolean`.
1485
+ * Example:
1486
+ * ```javascript
1487
+ *
1488
+ * {
1489
+ * "#AnObject-action?A=B&c=e": { supported: false },
1490
+ * "#AnotherObject-action2": { supported: true }
1491
+ * }
1492
+ * ```
1493
+ *
1494
+ *
1495
+ * Example usage: ` this.oCrossAppNav.isIntentSupported(["SalesOrder-approve?SOId=1234"]) .done(function(aResponses)
1496
+ * { if (oResponse["SalesOrder-approve?SOId=1234"].supported===true){ // enable link } else { // disable
1497
+ * link } }) .fail(function() { // disable link // request failed or other error }); `
1194
1498
  */
1195
1499
  isIntentSupported(
1196
1500
  /**
@@ -1212,6 +1516,46 @@ declare namespace sap {
1212
1516
  * {@link sap.ushell.services.CrossApplicationNavigation#hrefForExternal}. It is functionally equivalent
1213
1517
  * to {@link sap.ushell.services.CrossApplicationNavigation#isIntentSupported} but accepts the same interface
1214
1518
  * as {@link sap.ushell.services.CrossApplicationNavigation#toExternal}/ {@link sap.ushell.services.CrossApplicationNavigation#hrefForExternal}.
1519
+ *
1520
+ * @returns A `jQuery.Deferred` object's promise which is resolved with an array (!) of objects representing
1521
+ * whether the intent is supported or not objects with a property `supported` of type `boolean`.
1522
+ * representing Example:
1523
+ *
1524
+ * aIntents:
1525
+ * ```javascript
1526
+ *
1527
+ * [
1528
+ * {
1529
+ * target : {
1530
+ * semanticObject : "AnObject",
1531
+ * action: "action"
1532
+ * },
1533
+ * params : { P1 : "B", P2 : [ "V2a", "V2b"] }
1534
+ * },
1535
+ * {
1536
+ * target : {
1537
+ * semanticObject : "SalesOrder",
1538
+ * action: "display"
1539
+ * },
1540
+ * params : { P3 : "B", SalesOrderIds : [ "4711", "472"] }
1541
+ * }
1542
+ * ]
1543
+ * ```
1544
+ *
1545
+ *
1546
+ * response: [Indices correspond]
1547
+ * ```javascript
1548
+ *
1549
+ * [
1550
+ * { supported: false },
1551
+ * { supported: true }
1552
+ * ]
1553
+ * ```
1554
+ *
1555
+ *
1556
+ * Example usage: ` this.oCrossAppNav.isNavigationSupported([ ]) .done(function(aResponses) { if (oResponse[0].supported===true){
1557
+ * // enable link } else { // disable link } }) .fail(function() { // disable link // request failed or
1558
+ * other fatal error }); `
1215
1559
  */
1216
1560
  isNavigationSupported(
1217
1561
  /**
@@ -1232,6 +1576,8 @@ declare namespace sap {
1232
1576
  * This function gets the hash part of the URL and returns the URL of the target application.
1233
1577
  *
1234
1578
  * This is an asynchronous operation.
1579
+ *
1580
+ * @returns A jQuery.Promise.
1235
1581
  */
1236
1582
  resolveIntent(
1237
1583
  /**
@@ -1247,6 +1593,9 @@ declare namespace sap {
1247
1593
  * launchpad application). Invocation will trigger a hash change and subsequent invocation of the target.
1248
1594
  *
1249
1595
  * If the navigation target opens in a new window the running application may be retained.
1596
+ *
1597
+ * @returns A `Promise` which resolves once the navigation was triggered. The `Promise` might never reject
1598
+ * or resolve when an error occurs during the navigation.
1250
1599
  */
1251
1600
  toExternal(
1252
1601
  /**
@@ -1370,6 +1719,9 @@ declare namespace sap {
1370
1719
  /**
1371
1720
  * @SINCE 1.25.1
1372
1721
  * @deprecated (since 1.93)
1722
+ *
1723
+ *
1724
+ * @returns Empty string
1373
1725
  */
1374
1726
  getLegalText(): string;
1375
1727
  /**
@@ -1377,6 +1729,8 @@ declare namespace sap {
1377
1729
  * @deprecated (since 1.93)
1378
1730
  *
1379
1731
  * The service is deprecated. The function always returns a negative answer.
1732
+ *
1733
+ * @returns Rejected promise
1380
1734
  */
1381
1735
  isEnabled(): Object;
1382
1736
  /**
@@ -1384,6 +1738,8 @@ declare namespace sap {
1384
1738
  * @deprecated (since 1.93)
1385
1739
  *
1386
1740
  * Sends a feedback.
1741
+ *
1742
+ * @returns Empty promise
1387
1743
  */
1388
1744
  sendFeedback(): Promise<any>;
1389
1745
  }
@@ -1427,6 +1783,8 @@ declare namespace sap {
1427
1783
  *
1428
1784
  * In case of failure, the `fail` function returns the consistent (i.e. persisted) backend state of all
1429
1785
  * groups.
1786
+ *
1787
+ * @returns jQuery.promise object
1430
1788
  */
1431
1789
  addGroup(
1432
1790
  /**
@@ -1442,6 +1800,8 @@ declare namespace sap {
1442
1800
  *
1443
1801
  * In case of failure, the `fail` function returns the consistent (i.e. persisted) backend state of all
1444
1802
  * groups.
1803
+ *
1804
+ * @returns jQuery.promise object
1445
1805
  */
1446
1806
  addGroupAt(
1447
1807
  /**
@@ -1461,6 +1821,8 @@ declare namespace sap {
1461
1821
  * In case of success, the `done` function returns the new tile. Intention: the page builder by default
1462
1822
  * puts this tile at the end of the default group. In case of failure, the `fail` function should return
1463
1823
  * the consistent (i.e. persisted) backend state of the default group.
1824
+ *
1825
+ * @returns jQuery.promise object
1464
1826
  */
1465
1827
  addTile(
1466
1828
  /**
@@ -1474,6 +1836,8 @@ declare namespace sap {
1474
1836
  ): object;
1475
1837
  /**
1476
1838
  * Returns the press handler for clicking on a tile.
1839
+ *
1840
+ * @returns handler for clicking on the tile.
1477
1841
  */
1478
1842
  getAppBoxPressHandler(
1479
1843
  /**
@@ -1485,6 +1849,12 @@ declare namespace sap {
1485
1849
  * @SINCE 1.21.2
1486
1850
  *
1487
1851
  * Returns catalog's technical data.
1852
+ *
1853
+ * @returns An object that includes the following properties (the list may include additional properties):
1854
+ *
1855
+ * `id`: the catalog ID `systemId`: [remote catalogs] the ID of the remote system `remoteId`: [remote
1856
+ * catalogs] the ID of the catalog in the remote system `baseUrl`: [remote catalogs] the base URL of
1857
+ * the catalog in the remote system
1488
1858
  */
1489
1859
  getCatalogData(
1490
1860
  /**
@@ -1497,6 +1867,8 @@ declare namespace sap {
1497
1867
  *
1498
1868
  * Returns the catalog's technical error message in case it could not be loaded from the backend. **Beware:**
1499
1869
  * The technical error message is not translated!
1870
+ *
1871
+ * @returns The technical error message or `undefined` if the catalog was loaded properly
1500
1872
  */
1501
1873
  getCatalogError(
1502
1874
  /**
@@ -1506,6 +1878,8 @@ declare namespace sap {
1506
1878
  ): string;
1507
1879
  /**
1508
1880
  * Returns the catalog's unique identifier
1881
+ *
1882
+ * @returns Catalog id
1509
1883
  */
1510
1884
  getCatalogId(
1511
1885
  /**
@@ -1519,12 +1893,18 @@ declare namespace sap {
1519
1893
  * of title). Use {@link getCatalogError} to check if a (remote) catalog could not be loaded from the backend.
1520
1894
  * Progress notifications are sent for each single catalog, i.e. attaching a `progress` handler gives
1521
1895
  * you the same possibilities as attaching a `done` handler, but with the advantage of improved responsiveness.
1896
+ *
1897
+ * @returns `jQuery.Deferred` object's promise In case of success, an array of black-box catalog objects
1898
+ * is provided (which might be empty). In case of failure, an error message is passed. Progress notifications
1899
+ * are sent for each single catalog, providing a single black-box catalog object each time.
1522
1900
  */
1523
1901
  getCatalogs(): object;
1524
1902
  /**
1525
1903
  * Returns catalog tile's unique identifier. This function may be called for a catalog tile or (since 1.21.0)
1526
1904
  * for a group tile. In the latter case, the function returns the unique identifier of the catalog tile
1527
1905
  * on which the group tile is based.
1906
+ *
1907
+ * @returns Tile id
1528
1908
  */
1529
1909
  getCatalogTileId(
1530
1910
  /**
@@ -1536,6 +1916,8 @@ declare namespace sap {
1536
1916
  * Returns the keywords associated with a catalog tile which can be used to find the catalog tile in a search.
1537
1917
  * Note: getCatalogTileViewControl **must** be called **before** this method. Otherwise the keywords may
1538
1918
  * be incomplete.
1919
+ *
1920
+ * @returns The keywords associated with this catalog tile
1539
1921
  */
1540
1922
  getCatalogTileKeywords(
1541
1923
  /**
@@ -1547,6 +1929,9 @@ declare namespace sap {
1547
1929
  * @SINCE 1.16.3
1548
1930
  *
1549
1931
  * Returns preview icon for a catalog tile.
1932
+ *
1933
+ * @returns Preview icon as URL/URI for the catalog tile's underlying application as provided via the "preview"
1934
+ * contract
1550
1935
  */
1551
1936
  getCatalogTilePreviewIcon(
1552
1937
  /**
@@ -1558,6 +1943,9 @@ declare namespace sap {
1558
1943
  * @SINCE 1.40
1559
1944
  *
1560
1945
  * Returns preview subtitle for a catalog tile.
1946
+ *
1947
+ * @returns Preview subtitle for the catalog tile's underlying application as provided via the "preview"
1948
+ * contract
1561
1949
  */
1562
1950
  getCatalogTilePreviewSubtitle(
1563
1951
  /**
@@ -1569,6 +1957,8 @@ declare namespace sap {
1569
1957
  * @SINCE 1.16.3
1570
1958
  *
1571
1959
  * Returns preview title for a catalog tile.
1960
+ *
1961
+ * @returns Preview title for the catalog tile's underlying application as provided via the "preview" contract
1572
1962
  */
1573
1963
  getCatalogTilePreviewTitle(
1574
1964
  /**
@@ -1579,6 +1969,8 @@ declare namespace sap {
1579
1969
  /**
1580
1970
  * Returns the tiles of a catalog. In case of success, the `done` function of the returned promise object
1581
1971
  * gets an array of 'anonymous' tiles of the catalog.
1972
+ *
1973
+ * @returns jQuery.promise object.
1582
1974
  */
1583
1975
  getCatalogTiles(
1584
1976
  /**
@@ -1588,6 +1980,8 @@ declare namespace sap {
1588
1980
  ): object;
1589
1981
  /**
1590
1982
  * Returns the size of a catalog tile as a string. For example: "1x1", "1x2"
1983
+ *
1984
+ * @returns Tile size in units in 1x1 or 1x2 format
1591
1985
  */
1592
1986
  getCatalogTileSize(
1593
1987
  /**
@@ -1597,6 +1991,8 @@ declare namespace sap {
1597
1991
  ): string;
1598
1992
  /**
1599
1993
  * Returns the tags associated with a catalog tile which can be used to find the catalog tile in a tag filter.
1994
+ *
1995
+ * @returns The tags associated with this catalog tile
1600
1996
  */
1601
1997
  getCatalogTileTags(
1602
1998
  /**
@@ -1606,6 +2002,8 @@ declare namespace sap {
1606
2002
  ): string[];
1607
2003
  /**
1608
2004
  * Returns the navigation target URL of a catalog tile.
2005
+ *
2006
+ * @returns The target URL for the catalog tile's underlying application as provided via the "preview" contract
1609
2007
  */
1610
2008
  getCatalogTileTargetURL(
1611
2009
  /**
@@ -1617,6 +2015,8 @@ declare namespace sap {
1617
2015
  * @SINCE 1.67.0
1618
2016
  *
1619
2017
  * Returns the catalog tile info
2018
+ *
2019
+ * @returns The catalog tile info
1620
2020
  */
1621
2021
  getCatalogTileTitle(
1622
2022
  /**
@@ -1629,6 +2029,8 @@ declare namespace sap {
1629
2029
  * requests). Use `getCatalogTileViewControl` instead
1630
2030
  *
1631
2031
  * Returns the UI5 view or control of a catalog tile
2032
+ *
2033
+ * @returns UI5 view or control
1632
2034
  */
1633
2035
  getCatalogTileView(
1634
2036
  /**
@@ -1638,6 +2040,8 @@ declare namespace sap {
1638
2040
  ): object;
1639
2041
  /**
1640
2042
  * Returns the UI5 view or control of a catalog tile
2043
+ *
2044
+ * @returns jQuery.deferred.promise object that when resolved, returns the Catalog Tile View
1641
2045
  */
1642
2046
  getCatalogTileViewControl(
1643
2047
  /**
@@ -1647,6 +2051,8 @@ declare namespace sap {
1647
2051
  ): object;
1648
2052
  /**
1649
2053
  * Returns the catalog's title
2054
+ *
2055
+ * @returns Catalog title
1650
2056
  */
1651
2057
  getCatalogTitle(
1652
2058
  /**
@@ -1657,10 +2063,14 @@ declare namespace sap {
1657
2063
  /**
1658
2064
  * Returns the default group of the user. In case of success, the `done` function gets an 'anonymous' object
1659
2065
  * representing the default group.
2066
+ *
2067
+ * @returns jQuery.promise object.
1660
2068
  */
1661
2069
  getDefaultGroup(): object;
1662
2070
  /**
1663
2071
  * Returns the unique identifier of the given group
2072
+ *
2073
+ * @returns Group id
1664
2074
  */
1665
2075
  getGroupId(
1666
2076
  /**
@@ -1673,11 +2083,15 @@ declare namespace sap {
1673
2083
  *
1674
2084
  * Returns the groups of the user. In case of success, the `done` function gets an array of 'anonymous'
1675
2085
  * groups. The order of the array is the order in which the groups will be displayed to the user.
2086
+ *
2087
+ * @returns A promise that resolves to the list of groups
1676
2088
  */
1677
2089
  getGroups(): Promise<object>;
1678
2090
  /**
1679
2091
  * Returns an array of 'anonymous' tiles of a group. The order of the array is the order of tiles that will
1680
2092
  * be displayed to the user.
2093
+ *
2094
+ * @returns The group tiles array
1681
2095
  */
1682
2096
  getGroupTiles(
1683
2097
  /**
@@ -1687,6 +2101,8 @@ declare namespace sap {
1687
2101
  ): any[];
1688
2102
  /**
1689
2103
  * Returns the title of the given group.
2104
+ *
2105
+ * @returns group title
1690
2106
  */
1691
2107
  getGroupTitle(
1692
2108
  /**
@@ -1697,6 +2113,8 @@ declare namespace sap {
1697
2113
  /**
1698
2114
  * Returns an array of link tiles for a group. The order of the array is the order in which the links will
1699
2115
  * be displayed to the user.
2116
+ *
2117
+ * @returns The array of link tiles
1700
2118
  */
1701
2119
  getLinkTiles(
1702
2120
  /**
@@ -1706,6 +2124,8 @@ declare namespace sap {
1706
2124
  ): any[];
1707
2125
  /**
1708
2126
  * Returns the tile's unique identifier
2127
+ *
2128
+ * @returns Tile id
1709
2129
  */
1710
2130
  getTileId(
1711
2131
  /**
@@ -1715,6 +2135,8 @@ declare namespace sap {
1715
2135
  ): string;
1716
2136
  /**
1717
2137
  * Returns the tile size in the format of 1x1 or 1x2 string
2138
+ *
2139
+ * @returns tile size in units in 1x1 format
1718
2140
  */
1719
2141
  getTileSize(
1720
2142
  /**
@@ -1727,6 +2149,8 @@ declare namespace sap {
1727
2149
  *
1728
2150
  * The navigation target string is used (when assigned to `location.hash`) for performing a navigation action
1729
2151
  * that eventually opens the application represented by the tile.
2152
+ *
2153
+ * @returns the tile target
1730
2154
  */
1731
2155
  getTileTarget(
1732
2156
  /**
@@ -1736,6 +2160,8 @@ declare namespace sap {
1736
2160
  ): string;
1737
2161
  /**
1738
2162
  * Returns the tile's title.
2163
+ *
2164
+ * @returns The title
1739
2165
  */
1740
2166
  getTileTitle(
1741
2167
  /**
@@ -1745,6 +2171,8 @@ declare namespace sap {
1745
2171
  ): string;
1746
2172
  /**
1747
2173
  * Returns the tile's type.
2174
+ *
2175
+ * @returns The type
1748
2176
  */
1749
2177
  getTileType(
1750
2178
  /**
@@ -1755,6 +2183,8 @@ declare namespace sap {
1755
2183
  /**
1756
2184
  * Returns UI5 view or control of the tile. In case of success the `done` function should return UI5 view
1757
2185
  * or control of the tile. In case of failure the `fail` function should return nothing.
2186
+ *
2187
+ * @returns jQuery.promise object
1758
2188
  */
1759
2189
  getTileView(
1760
2190
  /**
@@ -1772,12 +2202,17 @@ declare namespace sap {
1772
2202
  * to catalog" scenario).
1773
2203
  * See:
1774
2204
  * #getCatalogs
2205
+ *
2206
+ * @returns `true` in case the catalogs are still valid; `false` if not
1775
2207
  */
1776
2208
  isCatalogsValid(): boolean;
1777
2209
  /**
1778
2210
  * Checks if a group was marked as featured (meaning the group is a Fiori 3 featured group).
1779
2211
  *
1780
2212
  * Returns `true` if the group is featured and `false` if not.
2213
+ *
2214
+ * @returns `true` if featured; `false` if not (or as default in case the function was not implemented in
2215
+ * the proper adapter).
1781
2216
  */
1782
2217
  isGroupFeatured(
1783
2218
  /**
@@ -1790,6 +2225,9 @@ declare namespace sap {
1790
2225
  * such as Rename, Drag&Drop...).
1791
2226
  *
1792
2227
  * Returns `true` if the group is locked and `false` if not.
2228
+ *
2229
+ * @returns `true` if locked; `false` if not (or as default in case the function was not implemented in
2230
+ * the proper adapter).
1793
2231
  */
1794
2232
  isGroupLocked(
1795
2233
  /**
@@ -1802,6 +2240,8 @@ declare namespace sap {
1802
2240
  *
1803
2241
  * Returns `true` if the group can be removed (i.e. if the given group was created by the user) and `false`
1804
2242
  * if the group can only be reset.
2243
+ *
2244
+ * @returns `true` if removable; `false` if resettable
1805
2245
  */
1806
2246
  isGroupRemovable(
1807
2247
  /**
@@ -1815,6 +2255,8 @@ declare namespace sap {
1815
2255
  * In case of success, the `done` function is called without any value. Intention: the page builder already
1816
2256
  * moved the page (visible to the user) and if successful - nothing needs to be done. In case of failure,
1817
2257
  * the `fail` function returns the consistent (i.e. persisted) backend state of all groups.
2258
+ *
2259
+ * @returns jQuery.promise object
1818
2260
  */
1819
2261
  moveGroup(
1820
2262
  /**
@@ -1836,6 +2278,8 @@ declare namespace sap {
1836
2278
  * source group and the target group. The result is in the following format {source:[{},{}], target:[{},{}]}.
1837
2279
  *
1838
2280
  * The source and the target groups tiles are in the form of the @see sap.ushell.services.LaunchPage.getGroupTiles
2281
+ *
2282
+ * @returns jQuery.promise object
1839
2283
  */
1840
2284
  moveTile(
1841
2285
  /**
@@ -1908,6 +2352,8 @@ declare namespace sap {
1908
2352
  *
1909
2353
  * In case of failure, the `fail` function returns the consistent (i.e. persisted) backend state of all
1910
2354
  * groups.
2355
+ *
2356
+ * @returns jQuery.promise object
1911
2357
  */
1912
2358
  removeGroup(
1913
2359
  /**
@@ -1927,6 +2373,8 @@ declare namespace sap {
1927
2373
  *
1928
2374
  * In case of failure, the `fail` function should return the consistent (i.e. persisted) backend state of
1929
2375
  * the group.
2376
+ *
2377
+ * @returns jQuery.promise object
1930
2378
  */
1931
2379
  removeTile(
1932
2380
  /**
@@ -1954,6 +2402,8 @@ declare namespace sap {
1954
2402
  * In case of failure, or when the given group was created by the user (i.e. can't be reset)- `fail` handler
1955
2403
  * is called, returning the consistent (i.e. persisted) backend state of all groups. The returned group
1956
2404
  * object is the same as the one returned by @see sap.ushell.services.LaunchPage.getGroups
2405
+ *
2406
+ * @returns jQuery.promise object
1957
2407
  */
1958
2408
  resetGroup(
1959
2409
  /**
@@ -1972,6 +2422,8 @@ declare namespace sap {
1972
2422
  * and if successful nothing needs to be done, as the title is already visible to the user. In case of failure,
1973
2423
  * the `fail` function returns the consistent (i.e. persisted) backend state of the group title, in most
1974
2424
  * cases the old title.
2425
+ *
2426
+ * @returns jQuery.promise object
1975
2427
  */
1976
2428
  setGroupTitle(
1977
2429
  /**
@@ -2070,6 +2522,8 @@ declare namespace sap {
2070
2522
  * Shows an error message with details on the screen. If more than one control should be shown, an {sap.m.VBox}
2071
2523
  * can be used. The default title is "error". If no custom buttons are given, an emphasized "close" button
2072
2524
  * is shown.
2525
+ *
2526
+ * @returns The error dialog, so it can be destroyed by a custom button
2073
2527
  */
2074
2528
  errorWithDetails(
2075
2529
  /**
@@ -2136,6 +2590,8 @@ declare namespace sap {
2136
2590
  * This function gets the hash part of the URL and expands a sap-intent-param if present and retrievable
2137
2591
  *
2138
2592
  * This is an asynchronous operation.
2593
+ *
2594
+ * @returns A jQuery.Promise. Its `done()` function gets an expanded shell hash (in internal format)
2139
2595
  */
2140
2596
  expandCompactHash(
2141
2597
  /**
@@ -2152,6 +2608,51 @@ declare namespace sap {
2152
2608
  *
2153
2609
  * This is effectively a test function for {@link toExternal}/ {@link hrefForExternal}. It is functionally
2154
2610
  * equivalent to {@link isIntentSupported} but accepts the same input as {@link toExternal}/ {@link hrefForExternal}.
2611
+ *
2612
+ * @returns A `jQuery.Deferred` object's promise which is resolved with an array (!) of objects representing
2613
+ * whether the intent is supported or not objects with a property `supported` of type `boolean`.
2614
+ * Example:
2615
+ *
2616
+ * aIntents: an array of parameterized (parsed) Intent objects, in the corresponding structure to arguments
2617
+ * to {@link sap.ushell.services.CrossApplicationNavigation.toExternal}, {@link sap.ushell.services.CrossApplicationNavigation.hrefForExternal}
2618
+ *
2619
+ * ```javascript
2620
+ *
2621
+ * [
2622
+ * {
2623
+ * target : {
2624
+ * semanticObject : "AnObject",
2625
+ * action: "action"
2626
+ * },
2627
+ * params : { P1 : "B", P2 : [ "V2a", "V2b"] }
2628
+ * },
2629
+ * {
2630
+ * target : {
2631
+ * semanticObject : "SalesOrder",
2632
+ * action: "display"
2633
+ * },
2634
+ * params : { P3 : "B", SalesOrderIds : [ "4711", "472"] }
2635
+ * }
2636
+ * ]
2637
+ * ```
2638
+ *
2639
+ *
2640
+ * The following formats are also supported as input to ease migration of existing code: `[ "#AnObject-action?P1=B&SalesOrderIds=4711&SalesOrderIds=472"
2641
+ * ]`
2642
+ *
2643
+ * response:
2644
+ * ```javascript
2645
+ *
2646
+ * [
2647
+ * { supported: false },
2648
+ * { supported: true }
2649
+ * ]
2650
+ * ```
2651
+ *
2652
+ *
2653
+ * Example usage: ` this.oCrossAppNav.isNavigationSupported([ ]) .done(function(aResponses) { if (oResponse[0].supported===true){
2654
+ * // enable link } else { // disable link } }) .fail(function() { // disable link // request failed or
2655
+ * other fatal error }); `
2155
2656
  */
2156
2657
  isNavigationSupported(
2157
2658
  /**
@@ -2183,6 +2684,23 @@ declare namespace sap {
2183
2684
  *
2184
2685
  *
2185
2686
  * This is an asynchronous operation.
2687
+ *
2688
+ * @returns A jQuery.Promise. Its `done()` function gets an object that you can use to create a {@link sap.ushell.components.container.ApplicationContainer}
2689
+ * or `undefined` in case the hash fragment was empty. Typically it contains the following information:
2690
+ *
2691
+ * ```javascript
2692
+ *
2693
+ * {
2694
+ * "applicationType": "URL",
2695
+ * "url": "/sap/bc/",
2696
+ * "additionalInformation": "SAPUI5.Component=com.sap.AComponent",
2697
+ * "text": "My targetmapping description",
2698
+ * "navigationMode": "embedded"
2699
+ * }
2700
+ * ```
2701
+ * The `navigationMode` indicates how the target application should be navigated. It is added to the
2702
+ * result using the logic in {@link navigationMode#getNavigationMode} if none of the resolvers in the chain
2703
+ * added it. No navigation should occur when the promise is resolved to `undefined`.
2186
2704
  */
2187
2705
  resolveHashFragment(
2188
2706
  /**
@@ -2196,6 +2714,17 @@ declare namespace sap {
2196
2714
  *
2197
2715
  * This function should be used by the NWBC browser in order to get a resolved target corresponding to a
2198
2716
  * certain configuration object describing the target. Do not use this function for developing Fiori applications.
2717
+ *
2718
+ * @returns A jQuery.Promise. Its `done()` function gets an object. Typically it contains the following
2719
+ * information:
2720
+ * ```javascript
2721
+ *
2722
+ * {
2723
+ * "url": "/sap/bc/",
2724
+ * "text": "My targetmapping description",
2725
+ * "externalNavigationMode": "embedded"
2726
+ * }
2727
+ * ```
2199
2728
  */
2200
2729
  resolveTarget(
2201
2730
  /**
@@ -2254,6 +2783,9 @@ declare namespace sap {
2254
2783
  * @SINCE 1.34
2255
2784
  *
2256
2785
  * Launches dismiss notification call.
2786
+ *
2787
+ *
2788
+ * @returns Promise object that on success resolves to undefined or it is rejected with a message object
2257
2789
  */
2258
2790
  dismissNotification(
2259
2791
  /**
@@ -2267,6 +2799,8 @@ declare namespace sap {
2267
2799
  * Launches a notification action oData call.
2268
2800
  * After launching the action, the function gets updated notification data in order to push the updated
2269
2801
  * data to the consumers.
2802
+ *
2803
+ * @returns Promise object that on success resolves to undefined or it is rejected with failed notifications
2270
2804
  */
2271
2805
  executeBulkAction(
2272
2806
  /**
@@ -2282,6 +2816,8 @@ declare namespace sap {
2282
2816
  * @SINCE 1.38
2283
2817
  *
2284
2818
  * Returns the notifications of the user sorted by type include the group headers and the notifications
2819
+ *
2820
+ * @returns Promise object that on success - returns all notification items
2285
2821
  */
2286
2822
  getNotificationsByTypeWithGroupHeaders(): Promise<any>;
2287
2823
  /**
@@ -2289,12 +2825,16 @@ declare namespace sap {
2289
2825
  *
2290
2826
  * Returns the number of notifications
2291
2827
  * e.g. Notifications for user.
2828
+ *
2829
+ * @returns Returns the number of notifications of the user
2292
2830
  */
2293
2831
  getNotificationsCount(): number;
2294
2832
  /**
2295
2833
  * @SINCE 1.44
2296
2834
  *
2297
2835
  * Returns the group headers of the user notifications
2836
+ *
2837
+ * @returns Promise object that on success - returns all group headers
2298
2838
  */
2299
2839
  getNotificationsGroupHeaders(): Promise<any>;
2300
2840
  /**
@@ -2302,6 +2842,8 @@ declare namespace sap {
2302
2842
  *
2303
2843
  * Returns the number of unseen notifications
2304
2844
  * e.g. Notifications that the user hasn't seen yet.
2845
+ *
2846
+ * @returns Promise object that on success - returns the number of unread notifications of the user
2305
2847
  */
2306
2848
  getUnseenNotificationsCount(): Promise<any>;
2307
2849
  /**
@@ -2329,10 +2871,16 @@ declare namespace sap {
2329
2871
  * Indicates whether notification service is enabled.
2330
2872
  * Enabling is based on the `enable` service configuration flag.
2331
2873
  * The service configuration must also include serviceUrl attribute.
2874
+ *
2875
+ *
2876
+ * @returns A boolean value indicating whether the notifications service is enabled
2332
2877
  */
2333
2878
  isEnabled(): boolean;
2334
2879
  /**
2335
2880
  * @SINCE 1.38
2881
+ *
2882
+ *
2883
+ * @returns boolean value whether first request was already performed and data was returned.
2336
2884
  */
2337
2885
  isFirstDataLoaded(): boolean;
2338
2886
  /**
@@ -2341,6 +2889,8 @@ declare namespace sap {
2341
2889
  * Launches mark as read notification call.
2342
2890
  * After launching the action, the function gets updated notification data in order to push the updated
2343
2891
  * data to the consumers.
2892
+ *
2893
+ * @returns Promise object that on success resolves to undefined or it is rejected with a message object
2344
2894
  */
2345
2895
  markRead(
2346
2896
  /**
@@ -2417,6 +2967,12 @@ declare namespace sap {
2417
2967
  * a save operation is executed.
2418
2968
  *
2419
2969
  * An initial object is returned.
2970
+ *
2971
+ * @returns Promise object whose done function returns a {@link sap.ushell.services.Personalization.ContextContainer}
2972
+ * object as parameter. The personalization container provides two different interfaces to synchronously
2973
+ * operate on personalization data. In the item mode the container contains items as name value pairs for
2974
+ * personalization data. In the variant mode the container contains variant sets which contain variants
2975
+ * containing items.
2420
2976
  */
2421
2977
  createEmptyContainer(
2422
2978
  /**
@@ -2448,6 +3004,8 @@ declare namespace sap {
2448
3004
  * of a container for the given key *after* the promise has returned.
2449
3005
  *
2450
3006
  * Note: Invoking this operation while another save or load operation is under way may result in failure.
3007
+ *
3008
+ * @returns promise for the deletion operation
2451
3009
  */
2452
3010
  delContainer(
2453
3011
  /**
@@ -2458,6 +3016,9 @@ declare namespace sap {
2458
3016
  /**
2459
3017
  * @SINCE 1.18.0
2460
3018
  * @deprecated
3019
+ *
3020
+ *
3021
+ * @returns promise for the deletion operation
2461
3022
  */
2462
3023
  delPersonalizationContainer(
2463
3024
  /**
@@ -2531,6 +3092,11 @@ declare namespace sap {
2531
3092
  * Naturally, if a delete or get with validity 0 is issued, it will *not* delete or retrieve a front-end
2532
3093
  * server persistent storage. Thus a sequence delete( [validity 0])/wait for promise, getContainer(sKey,{
2533
3094
  * validity : Infinity}) may return a valid dataset.
3095
+ *
3096
+ * @returns Promise object whose done function returns a {@link sap.ushell.services.Personalization.ContextContainer}
3097
+ * object as parameter. The container provides setItemValue / getItemValue methods to synchronously operate
3098
+ * on personalization data. By wrapping it in a VariantSetAdapter, an alternate interface to maintain variants
3099
+ * can be obtained.
2534
3100
  */
2535
3101
  getContainer(
2536
3102
  /**
@@ -2588,6 +3154,12 @@ declare namespace sap {
2588
3154
  * example you would have 2 variant sets, one for each variant type.
2589
3155
  *
2590
3156
  * Do not mix up the usage of a personalizer and a personalization container for one containerKey.
3157
+ *
3158
+ * @returns Promise object whose done function returns a {@link sap.ushell.services.PersonalizationContainer}
3159
+ * object as parameter. The personalization container provides two different interfaces to synchronously
3160
+ * operate on personalization data. In the item mode the container contains items as name-value pairs for
3161
+ * personalization data. In the variant mode the container contains variant sets which contain variants
3162
+ * containing items.
2591
3163
  */
2592
3164
  getPersonalizationContainer(
2593
3165
  /**
@@ -2602,6 +3174,9 @@ declare namespace sap {
2602
3174
  * data immediately via the connected adapter. For each operation a round trip is executed.
2603
3175
  *
2604
3176
  * Do not mix the usage of a personalizer and a personalization container for one containerKey.
3177
+ *
3178
+ * @returns {@link sap.ushell.services.Personalizer} which provides generic read and write access to the
3179
+ * currently logged on user's personalization settings.
2605
3180
  */
2606
3181
  getPersonalizer(
2607
3182
  /**
@@ -2634,6 +3209,9 @@ declare namespace sap {
2634
3209
  * the personalization data transiently as an object property. Primary usage of the transient personalizer
2635
3210
  * is a personalization scenario with variants where the transient personalizer is used as a buffer for
2636
3211
  * table personalization data.
3212
+ *
3213
+ * @returns {@link sap.ushell.services.TransientPersonalizer} which provides asynchronous read and write
3214
+ * access to a transient personalization data storage.
2637
3215
  */
2638
3216
  getTransientPersonalizer(): object;
2639
3217
  }
@@ -2654,6 +3232,8 @@ declare namespace sap {
2654
3232
  *
2655
3233
  * Creates a new variant set in the container. In case a variant set with this key is already existing an
2656
3234
  * exception is thrown.
3235
+ *
3236
+ * @returns {@link sap.ushell.services.PersonalizationContainerVariantSet}
2657
3237
  */
2658
3238
  addVariantSet(
2659
3239
  /**
@@ -2665,6 +3245,8 @@ declare namespace sap {
2665
3245
  * @SINCE 1.18.0
2666
3246
  *
2667
3247
  * Checks if a specific direct item is contained in the container.
3248
+ *
3249
+ * @returns true if the container contains a direct item with the key
2668
3250
  */
2669
3251
  containsItem(
2670
3252
  /**
@@ -2676,6 +3258,8 @@ declare namespace sap {
2676
3258
  * @SINCE 1.18.0
2677
3259
  *
2678
3260
  * Checks if a specific variant set is contained in the container.
3261
+ *
3262
+ * @returns true if the container contains a variant set with the key
2679
3263
  */
2680
3264
  containsVariantSet(
2681
3265
  /**
@@ -2709,12 +3293,17 @@ declare namespace sap {
2709
3293
  * @SINCE 1.18.0
2710
3294
  *
2711
3295
  * Returns an array with the keys of direct items in the container.
3296
+ *
3297
+ * @returns item keys
2712
3298
  */
2713
3299
  getItemKeys(): any[];
2714
3300
  /**
2715
3301
  * @SINCE 1.18.0
2716
3302
  *
2717
3303
  * Returns the value for a direct item from the container.
3304
+ *
3305
+ * @returns item value (JSON object). In case the container does not contain a direct item with this key
3306
+ * `undefined` is returned.
2718
3307
  */
2719
3308
  getItemValue(
2720
3309
  /**
@@ -2726,6 +3315,8 @@ declare namespace sap {
2726
3315
  * @SINCE 1.18.0
2727
3316
  *
2728
3317
  * Returns an array with the keys of the variant sets in the container.
3318
+ *
3319
+ * @returns variant set keys
2729
3320
  */
2730
3321
  getVariantSetKeys(): any[];
2731
3322
  /**
@@ -2738,6 +3329,8 @@ declare namespace sap {
2738
3329
  * operation may fail! (wait for the other promise).
2739
3330
  *
2740
3331
  * Synchronous read and write operations before the load is done have undefined effects.
3332
+ *
3333
+ * @returns Promise object
2741
3334
  */
2742
3335
  load(): object;
2743
3336
  /**
@@ -2745,6 +3338,10 @@ declare namespace sap {
2745
3338
  *
2746
3339
  * Attempts to save the current container data at the underlying storage asynchronously. The current state
2747
3340
  * is serialized.
3341
+ *
3342
+ * @returns Promise object
3343
+ *
3344
+ * If another save/load/delete operation is not completed, the operation may fail! (wait for the other promise).
2748
3345
  */
2749
3346
  save(): object;
2750
3347
  /**
@@ -2780,6 +3377,8 @@ declare namespace sap {
2780
3377
  * @SINCE 1.18.0
2781
3378
  *
2782
3379
  * Checks if a specific item is contained in this variant.
3380
+ *
3381
+ * @returns true if the variant contains an item with the key
2783
3382
  */
2784
3383
  containsItem(
2785
3384
  /**
@@ -2802,12 +3401,17 @@ declare namespace sap {
2802
3401
  * @SINCE 1.18.0
2803
3402
  *
2804
3403
  * Returns an array with the keys of all items in this variant.
3404
+ *
3405
+ * @returns item keys
2805
3406
  */
2806
3407
  getItemKeys(): any[];
2807
3408
  /**
2808
3409
  * @SINCE 1.18.0
2809
3410
  *
2810
3411
  * Returns the value for an item in this variant.
3412
+ *
3413
+ * @returns item value (JSON object). In case the variant does not contain an item with this key `undefined`
3414
+ * is returned.
2811
3415
  */
2812
3416
  getItemValue(
2813
3417
  /**
@@ -2819,12 +3423,16 @@ declare namespace sap {
2819
3423
  * @SINCE 1.18.0
2820
3424
  *
2821
3425
  * Returns the key of this variant.
3426
+ *
3427
+ * @returns variant key.
2822
3428
  */
2823
3429
  getVariantKey(): string;
2824
3430
  /**
2825
3431
  * @SINCE 1.18.0
2826
3432
  *
2827
3433
  * Returns the name of this variant.
3434
+ *
3435
+ * @returns variant name.
2828
3436
  */
2829
3437
  getVariantName(): string;
2830
3438
  /**
@@ -2865,6 +3473,8 @@ declare namespace sap {
2865
3473
  * @SINCE 1.18.0
2866
3474
  *
2867
3475
  * Checks if a specific variant is contained in the variant set.
3476
+ *
3477
+ * @returns true if the variant set contains a variant with the key
2868
3478
  */
2869
3479
  containsVariant(
2870
3480
  /**
@@ -2876,12 +3486,17 @@ declare namespace sap {
2876
3486
  * @SINCE 1.18.0
2877
3487
  *
2878
3488
  * Returns the current variant key.
3489
+ *
3490
+ * @returns current variant key. In case the current variant was never set `null` is returned.
2879
3491
  */
2880
3492
  getCurrentVariantKey(): string;
2881
3493
  /**
2882
3494
  * @SINCE 1.18.0
2883
3495
  *
2884
3496
  * Returns a variant object.
3497
+ *
3498
+ * @returns {@link sap.ushell.services.PersonalizationContainerVariant}. In case the variant set does not
3499
+ * contain a variant with this key `undefined` is returned.
2885
3500
  */
2886
3501
  getVariant(
2887
3502
  /**
@@ -2893,6 +3508,9 @@ declare namespace sap {
2893
3508
  * @SINCE 1.18.0
2894
3509
  *
2895
3510
  * Returns the variant key corresponding to a variant name.
3511
+ *
3512
+ * @returns variant key. In case the variant set does not contain a variant with this name `undefined` is
3513
+ * returned.
2896
3514
  */
2897
3515
  getVariantKeyByName(
2898
3516
  /**
@@ -2904,6 +3522,8 @@ declare namespace sap {
2904
3522
  * @SINCE 1.18.0
2905
3523
  *
2906
3524
  * Returns an array with the keys of the variants in the variant set.
3525
+ *
3526
+ * @returns variant keys
2907
3527
  */
2908
3528
  getVariantKeys(): any[];
2909
3529
  /**
@@ -2996,6 +3616,8 @@ declare namespace sap {
2996
3616
  * Signature of the callback function sShellHashPart, // The hash part on the URL that is resolved and used
2997
3617
  * for application loading sAppSpecificPart // Typically ignored sOldShellHashPart, // The old shell hash
2998
3618
  * part, if exist sOldAppSpecificPart, // The old app hash part, if exist
3619
+ *
3620
+ * @returns this
2999
3621
  */
3000
3622
  init(
3001
3623
  /**
@@ -3077,6 +3699,8 @@ declare namespace sap {
3077
3699
  * @SINCE 1.20.0
3078
3700
  *
3079
3701
  * Creates a Support Ticket. Forwards the given data (JSON object) to the associated adapter.
3702
+ *
3703
+ * @returns promise
3080
3704
  */
3081
3705
  createTicket(
3082
3706
  /**
@@ -3089,6 +3713,8 @@ declare namespace sap {
3089
3713
  *
3090
3714
  * Checks if the service is enabled. The service enablement depends on the configuration in the back-end
3091
3715
  * system and the bootstrap configuration.
3716
+ *
3717
+ * @returns `true` if the service is enabled; `false` otherwise
3092
3718
  */
3093
3719
  isEnabled(): boolean;
3094
3720
  }
@@ -3107,24 +3733,36 @@ declare namespace sap {
3107
3733
  * @SINCE 1.18.0
3108
3734
  *
3109
3735
  * Deletes a personalization data value.
3736
+ *
3737
+ * @returns Promise object which returns if the deletion was successful or erroneous. Promise object done
3738
+ * function: no params. Promise object fail function ins never triggered.
3110
3739
  */
3111
3740
  delPersData(): object;
3112
3741
  /**
3113
3742
  * @SINCE 1.18.0
3114
3743
  *
3115
3744
  * Gets a personalization data value.
3745
+ *
3746
+ * @returns Promise object which provides the personalization value. Promise object done function: param
3747
+ * {object} oValue JSON object containing the personalization value. If there is no personalization data
3748
+ * for the item, undefined is returned. Promise object fail function ins never triggered.
3116
3749
  */
3117
3750
  getPersData(): object;
3118
3751
  /**
3119
3752
  * @SINCE 1.18.0
3120
3753
  *
3121
3754
  * Synchronously gets a personalization data value.
3755
+ *
3756
+ * @returns JSON object containing the personalization value.
3122
3757
  */
3123
3758
  getValue(): object;
3124
3759
  /**
3125
3760
  * @SINCE 1.18.0
3126
3761
  *
3127
3762
  * Sets a personalization data value.
3763
+ *
3764
+ * @returns Promise object which returns if the saving was successful or erroneous. Promise object done
3765
+ * function: no params. Promise fail function ins never triggered.
3128
3766
  */
3129
3767
  setPersData(
3130
3768
  /**
@@ -3210,6 +3848,9 @@ declare namespace sap {
3210
3848
  * **Example 2:** `/sap/opu/odata/MyService;o=/MyEntities/$count?p1=v1` is converted to `/sap/opu/odata/MyService;o=sid(SYS.123)/MyEntities/$count?p1=v1`
3211
3849
  * if parameter `vComponentOrSystem` is set to "sid(SYS.123)". The URL is in no way
3212
3850
  * normalized.
3851
+ *
3852
+ * @returns the service URL pointing to the system specified in parameter `vComponentOrSystem` or to the
3853
+ * system of the current application
3213
3854
  */
3214
3855
  addSystemToServiceUrl(
3215
3856
  /**
@@ -3227,6 +3868,9 @@ declare namespace sap {
3227
3868
  * @SINCE 1.16.0
3228
3869
  *
3229
3870
  * compose a shell Hash from it's respective parts Note that it also may append an app specific route !
3871
+ *
3872
+ * @returns the hash part of an URL, e.g. `"Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH` returns
3873
+ * "" for an undefined object
3230
3874
  */
3231
3875
  constructShellHash(
3232
3876
  /**
@@ -3241,6 +3885,8 @@ declare namespace sap {
3241
3885
  * @SINCE 1.16.0
3242
3886
  *
3243
3887
  * Extract a hash part from an URL, including an app-specific part
3888
+ *
3889
+ * @returns `extracted string` if and only if a hash is present, undefined otherwise
3244
3890
  */
3245
3891
  getHash(
3246
3892
  /**
@@ -3263,6 +3909,8 @@ declare namespace sap {
3263
3909
  *
3264
3910
  * Note: the results when passing an illegal (non-compliant) url are undefined and subject to change w.o.
3265
3911
  * notice. Notably further checks may added. The design is deliberately restrictive and non-robust.
3912
+ *
3913
+ * @returns the parsed result
3266
3914
  */
3267
3915
  getShellHash(
3268
3916
  /**
@@ -3284,6 +3932,8 @@ declare namespace sap {
3284
3932
  *
3285
3933
  * The actual test is synchronous and *only* tests whether the hash part can be parsed and contains a semantic
3286
3934
  * object and action. It does not test whether the intent or its parameters are valid for a given user
3935
+ *
3936
+ * @returns true if the conditions are fulfilled.
3287
3937
  */
3288
3938
  isIntentUrl(
3289
3939
  /**
@@ -3303,6 +3953,8 @@ declare namespace sap {
3303
3953
  *
3304
3954
  * This function *only* tests whether the hash part can be parsed and contains a semantic object and action.
3305
3955
  * It does not test whether the intent or its parameters are valid for a given user
3956
+ *
3957
+ * @returns true if the conditions are fulfilled.
3306
3958
  */
3307
3959
  isIntentUrlAsync(
3308
3960
  /**
@@ -3315,6 +3967,9 @@ declare namespace sap {
3315
3967
  *
3316
3968
  * combine members of a javascript object into a parameter string, note that parameters are ordered in an
3317
3969
  * arbitrary manner which is subject to change
3970
+ *
3971
+ * @returns `ABC=1&ABC=1%202DEF=4` Note that the result is *not* prefixed with a "?", parameter values are
3972
+ * encodeURIComponent encoded.
3318
3973
  */
3319
3974
  paramsToString(
3320
3975
  /**
@@ -3326,6 +3981,8 @@ declare namespace sap {
3326
3981
  * @SINCE 1.20.0
3327
3982
  *
3328
3983
  * parse parameters from a URI query string (starting with ?) into a parameter object
3984
+ *
3985
+ * @returns oParams, any value { ABC : ["1", "1 2DEF=4"]}
3329
3986
  */
3330
3987
  parseParameters(
3331
3988
  /**
@@ -3337,6 +3994,14 @@ declare namespace sap {
3337
3994
  * @SINCE 1.16.0
3338
3995
  *
3339
3996
  * Decompose a shell hash into the respective parts
3997
+ *
3998
+ * @returns `undefined` if not a parseable hash
3999
+ * ` { semanticObject : string,
4000
+ * action : string,
4001
+ * contextRaw : string,
4002
+ * params : MapObject,
4003
+ * appSpecificRoute : string
4004
+ * } ` Note that params always has an Array for each parameter value!
3340
4005
  */
3341
4006
  parseShellHash(
3342
4007
  /**
@@ -3352,6 +4017,10 @@ declare namespace sap {
3352
4017
  * split a Unified Shell compliant hash into an Object containing a shell specific part and an app specific
3353
4018
  * parts
3354
4019
  * for non compliant hash strings, the empty object {} is returned. an optional leading # is stripped
4020
+ *
4021
+ * @returns `{}`(empty object) if not a parseable hash ` { shellPart : "Object-name~AFE2==?PV1=PV2&PV4=V5",
4022
+ * appSpecificRoute : "display/detail/7?UU=HH" } ` otherwise Note that params always has an Array for each
4023
+ * parameter value!
3355
4024
  */
3356
4025
  splitHash(
3357
4026
  /**
@@ -3447,6 +4116,9 @@ declare namespace sap {
3447
4116
  * a) Service configuration property `enable` is set to `true`
3448
4117
  * b) Service configuration property `pubToken` is not empty
3449
4118
  * c) Agreement text exists or `setUsageAnalyticsPermitted` is set to `false`
4119
+ *
4120
+ *
4121
+ * @returns A boolean value indicating whether the UsageAnalytics service is enabled
3450
4122
  */
3451
4123
  systemEnabled(): boolean;
3452
4124
  /**
@@ -3459,6 +4131,9 @@ declare namespace sap {
3459
4131
  * Returns `true` if the following conditions exist, and `false` otherwise:
3460
4132
  * a) The function `system enabled` returns `true`
3461
4133
  * b) The user property `trackUsageAnalytics` is set to `true`
4134
+ *
4135
+ *
4136
+ * @returns A boolean value indicating whether the user has specified to track activities
3462
4137
  */
3463
4138
  userEnabled(): boolean;
3464
4139
  }
@@ -3490,30 +4165,40 @@ declare namespace sap {
3490
4165
  * @SINCE 1.86.0
3491
4166
  *
3492
4167
  * Returns the email address of the user.
4168
+ *
4169
+ * @returns The user's email address.
3493
4170
  */
3494
4171
  getEmail(): string;
3495
4172
  /**
3496
4173
  * @SINCE 1.86.0
3497
4174
  *
3498
4175
  * Returns the first name of the user.
4176
+ *
4177
+ * @returns The user's first name.
3499
4178
  */
3500
4179
  getFirstName(): string;
3501
4180
  /**
3502
4181
  * @SINCE 1.86.0
3503
4182
  *
3504
4183
  * Returns the full name of the user.
4184
+ *
4185
+ * @returns The user's full name.
3505
4186
  */
3506
4187
  getFullName(): string;
3507
4188
  /**
3508
4189
  * @SINCE 1.16.3
3509
4190
  *
3510
4191
  * Returns the id of the user.
4192
+ *
4193
+ * @returns The user id.
3511
4194
  */
3512
4195
  getId(): string;
3513
4196
  /**
3514
4197
  * @SINCE 1.86.0
3515
4198
  *
3516
4199
  * Returns the last name of the user.
4200
+ *
4201
+ * @returns The user's last name.
3517
4202
  */
3518
4203
  getLastName(): string;
3519
4204
  }
@@ -3525,11 +4210,13 @@ declare namespace sap {
3525
4210
  interface $PictureTileSettings extends sap.m.$CustomTileSettings {
3526
4211
  height?:
3527
4212
  | sap.ui.core.CSSSize
3528
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
4213
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
4214
+ | `{${string}}`;
3529
4215
 
3530
4216
  width?:
3531
4217
  | sap.ui.core.CSSSize
3532
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
4218
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
4219
+ | `{${string}}`;
3533
4220
 
3534
4221
  tileContent?:
3535
4222
  | sap.ushell.components.factsheet.controls.PictureViewerItem
@@ -3544,14 +4231,21 @@ declare namespace sap {
3544
4231
  * Percentage of the space occupied by the image in the picture viewer control. Please note that if the
3545
4232
  * factor is too close to 1, the navigation arrows usually displayed in desktop mode will not be available
3546
4233
  */
3547
- tileScaling?: float | sap.ui.base.ManagedObject.PropertyBindingInfo;
4234
+ tileScaling?:
4235
+ | float
4236
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
4237
+ | `{${string}}`;
3548
4238
 
3549
- removable?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
4239
+ removable?:
4240
+ | boolean
4241
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
4242
+ | `{${string}}`;
3550
4243
 
3551
4244
  items?:
3552
4245
  | sap.ushell.components.factsheet.controls.PictureViewerItem[]
3553
4246
  | sap.ushell.components.factsheet.controls.PictureViewerItem
3554
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
4247
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
4248
+ | `{${string}}`;
3555
4249
 
3556
4250
  pictureDeleted?: (oEvent: sap.ui.base.Event) => void;
3557
4251
  }
@@ -3608,6 +4302,8 @@ declare namespace sap {
3608
4302
  * and enriches it with the information contained in `oClassInfo`.
3609
4303
  *
3610
4304
  * `oClassInfo` might contain the same kind of information as described in {@link sap.m.CustomTile.extend}.
4305
+ *
4306
+ * @returns Created class / constructor function
3611
4307
  */
3612
4308
  static extend<T extends Record<string, unknown>>(
3613
4309
  /**
@@ -3629,6 +4325,8 @@ declare namespace sap {
3629
4325
  ): Function;
3630
4326
  /**
3631
4327
  * Returns a metadata object for class sap.ushell.components.factsheet.controls.PictureTile.
4328
+ *
4329
+ * @returns Metadata object describing this class
3632
4330
  */
3633
4331
  static getMetadata(): sap.ui.core.ElementMetadata;
3634
4332
  /**
@@ -3636,6 +4334,8 @@ declare namespace sap {
3636
4334
  *
3637
4335
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
3638
4336
  * otherwise it will be bound to this `sap.ushell.components.factsheet.controls.PictureTile` itself.
4337
+ *
4338
+ * @returns Reference to `this` in order to allow method chaining
3639
4339
  */
3640
4340
  attachPictureDelete(
3641
4341
  /**
@@ -3658,6 +4358,8 @@ declare namespace sap {
3658
4358
  *
3659
4359
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
3660
4360
  * otherwise it will be bound to this `sap.ushell.components.factsheet.controls.PictureTile` itself.
4361
+ *
4362
+ * @returns Reference to `this` in order to allow method chaining
3661
4363
  */
3662
4364
  attachPictureDelete(
3663
4365
  /**
@@ -3675,6 +4377,8 @@ declare namespace sap {
3675
4377
  * `sap.ushell.components.factsheet.controls.PictureTile`.
3676
4378
  *
3677
4379
  * The passed function and listener object must match the ones used for event registration.
4380
+ *
4381
+ * @returns Reference to `this` in order to allow method chaining
3678
4382
  */
3679
4383
  detachPictureDelete(
3680
4384
  /**
@@ -3688,6 +4392,8 @@ declare namespace sap {
3688
4392
  ): this;
3689
4393
  /**
3690
4394
  * Fires event {@link #event:pictureDelete pictureDelete} to attached listeners.
4395
+ *
4396
+ * @returns Reference to `this` in order to allow method chaining
3691
4397
  */
3692
4398
  firePictureDelete(
3693
4399
  /**
@@ -3699,6 +4405,8 @@ declare namespace sap {
3699
4405
  * Gets current value of property {@link #getHeight height}.
3700
4406
  *
3701
4407
  * Default value is `"32px"`.
4408
+ *
4409
+ * @returns Value of property `height`
3702
4410
  */
3703
4411
  getHeight(): sap.ui.core.CSSSize;
3704
4412
  /**
@@ -3710,6 +4418,8 @@ declare namespace sap {
3710
4418
  * Gets current value of property {@link #getWidth width}.
3711
4419
  *
3712
4420
  * Default value is `"32px"`.
4421
+ *
4422
+ * @returns Value of property `width`
3713
4423
  */
3714
4424
  getWidth(): sap.ui.core.CSSSize;
3715
4425
  /**
@@ -3718,6 +4428,8 @@ declare namespace sap {
3718
4428
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3719
4429
  *
3720
4430
  * Default value is `"32px"`.
4431
+ *
4432
+ * @returns Reference to `this` in order to allow method chaining
3721
4433
  */
3722
4434
  setHeight(
3723
4435
  /**
@@ -3727,6 +4439,8 @@ declare namespace sap {
3727
4439
  ): this;
3728
4440
  /**
3729
4441
  * Reference to one PictureViewerItem coming from the PictureViewer.
4442
+ *
4443
+ * @returns `this` to allow method chaining
3730
4444
  */
3731
4445
  setTileContent(
3732
4446
  /**
@@ -3743,6 +4457,8 @@ declare namespace sap {
3743
4457
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3744
4458
  *
3745
4459
  * Default value is `"32px"`.
4460
+ *
4461
+ * @returns Reference to `this` in order to allow method chaining
3746
4462
  */
3747
4463
  setWidth(
3748
4464
  /**
@@ -3795,6 +4511,8 @@ declare namespace sap {
3795
4511
  * and enriches it with the information contained in `oClassInfo`.
3796
4512
  *
3797
4513
  * `oClassInfo` might contain the same kind of information as described in {@link sap.m.TileContainer.extend}.
4514
+ *
4515
+ * @returns Created class / constructor function
3798
4516
  */
3799
4517
  static extend<T extends Record<string, unknown>>(
3800
4518
  /**
@@ -3816,12 +4534,16 @@ declare namespace sap {
3816
4534
  ): Function;
3817
4535
  /**
3818
4536
  * Returns a metadata object for class sap.ushell.components.factsheet.controls.PictureViewer.
4537
+ *
4538
+ * @returns Metadata object describing this class
3819
4539
  */
3820
4540
  static getMetadata(): sap.ui.core.ElementMetadata;
3821
4541
  /**
3822
4542
  * @deprecated - Use aggregation "tiles"
3823
4543
  *
3824
4544
  * Adds some item `oItem` to the aggregation named `items`.
4545
+ *
4546
+ * @returns `this` to allow method chaining
3825
4547
  */
3826
4548
  addItem(
3827
4549
  /**
@@ -3835,6 +4557,8 @@ declare namespace sap {
3835
4557
  *
3836
4558
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
3837
4559
  * otherwise it will be bound to this `sap.ushell.components.factsheet.controls.PictureViewer` itself.
4560
+ *
4561
+ * @returns Reference to `this` in order to allow method chaining
3838
4562
  */
3839
4563
  attachPictureDeleted(
3840
4564
  /**
@@ -3858,6 +4582,8 @@ declare namespace sap {
3858
4582
  *
3859
4583
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
3860
4584
  * otherwise it will be bound to this `sap.ushell.components.factsheet.controls.PictureViewer` itself.
4585
+ *
4586
+ * @returns Reference to `this` in order to allow method chaining
3861
4587
  */
3862
4588
  attachPictureDeleted(
3863
4589
  /**
@@ -3872,6 +4598,8 @@ declare namespace sap {
3872
4598
  ): this;
3873
4599
  /**
3874
4600
  * Removes the picture at index `iIndex` from the `items` aggregation.
4601
+ *
4602
+ * @returns `this` to allow method chaining
3875
4603
  */
3876
4604
  deletePicture(
3877
4605
  /**
@@ -3882,6 +4610,8 @@ declare namespace sap {
3882
4610
  ): sap.ushell.components.factsheet.controls.PictureViewer;
3883
4611
  /**
3884
4612
  * Destroys all the items in the aggregation {@link #getItems items}.
4613
+ *
4614
+ * @returns Reference to `this` in order to allow method chaining
3885
4615
  */
3886
4616
  destroyItems(): this;
3887
4617
  /**
@@ -3889,6 +4619,8 @@ declare namespace sap {
3889
4619
  * `sap.ushell.components.factsheet.controls.PictureViewer`.
3890
4620
  *
3891
4621
  * The passed function and listener object must match the ones used for event registration.
4622
+ *
4623
+ * @returns Reference to `this` in order to allow method chaining
3892
4624
  */
3893
4625
  detachPictureDeleted(
3894
4626
  /**
@@ -3902,6 +4634,8 @@ declare namespace sap {
3902
4634
  ): this;
3903
4635
  /**
3904
4636
  * Fires event {@link #event:pictureDeleted pictureDeleted} to attached listeners.
4637
+ *
4638
+ * @returns Reference to `this` in order to allow method chaining
3905
4639
  */
3906
4640
  firePictureDeleted(
3907
4641
  /**
@@ -3911,6 +4645,8 @@ declare namespace sap {
3911
4645
  ): this;
3912
4646
  /**
3913
4647
  * Gets the current picture index.
4648
+ *
4649
+ * @returns the current picture index
3914
4650
  */
3915
4651
  getCurrentPictureIndex(): sap.ushell.components.factsheet.controls.PictureViewer;
3916
4652
  /**
@@ -3921,6 +4657,8 @@ declare namespace sap {
3921
4657
  * Gets current value of property {@link #getRemovable removable}.
3922
4658
  *
3923
4659
  * Default value is `false`.
4660
+ *
4661
+ * @returns Value of property `removable`
3924
4662
  */
3925
4663
  getRemovable(): boolean;
3926
4664
  /**
@@ -3930,11 +4668,15 @@ declare namespace sap {
3930
4668
  * factor is too close to 1, the navigation arrows usually displayed in desktop mode will not be available
3931
4669
  *
3932
4670
  * Default value is `0.95`.
4671
+ *
4672
+ * @returns Value of property `tileScaling`
3933
4673
  */
3934
4674
  getTileScaling(): float;
3935
4675
  /**
3936
4676
  * Checks for the provided `sap.ushell.components.factsheet.controls.PictureViewerItem` in the aggregation
3937
4677
  * {@link #getItems items}. and returns its index if found or -1 otherwise.
4678
+ *
4679
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
3938
4680
  */
3939
4681
  indexOfItem(
3940
4682
  /**
@@ -3947,6 +4689,8 @@ declare namespace sap {
3947
4689
  *
3948
4690
  * Inserts a item into the aggregation named `items`. When adding a new item to the aggregation, a sap.ca.ui.PictureTile
3949
4691
  * is actually created with its own ID and added to the internal TileContainer.
4692
+ *
4693
+ * @returns `this` to allow method chaining
3950
4694
  */
3951
4695
  insertItem(
3952
4696
  /**
@@ -3964,10 +4708,14 @@ declare namespace sap {
3964
4708
  * Removes all the controls from the aggregation {@link #getItems items}.
3965
4709
  *
3966
4710
  * Additionally, it unregisters them from the hosting UIArea.
4711
+ *
4712
+ * @returns An array of the removed elements (might be empty)
3967
4713
  */
3968
4714
  removeAllItems(): sap.ushell.components.factsheet.controls.PictureViewerItem[];
3969
4715
  /**
3970
4716
  * Removes a item from the aggregation {@link #getItems items}.
4717
+ *
4718
+ * @returns The removed item or `null`
3971
4719
  */
3972
4720
  removeItem(
3973
4721
  /**
@@ -3980,6 +4728,8 @@ declare namespace sap {
3980
4728
  ): sap.ushell.components.factsheet.controls.PictureViewerItem;
3981
4729
  /**
3982
4730
  * Select the picture at index `iIndex` from the `items` aggregation.
4731
+ *
4732
+ * @returns `this` to allow method chaining
3983
4733
  */
3984
4734
  selectPicture(
3985
4735
  /**
@@ -3995,6 +4745,8 @@ declare namespace sap {
3995
4745
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3996
4746
  *
3997
4747
  * Default value is `false`.
4748
+ *
4749
+ * @returns Reference to `this` in order to allow method chaining
3998
4750
  */
3999
4751
  setRemovable(
4000
4752
  /**
@@ -4011,6 +4763,8 @@ declare namespace sap {
4011
4763
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4012
4764
  *
4013
4765
  * Default value is `0.95`.
4766
+ *
4767
+ * @returns Reference to `this` in order to allow method chaining
4014
4768
  */
4015
4769
  setTileScaling(
4016
4770
  /**
@@ -4064,6 +4818,8 @@ declare namespace sap {
4064
4818
  * `sClassName` and enriches it with the information contained in `oClassInfo`.
4065
4819
  *
4066
4820
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
4821
+ *
4822
+ * @returns Created class / constructor function
4067
4823
  */
4068
4824
  static extend<T extends Record<string, unknown>>(
4069
4825
  /**
@@ -4085,10 +4841,14 @@ declare namespace sap {
4085
4841
  ): Function;
4086
4842
  /**
4087
4843
  * Returns a metadata object for class sap.ushell.components.factsheet.controls.PictureViewerItem.
4844
+ *
4845
+ * @returns Metadata object describing this class
4088
4846
  */
4089
4847
  static getMetadata(): sap.ui.core.ElementMetadata;
4090
4848
  /**
4091
4849
  * Destroys the image in the aggregation {@link #getImage image}.
4850
+ *
4851
+ * @returns Reference to `this` in order to allow method chaining
4092
4852
  */
4093
4853
  destroyImage(): this;
4094
4854
  /**
@@ -4097,10 +4857,14 @@ declare namespace sap {
4097
4857
  getImage(): sap.m.Image;
4098
4858
  /**
4099
4859
  * Gets current value of property {@link #getSrc src}.
4860
+ *
4861
+ * @returns Value of property `src`
4100
4862
  */
4101
4863
  getSrc(): string;
4102
4864
  /**
4103
4865
  * Sets the aggregated {@link #getImage image}.
4866
+ *
4867
+ * @returns Reference to `this` in order to allow method chaining
4104
4868
  */
4105
4869
  setImage(
4106
4870
  /**
@@ -4112,6 +4876,8 @@ declare namespace sap {
4112
4876
  * Setter for property `src`.
4113
4877
  *
4114
4878
  * Default value is empty/`undefined`
4879
+ *
4880
+ * @returns `this` to allow method chaining
4115
4881
  */
4116
4882
  setSrc(
4117
4883
  /**
@@ -4180,6 +4946,8 @@ declare namespace sap {
4180
4946
  * it with the information contained in `oClassInfo`.
4181
4947
  *
4182
4948
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.UIComponent.extend}.
4949
+ *
4950
+ * @returns Created class / constructor function
4183
4951
  */
4184
4952
  static extend<T extends Record<string, unknown>>(
4185
4953
  /**
@@ -4198,6 +4966,8 @@ declare namespace sap {
4198
4966
  ): Function;
4199
4967
  /**
4200
4968
  * Returns a metadata object for class sap.ushell.renderers.fiori2.Renderer.
4969
+ *
4970
+ * @returns Metadata object describing this class
4201
4971
  */
4202
4972
  static getMetadata(): sap.ui.core.ComponentMetadata;
4203
4973
  /**
@@ -4222,6 +4992,8 @@ declare namespace sap {
4222
4992
  * See:
4223
4993
  * sap.ushell.renderers.fiori2.renderer.LaunchpadState
4224
4994
  * If no launchpad state is provided, the content is added in all states.
4995
+ *
4996
+ * @returns oItem - the created control
4225
4997
  */
4226
4998
  addActionButton(
4227
4999
  /**
@@ -4289,6 +5061,8 @@ declare namespace sap {
4289
5061
  * See:
4290
5062
  * LaunchpadState
4291
5063
  * If no launchpad state is provided the content is added in all states.
5064
+ *
5065
+ * @returns oItem - the created control
4292
5066
  */
4293
5067
  addFloatingActionButton(
4294
5068
  /**
@@ -4331,6 +5105,8 @@ declare namespace sap {
4331
5105
  * See:
4332
5106
  * LaunchpadState
4333
5107
  * If no launchpad state is provided the content is added in all states.
5108
+ *
5109
+ * @returns jQuery.deferred.promise object that when resolved, returns the newly created control
4334
5110
  */
4335
5111
  addFloatingButton(
4336
5112
  /**
@@ -4387,6 +5163,8 @@ declare namespace sap {
4387
5163
  * See:
4388
5164
  * LaunchpadState
4389
5165
  * If no launchpad state is provided the content is added in all states.
5166
+ *
5167
+ * @returns oItem - the created control
4390
5168
  */
4391
5169
  addHeaderEndItem(
4392
5170
  /**
@@ -4450,6 +5228,8 @@ declare namespace sap {
4450
5228
  *
4451
5229
  * See:
4452
5230
  * LaunchpadState
5231
+ *
5232
+ * @returns The created control
4453
5233
  */
4454
5234
  addHeaderItem(
4455
5235
  /**
@@ -4510,6 +5290,8 @@ declare namespace sap {
4510
5290
  *
4511
5291
  * See:
4512
5292
  * LaunchpadState
5293
+ *
5294
+ * @returns The created control
4513
5295
  */
4514
5296
  addHeaderItem(
4515
5297
  /**
@@ -4559,6 +5341,8 @@ declare namespace sap {
4559
5341
  * See:
4560
5342
  * LaunchpadState
4561
5343
  * If no launchpad state is provided the content is added in all states.
5344
+ *
5345
+ * @returns oItem - the created control
4562
5346
  */
4563
5347
  addLeftPaneContent(
4564
5348
  /**
@@ -4612,6 +5396,9 @@ declare namespace sap {
4612
5396
  *
4613
5397
  * oRenderer.addShellSubHeader(oAddSubHeaderProperties);
4614
5398
  * ```
5399
+ *
5400
+ *
5401
+ * @returns jQuery.deferred.promise object that when resolved, returns the newly created control
4615
5402
  */
4616
5403
  addShellSubHeader(
4617
5404
  /**
@@ -4658,6 +5445,8 @@ declare namespace sap {
4658
5445
  * See:
4659
5446
  * LaunchpadState
4660
5447
  * If no launchpad state is provided the content is added in all states.
5448
+ *
5449
+ * @returns jQuery.deferred.promise object that when resolved, returns the newly created control.
4661
5450
  */
4662
5451
  addSidePaneContent(
4663
5452
  /**
@@ -4717,6 +5506,8 @@ declare namespace sap {
4717
5506
  * 2. The control type resource is already loaded
4718
5507
  * See:
4719
5508
  * LaunchpadState
5509
+ *
5510
+ * @returns The created control
4720
5511
  */
4721
5512
  addSubHeader(
4722
5513
  /**
@@ -4775,6 +5566,8 @@ declare namespace sap {
4775
5566
  * See:
4776
5567
  * sap.ushell.ui.shell.ToolAreaItem
4777
5568
  * sap.ushell.renderers.fiori2.renderer.LaunchpadState.
5569
+ *
5570
+ * @returns the added control
4778
5571
  */
4779
5572
  addToolAreaItem(
4780
5573
  /**
@@ -4825,6 +5618,8 @@ declare namespace sap {
4825
5618
  * See:
4826
5619
  * LaunchpadState
4827
5620
  * If no launchpad state is provided the content is added in all states.
5621
+ *
5622
+ * @returns jQuery.deferred.promise object that when resolved, returns the newly created control
4828
5623
  */
4829
5624
  addUserAction(
4830
5625
  /**
@@ -4869,6 +5664,9 @@ declare namespace sap {
4869
5664
  * };
4870
5665
  * oRenderer.addUserPreferencesEntry(oEntry);
4871
5666
  * ```
5667
+ *
5668
+ *
5669
+ * @returns User Preference Entry.
4872
5670
  */
4873
5671
  addUserPreferencesEntry(
4874
5672
  /**
@@ -4897,6 +5695,8 @@ declare namespace sap {
4897
5695
  * @SINCE 1.37
4898
5696
  *
4899
5697
  * This method returns the current state of the Viewport Container control.
5698
+ *
5699
+ * @returns The current Viewport State.
4900
5700
  */
4901
5701
  getCurrentViewportState(): object;
4902
5702
  /**
@@ -5153,6 +5953,8 @@ declare namespace sap {
5153
5953
  * It will continue to work as expected as long as one of the following conditions apply:
5154
5954
  * 1. The control instance is already created and its ID is included in the input parameter oControlProperties
5155
5955
  * 2. The control type resource is already loaded
5956
+ *
5957
+ * @returns The created control
5156
5958
  */
5157
5959
  setFooterControl(
5158
5960
  /**
@@ -5254,6 +6056,9 @@ declare namespace sap {
5254
6056
  * };
5255
6057
  * oRenderer.setShellFooter(oFooterControlProperties);
5256
6058
  * ```
6059
+ *
6060
+ *
6061
+ * @returns jQuery.deferred.promise object that when resolved, returns the newly created control
5257
6062
  */
5258
6063
  setShellFooter(
5259
6064
  /**
@@ -5593,6 +6398,8 @@ declare namespace sap {
5593
6398
  * with the information contained in `oClassInfo`.
5594
6399
  *
5595
6400
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
6401
+ *
6402
+ * @returns Created class / constructor function
5596
6403
  */
5597
6404
  static extend<T extends Record<string, unknown>>(
5598
6405
  /**
@@ -5611,6 +6418,8 @@ declare namespace sap {
5611
6418
  ): Function;
5612
6419
  /**
5613
6420
  * Returns a metadata object for class sap.ushell.ui.appfinder.AppBox.
6421
+ *
6422
+ * @returns Metadata object describing this class
5614
6423
  */
5615
6424
  static getMetadata(): sap.ui.core.ElementMetadata;
5616
6425
  /**
@@ -5621,6 +6430,8 @@ declare namespace sap {
5621
6430
  * otherwise it will be bound to this `sap.ushell.ui.appfinder.AppBox` itself.
5622
6431
  *
5623
6432
  * Fires after the appBox is rendered.
6433
+ *
6434
+ * @returns Reference to `this` in order to allow method chaining
5624
6435
  */
5625
6436
  attachAfterRendering(
5626
6437
  /**
@@ -5645,6 +6456,8 @@ declare namespace sap {
5645
6456
  * otherwise it will be bound to this `sap.ushell.ui.appfinder.AppBox` itself.
5646
6457
  *
5647
6458
  * Fires after the appBox is rendered.
6459
+ *
6460
+ * @returns Reference to `this` in order to allow method chaining
5648
6461
  */
5649
6462
  attachAfterRendering(
5650
6463
  /**
@@ -5663,6 +6476,8 @@ declare namespace sap {
5663
6476
  * otherwise it will be bound to this `sap.ushell.ui.appfinder.AppBox` itself.
5664
6477
  *
5665
6478
  * Fires when the appBox is pressed.
6479
+ *
6480
+ * @returns Reference to `this` in order to allow method chaining
5666
6481
  */
5667
6482
  attachPress(
5668
6483
  /**
@@ -5686,6 +6501,8 @@ declare namespace sap {
5686
6501
  * otherwise it will be bound to this `sap.ushell.ui.appfinder.AppBox` itself.
5687
6502
  *
5688
6503
  * Fires when the appBox is pressed.
6504
+ *
6505
+ * @returns Reference to `this` in order to allow method chaining
5689
6506
  */
5690
6507
  attachPress(
5691
6508
  /**
@@ -5699,6 +6516,8 @@ declare namespace sap {
5699
6516
  ): this;
5700
6517
  /**
5701
6518
  * Destroys the pinButton in the aggregation {@link #getPinButton pinButton}.
6519
+ *
6520
+ * @returns Reference to `this` in order to allow method chaining
5702
6521
  */
5703
6522
  destroyPinButton(): this;
5704
6523
  /**
@@ -5706,6 +6525,8 @@ declare namespace sap {
5706
6525
  * `sap.ushell.ui.appfinder.AppBox`.
5707
6526
  *
5708
6527
  * The passed function and listener object must match the ones used for event registration.
6528
+ *
6529
+ * @returns Reference to `this` in order to allow method chaining
5709
6530
  */
5710
6531
  detachAfterRendering(
5711
6532
  /**
@@ -5721,6 +6542,8 @@ declare namespace sap {
5721
6542
  * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.ushell.ui.appfinder.AppBox`.
5722
6543
  *
5723
6544
  * The passed function and listener object must match the ones used for event registration.
6545
+ *
6546
+ * @returns Reference to `this` in order to allow method chaining
5724
6547
  */
5725
6548
  detachPress(
5726
6549
  /**
@@ -5734,6 +6557,8 @@ declare namespace sap {
5734
6557
  ): this;
5735
6558
  /**
5736
6559
  * Fires event {@link #event:afterRendering afterRendering} to attached listeners.
6560
+ *
6561
+ * @returns Reference to `this` in order to allow method chaining
5737
6562
  */
5738
6563
  fireAfterRendering(
5739
6564
  /**
@@ -5743,6 +6568,8 @@ declare namespace sap {
5743
6568
  ): this;
5744
6569
  /**
5745
6570
  * Fires event {@link #event:press press} to attached listeners.
6571
+ *
6572
+ * @returns Reference to `this` in order to allow method chaining
5746
6573
  */
5747
6574
  firePress(
5748
6575
  /**
@@ -5754,12 +6581,16 @@ declare namespace sap {
5754
6581
  * Gets current value of property {@link #getIcon icon}.
5755
6582
  *
5756
6583
  * Specifies the icon url of the appBox.
6584
+ *
6585
+ * @returns Value of property `icon`
5757
6586
  */
5758
6587
  getIcon(): string;
5759
6588
  /**
5760
6589
  * Gets current value of property {@link #getNavigationMode navigationMode}.
5761
6590
  *
5762
6591
  * Specifies the navigationMode of the appBox.
6592
+ *
6593
+ * @returns Value of property `navigationMode`
5763
6594
  */
5764
6595
  getNavigationMode(): string;
5765
6596
  /**
@@ -5772,18 +6603,24 @@ declare namespace sap {
5772
6603
  * Gets current value of property {@link #getSubtitle subtitle}.
5773
6604
  *
5774
6605
  * Specifies the subTitle of the appBox.
6606
+ *
6607
+ * @returns Value of property `subtitle`
5775
6608
  */
5776
6609
  getSubtitle(): string;
5777
6610
  /**
5778
6611
  * Gets current value of property {@link #getTitle title}.
5779
6612
  *
5780
6613
  * Specifies the title of the appBox.
6614
+ *
6615
+ * @returns Value of property `title`
5781
6616
  */
5782
6617
  getTitle(): string;
5783
6618
  /**
5784
6619
  * Gets current value of property {@link #getUrl url}.
5785
6620
  *
5786
6621
  * Specifies the url of the appBox.
6622
+ *
6623
+ * @returns Value of property `url`
5787
6624
  */
5788
6625
  getUrl(): string;
5789
6626
  /**
@@ -5792,6 +6629,8 @@ declare namespace sap {
5792
6629
  * Specifies the icon url of the appBox.
5793
6630
  *
5794
6631
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6632
+ *
6633
+ * @returns Reference to `this` in order to allow method chaining
5795
6634
  */
5796
6635
  setIcon(
5797
6636
  /**
@@ -5805,6 +6644,8 @@ declare namespace sap {
5805
6644
  * Specifies the navigationMode of the appBox.
5806
6645
  *
5807
6646
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6647
+ *
6648
+ * @returns Reference to `this` in order to allow method chaining
5808
6649
  */
5809
6650
  setNavigationMode(
5810
6651
  /**
@@ -5814,6 +6655,8 @@ declare namespace sap {
5814
6655
  ): this;
5815
6656
  /**
5816
6657
  * Sets the aggregated {@link #getPinButton pinButton}.
6658
+ *
6659
+ * @returns Reference to `this` in order to allow method chaining
5817
6660
  */
5818
6661
  setPinButton(
5819
6662
  /**
@@ -5827,6 +6670,8 @@ declare namespace sap {
5827
6670
  * Specifies the subTitle of the appBox.
5828
6671
  *
5829
6672
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6673
+ *
6674
+ * @returns Reference to `this` in order to allow method chaining
5830
6675
  */
5831
6676
  setSubtitle(
5832
6677
  /**
@@ -5840,6 +6685,8 @@ declare namespace sap {
5840
6685
  * Specifies the title of the appBox.
5841
6686
  *
5842
6687
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6688
+ *
6689
+ * @returns Reference to `this` in order to allow method chaining
5843
6690
  */
5844
6691
  setTitle(
5845
6692
  /**
@@ -5853,6 +6700,8 @@ declare namespace sap {
5853
6700
  * Specifies the url of the appBox.
5854
6701
  *
5855
6702
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6703
+ *
6704
+ * @returns Reference to `this` in order to allow method chaining
5856
6705
  */
5857
6706
  setUrl(
5858
6707
  /**
@@ -5870,14 +6719,16 @@ declare namespace sap {
5870
6719
  */
5871
6720
  beforePressHandler?:
5872
6721
  | Function
5873
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
6722
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
6723
+ | `{${string}}`;
5874
6724
 
5875
6725
  /**
5876
6726
  * A callback function that is called after the save-as-tile dialog is closed.
5877
6727
  */
5878
6728
  afterPressHandler?:
5879
6729
  | any
5880
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
6730
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
6731
+ | `{${string}}`;
5881
6732
 
5882
6733
  /**
5883
6734
  * Title to be displayed on the tile.
@@ -5912,12 +6763,18 @@ declare namespace sap {
5912
6763
  /**
5913
6764
  * A customized target URL for the tile.
5914
6765
  */
5915
- customUrl?: any | sap.ui.base.ManagedObject.PropertyBindingInfo;
6766
+ customUrl?:
6767
+ | any
6768
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
6769
+ | `{${string}}`;
5916
6770
 
5917
6771
  /**
5918
6772
  * URL of an OData service from which data for a dynamic tile should be read.
5919
6773
  */
5920
- serviceUrl?: any | sap.ui.base.ManagedObject.PropertyBindingInfo;
6774
+ serviceUrl?:
6775
+ | any
6776
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
6777
+ | `{${string}}`;
5921
6778
 
5922
6779
  /**
5923
6780
  * Number of seconds after which dynamic content is read from the data source and the display is refreshed.
@@ -5931,21 +6788,26 @@ declare namespace sap {
5931
6788
  */
5932
6789
  showGroupSelection?:
5933
6790
  | boolean
5934
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
6791
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
6792
+ | `{${string}}`;
5935
6793
 
5936
6794
  /**
5937
6795
  * Whether to display the control for page selection in the save-bookmark dialog in launchpad spaces mode.
5938
6796
  */
5939
6797
  showPageSelection?:
5940
6798
  | boolean
5941
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
6799
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
6800
+ | `{${string}}`;
5942
6801
 
5943
6802
  /**
5944
6803
  * @deprecated - use dedicated properties above instead
5945
6804
  *
5946
6805
  * An object containing properties with information about the app, e.g. serviceUrl, numberUnit, ... .
5947
6806
  */
5948
- appData?: object | sap.ui.base.ManagedObject.PropertyBindingInfo;
6807
+ appData?:
6808
+ | object
6809
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
6810
+ | `{${string}}`;
5949
6811
  }
5950
6812
 
5951
6813
  /**
@@ -5989,6 +6851,8 @@ declare namespace sap {
5989
6851
  * enriches it with the information contained in `oClassInfo`.
5990
6852
  *
5991
6853
  * `oClassInfo` might contain the same kind of information as described in {@link sap.m.Button.extend}.
6854
+ *
6855
+ * @returns Created class / constructor function
5992
6856
  */
5993
6857
  static extend<T extends Record<string, unknown>>(
5994
6858
  /**
@@ -6010,12 +6874,16 @@ declare namespace sap {
6010
6874
  ): Function;
6011
6875
  /**
6012
6876
  * Returns a metadata object for class sap.ushell.ui.footerbar.AddBookmarkButton.
6877
+ *
6878
+ * @returns Metadata object describing this class
6013
6879
  */
6014
6880
  static getMetadata(): sap.ui.core.ElementMetadata;
6015
6881
  /**
6016
6882
  * Gets current value of property {@link #getAfterPressHandler afterPressHandler}.
6017
6883
  *
6018
6884
  * A callback function that is called after the save-as-tile dialog is closed.
6885
+ *
6886
+ * @returns Value of property `afterPressHandler`
6019
6887
  */
6020
6888
  getAfterPressHandler(): any;
6021
6889
  /**
@@ -6024,48 +6892,64 @@ declare namespace sap {
6024
6892
  * Gets current value of property {@link #getAppData appData}.
6025
6893
  *
6026
6894
  * An object containing properties with information about the app, e.g. serviceUrl, numberUnit, ... .
6895
+ *
6896
+ * @returns Value of property `appData`
6027
6897
  */
6028
6898
  getAppData(): object;
6029
6899
  /**
6030
6900
  * Gets current value of property {@link #getBeforePressHandler beforePressHandler}.
6031
6901
  *
6032
6902
  * A callback function that is called before the save-as-tile dialog is opened.
6903
+ *
6904
+ * @returns Value of property `beforePressHandler`
6033
6905
  */
6034
6906
  getBeforePressHandler(): Function;
6035
6907
  /**
6036
6908
  * Gets current value of property {@link #getCustomUrl customUrl}.
6037
6909
  *
6038
6910
  * A customized target URL for the tile.
6911
+ *
6912
+ * @returns Value of property `customUrl`
6039
6913
  */
6040
6914
  getCustomUrl(): any;
6041
6915
  /**
6042
6916
  * Gets current value of property {@link #getInfo info}.
6043
6917
  *
6044
6918
  * Text to be displayed at the bottom of the tile.
6919
+ *
6920
+ * @returns Value of property `info`
6045
6921
  */
6046
6922
  getInfo(): string;
6047
6923
  /**
6048
6924
  * Gets current value of property {@link #getKeywords keywords}.
6049
6925
  *
6050
6926
  * The keywords based on which the future tile should be indexed and filtered.
6927
+ *
6928
+ * @returns Value of property `keywords`
6051
6929
  */
6052
6930
  getKeywords(): string;
6053
6931
  /**
6054
6932
  * Gets current value of property {@link #getNumberUnit numberUnit}.
6055
6933
  *
6056
6934
  * For dynamic tile, the unit to be displayed below the number, for example, USD.
6935
+ *
6936
+ * @returns Value of property `numberUnit`
6057
6937
  */
6058
6938
  getNumberUnit(): string;
6059
6939
  /**
6060
6940
  * Gets current value of property {@link #getServiceRefreshInterval serviceRefreshInterval}.
6061
6941
  *
6062
6942
  * Number of seconds after which dynamic content is read from the data source and the display is refreshed.
6943
+ *
6944
+ * @returns Value of property `serviceRefreshInterval`
6063
6945
  */
6064
6946
  getServiceRefreshInterval(): string;
6065
6947
  /**
6066
6948
  * Gets current value of property {@link #getServiceUrl serviceUrl}.
6067
6949
  *
6068
6950
  * URL of an OData service from which data for a dynamic tile should be read.
6951
+ *
6952
+ * @returns Value of property `serviceUrl`
6069
6953
  */
6070
6954
  getServiceUrl(): any;
6071
6955
  /**
@@ -6074,6 +6958,8 @@ declare namespace sap {
6074
6958
  * Whether to display the control for group selection in the save-as-tile dialog in launchpad homepage mode.
6075
6959
  *
6076
6960
  * Default value is `true`.
6961
+ *
6962
+ * @returns Value of property `showGroupSelection`
6077
6963
  */
6078
6964
  getShowGroupSelection(): boolean;
6079
6965
  /**
@@ -6082,24 +6968,32 @@ declare namespace sap {
6082
6968
  * Whether to display the control for page selection in the save-bookmark dialog in launchpad spaces mode.
6083
6969
  *
6084
6970
  * Default value is `true`.
6971
+ *
6972
+ * @returns Value of property `showPageSelection`
6085
6973
  */
6086
6974
  getShowPageSelection(): boolean;
6087
6975
  /**
6088
6976
  * Gets current value of property {@link #getSubtitle subtitle}.
6089
6977
  *
6090
6978
  * Subtitle to be displayed below the tile title.
6979
+ *
6980
+ * @returns Value of property `subtitle`
6091
6981
  */
6092
6982
  getSubtitle(): string;
6093
6983
  /**
6094
6984
  * Gets current value of property {@link #getTileIcon tileIcon}.
6095
6985
  *
6096
6986
  * Icon to be displayed in the Tile.
6987
+ *
6988
+ * @returns Value of property `tileIcon`
6097
6989
  */
6098
6990
  getTileIcon(): string;
6099
6991
  /**
6100
6992
  * Gets current value of property {@link #getTitle title}.
6101
6993
  *
6102
6994
  * Title to be displayed on the tile.
6995
+ *
6996
+ * @returns Value of property `title`
6103
6997
  */
6104
6998
  getTitle(): string;
6105
6999
  /**
@@ -6108,6 +7002,8 @@ declare namespace sap {
6108
7002
  * A callback function that is called after the save-as-tile dialog is closed.
6109
7003
  *
6110
7004
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7005
+ *
7006
+ * @returns Reference to `this` in order to allow method chaining
6111
7007
  */
6112
7008
  setAfterPressHandler(
6113
7009
  /**
@@ -6123,6 +7019,8 @@ declare namespace sap {
6123
7019
  * An object containing properties with information about the app, e.g. serviceUrl, numberUnit, ... .
6124
7020
  *
6125
7021
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7022
+ *
7023
+ * @returns Reference to `this` in order to allow method chaining
6126
7024
  */
6127
7025
  setAppData(
6128
7026
  /**
@@ -6136,6 +7034,8 @@ declare namespace sap {
6136
7034
  * A callback function that is called before the save-as-tile dialog is opened.
6137
7035
  *
6138
7036
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7037
+ *
7038
+ * @returns Reference to `this` in order to allow method chaining
6139
7039
  */
6140
7040
  setBeforePressHandler(
6141
7041
  /**
@@ -6149,6 +7049,8 @@ declare namespace sap {
6149
7049
  * A customized target URL for the tile.
6150
7050
  *
6151
7051
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7052
+ *
7053
+ * @returns Reference to `this` in order to allow method chaining
6152
7054
  */
6153
7055
  setCustomUrl(
6154
7056
  /**
@@ -6162,6 +7064,8 @@ declare namespace sap {
6162
7064
  * Text to be displayed at the bottom of the tile.
6163
7065
  *
6164
7066
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7067
+ *
7068
+ * @returns Reference to `this` in order to allow method chaining
6165
7069
  */
6166
7070
  setInfo(
6167
7071
  /**
@@ -6175,6 +7079,8 @@ declare namespace sap {
6175
7079
  * The keywords based on which the future tile should be indexed and filtered.
6176
7080
  *
6177
7081
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7082
+ *
7083
+ * @returns Reference to `this` in order to allow method chaining
6178
7084
  */
6179
7085
  setKeywords(
6180
7086
  /**
@@ -6188,6 +7094,8 @@ declare namespace sap {
6188
7094
  * For dynamic tile, the unit to be displayed below the number, for example, USD.
6189
7095
  *
6190
7096
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7097
+ *
7098
+ * @returns Reference to `this` in order to allow method chaining
6191
7099
  */
6192
7100
  setNumberUnit(
6193
7101
  /**
@@ -6201,6 +7109,8 @@ declare namespace sap {
6201
7109
  * Number of seconds after which dynamic content is read from the data source and the display is refreshed.
6202
7110
  *
6203
7111
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7112
+ *
7113
+ * @returns Reference to `this` in order to allow method chaining
6204
7114
  */
6205
7115
  setServiceRefreshInterval(
6206
7116
  /**
@@ -6214,6 +7124,8 @@ declare namespace sap {
6214
7124
  * URL of an OData service from which data for a dynamic tile should be read.
6215
7125
  *
6216
7126
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7127
+ *
7128
+ * @returns Reference to `this` in order to allow method chaining
6217
7129
  */
6218
7130
  setServiceUrl(
6219
7131
  /**
@@ -6229,6 +7141,8 @@ declare namespace sap {
6229
7141
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6230
7142
  *
6231
7143
  * Default value is `true`.
7144
+ *
7145
+ * @returns Reference to `this` in order to allow method chaining
6232
7146
  */
6233
7147
  setShowGroupSelection(
6234
7148
  /**
@@ -6244,6 +7158,8 @@ declare namespace sap {
6244
7158
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6245
7159
  *
6246
7160
  * Default value is `true`.
7161
+ *
7162
+ * @returns Reference to `this` in order to allow method chaining
6247
7163
  */
6248
7164
  setShowPageSelection(
6249
7165
  /**
@@ -6257,6 +7173,8 @@ declare namespace sap {
6257
7173
  * Subtitle to be displayed below the tile title.
6258
7174
  *
6259
7175
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7176
+ *
7177
+ * @returns Reference to `this` in order to allow method chaining
6260
7178
  */
6261
7179
  setSubtitle(
6262
7180
  /**
@@ -6270,6 +7188,8 @@ declare namespace sap {
6270
7188
  * Icon to be displayed in the Tile.
6271
7189
  *
6272
7190
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7191
+ *
7192
+ * @returns Reference to `this` in order to allow method chaining
6273
7193
  */
6274
7194
  setTileIcon(
6275
7195
  /**
@@ -6283,6 +7203,8 @@ declare namespace sap {
6283
7203
  * Title to be displayed on the tile.
6284
7204
  *
6285
7205
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7206
+ *
7207
+ * @returns Reference to `this` in order to allow method chaining
6286
7208
  */
6287
7209
  setTitle(
6288
7210
  /**
@@ -6315,12 +7237,14 @@ declare namespace sap {
6315
7237
 
6316
7238
  _gridEnabled?:
6317
7239
  | boolean
6318
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
7240
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
7241
+ | `{${string}}`;
6319
7242
 
6320
7243
  groups?:
6321
7244
  | sap.ui.core.Control[]
6322
7245
  | sap.ui.core.Control
6323
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
7246
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
7247
+ | `{${string}}`;
6324
7248
 
6325
7249
  afterRendering?: (oEvent: sap.ui.base.Event) => void;
6326
7250
  }
@@ -6328,27 +7252,37 @@ declare namespace sap {
6328
7252
  interface $GridContainerSettings extends sap.ui.core.$ControlSettings {
6329
7253
  groupId?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
6330
7254
 
6331
- showHeader?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
7255
+ showHeader?:
7256
+ | boolean
7257
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
7258
+ | `{${string}}`;
6332
7259
 
6333
7260
  defaultGroup?:
6334
7261
  | boolean
6335
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
7262
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
7263
+ | `{${string}}`;
6336
7264
 
6337
- isLastGroup?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
7265
+ isLastGroup?:
7266
+ | boolean
7267
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
7268
+ | `{${string}}`;
6338
7269
 
6339
7270
  headerText?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
6340
7271
 
6341
7272
  headerLevel?:
6342
7273
  | sap.m.HeaderLevel
6343
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
7274
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
7275
+ | `{${string}}`;
6344
7276
 
6345
7277
  groupHeaderLevel?:
6346
7278
  | sap.m.HeaderLevel
6347
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
7279
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
7280
+ | `{${string}}`;
6348
7281
 
6349
7282
  showGroupHeader?:
6350
7283
  | boolean
6351
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
7284
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
7285
+ | `{${string}}`;
6352
7286
 
6353
7287
  homePageGroupDisplay?:
6354
7288
  | string
@@ -6356,41 +7290,60 @@ declare namespace sap {
6356
7290
 
6357
7291
  isGroupLocked?:
6358
7292
  | boolean
6359
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
7293
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
7294
+ | `{${string}}`;
6360
7295
 
6361
7296
  isGroupSelected?:
6362
7297
  | boolean
6363
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
7298
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
7299
+ | `{${string}}`;
6364
7300
 
6365
- editMode?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
7301
+ editMode?:
7302
+ | boolean
7303
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
7304
+ | `{${string}}`;
6366
7305
 
6367
7306
  showBackground?:
6368
7307
  | boolean
6369
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
7308
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
7309
+ | `{${string}}`;
6370
7310
 
6371
7311
  icon?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
6372
7312
 
6373
- showIcon?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
7313
+ showIcon?:
7314
+ | boolean
7315
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
7316
+ | `{${string}}`;
6374
7317
 
6375
- enableHelp?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
7318
+ enableHelp?:
7319
+ | boolean
7320
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
7321
+ | `{${string}}`;
6376
7322
 
6377
7323
  tileActionModeActive?:
6378
7324
  | boolean
6379
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
7325
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
7326
+ | `{${string}}`;
6380
7327
 
6381
- ieHtml5DnD?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
7328
+ ieHtml5DnD?:
7329
+ | boolean
7330
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
7331
+ | `{${string}}`;
6382
7332
 
6383
7333
  showEmptyLinksArea?:
6384
7334
  | boolean
6385
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
7335
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
7336
+ | `{${string}}`;
6386
7337
 
6387
7338
  showEmptyLinksAreaPlaceHolder?:
6388
7339
  | boolean
6389
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
7340
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
7341
+ | `{${string}}`;
6390
7342
 
6391
7343
  supportLinkPersonalization?:
6392
7344
  | boolean
6393
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
7345
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
7346
+ | `{${string}}`;
6394
7347
 
6395
7348
  tileSizeBehavior?:
6396
7349
  | string
@@ -6399,32 +7352,38 @@ declare namespace sap {
6399
7352
  tiles?:
6400
7353
  | sap.ui.core.Control[]
6401
7354
  | sap.ui.core.Control
6402
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
7355
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
7356
+ | `{${string}}`;
6403
7357
 
6404
7358
  links?:
6405
7359
  | sap.ui.core.Control[]
6406
7360
  | sap.ui.core.Control
6407
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
7361
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
7362
+ | `{${string}}`;
6408
7363
 
6409
7364
  beforeContent?:
6410
7365
  | sap.ui.core.Control[]
6411
7366
  | sap.ui.core.Control
6412
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
7367
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
7368
+ | `{${string}}`;
6413
7369
 
6414
7370
  afterContent?:
6415
7371
  | sap.ui.core.Control[]
6416
7372
  | sap.ui.core.Control
6417
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
7373
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
7374
+ | `{${string}}`;
6418
7375
 
6419
7376
  footerContent?:
6420
7377
  | sap.ui.core.Control[]
6421
7378
  | sap.ui.core.Control
6422
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
7379
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
7380
+ | `{${string}}`;
6423
7381
 
6424
7382
  headerActions?:
6425
7383
  | sap.ui.core.Control[]
6426
7384
  | sap.ui.core.Control
6427
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
7385
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
7386
+ | `{${string}}`;
6428
7387
 
6429
7388
  afterRendering?: (oEvent: sap.ui.base.Event) => void;
6430
7389
 
@@ -6449,31 +7408,44 @@ declare namespace sap {
6449
7408
 
6450
7409
  target?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
6451
7410
 
6452
- visible?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
7411
+ visible?:
7412
+ | boolean
7413
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
7414
+ | `{${string}}`;
6453
7415
 
6454
7416
  debugInfo?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
6455
7417
 
6456
7418
  animationRendered?:
6457
7419
  | boolean
6458
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
7420
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
7421
+ | `{${string}}`;
6459
7422
 
6460
- isLocked?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
7423
+ isLocked?:
7424
+ | boolean
7425
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
7426
+ | `{${string}}`;
6461
7427
 
6462
7428
  tileActionModeActive?:
6463
7429
  | boolean
6464
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
7430
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
7431
+ | `{${string}}`;
6465
7432
 
6466
- ieHtml5DnD?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
7433
+ ieHtml5DnD?:
7434
+ | boolean
7435
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
7436
+ | `{${string}}`;
6467
7437
 
6468
7438
  tileViews?:
6469
7439
  | sap.ui.core.Control[]
6470
7440
  | sap.ui.core.Control
6471
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
7441
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
7442
+ | `{${string}}`;
6472
7443
 
6473
7444
  footItems?:
6474
7445
  | sap.ui.core.Control[]
6475
7446
  | sap.ui.core.Control
6476
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
7447
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
7448
+ | `{${string}}`;
6477
7449
 
6478
7450
  press?: (oEvent: sap.ui.base.Event) => void;
6479
7451
 
@@ -6527,6 +7499,8 @@ declare namespace sap {
6527
7499
  * it with the information contained in `oClassInfo`.
6528
7500
  *
6529
7501
  * `oClassInfo` might contain the same kind of information as described in {@link sap.m.Button.extend}.
7502
+ *
7503
+ * @returns Created class / constructor function
6530
7504
  */
6531
7505
  static extend<T extends Record<string, unknown>>(
6532
7506
  /**
@@ -6545,6 +7519,8 @@ declare namespace sap {
6545
7519
  ): Function;
6546
7520
  /**
6547
7521
  * Returns a metadata object for class sap.ushell.ui.launchpad.ActionItem.
7522
+ *
7523
+ * @returns Metadata object describing this class
6548
7524
  */
6549
7525
  static getMetadata(): sap.ui.core.ElementMetadata;
6550
7526
  /**
@@ -6553,6 +7529,8 @@ declare namespace sap {
6553
7529
  *
6554
7530
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
6555
7531
  * otherwise it will be bound to this `sap.ushell.ui.launchpad.ActionItem` itself.
7532
+ *
7533
+ * @returns Reference to `this` in order to allow method chaining
6556
7534
  */
6557
7535
  attachAfterRendering(
6558
7536
  /**
@@ -6576,6 +7554,8 @@ declare namespace sap {
6576
7554
  *
6577
7555
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
6578
7556
  * otherwise it will be bound to this `sap.ushell.ui.launchpad.ActionItem` itself.
7557
+ *
7558
+ * @returns Reference to `this` in order to allow method chaining
6579
7559
  */
6580
7560
  attachAfterRendering(
6581
7561
  /**
@@ -6593,6 +7573,8 @@ declare namespace sap {
6593
7573
  *
6594
7574
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
6595
7575
  * otherwise it will be bound to this `sap.ushell.ui.launchpad.ActionItem` itself.
7576
+ *
7577
+ * @returns Reference to `this` in order to allow method chaining
6596
7578
  */
6597
7579
  attachPress(
6598
7580
  /**
@@ -6615,6 +7597,8 @@ declare namespace sap {
6615
7597
  *
6616
7598
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
6617
7599
  * otherwise it will be bound to this `sap.ushell.ui.launchpad.ActionItem` itself.
7600
+ *
7601
+ * @returns Reference to `this` in order to allow method chaining
6618
7602
  */
6619
7603
  attachPress(
6620
7604
  /**
@@ -6632,6 +7616,8 @@ declare namespace sap {
6632
7616
  * `sap.ushell.ui.launchpad.ActionItem`.
6633
7617
  *
6634
7618
  * The passed function and listener object must match the ones used for event registration.
7619
+ *
7620
+ * @returns Reference to `this` in order to allow method chaining
6635
7621
  */
6636
7622
  detachAfterRendering(
6637
7623
  /**
@@ -6647,6 +7633,8 @@ declare namespace sap {
6647
7633
  * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.ushell.ui.launchpad.ActionItem`.
6648
7634
  *
6649
7635
  * The passed function and listener object must match the ones used for event registration.
7636
+ *
7637
+ * @returns Reference to `this` in order to allow method chaining
6650
7638
  */
6651
7639
  detachPress(
6652
7640
  /**
@@ -6660,6 +7648,8 @@ declare namespace sap {
6660
7648
  ): this;
6661
7649
  /**
6662
7650
  * Fires event {@link #event:afterRendering afterRendering} to attached listeners.
7651
+ *
7652
+ * @returns Reference to `this` in order to allow method chaining
6663
7653
  */
6664
7654
  fireAfterRendering(
6665
7655
  /**
@@ -6669,6 +7659,8 @@ declare namespace sap {
6669
7659
  ): this;
6670
7660
  /**
6671
7661
  * Fires event {@link #event:press press} to attached listeners.
7662
+ *
7663
+ * @returns Reference to `this` in order to allow method chaining
6672
7664
  */
6673
7665
  firePress(
6674
7666
  /**
@@ -6680,6 +7672,8 @@ declare namespace sap {
6680
7672
  * Gets current value of property {@link #getActionType actionType}.
6681
7673
  *
6682
7674
  * Default value is `"standard"`.
7675
+ *
7676
+ * @returns Value of property `actionType`
6683
7677
  */
6684
7678
  getActionType(): string;
6685
7679
  /**
@@ -6688,6 +7682,8 @@ declare namespace sap {
6688
7682
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6689
7683
  *
6690
7684
  * Default value is `"standard"`.
7685
+ *
7686
+ * @returns Reference to `this` in order to allow method chaining
6691
7687
  */
6692
7688
  setActionType(
6693
7689
  /**
@@ -6734,6 +7730,8 @@ declare namespace sap {
6734
7730
  * and enriches it with the information contained in `oClassInfo`.
6735
7731
  *
6736
7732
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
7733
+ *
7734
+ * @returns Created class / constructor function
6737
7735
  */
6738
7736
  static extend<T extends Record<string, unknown>>(
6739
7737
  /**
@@ -6755,10 +7753,14 @@ declare namespace sap {
6755
7753
  ): Function;
6756
7754
  /**
6757
7755
  * Returns a metadata object for class sap.ushell.ui.launchpad.DashboardGroupsContainer.
7756
+ *
7757
+ * @returns Metadata object describing this class
6758
7758
  */
6759
7759
  static getMetadata(): sap.ui.core.ElementMetadata;
6760
7760
  /**
6761
7761
  * Adds some group to the aggregation {@link #getGroups groups}.
7762
+ *
7763
+ * @returns Reference to `this` in order to allow method chaining
6762
7764
  */
6763
7765
  addGroup(
6764
7766
  /**
@@ -6772,6 +7774,8 @@ declare namespace sap {
6772
7774
  *
6773
7775
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
6774
7776
  * otherwise it will be bound to this `sap.ushell.ui.launchpad.DashboardGroupsContainer` itself.
7777
+ *
7778
+ * @returns Reference to `this` in order to allow method chaining
6775
7779
  */
6776
7780
  attachAfterRendering(
6777
7781
  /**
@@ -6795,6 +7799,8 @@ declare namespace sap {
6795
7799
  *
6796
7800
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
6797
7801
  * otherwise it will be bound to this `sap.ushell.ui.launchpad.DashboardGroupsContainer` itself.
7802
+ *
7803
+ * @returns Reference to `this` in order to allow method chaining
6798
7804
  */
6799
7805
  attachAfterRendering(
6800
7806
  /**
@@ -6809,6 +7815,8 @@ declare namespace sap {
6809
7815
  ): this;
6810
7816
  /**
6811
7817
  * Destroys all the groups in the aggregation {@link #getGroups groups}.
7818
+ *
7819
+ * @returns Reference to `this` in order to allow method chaining
6812
7820
  */
6813
7821
  destroyGroups(): this;
6814
7822
  /**
@@ -6816,6 +7824,8 @@ declare namespace sap {
6816
7824
  * `sap.ushell.ui.launchpad.DashboardGroupsContainer`.
6817
7825
  *
6818
7826
  * The passed function and listener object must match the ones used for event registration.
7827
+ *
7828
+ * @returns Reference to `this` in order to allow method chaining
6819
7829
  */
6820
7830
  detachAfterRendering(
6821
7831
  /**
@@ -6829,6 +7839,8 @@ declare namespace sap {
6829
7839
  ): this;
6830
7840
  /**
6831
7841
  * Fires event {@link #event:afterRendering afterRendering} to attached listeners.
7842
+ *
7843
+ * @returns Reference to `this` in order to allow method chaining
6832
7844
  */
6833
7845
  fireAfterRendering(
6834
7846
  /**
@@ -6840,16 +7852,22 @@ declare namespace sap {
6840
7852
  * Gets current value of property {@link #get_gridEnabled _gridEnabled}.
6841
7853
  *
6842
7854
  * Default value is `false`.
7855
+ *
7856
+ * @returns Value of property `_gridEnabled`
6843
7857
  */
6844
7858
  get_gridEnabled(): boolean;
6845
7859
  /**
6846
7860
  * Gets current value of property {@link #getAccessibilityLabel accessibilityLabel}.
6847
7861
  *
6848
7862
  * A value for an optional accessibility label.
7863
+ *
7864
+ * @returns Value of property `accessibilityLabel`
6849
7865
  */
6850
7866
  getAccessibilityLabel(): string;
6851
7867
  /**
6852
7868
  * Gets current value of property {@link #getDisplayMode displayMode}.
7869
+ *
7870
+ * @returns Value of property `displayMode`
6853
7871
  */
6854
7872
  getDisplayMode(): string;
6855
7873
  /**
@@ -6859,6 +7877,8 @@ declare namespace sap {
6859
7877
  /**
6860
7878
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getGroups groups}. and returns
6861
7879
  * its index if found or -1 otherwise.
7880
+ *
7881
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
6862
7882
  */
6863
7883
  indexOfGroup(
6864
7884
  /**
@@ -6868,6 +7888,8 @@ declare namespace sap {
6868
7888
  ): int;
6869
7889
  /**
6870
7890
  * Inserts a group into the aggregation {@link #getGroups groups}.
7891
+ *
7892
+ * @returns Reference to `this` in order to allow method chaining
6871
7893
  */
6872
7894
  insertGroup(
6873
7895
  /**
@@ -6885,10 +7907,14 @@ declare namespace sap {
6885
7907
  * Removes all the controls from the aggregation {@link #getGroups groups}.
6886
7908
  *
6887
7909
  * Additionally, it unregisters them from the hosting UIArea.
7910
+ *
7911
+ * @returns An array of the removed elements (might be empty)
6888
7912
  */
6889
7913
  removeAllGroups(): sap.ui.core.Control[];
6890
7914
  /**
6891
7915
  * Removes a group from the aggregation {@link #getGroups groups}.
7916
+ *
7917
+ * @returns The removed group or `null`
6892
7918
  */
6893
7919
  removeGroup(
6894
7920
  /**
@@ -6902,6 +7928,8 @@ declare namespace sap {
6902
7928
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6903
7929
  *
6904
7930
  * Default value is `false`.
7931
+ *
7932
+ * @returns Reference to `this` in order to allow method chaining
6905
7933
  */
6906
7934
  set_gridEnabled(
6907
7935
  /**
@@ -6915,6 +7943,8 @@ declare namespace sap {
6915
7943
  * A value for an optional accessibility label.
6916
7944
  *
6917
7945
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7946
+ *
7947
+ * @returns Reference to `this` in order to allow method chaining
6918
7948
  */
6919
7949
  setAccessibilityLabel(
6920
7950
  /**
@@ -6926,6 +7956,8 @@ declare namespace sap {
6926
7956
  * Sets a new value for property {@link #getDisplayMode displayMode}.
6927
7957
  *
6928
7958
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7959
+ *
7960
+ * @returns Reference to `this` in order to allow method chaining
6929
7961
  */
6930
7962
  setDisplayMode(
6931
7963
  /**
@@ -6976,6 +8008,8 @@ declare namespace sap {
6976
8008
  * it with the information contained in `oClassInfo`.
6977
8009
  *
6978
8010
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
8011
+ *
8012
+ * @returns Created class / constructor function
6979
8013
  */
6980
8014
  static extend<T extends Record<string, unknown>>(
6981
8015
  /**
@@ -6997,10 +8031,14 @@ declare namespace sap {
6997
8031
  ): Function;
6998
8032
  /**
6999
8033
  * Returns a metadata object for class sap.ushell.ui.launchpad.GridContainer.
8034
+ *
8035
+ * @returns Metadata object describing this class
7000
8036
  */
7001
8037
  static getMetadata(): sap.ui.core.ElementMetadata;
7002
8038
  /**
7003
8039
  * Adds some afterContent to the aggregation {@link #getAfterContent afterContent}.
8040
+ *
8041
+ * @returns Reference to `this` in order to allow method chaining
7004
8042
  */
7005
8043
  addAfterContent(
7006
8044
  /**
@@ -7010,6 +8048,8 @@ declare namespace sap {
7010
8048
  ): this;
7011
8049
  /**
7012
8050
  * Adds some beforeContent to the aggregation {@link #getBeforeContent beforeContent}.
8051
+ *
8052
+ * @returns Reference to `this` in order to allow method chaining
7013
8053
  */
7014
8054
  addBeforeContent(
7015
8055
  /**
@@ -7019,6 +8059,8 @@ declare namespace sap {
7019
8059
  ): this;
7020
8060
  /**
7021
8061
  * Adds some footerContent to the aggregation {@link #getFooterContent footerContent}.
8062
+ *
8063
+ * @returns Reference to `this` in order to allow method chaining
7022
8064
  */
7023
8065
  addFooterContent(
7024
8066
  /**
@@ -7028,6 +8070,8 @@ declare namespace sap {
7028
8070
  ): this;
7029
8071
  /**
7030
8072
  * Adds some headerAction to the aggregation {@link #getHeaderActions headerActions}.
8073
+ *
8074
+ * @returns Reference to `this` in order to allow method chaining
7031
8075
  */
7032
8076
  addHeaderAction(
7033
8077
  /**
@@ -7037,6 +8081,8 @@ declare namespace sap {
7037
8081
  ): this;
7038
8082
  /**
7039
8083
  * Adds some link to the aggregation {@link #getLinks links}.
8084
+ *
8085
+ * @returns Reference to `this` in order to allow method chaining
7040
8086
  */
7041
8087
  addLink(
7042
8088
  /**
@@ -7046,6 +8092,8 @@ declare namespace sap {
7046
8092
  ): this;
7047
8093
  /**
7048
8094
  * Adds some tile to the aggregation {@link #getTiles tiles}.
8095
+ *
8096
+ * @returns Reference to `this` in order to allow method chaining
7049
8097
  */
7050
8098
  addTile(
7051
8099
  /**
@@ -7059,6 +8107,8 @@ declare namespace sap {
7059
8107
  *
7060
8108
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
7061
8109
  * otherwise it will be bound to this `sap.ushell.ui.launchpad.GridContainer` itself.
8110
+ *
8111
+ * @returns Reference to `this` in order to allow method chaining
7062
8112
  */
7063
8113
  attachAfterRendering(
7064
8114
  /**
@@ -7082,6 +8132,8 @@ declare namespace sap {
7082
8132
  *
7083
8133
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
7084
8134
  * otherwise it will be bound to this `sap.ushell.ui.launchpad.GridContainer` itself.
8135
+ *
8136
+ * @returns Reference to `this` in order to allow method chaining
7085
8137
  */
7086
8138
  attachAfterRendering(
7087
8139
  /**
@@ -7099,6 +8151,8 @@ declare namespace sap {
7099
8151
  *
7100
8152
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
7101
8153
  * otherwise it will be bound to this `sap.ushell.ui.launchpad.GridContainer` itself.
8154
+ *
8155
+ * @returns Reference to `this` in order to allow method chaining
7102
8156
  */
7103
8157
  attachLayoutChange(
7104
8158
  /**
@@ -7121,6 +8175,8 @@ declare namespace sap {
7121
8175
  *
7122
8176
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
7123
8177
  * otherwise it will be bound to this `sap.ushell.ui.launchpad.GridContainer` itself.
8178
+ *
8179
+ * @returns Reference to `this` in order to allow method chaining
7124
8180
  */
7125
8181
  attachLayoutChange(
7126
8182
  /**
@@ -7138,6 +8194,8 @@ declare namespace sap {
7138
8194
  *
7139
8195
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
7140
8196
  * otherwise it will be bound to this `sap.ushell.ui.launchpad.GridContainer` itself.
8197
+ *
8198
+ * @returns Reference to `this` in order to allow method chaining
7141
8199
  */
7142
8200
  attachTileDragEnter(
7143
8201
  /**
@@ -7160,6 +8218,8 @@ declare namespace sap {
7160
8218
  *
7161
8219
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
7162
8220
  * otherwise it will be bound to this `sap.ushell.ui.launchpad.GridContainer` itself.
8221
+ *
8222
+ * @returns Reference to `this` in order to allow method chaining
7163
8223
  */
7164
8224
  attachTileDragEnter(
7165
8225
  /**
@@ -7177,6 +8237,8 @@ declare namespace sap {
7177
8237
  *
7178
8238
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
7179
8239
  * otherwise it will be bound to this `sap.ushell.ui.launchpad.GridContainer` itself.
8240
+ *
8241
+ * @returns Reference to `this` in order to allow method chaining
7180
8242
  */
7181
8243
  attachTileDragStart(
7182
8244
  /**
@@ -7199,6 +8261,8 @@ declare namespace sap {
7199
8261
  *
7200
8262
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
7201
8263
  * otherwise it will be bound to this `sap.ushell.ui.launchpad.GridContainer` itself.
8264
+ *
8265
+ * @returns Reference to `this` in order to allow method chaining
7202
8266
  */
7203
8267
  attachTileDragStart(
7204
8268
  /**
@@ -7216,6 +8280,8 @@ declare namespace sap {
7216
8280
  *
7217
8281
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
7218
8282
  * otherwise it will be bound to this `sap.ushell.ui.launchpad.GridContainer` itself.
8283
+ *
8284
+ * @returns Reference to `this` in order to allow method chaining
7219
8285
  */
7220
8286
  attachTileDrop(
7221
8287
  /**
@@ -7238,6 +8304,8 @@ declare namespace sap {
7238
8304
  *
7239
8305
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
7240
8306
  * otherwise it will be bound to this `sap.ushell.ui.launchpad.GridContainer` itself.
8307
+ *
8308
+ * @returns Reference to `this` in order to allow method chaining
7241
8309
  */
7242
8310
  attachTileDrop(
7243
8311
  /**
@@ -7255,6 +8323,8 @@ declare namespace sap {
7255
8323
  *
7256
8324
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
7257
8325
  * otherwise it will be bound to this `sap.ushell.ui.launchpad.GridContainer` itself.
8326
+ *
8327
+ * @returns Reference to `this` in order to allow method chaining
7258
8328
  */
7259
8329
  attachTitleChange(
7260
8330
  /**
@@ -7277,6 +8347,8 @@ declare namespace sap {
7277
8347
  *
7278
8348
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
7279
8349
  * otherwise it will be bound to this `sap.ushell.ui.launchpad.GridContainer` itself.
8350
+ *
8351
+ * @returns Reference to `this` in order to allow method chaining
7280
8352
  */
7281
8353
  attachTitleChange(
7282
8354
  /**
@@ -7291,26 +8363,38 @@ declare namespace sap {
7291
8363
  ): this;
7292
8364
  /**
7293
8365
  * Destroys all the afterContent in the aggregation {@link #getAfterContent afterContent}.
8366
+ *
8367
+ * @returns Reference to `this` in order to allow method chaining
7294
8368
  */
7295
8369
  destroyAfterContent(): this;
7296
8370
  /**
7297
8371
  * Destroys all the beforeContent in the aggregation {@link #getBeforeContent beforeContent}.
8372
+ *
8373
+ * @returns Reference to `this` in order to allow method chaining
7298
8374
  */
7299
8375
  destroyBeforeContent(): this;
7300
8376
  /**
7301
8377
  * Destroys all the footerContent in the aggregation {@link #getFooterContent footerContent}.
8378
+ *
8379
+ * @returns Reference to `this` in order to allow method chaining
7302
8380
  */
7303
8381
  destroyFooterContent(): this;
7304
8382
  /**
7305
8383
  * Destroys all the headerActions in the aggregation {@link #getHeaderActions headerActions}.
8384
+ *
8385
+ * @returns Reference to `this` in order to allow method chaining
7306
8386
  */
7307
8387
  destroyHeaderActions(): this;
7308
8388
  /**
7309
8389
  * Destroys all the links in the aggregation {@link #getLinks links}.
8390
+ *
8391
+ * @returns Reference to `this` in order to allow method chaining
7310
8392
  */
7311
8393
  destroyLinks(): this;
7312
8394
  /**
7313
8395
  * Destroys all the tiles in the aggregation {@link #getTiles tiles}.
8396
+ *
8397
+ * @returns Reference to `this` in order to allow method chaining
7314
8398
  */
7315
8399
  destroyTiles(): this;
7316
8400
  /**
@@ -7318,6 +8402,8 @@ declare namespace sap {
7318
8402
  * `sap.ushell.ui.launchpad.GridContainer`.
7319
8403
  *
7320
8404
  * The passed function and listener object must match the ones used for event registration.
8405
+ *
8406
+ * @returns Reference to `this` in order to allow method chaining
7321
8407
  */
7322
8408
  detachAfterRendering(
7323
8409
  /**
@@ -7333,6 +8419,8 @@ declare namespace sap {
7333
8419
  * Detaches event handler `fnFunction` from the {@link #event:layoutChange layoutChange} event of this `sap.ushell.ui.launchpad.GridContainer`.
7334
8420
  *
7335
8421
  * The passed function and listener object must match the ones used for event registration.
8422
+ *
8423
+ * @returns Reference to `this` in order to allow method chaining
7336
8424
  */
7337
8425
  detachLayoutChange(
7338
8426
  /**
@@ -7349,6 +8437,8 @@ declare namespace sap {
7349
8437
  * `sap.ushell.ui.launchpad.GridContainer`.
7350
8438
  *
7351
8439
  * The passed function and listener object must match the ones used for event registration.
8440
+ *
8441
+ * @returns Reference to `this` in order to allow method chaining
7352
8442
  */
7353
8443
  detachTileDragEnter(
7354
8444
  /**
@@ -7365,6 +8455,8 @@ declare namespace sap {
7365
8455
  * `sap.ushell.ui.launchpad.GridContainer`.
7366
8456
  *
7367
8457
  * The passed function and listener object must match the ones used for event registration.
8458
+ *
8459
+ * @returns Reference to `this` in order to allow method chaining
7368
8460
  */
7369
8461
  detachTileDragStart(
7370
8462
  /**
@@ -7380,6 +8472,8 @@ declare namespace sap {
7380
8472
  * Detaches event handler `fnFunction` from the {@link #event:tileDrop tileDrop} event of this `sap.ushell.ui.launchpad.GridContainer`.
7381
8473
  *
7382
8474
  * The passed function and listener object must match the ones used for event registration.
8475
+ *
8476
+ * @returns Reference to `this` in order to allow method chaining
7383
8477
  */
7384
8478
  detachTileDrop(
7385
8479
  /**
@@ -7395,6 +8489,8 @@ declare namespace sap {
7395
8489
  * Detaches event handler `fnFunction` from the {@link #event:titleChange titleChange} event of this `sap.ushell.ui.launchpad.GridContainer`.
7396
8490
  *
7397
8491
  * The passed function and listener object must match the ones used for event registration.
8492
+ *
8493
+ * @returns Reference to `this` in order to allow method chaining
7398
8494
  */
7399
8495
  detachTitleChange(
7400
8496
  /**
@@ -7408,6 +8504,8 @@ declare namespace sap {
7408
8504
  ): this;
7409
8505
  /**
7410
8506
  * Fires event {@link #event:afterRendering afterRendering} to attached listeners.
8507
+ *
8508
+ * @returns Reference to `this` in order to allow method chaining
7411
8509
  */
7412
8510
  fireAfterRendering(
7413
8511
  /**
@@ -7417,6 +8515,8 @@ declare namespace sap {
7417
8515
  ): this;
7418
8516
  /**
7419
8517
  * Fires event {@link #event:layoutChange layoutChange} to attached listeners.
8518
+ *
8519
+ * @returns Reference to `this` in order to allow method chaining
7420
8520
  */
7421
8521
  fireLayoutChange(
7422
8522
  /**
@@ -7426,6 +8526,8 @@ declare namespace sap {
7426
8526
  ): this;
7427
8527
  /**
7428
8528
  * Fires event {@link #event:tileDragEnter tileDragEnter} to attached listeners.
8529
+ *
8530
+ * @returns Reference to `this` in order to allow method chaining
7429
8531
  */
7430
8532
  fireTileDragEnter(
7431
8533
  /**
@@ -7435,6 +8537,8 @@ declare namespace sap {
7435
8537
  ): this;
7436
8538
  /**
7437
8539
  * Fires event {@link #event:tileDragStart tileDragStart} to attached listeners.
8540
+ *
8541
+ * @returns Reference to `this` in order to allow method chaining
7438
8542
  */
7439
8543
  fireTileDragStart(
7440
8544
  /**
@@ -7444,6 +8548,8 @@ declare namespace sap {
7444
8548
  ): this;
7445
8549
  /**
7446
8550
  * Fires event {@link #event:tileDrop tileDrop} to attached listeners.
8551
+ *
8552
+ * @returns Reference to `this` in order to allow method chaining
7447
8553
  */
7448
8554
  fireTileDrop(
7449
8555
  /**
@@ -7453,6 +8559,8 @@ declare namespace sap {
7453
8559
  ): this;
7454
8560
  /**
7455
8561
  * Fires event {@link #event:titleChange titleChange} to attached listeners.
8562
+ *
8563
+ * @returns Reference to `this` in order to allow method chaining
7456
8564
  */
7457
8565
  fireTitleChange(
7458
8566
  /**
@@ -7472,18 +8580,24 @@ declare namespace sap {
7472
8580
  * Gets current value of property {@link #getDefaultGroup defaultGroup}.
7473
8581
  *
7474
8582
  * Default value is `false`.
8583
+ *
8584
+ * @returns Value of property `defaultGroup`
7475
8585
  */
7476
8586
  getDefaultGroup(): boolean;
7477
8587
  /**
7478
8588
  * Gets current value of property {@link #getEditMode editMode}.
7479
8589
  *
7480
8590
  * Default value is `false`.
8591
+ *
8592
+ * @returns Value of property `editMode`
7481
8593
  */
7482
8594
  getEditMode(): boolean;
7483
8595
  /**
7484
8596
  * Gets current value of property {@link #getEnableHelp enableHelp}.
7485
8597
  *
7486
8598
  * Default value is `false`.
8599
+ *
8600
+ * @returns Value of property `enableHelp`
7487
8601
  */
7488
8602
  getEnableHelp(): boolean;
7489
8603
  /**
@@ -7494,10 +8608,14 @@ declare namespace sap {
7494
8608
  * Gets current value of property {@link #getGroupHeaderLevel groupHeaderLevel}.
7495
8609
  *
7496
8610
  * Default value is `H4`.
8611
+ *
8612
+ * @returns Value of property `groupHeaderLevel`
7497
8613
  */
7498
8614
  getGroupHeaderLevel(): sap.m.HeaderLevel;
7499
8615
  /**
7500
8616
  * Gets current value of property {@link #getGroupId groupId}.
8617
+ *
8618
+ * @returns Value of property `groupId`
7501
8619
  */
7502
8620
  getGroupId(): string;
7503
8621
  /**
@@ -7508,42 +8626,58 @@ declare namespace sap {
7508
8626
  * Gets current value of property {@link #getHeaderLevel headerLevel}.
7509
8627
  *
7510
8628
  * Default value is `H2`.
8629
+ *
8630
+ * @returns Value of property `headerLevel`
7511
8631
  */
7512
8632
  getHeaderLevel(): sap.m.HeaderLevel;
7513
8633
  /**
7514
8634
  * Gets current value of property {@link #getHeaderText headerText}.
8635
+ *
8636
+ * @returns Value of property `headerText`
7515
8637
  */
7516
8638
  getHeaderText(): string;
7517
8639
  /**
7518
8640
  * Gets current value of property {@link #getHomePageGroupDisplay homePageGroupDisplay}.
8641
+ *
8642
+ * @returns Value of property `homePageGroupDisplay`
7519
8643
  */
7520
8644
  getHomePageGroupDisplay(): string;
7521
8645
  /**
7522
8646
  * Gets current value of property {@link #getIcon icon}.
7523
8647
  *
7524
8648
  * Default value is `"sap-icon://locked"`.
8649
+ *
8650
+ * @returns Value of property `icon`
7525
8651
  */
7526
8652
  getIcon(): string;
7527
8653
  /**
7528
8654
  * Gets current value of property {@link #getIeHtml5DnD ieHtml5DnD}.
7529
8655
  *
7530
8656
  * Default value is `false`.
8657
+ *
8658
+ * @returns Value of property `ieHtml5DnD`
7531
8659
  */
7532
8660
  getIeHtml5DnD(): boolean;
7533
8661
  /**
7534
8662
  * Gets current value of property {@link #getIsGroupLocked isGroupLocked}.
8663
+ *
8664
+ * @returns Value of property `isGroupLocked`
7535
8665
  */
7536
8666
  getIsGroupLocked(): boolean;
7537
8667
  /**
7538
8668
  * Gets current value of property {@link #getIsGroupSelected isGroupSelected}.
7539
8669
  *
7540
8670
  * Default value is `false`.
8671
+ *
8672
+ * @returns Value of property `isGroupSelected`
7541
8673
  */
7542
8674
  getIsGroupSelected(): boolean;
7543
8675
  /**
7544
8676
  * Gets current value of property {@link #getIsLastGroup isLastGroup}.
7545
8677
  *
7546
8678
  * Default value is `false`.
8679
+ *
8680
+ * @returns Value of property `isLastGroup`
7547
8681
  */
7548
8682
  getIsLastGroup(): boolean;
7549
8683
  /**
@@ -7554,48 +8688,64 @@ declare namespace sap {
7554
8688
  * Gets current value of property {@link #getShowBackground showBackground}.
7555
8689
  *
7556
8690
  * Default value is `false`.
8691
+ *
8692
+ * @returns Value of property `showBackground`
7557
8693
  */
7558
8694
  getShowBackground(): boolean;
7559
8695
  /**
7560
8696
  * Gets current value of property {@link #getShowEmptyLinksArea showEmptyLinksArea}.
7561
8697
  *
7562
8698
  * Default value is `false`.
8699
+ *
8700
+ * @returns Value of property `showEmptyLinksArea`
7563
8701
  */
7564
8702
  getShowEmptyLinksArea(): boolean;
7565
8703
  /**
7566
8704
  * Gets current value of property {@link #getShowEmptyLinksAreaPlaceHolder showEmptyLinksAreaPlaceHolder}.
7567
8705
  *
7568
8706
  * Default value is `false`.
8707
+ *
8708
+ * @returns Value of property `showEmptyLinksAreaPlaceHolder`
7569
8709
  */
7570
8710
  getShowEmptyLinksAreaPlaceHolder(): boolean;
7571
8711
  /**
7572
8712
  * Gets current value of property {@link #getShowGroupHeader showGroupHeader}.
7573
8713
  *
7574
8714
  * Default value is `true`.
8715
+ *
8716
+ * @returns Value of property `showGroupHeader`
7575
8717
  */
7576
8718
  getShowGroupHeader(): boolean;
7577
8719
  /**
7578
8720
  * Gets current value of property {@link #getShowHeader showHeader}.
7579
8721
  *
7580
8722
  * Default value is `true`.
8723
+ *
8724
+ * @returns Value of property `showHeader`
7581
8725
  */
7582
8726
  getShowHeader(): boolean;
7583
8727
  /**
7584
8728
  * Gets current value of property {@link #getShowIcon showIcon}.
7585
8729
  *
7586
8730
  * Default value is `false`.
8731
+ *
8732
+ * @returns Value of property `showIcon`
7587
8733
  */
7588
8734
  getShowIcon(): boolean;
7589
8735
  /**
7590
8736
  * Gets current value of property {@link #getSupportLinkPersonalization supportLinkPersonalization}.
7591
8737
  *
7592
8738
  * Default value is `false`.
8739
+ *
8740
+ * @returns Value of property `supportLinkPersonalization`
7593
8741
  */
7594
8742
  getSupportLinkPersonalization(): boolean;
7595
8743
  /**
7596
8744
  * Gets current value of property {@link #getTileActionModeActive tileActionModeActive}.
7597
8745
  *
7598
8746
  * Default value is `false`.
8747
+ *
8748
+ * @returns Value of property `tileActionModeActive`
7599
8749
  */
7600
8750
  getTileActionModeActive(): boolean;
7601
8751
  /**
@@ -7606,11 +8756,15 @@ declare namespace sap {
7606
8756
  * Gets current value of property {@link #getTileSizeBehavior tileSizeBehavior}.
7607
8757
  *
7608
8758
  * Default value is `TILE_SIZE_BEHAVIOR.RESPONSIVE`.
8759
+ *
8760
+ * @returns Value of property `tileSizeBehavior`
7609
8761
  */
7610
8762
  getTileSizeBehavior(): string;
7611
8763
  /**
7612
8764
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getAfterContent afterContent}.
7613
8765
  * and returns its index if found or -1 otherwise.
8766
+ *
8767
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
7614
8768
  */
7615
8769
  indexOfAfterContent(
7616
8770
  /**
@@ -7621,6 +8775,8 @@ declare namespace sap {
7621
8775
  /**
7622
8776
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getBeforeContent beforeContent}.
7623
8777
  * and returns its index if found or -1 otherwise.
8778
+ *
8779
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
7624
8780
  */
7625
8781
  indexOfBeforeContent(
7626
8782
  /**
@@ -7631,6 +8787,8 @@ declare namespace sap {
7631
8787
  /**
7632
8788
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getFooterContent footerContent}.
7633
8789
  * and returns its index if found or -1 otherwise.
8790
+ *
8791
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
7634
8792
  */
7635
8793
  indexOfFooterContent(
7636
8794
  /**
@@ -7641,6 +8799,8 @@ declare namespace sap {
7641
8799
  /**
7642
8800
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getHeaderActions headerActions}.
7643
8801
  * and returns its index if found or -1 otherwise.
8802
+ *
8803
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
7644
8804
  */
7645
8805
  indexOfHeaderAction(
7646
8806
  /**
@@ -7651,6 +8811,8 @@ declare namespace sap {
7651
8811
  /**
7652
8812
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getLinks links}. and returns
7653
8813
  * its index if found or -1 otherwise.
8814
+ *
8815
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
7654
8816
  */
7655
8817
  indexOfLink(
7656
8818
  /**
@@ -7661,6 +8823,8 @@ declare namespace sap {
7661
8823
  /**
7662
8824
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getTiles tiles}. and returns
7663
8825
  * its index if found or -1 otherwise.
8826
+ *
8827
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
7664
8828
  */
7665
8829
  indexOfTile(
7666
8830
  /**
@@ -7670,6 +8834,8 @@ declare namespace sap {
7670
8834
  ): int;
7671
8835
  /**
7672
8836
  * Inserts a afterContent into the aggregation {@link #getAfterContent afterContent}.
8837
+ *
8838
+ * @returns Reference to `this` in order to allow method chaining
7673
8839
  */
7674
8840
  insertAfterContent(
7675
8841
  /**
@@ -7685,6 +8851,8 @@ declare namespace sap {
7685
8851
  ): this;
7686
8852
  /**
7687
8853
  * Inserts a beforeContent into the aggregation {@link #getBeforeContent beforeContent}.
8854
+ *
8855
+ * @returns Reference to `this` in order to allow method chaining
7688
8856
  */
7689
8857
  insertBeforeContent(
7690
8858
  /**
@@ -7700,6 +8868,8 @@ declare namespace sap {
7700
8868
  ): this;
7701
8869
  /**
7702
8870
  * Inserts a footerContent into the aggregation {@link #getFooterContent footerContent}.
8871
+ *
8872
+ * @returns Reference to `this` in order to allow method chaining
7703
8873
  */
7704
8874
  insertFooterContent(
7705
8875
  /**
@@ -7715,6 +8885,8 @@ declare namespace sap {
7715
8885
  ): this;
7716
8886
  /**
7717
8887
  * Inserts a headerAction into the aggregation {@link #getHeaderActions headerActions}.
8888
+ *
8889
+ * @returns Reference to `this` in order to allow method chaining
7718
8890
  */
7719
8891
  insertHeaderAction(
7720
8892
  /**
@@ -7730,6 +8902,8 @@ declare namespace sap {
7730
8902
  ): this;
7731
8903
  /**
7732
8904
  * Inserts a link into the aggregation {@link #getLinks links}.
8905
+ *
8906
+ * @returns Reference to `this` in order to allow method chaining
7733
8907
  */
7734
8908
  insertLink(
7735
8909
  /**
@@ -7745,6 +8919,8 @@ declare namespace sap {
7745
8919
  ): this;
7746
8920
  /**
7747
8921
  * Inserts a tile into the aggregation {@link #getTiles tiles}.
8922
+ *
8923
+ * @returns Reference to `this` in order to allow method chaining
7748
8924
  */
7749
8925
  insertTile(
7750
8926
  /**
@@ -7760,6 +8936,8 @@ declare namespace sap {
7760
8936
  ): this;
7761
8937
  /**
7762
8938
  * Removes a afterContent from the aggregation {@link #getAfterContent afterContent}.
8939
+ *
8940
+ * @returns The removed afterContent or `null`
7763
8941
  */
7764
8942
  removeAfterContent(
7765
8943
  /**
@@ -7771,40 +8949,54 @@ declare namespace sap {
7771
8949
  * Removes all the controls from the aggregation {@link #getAfterContent afterContent}.
7772
8950
  *
7773
8951
  * Additionally, it unregisters them from the hosting UIArea.
8952
+ *
8953
+ * @returns An array of the removed elements (might be empty)
7774
8954
  */
7775
8955
  removeAllAfterContent(): sap.ui.core.Control[];
7776
8956
  /**
7777
8957
  * Removes all the controls from the aggregation {@link #getBeforeContent beforeContent}.
7778
8958
  *
7779
8959
  * Additionally, it unregisters them from the hosting UIArea.
8960
+ *
8961
+ * @returns An array of the removed elements (might be empty)
7780
8962
  */
7781
8963
  removeAllBeforeContent(): sap.ui.core.Control[];
7782
8964
  /**
7783
8965
  * Removes all the controls from the aggregation {@link #getFooterContent footerContent}.
7784
8966
  *
7785
8967
  * Additionally, it unregisters them from the hosting UIArea.
8968
+ *
8969
+ * @returns An array of the removed elements (might be empty)
7786
8970
  */
7787
8971
  removeAllFooterContent(): sap.ui.core.Control[];
7788
8972
  /**
7789
8973
  * Removes all the controls from the aggregation {@link #getHeaderActions headerActions}.
7790
8974
  *
7791
8975
  * Additionally, it unregisters them from the hosting UIArea.
8976
+ *
8977
+ * @returns An array of the removed elements (might be empty)
7792
8978
  */
7793
8979
  removeAllHeaderActions(): sap.ui.core.Control[];
7794
8980
  /**
7795
8981
  * Removes all the controls from the aggregation {@link #getLinks links}.
7796
8982
  *
7797
8983
  * Additionally, it unregisters them from the hosting UIArea.
8984
+ *
8985
+ * @returns An array of the removed elements (might be empty)
7798
8986
  */
7799
8987
  removeAllLinks(): sap.ui.core.Control[];
7800
8988
  /**
7801
8989
  * Removes all the controls from the aggregation {@link #getTiles tiles}.
7802
8990
  *
7803
8991
  * Additionally, it unregisters them from the hosting UIArea.
8992
+ *
8993
+ * @returns An array of the removed elements (might be empty)
7804
8994
  */
7805
8995
  removeAllTiles(): sap.ui.core.Control[];
7806
8996
  /**
7807
8997
  * Removes a beforeContent from the aggregation {@link #getBeforeContent beforeContent}.
8998
+ *
8999
+ * @returns The removed beforeContent or `null`
7808
9000
  */
7809
9001
  removeBeforeContent(
7810
9002
  /**
@@ -7814,6 +9006,8 @@ declare namespace sap {
7814
9006
  ): sap.ui.core.Control;
7815
9007
  /**
7816
9008
  * Removes a footerContent from the aggregation {@link #getFooterContent footerContent}.
9009
+ *
9010
+ * @returns The removed footerContent or `null`
7817
9011
  */
7818
9012
  removeFooterContent(
7819
9013
  /**
@@ -7823,6 +9017,8 @@ declare namespace sap {
7823
9017
  ): sap.ui.core.Control;
7824
9018
  /**
7825
9019
  * Removes a headerAction from the aggregation {@link #getHeaderActions headerActions}.
9020
+ *
9021
+ * @returns The removed headerAction or `null`
7826
9022
  */
7827
9023
  removeHeaderAction(
7828
9024
  /**
@@ -7832,6 +9028,8 @@ declare namespace sap {
7832
9028
  ): sap.ui.core.Control;
7833
9029
  /**
7834
9030
  * Removes a link from the aggregation {@link #getLinks links}.
9031
+ *
9032
+ * @returns The removed link or `null`
7835
9033
  */
7836
9034
  removeLink(
7837
9035
  /**
@@ -7841,6 +9039,8 @@ declare namespace sap {
7841
9039
  ): sap.ui.core.Control;
7842
9040
  /**
7843
9041
  * Removes a tile from the aggregation {@link #getTiles tiles}.
9042
+ *
9043
+ * @returns The removed tile or `null`
7844
9044
  */
7845
9045
  removeTile(
7846
9046
  /**
@@ -7854,6 +9054,8 @@ declare namespace sap {
7854
9054
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7855
9055
  *
7856
9056
  * Default value is `false`.
9057
+ *
9058
+ * @returns Reference to `this` in order to allow method chaining
7857
9059
  */
7858
9060
  setDefaultGroup(
7859
9061
  /**
@@ -7867,6 +9069,8 @@ declare namespace sap {
7867
9069
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7868
9070
  *
7869
9071
  * Default value is `false`.
9072
+ *
9073
+ * @returns Reference to `this` in order to allow method chaining
7870
9074
  */
7871
9075
  setEditMode(
7872
9076
  /**
@@ -7880,6 +9084,8 @@ declare namespace sap {
7880
9084
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7881
9085
  *
7882
9086
  * Default value is `false`.
9087
+ *
9088
+ * @returns Reference to `this` in order to allow method chaining
7883
9089
  */
7884
9090
  setEnableHelp(
7885
9091
  /**
@@ -7893,6 +9099,8 @@ declare namespace sap {
7893
9099
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7894
9100
  *
7895
9101
  * Default value is `H4`.
9102
+ *
9103
+ * @returns Reference to `this` in order to allow method chaining
7896
9104
  */
7897
9105
  setGroupHeaderLevel(
7898
9106
  /**
@@ -7904,6 +9112,8 @@ declare namespace sap {
7904
9112
  * Sets a new value for property {@link #getGroupId groupId}.
7905
9113
  *
7906
9114
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9115
+ *
9116
+ * @returns Reference to `this` in order to allow method chaining
7907
9117
  */
7908
9118
  setGroupId(
7909
9119
  /**
@@ -7917,6 +9127,8 @@ declare namespace sap {
7917
9127
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7918
9128
  *
7919
9129
  * Default value is `H2`.
9130
+ *
9131
+ * @returns Reference to `this` in order to allow method chaining
7920
9132
  */
7921
9133
  setHeaderLevel(
7922
9134
  /**
@@ -7928,6 +9140,8 @@ declare namespace sap {
7928
9140
  * Sets a new value for property {@link #getHeaderText headerText}.
7929
9141
  *
7930
9142
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9143
+ *
9144
+ * @returns Reference to `this` in order to allow method chaining
7931
9145
  */
7932
9146
  setHeaderText(
7933
9147
  /**
@@ -7939,6 +9153,8 @@ declare namespace sap {
7939
9153
  * Sets a new value for property {@link #getHomePageGroupDisplay homePageGroupDisplay}.
7940
9154
  *
7941
9155
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9156
+ *
9157
+ * @returns Reference to `this` in order to allow method chaining
7942
9158
  */
7943
9159
  setHomePageGroupDisplay(
7944
9160
  /**
@@ -7952,6 +9168,8 @@ declare namespace sap {
7952
9168
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7953
9169
  *
7954
9170
  * Default value is `"sap-icon://locked"`.
9171
+ *
9172
+ * @returns Reference to `this` in order to allow method chaining
7955
9173
  */
7956
9174
  setIcon(
7957
9175
  /**
@@ -7965,6 +9183,8 @@ declare namespace sap {
7965
9183
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7966
9184
  *
7967
9185
  * Default value is `false`.
9186
+ *
9187
+ * @returns Reference to `this` in order to allow method chaining
7968
9188
  */
7969
9189
  setIeHtml5DnD(
7970
9190
  /**
@@ -7976,6 +9196,8 @@ declare namespace sap {
7976
9196
  * Sets a new value for property {@link #getIsGroupLocked isGroupLocked}.
7977
9197
  *
7978
9198
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9199
+ *
9200
+ * @returns Reference to `this` in order to allow method chaining
7979
9201
  */
7980
9202
  setIsGroupLocked(
7981
9203
  /**
@@ -7989,6 +9211,8 @@ declare namespace sap {
7989
9211
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7990
9212
  *
7991
9213
  * Default value is `false`.
9214
+ *
9215
+ * @returns Reference to `this` in order to allow method chaining
7992
9216
  */
7993
9217
  setIsGroupSelected(
7994
9218
  /**
@@ -8002,6 +9226,8 @@ declare namespace sap {
8002
9226
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8003
9227
  *
8004
9228
  * Default value is `false`.
9229
+ *
9230
+ * @returns Reference to `this` in order to allow method chaining
8005
9231
  */
8006
9232
  setIsLastGroup(
8007
9233
  /**
@@ -8015,6 +9241,8 @@ declare namespace sap {
8015
9241
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8016
9242
  *
8017
9243
  * Default value is `false`.
9244
+ *
9245
+ * @returns Reference to `this` in order to allow method chaining
8018
9246
  */
8019
9247
  setShowBackground(
8020
9248
  /**
@@ -8028,6 +9256,8 @@ declare namespace sap {
8028
9256
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8029
9257
  *
8030
9258
  * Default value is `false`.
9259
+ *
9260
+ * @returns Reference to `this` in order to allow method chaining
8031
9261
  */
8032
9262
  setShowEmptyLinksArea(
8033
9263
  /**
@@ -8041,6 +9271,8 @@ declare namespace sap {
8041
9271
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8042
9272
  *
8043
9273
  * Default value is `false`.
9274
+ *
9275
+ * @returns Reference to `this` in order to allow method chaining
8044
9276
  */
8045
9277
  setShowEmptyLinksAreaPlaceHolder(
8046
9278
  /**
@@ -8054,6 +9286,8 @@ declare namespace sap {
8054
9286
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8055
9287
  *
8056
9288
  * Default value is `true`.
9289
+ *
9290
+ * @returns Reference to `this` in order to allow method chaining
8057
9291
  */
8058
9292
  setShowGroupHeader(
8059
9293
  /**
@@ -8067,6 +9301,8 @@ declare namespace sap {
8067
9301
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8068
9302
  *
8069
9303
  * Default value is `true`.
9304
+ *
9305
+ * @returns Reference to `this` in order to allow method chaining
8070
9306
  */
8071
9307
  setShowHeader(
8072
9308
  /**
@@ -8080,6 +9316,8 @@ declare namespace sap {
8080
9316
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8081
9317
  *
8082
9318
  * Default value is `false`.
9319
+ *
9320
+ * @returns Reference to `this` in order to allow method chaining
8083
9321
  */
8084
9322
  setShowIcon(
8085
9323
  /**
@@ -8093,6 +9331,8 @@ declare namespace sap {
8093
9331
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8094
9332
  *
8095
9333
  * Default value is `false`.
9334
+ *
9335
+ * @returns Reference to `this` in order to allow method chaining
8096
9336
  */
8097
9337
  setSupportLinkPersonalization(
8098
9338
  /**
@@ -8106,6 +9346,8 @@ declare namespace sap {
8106
9346
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8107
9347
  *
8108
9348
  * Default value is `false`.
9349
+ *
9350
+ * @returns Reference to `this` in order to allow method chaining
8109
9351
  */
8110
9352
  setTileActionModeActive(
8111
9353
  /**
@@ -8119,6 +9361,8 @@ declare namespace sap {
8119
9361
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8120
9362
  *
8121
9363
  * Default value is `TILE_SIZE_BEHAVIOR.RESPONSIVE`.
9364
+ *
9365
+ * @returns Reference to `this` in order to allow method chaining
8122
9366
  */
8123
9367
  setTileSizeBehavior(
8124
9368
  /**
@@ -8167,6 +9411,8 @@ declare namespace sap {
8167
9411
  * it with the information contained in `oClassInfo`.
8168
9412
  *
8169
9413
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
9414
+ *
9415
+ * @returns Created class / constructor function
8170
9416
  */
8171
9417
  static extend<T extends Record<string, unknown>>(
8172
9418
  /**
@@ -8188,10 +9434,14 @@ declare namespace sap {
8188
9434
  ): Function;
8189
9435
  /**
8190
9436
  * Returns a metadata object for class sap.ushell.ui.launchpad.LinkTileWrapper.
9437
+ *
9438
+ * @returns Metadata object describing this class
8191
9439
  */
8192
9440
  static getMetadata(): sap.ui.core.ElementMetadata;
8193
9441
  /**
8194
9442
  * Adds some footItem to the aggregation {@link #getFootItems footItems}.
9443
+ *
9444
+ * @returns Reference to `this` in order to allow method chaining
8195
9445
  */
8196
9446
  addFootItem(
8197
9447
  /**
@@ -8201,6 +9451,8 @@ declare namespace sap {
8201
9451
  ): this;
8202
9452
  /**
8203
9453
  * Adds some tileView to the aggregation {@link #getTileViews tileViews}.
9454
+ *
9455
+ * @returns Reference to `this` in order to allow method chaining
8204
9456
  */
8205
9457
  addTileView(
8206
9458
  /**
@@ -8214,6 +9466,8 @@ declare namespace sap {
8214
9466
  *
8215
9467
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
8216
9468
  * otherwise it will be bound to this `sap.ushell.ui.launchpad.LinkTileWrapper` itself.
9469
+ *
9470
+ * @returns Reference to `this` in order to allow method chaining
8217
9471
  */
8218
9472
  attachAfterRendering(
8219
9473
  /**
@@ -8237,6 +9491,8 @@ declare namespace sap {
8237
9491
  *
8238
9492
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
8239
9493
  * otherwise it will be bound to this `sap.ushell.ui.launchpad.LinkTileWrapper` itself.
9494
+ *
9495
+ * @returns Reference to `this` in order to allow method chaining
8240
9496
  */
8241
9497
  attachAfterRendering(
8242
9498
  /**
@@ -8254,6 +9510,8 @@ declare namespace sap {
8254
9510
  *
8255
9511
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
8256
9512
  * otherwise it will be bound to this `sap.ushell.ui.launchpad.LinkTileWrapper` itself.
9513
+ *
9514
+ * @returns Reference to `this` in order to allow method chaining
8257
9515
  */
8258
9516
  attachCoverDivPress(
8259
9517
  /**
@@ -8276,6 +9534,8 @@ declare namespace sap {
8276
9534
  *
8277
9535
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
8278
9536
  * otherwise it will be bound to this `sap.ushell.ui.launchpad.LinkTileWrapper` itself.
9537
+ *
9538
+ * @returns Reference to `this` in order to allow method chaining
8279
9539
  */
8280
9540
  attachCoverDivPress(
8281
9541
  /**
@@ -8293,6 +9553,8 @@ declare namespace sap {
8293
9553
  *
8294
9554
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
8295
9555
  * otherwise it will be bound to this `sap.ushell.ui.launchpad.LinkTileWrapper` itself.
9556
+ *
9557
+ * @returns Reference to `this` in order to allow method chaining
8296
9558
  */
8297
9559
  attachPress(
8298
9560
  /**
@@ -8315,6 +9577,8 @@ declare namespace sap {
8315
9577
  *
8316
9578
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
8317
9579
  * otherwise it will be bound to this `sap.ushell.ui.launchpad.LinkTileWrapper` itself.
9580
+ *
9581
+ * @returns Reference to `this` in order to allow method chaining
8318
9582
  */
8319
9583
  attachPress(
8320
9584
  /**
@@ -8332,6 +9596,8 @@ declare namespace sap {
8332
9596
  *
8333
9597
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
8334
9598
  * otherwise it will be bound to this `sap.ushell.ui.launchpad.LinkTileWrapper` itself.
9599
+ *
9600
+ * @returns Reference to `this` in order to allow method chaining
8335
9601
  */
8336
9602
  attachShowActions(
8337
9603
  /**
@@ -8354,6 +9620,8 @@ declare namespace sap {
8354
9620
  *
8355
9621
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
8356
9622
  * otherwise it will be bound to this `sap.ushell.ui.launchpad.LinkTileWrapper` itself.
9623
+ *
9624
+ * @returns Reference to `this` in order to allow method chaining
8357
9625
  */
8358
9626
  attachShowActions(
8359
9627
  /**
@@ -8368,10 +9636,14 @@ declare namespace sap {
8368
9636
  ): this;
8369
9637
  /**
8370
9638
  * Destroys all the footItems in the aggregation {@link #getFootItems footItems}.
9639
+ *
9640
+ * @returns Reference to `this` in order to allow method chaining
8371
9641
  */
8372
9642
  destroyFootItems(): this;
8373
9643
  /**
8374
9644
  * Destroys all the tileViews in the aggregation {@link #getTileViews tileViews}.
9645
+ *
9646
+ * @returns Reference to `this` in order to allow method chaining
8375
9647
  */
8376
9648
  destroyTileViews(): this;
8377
9649
  /**
@@ -8379,6 +9651,8 @@ declare namespace sap {
8379
9651
  * `sap.ushell.ui.launchpad.LinkTileWrapper`.
8380
9652
  *
8381
9653
  * The passed function and listener object must match the ones used for event registration.
9654
+ *
9655
+ * @returns Reference to `this` in order to allow method chaining
8382
9656
  */
8383
9657
  detachAfterRendering(
8384
9658
  /**
@@ -8395,6 +9669,8 @@ declare namespace sap {
8395
9669
  * `sap.ushell.ui.launchpad.LinkTileWrapper`.
8396
9670
  *
8397
9671
  * The passed function and listener object must match the ones used for event registration.
9672
+ *
9673
+ * @returns Reference to `this` in order to allow method chaining
8398
9674
  */
8399
9675
  detachCoverDivPress(
8400
9676
  /**
@@ -8410,6 +9686,8 @@ declare namespace sap {
8410
9686
  * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.ushell.ui.launchpad.LinkTileWrapper`.
8411
9687
  *
8412
9688
  * The passed function and listener object must match the ones used for event registration.
9689
+ *
9690
+ * @returns Reference to `this` in order to allow method chaining
8413
9691
  */
8414
9692
  detachPress(
8415
9693
  /**
@@ -8425,6 +9703,8 @@ declare namespace sap {
8425
9703
  * Detaches event handler `fnFunction` from the {@link #event:showActions showActions} event of this `sap.ushell.ui.launchpad.LinkTileWrapper`.
8426
9704
  *
8427
9705
  * The passed function and listener object must match the ones used for event registration.
9706
+ *
9707
+ * @returns Reference to `this` in order to allow method chaining
8428
9708
  */
8429
9709
  detachShowActions(
8430
9710
  /**
@@ -8438,6 +9718,8 @@ declare namespace sap {
8438
9718
  ): this;
8439
9719
  /**
8440
9720
  * Fires event {@link #event:afterRendering afterRendering} to attached listeners.
9721
+ *
9722
+ * @returns Reference to `this` in order to allow method chaining
8441
9723
  */
8442
9724
  fireAfterRendering(
8443
9725
  /**
@@ -8447,6 +9729,8 @@ declare namespace sap {
8447
9729
  ): this;
8448
9730
  /**
8449
9731
  * Fires event {@link #event:coverDivPress coverDivPress} to attached listeners.
9732
+ *
9733
+ * @returns Reference to `this` in order to allow method chaining
8450
9734
  */
8451
9735
  fireCoverDivPress(
8452
9736
  /**
@@ -8456,6 +9740,8 @@ declare namespace sap {
8456
9740
  ): this;
8457
9741
  /**
8458
9742
  * Fires event {@link #event:press press} to attached listeners.
9743
+ *
9744
+ * @returns Reference to `this` in order to allow method chaining
8459
9745
  */
8460
9746
  firePress(
8461
9747
  /**
@@ -8465,6 +9751,8 @@ declare namespace sap {
8465
9751
  ): this;
8466
9752
  /**
8467
9753
  * Fires event {@link #event:showActions showActions} to attached listeners.
9754
+ *
9755
+ * @returns Reference to `this` in order to allow method chaining
8468
9756
  */
8469
9757
  fireShowActions(
8470
9758
  /**
@@ -8476,10 +9764,14 @@ declare namespace sap {
8476
9764
  * Gets current value of property {@link #getAnimationRendered animationRendered}.
8477
9765
  *
8478
9766
  * Default value is `false`.
9767
+ *
9768
+ * @returns Value of property `animationRendered`
8479
9769
  */
8480
9770
  getAnimationRendered(): boolean;
8481
9771
  /**
8482
9772
  * Gets current value of property {@link #getDebugInfo debugInfo}.
9773
+ *
9774
+ * @returns Value of property `debugInfo`
8483
9775
  */
8484
9776
  getDebugInfo(): string;
8485
9777
  /**
@@ -8490,26 +9782,36 @@ declare namespace sap {
8490
9782
  * Gets current value of property {@link #getIeHtml5DnD ieHtml5DnD}.
8491
9783
  *
8492
9784
  * Default value is `false`.
9785
+ *
9786
+ * @returns Value of property `ieHtml5DnD`
8493
9787
  */
8494
9788
  getIeHtml5DnD(): boolean;
8495
9789
  /**
8496
9790
  * Gets current value of property {@link #getIsLocked isLocked}.
8497
9791
  *
8498
9792
  * Default value is `false`.
9793
+ *
9794
+ * @returns Value of property `isLocked`
8499
9795
  */
8500
9796
  getIsLocked(): boolean;
8501
9797
  /**
8502
9798
  * Gets current value of property {@link #getTarget target}.
9799
+ *
9800
+ * @returns Value of property `target`
8503
9801
  */
8504
9802
  getTarget(): string;
8505
9803
  /**
8506
9804
  * Gets current value of property {@link #getTileActionModeActive tileActionModeActive}.
8507
9805
  *
8508
9806
  * Default value is `false`.
9807
+ *
9808
+ * @returns Value of property `tileActionModeActive`
8509
9809
  */
8510
9810
  getTileActionModeActive(): boolean;
8511
9811
  /**
8512
9812
  * Gets current value of property {@link #getTileCatalogId tileCatalogId}.
9813
+ *
9814
+ * @returns Value of property `tileCatalogId`
8513
9815
  */
8514
9816
  getTileCatalogId(): string;
8515
9817
  /**
@@ -8518,17 +9820,23 @@ declare namespace sap {
8518
9820
  getTileViews(): sap.ui.core.Control[];
8519
9821
  /**
8520
9822
  * Gets current value of property {@link #getUuid uuid}.
9823
+ *
9824
+ * @returns Value of property `uuid`
8521
9825
  */
8522
9826
  getUuid(): string;
8523
9827
  /**
8524
9828
  * Gets current value of property {@link #getVisible visible}.
8525
9829
  *
8526
9830
  * Default value is `true`.
9831
+ *
9832
+ * @returns Value of property `visible`
8527
9833
  */
8528
9834
  getVisible(): boolean;
8529
9835
  /**
8530
9836
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getFootItems footItems}. and
8531
9837
  * returns its index if found or -1 otherwise.
9838
+ *
9839
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
8532
9840
  */
8533
9841
  indexOfFootItem(
8534
9842
  /**
@@ -8539,6 +9847,8 @@ declare namespace sap {
8539
9847
  /**
8540
9848
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getTileViews tileViews}. and
8541
9849
  * returns its index if found or -1 otherwise.
9850
+ *
9851
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
8542
9852
  */
8543
9853
  indexOfTileView(
8544
9854
  /**
@@ -8548,6 +9858,8 @@ declare namespace sap {
8548
9858
  ): int;
8549
9859
  /**
8550
9860
  * Inserts a footItem into the aggregation {@link #getFootItems footItems}.
9861
+ *
9862
+ * @returns Reference to `this` in order to allow method chaining
8551
9863
  */
8552
9864
  insertFootItem(
8553
9865
  /**
@@ -8563,6 +9875,8 @@ declare namespace sap {
8563
9875
  ): this;
8564
9876
  /**
8565
9877
  * Inserts a tileView into the aggregation {@link #getTileViews tileViews}.
9878
+ *
9879
+ * @returns Reference to `this` in order to allow method chaining
8566
9880
  */
8567
9881
  insertTileView(
8568
9882
  /**
@@ -8580,16 +9894,22 @@ declare namespace sap {
8580
9894
  * Removes all the controls from the aggregation {@link #getFootItems footItems}.
8581
9895
  *
8582
9896
  * Additionally, it unregisters them from the hosting UIArea.
9897
+ *
9898
+ * @returns An array of the removed elements (might be empty)
8583
9899
  */
8584
9900
  removeAllFootItems(): sap.ui.core.Control[];
8585
9901
  /**
8586
9902
  * Removes all the controls from the aggregation {@link #getTileViews tileViews}.
8587
9903
  *
8588
9904
  * Additionally, it unregisters them from the hosting UIArea.
9905
+ *
9906
+ * @returns An array of the removed elements (might be empty)
8589
9907
  */
8590
9908
  removeAllTileViews(): sap.ui.core.Control[];
8591
9909
  /**
8592
9910
  * Removes a footItem from the aggregation {@link #getFootItems footItems}.
9911
+ *
9912
+ * @returns The removed footItem or `null`
8593
9913
  */
8594
9914
  removeFootItem(
8595
9915
  /**
@@ -8599,6 +9919,8 @@ declare namespace sap {
8599
9919
  ): sap.ui.core.Control;
8600
9920
  /**
8601
9921
  * Removes a tileView from the aggregation {@link #getTileViews tileViews}.
9922
+ *
9923
+ * @returns The removed tileView or `null`
8602
9924
  */
8603
9925
  removeTileView(
8604
9926
  /**
@@ -8612,6 +9934,8 @@ declare namespace sap {
8612
9934
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8613
9935
  *
8614
9936
  * Default value is `false`.
9937
+ *
9938
+ * @returns Reference to `this` in order to allow method chaining
8615
9939
  */
8616
9940
  setAnimationRendered(
8617
9941
  /**
@@ -8623,6 +9947,8 @@ declare namespace sap {
8623
9947
  * Sets a new value for property {@link #getDebugInfo debugInfo}.
8624
9948
  *
8625
9949
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9950
+ *
9951
+ * @returns Reference to `this` in order to allow method chaining
8626
9952
  */
8627
9953
  setDebugInfo(
8628
9954
  /**
@@ -8636,6 +9962,8 @@ declare namespace sap {
8636
9962
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8637
9963
  *
8638
9964
  * Default value is `false`.
9965
+ *
9966
+ * @returns Reference to `this` in order to allow method chaining
8639
9967
  */
8640
9968
  setIeHtml5DnD(
8641
9969
  /**
@@ -8649,6 +9977,8 @@ declare namespace sap {
8649
9977
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8650
9978
  *
8651
9979
  * Default value is `false`.
9980
+ *
9981
+ * @returns Reference to `this` in order to allow method chaining
8652
9982
  */
8653
9983
  setIsLocked(
8654
9984
  /**
@@ -8660,6 +9990,8 @@ declare namespace sap {
8660
9990
  * Sets a new value for property {@link #getTarget target}.
8661
9991
  *
8662
9992
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9993
+ *
9994
+ * @returns Reference to `this` in order to allow method chaining
8663
9995
  */
8664
9996
  setTarget(
8665
9997
  /**
@@ -8673,6 +10005,8 @@ declare namespace sap {
8673
10005
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8674
10006
  *
8675
10007
  * Default value is `false`.
10008
+ *
10009
+ * @returns Reference to `this` in order to allow method chaining
8676
10010
  */
8677
10011
  setTileActionModeActive(
8678
10012
  /**
@@ -8684,6 +10018,8 @@ declare namespace sap {
8684
10018
  * Sets a new value for property {@link #getTileCatalogId tileCatalogId}.
8685
10019
  *
8686
10020
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
10021
+ *
10022
+ * @returns Reference to `this` in order to allow method chaining
8687
10023
  */
8688
10024
  setTileCatalogId(
8689
10025
  /**
@@ -8695,6 +10031,8 @@ declare namespace sap {
8695
10031
  * Sets a new value for property {@link #getUuid uuid}.
8696
10032
  *
8697
10033
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
10034
+ *
10035
+ * @returns Reference to `this` in order to allow method chaining
8698
10036
  */
8699
10037
  setUuid(
8700
10038
  /**
@@ -8708,6 +10046,8 @@ declare namespace sap {
8708
10046
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8709
10047
  *
8710
10048
  * Default value is `true`.
10049
+ *
10050
+ * @returns Reference to `this` in order to allow method chaining
8711
10051
  */
8712
10052
  setVisible(
8713
10053
  /**
@@ -8756,6 +10096,8 @@ declare namespace sap {
8756
10096
  * it with the information contained in `oClassInfo`.
8757
10097
  *
8758
10098
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
10099
+ *
10100
+ * @returns Created class / constructor function
8759
10101
  */
8760
10102
  static extend<T extends Record<string, unknown>>(
8761
10103
  /**
@@ -8774,6 +10116,8 @@ declare namespace sap {
8774
10116
  ): Function;
8775
10117
  /**
8776
10118
  * Returns a metadata object for class sap.ushell.ui.launchpad.TileState.
10119
+ *
10120
+ * @returns Metadata object describing this class
8777
10121
  */
8778
10122
  static getMetadata(): sap.ui.core.ElementMetadata;
8779
10123
  /**
@@ -8781,6 +10125,8 @@ declare namespace sap {
8781
10125
  *
8782
10126
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
8783
10127
  * otherwise it will be bound to this `sap.ushell.ui.launchpad.TileState` itself.
10128
+ *
10129
+ * @returns Reference to `this` in order to allow method chaining
8784
10130
  */
8785
10131
  attachPress(
8786
10132
  /**
@@ -8802,6 +10148,8 @@ declare namespace sap {
8802
10148
  *
8803
10149
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
8804
10150
  * otherwise it will be bound to this `sap.ushell.ui.launchpad.TileState` itself.
10151
+ *
10152
+ * @returns Reference to `this` in order to allow method chaining
8805
10153
  */
8806
10154
  attachPress(
8807
10155
  /**
@@ -8817,6 +10165,8 @@ declare namespace sap {
8817
10165
  * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.ushell.ui.launchpad.TileState`.
8818
10166
  *
8819
10167
  * The passed function and listener object must match the ones used for event registration.
10168
+ *
10169
+ * @returns Reference to `this` in order to allow method chaining
8820
10170
  */
8821
10171
  detachPress(
8822
10172
  /**
@@ -8830,6 +10180,8 @@ declare namespace sap {
8830
10180
  ): this;
8831
10181
  /**
8832
10182
  * Fires event {@link #event:press press} to attached listeners.
10183
+ *
10184
+ * @returns Reference to `this` in order to allow method chaining
8833
10185
  */
8834
10186
  firePress(
8835
10187
  /**
@@ -8841,6 +10193,8 @@ declare namespace sap {
8841
10193
  * Gets current value of property {@link #getState state}.
8842
10194
  *
8843
10195
  * Default value is `"Loaded"`.
10196
+ *
10197
+ * @returns Value of property `state`
8844
10198
  */
8845
10199
  getState(): string;
8846
10200
  /**
@@ -8849,6 +10203,8 @@ declare namespace sap {
8849
10203
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8850
10204
  *
8851
10205
  * Default value is `"Loaded"`.
10206
+ *
10207
+ * @returns Reference to `this` in order to allow method chaining
8852
10208
  */
8853
10209
  setState(
8854
10210
  /**
@@ -8866,12 +10222,16 @@ declare namespace sap {
8866
10222
  */
8867
10223
  icon?:
8868
10224
  | sap.ui.core.URI
8869
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
10225
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
10226
+ | `{${string}}`;
8870
10227
 
8871
10228
  /**
8872
10229
  * Defines whether to mark the control as selected
8873
10230
  */
8874
- selected?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
10231
+ selected?:
10232
+ | boolean
10233
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
10234
+ | `{${string}}`;
8875
10235
 
8876
10236
  text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
8877
10237
 
@@ -8885,14 +10245,20 @@ declare namespace sap {
8885
10245
  /**
8886
10246
  * Defines whether to display the control
8887
10247
  */
8888
- visible?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
10248
+ visible?:
10249
+ | boolean
10250
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
10251
+ | `{${string}}`;
8889
10252
 
8890
10253
  /**
8891
10254
  * Defines whether the control will have an expand functionality containing sub-items or actions. If the
8892
10255
  * property is set to true, a small "expand" icon appears in the lower corner of the control. The "expand"
8893
10256
  * event is fired when the "expand" icon is pressed.
8894
10257
  */
8895
- expandable?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
10258
+ expandable?:
10259
+ | boolean
10260
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
10261
+ | `{${string}}`;
8896
10262
 
8897
10263
  /**
8898
10264
  * Event is fired when the user presses the item.
@@ -8947,6 +10313,8 @@ declare namespace sap {
8947
10313
  * it with the information contained in `oClassInfo`.
8948
10314
  *
8949
10315
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
10316
+ *
10317
+ * @returns Created class / constructor function
8950
10318
  */
8951
10319
  static extend<T extends Record<string, unknown>>(
8952
10320
  /**
@@ -8965,6 +10333,8 @@ declare namespace sap {
8965
10333
  ): Function;
8966
10334
  /**
8967
10335
  * Returns a metadata object for class sap.ushell.ui.shell.ToolAreaItem.
10336
+ *
10337
+ * @returns Metadata object describing this class
8968
10338
  */
8969
10339
  static getMetadata(): sap.ui.core.ElementMetadata;
8970
10340
  /**
@@ -8974,6 +10344,8 @@ declare namespace sap {
8974
10344
  * otherwise it will be bound to this `sap.ushell.ui.shell.ToolAreaItem` itself.
8975
10345
  *
8976
10346
  * Event is fired when the user presses the Expand icon.
10347
+ *
10348
+ * @returns Reference to `this` in order to allow method chaining
8977
10349
  */
8978
10350
  attachExpand(
8979
10351
  /**
@@ -8997,6 +10369,8 @@ declare namespace sap {
8997
10369
  * otherwise it will be bound to this `sap.ushell.ui.shell.ToolAreaItem` itself.
8998
10370
  *
8999
10371
  * Event is fired when the user presses the Expand icon.
10372
+ *
10373
+ * @returns Reference to `this` in order to allow method chaining
9000
10374
  */
9001
10375
  attachExpand(
9002
10376
  /**
@@ -9015,6 +10389,8 @@ declare namespace sap {
9015
10389
  * otherwise it will be bound to this `sap.ushell.ui.shell.ToolAreaItem` itself.
9016
10390
  *
9017
10391
  * Event is fired when the user presses the item.
10392
+ *
10393
+ * @returns Reference to `this` in order to allow method chaining
9018
10394
  */
9019
10395
  attachPress(
9020
10396
  /**
@@ -9038,6 +10414,8 @@ declare namespace sap {
9038
10414
  * otherwise it will be bound to this `sap.ushell.ui.shell.ToolAreaItem` itself.
9039
10415
  *
9040
10416
  * Event is fired when the user presses the item.
10417
+ *
10418
+ * @returns Reference to `this` in order to allow method chaining
9041
10419
  */
9042
10420
  attachPress(
9043
10421
  /**
@@ -9053,6 +10431,8 @@ declare namespace sap {
9053
10431
  * Detaches event handler `fnFunction` from the {@link #event:expand expand} event of this `sap.ushell.ui.shell.ToolAreaItem`.
9054
10432
  *
9055
10433
  * The passed function and listener object must match the ones used for event registration.
10434
+ *
10435
+ * @returns Reference to `this` in order to allow method chaining
9056
10436
  */
9057
10437
  detachExpand(
9058
10438
  /**
@@ -9068,6 +10448,8 @@ declare namespace sap {
9068
10448
  * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.ushell.ui.shell.ToolAreaItem`.
9069
10449
  *
9070
10450
  * The passed function and listener object must match the ones used for event registration.
10451
+ *
10452
+ * @returns Reference to `this` in order to allow method chaining
9071
10453
  */
9072
10454
  detachPress(
9073
10455
  /**
@@ -9081,6 +10463,8 @@ declare namespace sap {
9081
10463
  ): this;
9082
10464
  /**
9083
10465
  * Fires event {@link #event:expand expand} to attached listeners.
10466
+ *
10467
+ * @returns Reference to `this` in order to allow method chaining
9084
10468
  */
9085
10469
  fireExpand(
9086
10470
  /**
@@ -9090,6 +10474,8 @@ declare namespace sap {
9090
10474
  ): this;
9091
10475
  /**
9092
10476
  * Fires event {@link #event:press press} to attached listeners.
10477
+ *
10478
+ * @returns Reference to `this` in order to allow method chaining
9093
10479
  */
9094
10480
  firePress(
9095
10481
  /**
@@ -9103,6 +10489,8 @@ declare namespace sap {
9103
10489
  * Gets current value of property {@link #getAriaLabel ariaLabel}.
9104
10490
  *
9105
10491
  * Text which will be read by screenreader.
10492
+ *
10493
+ * @returns Value of property `ariaLabel`
9106
10494
  */
9107
10495
  getAriaLabel(): string;
9108
10496
  /**
@@ -9113,12 +10501,16 @@ declare namespace sap {
9113
10501
  * event is fired when the "expand" icon is pressed.
9114
10502
  *
9115
10503
  * Default value is `false`.
10504
+ *
10505
+ * @returns Value of property `expandable`
9116
10506
  */
9117
10507
  getExpandable(): boolean;
9118
10508
  /**
9119
10509
  * Gets current value of property {@link #getIcon icon}.
9120
10510
  *
9121
10511
  * Icon that is displayed in the item.
10512
+ *
10513
+ * @returns Value of property `icon`
9122
10514
  */
9123
10515
  getIcon(): sap.ui.core.URI;
9124
10516
  /**
@@ -9127,10 +10519,14 @@ declare namespace sap {
9127
10519
  * Defines whether to mark the control as selected
9128
10520
  *
9129
10521
  * Default value is `false`.
10522
+ *
10523
+ * @returns Value of property `selected`
9130
10524
  */
9131
10525
  getSelected(): boolean;
9132
10526
  /**
9133
10527
  * Gets current value of property {@link #getText text}.
10528
+ *
10529
+ * @returns Value of property `text`
9134
10530
  */
9135
10531
  getText(): string;
9136
10532
  /**
@@ -9139,6 +10535,8 @@ declare namespace sap {
9139
10535
  * Defines whether to display the control
9140
10536
  *
9141
10537
  * Default value is `true`.
10538
+ *
10539
+ * @returns Value of property `visible`
9142
10540
  */
9143
10541
  getVisible(): boolean;
9144
10542
  /**
@@ -9149,6 +10547,8 @@ declare namespace sap {
9149
10547
  * Text which will be read by screenreader.
9150
10548
  *
9151
10549
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
10550
+ *
10551
+ * @returns Reference to `this` in order to allow method chaining
9152
10552
  */
9153
10553
  setAriaLabel(
9154
10554
  /**
@@ -9166,6 +10566,8 @@ declare namespace sap {
9166
10566
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9167
10567
  *
9168
10568
  * Default value is `false`.
10569
+ *
10570
+ * @returns Reference to `this` in order to allow method chaining
9169
10571
  */
9170
10572
  setExpandable(
9171
10573
  /**
@@ -9179,6 +10581,8 @@ declare namespace sap {
9179
10581
  * Icon that is displayed in the item.
9180
10582
  *
9181
10583
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
10584
+ *
10585
+ * @returns Reference to `this` in order to allow method chaining
9182
10586
  */
9183
10587
  setIcon(
9184
10588
  /**
@@ -9194,6 +10598,8 @@ declare namespace sap {
9194
10598
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9195
10599
  *
9196
10600
  * Default value is `false`.
10601
+ *
10602
+ * @returns Reference to `this` in order to allow method chaining
9197
10603
  */
9198
10604
  setSelected(
9199
10605
  /**
@@ -9205,6 +10611,8 @@ declare namespace sap {
9205
10611
  * Sets a new value for property {@link #getText text}.
9206
10612
  *
9207
10613
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
10614
+ *
10615
+ * @returns Reference to `this` in order to allow method chaining
9208
10616
  */
9209
10617
  setText(
9210
10618
  /**
@@ -9220,6 +10628,8 @@ declare namespace sap {
9220
10628
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9221
10629
  *
9222
10630
  * Default value is `true`.
10631
+ *
10632
+ * @returns Reference to `this` in order to allow method chaining
9223
10633
  */
9224
10634
  setVisible(
9225
10635
  /**
@@ -9263,6 +10673,8 @@ declare namespace sap {
9263
10673
  * with the information contained in `oClassInfo`.
9264
10674
  *
9265
10675
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ushell.ui.tile.TileBase.extend}.
10676
+ *
10677
+ * @returns Created class / constructor function
9266
10678
  */
9267
10679
  static extend<T extends Record<string, unknown>>(
9268
10680
  /**
@@ -9281,6 +10693,8 @@ declare namespace sap {
9281
10693
  ): Function;
9282
10694
  /**
9283
10695
  * Returns a metadata object for class sap.ushell.ui.tile.StaticTile.
10696
+ *
10697
+ * @returns Metadata object describing this class
9284
10698
  */
9285
10699
  static getMetadata(): sap.ui.base.Metadata;
9286
10700
  }
@@ -9297,6 +10711,8 @@ declare namespace sap {
9297
10711
  * it with the information contained in `oClassInfo`.
9298
10712
  *
9299
10713
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.service.Service.extend}.
10714
+ *
10715
+ * @returns Created class / constructor function
9300
10716
  */
9301
10717
  extend(
9302
10718
  /**
@@ -9315,6 +10731,8 @@ declare namespace sap {
9315
10731
  ): Function;
9316
10732
  /**
9317
10733
  * Returns a metadata object for class sap.ushell.ui5service.UserStatus.
10734
+ *
10735
+ * @returns Metadata object describing this class
9318
10736
  */
9319
10737
  getMetadata(): sap.ui.base.Metadata;
9320
10738
  }
@@ -9424,6 +10842,8 @@ declare namespace sap {
9424
10842
  * it with the information contained in `oClassInfo`.
9425
10843
  *
9426
10844
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.service.Service.extend}.
10845
+ *
10846
+ * @returns Created class / constructor function
9427
10847
  */
9428
10848
  static extend<T extends Record<string, unknown>>(
9429
10849
  /**
@@ -9442,12 +10862,16 @@ declare namespace sap {
9442
10862
  ): Function;
9443
10863
  /**
9444
10864
  * Returns a metadata object for class sap.ushell.ui5service.ShellUIService.
10865
+ *
10866
+ * @returns Metadata object describing this class
9445
10867
  */
9446
10868
  static getMetadata(): sap.ui.base.Metadata;
9447
10869
  /**
9448
10870
  * @SINCE 1.38.0
9449
10871
  *
9450
10872
  * Returns the title that was last set via {@link setTitle}.
10873
+ *
10874
+ * @returns The title that was last set via {@link setTitle}.
9451
10875
  */
9452
10876
  getTitle(): string;
9453
10877
  /**
@@ -9635,6 +11059,8 @@ declare namespace sap {
9635
11059
  * the page and there should be no other parts of the page consuming space outside the renderer. Use CSS
9636
11060
  * class `sapUShellFullHeight` at `html`, `body` and at the element to which the renderer is added to allow
9637
11061
  * the renderer to use 100% height.
11062
+ *
11063
+ * @returns the renderer or Promise (in asynchronous mode)
9638
11064
  */
9639
11065
  createRenderer(
9640
11066
  /**
@@ -9689,6 +11115,8 @@ declare namespace sap {
9689
11115
  *
9690
11116
  * However, if the dirty state was previously set to 'true' using 'setDirtyFlag' the registered dirty state
9691
11117
  * provider methods are ignored and the function simply returns 'true'.
11118
+ *
11119
+ * @returns The value of the dirty flag or the determined dirty state returned by the dirty state providers.
9692
11120
  */
9693
11121
  getDirtyFlag(): boolean;
9694
11122
  /**
@@ -9697,12 +11125,19 @@ declare namespace sap {
9697
11125
  * Returns the global dirty state.
9698
11126
  *
9699
11127
  * All open UShell browser windows for the same origin are asked about their global dirty state.
11128
+ *
11129
+ * @returns A `jQuery.Deferred` object's promise receiving the dirty state (see {@link sap.ushell.Container.DirtyState}).
9700
11130
  */
9701
11131
  getGlobalDirty(): jQuery.Deferred;
9702
11132
  /**
9703
11133
  * @SINCE 1.30.0
9704
11134
  *
9705
11135
  * Gets a renderer instance for the given renderer name, that was created by the createRenderer method.
11136
+ *
11137
+ * @returns the renderer with the specified name; the returned object is either a control (i.e. extend `sap.ui.core.Control`)
11138
+ * or a UI component (i.e. extend `sap.ui.core.UIComponent`), i.e. this method unwraps the renderer component
11139
+ * from its `sap.ui.core.ComponentContainer`; if no renderer name can be determined and a single renderer
11140
+ * instance has been created, this single instance is returned.
9706
11141
  */
9707
11142
  getRenderer(
9708
11143
  /**
@@ -9769,6 +11204,8 @@ declare namespace sap {
9769
11204
  * not reflect a service available.
9770
11205
  * See:
9771
11206
  * sap.ushell.services.ContainerInterface
11207
+ *
11208
+ * @returns the service or, in asynchronous mode, a Promise that returns the service
9772
11209
  */
9773
11210
  getService(
9774
11211
  /**
@@ -9839,6 +11276,8 @@ declare namespace sap {
9839
11276
  * and `{config: {foo: "bar"}}`.
9840
11277
  * See:
9841
11278
  * sap.ushell.services.ContainerInterface
11279
+ *
11280
+ * @returns a Promise that returns the requested service
9842
11281
  */
9843
11282
  getServiceAsync(
9844
11283
  /**