@sapui5/ts-types 1.114.0 → 1.115.1

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 (65) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +2 -0
  3. package/types/sap.apf.d.ts +2 -2
  4. package/types/sap.ca.ui.d.ts +135 -67
  5. package/types/sap.chart.d.ts +216 -144
  6. package/types/sap.collaboration.d.ts +80 -78
  7. package/types/sap.esh.search.ui.d.ts +93 -1
  8. package/types/sap.f.d.ts +1987 -1517
  9. package/types/sap.fe.core.d.ts +95 -209
  10. package/types/sap.fe.macros.d.ts +112 -10
  11. package/types/sap.fe.navigation.d.ts +39 -32
  12. package/types/sap.fe.placeholder.d.ts +3 -0
  13. package/types/sap.fe.templates.d.ts +10 -278
  14. package/types/sap.fe.test.d.ts +7 -13
  15. package/types/sap.fe.tools.d.ts +3 -0
  16. package/types/sap.feedback.ui.d.ts +1 -1
  17. package/types/sap.gantt.d.ts +1716 -1087
  18. package/types/sap.insights.d.ts +1 -1
  19. package/types/sap.landvisz.d.ts +35 -9
  20. package/types/sap.m.d.ts +26776 -22688
  21. package/types/sap.makit.d.ts +87 -28
  22. package/types/sap.me.d.ts +166 -74
  23. package/types/sap.ndc.d.ts +115 -43
  24. package/types/sap.ovp.d.ts +1 -2
  25. package/types/sap.rules.ui.d.ts +43 -19
  26. package/types/sap.sac.df.d.ts +3 -3
  27. package/types/sap.suite.ui.commons.d.ts +2056 -1282
  28. package/types/sap.suite.ui.generic.template.d.ts +99 -102
  29. package/types/sap.suite.ui.microchart.d.ts +503 -322
  30. package/types/sap.tnt.d.ts +160 -86
  31. package/types/sap.ui.codeeditor.d.ts +64 -38
  32. package/types/sap.ui.commons.d.ts +1377 -793
  33. package/types/sap.ui.comp.d.ts +4158 -2831
  34. package/types/sap.ui.core.d.ts +6006 -3642
  35. package/types/sap.ui.dt.d.ts +1 -1
  36. package/types/sap.ui.export.d.ts +71 -53
  37. package/types/sap.ui.fl.d.ts +162 -97
  38. package/types/sap.ui.generic.app.d.ts +40 -39
  39. package/types/sap.ui.generic.template.d.ts +1 -1
  40. package/types/sap.ui.integration.d.ts +497 -373
  41. package/types/sap.ui.layout.d.ts +598 -631
  42. package/types/sap.ui.mdc.d.ts +21985 -6
  43. package/types/sap.ui.richtexteditor.d.ts +107 -70
  44. package/types/sap.ui.rta.d.ts +7 -8
  45. package/types/sap.ui.suite.d.ts +29 -14
  46. package/types/sap.ui.support.d.ts +15 -17
  47. package/types/sap.ui.table.d.ts +910 -628
  48. package/types/sap.ui.testrecorder.d.ts +1 -1
  49. package/types/sap.ui.unified.d.ts +1775 -1166
  50. package/types/sap.ui.ux3.d.ts +1469 -759
  51. package/types/sap.ui.vbm.d.ts +1262 -710
  52. package/types/sap.ui.vk.d.ts +2981 -1751
  53. package/types/sap.ui.vtm.d.ts +704 -457
  54. package/types/sap.ui.webc.common.d.ts +9 -9
  55. package/types/sap.ui.webc.fiori.d.ts +812 -448
  56. package/types/sap.ui.webc.main.d.ts +2045 -1068
  57. package/types/sap.uiext.inbox.d.ts +168 -41
  58. package/types/sap.ushell.d.ts +722 -424
  59. package/types/sap.ushell_abap.d.ts +1 -1
  60. package/types/sap.uxap.d.ts +469 -343
  61. package/types/sap.viz.d.ts +2196 -833
  62. package/types/sap.webanalytics.core.d.ts +1 -1
  63. package/types/sap.zen.commons.d.ts +5 -5
  64. package/types/sap.zen.crosstab.d.ts +1 -1
  65. package/types/sap.zen.dsh.d.ts +147 -81
@@ -1,18 +1,18 @@
1
- // For Library Version: 1.114.0
1
+ // For Library Version: 1.115.1
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ushell {
5
5
  /**
6
- * @SINCE 1.15.0
6
+ * @since 1.15.0
7
7
  *
8
8
  * See:
9
9
  * sap.ushell.Container.getServiceAsync()
10
10
  */
11
11
  namespace services {
12
12
  /**
13
- * @SINCE 1.62.0
14
- * @EXPERIMENTAL
15
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
13
+ * @since 1.62.0
14
+ * @deprecated
15
+ * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
16
16
  */
17
17
  export const ContentExtensionAdapterFactory: undefined;
18
18
 
@@ -47,7 +47,7 @@ declare namespace sap {
47
47
 
48
48
  namespace Personalization {
49
49
  /**
50
- * @SINCE 1.22.0
50
+ * @since 1.22.0
51
51
  *
52
52
  * The container is the anchor object of the unified shell personalization in container mode.
53
53
  */
@@ -58,7 +58,7 @@ declare namespace sap {
58
58
  constructor();
59
59
 
60
60
  /**
61
- * @SINCE 1.22.0
61
+ * @since 1.22.0
62
62
  *
63
63
  * Returns an array with all internal keys of direct items in the container.
64
64
  *
@@ -66,13 +66,13 @@ declare namespace sap {
66
66
  */
67
67
  _getInternalKeys(): any[];
68
68
  /**
69
- * @SINCE 1.22.0
69
+ * @since 1.22.0
70
70
  *
71
71
  * clears the local copy data of this container
72
72
  */
73
73
  clear(): void;
74
74
  /**
75
- * @SINCE 1.22.0
75
+ * @since 1.22.0
76
76
  *
77
77
  * Checks if a specific direct item is contained in the container.
78
78
  *
@@ -85,7 +85,7 @@ declare namespace sap {
85
85
  sItemKey: string
86
86
  ): boolean;
87
87
  /**
88
- * @SINCE 1.22.0
88
+ * @since 1.22.0
89
89
  *
90
90
  * Deletes a direct item from the container. In case the item does not exist, nothing happens.
91
91
  */
@@ -96,7 +96,7 @@ declare namespace sap {
96
96
  sItemKey: string
97
97
  ): void;
98
98
  /**
99
- * @SINCE 1.22.0
99
+ * @since 1.22.0
100
100
  *
101
101
  * flush all pending request; The result of the promise may reflect the last pending operation in the queue
102
102
  *
@@ -104,7 +104,7 @@ declare namespace sap {
104
104
  */
105
105
  flush(): object;
106
106
  /**
107
- * @SINCE 1.22.0
107
+ * @since 1.22.0
108
108
  *
109
109
  * Returns an array with the keys of direct items in the container.
110
110
  *
@@ -112,7 +112,7 @@ declare namespace sap {
112
112
  */
113
113
  getItemKeys(): any[];
114
114
  /**
115
- * @SINCE 1.22.0
115
+ * @since 1.22.0
116
116
  *
117
117
  * Returns the value for a direct item from the container. (Value semantics, new copy is returned)
118
118
  *
@@ -126,7 +126,7 @@ declare namespace sap {
126
126
  sItemKey: string
127
127
  ): object;
128
128
  /**
129
- * @SINCE 1.28.0
129
+ * @since 1.28.0
130
130
  *
131
131
  * return the container key as a string variable
132
132
  *
@@ -134,7 +134,7 @@ declare namespace sap {
134
134
  */
135
135
  getKey(): string;
136
136
  /**
137
- * @SINCE 1.28.0
137
+ * @since 1.28.0
138
138
  *
139
139
  * Return an instance unmodifiable container instance. There is one instance of this wrapper per container.
140
140
  * It will permit all read accesses to the container, but block all modifying accesses.
@@ -143,14 +143,14 @@ declare namespace sap {
143
143
  */
144
144
  getUnmodifiableContainer(): object;
145
145
  /**
146
- * @SINCE 1.22.0
146
+ * @since 1.22.0
147
147
  * @deprecated (since 1.31) - Support for this function has been discontinued.
148
148
  *
149
149
  * return the validity of this container only for testing!
150
150
  */
151
151
  getValidity(): void;
152
152
  /**
153
- * @SINCE 1.22.0
153
+ * @since 1.22.0
154
154
  *
155
155
  * (Re)loads the current container data from the underlying storage asynchronously. The current local data
156
156
  * is discarded.
@@ -164,7 +164,7 @@ declare namespace sap {
164
164
  */
165
165
  load(): object;
166
166
  /**
167
- * @SINCE 1.22.0
167
+ * @since 1.22.0
168
168
  *
169
169
  * Attempts to save the current container data at the underlying storage asynchronously. The current state
170
170
  * is serialized.
@@ -175,7 +175,7 @@ declare namespace sap {
175
175
  */
176
176
  save(): object;
177
177
  /**
178
- * @SINCE 1.22.0
178
+ * @since 1.22.0
179
179
  *
180
180
  * Save the current container data at the underlying storage asynchronously at the earlies nDelayInMilliseconds
181
181
  * seconds before. The current state is serialized.
@@ -186,7 +186,7 @@ declare namespace sap {
186
186
  */
187
187
  saveDeferred(): object;
188
188
  /**
189
- * @SINCE 1.22.0
189
+ * @since 1.22.0
190
190
  *
191
191
  * Sets the value of a direct item in the container. In case the item is already existing its value is overwritten.
192
192
  * In case it is not existing a new item with this key and value is created. The value is serialized during
@@ -204,7 +204,7 @@ declare namespace sap {
204
204
  ): void;
205
205
  }
206
206
  /**
207
- * @SINCE 1.22.0
207
+ * @since 1.22.0
208
208
  *
209
209
  * The personalization variant contains personalization data. It is used in the personalization container
210
210
  * mode.
@@ -216,7 +216,7 @@ declare namespace sap {
216
216
  constructor();
217
217
 
218
218
  /**
219
- * @SINCE 1.18.0
219
+ * @since 1.18.0
220
220
  *
221
221
  * Checks if a specific item is contained in this variant.
222
222
  *
@@ -229,7 +229,7 @@ declare namespace sap {
229
229
  sItemKey: string
230
230
  ): boolean;
231
231
  /**
232
- * @SINCE 1.22.0
232
+ * @since 1.22.0
233
233
  *
234
234
  * Deletes an item from this variant. In case the item does not exist, nothing happens.
235
235
  */
@@ -240,7 +240,7 @@ declare namespace sap {
240
240
  sItemKey: string
241
241
  ): void;
242
242
  /**
243
- * @SINCE 1.22.0
243
+ * @since 1.22.0
244
244
  *
245
245
  * Returns an array with the keys of all items in this variant.
246
246
  *
@@ -248,7 +248,7 @@ declare namespace sap {
248
248
  */
249
249
  getItemKeys(): any[];
250
250
  /**
251
- * @SINCE 1.18.0
251
+ * @since 1.18.0
252
252
  *
253
253
  * Returns the value for an item in this variant.
254
254
  *
@@ -262,7 +262,7 @@ declare namespace sap {
262
262
  sItemKey: string
263
263
  ): object;
264
264
  /**
265
- * @SINCE 1.22.0
265
+ * @since 1.22.0
266
266
  *
267
267
  * Returns the key of this variant.
268
268
  *
@@ -270,7 +270,7 @@ declare namespace sap {
270
270
  */
271
271
  getVariantKey(): string;
272
272
  /**
273
- * @SINCE 1.22.0
273
+ * @since 1.22.0
274
274
  *
275
275
  * Returns the name of this variant.
276
276
  *
@@ -278,7 +278,7 @@ declare namespace sap {
278
278
  */
279
279
  getVariantName(): string;
280
280
  /**
281
- * @SINCE 1.18.0
281
+ * @since 1.18.0
282
282
  *
283
283
  * Sets the value for an item in this variant.
284
284
  */
@@ -293,7 +293,7 @@ declare namespace sap {
293
293
  item: object
294
294
  ): void;
295
295
  /**
296
- * @SINCE 1.24.0
296
+ * @since 1.24.0
297
297
  *
298
298
  * Sets the name of the variant.
299
299
  *
@@ -308,7 +308,7 @@ declare namespace sap {
308
308
  ): void;
309
309
  }
310
310
  /**
311
- * @SINCE 1.22.0
311
+ * @since 1.22.0
312
312
  *
313
313
  * The personalization variant set contains variants of personalization data. It is used in the personalization
314
314
  * container mode.
@@ -325,7 +325,7 @@ declare namespace sap {
325
325
  constructor();
326
326
 
327
327
  /**
328
- * @SINCE 1.22.0
328
+ * @since 1.22.0
329
329
  *
330
330
  * Creates a new variant in the variant set. In case a variant with this name is already existing an exception
331
331
  * is thrown.
@@ -339,7 +339,7 @@ declare namespace sap {
339
339
  sVariantSetName: string
340
340
  ): object;
341
341
  /**
342
- * @SINCE 1.22.0
342
+ * @since 1.22.0
343
343
  *
344
344
  * Checks if a specific variant is contained in the variant set.
345
345
  *
@@ -352,7 +352,7 @@ declare namespace sap {
352
352
  sVariantKey: string
353
353
  ): boolean;
354
354
  /**
355
- * @SINCE 1.22.0
355
+ * @since 1.22.0
356
356
  *
357
357
  * Deletes a variant from the variant set. In case the variant does not exist nothing happens.
358
358
  */
@@ -363,7 +363,7 @@ declare namespace sap {
363
363
  sVariantKey: string
364
364
  ): void;
365
365
  /**
366
- * @SINCE 1.22.0
366
+ * @since 1.22.0
367
367
  *
368
368
  * Returns the current variant key.
369
369
  *
@@ -371,7 +371,7 @@ declare namespace sap {
371
371
  */
372
372
  getCurrentVariantKey(): string;
373
373
  /**
374
- * @SINCE 1.22.0
374
+ * @since 1.22.0
375
375
  *
376
376
  * Returns a variant object.
377
377
  *
@@ -385,7 +385,7 @@ declare namespace sap {
385
385
  sVariantKey: string
386
386
  ): object;
387
387
  /**
388
- * @SINCE 1.22.0
388
+ * @since 1.22.0
389
389
  *
390
390
  * Returns the variant key corresponding to a variant name.
391
391
  *
@@ -399,7 +399,7 @@ declare namespace sap {
399
399
  sVariantName: string
400
400
  ): string;
401
401
  /**
402
- * @SINCE 1.22.0
402
+ * @since 1.22.0
403
403
  *
404
404
  * Returns an array with the keys of the variants in the variant set.
405
405
  *
@@ -407,7 +407,7 @@ declare namespace sap {
407
407
  */
408
408
  getVariantKeys(): any[];
409
409
  /**
410
- * @SINCE 1.22.0
410
+ * @since 1.22.0
411
411
  *
412
412
  * Sets the current variant key.
413
413
  */
@@ -422,7 +422,7 @@ declare namespace sap {
422
422
 
423
423
  namespace personalization {
424
424
  /**
425
- * @SINCE 1.18.0
425
+ * @since 1.18.0
426
426
  *
427
427
  * Wrapper object to expose a variant interface on a ContextContainer object obtained from the Peronalization
428
428
  * service:
@@ -453,7 +453,7 @@ declare namespace sap {
453
453
  }
454
454
 
455
455
  /**
456
- * @SINCE 1.15.0
456
+ * @since 1.15.0
457
457
  *
458
458
  * The unified shell's AppConfiguration service.
459
459
  */
@@ -474,37 +474,18 @@ declare namespace sap {
474
474
  ): void;
475
475
  }
476
476
  /**
477
- * @SINCE 1.38
477
+ * @since 1.38
478
+ *
479
+ * The Unified Shell's AppLifeCycle service.
480
+ *
481
+ * **Please note:** To retrieve a valid instance of this service you must call `sap.ushell.Container.getServiceAsync("AppLifeCycle")`.
482
+ * For details see {@link sap.ushell.services.Container#getServiceAsync}.
478
483
  */
479
484
  class AppLifeCycle {
480
- /**
481
- * The Unified Shell's AppLifeCycle service This method MUST be called by the Unified Shell's container
482
- * only, others MUST call `sap.ushell.Container.getServiceAsync("AppLifeCycle").then(function (AppLifeCycle)
483
- * {});`. Constructs a new instance of the AppLifeCycle service.
484
- * See:
485
- * sap.ushell.services.Container#getServiceAsync
486
- */
487
- constructor(
488
- /**
489
- * The service adapter for the AppLifeCycle service, as already provided by the container
490
- */
491
- oAdapter: object,
492
- /**
493
- * interface
494
- */
495
- oContainerInterface: object,
496
- /**
497
- * Service instantiation
498
- */
499
- sParameter: string,
500
- /**
501
- * service configuration (not in use)
502
- */
503
- oConfig: object
504
- );
485
+ constructor();
505
486
 
506
487
  /**
507
- * @SINCE 1.38
488
+ * @since 1.38
508
489
  *
509
490
  * Attaches an event handler for the appLoaded event. This event handler will be triggered each time an
510
491
  * application has been loaded.
@@ -524,7 +505,7 @@ declare namespace sap {
524
505
  oListener: object
525
506
  ): void;
526
507
  /**
527
- * @SINCE 1.38
508
+ * @since 1.38
528
509
  *
529
510
  * Detaches an event handler from the EventProvider.
530
511
  */
@@ -539,7 +520,7 @@ declare namespace sap {
539
520
  oListener: object
540
521
  ): void;
541
522
  /**
542
- * @SINCE 1.38
523
+ * @since 1.38
543
524
  *
544
525
  * Returns information about the currently running application.
545
526
  *
@@ -547,18 +528,18 @@ declare namespace sap {
547
528
  * - applicationType: “UI5|WDA|NWBC|URL|TR”
548
529
  * - componentInstance: reference to component (only for applicationType "UI5").
549
530
  * - homePage: `true` when root intent (normally #Shell-home) or Appfinder (#Shell-appfinder) is currently
550
- * displayed.
531
+ * displayed.
551
532
  * - getTechnicalParameter: `function` that returns the value of a technical parameter for the given
552
- * application. This method is for SAP internal usage only.
533
+ * application. This method is for SAP internal usage only.
553
534
  * - getIntent: `function` that returns a `Promise` that resolves with the current shell hash as an `Object`.
554
- * See {@link sap.ushell.services.URLParsing#parseShellHash} for details. This property is for SAP-internal
555
- * use only!
535
+ * See {@link sap.ushell.services.URLParsing#parseShellHash} for details. This property is for SAP-internal
536
+ * use only!
556
537
  * - getInfo: `function` that is called with an `Array` with following optional elements of type `String`
557
538
  *
558
539
  * ` productName ` A human readable free form text maintained on the platform where FLP runs, and identifying
559
540
  * the current product.
560
541
  * - ` theme ` Current FLP theme. Includes the path to the theme resources if the theme is not an sap
561
- * theme (does not start with sap_)
542
+ * theme (does not start with sap_)
562
543
  * - ` languageTag ` Current Language (BCP47 format)
563
544
  * - ` appIntent ` Intent that was used to launch the application (including parameters)
564
545
  * - ` appFrameworkId `ID of the framework
@@ -567,8 +548,8 @@ declare namespace sap {
567
548
  * - ` appVersion ` Version of the app
568
549
  * - ` appSupportInfo ` The name of an organizational component that handles support incidents.
569
550
  * - ` appFrameworkVersion ` Version of the framework The `function` returns a `Promise` that
570
- * resolves with an `Object` with properties corresponding to the elements of the `Array` passed as input.
571
- * Each of these properties holds its value or undefined if not configured.
551
+ * resolves with an `Object` with properties corresponding to the elements of the `Array` passed as input.
552
+ * Each of these properties holds its value or undefined if not configured.
572
553
  *
573
554
  * **Note:** Return value is only valid after app is loaded. See {@link #attachAppLoaded} for details. Before
574
555
  * an app is loaded, `undefined` is returned.
@@ -578,21 +559,18 @@ declare namespace sap {
578
559
  getCurrentApplication(): object | undefined;
579
560
  }
580
561
  /**
581
- * @SINCE 1.15.0
562
+ * @since 1.15.0
582
563
  *
583
- * The unified shell's bookmark service, which allows you to create shortcuts on the user's home page.
564
+ * The Unified Shell's bookmark service, which allows you to create shortcuts on the user's home page.
565
+ *
566
+ * **Please note:** To retrieve a valid instance of this service you must call `sap.ushell.Container.getServiceAsync("Bookmark")`.
567
+ * For details see {@link sap.ushell.services.Container#getServiceAsync}.
584
568
  */
585
569
  class Bookmark {
586
- /**
587
- * This method MUST be called by the Unified Shell's container only, others MUST call `sap.ushell.Container.getServiceAsync("Bookmark").then(function
588
- * (Bookmark) {});`. Constructs a new instance of the bookmark service.
589
- * See:
590
- * sap.ushell.services.Container#getServiceAsync
591
- */
592
570
  constructor();
593
571
 
594
572
  /**
595
- * @SINCE 1.15.0
573
+ * @since 1.15.0
596
574
  *
597
575
  * Adds a bookmark tile to one of the user's classic homepage groups or to multiple provided content nodes.
598
576
  * See:
@@ -662,9 +640,9 @@ declare namespace sap {
662
640
  numberUnit?: string;
663
641
  },
664
642
  /**
665
- * Either a legacy launchpad home page group, one content node or an array of content nodes. (See {@link
666
- * #getContentNodes}) If not provided, the bookmark will be added to the default group if spaces mode is
667
- * not active or to the default page if spaces mode is active.
643
+ * Either a legacy launchpad home page group, one content node or an array of content nodes. (See {@link #getContentNodes})
644
+ * If not provided, the bookmark will be added to the default group if spaces mode is not active or to the
645
+ * default page if spaces mode is active.
668
646
  */
669
647
  vContainer?:
670
648
  | object
@@ -676,7 +654,7 @@ declare namespace sap {
676
654
  sContentProviderId?: string
677
655
  ): jQuery.Promise;
678
656
  /**
679
- * @SINCE 1.21.2
657
+ * @since 1.21.2
680
658
  * @deprecated (since 1.112) - Please use {@link #addBookmark} instead.
681
659
  *
682
660
  * Adds the catalog tile with the given ID to given group. The catalog tile is looked up in the legacy SAP
@@ -710,7 +688,7 @@ declare namespace sap {
710
688
  }
711
689
  ): jQuery.Promise;
712
690
  /**
713
- * @SINCE 1.17.1
691
+ * @since 1.17.1
714
692
  *
715
693
  * Counts **all** bookmarks pointing to the given URL from all of the user's pages. You can use this method
716
694
  * to check if a bookmark already exists. This is a potentially asynchronous operation in case the user's
@@ -726,10 +704,14 @@ declare namespace sap {
726
704
  /**
727
705
  * The URL of the bookmarks to be counted, exactly as specified to {@link #addBookmark}.
728
706
  */
729
- sUrl: string
707
+ sUrl: string,
708
+ /**
709
+ * The Content Provider ID.
710
+ */
711
+ sContentProviderId: string
730
712
  ): jQuery.Promise;
731
713
  /**
732
- * @SINCE 1.17.1
714
+ * @since 1.17.1
733
715
  *
734
716
  * Deletes **all** bookmarks pointing to the given URL from all of the user's pages.
735
717
  * See:
@@ -751,7 +733,7 @@ declare namespace sap {
751
733
  sContentProviderId?: string
752
734
  ): jQuery.Promise;
753
735
  /**
754
- * @SINCE 1.81
736
+ * @since 1.81
755
737
  *
756
738
  * Returns available content nodes based on the current launchpad context. (Classic homepage, spaces mode)
757
739
  *
@@ -763,7 +745,7 @@ declare namespace sap {
763
745
  * It has the following properties:
764
746
  * - id: ID of the content node
765
747
  * - label: Human-readable representation of a content node which can be displayed in a control
766
- * - type: Specifies the content node type. E.g: space, page, group, etc. See {@link sap.ushell.ContentNodeType}
748
+ * - type: Specifies the content node type. E.g: space, page, group, etc. See {@link sap.ushell.ContentNodeType }
767
749
  *
768
750
  * - isContainer: Specifies if a bookmark can be added
769
751
  * - children: Specifies sub-nodes
@@ -772,7 +754,7 @@ declare namespace sap {
772
754
  */
773
755
  getContentNodes(): Promise<sap.ushell.services.Bookmark.ContentNode[]>;
774
756
  /**
775
- * @SINCE 1.17.1
757
+ * @since 1.17.1
776
758
  *
777
759
  * Updates **all** bookmarks pointing to the given URL on all of the user's pages with the given new parameters.
778
760
  * Parameters which are omitted are not changed in the existing bookmarks.
@@ -792,9 +774,64 @@ declare namespace sap {
792
774
  */
793
775
  sUrl: string,
794
776
  /**
795
- * The bookmark parameters as documented in {@link #addBookmark}.
777
+ * Bookmark parameters. In addition to title and URL, a bookmark might allow additional settings, such as
778
+ * an icon or a subtitle. Which settings are supported depends on the environment in which the application
779
+ * is running. Unsupported parameters will be ignored.
796
780
  */
797
- oParameters: object,
781
+ oParameters: {
782
+ /**
783
+ * The title of the bookmark.
784
+ */
785
+ title: string;
786
+ /**
787
+ * The target URL or intent of the bookmark. If the target application shall run in the current shell, the
788
+ * URL has to be a valid intent, i.e. in the format like `"#SO-Action?P1=a&P2=x&/route?RPV=1"`.
789
+ */
790
+ url: string;
791
+ /**
792
+ * The optional icon URL of the bookmark (e.g. `"sap-icon://home"`).
793
+ */
794
+ icon?: string;
795
+ /**
796
+ * The information text of the bookmark.
797
+ */
798
+ info?: string;
799
+ /**
800
+ * The subtitle of the bookmark.
801
+ */
802
+ subtitle?: string;
803
+ /**
804
+ * The URL to a REST or OData service that provides some dynamic information for the bookmark.
805
+ */
806
+ serviceUrl?: string;
807
+ /**
808
+ * Metadata for parameter serviceUrl. Mandatory to specify if parameter serviceURL contains semantic date
809
+ * ranges. This does not influence the data source of the app itself.
810
+ */
811
+ dataSource?: {
812
+ /**
813
+ * The type of the serviceURL's service. Only "OData" is supported.
814
+ */
815
+ type?: string;
816
+ /**
817
+ * Additional settings for the data source.
818
+ */
819
+ settings?: {
820
+ /**
821
+ * The OData version of parameter serviceURL. Valid values are "2.0" and "4.0".
822
+ */
823
+ odataVersion?: object;
824
+ };
825
+ };
826
+ /**
827
+ * The refresh interval for the `serviceUrl` in seconds.
828
+ */
829
+ serviceRefreshInterval?: string;
830
+ /**
831
+ * The unit for the number retrieved from `serviceUrl`.
832
+ */
833
+ numberUnit?: string;
834
+ },
798
835
  /**
799
836
  * The contentProviderId or undefined outside the cFLP
800
837
  */
@@ -802,7 +839,7 @@ declare namespace sap {
802
839
  ): jQuery.Promise;
803
840
  }
804
841
  /**
805
- * @SINCE 1.64.0
842
+ * @since 1.64.0
806
843
  *
807
844
  * The unified shell's Configuration service, which allows to attach to **selected** launchpad configuration
808
845
  * settings and their value changes.
@@ -817,7 +854,7 @@ declare namespace sap {
817
854
  constructor();
818
855
  }
819
856
  /**
820
- * @SINCE 1.15.0
857
+ * @since 1.15.0
821
858
  *
822
859
  * The Unified Shell's CrossApplicationNavigation service allows to navigate to "external" targets outside
823
860
  * of the currently running app (but still in scope of the current Fiori launchpad) or create links to such
@@ -908,7 +945,7 @@ declare namespace sap {
908
945
  sHashFragment: string
909
946
  ): jQuery.Promise;
910
947
  /**
911
- * @SINCE 1.38.0
948
+ * @since 1.38.0
912
949
  *
913
950
  * Returns a list of semantic objects of the intents the current user can navigate to.
914
951
  *
@@ -919,7 +956,7 @@ declare namespace sap {
919
956
  */
920
957
  getDistinctSemanticObjects(): jQuery.Promise;
921
958
  /**
922
- * @SINCE 1.38.0
959
+ * @since 1.38.0
923
960
  *
924
961
  * Resolves the given semantic object (and action) and business parameters to a list of links available
925
962
  * to the user.
@@ -948,7 +985,7 @@ declare namespace sap {
948
985
  * is in **internal** format, before putting it into a link tag, you must invoke:
949
986
  * ```javascript
950
987
  *
951
- * externalHash = oCrossApplicationNavigationService.hrefForExternal({ target : { shellHash : oLink.intent} }, that.oComponent);
988
+ * externalHash = oCrossApplicationNavigationService.hrefForExternal({ target : { shellHash : oLink.intent } }, that.oComponent);
952
989
  * ```
953
990
  * NOTE: in case the mass invocation interface is used (see `vArgs` parameter explanation above),
954
991
  * the promise will resolve to an array of arrays of arrays. For example, if the mass interface specified
@@ -976,6 +1013,8 @@ declare namespace sap {
976
1013
  getLinks(
977
1014
  /**
978
1015
  * An object containing nominal arguments for the method, having the following structure:
1016
+ *
1017
+ *
979
1018
  * ```javascript
980
1019
  *
981
1020
  * {
@@ -994,19 +1033,16 @@ declare namespace sap {
994
1033
  * // - "text" lexicographical sort on returned 'text' field
995
1034
  * // - "priority" experimental - top intents are returned first
996
1035
  *
997
- * treatTechHintAsFilter : true, // optional, defaults to false
998
- * // if true, only apps that match
999
- * // exactly the supplied technology
1000
- * // (e.g. sap-ui-tech-hint=WDA) will be considered
1036
+ * treatTechHintAsFilter : true, // optional, defaults to false.
1037
+ * // if true, only apps that match exactly the supplied technology (e.g. sap-ui-tech-hint=WDA) will be considered.
1001
1038
  *
1002
1039
  * ui5Component: UI5Component, // mandatory, the UI5 component invoking the service, shall be a root component!
1003
1040
  *
1004
- * appStateKey: "abc123...", // optional, application state key to add to the generated links, SAP internal usage only
1041
+ * appStateKey: "abc123...", // optional, application state key to add to the generated links, SAP internal usage only.
1005
1042
  *
1006
- * compactIntents: true // optional, whether intents should be returned in compact format.
1007
- * // Defaults to false.
1043
+ * compactIntents: true // optional, whether intents should be returned in compact format. Defaults to false.
1008
1044
  *
1009
- * ignoreFormFactor: true, // optional, defaults to false, deprecated, do not use, may have no effect in the future
1045
+ * ignoreFormFactor: true, // optional, defaults to false, deprecated, do not use, may have no effect in the future.
1010
1046
  *
1011
1047
  * tags: ["tag-1", "tag-2"] // optional, if specified, only returns links that match inbound with certain tags.
1012
1048
  * }
@@ -1067,16 +1103,104 @@ declare namespace sap {
1067
1103
  * Calling this method with no arguments will produce the same result as if the method was called with
1068
1104
  * an empty object.
1069
1105
  */
1070
- vArgs?: object | object[]
1106
+ vArgs?:
1107
+ | {
1108
+ /**
1109
+ * Optional, matches any semantic objects if undefined
1110
+ */
1111
+ semanticObject?: string;
1112
+ /**
1113
+ * Optional, matches any actions if undefined
1114
+ */
1115
+ action?: string;
1116
+ /**
1117
+ * Optional business parameters
1118
+ */
1119
+ params?: object;
1120
+ /**
1121
+ * Optional, defaults to false. If true, returns only the links that use at least one (non sap-) parameter
1122
+ * from 'params'.
1123
+ */
1124
+ withAtLeastOneUsedParam?: boolean;
1125
+ /**
1126
+ * Optional parameter that decides on how the returned results will be sorted.
1127
+ */
1128
+ sortResultsBy?: string;
1129
+ /**
1130
+ * Optional, defaults to false. If true, only apps that match exactly the supplied technology (e.g. sap-ui-tech-hint=WDA)
1131
+ * will be considered.
1132
+ */
1133
+ treatTechHintAsFilter?: boolean;
1134
+ /**
1135
+ * Mandatory, the UI5 component invoking the service, shall be a root component.
1136
+ */
1137
+ ui5Component: sap.ui.core.Component;
1138
+ /**
1139
+ * Optional, application state key to add to the generated links, SAP internal usage only.
1140
+ */
1141
+ appStateKey?: string;
1142
+ /**
1143
+ * Optional, whether intents should be returned in compact format. Defaults to false.
1144
+ */
1145
+ compactIntents?: boolean;
1146
+ /**
1147
+ * Optional, if specified, only returns links that match inbound with certain tags.
1148
+ */
1149
+ tags?: string[];
1150
+ }
1151
+ | Array<{
1152
+ /**
1153
+ * Optional, matches any semantic objects if undefined
1154
+ */
1155
+ semanticObject?: string;
1156
+ /**
1157
+ * Optional, matches any actions if undefined
1158
+ */
1159
+ action?: string;
1160
+ /**
1161
+ * Optional business parameters
1162
+ */
1163
+ params?: object;
1164
+ /**
1165
+ * Optional, defaults to false. If true, returns only the links that use at least one (non sap-) parameter
1166
+ * from 'params'.
1167
+ */
1168
+ withAtLeastOneUsedParam?: boolean;
1169
+ /**
1170
+ * Optional parameter that decides on how the returned results will be sorted.
1171
+ */
1172
+ sortResultsBy?: string;
1173
+ /**
1174
+ * Optional, defaults to false. If true, only apps that match exactly the supplied technology (e.g. sap-ui-tech-hint=WDA)
1175
+ * will be considered.
1176
+ */
1177
+ treatTechHintAsFilter?: boolean;
1178
+ /**
1179
+ * Mandatory, the UI5 component invoking the service, shall be a root component.
1180
+ */
1181
+ ui5Component: sap.ui.core.Component;
1182
+ /**
1183
+ * Optional, application state key to add to the generated links, SAP internal usage only.
1184
+ */
1185
+ appStateKey?: string;
1186
+ /**
1187
+ * Optional, whether intents should be returned in compact format. Defaults to false.
1188
+ */
1189
+ compactIntents?: boolean;
1190
+ /**
1191
+ * Optional, if specified, only returns links that match inbound with certain tags.
1192
+ */
1193
+ tags?: string[];
1194
+ }>
1071
1195
  ): jQuery.Promise;
1072
1196
  /**
1073
- * @SINCE 1.48
1197
+ * @since 1.48
1074
1198
  *
1075
1199
  * For a given semantic object, this method considers all actions associated with the semantic object and
1076
1200
  * returns the one tagged as a "primaryAction". If no inbound tagged as "primaryAction" exists, then the
1077
1201
  * intent of the first inbound (after sorting has been applied) matching the action "displayFactSheet".
1078
1202
  *
1079
- * The primary intent is determined by querying {@link sap.ushell.services.CrossApplicationNavigation#getLinks}
1203
+ * The primary intent is determined by querying {@link sap.ushell.services.CrossApplicationNavigation#getLinks }
1080
1204
  * with the given semantic object and optional parameter. Then the resulting list is filtered to the outcome
1081
1205
  * that a single item remains.
1082
1206
  *
@@ -1105,7 +1229,7 @@ declare namespace sap {
1105
1229
  mParameters?: object
1106
1230
  ): jQuery.Deferred;
1107
1231
  /**
1108
- * @SINCE 1.19.0
1232
+ * @since 1.19.0
1109
1233
  * @deprecated (since 1.38) - Please use {@link #getLinks} instead.
1110
1234
  *
1111
1235
  * Resolves a given semantic object and business parameters to a list of links, taking into account the
@@ -1130,7 +1254,7 @@ declare namespace sap {
1130
1254
  * Note that the intent is in **internal** format, before putting it into a link tag, you must invoke:
1131
1255
  * ```javascript
1132
1256
  *
1133
- * externalHash = oCrossApplicationNavigationService.hrefForExternal({ target : { shellHash : oLink.intent} }, that.oComponent);
1257
+ * externalHash = oCrossApplicationNavigationService.hrefForExternal({ target : { shellHash : oLink.intent } }, that.oComponent);
1134
1258
  * ```
1135
1259
  */
1136
1260
  getSemanticObjectLinks(
@@ -1177,7 +1301,7 @@ declare namespace sap {
1177
1301
  iSteps: number
1178
1302
  ): void;
1179
1303
  /**
1180
- * @SINCE 1.15.0
1304
+ * @since 1.15.0
1181
1305
  * @deprecated (since 1.94) - Please use {@link #hrefForAppSpecificHashAsync} instead.
1182
1306
  *
1183
1307
  * Returns a string which can be put into the DOM (e.g. in a link tag) given an application specific hash
@@ -1198,7 +1322,7 @@ declare namespace sap {
1198
1322
  sAppHash: string
1199
1323
  ): string;
1200
1324
  /**
1201
- * @SINCE 1.94.0
1325
+ * @since 1.94.0
1202
1326
  *
1203
1327
  * Returns a Promise which resolves a string that can be put into the DOM (e.g. in a link tag) given an
1204
1328
  * application specific hash suffix
@@ -1218,7 +1342,7 @@ declare namespace sap {
1218
1342
  sAppHash: string
1219
1343
  ): Promise<string>;
1220
1344
  /**
1221
- * @SINCE 1.15.0
1345
+ * @since 1.15.0
1222
1346
  * @deprecated (since 1.98) - Please use {@link #hrefForExternalAsync} instead.
1223
1347
  *
1224
1348
  * Returns a string which can be put into the DOM (e.g. in a link tag). **Note:** The generated url / url
@@ -1303,7 +1427,7 @@ declare namespace sap {
1303
1427
  bAsync: boolean
1304
1428
  ): string | Promise<string>;
1305
1429
  /**
1306
- * @SINCE 1.15.0
1430
+ * @since 1.15.0
1307
1431
  * @deprecated (since 1.98) - Please use {@link #hrefForExternalAsync} instead.
1308
1432
  *
1309
1433
  * Returns a string which can be put into the DOM (e.g. in a link tag). **Note:** The generated url / url
@@ -1384,7 +1508,7 @@ declare namespace sap {
1384
1508
  bAsync: boolean
1385
1509
  ): string | Promise<string>;
1386
1510
  /**
1387
- * @SINCE 1.94.0
1511
+ * @since 1.94.0
1388
1512
  *
1389
1513
  * Returns a promise resolving to a URL that launches an app with certain parameters. The URL can be used
1390
1514
  * to define a link to a Fiori application, for example.
@@ -1475,7 +1599,7 @@ declare namespace sap {
1475
1599
  oComponent?: object
1476
1600
  ): Promise<string>;
1477
1601
  /**
1478
- * @SINCE 1.36.0
1602
+ * @since 1.36.0
1479
1603
  * @deprecated (since 1.94) - Please use {@link #isInitialNavigationAsync} instead.
1480
1604
  *
1481
1605
  * Checks wether the FLP currently shows the initially loaded navigation target (i.e. the intent it was
@@ -1486,7 +1610,7 @@ declare namespace sap {
1486
1610
  */
1487
1611
  isInitialNavigation(): boolean;
1488
1612
  /**
1489
- * @SINCE 1.94.0
1613
+ * @since 1.94.0
1490
1614
  *
1491
1615
  * Checks whether the FLP has performed the first navigation. This method can be used to detect whether
1492
1616
  * the current app was started directly, that is, without a previous navigation to another app, to the FLP
@@ -1496,7 +1620,7 @@ declare namespace sap {
1496
1620
  */
1497
1621
  isInitialNavigationAsync(): Promise<boolean>;
1498
1622
  /**
1499
- * @SINCE 1.19.1
1623
+ * @since 1.19.1
1500
1624
  * @deprecated (since 1.31) - Please use {@link #isNavigationSupported} instead. Note that this has a slightly
1501
1625
  * different response format.
1502
1626
  *
@@ -1545,15 +1669,15 @@ declare namespace sap {
1545
1669
  oComponent?: object
1546
1670
  ): jQuery.Promise;
1547
1671
  /**
1548
- * @SINCE 1.32
1672
+ * @since 1.32
1549
1673
  *
1550
1674
  * Tells whether the given navigation intents are supported for the given parameters, form factor etc. .
1551
1675
  * "Supported" means that a valid navigation target is configured for the user and for the given device.
1552
1676
  *
1553
- * `isNavigationSupported` is effectively a test function for {@link sap.ushell.services.CrossApplicationNavigation#toExternal}
1677
+ * `isNavigationSupported` is effectively a test function for {@link sap.ushell.services.CrossApplicationNavigation#toExternal }
1554
1678
  * and {@link sap.ushell.services.CrossApplicationNavigation#hrefForExternal}.
1555
1679
  *
1556
- * It is functionally equivalent to {@link sap.ushell.services.CrossApplicationNavigation#isIntentSupported}
1680
+ * It is functionally equivalent to {@link sap.ushell.services.CrossApplicationNavigation#isIntentSupported }
1557
1681
  * but accepts the same interface as {@link sap.ushell.services.CrossApplicationNavigation#toExternal} and
1558
1682
  * {@link sap.ushell.services.CrossApplicationNavigation#hrefForExternal}.
1559
1683
  *
@@ -1659,7 +1783,7 @@ declare namespace sap {
1659
1783
  oComponent?: object
1660
1784
  ): jQuery.Promise;
1661
1785
  /**
1662
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1786
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1663
1787
  *
1664
1788
  * Resolves the URL hash fragment.
1665
1789
  *
@@ -1677,7 +1801,7 @@ declare namespace sap {
1677
1801
  sHashFragment: string
1678
1802
  ): jQuery.Promise;
1679
1803
  /**
1680
- * @SINCE 1.15.0
1804
+ * @since 1.15.0
1681
1805
  *
1682
1806
  * Triggers a navigation to a specified target outside of the currently running application (e.g. different
1683
1807
  * launchpad application). Invocation will trigger a hash change and subsequent invocation of the target.
@@ -1791,7 +1915,7 @@ declare namespace sap {
1791
1915
  ): Promise<void>;
1792
1916
  }
1793
1917
  /**
1794
- * @SINCE 1.25.1
1918
+ * @since 1.25.1
1795
1919
  * @deprecated (since 1.93)
1796
1920
  *
1797
1921
  * The Unified Shell's end user feedback service. This service is deprecated and does nothing. End user
@@ -1807,7 +1931,7 @@ declare namespace sap {
1807
1931
  constructor();
1808
1932
 
1809
1933
  /**
1810
- * @SINCE 1.25.1
1934
+ * @since 1.25.1
1811
1935
  * @deprecated (since 1.93)
1812
1936
  *
1813
1937
  *
@@ -1815,7 +1939,7 @@ declare namespace sap {
1815
1939
  */
1816
1940
  getLegalText(): string;
1817
1941
  /**
1818
- * @SINCE 1.25.1
1942
+ * @since 1.25.1
1819
1943
  * @deprecated (since 1.93)
1820
1944
  *
1821
1945
  * The service is deprecated. The function always returns a negative answer.
@@ -1824,7 +1948,7 @@ declare namespace sap {
1824
1948
  */
1825
1949
  isEnabled(): Object;
1826
1950
  /**
1827
- * @SINCE 1.25.1
1951
+ * @since 1.25.1
1828
1952
  * @deprecated (since 1.93)
1829
1953
  *
1830
1954
  * Sends a feedback.
@@ -1834,7 +1958,7 @@ declare namespace sap {
1834
1958
  sendFeedback(): Promise<any>;
1835
1959
  }
1836
1960
  /**
1837
- * @SINCE 1.15.0
1961
+ * @since 1.15.0
1838
1962
  * @deprecated (since 1.99) - This service has been deprecated as it only works for the classic homepage.
1839
1963
  *
1840
1964
  * A service for handling groups, tiles and catalogs.
@@ -1936,7 +2060,7 @@ declare namespace sap {
1936
2060
  oTile: object
1937
2061
  ): Function;
1938
2062
  /**
1939
- * @SINCE 1.21.2
2063
+ * @since 1.21.2
1940
2064
  *
1941
2065
  * Returns catalog's technical data.
1942
2066
  *
@@ -1953,7 +2077,7 @@ declare namespace sap {
1953
2077
  oCatalog: object
1954
2078
  ): object;
1955
2079
  /**
1956
- * @SINCE 1.17.1
2080
+ * @since 1.17.1
1957
2081
  *
1958
2082
  * Returns the catalog's technical error message in case it could not be loaded from the backend. **Beware:**
1959
2083
  * The technical error message is not translated!
@@ -2016,7 +2140,7 @@ declare namespace sap {
2016
2140
  oCatalogTile: object
2017
2141
  ): string[];
2018
2142
  /**
2019
- * @SINCE 1.16.3
2143
+ * @since 1.16.3
2020
2144
  *
2021
2145
  * Returns preview icon for a catalog tile.
2022
2146
  *
@@ -2030,7 +2154,7 @@ declare namespace sap {
2030
2154
  oCatalogTile: object
2031
2155
  ): string;
2032
2156
  /**
2033
- * @SINCE 1.40
2157
+ * @since 1.40
2034
2158
  *
2035
2159
  * Returns preview subtitle for a catalog tile.
2036
2160
  *
@@ -2044,7 +2168,7 @@ declare namespace sap {
2044
2168
  oCatalogTile: object
2045
2169
  ): string;
2046
2170
  /**
2047
- * @SINCE 1.16.3
2171
+ * @since 1.16.3
2048
2172
  *
2049
2173
  * Returns preview title for a catalog tile.
2050
2174
  *
@@ -2102,7 +2226,7 @@ declare namespace sap {
2102
2226
  oCatalogTile: object
2103
2227
  ): string;
2104
2228
  /**
2105
- * @SINCE 1.67.0
2229
+ * @since 1.67.0
2106
2230
  *
2107
2231
  * Returns the catalog tile info
2108
2232
  *
@@ -2282,7 +2406,7 @@ declare namespace sap {
2282
2406
  oTile: object
2283
2407
  ): object;
2284
2408
  /**
2285
- * @SINCE 1.16.4
2409
+ * @since 1.16.4
2286
2410
  *
2287
2411
  * Returns whether the catalogs collection previously returned by `getCatalogs()` is still valid.
2288
2412
  *
@@ -2539,7 +2663,7 @@ declare namespace sap {
2539
2663
  ): void;
2540
2664
  }
2541
2665
  /**
2542
- * @SINCE 1.16.0
2666
+ * @since 1.16.0
2543
2667
  */
2544
2668
  class Message {
2545
2669
  /**
@@ -2553,7 +2677,7 @@ declare namespace sap {
2553
2677
  constructor();
2554
2678
 
2555
2679
  /**
2556
- * @SINCE 1.16.0
2680
+ * @since 1.16.0
2557
2681
  *
2558
2682
  * Shows an confirmation dialog on the screen.
2559
2683
  *
@@ -2591,7 +2715,7 @@ declare namespace sap {
2591
2715
  | string[]
2592
2716
  ): void;
2593
2717
  /**
2594
- * @SINCE 1.16.0
2718
+ * @since 1.16.0
2595
2719
  *
2596
2720
  * Shows an error message on the screen.
2597
2721
  */
@@ -2606,10 +2730,10 @@ declare namespace sap {
2606
2730
  sTitle?: string
2607
2731
  ): void;
2608
2732
  /**
2609
- * @SINCE 1.81.0
2610
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2733
+ * @since 1.81.0
2734
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2611
2735
  *
2612
- * Shows an error message with details on the screen. If more than one control should be shown, an {sap.m.VBox}
2736
+ * Shows an error message with details on the screen. If more than one control should be shown, an {sap.m.VBox }
2613
2737
  * can be used. The default title is "error". If no custom buttons are given, an emphasized "close" button
2614
2738
  * is shown.
2615
2739
  *
@@ -2634,7 +2758,7 @@ declare namespace sap {
2634
2758
  buttons?: sap.m.Button[]
2635
2759
  ): sap.m.Dialog;
2636
2760
  /**
2637
- * @SINCE 1.16.0
2761
+ * @since 1.16.0
2638
2762
  *
2639
2763
  * Shows a MessageToast on the screen.
2640
2764
  */
@@ -2650,9 +2774,12 @@ declare namespace sap {
2650
2774
  ): void;
2651
2775
  }
2652
2776
  /**
2653
- * @SINCE 1.15.0
2777
+ * @since 1.15.0
2778
+ *
2779
+ * The Unified Shell's internal navigation target resolution service.
2654
2780
  *
2655
- * The Unified Shell's internal navigation target resolution service
2781
+ * **Please note:** To retrieve a valid instance of this service you must call `sap.ushell.Container.getServiceAsync("NavTargetResolution")`.
2782
+ * For details see {@link sap.ushell.services.Container#getServiceAsync}.
2656
2783
  *
2657
2784
  * Methods in this class deal with *internal* representations of the shell hash.
2658
2785
  *
@@ -2661,18 +2788,7 @@ declare namespace sap {
2661
2788
  * ... )
2662
2789
  */
2663
2790
  class NavTargetResolution {
2664
- /**
2665
- * This method MUST be called by the Unified Shell's container only, others MUST call `sap.ushell.Container.getServiceAsync("NavTargetResolution").then(function
2666
- * (NavTargetResolution) {});`. Constructs a new instance of the navigation target resolution service.
2667
- * See:
2668
- * sap.ushell.services.Container#getServiceAsync
2669
- */
2670
- constructor(
2671
- /**
2672
- * a Service configuration
2673
- */
2674
- oServiceConfiguration: object
2675
- );
2791
+ constructor();
2676
2792
 
2677
2793
  /**
2678
2794
  * expands a URL hash fragment
@@ -2691,7 +2807,7 @@ declare namespace sap {
2691
2807
  sHashFragment: string
2692
2808
  ): string;
2693
2809
  /**
2694
- * @SINCE 1.32
2810
+ * @since 1.32
2695
2811
  *
2696
2812
  * Tells whether the given navigation intent(s) are supported for the given parameters Supported" means
2697
2813
  * that a valid navigation target is configured for the user for the given device form factor.
@@ -2704,7 +2820,7 @@ declare namespace sap {
2704
2820
  * Example:
2705
2821
  *
2706
2822
  * aIntents: an array of parameterized (parsed) Intent objects, in the corresponding structure to arguments
2707
- * to {@link sap.ushell.services.CrossApplicationNavigation.toExternal}, {@link sap.ushell.services.CrossApplicationNavigation.hrefForExternal}
2823
+ * to {@link sap.ushell.services.CrossApplicationNavigation.toExternal}, {@link sap.ushell.services.CrossApplicationNavigation.hrefForExternal }
2708
2824
  *
2709
2825
  * ```javascript
2710
2826
  *
@@ -2803,7 +2919,7 @@ declare namespace sap {
2803
2919
  *
2804
2920
  * This is an asynchronous operation.
2805
2921
  *
2806
- * @returns A jQuery.Promise. Its `done()` function gets an object that you can use to create a {@link sap.ushell.components.container.ApplicationContainer}
2922
+ * @returns A jQuery.Promise. Its `done()` function gets an object that you can use to create a {@link sap.ushell.components.container.ApplicationContainer }
2807
2923
  * or `undefined` in case the hash fragment was empty. Typically it contains the following information:
2808
2924
  *
2809
2925
  * ```javascript
@@ -2828,7 +2944,7 @@ declare namespace sap {
2828
2944
  sHashFragment: string
2829
2945
  ): object;
2830
2946
  /**
2831
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2947
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2832
2948
  *
2833
2949
  * Resolves a navigation target taking into account the sap-system
2834
2950
  *
@@ -2869,7 +2985,7 @@ declare namespace sap {
2869
2985
  ): jQuery.Promise;
2870
2986
  }
2871
2987
  /**
2872
- * @SINCE 1.32.0
2988
+ * @since 1.32.0
2873
2989
  */
2874
2990
  class Notifications {
2875
2991
  /**
@@ -2914,7 +3030,7 @@ declare namespace sap {
2914
3030
  );
2915
3031
 
2916
3032
  /**
2917
- * @SINCE 1.34
3033
+ * @since 1.34
2918
3034
  *
2919
3035
  * Launches dismiss notification call.
2920
3036
  *
@@ -2928,7 +3044,7 @@ declare namespace sap {
2928
3044
  sNotificationId: object
2929
3045
  ): Promise<any>;
2930
3046
  /**
2931
- * @SINCE 1.32
3047
+ * @since 1.32
2932
3048
  *
2933
3049
  * Launches a notification action oData call.
2934
3050
  * After launching the action, the function gets updated notification data in order to push the updated
@@ -2947,7 +3063,7 @@ declare namespace sap {
2947
3063
  sActionId: object
2948
3064
  ): Promise<any>;
2949
3065
  /**
2950
- * @SINCE 1.38
3066
+ * @since 1.38
2951
3067
  *
2952
3068
  * Returns the notifications of the user sorted by type include the group headers and the notifications
2953
3069
  *
@@ -2955,7 +3071,7 @@ declare namespace sap {
2955
3071
  */
2956
3072
  getNotificationsByTypeWithGroupHeaders(): Promise<any>;
2957
3073
  /**
2958
- * @SINCE 1.44
3074
+ * @since 1.44
2959
3075
  *
2960
3076
  * Returns the number of notifications
2961
3077
  * e.g. Notifications for user.
@@ -2964,7 +3080,7 @@ declare namespace sap {
2964
3080
  */
2965
3081
  getNotificationsCount(): number;
2966
3082
  /**
2967
- * @SINCE 1.44
3083
+ * @since 1.44
2968
3084
  *
2969
3085
  * Returns the group headers of the user notifications
2970
3086
  *
@@ -2972,7 +3088,7 @@ declare namespace sap {
2972
3088
  */
2973
3089
  getNotificationsGroupHeaders(): Promise<any>;
2974
3090
  /**
2975
- * @SINCE 1.32
3091
+ * @since 1.32
2976
3092
  *
2977
3093
  * Returns the number of unseen notifications
2978
3094
  * e.g. Notifications that the user hasn't seen yet.
@@ -2981,7 +3097,7 @@ declare namespace sap {
2981
3097
  */
2982
3098
  getUnseenNotificationsCount(): Promise<any>;
2983
3099
  /**
2984
- * @SINCE 1.32
3100
+ * @since 1.32
2985
3101
  *
2986
3102
  * Initializes the notification service
2987
3103
  *
@@ -3000,7 +3116,7 @@ declare namespace sap {
3000
3116
  */
3001
3117
  init(): void;
3002
3118
  /**
3003
- * @SINCE 1.32.0
3119
+ * @since 1.32.0
3004
3120
  *
3005
3121
  * Indicates whether notification service is enabled.
3006
3122
  * Enabling is based on the `enable` service configuration flag.
@@ -3011,14 +3127,14 @@ declare namespace sap {
3011
3127
  */
3012
3128
  isEnabled(): boolean;
3013
3129
  /**
3014
- * @SINCE 1.38
3130
+ * @since 1.38
3015
3131
  *
3016
3132
  *
3017
3133
  * @returns boolean value whether first request was already performed and data was returned.
3018
3134
  */
3019
3135
  isFirstDataLoaded(): boolean;
3020
3136
  /**
3021
- * @SINCE 1.34
3137
+ * @since 1.34
3022
3138
  *
3023
3139
  * Launches mark as read notification call.
3024
3140
  * After launching the action, the function gets updated notification data in order to push the updated
@@ -3033,14 +3149,14 @@ declare namespace sap {
3033
3149
  sNotificationId: object
3034
3150
  ): Promise<any>;
3035
3151
  /**
3036
- * @SINCE 1.32
3152
+ * @since 1.32
3037
3153
  *
3038
3154
  * Mark all notifications as seen.
3039
3155
  * the main use-case is when the user navigated to the notification center and sees all the pending notifications.
3040
3156
  */
3041
3157
  notificationsSeen(): void;
3042
3158
  /**
3043
- * @SINCE 1.32
3159
+ * @since 1.32
3044
3160
  *
3045
3161
  * Gets a callback function that will be called when updated unseen notifications count is available.
3046
3162
  */
@@ -3051,7 +3167,7 @@ declare namespace sap {
3051
3167
  callback: object
3052
3168
  ): void;
3053
3169
  /**
3054
- * @SINCE 1.32
3170
+ * @since 1.32
3055
3171
  *
3056
3172
  * Gets a callback function that will be called when updated notifications data is available.
3057
3173
  */
@@ -3063,7 +3179,7 @@ declare namespace sap {
3063
3179
  ): void;
3064
3180
  }
3065
3181
  /**
3066
- * @SINCE 1.15.0
3182
+ * @since 1.15.0
3067
3183
  */
3068
3184
  class Personalization {
3069
3185
  /**
@@ -3089,7 +3205,7 @@ declare namespace sap {
3089
3205
  );
3090
3206
 
3091
3207
  /**
3092
- * @SINCE 1.22.0
3208
+ * @since 1.22.0
3093
3209
  *
3094
3210
  * Factory method to obtain an empty Data Context object. When data present in a prior context is not relevant
3095
3211
  * (e.g. when using a "uniquely" generated key and planning to overwrite any colliding front-end server
@@ -3102,7 +3218,7 @@ declare namespace sap {
3102
3218
  *
3103
3219
  * An initial object is returned.
3104
3220
  *
3105
- * @returns Promise object whose done function returns a {@link sap.ushell.services.Personalization.ContextContainer}
3221
+ * @returns Promise object whose done function returns a {@link sap.ushell.services.Personalization.ContextContainer }
3106
3222
  * object as parameter. The personalization container provides two different interfaces to synchronously
3107
3223
  * operate on personalization data. In the item mode the container contains items as name value pairs for
3108
3224
  * personalization data. In the variant mode the container contains variant sets which contain variants
@@ -3128,7 +3244,7 @@ declare namespace sap {
3128
3244
  oComponent: sap.ui.core.Component
3129
3245
  ): object;
3130
3246
  /**
3131
- * @SINCE 1.22.0
3247
+ * @since 1.22.0
3132
3248
  *
3133
3249
  * Asynchronously starts a deletion request for the given container identified by sContainerKey. Can be
3134
3250
  * called without having ever called getContainer with the corresponding key
@@ -3152,7 +3268,7 @@ declare namespace sap {
3152
3268
  oScope: object
3153
3269
  ): object;
3154
3270
  /**
3155
- * @SINCE 1.18.0
3271
+ * @since 1.18.0
3156
3272
  * @deprecated (since 1.22) - Please use {@link #delContainer} instead.
3157
3273
  *
3158
3274
  * Asynchronously starts a deletion request for the given container identified by sContainerKey. Can be
@@ -3173,7 +3289,7 @@ declare namespace sap {
3173
3289
  sContainerKey: string
3174
3290
  ): object;
3175
3291
  /**
3176
- * @SINCE 1.22.0
3292
+ * @since 1.22.0
3177
3293
  *
3178
3294
  * Factory method to obtain a Data Context object, which is a local copy of the persistence layer data.
3179
3295
  * The Container data is asynchronously read on creation if present, otherwise an initial object is created.
@@ -3239,7 +3355,7 @@ declare namespace sap {
3239
3355
  * server persistent storage. Thus a sequence delete( [validity 0])/wait for promise, getContainer(sKey,{
3240
3356
  * validity : Infinity}) may return a valid dataset.
3241
3357
  *
3242
- * @returns Promise object whose done function returns a {@link sap.ushell.services.Personalization.ContextContainer}
3358
+ * @returns Promise object whose done function returns a {@link sap.ushell.services.Personalization.ContextContainer }
3243
3359
  * object as parameter. The container provides setItemValue / getItemValue methods to synchronously operate
3244
3360
  * on personalization data. By wrapping it in a VariantSetAdapter, an alternate interface to maintain variants
3245
3361
  * can be obtained.
@@ -3266,7 +3382,7 @@ declare namespace sap {
3266
3382
  oComponent: sap.ui.core.Component
3267
3383
  ): object;
3268
3384
  /**
3269
- * @SINCE 1.18.0
3385
+ * @since 1.18.0
3270
3386
  * @deprecated (since 1.21) - Please use {@link #getContainer} instead.
3271
3387
  *
3272
3388
  * This interface is deprecated since 1.22, please use getContainer / delContainer.
@@ -3307,7 +3423,7 @@ declare namespace sap {
3307
3423
  *
3308
3424
  * Do not mix up the usage of a personalizer and a personalization container for one containerKey.
3309
3425
  *
3310
- * @returns Promise object whose done function returns a {@link sap.ushell.services.PersonalizationContainer}
3426
+ * @returns Promise object whose done function returns a {@link sap.ushell.services.PersonalizationContainer }
3311
3427
  * object as parameter. The personalization container provides two different interfaces to synchronously
3312
3428
  * operate on personalization data. In the item mode the container contains items as name-value pairs for
3313
3429
  * personalization data. In the variant mode the container contains variant sets which contain variants
@@ -3320,15 +3436,15 @@ declare namespace sap {
3320
3436
  sContainerKey: string
3321
3437
  ): object;
3322
3438
  /**
3323
- * @SINCE 1.15.0
3439
+ * @since 1.15.0
3324
3440
  *
3325
3441
  * Returns a personalizer object which handles personalization by asynchronous operations storing the personalization
3326
3442
  * data immediately via the connected adapter. For each operation a round trip is executed.
3327
3443
  *
3328
3444
  * Do not mix the usage of a personalizer and a personalization container for one containerKey.
3329
3445
  *
3330
- * Fetching multiple Personalizer for the same container, but different items is not supported. Use {@link
3331
- * sap.ushell.services.Personalizer#getContainer} instead for this scenario.
3446
+ * Fetching multiple Personalizer for the same container, but different items is not supported. Use {@link sap.ushell.services.Personalizer#getContainer }
3447
+ * instead for this scenario.
3332
3448
  *
3333
3449
  * @returns {@link sap.ushell.services.Personalizer} which provides generic read and write access to the
3334
3450
  * currently logged on user's personalization settings.
@@ -3358,7 +3474,7 @@ declare namespace sap {
3358
3474
  oComponent?: sap.ui.core.Component
3359
3475
  ): object;
3360
3476
  /**
3361
- * @SINCE 1.18.0
3477
+ * @since 1.18.0
3362
3478
  *
3363
3479
  * Returns a transient personalizer object which handles personalization by asynchronous operations storing
3364
3480
  * the personalization data transiently as an object property. Primary usage of the transient personalizer
@@ -3371,7 +3487,7 @@ declare namespace sap {
3371
3487
  getTransientPersonalizer(): object;
3372
3488
  }
3373
3489
  /**
3374
- * @SINCE 1.18.0
3490
+ * @since 1.18.0
3375
3491
  *
3376
3492
  * The personalization container is the anchor object of the unified shell personalization in container
3377
3493
  * mode.
@@ -3383,7 +3499,7 @@ declare namespace sap {
3383
3499
  constructor();
3384
3500
 
3385
3501
  /**
3386
- * @SINCE 1.18.0
3502
+ * @since 1.18.0
3387
3503
  *
3388
3504
  * Creates a new variant set in the container. In case a variant set with this key is already existing an
3389
3505
  * exception is thrown.
@@ -3397,7 +3513,7 @@ declare namespace sap {
3397
3513
  sVariantSetKey: string
3398
3514
  ): object;
3399
3515
  /**
3400
- * @SINCE 1.18.0
3516
+ * @since 1.18.0
3401
3517
  *
3402
3518
  * Checks if a specific direct item is contained in the container.
3403
3519
  *
@@ -3410,7 +3526,7 @@ declare namespace sap {
3410
3526
  sItemKey: string
3411
3527
  ): boolean;
3412
3528
  /**
3413
- * @SINCE 1.18.0
3529
+ * @since 1.18.0
3414
3530
  *
3415
3531
  * Checks if a specific variant set is contained in the container.
3416
3532
  *
@@ -3423,7 +3539,7 @@ declare namespace sap {
3423
3539
  sVariantSetKey: string
3424
3540
  ): boolean;
3425
3541
  /**
3426
- * @SINCE 1.18.0
3542
+ * @since 1.18.0
3427
3543
  *
3428
3544
  * Deletes a direct item from the container. In case the item does not exist, nothing happens.
3429
3545
  */
@@ -3434,7 +3550,7 @@ declare namespace sap {
3434
3550
  sItemKey: string
3435
3551
  ): void;
3436
3552
  /**
3437
- * @SINCE 1.18.0
3553
+ * @since 1.18.0
3438
3554
  *
3439
3555
  * Deletes a variant set from the container. In case the variant set does not exist nothing happens.
3440
3556
  */
@@ -3445,7 +3561,7 @@ declare namespace sap {
3445
3561
  sVariantSetKey: string
3446
3562
  ): void;
3447
3563
  /**
3448
- * @SINCE 1.18.0
3564
+ * @since 1.18.0
3449
3565
  *
3450
3566
  * Returns an array with the keys of direct items in the container.
3451
3567
  *
@@ -3453,7 +3569,7 @@ declare namespace sap {
3453
3569
  */
3454
3570
  getItemKeys(): any[];
3455
3571
  /**
3456
- * @SINCE 1.18.0
3572
+ * @since 1.18.0
3457
3573
  *
3458
3574
  * Returns the value for a direct item from the container.
3459
3575
  *
@@ -3467,7 +3583,7 @@ declare namespace sap {
3467
3583
  sItemKey: string
3468
3584
  ): object;
3469
3585
  /**
3470
- * @SINCE 1.18.0
3586
+ * @since 1.18.0
3471
3587
  *
3472
3588
  * Returns an array with the keys of the variant sets in the container.
3473
3589
  *
@@ -3475,7 +3591,7 @@ declare namespace sap {
3475
3591
  */
3476
3592
  getVariantSetKeys(): any[];
3477
3593
  /**
3478
- * @SINCE 1.18.0
3594
+ * @since 1.18.0
3479
3595
  *
3480
3596
  * (Re)loads the current container data from the underlying storage asynchronously. The current local data
3481
3597
  * is discarded.
@@ -3489,7 +3605,7 @@ declare namespace sap {
3489
3605
  */
3490
3606
  load(): object;
3491
3607
  /**
3492
- * @SINCE 1.18.0
3608
+ * @since 1.18.0
3493
3609
  *
3494
3610
  * Attempts to save the current container data at the underlying storage asynchronously. The current state
3495
3611
  * is serialized.
@@ -3500,7 +3616,7 @@ declare namespace sap {
3500
3616
  */
3501
3617
  save(): object;
3502
3618
  /**
3503
- * @SINCE 1.18.0
3619
+ * @since 1.18.0
3504
3620
  *
3505
3621
  * Sets the value of a direct item in the container. In case the item is already existing its value is overwritten.
3506
3622
  * In case it is not existing a new item with this key and value is created.
@@ -3517,7 +3633,7 @@ declare namespace sap {
3517
3633
  ): void;
3518
3634
  }
3519
3635
  /**
3520
- * @SINCE 1.18.0
3636
+ * @since 1.18.0
3521
3637
  *
3522
3638
  * The personalization variant contains personalization data. It is used in the personalization container
3523
3639
  * mode.
@@ -3529,7 +3645,7 @@ declare namespace sap {
3529
3645
  constructor();
3530
3646
 
3531
3647
  /**
3532
- * @SINCE 1.18.0
3648
+ * @since 1.18.0
3533
3649
  *
3534
3650
  * Checks if a specific item is contained in this variant.
3535
3651
  *
@@ -3542,7 +3658,7 @@ declare namespace sap {
3542
3658
  sItemKey: string
3543
3659
  ): boolean;
3544
3660
  /**
3545
- * @SINCE 1.18.0
3661
+ * @since 1.18.0
3546
3662
  *
3547
3663
  * Deletes an item from this variant. In case the item does not exist, nothing happens.
3548
3664
  */
@@ -3553,7 +3669,7 @@ declare namespace sap {
3553
3669
  sItemKey: string
3554
3670
  ): void;
3555
3671
  /**
3556
- * @SINCE 1.18.0
3672
+ * @since 1.18.0
3557
3673
  *
3558
3674
  * Returns an array with the keys of all items in this variant.
3559
3675
  *
@@ -3561,7 +3677,7 @@ declare namespace sap {
3561
3677
  */
3562
3678
  getItemKeys(): any[];
3563
3679
  /**
3564
- * @SINCE 1.18.0
3680
+ * @since 1.18.0
3565
3681
  *
3566
3682
  * Returns the value for an item in this variant.
3567
3683
  *
@@ -3575,7 +3691,7 @@ declare namespace sap {
3575
3691
  sItemKey: string
3576
3692
  ): object;
3577
3693
  /**
3578
- * @SINCE 1.18.0
3694
+ * @since 1.18.0
3579
3695
  *
3580
3696
  * Returns the key of this variant.
3581
3697
  *
@@ -3583,7 +3699,7 @@ declare namespace sap {
3583
3699
  */
3584
3700
  getVariantKey(): string;
3585
3701
  /**
3586
- * @SINCE 1.18.0
3702
+ * @since 1.18.0
3587
3703
  *
3588
3704
  * Returns the name of this variant.
3589
3705
  *
@@ -3591,7 +3707,7 @@ declare namespace sap {
3591
3707
  */
3592
3708
  getVariantName(): string;
3593
3709
  /**
3594
- * @SINCE 1.18.0
3710
+ * @since 1.18.0
3595
3711
  *
3596
3712
  * Sets the value for an item in this variant.
3597
3713
  */
@@ -3607,7 +3723,7 @@ declare namespace sap {
3607
3723
  ): void;
3608
3724
  }
3609
3725
  /**
3610
- * @SINCE 1.18.0
3726
+ * @since 1.18.0
3611
3727
  *
3612
3728
  * The personalization variant set contains variants of personalization data. It is used in the personalization
3613
3729
  * container mode.
@@ -3618,14 +3734,14 @@ declare namespace sap {
3618
3734
  */
3619
3735
  constructor();
3620
3736
  /**
3621
- * @SINCE 1.18.0
3737
+ * @since 1.18.0
3622
3738
  *
3623
3739
  * Deletes a variant from the variant set. In case the variant does not exist nothing happens.
3624
3740
  */
3625
3741
  delVariant: undefined;
3626
3742
 
3627
3743
  /**
3628
- * @SINCE 1.18.0
3744
+ * @since 1.18.0
3629
3745
  *
3630
3746
  * Checks if a specific variant is contained in the variant set.
3631
3747
  *
@@ -3638,7 +3754,7 @@ declare namespace sap {
3638
3754
  sVariantKey: string
3639
3755
  ): boolean;
3640
3756
  /**
3641
- * @SINCE 1.18.0
3757
+ * @since 1.18.0
3642
3758
  *
3643
3759
  * Returns the current variant key.
3644
3760
  *
@@ -3646,7 +3762,7 @@ declare namespace sap {
3646
3762
  */
3647
3763
  getCurrentVariantKey(): string;
3648
3764
  /**
3649
- * @SINCE 1.18.0
3765
+ * @since 1.18.0
3650
3766
  *
3651
3767
  * Returns a variant object.
3652
3768
  *
@@ -3660,7 +3776,7 @@ declare namespace sap {
3660
3776
  sVariantKey: string
3661
3777
  ): object;
3662
3778
  /**
3663
- * @SINCE 1.18.0
3779
+ * @since 1.18.0
3664
3780
  *
3665
3781
  * Returns the variant key corresponding to a variant name.
3666
3782
  *
@@ -3674,7 +3790,7 @@ declare namespace sap {
3674
3790
  sVariantName: string
3675
3791
  ): object;
3676
3792
  /**
3677
- * @SINCE 1.18.0
3793
+ * @since 1.18.0
3678
3794
  *
3679
3795
  * Returns an array with the keys of the variants in the variant set.
3680
3796
  *
@@ -3682,7 +3798,7 @@ declare namespace sap {
3682
3798
  */
3683
3799
  getVariantKeys(): any[];
3684
3800
  /**
3685
- * @SINCE 1.18.0
3801
+ * @since 1.18.0
3686
3802
  *
3687
3803
  * Sets the current variant key.
3688
3804
  */
@@ -3694,7 +3810,7 @@ declare namespace sap {
3694
3810
  ): void;
3695
3811
  }
3696
3812
  /**
3697
- * @SINCE 1.15.0
3813
+ * @since 1.15.0
3698
3814
  */
3699
3815
  class ShellNavigation {
3700
3816
  /**
@@ -3740,7 +3856,7 @@ declare namespace sap {
3740
3856
  * Thus it is crucial to use appropriate interfaces and not directly invoke window.location.hash.
3741
3857
  *
3742
3858
  * - internal construction methods for a "current" App specific and non-app specific hash (invoked by CrossApplicationNavigation),
3743
- * not to be invoked directly!
3859
+ * not to be invoked directly!
3744
3860
  * See:
3745
3861
  * sap.ushell.services.Container#getServiceAsync
3746
3862
  */
@@ -3782,7 +3898,7 @@ declare namespace sap {
3782
3898
  ): object;
3783
3899
  }
3784
3900
  /**
3785
- * @SINCE 1.44.0
3901
+ * @since 1.44.0
3786
3902
  * @deprecated (since 1.112) - This service has been deprecated. Please use the CrossApplicationNavigation
3787
3903
  * service instead.
3788
3904
  */
@@ -3805,7 +3921,7 @@ declare namespace sap {
3805
3921
  constructor();
3806
3922
  }
3807
3923
  /**
3808
- * @SINCE 1.19.1
3924
+ * @since 1.19.1
3809
3925
  *
3810
3926
  * The Unified Shell's Support Ticket service
3811
3927
  */
@@ -3853,7 +3969,7 @@ declare namespace sap {
3853
3969
  );
3854
3970
 
3855
3971
  /**
3856
- * @SINCE 1.20.0
3972
+ * @since 1.20.0
3857
3973
  *
3858
3974
  * Creates a Support Ticket. Forwards the given data (JSON object) to the associated adapter.
3859
3975
  *
@@ -3866,7 +3982,7 @@ declare namespace sap {
3866
3982
  oSupportTicketData: object
3867
3983
  ): object;
3868
3984
  /**
3869
- * @SINCE 1.20.0
3985
+ * @since 1.20.0
3870
3986
  *
3871
3987
  * Checks if the service is enabled. The service enablement depends on the configuration in the back-end
3872
3988
  * system and the bootstrap configuration.
@@ -3876,7 +3992,7 @@ declare namespace sap {
3876
3992
  isEnabled(): boolean;
3877
3993
  }
3878
3994
  /**
3879
- * @SINCE 1.18.0
3995
+ * @since 1.18.0
3880
3996
  *
3881
3997
  * The transient personalizer shall be used in container mode for table personalization.
3882
3998
  */
@@ -3887,7 +4003,7 @@ declare namespace sap {
3887
4003
  constructor();
3888
4004
 
3889
4005
  /**
3890
- * @SINCE 1.18.0
4006
+ * @since 1.18.0
3891
4007
  *
3892
4008
  * Deletes a personalization data value.
3893
4009
  *
@@ -3896,7 +4012,7 @@ declare namespace sap {
3896
4012
  */
3897
4013
  delPersData(): object;
3898
4014
  /**
3899
- * @SINCE 1.18.0
4015
+ * @since 1.18.0
3900
4016
  *
3901
4017
  * Gets a personalization data value.
3902
4018
  *
@@ -3906,7 +4022,7 @@ declare namespace sap {
3906
4022
  */
3907
4023
  getPersData(): object;
3908
4024
  /**
3909
- * @SINCE 1.18.0
4025
+ * @since 1.18.0
3910
4026
  *
3911
4027
  * Synchronously gets a personalization data value.
3912
4028
  *
@@ -3914,7 +4030,7 @@ declare namespace sap {
3914
4030
  */
3915
4031
  getValue(): object;
3916
4032
  /**
3917
- * @SINCE 1.18.0
4033
+ * @since 1.18.0
3918
4034
  *
3919
4035
  * Sets a personalization data value.
3920
4036
  *
@@ -3928,7 +4044,7 @@ declare namespace sap {
3928
4044
  oValue: object
3929
4045
  ): object;
3930
4046
  /**
3931
- * @SINCE 1.18.0
4047
+ * @since 1.18.0
3932
4048
  *
3933
4049
  * Synchronously sets a personalization data value.
3934
4050
  */
@@ -3940,7 +4056,7 @@ declare namespace sap {
3940
4056
  ): void;
3941
4057
  }
3942
4058
  /**
3943
- * @SINCE 1.15.0
4059
+ * @since 1.15.0
3944
4060
  */
3945
4061
  class URLParsing {
3946
4062
  /**
@@ -3968,7 +4084,7 @@ declare namespace sap {
3968
4084
  constructor();
3969
4085
 
3970
4086
  /**
3971
- * @SINCE 1.19.1
4087
+ * @since 1.19.1
3972
4088
  * @deprecated (since 1.31) - Please use {@link sap.ui.model.odata.ODataUtils#setOrigin} instead.
3973
4089
  *
3974
4090
  * Note: deprecated, please use `sap.ui.model.odata.ODataUtils.setOrigin(sServiceUrl, { alias : sSystem
@@ -4021,7 +4137,7 @@ declare namespace sap {
4021
4137
  vComponentOrSystem?: string | sap.ui.core.Component
4022
4138
  ): string;
4023
4139
  /**
4024
- * @SINCE 1.16.0
4140
+ * @since 1.16.0
4025
4141
  *
4026
4142
  * compose a shell Hash from it's respective parts Note that it also may append an app specific route !
4027
4143
  *
@@ -4051,7 +4167,7 @@ declare namespace sap {
4051
4167
  oShellHash: object
4052
4168
  ): string;
4053
4169
  /**
4054
- * @SINCE 1.16.0
4170
+ * @since 1.16.0
4055
4171
  *
4056
4172
  * Extract a hash part from an URL, including an app-specific part
4057
4173
  *
@@ -4064,9 +4180,9 @@ declare namespace sap {
4064
4180
  sURL: string
4065
4181
  ): string;
4066
4182
  /**
4067
- * @SINCE 1.16.0
4183
+ * @since 1.16.0
4068
4184
  *
4069
- * Extract the Shell hash# part from an URL The application specific route part is removed See {@link #getHash}
4185
+ * Extract the Shell hash# part from an URL The application specific route part is removed See {@link #getHash }
4070
4186
  * for a function which retains the app specific route.
4071
4187
  *
4072
4188
  * Shell services shall use this service to extract relevant parts of an URL from an actual URL string (which
@@ -4089,7 +4205,7 @@ declare namespace sap {
4089
4205
  sShellHashString: string
4090
4206
  ): Object;
4091
4207
  /**
4092
- * @SINCE 1.30.0
4208
+ * @since 1.30.0
4093
4209
  * @deprecated (since 1.96) - Please use {@link #isIntentUrlAsync} instead.
4094
4210
  *
4095
4211
  * Check if a URL has an intent based navigation part which can be parsed into a semantic object and action
@@ -4111,7 +4227,7 @@ declare namespace sap {
4111
4227
  sUrl: string
4112
4228
  ): boolean;
4113
4229
  /**
4114
- * @SINCE 1.96.0
4230
+ * @since 1.96.0
4115
4231
  *
4116
4232
  * Check if a URL has an intent based navigation part which can be parsed into a semantic object and action
4117
4233
  * part. Accepts only a relative URL (must contain #) or fully qualified Urls for which origin and filename
@@ -4132,7 +4248,7 @@ declare namespace sap {
4132
4248
  sUrl: string
4133
4249
  ): Promise<boolean>;
4134
4250
  /**
4135
- * @SINCE 1.20.0
4251
+ * @since 1.20.0
4136
4252
  *
4137
4253
  * combine members of a javascript object into a parameter string, note that parameters are ordered in an
4138
4254
  * arbitrary manner which is subject to change
@@ -4147,7 +4263,7 @@ declare namespace sap {
4147
4263
  oParams: object
4148
4264
  ): string;
4149
4265
  /**
4150
- * @SINCE 1.20.0
4266
+ * @since 1.20.0
4151
4267
  *
4152
4268
  * parse parameters from a URI query string (starting with ?) into a parameter object
4153
4269
  *
@@ -4160,7 +4276,7 @@ declare namespace sap {
4160
4276
  sParams: string
4161
4277
  ): object;
4162
4278
  /**
4163
- * @SINCE 1.16.0
4279
+ * @since 1.16.0
4164
4280
  *
4165
4281
  * Decompose a shell hash into the respective parts
4166
4282
  *
@@ -4192,7 +4308,7 @@ declare namespace sap {
4192
4308
  sHash: string
4193
4309
  ): object;
4194
4310
  /**
4195
- * @SINCE 1.16.0
4311
+ * @since 1.16.0
4196
4312
  *
4197
4313
  * split a Unified Shell compliant hash into an Object containing a shell specific part and an app specific
4198
4314
  * parts
@@ -4217,7 +4333,7 @@ declare namespace sap {
4217
4333
  ): object;
4218
4334
  }
4219
4335
  /**
4220
- * @SINCE 1.32.0
4336
+ * @since 1.32.0
4221
4337
  *
4222
4338
  * A UShell service for tracking business flows and user actions.
4223
4339
  */
@@ -4262,7 +4378,7 @@ declare namespace sap {
4262
4378
  );
4263
4379
 
4264
4380
  /**
4265
- * @SINCE 1.32.0
4381
+ * @since 1.32.0
4266
4382
  *
4267
4383
  * Sets up to 6 customer attributes of logged events according to the given object attributes.
4268
4384
  * A customer attribute can be set only once during a session.
@@ -4286,13 +4402,13 @@ declare namespace sap {
4286
4402
  oCustomFieldValues: object
4287
4403
  ): void;
4288
4404
  /**
4289
- * @SINCE 1.32.0
4405
+ * @since 1.32.0
4290
4406
  *
4291
4407
  * Enables the renderer to set the content of the legal message..
4292
4408
  */
4293
4409
  setLegalText(): void;
4294
4410
  /**
4295
- * @SINCE 1.32.0
4411
+ * @since 1.32.0
4296
4412
  *
4297
4413
  * Indicates whether the service is available.
4298
4414
  *
@@ -4308,7 +4424,7 @@ declare namespace sap {
4308
4424
  */
4309
4425
  systemEnabled(): boolean;
4310
4426
  /**
4311
- * @SINCE 1.32.0
4427
+ * @since 1.32.0
4312
4428
  *
4313
4429
  * Indicates whether the user has specified to track activities.
4314
4430
  *
@@ -4324,7 +4440,7 @@ declare namespace sap {
4324
4440
  userEnabled(): boolean;
4325
4441
  }
4326
4442
  /**
4327
- * @SINCE 1.16.3
4443
+ * @since 1.16.3
4328
4444
  */
4329
4445
  class UserInfo {
4330
4446
  /**
@@ -4348,7 +4464,7 @@ declare namespace sap {
4348
4464
  );
4349
4465
 
4350
4466
  /**
4351
- * @SINCE 1.86.0
4467
+ * @since 1.86.0
4352
4468
  *
4353
4469
  * Returns the email address of the user.
4354
4470
  *
@@ -4356,7 +4472,7 @@ declare namespace sap {
4356
4472
  */
4357
4473
  getEmail(): string;
4358
4474
  /**
4359
- * @SINCE 1.86.0
4475
+ * @since 1.86.0
4360
4476
  *
4361
4477
  * Returns the first name of the user.
4362
4478
  *
@@ -4364,7 +4480,7 @@ declare namespace sap {
4364
4480
  */
4365
4481
  getFirstName(): string;
4366
4482
  /**
4367
- * @SINCE 1.86.0
4483
+ * @since 1.86.0
4368
4484
  *
4369
4485
  * Returns the full name of the user.
4370
4486
  *
@@ -4372,7 +4488,7 @@ declare namespace sap {
4372
4488
  */
4373
4489
  getFullName(): string;
4374
4490
  /**
4375
- * @SINCE 1.16.3
4491
+ * @since 1.16.3
4376
4492
  *
4377
4493
  * Returns the id of the user.
4378
4494
  *
@@ -4380,7 +4496,7 @@ declare namespace sap {
4380
4496
  */
4381
4497
  getId(): string;
4382
4498
  /**
4383
- * @SINCE 1.86.0
4499
+ * @since 1.86.0
4384
4500
  *
4385
4501
  * Returns the last name of the user.
4386
4502
  *
@@ -4443,6 +4559,10 @@ declare namespace sap {
4443
4559
  image?: sap.m.Image;
4444
4560
  }
4445
4561
 
4562
+ interface PictureTile$PictureDeleteEventParameters {}
4563
+
4564
+ interface PictureViewer$PictureDeletedEventParameters {}
4565
+
4446
4566
  /**
4447
4567
  * @deprecated (since 1.22) - Please use {@link sap.m.Carousel} instead.
4448
4568
  *
@@ -4579,7 +4699,7 @@ declare namespace sap {
4579
4699
  oListener?: object
4580
4700
  ): this;
4581
4701
  /**
4582
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
4702
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
4583
4703
  *
4584
4704
  * Fires event {@link #event:pictureDelete pictureDelete} to attached listeners.
4585
4705
  *
@@ -4823,7 +4943,7 @@ declare namespace sap {
4823
4943
  oListener?: object
4824
4944
  ): this;
4825
4945
  /**
4826
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
4946
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
4827
4947
  *
4828
4948
  * Fires event {@link #event:pictureDeleted pictureDeleted} to attached listeners.
4829
4949
  *
@@ -5079,13 +5199,29 @@ declare namespace sap {
5079
5199
  sSrc: string
5080
5200
  ): sap.ushell.components.factsheet.controls.PictureViewerItem;
5081
5201
  }
5202
+
5203
+ /**
5204
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'PictureTile$PictureDeleteEventParameters'
5205
+ * in 1.115.1 and any later releases.
5206
+ */
5207
+ type $PictureTilePictureDeleteEventParameters = sap.ushell.components.factsheet.controls.PictureTile$PictureDeleteEventParameters;
5208
+
5209
+ type PictureTile$PictureDeleteEvent = sap.ui.base.Event<PictureTile$PictureDeleteEventParameters>;
5210
+
5211
+ /**
5212
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'PictureViewer$PictureDeletedEventParameters'
5213
+ * in 1.115.1 and any later releases.
5214
+ */
5215
+ type $PictureViewerPictureDeletedEventParameters = sap.ushell.components.factsheet.controls.PictureViewer$PictureDeletedEventParameters;
5216
+
5217
+ type PictureViewer$PictureDeletedEvent = sap.ui.base.Event<PictureViewer$PictureDeletedEventParameters>;
5082
5218
  }
5083
5219
  }
5084
5220
  }
5085
5221
 
5086
5222
  namespace Container {
5087
5223
  /**
5088
- * @SINCE 1.90.0
5224
+ * @since 1.90.0
5089
5225
  *
5090
5226
  * An enumeration for the application work protect mode state.
5091
5227
  */
@@ -5110,7 +5246,7 @@ declare namespace sap {
5110
5246
  interface $RendererSettings extends sap.ui.core.$UIComponentSettings {}
5111
5247
 
5112
5248
  /**
5113
- * @SINCE 1.15.0
5249
+ * @since 1.15.0
5114
5250
  *
5115
5251
  * The SAPUI5 component of SAP Fiori Launchpad renderer for the Unified Shell.
5116
5252
  */
@@ -5124,7 +5260,7 @@ declare namespace sap {
5124
5260
  */
5125
5261
  constructor();
5126
5262
  /**
5127
- * @SINCE 1.30
5263
+ * @since 1.30
5128
5264
  *
5129
5265
  * The launchpad states that can be passed as a parameter.
5130
5266
  *
@@ -5164,7 +5300,7 @@ declare namespace sap {
5164
5300
  */
5165
5301
  static getMetadata(): sap.ui.core.ComponentMetadata;
5166
5302
  /**
5167
- * @SINCE 1.30
5303
+ * @since 1.30
5168
5304
  * @deprecated (since 1.48) - Please use {@link #addUserAction} instead.
5169
5305
  *
5170
5306
  * Creates an action button in the User Actions Menu in the SAP Fiori launchpad, in the given launchpad
@@ -5213,9 +5349,9 @@ declare namespace sap {
5213
5349
  * control. Valid only if bCurrentState is set to false.
5214
5350
  */
5215
5351
  aStates: string[]
5216
- ): object;
5352
+ ): sap.ui.core.Control;
5217
5353
  /**
5218
- * @SINCE 1.30
5354
+ * @since 1.30
5219
5355
  * @deprecated (since 1.93)
5220
5356
  *
5221
5357
  * Adds the given sap.ui.core.Control to the EndUserFeedback dialog.
@@ -5232,7 +5368,7 @@ declare namespace sap {
5232
5368
  bShowCustomUIContent: boolean
5233
5369
  ): void;
5234
5370
  /**
5235
- * @SINCE 1.30
5371
+ * @since 1.30
5236
5372
  * @deprecated (since 1.48) - Please use {@link #addFloatingButton} instead.
5237
5373
  *
5238
5374
  * Creates a FloatingActionButton in Fiori launchpad, in the given launchpad states.
@@ -5281,7 +5417,7 @@ declare namespace sap {
5281
5417
  aStates: string[]
5282
5418
  ): object;
5283
5419
  /**
5284
- * @SINCE 1.48
5420
+ * @since 1.48
5285
5421
  * @deprecated (since 1.52)
5286
5422
  *
5287
5423
  * Creates a FloatingActionButton in Fiori launchpad, in the given launchpad states.
@@ -5320,7 +5456,7 @@ declare namespace sap {
5320
5456
  oParameters: object
5321
5457
  ): object;
5322
5458
  /**
5323
- * @SINCE 1.30
5459
+ * @since 1.30
5324
5460
  *
5325
5461
  * Creates and displays a shell header icon in Fiori launchpad, in the given launchpad states.
5326
5462
  * The icon is displayed in the right side of the Fiori Launchpad shell header or in an overflow menu.
@@ -5395,9 +5531,9 @@ declare namespace sap {
5395
5531
  * in which to add the control.
5396
5532
  */
5397
5533
  aStates: string[]
5398
- ): object;
5534
+ ): sap.ui.core.Control;
5399
5535
  /**
5400
- * @SINCE 1.30
5536
+ * @since 1.30
5401
5537
  *
5402
5538
  * Creates and displays an item in the header of Fiori launchpad, in the given launchpad states.
5403
5539
  * The new header item will be displayed on the left-hand side of the Fiori Launchpad shell header, according
@@ -5457,9 +5593,9 @@ declare namespace sap {
5457
5593
  * If no launchpad state is provided the control is added in all states.
5458
5594
  */
5459
5595
  aStates: string[]
5460
- ): object;
5596
+ ): sap.ui.core.Control;
5461
5597
  /**
5462
- * @SINCE 1.30
5598
+ * @since 1.30
5463
5599
  *
5464
5600
  * Creates and displays an item in the header of Fiori launchpad, in the given launchpad states.
5465
5601
  * The new header item will be displayed on the left-hand side of the Fiori Launchpad shell header, according
@@ -5514,9 +5650,9 @@ declare namespace sap {
5514
5650
  * If no launchpad state is provided the control is added in all states.
5515
5651
  */
5516
5652
  aStates: string[]
5517
- ): object;
5653
+ ): sap.ui.core.Control;
5518
5654
  /**
5519
- * @SINCE 1.30
5655
+ * @since 1.30
5520
5656
  * @deprecated (since 1.48) - Please use {@link #addSidePaneContent} instead.
5521
5657
  *
5522
5658
  * Creates the Left Pane content in Fiori launchpad, in the given launchpad states.
@@ -5564,7 +5700,7 @@ declare namespace sap {
5564
5700
  aStates: string[]
5565
5701
  ): object;
5566
5702
  /**
5567
- * @SINCE 1.48
5703
+ * @since 1.48
5568
5704
  *
5569
5705
  * Creates and displays a sub header control in Fiori launchpad, in the given launchpad states.
5570
5706
  * The new control is displayed in FLP UI according to the given display parameters.
@@ -5593,29 +5729,39 @@ declare namespace sap {
5593
5729
  * ```
5594
5730
  *
5595
5731
  *
5596
- * @returns jQuery.deferred.promise object that when resolved, returns the newly created control
5732
+ * @returns jQuery.Deferred.promise object that when resolved, returns the newly created control
5597
5733
  */
5598
5734
  addShellSubHeader(
5599
5735
  /**
5600
- * Contains the required parameters for creating and showing the new control object:
5601
- * Properties:
5602
- * - {string} controlType
5603
- * The (class) name of the control type to create.
5604
- * - {object} oControlProperties
5605
- * The properties that will be passed to the created control.
5606
- * - {boolean} bIsVisible
5607
- * Specify whether to display the control.
5608
- * - {boolean} bCurrentState
5609
- * If true, add the current control only to the current rendered shell state.
5610
- * Once the user navigates to another app or back to the Home page, this control will be removed.
5611
- * - {string[]} aStates
5612
- * (only valid if bCurrentState is set to false) - list of the sap.ushell.renderers.fiori2.Renderer.LaunchpadState
5613
- * in which to add the control.
5736
+ * Contains the required parameters for creating and showing the new control object.
5614
5737
  */
5615
- oParameters: object
5616
- ): object;
5738
+ oParameters: {
5739
+ /**
5740
+ * The (class) name of the control type to create.
5741
+ */
5742
+ controlType: string;
5743
+ /**
5744
+ * The properties that will be passed to the created control.
5745
+ */
5746
+ oControlProperties: object;
5747
+ /**
5748
+ * Specify whether to display the control.
5749
+ */
5750
+ bIsVisible: boolean;
5751
+ /**
5752
+ * If true, add the current control only to the current rendered shell state. Once the user navigates to
5753
+ * another app or back to the Home page, this control will be removed.
5754
+ */
5755
+ bCurrentState: boolean;
5756
+ /**
5757
+ * (only valid if bCurrentState is set to false) - list of the sap.ushell.renderers.fiori2.Renderer.LaunchpadState
5758
+ * in which to add the control.
5759
+ */
5760
+ aStates: string[];
5761
+ }
5762
+ ): jQuery.Promise;
5617
5763
  /**
5618
- * @SINCE 1.48
5764
+ * @since 1.48
5619
5765
  *
5620
5766
  * Creates the Left Pane content in Fiori launchpad, in the given launchpad states.
5621
5767
  *
@@ -5641,7 +5787,7 @@ declare namespace sap {
5641
5787
  * LaunchpadState
5642
5788
  * If no launchpad state is provided the content is added in all states.
5643
5789
  *
5644
- * @returns jQuery.deferred.promise object that when resolved, returns the newly created control.
5790
+ * @returns jQuery.Deferred.promise object that when resolved, returns the newly created control.
5645
5791
  */
5646
5792
  addSidePaneContent(
5647
5793
  /**
@@ -5671,9 +5817,9 @@ declare namespace sap {
5671
5817
  */
5672
5818
  aStates: string[];
5673
5819
  }
5674
- ): object;
5820
+ ): jQuery.Promise;
5675
5821
  /**
5676
- * @SINCE 1.30
5822
+ * @since 1.30
5677
5823
  * @deprecated (since 1.48) - Please use {@link #addShellSubHeader} instead.
5678
5824
  *
5679
5825
  * Creates and displays a sub header control in Fiori launchpad, in the given launchpad states.
@@ -5735,7 +5881,7 @@ declare namespace sap {
5735
5881
  aStates: string[]
5736
5882
  ): object;
5737
5883
  /**
5738
- * @SINCE 1.30
5884
+ * @since 1.30
5739
5885
  *
5740
5886
  * Creates a ToolAreaItem in Fiori Launchpad and adds it to the Tool Area, in the given launchpad states.
5741
5887
  * Once the item is added, the Tool Area is rendered on the left side on the Fiori Launchpad shell.
@@ -5782,9 +5928,9 @@ declare namespace sap {
5782
5928
  * in which the controls are added. If no launchpad state is provided the items are added in all states.
5783
5929
  */
5784
5930
  aStates: string[]
5785
- ): object;
5931
+ ): sap.ui.core.Control;
5786
5932
  /**
5787
- * @SINCE 1.48
5933
+ * @since 1.48
5788
5934
  *
5789
5935
  * Creates an Action Button in Fiori launchpad, in the given launchpad states.
5790
5936
  * The button will be displayed in the user actions menu, that is opened from the user button in the shell
@@ -5809,33 +5955,41 @@ declare namespace sap {
5809
5955
  * oRenderer.addUserAction(oAddActionButtonProperties);
5810
5956
  * ```
5811
5957
  *
5812
- * See:
5813
- * LaunchpadState
5814
- * If no launchpad state is provided the content is added in all states.
5815
5958
  *
5816
- * @returns jQuery.deferred.promise object that when resolved, returns the newly created control
5959
+ * @returns jQuery.Deferred.promise object that when resolved, returns the newly created control
5817
5960
  */
5818
5961
  addUserAction(
5819
5962
  /**
5820
- * Contains the required parameters for creating and showing the new control object:
5821
- * Properties:
5822
- * - {string} controlType
5823
- * The (class) name of the control type to create.
5824
- * - {object} oControlProperties
5825
- * The properties that will be passed to the created control.
5826
- * - {boolean} bIsVisible
5827
- * Specify whether to display the control.
5828
- * - {boolean} bCurrentState
5829
- * If true, add the current control only to the current rendered shell state.
5830
- * Once the user navigates to another app or back to the Home page, this control will be removed.
5831
- * - {string[]} aStates
5832
- * (only valid if bCurrentState is set to false) - list of the sap.ushell.renderers.fiori2.Renderer.LaunchpadState
5833
- * in which to add the control.
5963
+ * Contains the required parameters for creating and showing the new control object.
5834
5964
  */
5835
- oParameters: object
5836
- ): object;
5965
+ oParameters: {
5966
+ /**
5967
+ * The (class) name of the control type to create.
5968
+ */
5969
+ controlType: string;
5970
+ /**
5971
+ * The properties that will be passed to the created control.
5972
+ */
5973
+ oControlProperties: object;
5974
+ /**
5975
+ * Specify whether to display the control.
5976
+ */
5977
+ bIsVisible: boolean;
5978
+ /**
5979
+ * If true, add the current control only to the current rendered shell state. Once the user navigates to
5980
+ * another app or back to the Home page, this control will be removed.
5981
+ */
5982
+ bCurrentState: boolean;
5983
+ /**
5984
+ * (only valid if bCurrentState is set to false) - list of the sap.ushell.renderers.fiori2.Renderer.LaunchpadState
5985
+ * in which to add the control. If no launchpad state is provided the content is added in all states. @see
5986
+ * LaunchpadState
5987
+ */
5988
+ aStates: string[];
5989
+ }
5990
+ ): jQuery.Promise;
5837
5991
  /**
5838
- * @SINCE 1.30
5992
+ * @since 1.30
5839
5993
  *
5840
5994
  * Adds an entry to the User Preferences dialog box including the UI control that appears when the user
5841
5995
  * clicks the new entry, and handling of User Preferences actions such as SAVE and CANCEL.
@@ -5858,43 +6012,59 @@ declare namespace sap {
5858
6012
  * };
5859
6013
  * oRenderer.addUserPreferencesEntry(oEntry);
5860
6014
  * ```
5861
- *
5862
- *
5863
- * @returns User Preference Entry.
5864
6015
  */
5865
6016
  addUserPreferencesEntry(
5866
6017
  /**
5867
- * The data of the new added User Preference entry Including:
5868
- * {string} entryHelpID (Optional) - The ID of the object.
5869
- * {string} title - The title of the entry to be presented in the list in the User Preferences dialog
5870
- * box.
5871
- * We recommend using a string from the translation bundle.
5872
- * {string}/{Function} value - A string to be presented as the value of the entry
5873
- * OR a function to be called which returns a {jQuery.Deferred.promise} object.
5874
- * {Function} content - A function to be called that returns a {jQuery.Deferred.promise} object
5875
- * which consists of a {sap.ui.core.Control} to be displayed in a follow-on dialog box. A SAPUI5 view instance
5876
- * can also be returned. The functions is called on each time the user opens the User Preferences dialog
5877
- * box. {Function} onSave - A function to be called which returns a {jQuery.Deferred.promise} object
5878
- * when the user clicks Save in the User Preferences dialog box.
5879
- * If an error occurs, pass the error message via the {jQuery.Deferred.promise} object. Errors are displayed
5880
- * in the log.
5881
- * {Function} onCancel - A function to be called that closes the User Preferences dialog box without
5882
- * saving any changes.
5883
- * {Boolean} provideEmptyWrapper - Experimental. Set this value to true if you want that your content
5884
- * is displayed without the standard header
5885
- */
5886
- entryObject: object
5887
- ): object;
6018
+ * The data of the new added User Preference entry.
6019
+ */
6020
+ entryObject: {
6021
+ /**
6022
+ * (Optional) - The ID of the object.
6023
+ */
6024
+ entryHelpID: string;
6025
+ /**
6026
+ * The title of the entry to be presented in the list in the User Preferences dialog box. We recommend using
6027
+ * a string from the translation bundle.
6028
+ */
6029
+ title: string;
6030
+ /**
6031
+ * A function to be called that returns a {jQuery.Deferred.promise} object which consists of a {sap.ui.core.Control }
6032
+ * to be displayed in a follow-on dialog box. A SAPUI5 view instance can also be returned. The function
6033
+ * is called on each time the user opens the User Preferences dialog box.
6034
+ */
6035
+ content: Function;
6036
+ /**
6037
+ * A function to be called which returns a {jQuery.Deferred.promise} object when the user clicks "save"
6038
+ * in the User Preferences dialog box. If an error occurs, pass the error message via the {jQuery.Deferred.promise }
6039
+ * object. Errors are displayed in the log.
6040
+ */
6041
+ onSave: Function;
6042
+ /**
6043
+ * A function to be called that closes the User Preferences dialog box without saving any changes.
6044
+ */
6045
+ onCancel: Function;
6046
+ /**
6047
+ * Experimental. Set this value to true if you want that your content is displayed without the standard
6048
+ * header.
6049
+ */
6050
+ provideEmptyWrapper: boolean;
6051
+ },
6052
+ /**
6053
+ * A string to be presented as the value of the entry OR a function to be called which returns a {jQuery.Deferred.promise }
6054
+ * object.
6055
+ */
6056
+ value: string | Function
6057
+ ): void;
5888
6058
  /**
5889
- * @SINCE 1.37
6059
+ * @since 1.37
5890
6060
  *
5891
6061
  * This method returns the current state of the Viewport Container control.
5892
6062
  *
5893
6063
  * @returns The current Viewport State.
5894
6064
  */
5895
- getCurrentViewportState(): object;
6065
+ getCurrentViewportState(): string;
5896
6066
  /**
5897
- * @SINCE 1.30
6067
+ * @since 1.30
5898
6068
  *
5899
6069
  * Hides an action button from the User Actions Menu in the SAP Fiori launchpad, in the given launchpad
5900
6070
  * states (LaunchpadState). The removed button will not be destroyed.
@@ -5920,7 +6090,7 @@ declare namespace sap {
5920
6090
  aStates: string[]
5921
6091
  ): void;
5922
6092
  /**
5923
- * @SINCE 1.30
6093
+ * @since 1.30
5924
6094
  * @deprecated (since 1.52)
5925
6095
  *
5926
6096
  * Hide the given sap.ushell.ui.shell.ShellFloatingAction from Fiori Launchpad, in the given launchpad states.
@@ -5949,7 +6119,7 @@ declare namespace sap {
5949
6119
  aStates: string[]
5950
6120
  ): void;
5951
6121
  /**
5952
- * @SINCE 1.30
6122
+ * @since 1.30
5953
6123
  *
5954
6124
  * Hide the given sap.ushell.ui.shell.ShellHeadItem from Fiori Launchpad, in the given launchpad states.
5955
6125
  * The removed control will not be destroyed.
@@ -5977,7 +6147,7 @@ declare namespace sap {
5977
6147
  aStates: string[]
5978
6148
  ): void;
5979
6149
  /**
5980
- * @SINCE 1.30
6150
+ * @since 1.30
5981
6151
  *
5982
6152
  * Hide the given sap.ushell.ui.shell.ShellHeadItem from Fiori Launchpad, in the given launchpad states.
5983
6153
  * The removed control will not be destroyed.
@@ -6005,7 +6175,7 @@ declare namespace sap {
6005
6175
  aStates: string[]
6006
6176
  ): void;
6007
6177
  /**
6008
- * @SINCE 1.30
6178
+ * @since 1.30
6009
6179
  *
6010
6180
  * Hide the given control from Fiori Launchpad, in the given launchpad states. The removed control will
6011
6181
  * not be destroyed.
@@ -6033,7 +6203,7 @@ declare namespace sap {
6033
6203
  aStates: string[]
6034
6204
  ): void;
6035
6205
  /**
6036
- * @SINCE 1.30
6206
+ * @since 1.30
6037
6207
  *
6038
6208
  * Hide the given control from the Fiori Launchpad sub header, in the given launchpad states. The removed
6039
6209
  * control will not be destroyed.
@@ -6061,7 +6231,7 @@ declare namespace sap {
6061
6231
  aStates: string[]
6062
6232
  ): void;
6063
6233
  /**
6064
- * @SINCE 1.30
6234
+ * @since 1.30
6065
6235
  *
6066
6236
  * If exists, this method will remove the footer from the Fiori Launchpad.
6067
6237
  *
@@ -6071,7 +6241,7 @@ declare namespace sap {
6071
6241
  */
6072
6242
  removeFooter(): void;
6073
6243
  /**
6074
- * @SINCE 1.30
6244
+ * @since 1.30
6075
6245
  *
6076
6246
  * Remove the given Tool Area Item from Fiori Launchpad, in the given launchpad states. This API is meant
6077
6247
  * to be used for implementing custom elements in the SAP Fiori launchpad. We do not recommend using it
@@ -6097,7 +6267,7 @@ declare namespace sap {
6097
6267
  aStates: string[]
6098
6268
  ): void;
6099
6269
  /**
6100
- * @SINCE 1.30
6270
+ * @since 1.30
6101
6271
  *
6102
6272
  * Displays the given sap.m.Bar as the footer of the Fiori launchpad shell.
6103
6273
  * The footer will be displayed in all states.
@@ -6117,12 +6287,12 @@ declare namespace sap {
6117
6287
  */
6118
6288
  setFooter(
6119
6289
  /**
6120
- * The control to be added as the footer of the Fiori Launchpad
6290
+ * sap.m.Bar, the control to be added as the footer of the Fiori Launchpad
6121
6291
  */
6122
6292
  oFooter: sap.m.Bar
6123
6293
  ): void;
6124
6294
  /**
6125
- * @SINCE 1.42
6295
+ * @since 1.42
6126
6296
  * @deprecated (since 1.48) - Please use {@link #setShellFooter} instead.
6127
6297
  *
6128
6298
  * Creates and displays an SAPUI5 control as the footer of the Fiori launchpad shell.
@@ -6162,7 +6332,7 @@ declare namespace sap {
6162
6332
  oControlProperties: object
6163
6333
  ): sap.ui.core.Control;
6164
6334
  /**
6165
- * @SINCE 1.30
6335
+ * @since 1.30
6166
6336
  *
6167
6337
  * Sets the title in the Fiori Launchpad shell header.
6168
6338
  */
@@ -6173,7 +6343,7 @@ declare namespace sap {
6173
6343
  sTitle: string
6174
6344
  ): void;
6175
6345
  /**
6176
- * @SINCE 1.38
6346
+ * @since 1.38
6177
6347
  *
6178
6348
  * Sets the header visibility according to the given value and shell states. (see sap.ushell.renderers.fiori2.renderer.LaunchpadState).
6179
6349
  *
@@ -6208,7 +6378,7 @@ declare namespace sap {
6208
6378
  aStates: string[]
6209
6379
  ): void;
6210
6380
  /**
6211
- * @SINCE 1.30
6381
+ * @since 1.30
6212
6382
  *
6213
6383
  * Sets the visibility of the left pane in the Fiori Launchpad shell, in the given launchpad state @see
6214
6384
  * LaunchpadState
@@ -6224,7 +6394,7 @@ declare namespace sap {
6224
6394
  bVisible: boolean
6225
6395
  ): void;
6226
6396
  /**
6227
- * @SINCE 1.48
6397
+ * @since 1.48
6228
6398
  *
6229
6399
  * Creates and displays an SAPUI5 control as the footer of the Fiori launchpad shell.
6230
6400
  * The footer will be displayed in all states.
@@ -6251,21 +6421,25 @@ declare namespace sap {
6251
6421
  * ```
6252
6422
  *
6253
6423
  *
6254
- * @returns object that when resolved, returns the newly created control
6424
+ * @returns jQuery.deferred.promise object that when resolved, returns the newly created control
6255
6425
  */
6256
6426
  setShellFooter(
6257
6427
  /**
6258
- * Contains the required parameters for creating and showing the new control object:
6259
- * Properties:
6260
- * - {string} controlType
6261
- * The (class) name of the control type to create, for example: `"sap.m.Bar"`
6262
- * - {object} oControlProperties
6263
- * The properties that will be passed to the created control, for example: `{id: "testBar"}`
6428
+ * Contains the required parameters for creating and showing the new control object.
6264
6429
  */
6265
- oParameters: object
6430
+ oParameters: {
6431
+ /**
6432
+ * The (class) name of the control type to create, for example: `sap.m.Bar`
6433
+ */
6434
+ controlType: string;
6435
+ /**
6436
+ * The properties that will be passed to the created control, for example: `{id: "testBar"}`
6437
+ */
6438
+ oControlProperties: object;
6439
+ }
6266
6440
  ): jQuery.Promise;
6267
6441
  /**
6268
- * @SINCE 1.30
6442
+ * @since 1.30
6269
6443
  *
6270
6444
  * Displays action buttons in the User Actions Menu in the SAP Fiori launchpad, in the given launchpad states
6271
6445
  * (LaunchpadState). (see sap.ushell.renderers.fiori2.renderer.LaunchpadState).
@@ -6303,7 +6477,7 @@ declare namespace sap {
6303
6477
  aStates: string[]
6304
6478
  ): void;
6305
6479
  /**
6306
- * @SINCE 1.30
6480
+ * @since 1.30
6307
6481
  * @deprecated (since 1.52) - Support for the FloatingActionButton has been discontinued.
6308
6482
  *
6309
6483
  * Displays FloatingActionButton on the bottom right corner of the Fiori launchpad, in the given launchpad
@@ -6337,7 +6511,7 @@ declare namespace sap {
6337
6511
  aStates: string[]
6338
6512
  ): void;
6339
6513
  /**
6340
- * @SINCE 1.30
6514
+ * @since 1.30
6341
6515
  *
6342
6516
  * Displays HeaderItems on the right side of the Fiori launchpad shell header, in the given launchpad states
6343
6517
  * (see sap.ushell.renderers.fiori2.renderer.LaunchpadState).
@@ -6371,7 +6545,7 @@ declare namespace sap {
6371
6545
  aStates: string[]
6372
6546
  ): void;
6373
6547
  /**
6374
- * @SINCE 1.30
6548
+ * @since 1.30
6375
6549
  *
6376
6550
  * Creates and displays one or more HeaderItem controls according to the given control IDs and Shell states
6377
6551
  * (see sap.ushell.renderers.fiori2.renderer.LaunchpadState).
@@ -6412,7 +6586,7 @@ declare namespace sap {
6412
6586
  aStates: string[]
6413
6587
  ): void;
6414
6588
  /**
6415
- * @SINCE 1.30
6589
+ * @since 1.30
6416
6590
  *
6417
6591
  * Displays one or more sub header controls according to the given control IDs and shell states.
6418
6592
  * (see sap.ushell.renderers.fiori2.renderer.LaunchpadState).
@@ -6468,7 +6642,7 @@ declare namespace sap {
6468
6642
  bVisible?: boolean
6469
6643
  ): void;
6470
6644
  /**
6471
- * @SINCE 1.30
6645
+ * @since 1.30
6472
6646
  *
6473
6647
  * Displays ToolAreaItems on the left side of the Fiori Launchpad shell, in the given launchpad states.
6474
6648
  *
@@ -6551,6 +6725,10 @@ declare namespace sap {
6551
6725
  afterRendering?: (oEvent: sap.ui.base.Event) => void;
6552
6726
  }
6553
6727
 
6728
+ interface AppBox$AfterRenderingEventParameters {}
6729
+
6730
+ interface AppBox$PressEventParameters {}
6731
+
6554
6732
  /**
6555
6733
  * Add your documentation for the new ui/appfinder/AppBox
6556
6734
  */
@@ -6749,7 +6927,7 @@ declare namespace sap {
6749
6927
  oListener?: object
6750
6928
  ): this;
6751
6929
  /**
6752
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
6930
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
6753
6931
  *
6754
6932
  * Fires event {@link #event:afterRendering afterRendering} to attached listeners.
6755
6933
  *
@@ -6762,7 +6940,7 @@ declare namespace sap {
6762
6940
  mParameters?: object
6763
6941
  ): this;
6764
6942
  /**
6765
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
6943
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
6766
6944
  *
6767
6945
  * Fires event {@link #event:press press} to attached listeners.
6768
6946
  *
@@ -6907,6 +7085,22 @@ declare namespace sap {
6907
7085
  sUrl?: string
6908
7086
  ): this;
6909
7087
  }
7088
+
7089
+ /**
7090
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'AppBox$AfterRenderingEventParameters'
7091
+ * in 1.115.1 and any later releases.
7092
+ */
7093
+ type $AppBoxAfterRenderingEventParameters = sap.ushell.ui.appfinder.AppBox$AfterRenderingEventParameters;
7094
+
7095
+ type AppBox$AfterRenderingEvent = sap.ui.base.Event<AppBox$AfterRenderingEventParameters>;
7096
+
7097
+ /**
7098
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'AppBox$PressEventParameters'
7099
+ * in 1.115.1 and any later releases.
7100
+ */
7101
+ type $AppBoxPressEventParameters = sap.ushell.ui.appfinder.AppBox$PressEventParameters;
7102
+
7103
+ type AppBox$PressEvent = sap.ui.base.Event<AppBox$PressEventParameters>;
6910
7104
  }
6911
7105
 
6912
7106
  namespace footerbar {
@@ -6974,7 +7168,7 @@ declare namespace sap {
6974
7168
  | `{${string}}`;
6975
7169
 
6976
7170
  /**
6977
- * Data source of the OData service. See same parameter of {@link sap.ushell.services.Bookmark#addBookmark}
7171
+ * Data source of the OData service. See same parameter of {@link sap.ushell.services.Bookmark#addBookmark }
6978
7172
  * for details
6979
7173
  */
6980
7174
  dataSource?:
@@ -7123,7 +7317,7 @@ declare namespace sap {
7123
7317
  /**
7124
7318
  * Gets current value of property {@link #getDataSource dataSource}.
7125
7319
  *
7126
- * Data source of the OData service. See same parameter of {@link sap.ushell.services.Bookmark#addBookmark}
7320
+ * Data source of the OData service. See same parameter of {@link sap.ushell.services.Bookmark#addBookmark }
7127
7321
  * for details
7128
7322
  *
7129
7323
  * @returns Value of property `dataSource`
@@ -7279,7 +7473,7 @@ declare namespace sap {
7279
7473
  /**
7280
7474
  * Sets a new value for property {@link #getDataSource dataSource}.
7281
7475
  *
7282
- * Data source of the OData service. See same parameter of {@link sap.ushell.services.Bookmark#addBookmark}
7476
+ * Data source of the OData service. See same parameter of {@link sap.ushell.services.Bookmark#addBookmark }
7283
7477
  * for details
7284
7478
  *
7285
7479
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
@@ -7546,6 +7740,23 @@ declare namespace sap {
7546
7740
  press?: (oEvent: sap.ui.base.Event) => void;
7547
7741
  }
7548
7742
 
7743
+ interface ActionItem$AfterRenderingEventParameters {}
7744
+
7745
+ interface ActionItem$PressEventParameters
7746
+ extends sap.m.Button$PressEventParameters {}
7747
+
7748
+ interface DashboardGroupsContainer$AfterRenderingEventParameters {}
7749
+
7750
+ interface LinkTileWrapper$AfterRenderingEventParameters {}
7751
+
7752
+ interface LinkTileWrapper$CoverDivPressEventParameters {}
7753
+
7754
+ interface LinkTileWrapper$PressEventParameters {}
7755
+
7756
+ interface LinkTileWrapper$ShowActionsEventParameters {}
7757
+
7758
+ interface TileState$PressEventParameters {}
7759
+
7549
7760
  class ActionItem extends sap.m.Button {
7550
7761
  /**
7551
7762
  * Constructor for a new ui/launchpad/ActionItem.
@@ -7731,7 +7942,7 @@ declare namespace sap {
7731
7942
  oListener?: object
7732
7943
  ): this;
7733
7944
  /**
7734
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
7945
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
7735
7946
  *
7736
7947
  * Fires event {@link #event:afterRendering afterRendering} to attached listeners.
7737
7948
  *
@@ -7744,7 +7955,7 @@ declare namespace sap {
7744
7955
  mParameters?: object
7745
7956
  ): this;
7746
7957
  /**
7747
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
7958
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
7748
7959
  *
7749
7960
  * Fires event {@link #event:press press} to attached listeners.
7750
7961
  *
@@ -7926,7 +8137,7 @@ declare namespace sap {
7926
8137
  oListener?: object
7927
8138
  ): this;
7928
8139
  /**
7929
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
8140
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
7930
8141
  *
7931
8142
  * Fires event {@link #event:afterRendering afterRendering} to attached listeners.
7932
8143
  *
@@ -8379,7 +8590,7 @@ declare namespace sap {
8379
8590
  oListener?: object
8380
8591
  ): this;
8381
8592
  /**
8382
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
8593
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
8383
8594
  *
8384
8595
  * Fires event {@link #event:afterRendering afterRendering} to attached listeners.
8385
8596
  *
@@ -8392,7 +8603,7 @@ declare namespace sap {
8392
8603
  mParameters?: object
8393
8604
  ): this;
8394
8605
  /**
8395
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
8606
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
8396
8607
  *
8397
8608
  * Fires event {@link #event:coverDivPress coverDivPress} to attached listeners.
8398
8609
  *
@@ -8405,7 +8616,7 @@ declare namespace sap {
8405
8616
  mParameters?: object
8406
8617
  ): this;
8407
8618
  /**
8408
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
8619
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
8409
8620
  *
8410
8621
  * Fires event {@link #event:press press} to attached listeners.
8411
8622
  *
@@ -8418,7 +8629,7 @@ declare namespace sap {
8418
8629
  mParameters?: object
8419
8630
  ): this;
8420
8631
  /**
8421
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
8632
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
8422
8633
  *
8423
8634
  * Fires event {@link #event:showActions showActions} to attached listeners.
8424
8635
  *
@@ -8868,7 +9079,7 @@ declare namespace sap {
8868
9079
  oListener?: object
8869
9080
  ): this;
8870
9081
  /**
8871
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
9082
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
8872
9083
  *
8873
9084
  * Fires event {@link #event:press press} to attached listeners.
8874
9085
  *
@@ -8904,6 +9115,70 @@ declare namespace sap {
8904
9115
  sState?: string
8905
9116
  ): this;
8906
9117
  }
9118
+
9119
+ /**
9120
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'ActionItem$AfterRenderingEventParameters'
9121
+ * in 1.115.1 and any later releases.
9122
+ */
9123
+ type $ActionItemAfterRenderingEventParameters = sap.ushell.ui.launchpad.ActionItem$AfterRenderingEventParameters;
9124
+
9125
+ type ActionItem$AfterRenderingEvent = sap.ui.base.Event<ActionItem$AfterRenderingEventParameters>;
9126
+
9127
+ /**
9128
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'ActionItem$PressEventParameters'
9129
+ * in 1.115.1 and any later releases.
9130
+ */
9131
+ type $ActionItemPressEventParameters = sap.ushell.ui.launchpad.ActionItem$PressEventParameters;
9132
+
9133
+ type ActionItem$PressEvent = sap.ui.base.Event<ActionItem$PressEventParameters>;
9134
+
9135
+ /**
9136
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'DashboardGroupsContainer$AfterRenderingEventParameters'
9137
+ * in 1.115.1 and any later releases.
9138
+ */
9139
+ type $DashboardGroupsContainerAfterRenderingEventParameters = sap.ushell.ui.launchpad.DashboardGroupsContainer$AfterRenderingEventParameters;
9140
+
9141
+ type DashboardGroupsContainer$AfterRenderingEvent = sap.ui.base.Event<DashboardGroupsContainer$AfterRenderingEventParameters>;
9142
+
9143
+ /**
9144
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'LinkTileWrapper$AfterRenderingEventParameters'
9145
+ * in 1.115.1 and any later releases.
9146
+ */
9147
+ type $LinkTileWrapperAfterRenderingEventParameters = sap.ushell.ui.launchpad.LinkTileWrapper$AfterRenderingEventParameters;
9148
+
9149
+ type LinkTileWrapper$AfterRenderingEvent = sap.ui.base.Event<LinkTileWrapper$AfterRenderingEventParameters>;
9150
+
9151
+ /**
9152
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'LinkTileWrapper$CoverDivPressEventParameters'
9153
+ * in 1.115.1 and any later releases.
9154
+ */
9155
+ type $LinkTileWrapperCoverDivPressEventParameters = sap.ushell.ui.launchpad.LinkTileWrapper$CoverDivPressEventParameters;
9156
+
9157
+ type LinkTileWrapper$CoverDivPressEvent = sap.ui.base.Event<LinkTileWrapper$CoverDivPressEventParameters>;
9158
+
9159
+ /**
9160
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'LinkTileWrapper$PressEventParameters'
9161
+ * in 1.115.1 and any later releases.
9162
+ */
9163
+ type $LinkTileWrapperPressEventParameters = sap.ushell.ui.launchpad.LinkTileWrapper$PressEventParameters;
9164
+
9165
+ type LinkTileWrapper$PressEvent = sap.ui.base.Event<LinkTileWrapper$PressEventParameters>;
9166
+
9167
+ /**
9168
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'LinkTileWrapper$ShowActionsEventParameters'
9169
+ * in 1.115.1 and any later releases.
9170
+ */
9171
+ type $LinkTileWrapperShowActionsEventParameters = sap.ushell.ui.launchpad.LinkTileWrapper$ShowActionsEventParameters;
9172
+
9173
+ type LinkTileWrapper$ShowActionsEvent = sap.ui.base.Event<LinkTileWrapper$ShowActionsEventParameters>;
9174
+
9175
+ /**
9176
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'TileState$PressEventParameters'
9177
+ * in 1.115.1 and any later releases.
9178
+ */
9179
+ type $TileStatePressEventParameters = sap.ushell.ui.launchpad.TileState$PressEventParameters;
9180
+
9181
+ type TileState$PressEvent = sap.ui.base.Event<TileState$PressEventParameters>;
8907
9182
  }
8908
9183
 
8909
9184
  namespace shell {
@@ -8927,7 +9202,7 @@ declare namespace sap {
8927
9202
  text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
8928
9203
 
8929
9204
  /**
8930
- * @SINCE 1.30
9205
+ * @since 1.30
8931
9206
  *
8932
9207
  * Text which will be read by screenreader.
8933
9208
  */
@@ -8962,8 +9237,12 @@ declare namespace sap {
8962
9237
  expand?: (oEvent: sap.ui.base.Event) => void;
8963
9238
  }
8964
9239
 
9240
+ interface ToolAreaItem$ExpandEventParameters {}
9241
+
9242
+ interface ToolAreaItem$PressEventParameters {}
9243
+
8965
9244
  /**
8966
- * @SINCE 1.30.5
9245
+ * @since 1.30.5
8967
9246
  *
8968
9247
  * A control to be placed in the tool area
8969
9248
  */
@@ -9153,7 +9432,7 @@ declare namespace sap {
9153
9432
  oListener?: object
9154
9433
  ): this;
9155
9434
  /**
9156
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
9435
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
9157
9436
  *
9158
9437
  * Fires event {@link #event:expand expand} to attached listeners.
9159
9438
  *
@@ -9166,7 +9445,7 @@ declare namespace sap {
9166
9445
  mParameters?: object
9167
9446
  ): this;
9168
9447
  /**
9169
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
9448
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
9170
9449
  *
9171
9450
  * Fires event {@link #event:press press} to attached listeners.
9172
9451
  *
@@ -9179,7 +9458,7 @@ declare namespace sap {
9179
9458
  mParameters?: object
9180
9459
  ): this;
9181
9460
  /**
9182
- * @SINCE 1.30
9461
+ * @since 1.30
9183
9462
  *
9184
9463
  * Gets current value of property {@link #getAriaLabel ariaLabel}.
9185
9464
  *
@@ -9235,7 +9514,7 @@ declare namespace sap {
9235
9514
  */
9236
9515
  getVisible(): boolean;
9237
9516
  /**
9238
- * @SINCE 1.30
9517
+ * @since 1.30
9239
9518
  *
9240
9519
  * Sets a new value for property {@link #getAriaLabel ariaLabel}.
9241
9520
  *
@@ -9333,11 +9612,27 @@ declare namespace sap {
9333
9612
  bVisible?: boolean
9334
9613
  ): this;
9335
9614
  }
9615
+
9616
+ /**
9617
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'ToolAreaItem$ExpandEventParameters'
9618
+ * in 1.115.1 and any later releases.
9619
+ */
9620
+ type $ToolAreaItemExpandEventParameters = sap.ushell.ui.shell.ToolAreaItem$ExpandEventParameters;
9621
+
9622
+ type ToolAreaItem$ExpandEvent = sap.ui.base.Event<ToolAreaItem$ExpandEventParameters>;
9623
+
9624
+ /**
9625
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'ToolAreaItem$PressEventParameters'
9626
+ * in 1.115.1 and any later releases.
9627
+ */
9628
+ type $ToolAreaItemPressEventParameters = sap.ushell.ui.shell.ToolAreaItem$PressEventParameters;
9629
+
9630
+ type ToolAreaItem$PressEvent = sap.ui.base.Event<ToolAreaItem$PressEventParameters>;
9336
9631
  }
9337
9632
 
9338
9633
  namespace tile {
9339
9634
  /**
9340
- * @SINCE 1.15.0
9635
+ * @since 1.15.0
9341
9636
  *
9342
9637
  * An applauncher tile for simple, static apps, displaying title, subtitle, an icon and additional information
9343
9638
  */
@@ -9349,8 +9644,8 @@ declare namespace sap {
9349
9644
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
9350
9645
  * of the syntax of the settings object.
9351
9646
  *
9352
- * This class does not have its own settings, but all settings applicable to the base type {@link sap.ushell.ui.tile.TileBase#constructor
9353
- * sap.ushell.ui.tile.TileBase} can be used.
9647
+ * This class does not have its own settings, but all settings applicable to the base type {@link sap.ushell.ui.tile.TileBase#constructor sap.ushell.ui.tile.TileBase }
9648
+ * can be used.
9354
9649
  */
9355
9650
  constructor(
9356
9651
  /**
@@ -9431,10 +9726,9 @@ declare namespace sap {
9431
9726
  */
9432
9727
  getMetadata(): sap.ui.base.Metadata;
9433
9728
  }
9434
- const UserStatus: UserStatus;
9435
9729
 
9436
9730
  /**
9437
- * @SINCE 1.38.0
9731
+ * @since 1.38.0
9438
9732
  *
9439
9733
  * The Unified Shell's ShellUIService service.
9440
9734
  *
@@ -9562,7 +9856,7 @@ declare namespace sap {
9562
9856
  */
9563
9857
  static getMetadata(): sap.ui.base.Metadata;
9564
9858
  /**
9565
- * @SINCE 1.38.0
9859
+ * @since 1.38.0
9566
9860
  *
9567
9861
  * Returns the title that was last set via {@link setTitle}.
9568
9862
  *
@@ -9570,7 +9864,7 @@ declare namespace sap {
9570
9864
  */
9571
9865
  getTitle(): string;
9572
9866
  /**
9573
- * @SINCE 1.38.0
9867
+ * @since 1.38.0
9574
9868
  *
9575
9869
  * Displays the given hierarchy in the shell header.
9576
9870
  */
@@ -9607,7 +9901,7 @@ declare namespace sap {
9607
9901
  aHierarchyLevels?: object[]
9608
9902
  ): void;
9609
9903
  /**
9610
- * @SINCE 1.40.0
9904
+ * @since 1.40.0
9611
9905
  *
9612
9906
  * Used by apps to set related apps. This setting is propagated towards the Shell Header via corresponding
9613
9907
  * events.
@@ -9644,7 +9938,7 @@ declare namespace sap {
9644
9938
  aRelatedApps?: object[]
9645
9939
  ): void;
9646
9940
  /**
9647
- * @SINCE 1.38.0
9941
+ * @since 1.38.0
9648
9942
  *
9649
9943
  * Displays the given title in the shell header. This method should not be called if the app calling the
9650
9944
  * method is not currently displayed in the Fiori Launchpad.
@@ -9659,7 +9953,7 @@ declare namespace sap {
9659
9953
  }
9660
9954
 
9661
9955
  /**
9662
- * @SINCE 1.15.0
9956
+ * @since 1.15.0
9663
9957
  *
9664
9958
  * The Unified Shell's container which manages renderers, services, and adapters. The container is designed
9665
9959
  * to be a singleton. Instead of creating an instance please access the central instance via namespace `sap.ushell.Container`.
@@ -9667,14 +9961,14 @@ declare namespace sap {
9667
9961
  class Container {
9668
9962
  constructor();
9669
9963
  /**
9670
- * @SINCE 1.21.1
9964
+ * @since 1.21.1
9671
9965
  *
9672
9966
  * An enumeration for the application work protect mode state.
9673
9967
  */
9674
9968
  DirtyState: sap.ushell.Container.DirtyState;
9675
9969
 
9676
9970
  /**
9677
- * @SINCE 1.15.0
9971
+ * @since 1.15.0
9678
9972
  *
9679
9973
  * Logs out the current user from all relevant back-end systems, including the logon system itself. This
9680
9974
  * member represents the default native implementation of logout. If SessionHandler was created, we register
@@ -9683,7 +9977,7 @@ declare namespace sap {
9683
9977
  logout: undefined;
9684
9978
 
9685
9979
  /**
9686
- * @SINCE 1.15.0
9980
+ * @since 1.15.0
9687
9981
  *
9688
9982
  * Adds a system to the list of remote systems currently in use. On logout this list is processed and performs
9689
9983
  * a logout for each system via the ContainerAdapter specific for its platform.
@@ -9695,7 +9989,7 @@ declare namespace sap {
9695
9989
  oRemoteSystem: sap.ushell.System
9696
9990
  ): void;
9697
9991
  /**
9698
- * @SINCE 1.19.1
9992
+ * @since 1.19.1
9699
9993
  *
9700
9994
  * Attaches a listener to the logout event. In case the bAsyncFunction parameter is true, the fnFunction
9701
9995
  * must return a promise. FLP will wait for the promise to be resolved before doing the actual logout.
@@ -9711,7 +10005,7 @@ declare namespace sap {
9711
10005
  bAsyncFunction: boolean
9712
10006
  ): void;
9713
10007
  /**
9714
- * @SINCE 1.34.1
10008
+ * @since 1.34.1
9715
10009
  *
9716
10010
  * Attaches a listener to the rendererCreated event.
9717
10011
  */
@@ -9725,7 +10019,7 @@ declare namespace sap {
9725
10019
  fnFunction: Function
9726
10020
  ): void;
9727
10021
  /**
9728
- * @SINCE 1.21.2
10022
+ * @since 1.21.2
9729
10023
  *
9730
10024
  * Cancels the logon procedure in the current frame, if any. This MUST be used by the logon frame provider
9731
10025
  * in case the user wants to close the logon frame for good. It will report "Authentication cancelled" and
@@ -9736,7 +10030,7 @@ declare namespace sap {
9736
10030
  */
9737
10031
  cancelLogon(): void;
9738
10032
  /**
9739
- * @SINCE 1.15.0
10033
+ * @since 1.15.0
9740
10034
  *
9741
10035
  * Creates a new renderer instance for the given renderer name.
9742
10036
  *
@@ -9767,9 +10061,13 @@ declare namespace sap {
9767
10061
  * If `true`, the renderer is created asynchronously and a `Promise` is returned.
9768
10062
  */
9769
10063
  bAsync?: boolean
9770
- ): sap.ui.core.Control | Promise<any>;
10064
+ ):
10065
+ | sap.ui.core.Control
10066
+ | Promise<sap.ui.core.Control>
10067
+ | sap.ui.core.ComponentContainer
10068
+ | Promise<sap.ui.core.ComponentContainer>;
9771
10069
  /**
9772
- * @SINCE 1.67.0
10070
+ * @since 1.67.0
9773
10071
  *
9774
10072
  * Deregister the work protection dirty callback function. See registerDirtyStateProvider for more information.
9775
10073
  * Only the last registered function will be deregistered (in case it was registered multiple times).
@@ -9781,7 +10079,7 @@ declare namespace sap {
9781
10079
  fnDirty: Function
9782
10080
  ): void;
9783
10081
  /**
9784
- * @SINCE 1.19.1
10082
+ * @since 1.19.1
9785
10083
  *
9786
10084
  * Detaches a listener from the logout event.
9787
10085
  */
@@ -9792,7 +10090,7 @@ declare namespace sap {
9792
10090
  fnFunction: Function
9793
10091
  ): void;
9794
10092
  /**
9795
- * @SINCE 1.34.1
10093
+ * @since 1.34.1
9796
10094
  *
9797
10095
  * Detaches a listener from the rendererCreated event.
9798
10096
  */
@@ -9803,7 +10101,7 @@ declare namespace sap {
9803
10101
  fnFunction: Function
9804
10102
  ): void;
9805
10103
  /**
9806
- * @SINCE 1.27.0
10104
+ * @since 1.27.0
9807
10105
  *
9808
10106
  * If the dirty state was set to 'false' using 'setDirtyFlag' the registered dirty state provider methods
9809
10107
  * get called to determine the actual dirty state. The determined dirty state is then returned.
@@ -9815,7 +10113,7 @@ declare namespace sap {
9815
10113
  */
9816
10114
  getDirtyFlag(): boolean;
9817
10115
  /**
9818
- * @SINCE 1.21.1
10116
+ * @since 1.21.1
9819
10117
  *
9820
10118
  * Returns the global dirty state.
9821
10119
  *
@@ -9825,7 +10123,7 @@ declare namespace sap {
9825
10123
  */
9826
10124
  getGlobalDirty(): jQuery.Deferred;
9827
10125
  /**
9828
- * @SINCE 1.30.0
10126
+ * @since 1.30.0
9829
10127
  *
9830
10128
  * Gets a renderer instance for the given renderer name, that was created by the createRenderer method.
9831
10129
  *
@@ -9840,9 +10138,9 @@ declare namespace sap {
9840
10138
  * if not given here.
9841
10139
  */
9842
10140
  sRendererName?: string
9843
- ): object;
10141
+ ): sap.ui.core.Control | sap.ui.core.Component;
9844
10142
  /**
9845
- * @SINCE 1.15.0
10143
+ * @since 1.15.0
9846
10144
  * @deprecated (since 1.77) - Please use {@link #getServiceAsync} instead.
9847
10145
  *
9848
10146
  * Returns a service with the given name, creating it if necessary. Services are singleton objects identified
@@ -9915,9 +10213,9 @@ declare namespace sap {
9915
10213
  * if true, the adapter is loaded asynchronously and a Promise is returned. (since 1.55.0)
9916
10214
  */
9917
10215
  bAsync?: boolean
9918
- ): object | Promise<any>;
10216
+ ): object | Promise<object>;
9919
10217
  /**
9920
- * @SINCE 1.55.0
10218
+ * @since 1.55.0
9921
10219
  *
9922
10220
  * Returns a Promise that resolves a service with the given name, creating it if necessary. Services are
9923
10221
  * singleton objects identified by their (resulting) name.
@@ -9983,9 +10281,9 @@ declare namespace sap {
9983
10281
  * A parameter which is passed to the service constructor and every adapter constructor.
9984
10282
  */
9985
10283
  sParameter?: string
9986
- ): Promise<any>;
10284
+ ): Promise<object>;
9987
10285
  /**
9988
- * @SINCE 1.31.0
10286
+ * @since 1.31.0
9989
10287
  *
9990
10288
  * Register the work protection dirty callback function. In the work protect mechanism, each platform can
9991
10289
  * register their own method in order to check if data was changed during the session, and notify the container
@@ -10012,7 +10310,7 @@ declare namespace sap {
10012
10310
  fnDirty: Function
10013
10311
  ): void;
10014
10312
  /**
10015
- * @SINCE 1.27.0
10313
+ * @since 1.27.0
10016
10314
  *
10017
10315
  * Setter for the isDirty flag value.
10018
10316
  *
@@ -10026,7 +10324,7 @@ declare namespace sap {
10026
10324
  ): void;
10027
10325
  }
10028
10326
  /**
10029
- * @SINCE 1.15.0
10327
+ * @since 1.15.0
10030
10328
  *
10031
10329
  * A representation of a system
10032
10330
  */