@sapui5/ts-types 1.120.8 → 1.121.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +1 -0
  3. package/types/sap.apf.d.ts +50 -18
  4. package/types/sap.ca.ui.d.ts +1114 -546
  5. package/types/sap.chart.d.ts +17 -1
  6. package/types/sap.collaboration.d.ts +185 -64
  7. package/types/sap.esh.search.ui.d.ts +2 -1960
  8. package/types/sap.f.d.ts +124 -45
  9. package/types/sap.fe.core.d.ts +212 -191
  10. package/types/sap.fe.macros.d.ts +371 -531
  11. package/types/sap.fe.navigation.d.ts +59 -26
  12. package/types/sap.fe.placeholder.d.ts +1 -1
  13. package/types/sap.fe.plugins.managecache.d.ts +7 -0
  14. package/types/sap.fe.templates.d.ts +16 -11
  15. package/types/sap.fe.test.d.ts +333 -33
  16. package/types/sap.fe.tools.d.ts +1 -1
  17. package/types/sap.feedback.ui.d.ts +1 -1
  18. package/types/sap.gantt.d.ts +3947 -1754
  19. package/types/sap.insights.d.ts +162 -43
  20. package/types/sap.m.d.ts +2023 -289
  21. package/types/sap.makit.d.ts +11 -1
  22. package/types/sap.me.d.ts +7 -1
  23. package/types/sap.ndc.d.ts +1 -1
  24. package/types/sap.ovp.d.ts +9 -7
  25. package/types/sap.rules.ui.d.ts +134 -75
  26. package/types/sap.sac.df.d.ts +272 -49
  27. package/types/sap.suite.ui.commons.d.ts +4231 -1008
  28. package/types/sap.suite.ui.generic.template.d.ts +38 -48
  29. package/types/sap.suite.ui.microchart.d.ts +66 -1
  30. package/types/sap.tnt.d.ts +601 -116
  31. package/types/sap.ui.codeeditor.d.ts +10 -6
  32. package/types/sap.ui.commons.d.ts +86 -8
  33. package/types/sap.ui.comp.d.ts +259 -110
  34. package/types/sap.ui.core.d.ts +471 -186
  35. package/types/sap.ui.dt.d.ts +1 -1
  36. package/types/sap.ui.export.d.ts +16 -3
  37. package/types/sap.ui.fl.d.ts +91 -68
  38. package/types/sap.ui.generic.app.d.ts +250 -193
  39. package/types/sap.ui.generic.template.d.ts +1 -1
  40. package/types/sap.ui.integration.d.ts +51 -4
  41. package/types/sap.ui.layout.d.ts +221 -26
  42. package/types/sap.ui.mdc.d.ts +1516 -787
  43. package/types/sap.ui.richtexteditor.d.ts +4 -1
  44. package/types/sap.ui.rta.d.ts +1 -1
  45. package/types/sap.ui.suite.d.ts +3 -1
  46. package/types/sap.ui.support.d.ts +28 -4
  47. package/types/sap.ui.table.d.ts +65 -11
  48. package/types/sap.ui.testrecorder.d.ts +1 -1
  49. package/types/sap.ui.unified.d.ts +157 -54
  50. package/types/sap.ui.ux3.d.ts +30 -12
  51. package/types/sap.ui.vbm.d.ts +5300 -2517
  52. package/types/sap.ui.vk.d.ts +2742 -836
  53. package/types/sap.ui.vtm.d.ts +685 -215
  54. package/types/sap.ui.webc.common.d.ts +1 -1
  55. package/types/sap.ui.webc.fiori.d.ts +49 -1
  56. package/types/sap.ui.webc.main.d.ts +144 -9
  57. package/types/sap.uiext.inbox.d.ts +1 -1
  58. package/types/sap.ushell.d.ts +977 -535
  59. package/types/sap.ushell_abap.d.ts +1 -1
  60. package/types/sap.uxap.d.ts +55 -5
  61. package/types/sap.viz.d.ts +86 -1
  62. package/types/sap.webanalytics.core.d.ts +1 -1
  63. package/types/sap.zen.commons.d.ts +79 -18
  64. package/types/sap.zen.crosstab.d.ts +83 -15
  65. package/types/sap.zen.dsh.d.ts +194 -143
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.8
1
+ // For Library Version: 1.121.0
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -52,7 +52,7 @@ declare namespace sap {
52
52
  * @since 1.15.0
53
53
  * @deprecated (since 1.120)
54
54
  *
55
- * @returns a promise that is resolved once the container is available
55
+ * @returns Resolves once the container is available.
56
56
  */
57
57
  function bootstrap(
58
58
  /**
@@ -66,19 +66,13 @@ declare namespace sap {
66
66
  mAdapterPackagesByPlatform?: Record<string, string>
67
67
  ): jQuery.Promise;
68
68
  /**
69
+ * Default namespace for Unified Shell services.
69
70
  * See:
70
- * sap.ushell.Container.getServiceAsync()
71
+ * sap.ushell.Container.getServiceAsync
71
72
  *
72
73
  * @since 1.15.0
73
74
  */
74
75
  namespace services {
75
- /**
76
- * @since 1.62.0
77
- * @deprecated
78
- * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
79
- */
80
- export const ContentExtensionAdapterFactory: undefined;
81
-
82
76
  namespace Bookmark {
83
77
  /**
84
78
  * A content node may be: - a classic home page group - an unselectable node (space) or a selectable node
@@ -110,8 +104,7 @@ declare namespace sap {
110
104
 
111
105
  namespace BookmarkV2 {
112
106
  /**
113
- * A content node may be: - a classic home page group - an unselectable node (space) or a selectable node
114
- * (page) in spaces mode - or any other containers in the future
107
+ * A tree of content nodes.
115
108
  */
116
109
  type ContentNode = {
117
110
  /**
@@ -123,7 +116,7 @@ declare namespace sap {
123
116
  */
124
117
  label: string;
125
118
  /**
126
- * Specifies the content node type. E.g: space, page, group, etc. See {@link sap.ushell.sap.ushell.services.BookmarkV2.ContentNodeType}
119
+ * Specifies the content node type. E.g: space, page, etc. See {@link sap.ushell.sap.ushell.services.BookmarkV2.ContentNodeType}
127
120
  */
128
121
  type: sap.ushell.ContentNodeType;
129
122
  /**
@@ -146,7 +139,10 @@ declare namespace sap {
146
139
  * @experimental (since 1.120.0)
147
140
  */
148
141
  class Footer {
149
- constructor();
142
+ /**
143
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
144
+ */
145
+ protected constructor();
150
146
 
151
147
  /**
152
148
  * Destroys the footer.
@@ -164,7 +160,10 @@ declare namespace sap {
164
160
  * @experimental (since 1.120.0)
165
161
  */
166
162
  class Item {
167
- constructor();
163
+ /**
164
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
165
+ */
166
+ protected constructor();
168
167
 
169
168
  /**
170
169
  * Destroys the item and it's related content.
@@ -179,51 +178,51 @@ declare namespace sap {
179
178
  *
180
179
  * @since 1.120.0
181
180
  *
182
- * @returns this to allow method chaining.
181
+ * @returns Reference to `this` for method chaining.
183
182
  */
184
- hideForAllApps(): sap.ushell.services.Extension.Item;
183
+ hideForAllApps(): this;
185
184
  /**
186
185
  * Hides the item for the current application. Note: The item will not be hidden if it was set visible for
187
186
  * all apps {@link #showForAllApps}
188
187
  *
189
188
  * @since 1.120.0
190
189
  *
191
- * @returns this to allow method chaining.
190
+ * @returns Reference to `this` for method chaining.
192
191
  */
193
- hideForCurrentApp(): sap.ushell.services.Extension.Item;
192
+ hideForCurrentApp(): this;
194
193
  /**
195
194
  * Hides the item for launchpad "home". Does not change the visibility of the item within applications.
196
195
  *
197
196
  * @since 1.120.0
198
197
  *
199
- * @returns this to allow method chaining.
198
+ * @returns Reference to `this` for method chaining.
200
199
  */
201
- hideOnHome(): sap.ushell.services.Extension.Item;
200
+ hideOnHome(): this;
202
201
  /**
203
202
  * Shows the item for all applications. Does not change the visibility of the item for the launchpad "home".
204
203
  *
205
204
  * @since 1.120.0
206
205
  *
207
- * @returns this to allow method chaining.
206
+ * @returns Reference to `this` for method chaining.
208
207
  */
209
- showForAllApps(): sap.ushell.services.Extension.Item;
208
+ showForAllApps(): this;
210
209
  /**
211
210
  * Shows the item for the current application. The item will be hidden after the user navigates away from
212
211
  * this application. The item will not be added again if the user navigates back to the application.
213
212
  *
214
213
  * @since 1.120.0
215
214
  *
216
- * @returns this to allow method chaining.
215
+ * @returns Reference to `this` for method chaining.
217
216
  */
218
- showForCurrentApp(): sap.ushell.services.Extension.Item;
217
+ showForCurrentApp(): this;
219
218
  /**
220
219
  * Shows the item for launchpad "home". Does not change the visibility of the item within applications.
221
220
  *
222
221
  * @since 1.120.0
223
222
  *
224
- * @returns this to allow method chaining.
223
+ * @returns Reference to `this` for method chaining.
225
224
  */
226
- showOnHome(): sap.ushell.services.Extension.Item;
225
+ showOnHome(): this;
227
226
  }
228
227
  /**
229
228
  * The side pane extension point is positioned next the launchpad content. To be instantiated by {@link sap.ushell.services.Extension}.
@@ -233,7 +232,10 @@ declare namespace sap {
233
232
  * @experimental (since 1.120.0)
234
233
  */
235
234
  class SidePane {
236
- constructor();
235
+ /**
236
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
237
+ */
238
+ protected constructor();
237
239
 
238
240
  /**
239
241
  * Creates an item in the side pane.
@@ -263,34 +265,34 @@ declare namespace sap {
263
265
  *
264
266
  * @since 1.120.0
265
267
  *
266
- * @returns this to allow method chaining.
268
+ * @returns Reference to `this` for method chaining.
267
269
  */
268
- hideForAllApps(): sap.ushell.services.Extension.SidePane;
270
+ hideForAllApps(): this;
269
271
  /**
270
272
  * Hides the area for launchpad "home". Does not change the visibility of the area within applications.
271
273
  *
272
274
  * @since 1.120.0
273
275
  *
274
- * @returns this to allow method chaining.
276
+ * @returns Reference to `this` for method chaining.
275
277
  */
276
- hideOnHome(): sap.ushell.services.Extension.SidePane;
278
+ hideOnHome(): this;
277
279
  /**
278
280
  * Shows the side pane for all applications. Does not change the visibility of the side pane for the launchpad
279
281
  * "home".
280
282
  *
281
283
  * @since 1.120.0
282
284
  *
283
- * @returns this to allow method chaining.
285
+ * @returns Reference to `this` for method chaining.
284
286
  */
285
- showForAllApps(): sap.ushell.services.Extension.SidePane;
287
+ showForAllApps(): this;
286
288
  /**
287
289
  * Shows the side pane for launchpad "home". Does not change the visibility of the side pane within applications.
288
290
  *
289
291
  * @since 1.120.0
290
292
  *
291
- * @returns this to allow method chaining.
293
+ * @returns Reference to `this` for method chaining.
292
294
  */
293
- showOnHome(): sap.ushell.services.Extension.SidePane;
295
+ showOnHome(): this;
294
296
  }
295
297
  /**
296
298
  * The tool area extension point is positioned next the launchpad content. To be instantiated by {@link sap.ushell.services.Extension}.
@@ -300,7 +302,10 @@ declare namespace sap {
300
302
  * @experimental (since 1.120.0)
301
303
  */
302
304
  class ToolArea {
303
- constructor();
305
+ /**
306
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
307
+ */
308
+ protected constructor();
304
309
 
305
310
  /**
306
311
  * Creates an item in the tool area.
@@ -321,34 +326,34 @@ declare namespace sap {
321
326
  *
322
327
  * @since 1.120.0
323
328
  *
324
- * @returns this to allow method chaining.
329
+ * @returns Reference to `this` for method chaining.
325
330
  */
326
- hideForAllApps(): sap.ushell.services.Extension.ToolArea;
331
+ hideForAllApps(): this;
327
332
  /**
328
333
  * Hides the tool area for launchpad "home". Does not change the visibility of the tool area within applications.
329
334
  *
330
335
  * @since 1.120.0
331
336
  *
332
- * @returns this to allow method chaining.
337
+ * @returns Reference to `this` for method chaining.
333
338
  */
334
- hideOnHome(): sap.ushell.services.Extension.ToolArea;
339
+ hideOnHome(): this;
335
340
  /**
336
341
  * Shows the tool area for all applications. Does not change the visibility of the tool area for the launchpad
337
342
  * "home".
338
343
  *
339
344
  * @since 1.120.0
340
345
  *
341
- * @returns this to allow method chaining.
346
+ * @returns Reference to `this` for method chaining.
342
347
  */
343
- showForAllApps(): sap.ushell.services.Extension.ToolArea;
348
+ showForAllApps(): this;
344
349
  /**
345
350
  * Shows the tool area for launchpad "home". Does not change the visibility of the tool area within applications.
346
351
  *
347
352
  * @since 1.120.0
348
353
  *
349
- * @returns this to allow method chaining.
354
+ * @returns Reference to `this` for method chaining.
350
355
  */
351
- showOnHome(): sap.ushell.services.Extension.ToolArea;
356
+ showOnHome(): this;
352
357
  }
353
358
  }
354
359
 
@@ -537,15 +542,17 @@ declare namespace sap {
537
542
  /**
538
543
  * The container is the anchor object of the unified shell personalization in container mode.
539
544
  *
545
+ * To be called by the personalization service getContainer method.
546
+ *
540
547
  * @since 1.22.0
541
548
  * @deprecated (since 1.120) - Please use {@link sap.ushell.services.PersonalizationV2.ContextContainer }
542
549
  * instead
543
550
  */
544
551
  class ContextContainer {
545
552
  /**
546
- * To be called by the personalization service getContainer method.
553
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
547
554
  */
548
- constructor();
555
+ protected constructor();
549
556
 
550
557
  /**
551
558
  * Returns an array with all internal keys of direct items in the container.
@@ -555,7 +562,7 @@ declare namespace sap {
555
562
  *
556
563
  * @returns item keys
557
564
  */
558
- _getInternalKeys(): any[];
565
+ _getInternalKeys(): string[];
559
566
  /**
560
567
  * clears the local copy data of this container
561
568
  *
@@ -591,9 +598,9 @@ declare namespace sap {
591
598
  *
592
599
  * @since 1.22.0
593
600
  *
594
- * @returns promise
601
+ * @returns Resolves once the requests were flushed.
595
602
  */
596
- flush(): object;
603
+ flush(): jQuery.Promise;
597
604
  /**
598
605
  * Returns an array with the keys of direct items in the container.
599
606
  *
@@ -601,7 +608,7 @@ declare namespace sap {
601
608
  *
602
609
  * @returns item keys
603
610
  */
604
- getItemKeys(): any[];
611
+ getItemKeys(): string[];
605
612
  /**
606
613
  * Returns the value for a direct item from the container. (Value semantics, new copy is returned)
607
614
  *
@@ -651,9 +658,9 @@ declare namespace sap {
651
658
  *
652
659
  * @since 1.22.0
653
660
  *
654
- * @returns Promise object
661
+ * @returns Resolves once the context container is loaded.
655
662
  */
656
- load(): object;
663
+ load(): jQuery.Promise;
657
664
  /**
658
665
  * Attempts to save the current container data at the underlying storage asynchronously. The current state
659
666
  * is serialized.
@@ -662,22 +669,22 @@ declare namespace sap {
662
669
  * @deprecated (since 1.120.0) - Use {@link sap.ushell.services.Personalization.ContextContainer#saveDeferred }
663
670
  * instead
664
671
  *
665
- * @returns Promise object
672
+ * @returns Resolves once the container is saved.
666
673
  *
667
674
  * If another save/load/delete operation is not completed, the operation may fail! (wait for the other promise).
668
675
  */
669
- save(): object;
676
+ save(): jQuery.Promise;
670
677
  /**
671
678
  * Save the current container data at the underlying storage asynchronously at the earlies nDelayInMilliseconds
672
679
  * seconds before. The current state is serialized.
673
680
  *
674
681
  * @since 1.22.0
675
682
  *
676
- * @returns Promise object
683
+ * @returns Resolves once the container is saved.
677
684
  *
678
685
  * The operation may wait for completion of another pending operation.
679
686
  */
680
- saveDeferred(): object;
687
+ saveDeferred(): jQuery.Promise;
681
688
  /**
682
689
  * Sets the value of a direct item in the container. In case the item is already existing its value is overwritten.
683
690
  * In case it is not existing a new item with this key and value is created. The value is serialized during
@@ -700,27 +707,31 @@ declare namespace sap {
700
707
  * The personalization container is the anchor object of the unified shell personalization in container
701
708
  * mode.
702
709
  *
710
+ * To be called by the personalization service getPersonalizationContainer method.
711
+ *
703
712
  * @since 1.18.0
704
713
  * @deprecated (since 1.120) - Please use {@link sap.ushell.services.Personalization#getContainer} instead
705
714
  */
706
715
  class PersonalizationContainer {
707
716
  /**
708
- * To be called by the personalization service getPersonalizationContainer method.
717
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
709
718
  */
710
- constructor();
719
+ protected constructor();
711
720
  }
712
721
  /**
713
722
  * The personalization variant contains personalization data. It is used in the personalization container
714
723
  * mode.
715
724
  *
725
+ * To be called by the personalization variant set.
726
+ *
716
727
  * @since 1.18.0
717
728
  * @deprecated (since 1.120) - Please use {@link sap.ushell.services.Personalization#getContainer} instead
718
729
  */
719
730
  class PersonalizationContainerVariant {
720
731
  /**
721
- * To be called by the personalization variant set.
732
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
722
733
  */
723
- constructor();
734
+ protected constructor();
724
735
 
725
736
  /**
726
737
  * Checks if a specific item is contained in this variant.
@@ -753,7 +764,7 @@ declare namespace sap {
753
764
  *
754
765
  * @returns item keys
755
766
  */
756
- getItemKeys(): any[];
767
+ getItemKeys(): string[];
757
768
  /**
758
769
  * Returns the value for an item in this variant.
759
770
  *
@@ -804,20 +815,16 @@ declare namespace sap {
804
815
  * The personalization variant set contains variants of personalization data. It is used in the personalization
805
816
  * container mode.
806
817
  *
818
+ * To be called by the personalization container.
819
+ *
807
820
  * @since 1.18.0
808
821
  * @deprecated (since 1.120) - Please use {@link sap.ushell.services.Personalization#getContainer} instead
809
822
  */
810
823
  class PersonalizationContainerVariantSet {
811
824
  /**
812
- * To be called by the personalization container.
813
- */
814
- constructor();
815
- /**
816
- * Deletes a variant from the variant set. In case the variant does not exist nothing happens.
817
- *
818
- * @since 1.18.0
825
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
819
826
  */
820
- delVariant: undefined;
827
+ protected constructor();
821
828
 
822
829
  /**
823
830
  * Checks if a specific variant is contained in the variant set.
@@ -832,6 +839,17 @@ declare namespace sap {
832
839
  */
833
840
  sVariantKey: string
834
841
  ): boolean;
842
+ /**
843
+ * Deletes a variant from the variant set. In case the variant does not exist nothing happens.
844
+ *
845
+ * @since 1.18.0
846
+ */
847
+ delVariant(
848
+ /**
849
+ * variant key
850
+ */
851
+ sVariantKey: string
852
+ ): void;
835
853
  /**
836
854
  * Returns the current variant key.
837
855
  *
@@ -845,7 +863,7 @@ declare namespace sap {
845
863
  *
846
864
  * @since 1.18.0
847
865
  *
848
- * @returns {@link sap.ushell.services.Personalization.PersonalizationContainerVariant}. In case the variant
866
+ * @returns {@link sap.ushell.services.Personalization.PersonalizationContainerVariant} In case the variant
849
867
  * set does not contain a variant with this key `undefined` is returned.
850
868
  */
851
869
  getVariant(
@@ -875,7 +893,7 @@ declare namespace sap {
875
893
  *
876
894
  * @returns variant keys
877
895
  */
878
- getVariantKeys(): any[];
896
+ getVariantKeys(): string[];
879
897
  /**
880
898
  * Sets the current variant key.
881
899
  *
@@ -892,14 +910,47 @@ declare namespace sap {
892
910
  * The Unified Shell personalizer providing set get delete methods to access the persisted personalization
893
911
  * data in direct mode.
894
912
  *
913
+ * To be called by the personalization service getPersonalizer method.
914
+ *
895
915
  * @since 1.15.0
896
916
  * @deprecated (since 1.120) - Please use {@link sap.ushell.services.PersonalizationV2.Personalizer} instead
897
917
  */
898
918
  class Personalizer {
899
919
  /**
900
- * To be called by the personalization service getPersonalizer method.
920
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
901
921
  */
902
- constructor();
922
+ protected constructor();
923
+
924
+ /**
925
+ * Deletes a personalization data value.
926
+ *
927
+ * @since 1.15.0
928
+ *
929
+ * @returns Resolves once the pers data was deleted or rejects with an error message.
930
+ */
931
+ delPersData(): jQuery.Promise;
932
+ /**
933
+ * Gets a personalization data value.
934
+ *
935
+ * @since 1.15.0
936
+ *
937
+ * @returns Resolves the personalization value. If there is no personalization data for the item, undefined
938
+ * is returned. Promise object fail function: param {string} sMessage Error message.
939
+ */
940
+ getPersData(): jQuery.Promise;
941
+ /**
942
+ * Sets a personalization data value.
943
+ *
944
+ * @since 1.15.0
945
+ *
946
+ * @returns Resolves once the pers data was stored or rejects with an error message.
947
+ */
948
+ setPersData(
949
+ /**
950
+ * JSON object containing the personalization value.
951
+ */
952
+ oValue: object
953
+ ): jQuery.Promise;
903
954
  }
904
955
  /**
905
956
  * The transient personalizer shall be used in container mode for table personalization. To be called by
@@ -916,14 +967,16 @@ declare namespace sap {
916
967
  * The personalization variant contains personalization data. It is used in the personalization container
917
968
  * mode.
918
969
  *
970
+ * To be instantiated via Personalization.VariantSet add / get Variant only
971
+ *
919
972
  * @since 1.22.0
920
973
  * @deprecated (since 1.120) - Please use {@link sap.ushell.services.PersonalizationV2.Variant} instead
921
974
  */
922
975
  class Variant {
923
976
  /**
924
- * To be instantiated via Personalization.VariantSet add / get Variant only
977
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
925
978
  */
926
- constructor();
979
+ protected constructor();
927
980
 
928
981
  /**
929
982
  * Checks if a specific item is contained in this variant.
@@ -956,7 +1009,7 @@ declare namespace sap {
956
1009
  *
957
1010
  * @returns item keys
958
1011
  */
959
- getItemKeys(): any[];
1012
+ getItemKeys(): string[];
960
1013
  /**
961
1014
  * Returns the value for an item in this variant.
962
1015
  *
@@ -1019,21 +1072,21 @@ declare namespace sap {
1019
1072
  }
1020
1073
  /**
1021
1074
  * The personalization variant set contains variants of personalization data. It is used in the personalization
1022
- * container mode.
1075
+ * container mode. A VariantSet is a class representing a collection of Variants (identified by a key and
1076
+ * name) and a member variable indicating the "current variable"
1077
+ *
1078
+ * When manipulating the underlying data, additional constraints are enforced.
1079
+ *
1080
+ * To be called by the personalization container.
1023
1081
  *
1024
1082
  * @since 1.22.0
1025
1083
  * @deprecated (since 1.120) - Please use {@link sap.ushell.services.PersonalizationV2.VariantSet} instead
1026
1084
  */
1027
1085
  class VariantSet {
1028
1086
  /**
1029
- * A VariantSet is a class representing a collection of Variants (identified by a key and name) and a member
1030
- * variable indicating the "current variable"
1031
- *
1032
- * When manipulating the underlying data, additional constraints are enforced.
1033
- *
1034
- * To be called by the personalization container.
1087
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1035
1088
  */
1036
- constructor();
1089
+ protected constructor();
1037
1090
 
1038
1091
  /**
1039
1092
  * Creates a new variant in the variant set. In case a variant with this name is already existing an exception
@@ -1116,7 +1169,7 @@ declare namespace sap {
1116
1169
  *
1117
1170
  * @returns variant keys
1118
1171
  */
1119
- getVariantKeys(): any[];
1172
+ getVariantKeys(): string[];
1120
1173
  /**
1121
1174
  * Sets the current variant key.
1122
1175
  *
@@ -1220,7 +1273,7 @@ declare namespace sap {
1220
1273
  *
1221
1274
  * @returns variant set keys
1222
1275
  */
1223
- getVariantSetKeys(): any[];
1276
+ getVariantSetKeys(): string[];
1224
1277
  }
1225
1278
  }
1226
1279
 
@@ -1228,13 +1281,15 @@ declare namespace sap {
1228
1281
  /**
1229
1282
  * The container is the anchor object of the unified shell personalization in container mode.
1230
1283
  *
1284
+ * To be called by the personalization service getContainer method.
1285
+ *
1231
1286
  * @since 1.120.0
1232
1287
  */
1233
1288
  class ContextContainer {
1234
1289
  /**
1235
- * To be called by the personalization service getContainer method.
1290
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1236
1291
  */
1237
- constructor();
1292
+ protected constructor();
1238
1293
 
1239
1294
  /**
1240
1295
  * clears the local copy data of this container
@@ -1271,7 +1326,7 @@ declare namespace sap {
1271
1326
  *
1272
1327
  * @since 1.120.0
1273
1328
  *
1274
- * @returns promise
1329
+ * @returns Resolves once the pending requests were flushed.
1275
1330
  */
1276
1331
  flushPendingRequests(): Promise<any>;
1277
1332
  /**
@@ -1319,8 +1374,8 @@ declare namespace sap {
1319
1374
  */
1320
1375
  load(): Promise<undefined>;
1321
1376
  /**
1322
- * * todo: jsdoc Save the current container data at the underlying storage asynchronously at the earlies
1323
- * nDelayInMilliseconds seconds before. The current state is serialized.
1377
+ * Save the current container data at the underlying storage asynchronously at the earlies nDelayInMilliseconds
1378
+ * seconds before. The current state is serialized.
1324
1379
  *
1325
1380
  * @since 1.120.0
1326
1381
  *
@@ -1351,13 +1406,15 @@ declare namespace sap {
1351
1406
  * The Unified Shell personalizer providing set get delete methods to access the persisted personalization
1352
1407
  * data in direct mode.
1353
1408
  *
1409
+ * To be called by the personalization service getPersonalizer method.
1410
+ *
1354
1411
  * @since 1.120.0
1355
1412
  */
1356
1413
  class Personalizer {
1357
1414
  /**
1358
- * To be called by the personalization service getPersonalizer method.
1415
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1359
1416
  */
1360
- constructor();
1417
+ protected constructor();
1361
1418
 
1362
1419
  /**
1363
1420
  * Deletes a personalization data value.
@@ -1396,7 +1453,10 @@ declare namespace sap {
1396
1453
  * @since 1.120.0
1397
1454
  */
1398
1455
  class TransientPersonalizer {
1399
- constructor();
1456
+ /**
1457
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1458
+ */
1459
+ protected constructor();
1400
1460
 
1401
1461
  /**
1402
1462
  * Deletes a personalization data value.
@@ -1432,13 +1492,15 @@ declare namespace sap {
1432
1492
  * The personalization variant contains personalization data. It is used in the personalization container
1433
1493
  * mode.
1434
1494
  *
1495
+ * To be instantiated via Personalization.VariantSet add / get Variant only
1496
+ *
1435
1497
  * @since 1.120.0
1436
1498
  */
1437
1499
  class Variant {
1438
1500
  /**
1439
- * To be instantiated via PersonalizationV2.VariantSet add / get Variant only
1501
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1440
1502
  */
1441
- constructor();
1503
+ protected constructor();
1442
1504
 
1443
1505
  /**
1444
1506
  * Checks if a specific item is contained in this variant.
@@ -1533,20 +1595,19 @@ declare namespace sap {
1533
1595
  ): void;
1534
1596
  }
1535
1597
  /**
1598
+ * A VariantSet is a class representing a collection of Variants (identified by a key and name) and a member
1599
+ * variable indicating the "current variable"
1600
+ *
1601
+ * When manipulating the underlying data, additional constraints are enforced.
1602
+ *
1536
1603
  * The personalization variant set contains variants of personalization data. It is used in the personalization
1537
1604
  * container mode.
1538
1605
  *
1606
+ * To be called by the personalization container
1607
+ *
1539
1608
  * @since 1.120.0
1540
1609
  */
1541
1610
  class VariantSet {
1542
- /**
1543
- * A VariantSet is a class representing a collection of Variants (identified by a key and name) and a member
1544
- * variable indicating the "current variable"
1545
- *
1546
- * When manipulating the underlying data, additional constraints are enforced.
1547
- *
1548
- * To be called by the personalization container.
1549
- */
1550
1611
  constructor();
1551
1612
 
1552
1613
  /**
@@ -1651,18 +1712,17 @@ declare namespace sap {
1651
1712
  * ```
1652
1713
  *
1653
1714
  *
1715
+ * VariantSetAdapter amends ContextContainer with functionality to
1716
+ *
1717
+ * Example: An application has two types of variants. Variant type 1 contains filter values for a query,
1718
+ * which are stored in item 1 of the variant, and personalization data for a table, which are stored in
1719
+ * item 2 of the variant. Variant type 2 contains a setting (item 3) that is independent of the filtering
1720
+ * and the table settings. It might be used for a different screen than the variants of type 1. In this
1721
+ * example you would have 2 variant sets, one for each variant type.
1722
+ *
1654
1723
  * @since 1.120.0
1655
1724
  */
1656
1725
  class VariantSetAdapter {
1657
- /**
1658
- * VariantSetAdapter amends ContextContainer with functionality to
1659
- *
1660
- * Example: An application has two types of variants. Variant type 1 contains filter values for a query,
1661
- * which are stored in item 1 of the variant, and personalization data for a table, which are stored in
1662
- * item 2 of the variant. Variant type 2 contains a setting (item 3) that is independent of the filtering
1663
- * and the table settings. It might be used for a different screen than the variants of type 1. In this
1664
- * example you would have 2 variant sets, one for each variant type.
1665
- */
1666
1726
  constructor(
1667
1727
  /**
1668
1728
  * Context
@@ -1774,18 +1834,12 @@ declare namespace sap {
1774
1834
  shared?: boolean;
1775
1835
  };
1776
1836
  }
1777
-
1778
1837
  /**
1779
- * The unified shell's AppConfiguration service.
1838
+ * The unified shell's AppConfiguration service as a singleton object.
1780
1839
  *
1781
1840
  * @since 1.15.0
1782
1841
  */
1783
- class AppConfiguration {
1784
- /**
1785
- * The Unified Shell App configuration service as a singleton object.
1786
- */
1787
- constructor();
1788
-
1842
+ interface AppConfiguration {
1789
1843
  /**
1790
1844
  * Sets the application screen size to full width
1791
1845
  *
@@ -1799,16 +1853,74 @@ declare namespace sap {
1799
1853
  bValue: boolean
1800
1854
  ): void;
1801
1855
  }
1856
+
1857
+ /**
1858
+ * @since 1.62.0
1859
+ * @deprecated
1860
+ * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1861
+ */
1862
+ interface ContentExtensionAdapterFactory {
1863
+ /**
1864
+ * Constructs a new instance of the Content Extension Adapter Factory. An array of adapter configurations
1865
+ * needs to be passed to it (one specific adapter for each extended content). The configuration can be passed
1866
+ * explicitly as an array vConfig or coded in ContentExtensionAdapterConfig.
1867
+ *
1868
+ * Once instantiated, it generates a map of all the needed adapters and returns them (as a promise) with
1869
+ * the method #getAdapterMap. Once the Promises resolve, the adapters are available in the map.
1870
+ *
1871
+ * IMPORTANT: aConfig.contentProviderName is the string any content would use to indicate the LaunchPage
1872
+ * service which adapter needs to be used through a field "contentProvider" e.g. oGroup.contentProvider
1873
+ *
1874
+ * Currently, the configuration mocks the content through FeatureGroupConfig and uses the local adapter.
1875
+ * This should be changed once a dedicated adapter for the extended content exists.
1876
+ *
1877
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1878
+ *
1879
+ * @returns A promise that resolves to a map of content provider names to adapter instances Note that the
1880
+ * map might contain undefined entries if the adapters are disabled.
1881
+ */
1882
+ getAdapters(
1883
+ /**
1884
+ * A configuration array for the different adapters of ContentExtensionAdapterFactory.
1885
+ */
1886
+ vConfigs: Array<{
1887
+ /**
1888
+ * The name of the adapter to find it in the service
1889
+ */
1890
+ contentProviderName: string;
1891
+ /**
1892
+ * The path to the adapter
1893
+ */
1894
+ adapter: string;
1895
+ /**
1896
+ * The path to the configuration flag for this adapter
1897
+ */
1898
+ config: string;
1899
+ /**
1900
+ * A system object for creating the system when instantiating the adapter
1901
+ */
1902
+ system: object;
1903
+ /**
1904
+ * A function that returns any needed configuration for the adapter
1905
+ */
1906
+ configHandler: Function;
1907
+ }>
1908
+ ): Promise<object>;
1909
+ }
1910
+
1802
1911
  /**
1803
1912
  * The Unified Shell's AppLifeCycle service.
1804
1913
  *
1805
1914
  * **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("AppLifeCycle")`.
1806
- * For details, see {@link sap.ushell.services.Container#getServiceAsync}.
1915
+ * For details, see {@link sap.ushell.Container#getServiceAsync}.
1807
1916
  *
1808
1917
  * @since 1.38
1809
1918
  */
1810
- class AppLifeCycle {
1811
- constructor();
1919
+ class AppLifeCycle extends sap.ushell.services.Service {
1920
+ /**
1921
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1922
+ */
1923
+ protected constructor();
1812
1924
 
1813
1925
  /**
1814
1926
  * Attaches an event handler for the appLoaded event. This event handler will be triggered each time an
@@ -1850,9 +1962,6 @@ declare namespace sap {
1850
1962
  *
1851
1963
  * The function returns an object with following parameters:
1852
1964
  * - applicationType: “UI5|WDA|NWBC|URL|TR”
1853
- * - applicationFramework: when applicationType is "URL", this parameter indicates which application
1854
- * framework is running inside the iframe - “UI5|WDA|GUI|CRM”. This attribute is for SAP internal usage
1855
- * only.
1856
1965
  * - componentInstance: reference to component (only for applicationType "UI5").
1857
1966
  * - homePage: `true` when root intent (normally #Shell-home) or Appfinder (#Shell-appfinder) is currently
1858
1967
  * displayed.
@@ -1891,13 +2000,16 @@ declare namespace sap {
1891
2000
  * The Unified Shell's bookmark service. Allows creating shortcuts on the user's home page.
1892
2001
  *
1893
2002
  * **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("Bookmark")`.
1894
- * For details, see {@link sap.ushell.services.Container#getServiceAsync}.
2003
+ * For details, see {@link sap.ushell.Container#getServiceAsync}.
1895
2004
  *
1896
2005
  * @since 1.15.0
1897
2006
  * @deprecated (since 1.119) - Please use {@link sap.ushell.services.BookmarkV2} instead.
1898
2007
  */
1899
- class Bookmark {
1900
- constructor();
2008
+ class Bookmark extends sap.ushell.services.Service {
2009
+ /**
2010
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2011
+ */
2012
+ protected constructor();
1901
2013
 
1902
2014
  /**
1903
2015
  * Adds a bookmark tile to one of the user's classic home page groups or to multiple provided content nodes.
@@ -1907,8 +2019,8 @@ declare namespace sap {
1907
2019
  * @since 1.15.0
1908
2020
  * @deprecated (since 1.119) - Please use {@link sap.ushell.services.BookmarkV2#addBookmark} instead.
1909
2021
  *
1910
- * @returns A `jQuery.Promise` which resolves on success, but rejects with a reason-message on failure to
1911
- * add the bookmark to the specified or implied group. The promise gets resolved if personalization is disabled.
2022
+ * @returns Resolves on success, but rejects with a reason-message on failure to add the bookmark to the
2023
+ * specified or implied group. The promise gets resolved if personalization is disabled.
1912
2024
  */
1913
2025
  addBookmark(
1914
2026
  /**
@@ -2020,9 +2132,8 @@ declare namespace sap {
2020
2132
  * @since 1.21.2
2021
2133
  * @deprecated (since 1.112) - Please use {@link sap.ushell.services.BookmarkV2#addBookmark} instead.
2022
2134
  *
2023
- * @returns A `jQuery.Promise` which informs about success or failure of this asynchronous operation. In
2024
- * case of success, no further details are passed. In case of failure, an error message is passed. In launchpad
2025
- * spaces mode the promise gets rejected.
2135
+ * @returns Resolves if successful. In case of failure, an error message is passed. In launchpad spaces
2136
+ * mode the promise gets rejected.
2026
2137
  */
2027
2138
  addCatalogTileToGroup(
2028
2139
  /**
@@ -2057,8 +2168,7 @@ declare namespace sap {
2057
2168
  * @since 1.17.1
2058
2169
  * @deprecated (since 1.119) - Please use {@link sap.ushell.services.BookmarkV2#countBookmarks} instead.
2059
2170
  *
2060
- * @returns A `jQuery.Promise` which informs about success or failure of this asynchronous operation. In
2061
- * case of success, the count of existing bookmarks is provided (which might be zero). In case of failure,
2171
+ * @returns Resolves the count of existing bookmarks is provided (which might be zero). In case of failure,
2062
2172
  * an error message is passed.
2063
2173
  */
2064
2174
  countBookmarks(
@@ -2080,8 +2190,7 @@ declare namespace sap {
2080
2190
  * @since 1.17.1
2081
2191
  * @deprecated (since 1.119) - Please use {@link sap.ushell.services.BookmarkV2#deleteBookmarks} instead.
2082
2192
  *
2083
- * @returns A `jQuery.Promise` which informs about success or failure of this asynchronous operation. In
2084
- * case of success, the number of deleted bookmarks is provided (which might be zero). In case of failure,
2193
+ * @returns Resolves the number of deleted bookmarks is provided (which might be zero). In case of failure,
2085
2194
  * an error message is passed.
2086
2195
  */
2087
2196
  deleteBookmarks(
@@ -2127,8 +2236,7 @@ declare namespace sap {
2127
2236
  * @since 1.17.1
2128
2237
  * @deprecated (since 1.119) - Please use {@link sap.ushell.services.BookmarkV2#updateBookmarks} instead.
2129
2238
  *
2130
- * @returns A `jQuery.Promise` which informs about success or failure of this asynchronous operation. In
2131
- * case of success, the number of updated bookmarks is provided (which might be zero). In case of failure,
2239
+ * @returns Resolves the number of updated bookmarks is provided (which might be zero). In case of failure,
2132
2240
  * an error message is passed.
2133
2241
  */
2134
2242
  updateBookmarks(
@@ -2206,22 +2314,25 @@ declare namespace sap {
2206
2314
  * The Unified Shell's bookmark service. Allows creating shortcuts on the user's home page.
2207
2315
  *
2208
2316
  * **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("BookmarkV2")`.
2209
- * For details, see {@link sap.ushell.services.Container#getServiceAsync}.
2317
+ * For details, see {@link sap.ushell.Container#getServiceAsync}.
2210
2318
  *
2211
2319
  * @since 1.119.0
2212
2320
  */
2213
- class BookmarkV2 {
2214
- constructor();
2321
+ class BookmarkV2 extends sap.ushell.services.Service {
2322
+ /**
2323
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2324
+ */
2325
+ protected constructor();
2215
2326
 
2216
2327
  /**
2217
- * Adds a bookmark tile to one of the user's classic home page groups or to multiple provided content nodes.
2328
+ * Adds a bookmark tile to the provided content nodes.
2218
2329
  * See:
2219
2330
  * sap.ushell.services.URLParsing#getShellHash
2220
2331
  *
2221
2332
  * @since 1.119.0
2222
2333
  *
2223
2334
  * @returns A `Promise` which resolves on success, but rejects with a reason-message on failure to add the
2224
- * bookmark to the specified or implied group. The promise gets resolved if personalization is disabled.
2335
+ * bookmark to the specified or implied content node. The promise gets resolved if personalization is disabled.
2225
2336
  */
2226
2337
  addBookmark(
2227
2338
  /**
@@ -2313,16 +2424,14 @@ declare namespace sap {
2313
2424
  numberUnit?: string;
2314
2425
  },
2315
2426
  /**
2316
- * Either a legacy launchpad home page group, one content node or an array of content nodes (see {@link #getContentNodes}).
2317
- * If not provided, the bookmark will be added to the default group if spaces mode is not active or to the
2318
- * default page if spaces mode is active.
2427
+ * Either a content node or an array of content nodes (see {@link #getContentNodes}). If not provided, the
2428
+ * bookmark will be added to the default page.
2319
2429
  */
2320
2430
  vContainer?:
2321
- | object
2322
2431
  | sap.ushell.services.BookmarkV2.ContentNode
2323
2432
  | sap.ushell.services.BookmarkV2.ContentNode[],
2324
2433
  /**
2325
- * The contentProviderId or undefined outside the cFLP
2434
+ * **SAP internal usage only** The contentProviderId or undefined outside the cFLP.
2326
2435
  */
2327
2436
  sContentProviderId?: string
2328
2437
  ): Promise<any>;
@@ -2372,20 +2481,7 @@ declare namespace sap {
2372
2481
  sContentProviderId?: string
2373
2482
  ): Promise<any>;
2374
2483
  /**
2375
- * Returns available content nodes based on the current launchpad context. (Classic home page, spaces mode)
2376
- *
2377
- * A content node may be:
2378
- * - a classic home page group
2379
- * - an unselectable node (space) or a selectable node (page) in spaces mode
2380
- * - or any other containers in the future
2381
- *
2382
- * It has the following properties:
2383
- * - id: ID of the content node
2384
- * - label: Human-readable representation of a content node which can be displayed in a control
2385
- * - type: Specifies the content node type. E.g: space, page, group, etc. See {@link sap.ushell.ContentNodeType }
2386
- *
2387
- * - isContainer: Specifies if a bookmark can be added
2388
- * - children: Specifies sub-nodes
2484
+ * Returns available content nodes.
2389
2485
  *
2390
2486
  * @since 1.119.0
2391
2487
  *
@@ -2484,26 +2580,70 @@ declare namespace sap {
2484
2580
  * and their value changes.
2485
2581
  *
2486
2582
  * **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("Configuration")`.
2487
- * For details, see {@link sap.ushell.services.Container#getServiceAsync}.
2583
+ * For details, see {@link sap.ushell.Container#getServiceAsync}.
2488
2584
  *
2489
2585
  * @since 1.64.0
2490
2586
  */
2491
- class Configuration {
2492
- constructor();
2587
+ class Configuration extends sap.ushell.services.Service {
2588
+ /**
2589
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2590
+ */
2591
+ protected constructor();
2592
+
2593
+ /**
2594
+ * Allows to attach to any value change of the sizeBehavior configuration for homepage parts (smaller tile
2595
+ * size) which is needed to implement custom tiles reacting on this setting. The returned value can directly
2596
+ * be used in {@link sap.m.GenericTile#sizeBehavior}.
2597
+ *
2598
+ * Once attached, `fnCallback` will be called once initially for the **current value** and afterwards every
2599
+ * time the value changed.
2600
+ *
2601
+ * Please ensure to detach from the registry by calling `.detach` on the returned object e.g. in the destroy
2602
+ * function of your component or controller! Make sure that you do not attach twice with the same function
2603
+ * as otherwise a detach cannot be performed later!
2604
+ *
2605
+ * Example usage:
2606
+ * ```javascript
2607
+ *
2608
+ * var oEventRegistry;
2609
+ *
2610
+ * // the callback that is called whenever the property changes
2611
+ * var fnCallback = function (sSizeBehavior) {
2612
+ * // do something with sSizeBehavior like setting it on a
2613
+ * // sap.m.GenericTile via model and data binding!
2614
+ * };
2615
+ *
2616
+ *
2617
+ * // retrieve service via getServiceAsync API
2618
+ * sap.ushell.Container.getServiceAsync("Configuration").then( function (oService) {
2619
+ * // keep the returned event registry in order to detach upon destroy of your context
2620
+ * oEventRegistry = oService.attachSizeBehaviorUpdate(fnCallback);
2621
+ * });
2622
+ *
2623
+ * // detach later when your context is destroyed (e.g. destroy of the controller)
2624
+ * oEventRegistry.detach();
2625
+ * ```
2626
+ *
2627
+ *
2628
+ *
2629
+ * @returns detach handler - call detach() to detach from further updates
2630
+ */
2631
+ attachSizeBehaviorUpdate(
2632
+ /**
2633
+ * The function to be called once the property changes. It receives a parameter of type {@link sap.m.TileSizeBehavior}.
2634
+ */
2635
+ fnCallback: Function
2636
+ ): {
2637
+ detach: Function;
2638
+ };
2493
2639
  }
2494
2640
  /**
2495
2641
  * The Unified Shell's CrossApplicationNavigation service. Allows navigating to "external" targets outside
2496
2642
  * of the currently running app (but still in scope of the current Fiori launchpad) or to create links to
2497
2643
  * such external targets.
2498
2644
  *
2499
- * To use the CrossApplicationNavigation service you can retrieve an instance via ushell's Container:
2500
- * ```javascript
2501
- *
2502
- * sap.ushell.Container.getServiceAsync("CrossApplicationNavigation").then(function (CrossApplicationNavigationService) {
2503
- * // Use the CrossApplicationNavigation service
2504
- * });
2505
- * ```
2506
- *
2645
+ * **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("ClientSideTargetResolution")`.
2646
+ * For details, see {@link sap.ushell.Container#getServiceAsync}.
2507
2647
  *
2508
2648
  * The CrossApplicationNavigation service currently provides platform independent functionality.
2509
2649
  *
@@ -2555,8 +2695,11 @@ declare namespace sap {
2555
2695
  * @since 1.15.0
2556
2696
  * @deprecated (since 1.120) - Please use {@link sap.ushell.services.Navigation} instead
2557
2697
  */
2558
- class CrossApplicationNavigation {
2559
- constructor();
2698
+ class CrossApplicationNavigation extends sap.ushell.services.Service {
2699
+ /**
2700
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2701
+ */
2702
+ protected constructor();
2560
2703
 
2561
2704
  /**
2562
2705
  * Attempts to use the browser history to navigate to the previous app.
@@ -2577,7 +2720,7 @@ declare namespace sap {
2577
2720
  * it into a long url with all parameters expanded
2578
2721
  *
2579
2722
  *
2580
- * @returns promise the success handler of the resolve promise get an expanded shell hash as first argument
2723
+ * @returns Resolves the expanded shell hash as first argument.
2581
2724
  */
2582
2725
  expandCompactHash(
2583
2726
  /**
@@ -2590,10 +2733,10 @@ declare namespace sap {
2590
2733
  *
2591
2734
  * @since 1.38.0
2592
2735
  *
2593
- * @returns A promise that resolves with an array of strings representing the semantic objects of the intents
2594
- * the current user can navigate to, or rejects with an error message. The returned array will not contain
2595
- * duplicates. NOTE: the caller should not rely on the specific order the semantic objects appear in
2596
- * the returned array.
2736
+ * @returns Resolves with an array of strings representing the semantic objects of the intents the current
2737
+ * user can navigate to, or rejects with an error message. The returned array will not contain duplicates.
2738
+ * NOTE: the caller should not rely on the specific order the semantic objects appear in the returned
2739
+ * array.
2597
2740
  */
2598
2741
  getDistinctSemanticObjects(): jQuery.Promise;
2599
2742
  /**
@@ -2602,8 +2745,7 @@ declare namespace sap {
2602
2745
  *
2603
2746
  * @since 1.38.0
2604
2747
  *
2605
- * @returns A promise that resolves with an array of link objects containing (at least) the following properties:
2606
- *
2748
+ * @returns Resolves with an array of link objects containing (at least) the following properties:
2607
2749
  * ```javascript
2608
2750
  *
2609
2751
  * {
@@ -2845,8 +2987,7 @@ declare namespace sap {
2845
2987
  *
2846
2988
  * @since 1.48
2847
2989
  *
2848
- * @returns When a relevant link object exists, it will return a promise that resolves to an object of the
2849
- * following form:
2990
+ * @returns Resolves to an object of the following form when a relevant link object exists:
2850
2991
  * ```javascript
2851
2992
  *
2852
2993
  * {
@@ -2868,7 +3009,7 @@ declare namespace sap {
2868
3009
  * @see sap.ushell.services.CrossApplicationNavigation#getSemanticObjectLinks for description.
2869
3010
  */
2870
3011
  mParameters?: object
2871
- ): jQuery.Deferred;
3012
+ ): jQuery.Promise;
2872
3013
  /**
2873
3014
  * Resolves a given semantic object and business parameters to a list of links, taking into account the
2874
3015
  * form factor of the current device.
@@ -2876,8 +3017,7 @@ declare namespace sap {
2876
3017
  * @since 1.19.0
2877
3018
  * @deprecated (since 1.38) - Please use {@link #getLinks} instead.
2878
3019
  *
2879
- * @returns A `jQuery.Deferred` object's promise which is resolved with an array of link objects containing
2880
- * (at least) the following properties:
3020
+ * @returns Resolves with an array of link objects containing (at least) the following properties:
2881
3021
  * ```javascript
2882
3022
  *
2883
3023
  * {
@@ -3269,8 +3409,8 @@ declare namespace sap {
3269
3409
  * @deprecated (since 1.31) - Please use {@link #isNavigationSupported} instead. Note that this has a slightly
3270
3410
  * different response format.
3271
3411
  *
3272
- * @returns A `jQuery.Deferred` object's promise which is resolved with a map containing the intents from
3273
- * `aIntents` as keys. The map values are objects with a property `supported` of type `boolean`.
3412
+ * @returns Resolves with a map containing the intents from `aIntents` as keys. The map values are objects
3413
+ * with a property `supported` of type `boolean`.
3274
3414
  * Example:
3275
3415
  * ```javascript
3276
3416
  *
@@ -3322,8 +3462,8 @@ declare namespace sap {
3322
3462
  *
3323
3463
  * @since 1.32
3324
3464
  *
3325
- * @returns Promise of a `jQuery.Deferred` object that resolves to an array of objects indicating whether
3326
- * the intent is supported or not. Each object has a property `supported` of type `boolean`.
3465
+ * @returns Resolves to an array of objects indicating whether the intent is supported or not. Each object
3466
+ * has a property `supported` of type `boolean`.
3327
3467
  *
3328
3468
  * Example:
3329
3469
  *
@@ -3432,7 +3572,7 @@ declare namespace sap {
3432
3572
  *
3433
3573
  * @ui5-protected Do not call from applications (only from related classes in the framework)
3434
3574
  *
3435
- * @returns A jQuery.Promise.
3575
+ * @returns Resolves the intent.
3436
3576
  */
3437
3577
  resolveIntent(
3438
3578
  /**
@@ -3559,17 +3699,17 @@ declare namespace sap {
3559
3699
  * The Unified Shell's end user feedback service. This service is deprecated and does nothing. End user
3560
3700
  * feedback functionality is not part of the ushell library.
3561
3701
  *
3702
+ * **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("DarkModeSupport")`.
3703
+ * For details, see {@link sap.ushell.Container#getServiceAsync}.
3704
+ *
3562
3705
  * @since 1.25.1
3563
3706
  * @deprecated (since 1.93)
3564
3707
  */
3565
- class EndUserFeedback {
3708
+ class EndUserFeedback extends sap.ushell.services.Service {
3566
3709
  /**
3567
- * This method MUST be called by the Unified Shell's container only, others MUST call `sap.ushell.Container.getServiceAsync("EndUserFeedback").then(function
3568
- * (EndUserFeedback) {});`. Constructs a new instance of the end user feedback service.
3569
- * See:
3570
- * sap.ushell.services.Container#getServiceAsync
3710
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
3571
3711
  */
3572
- constructor();
3712
+ protected constructor();
3573
3713
 
3574
3714
  /**
3575
3715
  * @since 1.25.1
@@ -3584,9 +3724,9 @@ declare namespace sap {
3584
3724
  * @since 1.25.1
3585
3725
  * @deprecated (since 1.93)
3586
3726
  *
3587
- * @returns Rejected promise
3727
+ * @returns Rejected promise.
3588
3728
  */
3589
- isEnabled(): object;
3729
+ isEnabled(): Promise<any>;
3590
3730
  /**
3591
3731
  * Sends a feedback.
3592
3732
  *
@@ -3601,7 +3741,7 @@ declare namespace sap {
3601
3741
  * The Unified Shell's Extension service. Allows adding extensions on the user's home page.
3602
3742
  *
3603
3743
  * **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("Extension")`.
3604
- * For details, see {@link sap.ushell.services.Container#getServiceAsync}.
3744
+ * For details, see {@link sap.ushell.Container#getServiceAsync}.
3605
3745
  *
3606
3746
  *
3607
3747
  * All extension items and extension areas are instantiated as invisible. You have to call .show<...> to
@@ -3610,8 +3750,11 @@ declare namespace sap {
3610
3750
  * @since 1.120.0
3611
3751
  * @experimental (since 1.120.0) - Restriction: API calls might be ignored for apps running in an iframe
3612
3752
  */
3613
- class Extension {
3614
- constructor();
3753
+ class Extension extends sap.ushell.services.Service {
3754
+ /**
3755
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
3756
+ */
3757
+ protected constructor();
3615
3758
 
3616
3759
  /**
3617
3760
  * Adds an entry to the user settings dialog box including the UI control that appears when the user clicks
@@ -3639,18 +3782,18 @@ declare namespace sap {
3639
3782
  /**
3640
3783
  * A string to be presented as the sub title of the entry OR a function which resolves the sub title.
3641
3784
  */
3642
- value: string | Function;
3785
+ value: string | (() => Promise<string>);
3643
3786
  /**
3644
3787
  * A function that resolves the content which has to be a {@link sap.ui.core.Control}. A SAPUI5 view instance
3645
3788
  * can also be returned. The result will be displayed in the settings as content for this entry.
3646
3789
  */
3647
- content: Function;
3790
+ content: () => Promise<sap.ui.core.Control>;
3648
3791
  /**
3649
3792
  * A callback which is called when the user clicks "save" in the user settings dialog. The function has
3650
3793
  * to return a native promise. If an error occurs, pass the error message via rejected promise. Errors are
3651
3794
  * displayed in the common log.
3652
3795
  */
3653
- onSave: Function;
3796
+ onSave: () => Promise<any>;
3654
3797
  /**
3655
3798
  * A callback which is called when the user closes the user settings dialog without saving any changes.
3656
3799
  */
@@ -3777,6 +3920,9 @@ declare namespace sap {
3777
3920
  /**
3778
3921
  * A service for handling groups, tiles and catalogs.
3779
3922
  *
3923
+ * **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("Extension")`.
3924
+ * For details, see {@link sap.ushell.Container#getServiceAsync}.
3925
+ *
3780
3926
  * The functions that return the main objects are getGroups, getGroupTitle, getCatalogs and getCatalogTiles.
3781
3927
  * Since the implementation (i.e. adapter) is platform specific, do not call or access properties and functions
3782
3928
  * of returned objects. Instead, use other functions of the LaunchPage service with the relevant object
@@ -3788,53 +3934,37 @@ declare namespace sap {
3788
3934
  * @since 1.15.0
3789
3935
  * @deprecated (since 1.99) - This service has been deprecated as it only works for the classic homepage.
3790
3936
  */
3791
- class LaunchPage {
3937
+ class LaunchPage extends sap.ushell.services.Service {
3792
3938
  /**
3793
- * This method MUST be called by the Unified Shell's container only, others MUST call `sap.ushell.Container.getServiceAsync("LaunchPage").then(function
3794
- * (LaunchPage) {});`. Constructs a new instance of the page builder service.
3795
- * See:
3796
- * sap.ushell.services.Container#getServiceAsync
3939
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
3797
3940
  */
3798
- constructor(
3799
- /**
3800
- * the page builder adapter for the logon system
3801
- */
3802
- oAdapter: object,
3803
- /**
3804
- * the interface provided by the container
3805
- */
3806
- oContainerInterface: object
3807
- );
3941
+ protected constructor();
3808
3942
 
3809
3943
  /**
3810
3944
  * Adds a new group.
3811
3945
  *
3812
- * In case of success, the `done` function gets the new added group object. Intention: the page builder
3813
- * adds this group to the end of the home screen.
3946
+ * Intention: the page builder adds this group to the end of the home screen.
3814
3947
  *
3815
- * In case of failure, the `fail` function returns the consistent (i.e. persisted) backend state of all
3816
- * groups.
3948
+ * In case of failure it gets the consistent (i.e. persisted) backend state of all groups.
3817
3949
  *
3818
3950
  *
3819
- * @returns jQuery.promise object
3951
+ * @returns Resolves once the group was added.
3820
3952
  */
3821
3953
  addGroup(
3822
3954
  /**
3823
3955
  * The title of the new group
3824
3956
  */
3825
3957
  sTitle: string
3826
- ): object;
3958
+ ): jQuery.Promise;
3827
3959
  /**
3828
3960
  * Adds a new group at a specific location.
3829
3961
  *
3830
- * In case of success, the `done` function gets the new added group object. Intention: the page builder
3831
- * adds this group to the specific location on the home screen.
3962
+ * Intention: the page builder adds this group to the specific location on the home screen.
3832
3963
  *
3833
- * In case of failure, the `fail` function returns the consistent (i.e. persisted) backend state of all
3834
- * groups.
3964
+ * In case of error it gets the consistent (i.e. persisted) backend state of all groups.
3835
3965
  *
3836
3966
  *
3837
- * @returns jQuery.promise object
3967
+ * @returns Resolves the group.
3838
3968
  */
3839
3969
  addGroupAt(
3840
3970
  /**
@@ -3845,18 +3975,17 @@ declare namespace sap {
3845
3975
  * the location of the new group
3846
3976
  */
3847
3977
  iIndex: int
3848
- ): object;
3978
+ ): jQuery.Promise;
3849
3979
  /**
3850
3980
  * Adds a tile to a group.
3851
3981
  *
3852
3982
  * If no group is provided then the tile is added to the default group.
3853
3983
  *
3854
- * In case of success, the `done` function returns the new tile. Intention: the page builder by default
3855
- * puts this tile at the end of the default group. In case of failure, the `fail` function should return
3856
- * the consistent (i.e. persisted) backend state of the default group.
3984
+ * Intention: the page builder by default puts this tile at the end of the default group. In case of failure
3985
+ * it gets the consistent (i.e. persisted) backend state of the default group.
3857
3986
  *
3858
3987
  *
3859
- * @returns jQuery.promise object
3988
+ * @returns Resolves once the tile was added.
3860
3989
  */
3861
3990
  addTile(
3862
3991
  /**
@@ -3867,7 +3996,7 @@ declare namespace sap {
3867
3996
  * The target group
3868
3997
  */
3869
3998
  oGroup?: object
3870
- ): object;
3999
+ ): jQuery.Promise;
3871
4000
  /**
3872
4001
  * Returns the press handler for clicking on a tile.
3873
4002
  *
@@ -3931,11 +4060,23 @@ declare namespace sap {
3931
4060
  * you the same possibilities as attaching a `done` handler, but with the advantage of improved responsiveness.
3932
4061
  *
3933
4062
  *
3934
- * @returns `jQuery.Deferred` object's promise In case of success, an array of black-box catalog objects
3935
- * is provided (which might be empty). In case of failure, an error message is passed. Progress notifications
3936
- * are sent for each single catalog, providing a single black-box catalog object each time.
4063
+ * @returns Resolves an array of black-box catalog objects is provided (which might be empty). In case of
4064
+ * failure, an error message is passed. Progress notifications are sent for each single catalog, providing
4065
+ * a single black-box catalog object each time.
3937
4066
  */
3938
- getCatalogs(): object;
4067
+ getCatalogs(): jQuery.Promise;
4068
+ /**
4069
+ * Returns catalog tile's content provider ID.
4070
+ *
4071
+ *
4072
+ * @returns Tile content provider ID
4073
+ */
4074
+ getCatalogTileContentProviderId(
4075
+ /**
4076
+ * The tile or the catalog tile
4077
+ */
4078
+ oTile: object
4079
+ ): string;
3939
4080
  /**
3940
4081
  * Returns catalog tile's unique identifier. This function may be called for a catalog tile or (since 1.21.0)
3941
4082
  * for a group tile. In the latter case, the function returns the unique identifier of the catalog tile
@@ -3978,6 +4119,19 @@ declare namespace sap {
3978
4119
  */
3979
4120
  oCatalogTile: object
3980
4121
  ): string;
4122
+ /**
4123
+ * Returns the catalog tile info
4124
+ *
4125
+ * @since 1.67.0
4126
+ *
4127
+ * @returns The catalog tile info
4128
+ */
4129
+ getCatalogTilePreviewInfo(
4130
+ /**
4131
+ * The catalog tile
4132
+ */
4133
+ oCatalogTile: object
4134
+ ): string;
3981
4135
  /**
3982
4136
  * Returns preview subtitle for a catalog tile.
3983
4137
  *
@@ -4006,18 +4160,17 @@ declare namespace sap {
4006
4160
  oCatalogTile: object
4007
4161
  ): string;
4008
4162
  /**
4009
- * Returns the tiles of a catalog. In case of success, the `done` function of the returned promise object
4010
- * gets an array of 'anonymous' tiles of the catalog.
4163
+ * Returns the tiles of a catalog.
4011
4164
  *
4012
4165
  *
4013
- * @returns jQuery.promise object.
4166
+ * @returns Resolve the catalog tiles.
4014
4167
  */
4015
4168
  getCatalogTiles(
4016
4169
  /**
4017
4170
  * The catalog
4018
4171
  */
4019
4172
  oCatalog: object
4020
- ): object;
4173
+ ): jQuery.Promise;
4021
4174
  /**
4022
4175
  * Returns the size of a catalog tile as a string. For example: "1x1", "1x2"
4023
4176
  *
@@ -4070,11 +4223,10 @@ declare namespace sap {
4070
4223
  oCatalogTile: object
4071
4224
  ): string[];
4072
4225
  /**
4073
- * Returns the catalog tile info
4226
+ * Returns the catalog tile's title
4074
4227
  *
4075
- * @since 1.67.0
4076
4228
  *
4077
- * @returns The catalog tile info
4229
+ * @returns Tile title
4078
4230
  */
4079
4231
  getCatalogTileTitle(
4080
4232
  /**
@@ -4103,7 +4255,7 @@ declare namespace sap {
4103
4255
  * Returns the UI5 view or control of a catalog tile
4104
4256
  *
4105
4257
  *
4106
- * @returns jQuery.deferred.promise object that when resolved, returns the Catalog Tile View
4258
+ * @returns Resolves the Catalog Tile View
4107
4259
  */
4108
4260
  getCatalogTileViewControl(
4109
4261
  /**
@@ -4114,7 +4266,7 @@ declare namespace sap {
4114
4266
  * SAP-internal: Whether the tile should be displayed in preview mode
4115
4267
  */
4116
4268
  bPreview?: boolean
4117
- ): object;
4269
+ ): jQuery.Promise;
4118
4270
  /**
4119
4271
  * Returns the catalog's title
4120
4272
  *
@@ -4128,13 +4280,12 @@ declare namespace sap {
4128
4280
  oCatalog: object
4129
4281
  ): string;
4130
4282
  /**
4131
- * Returns the default group of the user. In case of success, the `done` function gets an 'anonymous' object
4132
- * representing the default group.
4283
+ * Returns the default group of the user.
4133
4284
  *
4134
4285
  *
4135
- * @returns jQuery.promise object.
4286
+ * @returns Resolves the default group.
4136
4287
  */
4137
- getDefaultGroup(): object;
4288
+ getDefaultGroup(): jQuery.Promise;
4138
4289
  /**
4139
4290
  * Returns the unique identifier of the given group
4140
4291
  *
@@ -4148,14 +4299,14 @@ declare namespace sap {
4148
4299
  oGroup: object
4149
4300
  ): string;
4150
4301
  /**
4151
- * Returns the groups of the user. In case of success, the `done` function gets an array of 'anonymous'
4152
- * groups. The order of the array is the order in which the groups will be displayed to the user.
4302
+ * Returns the groups of the user. The order of the array is the order in which the groups will be displayed
4303
+ * to the user.
4153
4304
  *
4154
4305
  * @deprecated (since 1.99) - Alternative for use with {@link sap.ushell.services.Bookmark} is {@link sap.ushell.services.Bookmark#getContentNodes}
4155
4306
  *
4156
4307
  * @returns A promise that resolves to the list of groups
4157
4308
  */
4158
- getGroups(): Promise<object>;
4309
+ getGroups(): jQuery.Promise<object>;
4159
4310
  /**
4160
4311
  * Returns an array of 'anonymous' tiles of a group. The order of the array is the order of tiles that will
4161
4312
  * be displayed to the user.
@@ -4258,18 +4409,17 @@ declare namespace sap {
4258
4409
  oTile: object
4259
4410
  ): string;
4260
4411
  /**
4261
- * Returns UI5 view or control of the tile. In case of success the `done` function should return UI5 view
4262
- * or control of the tile. In case of failure the `fail` function should return nothing.
4412
+ * Returns UI5 view or control of the tile.
4263
4413
  *
4264
4414
  *
4265
- * @returns jQuery.promise object
4415
+ * @returns Resolves the UI5 view or control of the tile.
4266
4416
  */
4267
4417
  getTileView(
4268
4418
  /**
4269
4419
  * The tile
4270
4420
  */
4271
4421
  oTile: object
4272
- ): object;
4422
+ ): jQuery.Promise;
4273
4423
  /**
4274
4424
  * Returns whether the catalogs collection previously returned by `getCatalogs()` is still valid.
4275
4425
  *
@@ -4333,12 +4483,11 @@ declare namespace sap {
4333
4483
  /**
4334
4484
  * Moves a group to a new index (i.e. location).
4335
4485
  *
4336
- * In case of success, the `done` function is called without any value. Intention: the page builder already
4337
- * moved the page (visible to the user) and if successful - nothing needs to be done. In case of failure,
4338
- * the `fail` function returns the consistent (i.e. persisted) backend state of all groups.
4486
+ * Intention: the page builder already moved the page (visible to the user) and if successful - nothing
4487
+ * needs to be done. In case of failure it gets the consistent (i.e. persisted) backend state of all groups.
4339
4488
  *
4340
4489
  *
4341
- * @returns jQuery.promise object
4490
+ * @returns Resolves once the group was moved.
4342
4491
  */
4343
4492
  moveGroup(
4344
4493
  /**
@@ -4349,20 +4498,19 @@ declare namespace sap {
4349
4498
  * The new index for the group
4350
4499
  */
4351
4500
  iNewIndex: int
4352
- ): object;
4501
+ ): jQuery.Promise;
4353
4502
  /**
4354
4503
  * Moves a tile within a group or between different groups.
4355
4504
  *
4356
- * In case of success, the `done` function returns nothing. Intention: the page builder already moved the
4357
- * tile.
4505
+ * Intention: the page builder already moved the tile.
4358
4506
  *
4359
- * In case of failure, the `fail` function returns the consistent (i.e. persisted) backend state of the
4360
- * source group and the target group. The result is in the following format {source:[{},{}], target:[{},{}]}.
4507
+ * In case of failure it gets the consistent (i.e. persisted) backend state of the source group and the
4508
+ * target group. The result is in the following format {source:[{},{}], target:[{},{}]}.
4361
4509
  *
4362
4510
  * The source and the target groups tiles are in the form of the @see sap.ushell.services.LaunchPage.getGroupTiles
4363
4511
  *
4364
4512
  *
4365
- * @returns jQuery.promise object
4513
+ * @returns Resolves once the tile was moved.
4366
4514
  */
4367
4515
  moveTile(
4368
4516
  /**
@@ -4392,7 +4540,7 @@ declare namespace sap {
4392
4540
  * (added with 1.46) The new type of the tile
4393
4541
  */
4394
4542
  sNewTileType?: string
4395
- ): object;
4543
+ ): jQuery.Promise;
4396
4544
  /**
4397
4545
  * Triggers a refresh action of a tile. Typically this action is related to the value presented in dynamic
4398
4546
  * tiles
@@ -4429,15 +4577,13 @@ declare namespace sap {
4429
4577
  /**
4430
4578
  * Removes a group.
4431
4579
  *
4432
- * In case of success, the `done` function is called without any value (i.e. input data). Intention: the
4433
- * page builder already removed the page (or hid it from the user) and if successful - nothing needs to
4434
- * be done.
4580
+ * Intention: the page builder already removed the page (or hid it from the user) and if successful - nothing
4581
+ * needs to be done.
4435
4582
  *
4436
- * In case of failure, the `fail` function returns the consistent (i.e. persisted) backend state of all
4437
- * groups.
4583
+ * In case of failure it gets the consistent (i.e. persisted) backend state of all groups.
4438
4584
  *
4439
4585
  *
4440
- * @returns jQuery.promise object
4586
+ * @returns Resolves once the group was removed.
4441
4587
  */
4442
4588
  removeGroup(
4443
4589
  /**
@@ -4448,18 +4594,16 @@ declare namespace sap {
4448
4594
  * The index of the group to be removed
4449
4595
  */
4450
4596
  iIndex: int
4451
- ): object;
4597
+ ): jQuery.Promise;
4452
4598
  /**
4453
4599
  * Removes a tile from a group.
4454
4600
  *
4455
- * In case of success, the `done` function returns the new tile. Intention: the page builder has already
4456
- * 'hidden' (or removed) the tile.
4601
+ * Intention: the page builder has already 'hidden' (or removed) the tile.
4457
4602
  *
4458
- * In case of failure, the `fail` function should return the consistent (i.e. persisted) backend state of
4459
- * the group.
4603
+ * In case of failure it gets the consistent (i.e. persisted) backend state of the group.
4460
4604
  *
4461
4605
  *
4462
- * @returns jQuery.promise object
4606
+ * @returns Resolves once the tile was removed.
4463
4607
  */
4464
4608
  removeTile(
4465
4609
  /**
@@ -4474,7 +4618,7 @@ declare namespace sap {
4474
4618
  * The tile index
4475
4619
  */
4476
4620
  iIndex: int
4477
- ): object;
4621
+ ): jQuery.Promise;
4478
4622
  /**
4479
4623
  * Resets a group.
4480
4624
  *
@@ -4482,14 +4626,12 @@ declare namespace sap {
4482
4626
  * action means that the group is set back to the state defined by the administrator, and changes made by
4483
4627
  * the end user (e.g. adding tiles) are removed. A group can be reset multiple times.
4484
4628
  *
4485
- * In case of success, the `done` function gets the reset group object.
4486
- *
4487
- * In case of failure, or when the given group was created by the user (i.e. can't be reset)- `fail` handler
4488
- * is called, returning the consistent (i.e. persisted) backend state of all groups. The returned group
4489
- * object is the same as the one returned by @see sap.ushell.services.LaunchPage.getGroups
4629
+ * In case of failure, or when the given group was created by the user (i.e. can't be reset)- it gets, the
4630
+ * consistent (i.e. persisted) backend state of all groups. The returned group object is the same as the
4631
+ * one returned by @see sap.ushell.services.LaunchPage.getGroups
4490
4632
  *
4491
4633
  *
4492
- * @returns jQuery.promise object
4634
+ * @returns Resolves once the group was reset.
4493
4635
  */
4494
4636
  resetGroup(
4495
4637
  /**
@@ -4500,17 +4642,16 @@ declare namespace sap {
4500
4642
  * The index of the group to be reset
4501
4643
  */
4502
4644
  iIndex: int
4503
- ): object;
4645
+ ): jQuery.Promise;
4504
4646
  /**
4505
4647
  * Sets the title of an existing group.
4506
4648
  *
4507
- * In case of success, the `done` function returns nothing. Intention: the page builder knows the new title,
4508
- * and if successful nothing needs to be done, as the title is already visible to the user. In case of failure,
4509
- * the `fail` function returns the consistent (i.e. persisted) backend state of the group title, in most
4510
- * cases the old title.
4649
+ * Intention: the page builder knows the new title, and if successful nothing needs to be done, as the title
4650
+ * is already visible to the user. In case of failure it gets the consistent (i.e. persisted) backend state
4651
+ * of the group title, in most cases the old title.
4511
4652
  *
4512
4653
  *
4513
- * @returns jQuery.promise object
4654
+ * @returns Resolves once the group title was set.
4514
4655
  */
4515
4656
  setGroupTitle(
4516
4657
  /**
@@ -4521,7 +4662,7 @@ declare namespace sap {
4521
4662
  * The new title of the group
4522
4663
  */
4523
4664
  sTitle: string
4524
- ): object;
4665
+ ): jQuery.Promise;
4525
4666
  /**
4526
4667
  * Sets the tile's visibility state and notifies the tile about the change.
4527
4668
  */
@@ -4540,13 +4681,16 @@ declare namespace sap {
4540
4681
  * Message service.
4541
4682
  *
4542
4683
  * **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("Message")`.
4543
- * For details, see {@link sap.ushell.services.Container#getServiceAsync}.
4684
+ * For details, see {@link sap.ushell.Container#getServiceAsync}.
4544
4685
  *
4545
4686
  * @since 1.16.0
4546
4687
  * @deprecated (since 1.120)
4547
4688
  */
4548
- class Message {
4549
- constructor();
4689
+ class Message extends sap.ushell.services.Service {
4690
+ /**
4691
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
4692
+ */
4693
+ protected constructor();
4550
4694
 
4551
4695
  /**
4552
4696
  * Shows an confirmation dialog on the screen.
@@ -4650,7 +4794,7 @@ declare namespace sap {
4650
4794
  * running app (but still in scope of the current Fiori launchpad) or to create links to such external targets.
4651
4795
  *
4652
4796
  * **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("Navigation")`.
4653
- * For details, see {@link sap.ushell.services.Container#getServiceAsync}.
4797
+ * For details, see {@link sap.ushell.Container#getServiceAsync}.
4654
4798
  *
4655
4799
  * The Navigation service currently provides platform independent functionality.
4656
4800
  *
@@ -4700,8 +4844,11 @@ declare namespace sap {
4700
4844
  *
4701
4845
  * @since 1.120.0
4702
4846
  */
4703
- class Navigation {
4704
- constructor();
4847
+ class Navigation extends sap.ushell.services.Service {
4848
+ /**
4849
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
4850
+ */
4851
+ protected constructor();
4705
4852
 
4706
4853
  /**
4707
4854
  * Attempts to use the browser history to navigate to the previous app.
@@ -4866,6 +5013,9 @@ declare namespace sap {
4866
5013
  *
4867
5014
  *
4868
5015
  * @since 1.120.0
5016
+ *
5017
+ * @returns A promise that resolves to an array of objects indicating whether the intent is supported or
5018
+ * not. Each object has a property `supported` of type `boolean`.
4869
5019
  */
4870
5020
  isNavigationSupported(
4871
5021
  /**
@@ -4876,7 +5026,11 @@ declare namespace sap {
4876
5026
  * The root component of the application.
4877
5027
  */
4878
5028
  oComponent?: sap.ui.core.Component
4879
- ): void;
5029
+ ): Promise<
5030
+ Array<{
5031
+ supported: boolean;
5032
+ }>
5033
+ >;
4880
5034
  /**
4881
5035
  * Triggers a navigation to a specified target outside of the currently running application (e.g. different
4882
5036
  * launchpad application). Invocation will trigger a hash change and subsequent invocation of the target.
@@ -4938,7 +5092,7 @@ declare namespace sap {
4938
5092
  * The Unified Shell's internal navigation target resolution service.
4939
5093
  *
4940
5094
  * **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("NavTargetResolution")`.
4941
- * For details, see {@link sap.ushell.services.Container#getServiceAsync}.
5095
+ * For details, see {@link sap.ushell.Container#getServiceAsync}.
4942
5096
  *
4943
5097
  * Methods in this class deal with *internal* representations of the shell hash.
4944
5098
  *
@@ -4949,8 +5103,11 @@ declare namespace sap {
4949
5103
  * @since 1.15.0
4950
5104
  * @deprecated (since 1.120)
4951
5105
  */
4952
- class NavTargetResolution {
4953
- constructor();
5106
+ class NavTargetResolution extends sap.ushell.services.Service {
5107
+ /**
5108
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
5109
+ */
5110
+ protected constructor();
4954
5111
 
4955
5112
  /**
4956
5113
  * expands a URL hash fragment
@@ -4960,7 +5117,7 @@ declare namespace sap {
4960
5117
  * This is an asynchronous operation.
4961
5118
  *
4962
5119
  *
4963
- * @returns A jQuery.Promise. Its `done()` function gets an expanded shell hash (in internal format)
5120
+ * @returns Resolves expanded shell hash (in internal format).
4964
5121
  */
4965
5122
  expandCompactHash(
4966
5123
  /**
@@ -4968,7 +5125,7 @@ declare namespace sap {
4968
5125
  * given in `location.hash`)
4969
5126
  */
4970
5127
  sHashFragment: string
4971
- ): string;
5128
+ ): jQuery.Promise;
4972
5129
  /**
4973
5130
  * Tells whether the given navigation intent(s) are supported for the given parameters Supported" means
4974
5131
  * that a valid navigation target is configured for the user for the given device form factor.
@@ -4978,8 +5135,8 @@ declare namespace sap {
4978
5135
  *
4979
5136
  * @since 1.32
4980
5137
  *
4981
- * @returns A `jQuery.Deferred` object's promise which is resolved with an array (!) of objects representing
4982
- * whether the intent is supported or not objects with a property `supported` of type `boolean`.
5138
+ * @returns Resolves an array of objects representing whether the intent is supported or not objects with
5139
+ * a property `supported` of type `boolean`.
4983
5140
  * Example:
4984
5141
  *
4985
5142
  * aIntents: an array of parameterized (parsed) Intent objects, in the corresponding structure to arguments
@@ -5059,7 +5216,7 @@ declare namespace sap {
5059
5216
  * or `{ target : { shellHash : "AnObject-action?A=B&c=e" } }`
5060
5217
  */
5061
5218
  aIntents: object[]
5062
- ): object;
5219
+ ): jQuery.Promise;
5063
5220
  /**
5064
5221
  * Resolves the URL hash fragment.
5065
5222
  *
@@ -5083,7 +5240,7 @@ declare namespace sap {
5083
5240
  * This is an asynchronous operation.
5084
5241
  *
5085
5242
  *
5086
- * @returns A jQuery.Promise. Its `done()` function gets an object that you can use to create a {@link sap.ushell.components.container.ApplicationContainer }
5243
+ * @returns Resolves an object that you can use to create a {@link sap.ushell.components.container.ApplicationContainer }
5087
5244
  * or `undefined` in case the hash fragment was empty. Typically it contains the following information:
5088
5245
  *
5089
5246
  * ```javascript
@@ -5106,7 +5263,7 @@ declare namespace sap {
5106
5263
  * given in `location.hash`)! Example: `#SemanticObject-action?P1=V1&P2=A%20B%20C`
5107
5264
  */
5108
5265
  sHashFragment: string
5109
- ): object;
5266
+ ): jQuery.Promise;
5110
5267
  /**
5111
5268
  * Resolves a navigation target taking into account the sap-system
5112
5269
  *
@@ -5115,8 +5272,7 @@ declare namespace sap {
5115
5272
  *
5116
5273
  * @ui5-protected Do not call from applications (only from related classes in the framework)
5117
5274
  *
5118
- * @returns A jQuery.Promise. Its `done()` function gets an object. Typically it contains the following
5119
- * information:
5275
+ * @returns Resolves an object. Typically it contains the following information:
5120
5276
  * ```javascript
5121
5277
  *
5122
5278
  * {
@@ -5152,6 +5308,9 @@ declare namespace sap {
5152
5308
  * UShell service for fetching user notification data from the Notification center/service
5153
5309
  * and exposing them to the Unified Shell and Fiori applications UI controls.
5154
5310
  *
5311
+ * **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("ClientSideTargetResolution")`.
5312
+ * For details, see {@link sap.ushell.Container#getServiceAsync}.
5313
+ *
5155
5314
  * In order to get user notifications, Unified Shell notification service issues OData requests
5156
5315
  * to the service defined by the configuration property `serviceUrl`,
5157
5316
  * for example: "/sap/opu/odata4/iwngw/notification/default/iwngw/notification_srv/0001"
@@ -5175,8 +5334,11 @@ declare namespace sap {
5175
5334
  * @since 1.32.0
5176
5335
  * @deprecated (since 1.119) - Please use {@link sap.ushell.services.NotificationsV2} instead.
5177
5336
  */
5178
- class Notifications {
5179
- constructor();
5337
+ class Notifications extends sap.ushell.services.Service {
5338
+ /**
5339
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
5340
+ */
5341
+ protected constructor();
5180
5342
 
5181
5343
  /**
5182
5344
  * Launches dismiss notification call.
@@ -5184,7 +5346,7 @@ declare namespace sap {
5184
5346
  *
5185
5347
  * @since 1.34
5186
5348
  *
5187
- * @returns Promise object that on success resolves to undefined or it is rejected with a message object
5349
+ * @returns Resolves to undefined or it is rejected with a message object
5188
5350
  */
5189
5351
  dismissNotification(
5190
5352
  /**
@@ -5216,7 +5378,7 @@ declare namespace sap {
5216
5378
  *
5217
5379
  * @since 1.38
5218
5380
  *
5219
- * @returns Promise object that - on success - returns all notification items
5381
+ * @returns Resolves all notification items
5220
5382
  */
5221
5383
  getNotificationsByTypeWithGroupHeaders(): jQuery.Promise;
5222
5384
  /**
@@ -5233,7 +5395,7 @@ declare namespace sap {
5233
5395
  *
5234
5396
  * @since 1.44
5235
5397
  *
5236
- * @returns Promise object that - on success - returns all group headers
5398
+ * @returns Resolves all group headers
5237
5399
  */
5238
5400
  getNotificationsGroupHeaders(): jQuery.Promise;
5239
5401
  /**
@@ -5242,7 +5404,7 @@ declare namespace sap {
5242
5404
  *
5243
5405
  * @since 1.32
5244
5406
  *
5245
- * @returns Promise object that on success - returns the number of unread notifications of the user
5407
+ * @returns Resolves the number of unread notifications of the user
5246
5408
  */
5247
5409
  getUnseenNotificationsCount(): jQuery.Promise;
5248
5410
  /**
@@ -5289,7 +5451,7 @@ declare namespace sap {
5289
5451
  *
5290
5452
  * @since 1.34
5291
5453
  *
5292
- * @returns Promise object that on success resolves to undefined or it is rejected with a message object
5454
+ * @returns Resolves to undefined or it is rejected with a message object
5293
5455
  */
5294
5456
  markRead(
5295
5457
  /**
@@ -5333,7 +5495,7 @@ declare namespace sap {
5333
5495
  * and exposing them to the Unified Shell and Fiori applications UI controls.
5334
5496
  *
5335
5497
  * **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("NotificationsV2")`.
5336
- * For details, see {@link sap.ushell.services.Container#getServiceAsync}.
5498
+ * For details, see {@link sap.ushell.Container#getServiceAsync}.
5337
5499
  *
5338
5500
  * In order to get user notifications, Unified Shell notification service issues OData requests
5339
5501
  * to the service defined by the configuration property `serviceUrl`,
@@ -5357,8 +5519,11 @@ declare namespace sap {
5357
5519
  *
5358
5520
  * @since 1.119
5359
5521
  */
5360
- class NotificationsV2 {
5361
- constructor();
5522
+ class NotificationsV2 extends sap.ushell.services.Service {
5523
+ /**
5524
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
5525
+ */
5526
+ protected constructor();
5362
5527
 
5363
5528
  /**
5364
5529
  * Launches dismiss notification call.
@@ -5472,7 +5637,7 @@ declare namespace sap {
5472
5637
  * the main use-case is when the user navigated to the notification center and sees all the pending notifications.
5473
5638
  *
5474
5639
  *
5475
- * @returns Promise taht resolves when operation is finished
5640
+ * @returns Promise that resolves when operation is finished
5476
5641
  */
5477
5642
  notificationsSeen(): Promise<any>;
5478
5643
  /**
@@ -5495,17 +5660,20 @@ declare namespace sap {
5495
5660
  ): void;
5496
5661
  }
5497
5662
  /**
5498
- * This method MUST be called by the Unified Shell's container only, others MUST call `sap.ushell.Container.getServiceAsync("Personalization").then(function
5499
- * (Personalization) {});`. Constructs a new instance of the personalization service.
5500
- *
5501
5663
  * The Unified Shell's personalization service, which provides a personalizer object that handles all personalization
5502
5664
  * operations.
5503
5665
  *
5666
+ * **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("ClientSideTargetResolution")`.
5667
+ * For details, see {@link sap.ushell.Container#getServiceAsync}.
5668
+ *
5504
5669
  * @since 1.15.0
5505
5670
  * @deprecated (since 1.120) - Please use {@link sap.ushell.services.PersonalizationV2} instead
5506
5671
  */
5507
- class Personalization {
5508
- constructor();
5672
+ class Personalization extends sap.ushell.services.Service {
5673
+ /**
5674
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
5675
+ */
5676
+ protected constructor();
5509
5677
 
5510
5678
  /**
5511
5679
  * Factory method to obtain an empty Data Context object. When data present in a prior context is not relevant
@@ -5521,11 +5689,10 @@ declare namespace sap {
5521
5689
  *
5522
5690
  * @since 1.22.0
5523
5691
  *
5524
- * @returns Promise object whose done function returns a {@link sap.ushell.services.Personalization.ContextContainer }
5525
- * object as parameter. The personalization container provides two different interfaces to synchronously
5526
- * operate on personalization data. In the item mode the container contains items as name value pairs for
5527
- * personalization data. In the variant mode the container contains variant sets which contain variants
5528
- * containing items.
5692
+ * @returns Resolves a {@link sap.ushell.services.Personalization.ContextContainer} object as parameter.
5693
+ * The personalization container provides two different interfaces to synchronously operate on personalization
5694
+ * data. In the item mode the container contains items as name value pairs for personalization data. In
5695
+ * the variant mode the container contains variant sets which contain variants containing items.
5529
5696
  */
5530
5697
  createEmptyContainer(
5531
5698
  /**
@@ -5545,7 +5712,7 @@ declare namespace sap {
5545
5712
  * the application.
5546
5713
  */
5547
5714
  oComponent: sap.ui.core.Component
5548
- ): object;
5715
+ ): jQuery.Promise;
5549
5716
  /**
5550
5717
  * Asynchronously starts a deletion request for the given container identified by sContainerKey. Can be
5551
5718
  * called without having ever called getContainer with the corresponding key
@@ -5558,7 +5725,7 @@ declare namespace sap {
5558
5725
  *
5559
5726
  * @since 1.22.0
5560
5727
  *
5561
- * @returns promise for the deletion operation
5728
+ * @returns Resolves once the container was deleted.
5562
5729
  */
5563
5730
  delContainer(
5564
5731
  /**
@@ -5569,7 +5736,7 @@ declare namespace sap {
5569
5736
  * scope object
5570
5737
  */
5571
5738
  oScope: object
5572
- ): object;
5739
+ ): jQuery.Promise;
5573
5740
  /**
5574
5741
  * Asynchronously starts a deletion request for the given container identified by sContainerKey. Can be
5575
5742
  * called without having ever created a personalization container.
@@ -5583,14 +5750,14 @@ declare namespace sap {
5583
5750
  * @since 1.18.0
5584
5751
  * @deprecated (since 1.22) - Please use {@link #delContainer} instead.
5585
5752
  *
5586
- * @returns promise for the deletion operation
5753
+ * @returns Resolves once the container was deleted.
5587
5754
  */
5588
5755
  delPersonalizationContainer(
5589
5756
  /**
5590
5757
  * identifies the container
5591
5758
  */
5592
5759
  sContainerKey: string
5593
- ): object;
5760
+ ): jQuery.Promise;
5594
5761
  /**
5595
5762
  * Factory method to obtain a Data Context object, which is a local copy of the persistence layer data.
5596
5763
  * The Container data is asynchronously read on creation if present, otherwise an initial object is created.
@@ -5646,8 +5813,8 @@ declare namespace sap {
5646
5813
  * namespaces per validity).
5647
5814
  *
5648
5815
  * In general, mixing different validity models for a given container key is not supported. Fast chaining
5649
- * of different methods may source arbitrary persistence layers. The validity of the resulting object in
5650
- * the done function of a promise is the last get validity.
5816
+ * of different methods may source arbitrary persistence layers. The validity of the resolved object is
5817
+ * the last get validity.
5651
5818
  *
5652
5819
  * The validity associated with the last getContainer or createEmptyContainer determines the current validity
5653
5820
  * of the container and the validity used during the next save operation.
@@ -5658,10 +5825,9 @@ declare namespace sap {
5658
5825
  *
5659
5826
  * @since 1.22.0
5660
5827
  *
5661
- * @returns Promise object whose done function returns a {@link sap.ushell.services.Personalization.ContextContainer }
5662
- * object as parameter. The container provides setItemValue / getItemValue methods to synchronously operate
5663
- * on personalization data. By wrapping it in a VariantSetAdapter, an alternate interface to maintain variants
5664
- * can be obtained.
5828
+ * @returns Resolves a {@link sap.ushell.services.Personalization.ContextContainer} object as parameter.
5829
+ * The container provides setItemValue / getItemValue methods to synchronously operate on personalization
5830
+ * data. By wrapping it in a VariantSetAdapter, an alternate interface to maintain variants can be obtained.
5665
5831
  */
5666
5832
  getContainer(
5667
5833
  /**
@@ -5683,7 +5849,7 @@ declare namespace sap {
5683
5849
  * the application.
5684
5850
  */
5685
5851
  oComponent: sap.ui.core.Component
5686
- ): object;
5852
+ ): jQuery.Promise;
5687
5853
  /**
5688
5854
  * Returns a generated key. This key is suitably random, but it is susceptible to brute force attacks. Storages
5689
5855
  * based on the generated key must not be used for sensitive data.
@@ -5736,18 +5902,17 @@ declare namespace sap {
5736
5902
  * @since 1.18.0
5737
5903
  * @deprecated (since 1.21) - Please use {@link #getContainer} instead.
5738
5904
  *
5739
- * @returns Promise object whose done function returns a {@link sap.ushell.services.PersonalizationContainer }
5740
- * object as parameter. The personalization container provides two different interfaces to synchronously
5741
- * operate on personalization data. In the item mode the container contains items as name-value pairs for
5742
- * personalization data. In the variant mode the container contains variant sets which contain variants
5743
- * containing items.
5905
+ * @returns Resolves a {@link sap.ushell.services.PersonalizationContainer} object as parameter. The personalization
5906
+ * container provides two different interfaces to synchronously operate on personalization data. In the
5907
+ * item mode the container contains items as name-value pairs for personalization data. In the variant mode
5908
+ * the container contains variant sets which contain variants containing items.
5744
5909
  */
5745
5910
  getPersonalizationContainer(
5746
5911
  /**
5747
5912
  * identifies the container
5748
5913
  */
5749
5914
  sContainerKey: string
5750
- ): object;
5915
+ ): jQuery.Promise;
5751
5916
  /**
5752
5917
  * Returns a personalizer object which handles personalization by asynchronous operations storing the personalization
5753
5918
  * data immediately via the connected adapter. For each operation a round trip is executed.
@@ -5759,8 +5924,8 @@ declare namespace sap {
5759
5924
  *
5760
5925
  * @since 1.15.0
5761
5926
  *
5762
- * @returns {@link sap.ushell.services.Personalizer} which provides generic read and write access to the
5763
- * currently logged on user's personalization settings.
5927
+ * @returns A Personalizer which provides generic read and write access to the currently logged on user's
5928
+ * personalization settings.
5764
5929
  */
5765
5930
  getPersonalizer(
5766
5931
  /**
@@ -5785,7 +5950,7 @@ declare namespace sap {
5785
5950
  * with the application.
5786
5951
  */
5787
5952
  oComponent?: sap.ui.core.Component
5788
- ): object;
5953
+ ): /* was: sap.ushell.services.Personalizer */ any;
5789
5954
  /**
5790
5955
  * Returns a transient personalizer object which handles personalization by asynchronous operations storing
5791
5956
  * the personalization data transiently as an object property. Primary usage of the transient personalizer
@@ -5794,26 +5959,25 @@ declare namespace sap {
5794
5959
  *
5795
5960
  * @since 1.18.0
5796
5961
  *
5797
- * @returns {@link sap.ushell.services.TransientPersonalizer} which provides asynchronous read and write
5798
- * access to a transient personalization data storage.
5962
+ * @returns A TransientPersonalizer which provides asynchronous read and write access to a transient personalization
5963
+ * data storage.
5799
5964
  */
5800
- getTransientPersonalizer(): object;
5965
+ getTransientPersonalizer(): /* was: sap.ushell.services.TransientPersonalizer */ any;
5801
5966
  }
5802
5967
  /**
5803
5968
  * The Unified Shell's personalization service. Provides a personalizer object that handles all personalization
5804
5969
  * operations.
5805
5970
  *
5806
5971
  * **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("PersonalizationV2")`.
5807
- * For details, see {@link sap.ushell.services.Container#getServiceAsync}.
5972
+ * For details, see {@link sap.ushell.Container#getServiceAsync}.
5808
5973
  *
5809
5974
  * @since 1.120.0
5810
5975
  */
5811
- class PersonalizationV2 {
5812
- constructor();
5976
+ class PersonalizationV2 extends sap.ushell.services.Service {
5813
5977
  /**
5814
- * @since 1.120.0
5978
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
5815
5979
  */
5816
- static constants: undefined;
5980
+ protected constructor();
5817
5981
 
5818
5982
  /**
5819
5983
  * Factory method to obtain an empty Data Context object. When data present in a prior context is not relevant
@@ -5861,7 +6025,7 @@ declare namespace sap {
5861
6025
  *
5862
6026
  * @since 1.120.0
5863
6027
  *
5864
- * @returns promise for the deletion operation
6028
+ * @returns Resolves once the container was deleted.
5865
6029
  */
5866
6030
  deleteContainer(
5867
6031
  /**
@@ -5928,8 +6092,8 @@ declare namespace sap {
5928
6092
  * namespaces per validity).
5929
6093
  *
5930
6094
  * In general, mixing different validity models for a given container key is not supported. Fast chaining
5931
- * of different methods may source arbitrary persistence layers. The validity of the resulting object in
5932
- * the done function of a promise is the last get validity.
6095
+ * of different methods may source arbitrary persistence layers. The validity of the resolved object is
6096
+ * the last get validity.
5933
6097
  *
5934
6098
  * The validity associated with the last getContainer or createEmptyContainer determines the current validity
5935
6099
  * of the container and the validity used during the next save operation.
@@ -6010,16 +6174,27 @@ declare namespace sap {
6010
6174
  */
6011
6175
  getTransientPersonalizer(): Promise<sap.ushell.services.PersonalizationV2.TransientPersonalizer>;
6012
6176
  }
6177
+ /**
6178
+ * Abstract base class for ushell services. For details, see {@link sap.ushell.Container#getServiceAsync}.
6179
+ *
6180
+ * @since 1.121.0
6181
+ */
6182
+ abstract class Service {
6183
+ /**
6184
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
6185
+ */
6186
+ protected constructor();
6187
+ }
6013
6188
  /**
6014
6189
  * The Unified Shell's internal navigation service (platform independent).
6015
6190
  *
6016
6191
  * **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("ShellNavigation")`.
6017
- * For details, see {@link sap.ushell.services.Container#getServiceAsync}.
6192
+ * For details, see {@link sap.ushell.Container#getServiceAsync}.
6018
6193
  *
6019
6194
  * This interface is for consumption by shell renderers/containers only
6020
6195
  *
6021
6196
  * It is not for direct usage by applications, see inner app navigation : UI5 interfaces (hashChanger, Router)
6022
- * cross app navigation : @see CrossApplicationNavigation
6197
+ * cross app navigation : @see sap.ushell.services.CrossApplicationNavigation
6023
6198
  *
6024
6199
  * Usage:
6025
6200
  *
@@ -6058,7 +6233,10 @@ declare namespace sap {
6058
6233
  * @deprecated (since 1.120)
6059
6234
  */
6060
6235
  class ShellNavigation {
6061
- constructor();
6236
+ /**
6237
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
6238
+ */
6239
+ protected constructor();
6062
6240
 
6063
6241
  /**
6064
6242
  * compact the parameter object, if required a number of parameters will be removed, instead a corresponding
@@ -6121,14 +6299,14 @@ declare namespace sap {
6121
6299
  * part, if exist sOldAppSpecificPart, // The old app hash part, if exist
6122
6300
  *
6123
6301
  *
6124
- * @returns this
6302
+ * @returns Reference to `this` for method chaining.
6125
6303
  */
6126
6304
  init(
6127
6305
  /**
6128
6306
  * The callback method for hash changes
6129
6307
  */
6130
6308
  fnShellCallback: Function
6131
- ): object;
6309
+ ): this;
6132
6310
  /**
6133
6311
  * Rewrite the hash fragment identifier without triggering any navigation at
6134
6312
  *
@@ -6149,56 +6327,143 @@ declare namespace sap {
6149
6327
  * This method should not be used externally. It's reserved uniquely for internal shell consumption and
6150
6328
  * its signature or result might change at any time.
6151
6329
  *
6152
- * @ui5-protected Do not call from applications (only from related classes in the framework)
6330
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
6331
+ */
6332
+ resetHistoryEntryReplaced(): void;
6333
+ /**
6334
+ * Returns true if the history entry was replaced immediately after the last navigation. To be useful, this
6335
+ * method should be called immediately after the hash enters the URL but before the target application is
6336
+ * finally navigated to.
6337
+ *
6338
+ * This method should not be used externally. It's reserved uniquely for internal shell consumption and
6339
+ * its signature or result might change at any time.
6340
+ *
6341
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
6342
+ *
6343
+ * @returns Whether `hasher#replaceHash` was called after the last navigation.
6344
+ */
6345
+ wasHistoryEntryReplaced(): boolean;
6346
+ }
6347
+ /**
6348
+ * Constructs an instance of SmartNavigation. The constructed service provides an enhancement on {@link CrossApplicationNavigation#getLinks }
6349
+ * and {@link CrossApplicationNavigation#toExternal}. In order for an application to leverage this enhancement,
6350
+ * it is pertinent that the application uses {@link SmartNavigation#toExternal} for navigation. Hence the
6351
+ * caller can subsequently use {@link SmartNavigation#getLinks} with the outcome that it sorts the resulting
6352
+ * list in the order of frequency of attempted navigation from the application to respective links.
6353
+ * Attempted in the previous paragraph is emphasized due to the fact that a click on the link
6354
+ * will cause an increment of the frequency count, regardless of whether or not the navigation was successful.
6355
+ *
6356
+ *
6357
+ * **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("ClientSideTargetResolution")`.
6358
+ * For details, see {@link sap.ushell.Container#getServiceAsync}.
6359
+ *
6360
+ * @since 1.44.0
6361
+ * @deprecated (since 1.112) - This service has been deprecated. Please use the CrossApplicationNavigation
6362
+ * service instead.
6363
+ */
6364
+ class SmartNavigation extends sap.ushell.services.Service {
6365
+ /**
6366
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
6367
+ */
6368
+ protected constructor();
6369
+
6370
+ /**
6371
+ * Resolves the given semantic object (or action) and business parameters to a list of links available to
6372
+ * the user, sorted according their relevance to the calling application.
6373
+ *
6374
+ * The relevance of link is defined by the frequency with which a navigation activity from the calling application
6375
+ * to that link occurs.
6376
+ *
6377
+ * Internally, this method delegates to {@link sap.ushell.services.CrossApplicationNavigation#getLinks }
6378
+ * and then sorts the resulting list accordingly.
6379
+ * See:
6380
+ * sap.ushell.services.CrossApplicationNavigation#getLinks
6381
+ *
6382
+ * @since 1.44.0
6383
+ *
6384
+ * @returns Resolves with an array of link objects sorted according to their relevance to the calling application.
6385
+ */
6386
+ getLinks(): jQuery.Promise;
6387
+ /**
6388
+ * Completely delegates to {@link sap.ushell.services.CrossApplicationNavigation#getPrimaryIntent}, and
6389
+ * either may be used in place of the other with exactly the same outcome.
6390
+ * See:
6391
+ * sap.ushell.services.CrossApplicationNavigation#getPrimaryIntent
6392
+ *
6393
+ * @since 1.48.0
6394
+ */
6395
+ getPrimaryIntent(): void;
6396
+ /**
6397
+ * Completely delegates to {@link sap.ushell.services.CrossApplicationNavigation#hrefForExternal}, and may
6398
+ * be used in place of the other with exactly the same outcome.
6399
+ * See:
6400
+ * sap.ushell.services.CrossApplicationNavigation#hrefForExternal
6401
+ *
6402
+ * @since 1.46.0
6403
+ * @deprecated (since 1.94) - Please use {@link #hrefForExternalAsync} instead.
6404
+ */
6405
+ hrefForExternal(): void;
6406
+ /**
6407
+ * Completely delegates to {@link sap.ushell.services.CrossApplicationNavigation#hrefForExternalAsync},
6408
+ * and may be used in place of the other with exactly the same outcome.
6409
+ * See:
6410
+ * sap.ushell.services.CrossApplicationNavigation#hrefForExternalAsync
6411
+ *
6412
+ * @since 1.94.0
6413
+ *
6414
+ * @returns A promise that is resolved to a string that can be put into an href attribute of an HTML anchor.
6415
+ * The returned string will always start with a hash character.
6153
6416
  */
6154
- resetHistoryEntryReplaced(): void;
6417
+ hrefForExternalAsync(): Promise<string>;
6155
6418
  /**
6156
- * Returns true if the history entry was replaced immediately after the last navigation. To be useful, this
6157
- * method should be called immediately after the hash enters the URL but before the target application is
6158
- * finally navigated to.
6419
+ * Usage of this method in place of {@link sap.ushell.services.CrossApplicationNavigation#toExternal} drives
6420
+ * the smartness of the results returned by {@link sap.ushell.services.SmartNavigation#getLinks}.
6421
+ * See:
6422
+ * sap.ushell.services.CrossApplicationNavigation#toExternal
6159
6423
  *
6160
- * This method should not be used externally. It's reserved uniquely for internal shell consumption and
6161
- * its signature or result might change at any time.
6424
+ * @since 1.44.0
6425
+ */
6426
+ toExternal(): void;
6427
+ /**
6428
+ * Tracks a navigation to a valid intent if provided via arguments but does not perform the navigation itself.
6429
+ * If no valid intent was provided tracking will be prevented. The intent has to consist of SemanticObject
6430
+ * and Action. It may be passed as complete shellHash (presidence) or as individual parts Additional parameters
6431
+ * will not be part of the tracking and ignored This Method can be used to track a click if the actual navigation
6432
+ * was triggered via clicking a link on the UI.
6162
6433
  *
6163
- * @ui5-protected Do not call from applications (only from related classes in the framework)
6434
+ * @since 1.46.0
6164
6435
  *
6165
- * @returns Whether `hasher#replaceHash` was called after the last navigation.
6166
- */
6167
- wasHistoryEntryReplaced(): boolean;
6168
- }
6169
- /**
6170
- * @since 1.44.0
6171
- * @deprecated (since 1.112) - This service has been deprecated. Please use the CrossApplicationNavigation
6172
- * service instead.
6173
- */
6174
- class SmartNavigation {
6175
- /**
6176
- * Constructs an instance of SmartNavigation.
6177
- *
6178
- * The constructed service provides an enhancement on {@link CrossApplicationNavigation#getLinks} and
6179
- * {@link CrossApplicationNavigation#toExternal}. In order for an application to leverage this enhancement,
6180
- * it is pertinent that the application uses {@link SmartNavigation#toExternal} for navigation. Hence the
6181
- * caller can subsequently use {@link SmartNavigation#getLinks} with the outcome that it sorts the resulting
6182
- * list in the order of frequency of attempted navigation from the application to respective links.
6183
- * Attempted in the previous paragraph is emphasized due to the fact that a click on the link
6184
- * will cause an increment of the frequency count, regardless of whether or not the navigation was successful.
6185
- * Note that an instance of this service should only be obtained via `sap.ushell.services.Container#getServiceAsync("SmartNavigation").then(function
6186
- * (SmartNavigation) {});`
6187
- * See:
6188
- * sap.ushell.services.Container#getServiceAsync
6436
+ * @returns Resolves once the navigation was tracked.
6189
6437
  */
6190
- constructor();
6438
+ trackNavigation(
6439
+ /**
6440
+ * The navigation target as object, for example: `{ target: { shellHash: 'SaleOrder-display' } }` or
6441
+ * ```javascript
6442
+ *
6443
+ * {
6444
+ * target: {
6445
+ * semanticObject: 'SalesOrder',
6446
+ * action: 'action'
6447
+ * }
6448
+ * }
6449
+ * ```
6450
+ */
6451
+ oArgs: object
6452
+ ): jQuery.Promise;
6191
6453
  }
6192
6454
  /**
6193
6455
  * The Unified Shell's SupportTicket service.
6194
6456
  *
6195
6457
  * **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("SupportTicket")`.
6196
- * For details, see {@link sap.ushell.services.Container#getServiceAsync}.
6458
+ * For details, see {@link sap.ushell.Container#getServiceAsync}.
6197
6459
  *
6198
6460
  * @since 1.19.1
6199
6461
  */
6200
- class SupportTicket {
6201
- constructor();
6462
+ class SupportTicket extends sap.ushell.services.Service {
6463
+ /**
6464
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
6465
+ */
6466
+ protected constructor();
6202
6467
 
6203
6468
  /**
6204
6469
  * Creates a Support Ticket. Forwards the given data (JSON object) to the associated adapter.
@@ -6240,7 +6505,7 @@ declare namespace sap {
6240
6505
  * The Unified Shell's internal URL parsing service (platform independent).
6241
6506
  *
6242
6507
  * **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("URLParsing")`.
6243
- * For details, see {@link sap.ushell.services.Container#getServiceAsync}.
6508
+ * For details, see {@link sap.ushell.Container#getServiceAsync}.
6244
6509
  *
6245
6510
  * Methods in this class allow to break down a shell compliant hash into it's respective parts (SemanticObject,Action,Context,
6246
6511
  * Parameters, appSpecificHash) or (ShellPart,appSpecificHash) respectively or construct a hash from its
@@ -6259,8 +6524,11 @@ declare namespace sap {
6259
6524
  *
6260
6525
  * @since 1.15.0
6261
6526
  */
6262
- class URLParsing {
6263
- constructor();
6527
+ class URLParsing extends sap.ushell.services.Service {
6528
+ /**
6529
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
6530
+ */
6531
+ protected constructor();
6264
6532
 
6265
6533
  /**
6266
6534
  * Note: deprecated, please use `sap.ui.model.odata.ODataUtils.setOrigin(sServiceUrl, { alias : sSystem
@@ -6512,8 +6780,13 @@ declare namespace sap {
6512
6780
  ): object;
6513
6781
  }
6514
6782
  /**
6515
- * A UShell service for tracking business flows and user actions. The UsageAnalytics service exposes API
6516
- * for logging custom events and setting custom field values in the logged events.
6783
+ * A UShell service for tracking business flows and user actions.
6784
+ *
6785
+ * **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("ClientSideTargetResolution")`.
6786
+ * For details, see {@link sap.ushell.Container#getServiceAsync}.
6787
+ *
6788
+ * The UsageAnalytics service exposes API for logging custom events and setting custom field values in the
6789
+ * logged events.
6517
6790
  * The data is sent via http and recorded on a server, whose URL is defined by the `baseUrl` service configuration
6518
6791
  * property.
6519
6792
  * The service configuration must also include the site ID from the `pubToken` attribute.
@@ -6537,8 +6810,11 @@ declare namespace sap {
6537
6810
  * @deprecated (since 1.120.0) - The corresponding cloud service "SAP Web Analytics" has been retired, therefore
6538
6811
  * this client-side service API cannot be used any longer.
6539
6812
  */
6540
- class UsageAnalytics {
6541
- constructor();
6813
+ class UsageAnalytics extends sap.ushell.services.Service {
6814
+ /**
6815
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
6816
+ */
6817
+ protected constructor();
6542
6818
 
6543
6819
  /**
6544
6820
  * Sets up to 6 customer attributes of logged events according to the given object attributes.
@@ -6606,12 +6882,15 @@ declare namespace sap {
6606
6882
  * The Unified Shell's user information service. Allows retrieving information about the logged-in user.
6607
6883
  *
6608
6884
  * **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("UserInfo")`.
6609
- * For details, see {@link sap.ushell.services.Container#getServiceAsync}.
6885
+ * For details, see {@link sap.ushell.Container#getServiceAsync}.
6610
6886
  *
6611
6887
  * @since 1.16.3
6612
6888
  */
6613
- class UserInfo {
6614
- constructor();
6889
+ class UserInfo extends sap.ushell.services.Service {
6890
+ /**
6891
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
6892
+ */
6893
+ protected constructor();
6615
6894
 
6616
6895
  /**
6617
6896
  * Returns the email address of the user.
@@ -6653,6 +6932,15 @@ declare namespace sap {
6653
6932
  * @returns The user's last name.
6654
6933
  */
6655
6934
  getLastName(): string;
6935
+ /**
6936
+ * Returns an object representing data about the user: ID, first name, last name, full name, e-mail address.
6937
+ *
6938
+ * @since 1.71.0
6939
+ *
6940
+ * @returns object providing information about the logged-in user: ID, first name, last name, full name,
6941
+ * e-mail address
6942
+ */
6943
+ getShellUserInfo(): Promise<any>;
6656
6944
  }
6657
6945
  }
6658
6946
 
@@ -6879,7 +7167,7 @@ declare namespace sap {
6879
7167
  * ID of the element which is the current target of the association {@link #getTileContent tileContent},
6880
7168
  * or `null`.
6881
7169
  */
6882
- getTileContent(): sap.ui.core.ID;
7170
+ getTileContent(): sap.ui.core.ID | null;
6883
7171
  /**
6884
7172
  * Gets current value of property {@link #getWidth width}.
6885
7173
  *
@@ -7422,17 +7710,18 @@ declare namespace sap {
7422
7710
  interface $RendererSettings extends sap.ui.core.$UIComponentSettings {}
7423
7711
 
7424
7712
  /**
7425
- * The SAPUI5 component of SAP Fiori Launchpad renderer for the Unified Shell.
7713
+ * The SAPUI5 component of SAP Fiori Launchpad renderer for the Unified Shell. This method MUST be called
7714
+ * by the Unified Shell's container only, others MUST call `sap.ushell.Container.createRenderer("fiori2",
7715
+ * true)`.
7426
7716
  *
7427
7717
  * @since 1.15.0
7428
7718
  * @deprecated (since 1.120.0) - Please use {@link sap.ushell.services.Extension} instead.
7429
7719
  */
7430
7720
  class Renderer extends sap.ui.core.UIComponent {
7431
7721
  /**
7432
- * This method MUST be called by the Unified Shell's container only, others MUST call `sap.ushell.Container.createRenderer("fiori2",
7433
- * true)`.
7722
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
7434
7723
  */
7435
- constructor();
7724
+ protected constructor();
7436
7725
  /**
7437
7726
  * The launchpad states that can be passed as a parameter.
7438
7727
  *
@@ -7580,7 +7869,7 @@ declare namespace sap {
7580
7869
  * @since 1.48
7581
7870
  * @deprecated (since 1.52)
7582
7871
  *
7583
- * @returns jQuery.deferred.promise object that when resolved, returns the newly created control
7872
+ * @returns Resolves with the newly created control
7584
7873
  */
7585
7874
  addFloatingButton(
7586
7875
  /**
@@ -7600,7 +7889,7 @@ declare namespace sap {
7600
7889
  * in which to add the control.
7601
7890
  */
7602
7891
  oParameters: object
7603
- ): object;
7892
+ ): jQuery.Promise;
7604
7893
  /**
7605
7894
  * Creates and displays a shell header icon in Fiori launchpad, in the given launchpad states.
7606
7895
  * The icon is displayed in the right side of the Fiori Launchpad shell header or in an overflow menu.
@@ -7875,7 +8164,7 @@ declare namespace sap {
7875
8164
  *
7876
8165
  * @since 1.48
7877
8166
  *
7878
- * @returns jQuery.Deferred.promise object that when resolved, returns the newly created control
8167
+ * @returns Resolves with the newly created control
7879
8168
  */
7880
8169
  addShellSubHeader(
7881
8170
  /**
@@ -7933,7 +8222,7 @@ declare namespace sap {
7933
8222
  *
7934
8223
  * @since 1.48
7935
8224
  *
7936
- * @returns jQuery.Deferred.promise object that when resolved, returns the newly created control.
8225
+ * @returns Resolves with the newly created control
7937
8226
  */
7938
8227
  addSidePaneContent(
7939
8228
  /**
@@ -8102,7 +8391,7 @@ declare namespace sap {
8102
8391
  *
8103
8392
  * @since 1.48
8104
8393
  *
8105
- * @returns jQuery.Deferred.promise object that when resolved, returns the newly created control
8394
+ * @returns Resolves with the newly created control
8106
8395
  */
8107
8396
  addUserAction(
8108
8397
  /**
@@ -8175,14 +8464,14 @@ declare namespace sap {
8175
8464
  */
8176
8465
  title: string;
8177
8466
  /**
8178
- * A function to be called that returns a {jQuery.Deferred.promise} object which consists of a {sap.ui.core.Control }
8467
+ * A function to be called that returns a {@link jQuery.Promise} object which consists of a {sap.ui.core.Control }
8179
8468
  * to be displayed in a follow-on dialog box. A SAPUI5 view instance can also be returned. The function
8180
8469
  * is called on each time the user opens the User Preferences dialog box.
8181
8470
  */
8182
8471
  content: Function;
8183
8472
  /**
8184
- * A function to be called which returns a {jQuery.Deferred.promise} object when the user clicks "save"
8185
- * in the User Preferences dialog box. If an error occurs, pass the error message via the {jQuery.Deferred.promise }
8473
+ * A function to be called which returns a {@link jQuery.Promise} object when the user clicks "save" in
8474
+ * the User Preferences dialog box. If an error occurs, pass the error message via the {@link jQuery.Promise }
8186
8475
  * object. Errors are displayed in the log.
8187
8476
  */
8188
8477
  onSave: Function;
@@ -8197,7 +8486,7 @@ declare namespace sap {
8197
8486
  provideEmptyWrapper: boolean;
8198
8487
  },
8199
8488
  /**
8200
- * A string to be presented as the value of the entry OR a function to be called which returns a {jQuery.Deferred.promise }
8489
+ * A string to be presented as the value of the entry OR a function to be called which returns a {@link jQuery.Promise }
8201
8490
  * object.
8202
8491
  */
8203
8492
  value: string | Function
@@ -8573,7 +8862,7 @@ declare namespace sap {
8573
8862
  *
8574
8863
  * @since 1.48
8575
8864
  *
8576
- * @returns jQuery.deferred.promise object that when resolved, returns the newly created control
8865
+ * @returns Resolves with the newly created control
8577
8866
  */
8578
8867
  setShellFooter(
8579
8868
  /**
@@ -8863,6 +9152,21 @@ declare namespace sap {
8863
9152
  | string
8864
9153
  | sap.ui.base.ManagedObject.PropertyBindingInfo;
8865
9154
 
9155
+ /**
9156
+ * Specifies the contentProviderLabel of the appBox.
9157
+ */
9158
+ contentProviderLabel?:
9159
+ | string
9160
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
9161
+
9162
+ /**
9163
+ * Specifies the if the contentProviderLabel of the appBox is shown.
9164
+ */
9165
+ showContentProviderLabel?:
9166
+ | boolean
9167
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
9168
+ | `{${string}}`;
9169
+
8866
9170
  /**
8867
9171
  * The pinButton aggregation that can contain the pin button.
8868
9172
  */
@@ -8884,14 +9188,12 @@ declare namespace sap {
8884
9188
  interface AppBox$PressEventParameters {}
8885
9189
 
8886
9190
  /**
8887
- * Add your documentation for the new ui/appfinder/AppBox
9191
+ * Constructor for a new ui/appfinder/AppBox.
8888
9192
  *
8889
9193
  * @deprecated (since 1.120)
8890
9194
  */
8891
9195
  class AppBox extends sap.ui.core.Control {
8892
9196
  /**
8893
- * Constructor for a new ui/appfinder/AppBox.
8894
- *
8895
9197
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
8896
9198
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
8897
9199
  * of the syntax of the settings object.
@@ -8899,12 +9201,12 @@ declare namespace sap {
8899
9201
  constructor(
8900
9202
  /**
8901
9203
  * initial settings for the new control
9204
+ *
9205
+ * Add your documentation for the new ui/appfinder/AppBox
8902
9206
  */
8903
9207
  mSettings?: sap.ushell.ui.appfinder.$AppBoxSettings
8904
9208
  );
8905
9209
  /**
8906
- * Constructor for a new ui/appfinder/AppBox.
8907
- *
8908
9210
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
8909
9211
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
8910
9212
  * of the syntax of the settings object.
@@ -8916,6 +9218,8 @@ declare namespace sap {
8916
9218
  sId?: string,
8917
9219
  /**
8918
9220
  * initial settings for the new control
9221
+ *
9222
+ * Add your documentation for the new ui/appfinder/AppBox
8919
9223
  */
8920
9224
  mSettings?: sap.ushell.ui.appfinder.$AppBoxSettings
8921
9225
  );
@@ -9117,6 +9421,17 @@ declare namespace sap {
9117
9421
  */
9118
9422
  mParameters?: object
9119
9423
  ): this;
9424
+ /**
9425
+ * Gets current value of property {@link #getContentProviderLabel contentProviderLabel}.
9426
+ *
9427
+ * Specifies the contentProviderLabel of the appBox.
9428
+ *
9429
+ * Default value is `empty string`.
9430
+ *
9431
+ *
9432
+ * @returns Value of property `contentProviderLabel`
9433
+ */
9434
+ getContentProviderLabel(): string;
9120
9435
  /**
9121
9436
  * Gets current value of property {@link #getIcon icon}.
9122
9437
  *
@@ -9141,6 +9456,17 @@ declare namespace sap {
9141
9456
  * The pinButton aggregation that can contain the pin button.
9142
9457
  */
9143
9458
  getPinButton(): sap.m.Button;
9459
+ /**
9460
+ * Gets current value of property {@link #getShowContentProviderLabel showContentProviderLabel}.
9461
+ *
9462
+ * Specifies the if the contentProviderLabel of the appBox is shown.
9463
+ *
9464
+ * Default value is `false`.
9465
+ *
9466
+ *
9467
+ * @returns Value of property `showContentProviderLabel`
9468
+ */
9469
+ getShowContentProviderLabel(): boolean;
9144
9470
  /**
9145
9471
  * Gets current value of property {@link #getSubtitle subtitle}.
9146
9472
  *
@@ -9168,6 +9494,24 @@ declare namespace sap {
9168
9494
  * @returns Value of property `url`
9169
9495
  */
9170
9496
  getUrl(): string;
9497
+ /**
9498
+ * Sets a new value for property {@link #getContentProviderLabel contentProviderLabel}.
9499
+ *
9500
+ * Specifies the contentProviderLabel of the appBox.
9501
+ *
9502
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9503
+ *
9504
+ * Default value is `empty string`.
9505
+ *
9506
+ *
9507
+ * @returns Reference to `this` in order to allow method chaining
9508
+ */
9509
+ setContentProviderLabel(
9510
+ /**
9511
+ * New value for property `contentProviderLabel`
9512
+ */
9513
+ sContentProviderLabel?: string
9514
+ ): this;
9171
9515
  /**
9172
9516
  * Sets a new value for property {@link #getIcon icon}.
9173
9517
  *
@@ -9212,6 +9556,24 @@ declare namespace sap {
9212
9556
  */
9213
9557
  oPinButton: sap.m.Button
9214
9558
  ): this;
9559
+ /**
9560
+ * Sets a new value for property {@link #getShowContentProviderLabel showContentProviderLabel}.
9561
+ *
9562
+ * Specifies the if the contentProviderLabel of the appBox is shown.
9563
+ *
9564
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9565
+ *
9566
+ * Default value is `false`.
9567
+ *
9568
+ *
9569
+ * @returns Reference to `this` in order to allow method chaining
9570
+ */
9571
+ setShowContentProviderLabel(
9572
+ /**
9573
+ * New value for property `showContentProviderLabel`
9574
+ */
9575
+ bShowContentProviderLabel?: boolean
9576
+ ): this;
9215
9577
  /**
9216
9578
  * Sets a new value for property {@link #getSubtitle subtitle}.
9217
9579
  *
@@ -9956,10 +10318,11 @@ declare namespace sap {
9956
10318
 
9957
10319
  interface TileState$PressEventParameters {}
9958
10320
 
10321
+ /**
10322
+ * Constructor for a new ui/launchpad/ActionItem.
10323
+ */
9959
10324
  class ActionItem extends sap.m.Button {
9960
10325
  /**
9961
- * Constructor for a new ui/launchpad/ActionItem.
9962
- *
9963
10326
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
9964
10327
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
9965
10328
  * of the syntax of the settings object.
@@ -9971,8 +10334,6 @@ declare namespace sap {
9971
10334
  mSettings?: sap.ushell.ui.launchpad.$ActionItemSettings
9972
10335
  );
9973
10336
  /**
9974
- * Constructor for a new ui/launchpad/ActionItem.
9975
- *
9976
10337
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
9977
10338
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
9978
10339
  * of the syntax of the settings object.
@@ -10201,12 +10562,12 @@ declare namespace sap {
10201
10562
  ): this;
10202
10563
  }
10203
10564
  /**
10565
+ * Constructor for "sap.ushell.ui.launchpad.DashboardGroupsContainer".
10566
+ *
10204
10567
  * @deprecated (since 1.120)
10205
10568
  */
10206
10569
  class DashboardGroupsContainer extends sap.ui.core.Control {
10207
10570
  /**
10208
- * Constructor for "sap.ushell.ui.launchpad.DashboardGroupsContainer".
10209
- *
10210
10571
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
10211
10572
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
10212
10573
  * of the syntax of the settings object.
@@ -10218,8 +10579,6 @@ declare namespace sap {
10218
10579
  mSettings?: sap.ushell.ui.launchpad.$DashboardGroupsContainerSettings
10219
10580
  );
10220
10581
  /**
10221
- * Constructor for "sap.ushell.ui.launchpad.DashboardGroupsContainer".
10222
- *
10223
10582
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
10224
10583
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
10225
10584
  * of the syntax of the settings object.
@@ -10471,13 +10830,13 @@ declare namespace sap {
10471
10830
  ): this;
10472
10831
  }
10473
10832
  /**
10833
+ * Constructor for a new ui/launchpad/LinkTileWrapper. A link tile to be displayed in the tile container.
10834
+ * This control acts as container for specialized tile implementations.
10835
+ *
10474
10836
  * @deprecated (since 1.120)
10475
10837
  */
10476
10838
  class LinkTileWrapper extends sap.ui.core.Control {
10477
10839
  /**
10478
- * Constructor for a new ui/launchpad/LinkTileWrapper. A link tile to be displayed in the tile container.
10479
- * This control acts as container for specialized tile implementations.
10480
- *
10481
10840
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
10482
10841
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
10483
10842
  * of the syntax of the settings object.
@@ -10489,9 +10848,6 @@ declare namespace sap {
10489
10848
  mSettings?: sap.ushell.ui.launchpad.$LinkTileWrapperSettings
10490
10849
  );
10491
10850
  /**
10492
- * Constructor for a new ui/launchpad/LinkTileWrapper. A link tile to be displayed in the tile container.
10493
- * This control acts as container for specialized tile implementations.
10494
- *
10495
10851
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
10496
10852
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
10497
10853
  * of the syntax of the settings object.
@@ -11231,13 +11587,13 @@ declare namespace sap {
11231
11587
  ): this;
11232
11588
  }
11233
11589
  /**
11590
+ * Constructor for a new ui/launchpad/TileState. The tile state control that displays loading indicator,
11591
+ * while tile view is loading and failed status in case tile view is not available.
11592
+ *
11234
11593
  * @deprecated (since 1.120)
11235
11594
  */
11236
11595
  class TileState extends sap.ui.core.Control {
11237
11596
  /**
11238
- * Constructor for a new ui/launchpad/TileState. The tile state control that displays loading indicator,
11239
- * while tile view is loading and failed status in case tile view is not available.
11240
- *
11241
11597
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
11242
11598
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
11243
11599
  * of the syntax of the settings object.
@@ -11249,9 +11605,6 @@ declare namespace sap {
11249
11605
  mSettings?: sap.ushell.ui.launchpad.$TileStateSettings
11250
11606
  );
11251
11607
  /**
11252
- * Constructor for a new ui/launchpad/TileState. The tile state control that displays loading indicator,
11253
- * while tile view is loading and failed status in case tile view is not available.
11254
- *
11255
11608
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
11256
11609
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
11257
11610
  * of the syntax of the settings object.
@@ -11398,6 +11751,41 @@ declare namespace sap {
11398
11751
  sState?: string
11399
11752
  ): this;
11400
11753
  }
11754
+ /**
11755
+ * Denotes display states of the viewport
11756
+ *
11757
+ * This enum is part of the 'sap/ushell/library' module export and must be accessed by the property 'ui.launchpad.ViewPortState'.
11758
+ */
11759
+ enum ViewPortState {
11760
+ /**
11761
+ * Indicates state, when only center content is in the viewport.
11762
+ */
11763
+ Center = "Center",
11764
+ /**
11765
+ * Indicates state, when the center content as well as a part from the left content is in the viewport.
11766
+ */
11767
+ CenterLeft = "CenterLeft",
11768
+ /**
11769
+ * Indicates state, when the center content as well as a part from the right content is in the viewport.
11770
+ */
11771
+ CenterRight = "CenterRight",
11772
+ /**
11773
+ * Indicates state, when only left content is in the viewport.
11774
+ */
11775
+ Left = "Left",
11776
+ /**
11777
+ * Indicates state, when the left content as well as a part from the center content is in the viewport.
11778
+ */
11779
+ LeftCenter = "LeftCenter",
11780
+ /**
11781
+ * Indicates state, when only right content is in the viewport.
11782
+ */
11783
+ Right = "Right",
11784
+ /**
11785
+ * Indicates state, when the right content as well as a part from the center content is in the viewport.
11786
+ */
11787
+ RightCenter = "RightCenter",
11788
+ }
11401
11789
 
11402
11790
  type ActionItem$AfterRenderingEvent = sap.ui.base.Event<
11403
11791
  ActionItem$AfterRenderingEventParameters,
@@ -11903,15 +12291,14 @@ declare namespace sap {
11903
12291
 
11904
12292
  namespace tile {
11905
12293
  /**
11906
- * An applauncher tile for simple, static apps, displaying title, subtitle, an icon and additional information
12294
+ * Constructor for a new ui/tile/StaticTile. An applauncher tile for simple, static apps, displaying title,
12295
+ * subtitle, an icon and additional information
11907
12296
  *
11908
12297
  * @since 1.15.0
11909
12298
  * @deprecated (since 1.120)
11910
12299
  */
11911
12300
  class StaticTile /* was: sap.ushell.ui.tile.TileBase */ extends Object {
11912
12301
  /**
11913
- * Constructor for a new ui/tile/StaticTile.
11914
- *
11915
12302
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
11916
12303
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
11917
12304
  * of the syntax of the settings object.
@@ -11966,44 +12353,6 @@ declare namespace sap {
11966
12353
  }
11967
12354
 
11968
12355
  namespace ui5service {
11969
- /**
11970
- * @deprecated (since 1.70) - Support for this service has been discontinued.
11971
- */
11972
- interface UserStatus
11973
- extends /* was: sap.ui.core.service.Service */ Object {
11974
- /**
11975
- * Creates a new subclass of class sap.ushell.ui5service.UserStatus with name `sClassName` and enriches
11976
- * it with the information contained in `oClassInfo`.
11977
- *
11978
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.service.Service.extend}.
11979
- *
11980
- *
11981
- * @returns Created class / constructor function
11982
- */
11983
- extend(
11984
- /**
11985
- * Name of the class being created
11986
- */
11987
- sClassName: string,
11988
- /**
11989
- * Object literal with information about the class
11990
- */
11991
- oClassInfo?: object,
11992
- /**
11993
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
11994
- * used by this class
11995
- */
11996
- FNMetaImpl?: Function
11997
- ): Function;
11998
- /**
11999
- * Returns a metadata object for class sap.ushell.ui5service.UserStatus.
12000
- *
12001
- *
12002
- * @returns Metadata object describing this class
12003
- */
12004
- getMetadata(): sap.ui.base.Metadata;
12005
- }
12006
-
12007
12356
  /**
12008
12357
  * The Unified Shell's ShellUIService service.
12009
12358
  *
@@ -12032,7 +12381,7 @@ declare namespace sap {
12032
12381
  *
12033
12382
  * // Component.js (the app root component)
12034
12383
  * ...
12035
- * this.getServiceAsync("ShellUIService").then( // promise is returned
12384
+ * this.getService("ShellUIService").then( // promise is returned
12036
12385
  * function (oService) {
12037
12386
  * oService.setTitle("Application Title");
12038
12387
  * },
@@ -12227,16 +12576,113 @@ declare namespace sap {
12227
12576
  sTitle?: string
12228
12577
  ): void;
12229
12578
  }
12230
- }
12579
+ /**
12580
+ * @deprecated (since 1.70) - Support for this service has been discontinued.
12581
+ */
12582
+ class UserStatus /* was: sap.ui.core.service.Service */ extends Object {
12583
+ constructor();
12231
12584
 
12585
+ /**
12586
+ * Creates a new subclass of class sap.ushell.ui5service.UserStatus with name `sClassName` and enriches
12587
+ * it with the information contained in `oClassInfo`.
12588
+ *
12589
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.service.Service.extend}.
12590
+ *
12591
+ *
12592
+ * @returns Created class / constructor function
12593
+ */
12594
+ static extend<T extends Record<string, unknown>>(
12595
+ /**
12596
+ * Name of the class being created
12597
+ */
12598
+ sClassName: string,
12599
+ /**
12600
+ * Object literal with information about the class
12601
+ */
12602
+ oClassInfo?: sap.ClassInfo<T, sap.ushell.ui5service.UserStatus>,
12603
+ /**
12604
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
12605
+ * used by this class
12606
+ */
12607
+ FNMetaImpl?: Function
12608
+ ): Function;
12609
+ /**
12610
+ * Returns a metadata object for class sap.ushell.ui5service.UserStatus.
12611
+ *
12612
+ *
12613
+ * @returns Metadata object describing this class
12614
+ */
12615
+ static getMetadata(): sap.ui.base.Metadata;
12616
+ /**
12617
+ * Attaches an event handler fnFunction to be called upon the 'statusChanged' event. Event is fired when
12618
+ * the setStatus method is called.
12619
+ *
12620
+ * @since 1.46
12621
+ * @deprecated (since 1.70)
12622
+ */
12623
+ attachStatusChanged(
12624
+ /**
12625
+ * The function to be called when the event occurs.
12626
+ */
12627
+ fnFunction?: Function
12628
+ ): void;
12629
+ /**
12630
+ * Detaches an event handler from the 'statusChanged' event.
12631
+ *
12632
+ * @since 1.46
12633
+ * @deprecated (since 1.70)
12634
+ */
12635
+ detachStatusChanged(
12636
+ /**
12637
+ * Event handler to be detached.
12638
+ */
12639
+ fnFunction: Function
12640
+ ): void;
12641
+ /**
12642
+ * Enable the User Status service (online status)
12643
+ *
12644
+ * If the user has never agreed to share their online status, then the method will show the opt-in screen
12645
+ * to the user. If the user already agreed to share their online status, the setStatus method will be called
12646
+ * with the default online status that was set by the user. If the user already declined to share their
12647
+ * online status, the setStatus method will be called with a null value.
12648
+ *
12649
+ * @since 1.46
12650
+ * @deprecated (since 1.70)
12651
+ */
12652
+ setEnabled(
12653
+ /**
12654
+ * boolean.
12655
+ */
12656
+ bEnable: boolean
12657
+ ): void;
12658
+ /**
12659
+ * Publish the user status. This method is used to publish the status to other components.
12660
+ *
12661
+ * The publication of the status by firing the 'statusChanged' event will happen when all the following
12662
+ * apply: 1) the User Status service is enabled 2) the status is null or exists in the list of available
12663
+ * statuses (sap.ushell.ui5service.UserStatus.prototype.AvailableStatus) 3) the user has agreed to share
12664
+ * their online status
12665
+ *
12666
+ * @since 1.46
12667
+ * @deprecated (since 1.70)
12668
+ */
12669
+ setStatus(
12670
+ /**
12671
+ * sap.ushell.ui5service.UserStatus.prototype.AvailableStatus
12672
+ */
12673
+ oNewStatus: object
12674
+ ): void;
12675
+ }
12676
+ }
12232
12677
  /**
12233
12678
  * The Unified Shell's container. Manages renderers, services, and adapters. The container is designed to
12234
12679
  * be a singleton, therefore instead of creating an instance, access the central one via `sap.ushell.Container`.
12680
+ * See:
12681
+ * sap.ushell.bootstrap
12235
12682
  *
12236
12683
  * @since 1.15.0
12237
12684
  */
12238
- class Container {
12239
- constructor();
12685
+ interface Container {
12240
12686
  /**
12241
12687
  * An enumeration for the application work protect mode state.
12242
12688
  *
@@ -12293,7 +12739,7 @@ declare namespace sap {
12293
12739
  * let all pending requests for the current realm fail. As a side-effect, it also calls `destroy` on the
12294
12740
  * logon frame provider.
12295
12741
  * See:
12296
- * sap.ushell.services.Container#setLogonFrameProvider
12742
+ * sap.ushell.Container#setLogonFrameProvider
12297
12743
  *
12298
12744
  * @since 1.21.2
12299
12745
  * @deprecated (since 1.120)
@@ -12393,9 +12839,9 @@ declare namespace sap {
12393
12839
  * @since 1.21.1
12394
12840
  * @deprecated (since 1.120)
12395
12841
  *
12396
- * @returns A `jQuery.Deferred` object's promise receiving the dirty state (see {@link sap.ushell.Container.DirtyState}).
12842
+ * @returns Resolves the dirty state (see {@link sap.ushell.Container.DirtyState}).
12397
12843
  */
12398
- getGlobalDirty(): jQuery.Deferred;
12844
+ getGlobalDirty(): jQuery.Promise;
12399
12845
  /**
12400
12846
  * Gets a renderer instance for the given renderer name, that was created by the createRenderer method.
12401
12847
  *
@@ -12475,7 +12921,7 @@ declare namespace sap {
12475
12921
  *
12476
12922
  * @returns the service or, in asynchronous mode, a Promise that returns the service
12477
12923
  */
12478
- getService(
12924
+ getService<ServiceType extends sap.ushell.services.Service>(
12479
12925
  /**
12480
12926
  * The service name, such as "Menu"
12481
12927
  */
@@ -12488,7 +12934,7 @@ declare namespace sap {
12488
12934
  * if true, the adapter is loaded asynchronously and a Promise is returned. (since 1.55.0)
12489
12935
  */
12490
12936
  bAsync?: boolean
12491
- ): object | Promise<object>;
12937
+ ): ServiceType | Promise<ServiceType>;
12492
12938
  /**
12493
12939
  * Returns a Promise that resolves a service with the given name, creating it if necessary. Services are
12494
12940
  * singleton objects identified by their (resulting) name.
@@ -12547,7 +12993,7 @@ declare namespace sap {
12547
12993
  *
12548
12994
  * @returns a Promise that returns the requested service
12549
12995
  */
12550
- getServiceAsync(
12996
+ getServiceAsync<ServiceType extends sap.ushell.services.Service>(
12551
12997
  /**
12552
12998
  * The service name, such as "Menu"
12553
12999
  */
@@ -12556,18 +13002,7 @@ declare namespace sap {
12556
13002
  * A parameter which is passed to the service constructor and every adapter constructor.
12557
13003
  */
12558
13004
  sParameter?: string
12559
- ): Promise<object>;
12560
- /**
12561
- * Logs out the current user from all relevant back-end systems, including the logon system itself. This
12562
- * member represents the default native implementation of logout. If SessionHandler was created, we register
12563
- * the alternate logout function using registerLogout function.
12564
- *
12565
- * @since 1.15.0
12566
- * @deprecated (since 1.120)
12567
- *
12568
- * @returns A `jQuery.promise` to be resolved when logout is finished, even when it fails.
12569
- */
12570
- logout(): jQuery.Deferred;
13005
+ ): Promise<ServiceType>;
12571
13006
  /**
12572
13007
  * Register the work protection dirty callback function. In the work protect mechanism, each platform can
12573
13008
  * register their own method in order to check if data was changed during the session, and notify the container
@@ -12609,15 +13044,14 @@ declare namespace sap {
12609
13044
  bIsDirty?: boolean
12610
13045
  ): void;
12611
13046
  }
13047
+
12612
13048
  /**
12613
- * A representation of a system
13049
+ * A representation of a system Constructs a new system object representing a system used in the Unified
13050
+ * Shell.
12614
13051
  *
12615
13052
  * @since 1.15.0
12616
13053
  */
12617
13054
  class System {
12618
- /**
12619
- * Constructs a new system object representing a system used in the Unified Shell.
12620
- */
12621
13055
  constructor(
12622
13056
  /**
12623
13057
  * An object containing the system data
@@ -12641,6 +13075,8 @@ declare namespace sap {
12641
13075
  }
12642
13076
  /**
12643
13077
  * Denotes the types of the content nodes.
13078
+ *
13079
+ * This enum is part of the 'sap/ushell/library' module export and must be accessed by the property 'ContentNodeType'.
12644
13080
  */
12645
13081
  enum ContentNodeType {
12646
13082
  /**
@@ -12660,6 +13096,8 @@ declare namespace sap {
12660
13096
  }
12661
13097
  /**
12662
13098
  * The state of a navigation operation
13099
+ *
13100
+ * This enum is part of the 'sap/ushell/library' module export and must be accessed by the property 'NavigationState'.
12663
13101
  */
12664
13102
  enum NavigationState {
12665
13103
  Finished = "Finished",
@@ -12669,6 +13107,8 @@ declare namespace sap {
12669
13107
  }
12670
13108
 
12671
13109
  interface IUI5DefineDependencyNames {
13110
+ "sap/ushell/api/RTA": undefined;
13111
+
12672
13112
  "sap/ushell/components/factsheet/controls/PictureTile": undefined;
12673
13113
 
12674
13114
  "sap/ushell/components/factsheet/controls/PictureViewer": undefined;
@@ -12707,6 +13147,8 @@ declare namespace sap {
12707
13147
 
12708
13148
  "sap/ushell/services/Configuration": undefined;
12709
13149
 
13150
+ "sap/ushell/services/ContentExtensionAdapterFactory": undefined;
13151
+
12710
13152
  "sap/ushell/services/CrossApplicationNavigation": undefined;
12711
13153
 
12712
13154
  "sap/ushell/services/EndUserFeedback": undefined;
@@ -12717,8 +13159,6 @@ declare namespace sap {
12717
13159
 
12718
13160
  "sap/ushell/services/Extension/Footer": undefined;
12719
13161
 
12720
- "sap/ushell/services/Extension/Header": undefined;
12721
-
12722
13162
  "sap/ushell/services/Extension/Item": undefined;
12723
13163
 
12724
13164
  "sap/ushell/services/Extension/SidePane": undefined;
@@ -12789,6 +13229,8 @@ declare namespace sap {
12789
13229
 
12790
13230
  "sap/ushell/ui/launchpad/TileState": undefined;
12791
13231
 
13232
+ "sap/ushell/ui/launchpad/VizInstanceBase": undefined;
13233
+
12792
13234
  "sap/ushell/ui/shell/ToolAreaItem": undefined;
12793
13235
 
12794
13236
  "sap/ushell/ui/tile/StaticTile": undefined;