@sapui5/ts-types-esm 1.132.1 → 1.134.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 (68) hide show
  1. package/package.json +1 -1
  2. package/types/sap.apf.d.ts +12 -11
  3. package/types/sap.ca.ui.d.ts +413 -415
  4. package/types/sap.chart.d.ts +6 -6
  5. package/types/sap.collaboration.d.ts +31 -31
  6. package/types/sap.cux.home.d.ts +927 -110
  7. package/types/sap.esh.search.ui.d.ts +45 -1
  8. package/types/sap.f.d.ts +211 -183
  9. package/types/sap.fe.base.d.ts +1 -1
  10. package/types/sap.fe.controls.d.ts +1 -1
  11. package/types/sap.fe.core.d.ts +40 -11
  12. package/types/sap.fe.ina.d.ts +1 -1
  13. package/types/sap.fe.macros.d.ts +141 -99
  14. package/types/sap.fe.navigation.d.ts +3 -3
  15. package/types/sap.fe.placeholder.d.ts +1 -1
  16. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  17. package/types/sap.fe.templates.d.ts +1 -1
  18. package/types/sap.fe.test.d.ts +3 -8
  19. package/types/sap.fe.tools.d.ts +1 -1
  20. package/types/sap.feedback.ui.d.ts +1 -1
  21. package/types/sap.gantt.d.ts +576 -464
  22. package/types/sap.insights.d.ts +3 -3
  23. package/types/sap.m.d.ts +2574 -1193
  24. package/types/sap.makit.d.ts +182 -182
  25. package/types/sap.me.d.ts +25 -27
  26. package/types/sap.ndc.d.ts +1 -1
  27. package/types/sap.ovp.d.ts +1 -1
  28. package/types/sap.rules.ui.d.ts +41 -41
  29. package/types/sap.sac.df.d.ts +465 -193
  30. package/types/sap.suite.ui.commons.d.ts +432 -487
  31. package/types/sap.suite.ui.generic.template.d.ts +80 -37
  32. package/types/sap.suite.ui.microchart.d.ts +55 -79
  33. package/types/sap.tnt.d.ts +335 -20
  34. package/types/sap.ui.codeeditor.d.ts +9 -7
  35. package/types/sap.ui.commons.d.ts +326 -335
  36. package/types/sap.ui.comp.d.ts +432 -445
  37. package/types/sap.ui.core.d.ts +46978 -46714
  38. package/types/sap.ui.dt.d.ts +1 -1
  39. package/types/sap.ui.export.d.ts +1 -1
  40. package/types/sap.ui.fl.d.ts +5 -5
  41. package/types/sap.ui.generic.app.d.ts +83 -66
  42. package/types/sap.ui.generic.template.d.ts +1 -1
  43. package/types/sap.ui.integration.d.ts +322 -236
  44. package/types/sap.ui.layout.d.ts +90 -104
  45. package/types/sap.ui.mdc.d.ts +393 -153
  46. package/types/sap.ui.richtexteditor.d.ts +48 -8
  47. package/types/sap.ui.rta.d.ts +76 -1
  48. package/types/sap.ui.suite.d.ts +14 -14
  49. package/types/sap.ui.support.d.ts +2 -2
  50. package/types/sap.ui.table.d.ts +219 -197
  51. package/types/sap.ui.testrecorder.d.ts +1 -1
  52. package/types/sap.ui.unified.d.ts +170 -158
  53. package/types/sap.ui.ux3.d.ts +113 -117
  54. package/types/sap.ui.vbm.d.ts +391 -60
  55. package/types/sap.ui.vk.d.ts +138 -135
  56. package/types/sap.ui.vtm.d.ts +112 -103
  57. package/types/sap.ui.webc.common.d.ts +7 -7
  58. package/types/sap.ui.webc.fiori.d.ts +164 -176
  59. package/types/sap.ui.webc.main.d.ts +527 -531
  60. package/types/sap.uiext.inbox.d.ts +43 -43
  61. package/types/sap.ushell.d.ts +246 -126
  62. package/types/sap.ushell_abap.d.ts +1 -1
  63. package/types/sap.uxap.d.ts +39 -51
  64. package/types/sap.viz.d.ts +2782 -2858
  65. package/types/sap.webanalytics.core.d.ts +1 -1
  66. package/types/sap.zen.commons.d.ts +17 -17
  67. package/types/sap.zen.crosstab.d.ts +10 -10
  68. package/types/sap.zen.dsh.d.ts +11 -11
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.132.1
1
+ // For Library Version: 1.134.0
2
2
 
3
3
  declare module "sap/ushell/library" {
4
4
  /**
@@ -10,7 +10,7 @@ declare module "sap/ushell/library" {
10
10
  /**
11
11
  * A group of the classic homepage
12
12
  *
13
- * @deprecated (since 1.120)
13
+ * @deprecated As of version 1.120.
14
14
  */
15
15
  HomepageGroup = "HomepageGroup",
16
16
  /**
@@ -44,7 +44,7 @@ declare module "sap/ushell/library" {
44
44
  *
45
45
  * This enum is part of the 'sap/ushell/library' module export and must be accessed by the property 'ui.launchpad.ViewPortState'.
46
46
  *
47
- * @deprecated (since 1.120.0) - The ViewPortState is related to Fiori2 and not used anymore.
47
+ * @deprecated As of version 1.120.0. The ViewPortState is related to Fiori2 and not used anymore.
48
48
  */
49
49
  enum ViewPortState {
50
50
  /**
@@ -96,7 +96,7 @@ declare module "sap/ushell/components/factsheet/controls/PictureTile" {
96
96
  /**
97
97
  * Tile control embedding an image and allowing custom sizing
98
98
  *
99
- * @deprecated (since 1.22) - Please use {@link sap.m.Carousel} instead.
99
+ * @deprecated As of version 1.22. Please use {@link sap.m.Carousel} instead.
100
100
  *
101
101
  * PictureTile is used in PictureViewer control and is not meant to be consumed outside of PictureViewer
102
102
  * usage. PictureViewer was replacing the sap.m.Carousel as it wasn't supporting some versions of MS Internet
@@ -315,7 +315,7 @@ declare module "sap/ushell/components/factsheet/controls/PictureTile" {
315
315
  /**
316
316
  * Describes the settings that can be provided to the PictureTile constructor.
317
317
  *
318
- * @deprecated (since 1.22) - Please use {@link sap.m.Carousel} instead.
318
+ * @deprecated As of version 1.22. Please use {@link sap.m.Carousel} instead.
319
319
  *
320
320
  * PictureTile is used in PictureViewer control and is not meant to be consumed outside of PictureViewer
321
321
  * usage. PictureViewer was replacing the sap.m.Carousel as it wasn't supporting some versions of MS Internet
@@ -366,9 +366,9 @@ declare module "sap/ushell/components/factsheet/controls/PictureViewer" {
366
366
  /**
367
367
  * Picture viewer control relying on the TileContainer control
368
368
  *
369
- * @deprecated (since 1.22) - Please use {@link sap.m.Carousel} instead. PictureViewer was replacing the
370
- * Carousel as it wasn't supporting some versions of MS Internet Explorer. Now, the sap.m.Carousel is fully
371
- * functional, please use sap.m.Carousel instead. This control will not be supported anymore.
369
+ * @deprecated As of version 1.22. Please use {@link sap.m.Carousel} instead. PictureViewer was replacing
370
+ * the Carousel as it wasn't supporting some versions of MS Internet Explorer. Now, the sap.m.Carousel is
371
+ * fully functional, please use sap.m.Carousel instead. This control will not be supported anymore.
372
372
  */
373
373
  export default class PictureViewer extends TileContainer {
374
374
  /**
@@ -436,7 +436,7 @@ declare module "sap/ushell/components/factsheet/controls/PictureViewer" {
436
436
  /**
437
437
  * Adds some item `oItem` to the aggregation named `items`. Deprecated, use aggregation "tiles".
438
438
  *
439
- * @deprecated (since 1.18)
439
+ * @deprecated As of version 1.18.
440
440
  *
441
441
  * @returns `this` to allow method chaining
442
442
  */
@@ -595,7 +595,7 @@ declare module "sap/ushell/components/factsheet/controls/PictureViewer" {
595
595
  * is actually created with its own ID and added to the internal TileContainer. Deprecated, use aggregation
596
596
  * "tiles".
597
597
  *
598
- * @deprecated (since 1.18)
598
+ * @deprecated As of version 1.18.
599
599
  *
600
600
  * @returns `this` to allow method chaining
601
601
  */
@@ -685,9 +685,9 @@ declare module "sap/ushell/components/factsheet/controls/PictureViewer" {
685
685
  /**
686
686
  * Describes the settings that can be provided to the PictureViewer constructor.
687
687
  *
688
- * @deprecated (since 1.22) - Please use {@link sap.m.Carousel} instead. PictureViewer was replacing the
689
- * Carousel as it wasn't supporting some versions of MS Internet Explorer. Now, the sap.m.Carousel is fully
690
- * functional, please use sap.m.Carousel instead. This control will not be supported anymore.
688
+ * @deprecated As of version 1.22. Please use {@link sap.m.Carousel} instead. PictureViewer was replacing
689
+ * the Carousel as it wasn't supporting some versions of MS Internet Explorer. Now, the sap.m.Carousel is
690
+ * fully functional, please use sap.m.Carousel instead. This control will not be supported anymore.
691
691
  */
692
692
  export interface $PictureViewerSettings extends $TileContainerSettings {
693
693
  /**
@@ -733,10 +733,10 @@ declare module "sap/ushell/components/factsheet/controls/PictureViewerItem" {
733
733
  /**
734
734
  * Picture viewer control relying on the TileContainer control
735
735
  *
736
- * @deprecated (since 1.22) - Please use {@link sap.m.Carousel} instead. PictureViewerItem is used in PictureViewer
737
- * control and is not meant to be consumed outside of PictureViewer usage. PictureViewer was replacing the
738
- * Carousel as it wasn't supporting some versions of MS Internet Explorer. Now, the sap.m.Carousel is fully
739
- * functional, please use sap.m.Carousel instead. This control will not be supported anymore.
736
+ * @deprecated As of version 1.22. Please use {@link sap.m.Carousel} instead. PictureViewerItem is used
737
+ * in PictureViewer control and is not meant to be consumed outside of PictureViewer usage. PictureViewer
738
+ * was replacing the Carousel as it wasn't supporting some versions of MS Internet Explorer. Now, the sap.m.Carousel
739
+ * is fully functional, please use sap.m.Carousel instead. This control will not be supported anymore.
740
740
  */
741
741
  export default class PictureViewerItem extends Control {
742
742
  /**
@@ -849,10 +849,10 @@ declare module "sap/ushell/components/factsheet/controls/PictureViewerItem" {
849
849
  /**
850
850
  * Describes the settings that can be provided to the PictureViewerItem constructor.
851
851
  *
852
- * @deprecated (since 1.22) - Please use {@link sap.m.Carousel} instead. PictureViewerItem is used in PictureViewer
853
- * control and is not meant to be consumed outside of PictureViewer usage. PictureViewer was replacing the
854
- * Carousel as it wasn't supporting some versions of MS Internet Explorer. Now, the sap.m.Carousel is fully
855
- * functional, please use sap.m.Carousel instead. This control will not be supported anymore.
852
+ * @deprecated As of version 1.22. Please use {@link sap.m.Carousel} instead. PictureViewerItem is used
853
+ * in PictureViewer control and is not meant to be consumed outside of PictureViewer usage. PictureViewer
854
+ * was replacing the Carousel as it wasn't supporting some versions of MS Internet Explorer. Now, the sap.m.Carousel
855
+ * is fully functional, please use sap.m.Carousel instead. This control will not be supported anymore.
856
856
  */
857
857
  export interface $PictureViewerItemSettings extends $ControlSettings {
858
858
  src?: string | PropertyBindingInfo;
@@ -923,7 +923,7 @@ declare module "sap/ushell/Container" {
923
923
  * Attaches a listener to the rendererCreated event.
924
924
  *
925
925
  * @since 1.34.1
926
- * @deprecated (since 1.120)
926
+ * @deprecated As of version 1.120.
927
927
  */
928
928
  attachRendererCreatedEvent(
929
929
  /**
@@ -943,7 +943,7 @@ declare module "sap/ushell/Container" {
943
943
  * sap.ushell.Container#setLogonFrameProvider
944
944
  *
945
945
  * @since 1.21.2
946
- * @deprecated (since 1.120)
946
+ * @deprecated As of version 1.120.
947
947
  */
948
948
  cancelLogon(): void;
949
949
  /**
@@ -965,7 +965,7 @@ declare module "sap/ushell/Container" {
965
965
  * the renderer to use 100% height.
966
966
  *
967
967
  * @since 1.15.0
968
- * @deprecated (since 1.120.0)
968
+ * @deprecated As of version 1.120.0.
969
969
  *
970
970
  * @returns the renderer or Promise (in asynchronous mode)
971
971
  */
@@ -1011,7 +1011,7 @@ declare module "sap/ushell/Container" {
1011
1011
  * Detaches a listener from the rendererCreated event.
1012
1012
  *
1013
1013
  * @since 1.34.1
1014
- * @deprecated (since 1.120)
1014
+ * @deprecated As of version 1.120.
1015
1015
  */
1016
1016
  detachRendererCreatedEvent(
1017
1017
  /**
@@ -1027,7 +1027,7 @@ declare module "sap/ushell/Container" {
1027
1027
  * provider methods are ignored and the function simply returns 'true'.
1028
1028
  *
1029
1029
  * @since 1.27.0
1030
- * @deprecated (since 1.120)
1030
+ * @deprecated As of version 1.120.
1031
1031
  *
1032
1032
  * @returns The value of the dirty flag or the determined dirty state returned by the dirty state providers.
1033
1033
  */
@@ -1038,7 +1038,7 @@ declare module "sap/ushell/Container" {
1038
1038
  * All open UShell browser windows for the same origin are asked about their global dirty state.
1039
1039
  *
1040
1040
  * @since 1.21.1
1041
- * @deprecated (since 1.120)
1041
+ * @deprecated As of version 1.120.
1042
1042
  *
1043
1043
  * @returns Resolves the dirty state (see {@link sap.ushell.Container.DirtyState}).
1044
1044
  */
@@ -1047,7 +1047,7 @@ declare module "sap/ushell/Container" {
1047
1047
  * Gets a renderer instance for the given renderer name, that was created by the createRenderer method.
1048
1048
  *
1049
1049
  * @since 1.30.0
1050
- * @deprecated (since 1.120) - Use {@link sap.ushell.services.Extension} for shell extensions instead.
1050
+ * @deprecated As of version 1.120. Use {@link sap.ushell.services.Extension} for shell extensions instead.
1051
1051
  *
1052
1052
  * @returns the renderer with the specified name; the returned object is either a control (i.e. extend `sap.ui.core.Control`)
1053
1053
  * or a UI component (i.e. extend `sap.ui.core.UIComponent`), i.e. this method unwraps the renderer component
@@ -1118,7 +1118,7 @@ declare module "sap/ushell/Container" {
1118
1118
  * sap.ushell.services.ContainerInterface
1119
1119
  *
1120
1120
  * @since 1.15.0
1121
- * @deprecated (since 1.77) - Please use {@link #getServiceAsync} instead.
1121
+ * @deprecated As of version 1.77. Please use {@link #getServiceAsync} instead.
1122
1122
  *
1123
1123
  * @returns the service or, in asynchronous mode, a Promise that returns the service
1124
1124
  */
@@ -1284,7 +1284,7 @@ declare module "sap/ushell/renderers/fiori2/Renderer" {
1284
1284
  * by the Unified Shell's container only, others MUST call {@link sap.ushell.Container#getRenderer}.
1285
1285
  *
1286
1286
  * @since 1.15.0
1287
- * @deprecated (since 1.120.0) - Please use {@link sap.ushell.services.Extension} instead.
1287
+ * @deprecated As of version 1.120.0. Please use {@link sap.ushell.services.Extension} instead.
1288
1288
  */
1289
1289
  export default class Renderer extends UIComponent {
1290
1290
  /**
@@ -1324,7 +1324,7 @@ declare module "sap/ushell/renderers/fiori2/Renderer" {
1324
1324
  * If no launchpad state is provided, the content is added in all states.
1325
1325
  *
1326
1326
  * @since 1.30
1327
- * @deprecated (since 1.48) - Please use {@link #addUserAction} instead.
1327
+ * @deprecated As of version 1.48. Please use {@link #addUserAction} instead.
1328
1328
  *
1329
1329
  * @returns oItem - the created control
1330
1330
  */
@@ -1359,7 +1359,7 @@ declare module "sap/ushell/renderers/fiori2/Renderer" {
1359
1359
  * The EndUserFeedback dialog is opened via the user actions menu in the Fiori Launchpad shell header.
1360
1360
  *
1361
1361
  * @since 1.30
1362
- * @deprecated (since 1.93)
1362
+ * @deprecated As of version 1.93.
1363
1363
  */
1364
1364
  addEndUserFeedbackCustomUI(
1365
1365
  /**
@@ -1392,7 +1392,7 @@ declare module "sap/ushell/renderers/fiori2/Renderer" {
1392
1392
  * If no launchpad state is provided the content is added in all states.
1393
1393
  *
1394
1394
  * @since 1.30
1395
- * @deprecated (since 1.48) - Please use {@link #addFloatingButton} instead.
1395
+ * @deprecated As of version 1.48. Please use {@link #addFloatingButton} instead.
1396
1396
  *
1397
1397
  * @returns oItem - the created control
1398
1398
  */
@@ -1436,7 +1436,7 @@ declare module "sap/ushell/renderers/fiori2/Renderer" {
1436
1436
  * If no launchpad state is provided the content is added in all states.
1437
1437
  *
1438
1438
  * @since 1.48
1439
- * @deprecated (since 1.52)
1439
+ * @deprecated As of version 1.52.
1440
1440
  *
1441
1441
  * @returns Resolves with the newly created control
1442
1442
  */
@@ -1675,7 +1675,7 @@ declare module "sap/ushell/renderers/fiori2/Renderer" {
1675
1675
  * If no launchpad state is provided the content is added in all states.
1676
1676
  *
1677
1677
  * @since 1.30
1678
- * @deprecated (since 1.48) - Please use {@link #addSidePaneContent} instead.
1678
+ * @deprecated As of version 1.48. Please use {@link #addSidePaneContent} instead.
1679
1679
  *
1680
1680
  * @returns oItem - the created control
1681
1681
  */
@@ -1849,7 +1849,7 @@ declare module "sap/ushell/renderers/fiori2/Renderer" {
1849
1849
  * LaunchpadState
1850
1850
  *
1851
1851
  * @since 1.30
1852
- * @deprecated (since 1.48) - Please use {@link #addShellSubHeader} instead.
1852
+ * @deprecated As of version 1.48. Please use {@link #addShellSubHeader} instead.
1853
1853
  *
1854
1854
  * @returns The created control
1855
1855
  */
@@ -2064,7 +2064,7 @@ declare module "sap/ushell/renderers/fiori2/Renderer" {
2064
2064
  * This method returns the current state of the Viewport Container control.
2065
2065
  *
2066
2066
  * @since 1.37
2067
- * @deprecated (since 1.120.0) - This functionality was discontinued
2067
+ * @deprecated As of version 1.120.0. This functionality was discontinued
2068
2068
  *
2069
2069
  * @returns The current Viewport State.
2070
2070
  */
@@ -2107,7 +2107,7 @@ declare module "sap/ushell/renderers/fiori2/Renderer" {
2107
2107
  * If no launchpad state is provided the content is removed in all states.
2108
2108
  *
2109
2109
  * @since 1.30
2110
- * @deprecated (since 1.52)
2110
+ * @deprecated As of version 1.52.
2111
2111
  */
2112
2112
  hideFloatingActionButton(
2113
2113
  /**
@@ -2291,7 +2291,7 @@ declare module "sap/ushell/renderers/fiori2/Renderer" {
2291
2291
  *
2292
2292
  *
2293
2293
  * @since 1.30
2294
- * @deprecated (since 1.120.0) - Please use {@link #setShellFooter} instead.
2294
+ * @deprecated As of version 1.120.0. Please use {@link #setShellFooter} instead.
2295
2295
  */
2296
2296
  setFooter(
2297
2297
  /**
@@ -2323,7 +2323,7 @@ declare module "sap/ushell/renderers/fiori2/Renderer" {
2323
2323
  * 2. The control type resource is already loaded
2324
2324
  *
2325
2325
  * @since 1.42
2326
- * @deprecated (since 1.48) - Please use {@link #setShellFooter} instead.
2326
+ * @deprecated As of version 1.48. Please use {@link #setShellFooter} instead.
2327
2327
  *
2328
2328
  * @returns The created control
2329
2329
  */
@@ -2343,7 +2343,7 @@ declare module "sap/ushell/renderers/fiori2/Renderer" {
2343
2343
  * Sets the title in the Fiori Launchpad shell header.
2344
2344
  *
2345
2345
  * @since 1.30
2346
- * @deprecated (since 1.120.0) - Please use {@link sap.ushell.ui5service.ShellUIService#getTitle} instead.
2346
+ * @deprecated As of version 1.120.0. Please use {@link sap.ushell.ui5service.ShellUIService#getTitle} instead.
2347
2347
  */
2348
2348
  setHeaderTitle(
2349
2349
  /**
@@ -2365,7 +2365,7 @@ declare module "sap/ushell/renderers/fiori2/Renderer" {
2365
2365
  * LaunchpadState
2366
2366
  *
2367
2367
  * @since 1.38
2368
- * @deprecated (since 1.120.0) - This functionality was discontinued
2368
+ * @deprecated As of version 1.120.0. This functionality was discontinued
2369
2369
  */
2370
2370
  setHeaderVisibility(
2371
2371
  /**
@@ -2503,7 +2503,7 @@ declare module "sap/ushell/renderers/fiori2/Renderer" {
2503
2503
  *
2504
2504
  *
2505
2505
  * @since 1.30
2506
- * @deprecated (since 1.52) - Support for the FloatingActionButton has been discontinued.
2506
+ * @deprecated As of version 1.52. Support for the FloatingActionButton has been discontinued.
2507
2507
  */
2508
2508
  showFloatingActionButton(
2509
2509
  /**
@@ -2691,7 +2691,7 @@ declare module "sap/ushell/renderers/fiori2/Renderer" {
2691
2691
  /**
2692
2692
  * Describes the settings that can be provided to the Renderer constructor.
2693
2693
  *
2694
- * @deprecated (since 1.120.0) - Please use {@link sap.ushell.services.Extension} instead.
2694
+ * @deprecated As of version 1.120.0. Please use {@link sap.ushell.services.Extension} instead.
2695
2695
  */
2696
2696
  export interface $RendererSettings extends $UIComponentSettings {}
2697
2697
  }
@@ -2714,7 +2714,7 @@ declare module "sap/ushell/services/AppConfiguration" {
2714
2714
  * should be specified, otherwise the entry will be updated with a new timestamp Only applications of type
2715
2715
  * Search and Co-Pilot can set their icon.
2716
2716
  *
2717
- * @deprecated (since 1.120) - without replacement.
2717
+ * @deprecated As of version 1.120. without replacement.
2718
2718
  *
2719
2719
  * @returns Resolves the updated list of user recents.
2720
2720
  */
@@ -2729,7 +2729,7 @@ declare module "sap/ushell/services/AppConfiguration" {
2729
2729
  * application settings buttons with the new buttons. It is meant to be used by applications that want to
2730
2730
  * add their own settings button to the shell header.
2731
2731
  *
2732
- * @deprecated (since 1.120) - Use {@link sap.ushell.services.Extension#addUserAction} instead.
2732
+ * @deprecated As of version 1.120. Use {@link sap.ushell.services.Extension#addUserAction} instead.
2733
2733
  */
2734
2734
  addApplicationSettingsButtons(
2735
2735
  /**
@@ -2740,7 +2740,7 @@ declare module "sap/ushell/services/AppConfiguration" {
2740
2740
  /**
2741
2741
  * Sets the application screen size to full width
2742
2742
  *
2743
- * @deprecated (since 1.120.0) - Use the "sap.ui/fullWidth" property in the application's manifest.json
2743
+ * @deprecated As of version 1.120.0. Use {@link sap.ushell.ui5service.ShellUIService#setApplicationFullWidth }
2744
2744
  * instead.
2745
2745
  */
2746
2746
  setApplicationFullWidth(
@@ -2752,7 +2752,7 @@ declare module "sap/ushell/services/AppConfiguration" {
2752
2752
  /**
2753
2753
  * Sets the icons of the browser.
2754
2754
  *
2755
- * @deprecated (since 1.120.0) - Use {@link sap.ui.util.Mobile#setIcons} instead.
2755
+ * @deprecated As of version 1.120.0. Use {@link sap.ui.util.Mobile#setIcons} instead.
2756
2756
  */
2757
2757
  setIcons(
2758
2758
  /**
@@ -2929,6 +2929,10 @@ declare module "sap/ushell/services/AppLifeCycle" {
2929
2929
  * Version of the framework
2930
2930
  */
2931
2931
  appFrameworkVersion: string;
2932
+ /**
2933
+ * The FLP URL with the current hash included.
2934
+ */
2935
+ url: string;
2932
2936
  };
2933
2937
 
2934
2938
  /**
@@ -3096,7 +3100,7 @@ declare module "sap/ushell/services/Bookmark" {
3096
3100
  *
3097
3101
  *
3098
3102
  * @since 1.15.0
3099
- * @deprecated (since 1.119) - Please use {@link sap.ushell.services.BookmarkV2} instead.
3103
+ * @deprecated As of version 1.119. Please use {@link sap.ushell.services.BookmarkV2} instead.
3100
3104
  */
3101
3105
  export default class Bookmark extends sap.ushell.services.Service {
3102
3106
  /**
@@ -3110,7 +3114,7 @@ declare module "sap/ushell/services/Bookmark" {
3110
3114
  * sap.ushell.services.URLParsing#getShellHash
3111
3115
  *
3112
3116
  * @since 1.15.0
3113
- * @deprecated (since 1.119) - Please use {@link sap.ushell.services.BookmarkV2#addBookmark} instead.
3117
+ * @deprecated As of version 1.119. Please use {@link sap.ushell.services.BookmarkV2#addBookmark} instead.
3114
3118
  *
3115
3119
  * @returns Resolves on success, but rejects with a reason-message on failure to add the bookmark to the
3116
3120
  * specified or implied group. The promise gets resolved if personalization is disabled.
@@ -3220,7 +3224,7 @@ declare module "sap/ushell/services/Bookmark" {
3220
3224
  * HANA catalog unless data to look up a remote catalog is provided.
3221
3225
  *
3222
3226
  * @since 1.21.2
3223
- * @deprecated (since 1.112) - Please use {@link sap.ushell.services.BookmarkV2#addBookmark} instead.
3227
+ * @deprecated As of version 1.112. Please use {@link sap.ushell.services.BookmarkV2#addBookmark} instead.
3224
3228
  *
3225
3229
  * @returns Resolves if successful. In case of failure, an error message is passed. In launchpad spaces
3226
3230
  * mode the promise gets rejected.
@@ -3256,7 +3260,7 @@ declare module "sap/ushell/services/Bookmark" {
3256
3260
  * #addBookmark
3257
3261
  *
3258
3262
  * @since 1.17.1
3259
- * @deprecated (since 1.119) - Please use {@link sap.ushell.services.BookmarkV2#countBookmarks} instead.
3263
+ * @deprecated As of version 1.119. Please use {@link sap.ushell.services.BookmarkV2#countBookmarks} instead.
3260
3264
  *
3261
3265
  * @returns Resolves the count of existing bookmarks is provided (which might be zero). In case of failure,
3262
3266
  * an error message is passed.
@@ -3278,7 +3282,7 @@ declare module "sap/ushell/services/Bookmark" {
3278
3282
  * #countBookmarks
3279
3283
  *
3280
3284
  * @since 1.17.1
3281
- * @deprecated (since 1.119) - Please use {@link sap.ushell.services.BookmarkV2#deleteBookmarks} instead.
3285
+ * @deprecated As of version 1.119. Please use {@link sap.ushell.services.BookmarkV2#deleteBookmarks} instead.
3282
3286
  *
3283
3287
  * @returns Resolves the number of deleted bookmarks is provided (which might be zero). In case of failure,
3284
3288
  * an error message is passed.
@@ -3310,7 +3314,7 @@ declare module "sap/ushell/services/Bookmark" {
3310
3314
  * - children: Specifies sub-nodes
3311
3315
  *
3312
3316
  * @since 1.81
3313
- * @deprecated (since 1.119) - Please use {@link sap.ushell.services.BookmarkV2#getContentNodes} instead.
3317
+ * @deprecated As of version 1.119. Please use {@link sap.ushell.services.BookmarkV2#getContentNodes} instead.
3314
3318
  *
3315
3319
  * @returns Promise resolving the currently available content nodes.
3316
3320
  */
@@ -3324,7 +3328,7 @@ declare module "sap/ushell/services/Bookmark" {
3324
3328
  * #deleteBookmarks
3325
3329
  *
3326
3330
  * @since 1.17.1
3327
- * @deprecated (since 1.119) - Please use {@link sap.ushell.services.BookmarkV2#updateBookmarks} instead.
3331
+ * @deprecated As of version 1.119. Please use {@link sap.ushell.services.BookmarkV2#updateBookmarks} instead.
3328
3332
  *
3329
3333
  * @returns Resolves the number of updated bookmarks is provided (which might be zero). In case of failure,
3330
3334
  * an error message is passed.
@@ -3895,7 +3899,7 @@ declare module "sap/ushell/services/CrossApplicationNavigation" {
3895
3899
  * The same restrictions apply for the Application state.
3896
3900
  *
3897
3901
  * @since 1.15.0
3898
- * @deprecated (since 1.120) - Please use {@link sap.ushell.services.Navigation} instead
3902
+ * @deprecated As of version 1.120. Please use {@link sap.ushell.services.Navigation} instead
3899
3903
  */
3900
3904
  export default class CrossApplicationNavigation extends sap.ushell.services
3901
3905
  .Service {
@@ -4218,7 +4222,7 @@ declare module "sap/ushell/services/CrossApplicationNavigation" {
4218
4222
  * form factor of the current device.
4219
4223
  *
4220
4224
  * @since 1.19.0
4221
- * @deprecated (since 1.38) - Please use {@link #getLinks} instead.
4225
+ * @deprecated As of version 1.38. Please use {@link #getLinks} instead.
4222
4226
  *
4223
4227
  * @returns Resolves with an array of link objects containing (at least) the following properties:
4224
4228
  * ```javascript
@@ -4293,7 +4297,7 @@ declare module "sap/ushell/services/CrossApplicationNavigation" {
4293
4297
  * hash
4294
4298
  *
4295
4299
  * @since 1.15.0
4296
- * @deprecated (since 1.94) - Please use {@link #hrefForAppSpecificHashAsync} instead.
4300
+ * @deprecated As of version 1.94. Please use {@link #hrefForAppSpecificHashAsync} instead.
4297
4301
  *
4298
4302
  * @returns A string which can be put into the link tag, containing the current shell navigation target
4299
4303
  * and the specified application specific hash suffix
@@ -4330,7 +4334,7 @@ declare module "sap/ushell/services/CrossApplicationNavigation" {
4330
4334
  * segment must not be used as `shellHash` in the target definition of {@link sap.ushell.services.CrossApplicationNavigation#toExternal}
4331
4335
  *
4332
4336
  * @since 1.15.0
4333
- * @deprecated (since 1.98) - Please use {@link #hrefForExternalAsync} instead.
4337
+ * @deprecated As of version 1.98. Please use {@link #hrefForExternalAsync} instead.
4334
4338
  *
4335
4339
  * @returns the href for the specified parameters as an external shell hash; always starting with a hash
4336
4340
  * character; all parameters and parameter names are URL-encoded (via encodeURIComponent) and the complete
@@ -4415,7 +4419,7 @@ declare module "sap/ushell/services/CrossApplicationNavigation" {
4415
4419
  * segment must not be used as `shellHash` in the target definition of {@link sap.ushell.services.CrossApplicationNavigation#toExternal}
4416
4420
  *
4417
4421
  * @since 1.15.0
4418
- * @deprecated (since 1.98) - Please use {@link #hrefForExternalAsync} instead.
4422
+ * @deprecated As of version 1.98. Please use {@link #hrefForExternalAsync} instead.
4419
4423
  *
4420
4424
  * @returns the href for the specified parameters as an external shell hash; always starting with a hash
4421
4425
  * character; all parameters and parameter names are URL-encoded (via encodeURIComponent) and the complete
@@ -4586,7 +4590,7 @@ declare module "sap/ushell/services/CrossApplicationNavigation" {
4586
4590
  * is, without a navigation from another app or FLP home.
4587
4591
  *
4588
4592
  * @since 1.36.0
4589
- * @deprecated (since 1.94) - Please use {@link #isInitialNavigationAsync} instead.
4593
+ * @deprecated As of version 1.94. Please use {@link #isInitialNavigationAsync} instead.
4590
4594
  *
4591
4595
  * @returns Whether the initial navigation occurred.
4592
4596
  */
@@ -4607,8 +4611,8 @@ declare module "sap/ushell/services/CrossApplicationNavigation" {
4607
4611
  * in internal format and expanded.
4608
4612
  *
4609
4613
  * @since 1.19.1
4610
- * @deprecated (since 1.31) - Please use {@link #isNavigationSupported} instead. Note that this has a slightly
4611
- * different response format.
4614
+ * @deprecated As of version 1.31. Please use {@link #isNavigationSupported} instead. Note that this has
4615
+ * a slightly different response format.
4612
4616
  *
4613
4617
  * @returns Resolves with a map containing the intents from `aIntents` as keys. The map values are objects
4614
4618
  * with a property `supported` of type `boolean`.
@@ -4915,7 +4919,7 @@ declare module "sap/ushell/services/EndUserFeedback" {
4915
4919
  *
4916
4920
  *
4917
4921
  * @since 1.25.1
4918
- * @deprecated (since 1.93)
4922
+ * @deprecated As of version 1.93.
4919
4923
  */
4920
4924
  export default class EndUserFeedback extends sap.ushell.services.Service {
4921
4925
  /**
@@ -4925,7 +4929,7 @@ declare module "sap/ushell/services/EndUserFeedback" {
4925
4929
 
4926
4930
  /**
4927
4931
  * @since 1.25.1
4928
- * @deprecated (since 1.93)
4932
+ * @deprecated As of version 1.93.
4929
4933
  *
4930
4934
  * @returns Empty string
4931
4935
  */
@@ -4934,7 +4938,7 @@ declare module "sap/ushell/services/EndUserFeedback" {
4934
4938
  * The service is deprecated. The function always returns a negative answer.
4935
4939
  *
4936
4940
  * @since 1.25.1
4937
- * @deprecated (since 1.93)
4941
+ * @deprecated As of version 1.93.
4938
4942
  *
4939
4943
  * @returns Rejected promise.
4940
4944
  */
@@ -4943,7 +4947,7 @@ declare module "sap/ushell/services/EndUserFeedback" {
4943
4947
  * Sends a feedback.
4944
4948
  *
4945
4949
  * @since 1.25.1
4946
- * @deprecated (since 1.93)
4950
+ * @deprecated As of version 1.93.
4947
4951
  *
4948
4952
  * @returns Empty promise
4949
4953
  */
@@ -5119,6 +5123,8 @@ declare module "sap/ushell/services/Extension/Item" {
5119
5123
  declare module "sap/ushell/services/FrameBoundExtension" {
5120
5124
  import Control from "sap/ui/core/Control";
5121
5125
 
5126
+ import UserSettingsEntry from "sap/ushell/services/FrameBoundExtension/UserSettingsEntry";
5127
+
5122
5128
  import Footer from "sap/ushell/services/FrameBoundExtension/Footer";
5123
5129
 
5124
5130
  import { Properties } from "sap/ushell/ui/shell/ShellHeadItem";
@@ -5157,7 +5163,7 @@ declare module "sap/ushell/services/FrameBoundExtension" {
5157
5163
  *
5158
5164
  * @since 1.124.0
5159
5165
  *
5160
- * @returns Resolves once the settings entry was added.
5166
+ * @returns Resolves with the new entry once the settings entry was added.
5161
5167
  */
5162
5168
  addUserSettingsEntry(
5163
5169
  /**
@@ -5174,7 +5180,7 @@ declare module "sap/ushell/services/FrameBoundExtension" {
5174
5180
  */
5175
5181
  title: string;
5176
5182
  /**
5177
- * A string to be presented as the sub title of the entry OR a function which resolves the sub title.
5183
+ * A string to be presented as the subtitle of the entry OR a function which resolves the sub title.
5178
5184
  */
5179
5185
  value: string | (() => Promise<string>);
5180
5186
  /**
@@ -5197,7 +5203,7 @@ declare module "sap/ushell/services/FrameBoundExtension" {
5197
5203
  */
5198
5204
  provideEmptyWrapper?: boolean;
5199
5205
  }
5200
- ): Promise<any>;
5206
+ ): Promise<UserSettingsEntry>;
5201
5207
  /**
5202
5208
  * Creates a new footer which is positioned below the launchpad content.
5203
5209
  *
@@ -5595,6 +5601,33 @@ declare module "sap/ushell/services/FrameBoundExtension/ToolArea" {
5595
5601
  }
5596
5602
  }
5597
5603
 
5604
+ declare module "sap/ushell/services/FrameBoundExtension/UserSettingsEntry" {
5605
+ /**
5606
+ * The UserSettingsEntry defines an entry in the user settings dialog. To be instantiated by {@link sap.ushell.services.FrameBoundExtension}.
5607
+ *
5608
+ * **Restriction:** Does not work when called from within an iframe. The calling function has to be in
5609
+ * the 'same frame' as the launchpad itself.
5610
+ *
5611
+ * @since 1.134.0
5612
+ */
5613
+ export default class UserSettingsEntry {
5614
+ /**
5615
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
5616
+ */
5617
+ protected constructor();
5618
+
5619
+ /**
5620
+ * Opens the user settings entry.
5621
+ *
5622
+ * The dialog is opened and then navigated to the new entry. If a group is available, the function navigates
5623
+ * to the group and entry (tab).
5624
+ *
5625
+ * @since 1.134.0
5626
+ */
5627
+ open(): void;
5628
+ }
5629
+ }
5630
+
5598
5631
  declare module "sap/ushell/services/LaunchPage" {
5599
5632
  /**
5600
5633
  * A service for handling groups, tiles and catalogs.
@@ -5619,7 +5652,7 @@ declare module "sap/ushell/services/LaunchPage" {
5619
5652
  * with the field "contentProvider".
5620
5653
  *
5621
5654
  * @since 1.15.0
5622
- * @deprecated (since 1.99) - This service has been deprecated as it only works for the classic homepage.
5655
+ * @deprecated As of version 1.99. This service has been deprecated as it only works for the classic homepage.
5623
5656
  */
5624
5657
  export default class LaunchPage extends sap.ushell.services.Service {
5625
5658
  /**
@@ -5924,7 +5957,7 @@ declare module "sap/ushell/services/LaunchPage" {
5924
5957
  /**
5925
5958
  * Returns the UI5 view or control of a catalog tile
5926
5959
  *
5927
- * @deprecated (since 1.48) - Please use {@link #getCatalogTileViewControl} instead.
5960
+ * @deprecated As of version 1.48. Please use {@link #getCatalogTileViewControl} instead.
5928
5961
  *
5929
5962
  * @returns UI5 view or control
5930
5963
  */
@@ -5989,7 +6022,7 @@ declare module "sap/ushell/services/LaunchPage" {
5989
6022
  * Returns the groups of the user. The order of the array is the order in which the groups will be displayed
5990
6023
  * to the user.
5991
6024
  *
5992
- * @deprecated (since 1.99) - Alternative for use with {@link sap.ushell.services.Bookmark} is {@link sap.ushell.services.Bookmark#getContentNodes}
6025
+ * @deprecated As of version 1.99. Alternative for use with {@link sap.ushell.services.Bookmark} is {@link sap.ushell.services.Bookmark#getContentNodes}
5993
6026
  *
5994
6027
  * @returns A promise that resolves to the list of groups
5995
6028
  */
@@ -6252,8 +6285,8 @@ declare module "sap/ushell/services/LaunchPage" {
6252
6285
  * Tile actions should be returned immediately without any additional server access in order to avoid delays
6253
6286
  * in rendering the action list in the browser.
6254
6287
  *
6255
- * @deprecated (since 1.99) - This feature has been deprecated with the classic homepage. There is no alternative
6256
- * with spaces and pages.
6288
+ * @deprecated As of version 1.99. This feature has been deprecated with the classic homepage. There is
6289
+ * no alternative with spaces and pages.
6257
6290
  */
6258
6291
  registerTileActionsProvider(
6259
6292
  /**
@@ -6382,7 +6415,7 @@ declare module "sap/ushell/services/Message" {
6382
6415
  *
6383
6416
  *
6384
6417
  * @since 1.16.0
6385
- * @deprecated (since 1.120)
6418
+ * @deprecated As of version 1.120.
6386
6419
  */
6387
6420
  export default class Message extends sap.ushell.services.Service {
6388
6421
  /**
@@ -6941,7 +6974,7 @@ declare module "sap/ushell/services/NavTargetResolution" {
6941
6974
  * ... )
6942
6975
  *
6943
6976
  * @since 1.15.0
6944
- * @deprecated (since 1.120) - Use {@link sap.ushell.services.Navigation} for Navigation instead.
6977
+ * @deprecated As of version 1.120. Use {@link sap.ushell.services.Navigation} for Navigation instead.
6945
6978
  */
6946
6979
  export default class NavTargetResolution extends sap.ushell.services.Service {
6947
6980
  /**
@@ -7183,7 +7216,7 @@ declare module "sap/ushell/services/Notifications" {
7183
7216
  * a notification actions - Marking user notifications as seen
7184
7217
  *
7185
7218
  * @since 1.32.0
7186
- * @deprecated (since 1.119) - Please use {@link sap.ushell.services.NotificationsV2} instead.
7219
+ * @deprecated As of version 1.119. Please use {@link sap.ushell.services.NotificationsV2} instead.
7187
7220
  */
7188
7221
  export default class Notifications extends sap.ushell.services.Service {
7189
7222
  /**
@@ -7790,7 +7823,7 @@ declare module "sap/ushell/services/Personalization" {
7790
7823
  *
7791
7824
  *
7792
7825
  * @since 1.15.0
7793
- * @deprecated (since 1.120) - Please use {@link sap.ushell.services.PersonalizationV2} instead
7826
+ * @deprecated As of version 1.120. Please use {@link sap.ushell.services.PersonalizationV2} instead
7794
7827
  */
7795
7828
  export default class Personalization extends sap.ushell.services.Service {
7796
7829
  /**
@@ -7871,7 +7904,7 @@ declare module "sap/ushell/services/Personalization" {
7871
7904
  * Note: Invoking this operation while another save or load operation is under way may result in failure.
7872
7905
  *
7873
7906
  * @since 1.18.0
7874
- * @deprecated (since 1.22) - Please use {@link #delContainer} instead.
7907
+ * @deprecated As of version 1.22. Please use {@link #delContainer} instead.
7875
7908
  *
7876
7909
  * @returns Resolves once the container was deleted.
7877
7910
  */
@@ -8023,7 +8056,7 @@ declare module "sap/ushell/services/Personalization" {
8023
8056
  * Do not mix up the usage of a personalizer and a personalization container for one containerKey.
8024
8057
  *
8025
8058
  * @since 1.18.0
8026
- * @deprecated (since 1.21) - Please use {@link #getContainer} instead.
8059
+ * @deprecated As of version 1.21. Please use {@link #getContainer} instead.
8027
8060
  *
8028
8061
  * @returns Resolves a {@link sap.ushell.services.PersonalizationContainer} object as parameter. The personalization
8029
8062
  * container provides two different interfaces to synchronously operate on personalization data. In the
@@ -8096,7 +8129,7 @@ declare module "sap/ushell/services/_Personalization/ContextContainer" {
8096
8129
  * To be called by the personalization service getContainer method.
8097
8130
  *
8098
8131
  * @since 1.22.0
8099
- * @deprecated (since 1.120) - Please use {@link sap.ushell.services.PersonalizationV2.ContextContainer }
8132
+ * @deprecated As of version 1.120. Please use {@link sap.ushell.services.PersonalizationV2.ContextContainer }
8100
8133
  * instead
8101
8134
  */
8102
8135
  export default class ContextContainer {
@@ -8109,7 +8142,7 @@ declare module "sap/ushell/services/_Personalization/ContextContainer" {
8109
8142
  * Returns an array with all internal keys of direct items in the container.
8110
8143
  *
8111
8144
  * @since 1.22.0
8112
- * @deprecated (since 1.120.0)
8145
+ * @deprecated As of version 1.120.0.
8113
8146
  *
8114
8147
  * @returns item keys
8115
8148
  */
@@ -8195,7 +8228,7 @@ declare module "sap/ushell/services/_Personalization/ContextContainer" {
8195
8228
  * return the validity of this container only for testing!
8196
8229
  *
8197
8230
  * @since 1.22.0
8198
- * @deprecated (since 1.31) - Support for this function has been discontinued.
8231
+ * @deprecated As of version 1.31. Support for this function has been discontinued.
8199
8232
  */
8200
8233
  getValidity(): void;
8201
8234
  /**
@@ -8217,7 +8250,7 @@ declare module "sap/ushell/services/_Personalization/ContextContainer" {
8217
8250
  * is serialized.
8218
8251
  *
8219
8252
  * @since 1.22.0
8220
- * @deprecated (since 1.120.0) - Use {@link sap.ushell.services.Personalization.ContextContainer#saveDeferred }
8253
+ * @deprecated As of version 1.120.0. Use {@link sap.ushell.services.Personalization.ContextContainer#saveDeferred }
8221
8254
  * instead
8222
8255
  *
8223
8256
  * @returns Resolves once the container is saved.
@@ -8264,7 +8297,8 @@ declare module "sap/ushell/services/_Personalization/PersonalizationContainer" {
8264
8297
  * To be called by the personalization service getPersonalizationContainer method.
8265
8298
  *
8266
8299
  * @since 1.18.0
8267
- * @deprecated (since 1.120) - Please use {@link sap.ushell.services.Personalization#getContainer} instead
8300
+ * @deprecated As of version 1.120. Please use {@link sap.ushell.services.Personalization#getContainer }
8301
+ * instead
8268
8302
  */
8269
8303
  export default class PersonalizationContainer {
8270
8304
  /**
@@ -8282,7 +8316,8 @@ declare module "sap/ushell/services/_Personalization/PersonalizationContainerVar
8282
8316
  * To be called by the personalization variant set.
8283
8317
  *
8284
8318
  * @since 1.18.0
8285
- * @deprecated (since 1.120) - Please use {@link sap.ushell.services.Personalization#getContainer} instead
8319
+ * @deprecated As of version 1.120. Please use {@link sap.ushell.services.Personalization#getContainer }
8320
+ * instead
8286
8321
  */
8287
8322
  export default class PersonalizationContainerVariant {
8288
8323
  /**
@@ -8378,7 +8413,8 @@ declare module "sap/ushell/services/_Personalization/PersonalizationContainerVar
8378
8413
  * To be called by the personalization container.
8379
8414
  *
8380
8415
  * @since 1.18.0
8381
- * @deprecated (since 1.120) - Please use {@link sap.ushell.services.Personalization#getContainer} instead
8416
+ * @deprecated As of version 1.120. Please use {@link sap.ushell.services.Personalization#getContainer }
8417
+ * instead
8382
8418
  */
8383
8419
  export default class PersonalizationContainerVariantSet {
8384
8420
  /**
@@ -8476,7 +8512,8 @@ declare module "sap/ushell/services/_Personalization/Personalizer" {
8476
8512
  * To be called by the personalization service getPersonalizer method.
8477
8513
  *
8478
8514
  * @since 1.15.0
8479
- * @deprecated (since 1.120) - Please use {@link sap.ushell.services.PersonalizationV2.Personalizer} instead
8515
+ * @deprecated As of version 1.120. Please use {@link sap.ushell.services.PersonalizationV2.Personalizer }
8516
+ * instead
8480
8517
  */
8481
8518
  export default class Personalizer {
8482
8519
  /**
@@ -8523,7 +8560,7 @@ declare module "sap/ushell/services/_Personalization/TransientPersonalizer" {
8523
8560
  * the personalization service getTransientPersonalizer method.
8524
8561
  *
8525
8562
  * @since 1.18.0
8526
- * @deprecated (since 1.120) - Please use {@link sap.ushell.services.PersonalizationV2.TransientPersonalizer }
8563
+ * @deprecated As of version 1.120. Please use {@link sap.ushell.services.PersonalizationV2.TransientPersonalizer }
8527
8564
  * instead
8528
8565
  */
8529
8566
  export default class TransientPersonalizer {
@@ -8539,7 +8576,7 @@ declare module "sap/ushell/services/_Personalization/Variant" {
8539
8576
  * To be instantiated via Personalization.VariantSet add / get Variant only
8540
8577
  *
8541
8578
  * @since 1.22.0
8542
- * @deprecated (since 1.120) - Please use {@link sap.ushell.services.PersonalizationV2.Variant} instead
8579
+ * @deprecated As of version 1.120. Please use {@link sap.ushell.services.PersonalizationV2.Variant} instead
8543
8580
  */
8544
8581
  export default class Variant {
8545
8582
  /**
@@ -8652,7 +8689,8 @@ declare module "sap/ushell/services/_Personalization/VariantSet" {
8652
8689
  * To be called by the personalization container.
8653
8690
  *
8654
8691
  * @since 1.22.0
8655
- * @deprecated (since 1.120) - Please use {@link sap.ushell.services.PersonalizationV2.VariantSet} instead
8692
+ * @deprecated As of version 1.120. Please use {@link sap.ushell.services.PersonalizationV2.VariantSet }
8693
+ * instead
8656
8694
  */
8657
8695
  export default class VariantSet {
8658
8696
  /**
@@ -8769,7 +8807,7 @@ declare module "sap/ushell/services/personalization/VariantSetAdapter" {
8769
8807
  *
8770
8808
  *
8771
8809
  * @since 1.18.0
8772
- * @deprecated (since 1.120) - Please use {@link sap.ushell.services.PersonalizationV2.VariantSetAdapter }
8810
+ * @deprecated As of version 1.120. Please use {@link sap.ushell.services.PersonalizationV2.VariantSetAdapter }
8773
8811
  * instead
8774
8812
  */
8775
8813
  export default class VariantSetAdapter {
@@ -9725,7 +9763,7 @@ declare module "sap/ushell/services/ShellNavigation" {
9725
9763
  * not to be invoked directly!
9726
9764
  *
9727
9765
  * @since 1.15.0
9728
- * @deprecated (since 1.120) - Use {@link sap.ushell.services.Navigation} for Navigation instead.
9766
+ * @deprecated As of version 1.120. Use {@link sap.ushell.services.Navigation} for Navigation instead.
9729
9767
  */
9730
9768
  export default class ShellNavigation {
9731
9769
  /**
@@ -9864,7 +9902,7 @@ declare module "sap/ushell/services/SmartNavigation" {
9864
9902
  *
9865
9903
  *
9866
9904
  * @since 1.44.0
9867
- * @deprecated (since 1.112) - This service has been deprecated. Please use the CrossApplicationNavigation
9905
+ * @deprecated As of version 1.112. This service has been deprecated. Please use the CrossApplicationNavigation
9868
9906
  * service instead.
9869
9907
  */
9870
9908
  export default class SmartNavigation extends sap.ushell.services.Service {
@@ -9906,7 +9944,7 @@ declare module "sap/ushell/services/SmartNavigation" {
9906
9944
  * sap.ushell.services.CrossApplicationNavigation#hrefForExternal
9907
9945
  *
9908
9946
  * @since 1.46.0
9909
- * @deprecated (since 1.94) - Please use {@link #hrefForExternalAsync} instead.
9947
+ * @deprecated As of version 1.94. Please use {@link #hrefForExternalAsync} instead.
9910
9948
  */
9911
9949
  hrefForExternal(): void;
9912
9950
  /**
@@ -10166,7 +10204,7 @@ declare module "sap/ushell/services/URLParsing" {
10166
10204
  * normalized.
10167
10205
  *
10168
10206
  * @since 1.19.1
10169
- * @deprecated (since 1.31) - Please use {@link sap.ui.model.odata.ODataUtils#setOrigin} instead.
10207
+ * @deprecated As of version 1.31. Please use {@link sap.ui.model.odata.ODataUtils#setOrigin} instead.
10170
10208
  *
10171
10209
  * @returns the service URL pointing to the system specified in parameter `vComponentOrSystem` or to the
10172
10210
  * system of the current application
@@ -10248,7 +10286,7 @@ declare module "sap/ushell/services/URLParsing" {
10248
10286
  * object and action. It does not test whether the intent or its parameters are valid for a given user
10249
10287
  *
10250
10288
  * @since 1.30.0
10251
- * @deprecated (since 1.96) - Please use {@link #isIntentUrlAsync} instead.
10289
+ * @deprecated As of version 1.96. Please use {@link #isIntentUrlAsync} instead.
10252
10290
  *
10253
10291
  * @returns true if the conditions are fulfilled.
10254
10292
  */
@@ -10460,8 +10498,8 @@ declare module "sap/ushell/services/UsageAnalytics" {
10460
10498
  *
10461
10499
  *
10462
10500
  * @since 1.32.0
10463
- * @deprecated (since 1.120.0) - The corresponding cloud service "SAP Web Analytics" has been retired, therefore
10464
- * this client-side service API cannot be used any longer.
10501
+ * @deprecated As of version 1.120.0. The corresponding cloud service "SAP Web Analytics" has been retired,
10502
+ * therefore this client-side service API cannot be used any longer.
10465
10503
  */
10466
10504
  export default class UsageAnalytics extends sap.ushell.services.Service {
10467
10505
  /**
@@ -10475,7 +10513,7 @@ declare module "sap/ushell/services/UsageAnalytics" {
10475
10513
  * Currently these attributes correspond to database columns custom5...custom10.
10476
10514
  *
10477
10515
  * @since 1.32.0
10478
- * @deprecated (since 1.120.0)
10516
+ * @deprecated As of version 1.120.0.
10479
10517
  */
10480
10518
  setCustomAttributes(
10481
10519
  /**
@@ -10498,7 +10536,7 @@ declare module "sap/ushell/services/UsageAnalytics" {
10498
10536
  * Enables the renderer to set the content of the legal message..
10499
10537
  *
10500
10538
  * @since 1.32.0
10501
- * @deprecated (since 1.120.0)
10539
+ * @deprecated As of version 1.120.0.
10502
10540
  */
10503
10541
  setLegalText(): void;
10504
10542
  /**
@@ -10509,7 +10547,7 @@ declare module "sap/ushell/services/UsageAnalytics" {
10509
10547
  * Since the service is deprecated and no longer supported, this method always returns `false`.
10510
10548
  *
10511
10549
  * @since 1.32.0
10512
- * @deprecated (since 1.120.0)
10550
+ * @deprecated As of version 1.120.0.
10513
10551
  *
10514
10552
  * @returns A boolean value indicating whether the UsageAnalytics service is enabled
10515
10553
  */
@@ -10522,7 +10560,7 @@ declare module "sap/ushell/services/UsageAnalytics" {
10522
10560
  * Since the service is deprecated and no longer supported, this method always returns `false`.
10523
10561
  *
10524
10562
  * @since 1.32.0
10525
- * @deprecated (since 1.120.0)
10563
+ * @deprecated As of version 1.120.0.
10526
10564
  *
10527
10565
  * @returns A boolean value indicating whether the user has specified to track activities
10528
10566
  */
@@ -10668,7 +10706,7 @@ declare module "sap/ushell/ui/appfinder/AppBox" {
10668
10706
  /**
10669
10707
  * Constructor for a new ui/appfinder/AppBox.
10670
10708
  *
10671
- * @deprecated (since 1.120)
10709
+ * @deprecated As of version 1.120.
10672
10710
  */
10673
10711
  export default class AppBox extends Control {
10674
10712
  constructor(
@@ -10696,7 +10734,7 @@ declare module "sap/ushell/ui/appfinder/AppBox" {
10696
10734
  /**
10697
10735
  * Describes the settings that can be provided to the AppBox constructor.
10698
10736
  *
10699
- * @deprecated (since 1.120)
10737
+ * @deprecated As of version 1.120.
10700
10738
  */
10701
10739
  export interface $AppBoxSettings extends $ControlSettings {}
10702
10740
  }
@@ -10785,8 +10823,8 @@ declare module "sap/ushell/ui/footerbar/AddBookmarkButton" {
10785
10823
  *
10786
10824
  * An object containing properties with information about the app, e.g. serviceUrl, numberUnit, ... .
10787
10825
  *
10788
- * @deprecated (since 1.31) - Use dedicated properties like afterPressHandler, beforePresshandler, customUrl,
10789
- * ... of the AddBookmarkButton instead.
10826
+ * @deprecated As of version 1.31. Use dedicated properties like afterPressHandler, beforePresshandler,
10827
+ * customUrl, ... of the AddBookmarkButton instead.
10790
10828
  *
10791
10829
  * @returns Value of property `appData`
10792
10830
  */
@@ -10937,8 +10975,8 @@ declare module "sap/ushell/ui/footerbar/AddBookmarkButton" {
10937
10975
  *
10938
10976
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
10939
10977
  *
10940
- * @deprecated (since 1.31) - Use dedicated properties like afterPressHandler, beforePresshandler, customUrl,
10941
- * ... of the AddBookmarkButton instead.
10978
+ * @deprecated As of version 1.31. Use dedicated properties like afterPressHandler, beforePresshandler,
10979
+ * customUrl, ... of the AddBookmarkButton instead.
10942
10980
  *
10943
10981
  * @returns Reference to `this` in order to allow method chaining
10944
10982
  */
@@ -11242,8 +11280,8 @@ declare module "sap/ushell/ui/footerbar/AddBookmarkButton" {
11242
11280
  /**
11243
11281
  * An object containing properties with information about the app, e.g. serviceUrl, numberUnit, ... .
11244
11282
  *
11245
- * @deprecated (since 1.31) - Use dedicated properties like afterPressHandler, beforePresshandler, customUrl,
11246
- * ... of the AddBookmarkButton instead.
11283
+ * @deprecated As of version 1.31. Use dedicated properties like afterPressHandler, beforePresshandler,
11284
+ * customUrl, ... of the AddBookmarkButton instead.
11247
11285
  */
11248
11286
  appData?: object | PropertyBindingInfo | `{${string}}`;
11249
11287
  }
@@ -11559,7 +11597,7 @@ declare module "sap/ushell/ui/launchpad/DashboardGroupsContainer" {
11559
11597
  /**
11560
11598
  * Constructor for "sap.ushell.ui.launchpad.DashboardGroupsContainer".
11561
11599
  *
11562
- * @deprecated (since 1.120)
11600
+ * @deprecated As of version 1.120.
11563
11601
  */
11564
11602
  export default class DashboardGroupsContainer extends Control {
11565
11603
  /**
@@ -11824,7 +11862,7 @@ declare module "sap/ushell/ui/launchpad/DashboardGroupsContainer" {
11824
11862
  /**
11825
11863
  * Describes the settings that can be provided to the DashboardGroupsContainer constructor.
11826
11864
  *
11827
- * @deprecated (since 1.120)
11865
+ * @deprecated As of version 1.120.
11828
11866
  */
11829
11867
  export interface $DashboardGroupsContainerSettings extends $ControlSettings {
11830
11868
  /**
@@ -11869,7 +11907,7 @@ declare module "sap/ushell/ui/launchpad/LinkTileWrapper" {
11869
11907
  * Constructor for a new ui/launchpad/LinkTileWrapper. A link tile to be displayed in the tile container.
11870
11908
  * This control acts as container for specialized tile implementations.
11871
11909
  *
11872
- * @deprecated (since 1.120)
11910
+ * @deprecated As of version 1.120.
11873
11911
  */
11874
11912
  export default class LinkTileWrapper extends Control {
11875
11913
  /**
@@ -12622,7 +12660,7 @@ declare module "sap/ushell/ui/launchpad/LinkTileWrapper" {
12622
12660
  /**
12623
12661
  * Describes the settings that can be provided to the LinkTileWrapper constructor.
12624
12662
  *
12625
- * @deprecated (since 1.120)
12663
+ * @deprecated As of version 1.120.
12626
12664
  */
12627
12665
  export interface $LinkTileWrapperSettings extends $ControlSettings {
12628
12666
  uuid?: string | PropertyBindingInfo;
@@ -12724,7 +12762,7 @@ declare module "sap/ushell/ui/launchpad/TileState" {
12724
12762
  * Constructor for a new ui/launchpad/TileState. The tile state control that displays loading indicator,
12725
12763
  * while tile view is loading and failed status in case tile view is not available.
12726
12764
  *
12727
- * @deprecated (since 1.120)
12765
+ * @deprecated As of version 1.120.
12728
12766
  */
12729
12767
  export default class TileState extends Control {
12730
12768
  /**
@@ -12888,7 +12926,7 @@ declare module "sap/ushell/ui/launchpad/TileState" {
12888
12926
  /**
12889
12927
  * Describes the settings that can be provided to the TileState constructor.
12890
12928
  *
12891
- * @deprecated (since 1.120)
12929
+ * @deprecated As of version 1.120.
12892
12930
  */
12893
12931
  export interface $TileStateSettings extends $ControlSettings {
12894
12932
  state?: string | PropertyBindingInfo;
@@ -13427,7 +13465,7 @@ declare module "sap/ushell/ui/tile/StaticTile" {
13427
13465
  * subtitle, an icon and additional information
13428
13466
  *
13429
13467
  * @since 1.15.0
13430
- * @deprecated (since 1.120)
13468
+ * @deprecated As of version 1.120.
13431
13469
  */
13432
13470
  export default class StaticTile
13433
13471
  extends /* was: sap.ushell.ui.tile.TileBase */ Object
@@ -13621,6 +13659,17 @@ declare module "sap/ushell/ui5service/ShellUIService" {
13621
13659
  * @returns The current title.
13622
13660
  */
13623
13661
  getTitle(): string;
13662
+ /**
13663
+ * Sets the application screen size to either full width or letterbox.
13664
+ *
13665
+ * @since 1.133.0
13666
+ */
13667
+ setApplicationFullWidth(
13668
+ /**
13669
+ * Whether the application should be displayed in full width.
13670
+ */
13671
+ bFullWidth: boolean
13672
+ ): void;
13624
13673
  /**
13625
13674
  * Displays the given hierarchy in the shell header. The default app hierarchy is applied if no parameter
13626
13675
  * is given.
@@ -13649,13 +13698,80 @@ declare module "sap/ushell/ui5service/ShellUIService" {
13649
13698
  * Displays the given title in the shell header. This method should not be called - and will be without
13650
13699
  * effect - if the app calling the method is not currently displayed in the Fiori launchpad.
13651
13700
  *
13701
+ * The sTitle will be concatenated with the window title extension and displayed as browser tab title. If
13702
+ * oAdditionalInformation is set, the browser tab title will be constructed from the oAdditionalInformation
13703
+ * plus window title extension. sTitle is still used in the shell header.
13704
+ *
13705
+ * Examples:
13706
+ * ```javascript
13707
+ *
13708
+ * // Window Title Extension is: "Fiori Launchpad"
13709
+ *
13710
+ * setTitle("My App Title");
13711
+ * // Shell Header title: "My App Title"
13712
+ * // Browser Window Title: "My App Title - Fiori Launchpad"
13713
+ * ```
13714
+ *
13715
+ *
13716
+ *
13717
+ * ```javascript
13718
+ *
13719
+ * // Window Title Extension is: "Fiori Launchpad"
13720
+ *
13721
+ * setTitle("My App Title", {
13722
+ * headerText: "My Header Text",
13723
+ * additionalContext: "My Additional Context",
13724
+ * searchTerm: "My Search Term",
13725
+ * searchScope: "My Search Scope"
13726
+ * });
13727
+ * // Search Term has precedence over headerText and additionalContext.
13728
+ * // Shell Header title: "My App Title"
13729
+ * // Browser Window Title: "My Search Term in My Search Scope - Search - Fiori Launchpad"
13730
+ * ```
13731
+ *
13732
+ *
13733
+ *
13734
+ * ```javascript
13735
+ *
13736
+ * // Window Title Extension is: "Fiori Launchpad"
13737
+ *
13738
+ * setTitle("My App Title", {
13739
+ * headerText: "My Header Text",
13740
+ * additionalContext: "My Additional Context"
13741
+ * });
13742
+ * // Shell Header title: "My App Title"
13743
+ * // Browser Window Title: "My Header Text - My Additional Context - Fiori Launchpad"
13744
+ * ```
13745
+ *
13746
+ *
13652
13747
  * @since 1.38.0
13653
13748
  */
13654
13749
  setTitle(
13655
13750
  /**
13656
13751
  * The new title. The default title is set if this argument is not given.
13657
13752
  */
13658
- sTitle?: string
13753
+ sTitle?: string,
13754
+ /**
13755
+ * An object of additional information to be displayed in the browser window title
13756
+ */
13757
+ oAdditionalInformation?: {
13758
+ /**
13759
+ * Optional header text
13760
+ */
13761
+ headerText?: string;
13762
+ /**
13763
+ * Optional additional context information
13764
+ */
13765
+ additionalContext?: string;
13766
+ /**
13767
+ * Optional search term. If given, headerText and additionalContext will be ignored
13768
+ */
13769
+ searchTerm?: string;
13770
+ /**
13771
+ * Optional search scope, only used if searchTerm is given
13772
+ */
13773
+ searchScope?: string;
13774
+ }
13659
13775
  ): void;
13660
13776
  }
13661
13777
  /**
@@ -13699,7 +13815,7 @@ declare module "sap/ushell/ui5service/UserStatus" {
13699
13815
  import Metadata from "sap/ui/base/Metadata";
13700
13816
 
13701
13817
  /**
13702
- * @deprecated (since 1.70) - Support for this service has been discontinued.
13818
+ * @deprecated As of version 1.70. Support for this service has been discontinued.
13703
13819
  */
13704
13820
  export default class UserStatus
13705
13821
  extends /* was: sap.ui.core.service.Service */ Object
@@ -13742,7 +13858,7 @@ declare module "sap/ushell/ui5service/UserStatus" {
13742
13858
  * the setStatus method is called.
13743
13859
  *
13744
13860
  * @since 1.46
13745
- * @deprecated (since 1.70)
13861
+ * @deprecated As of version 1.70.
13746
13862
  */
13747
13863
  attachStatusChanged(
13748
13864
  /**
@@ -13754,7 +13870,7 @@ declare module "sap/ushell/ui5service/UserStatus" {
13754
13870
  * Detaches an event handler from the 'statusChanged' event.
13755
13871
  *
13756
13872
  * @since 1.46
13757
- * @deprecated (since 1.70)
13873
+ * @deprecated As of version 1.70.
13758
13874
  */
13759
13875
  detachStatusChanged(
13760
13876
  /**
@@ -13771,7 +13887,7 @@ declare module "sap/ushell/ui5service/UserStatus" {
13771
13887
  * online status, the setStatus method will be called with a null value.
13772
13888
  *
13773
13889
  * @since 1.46
13774
- * @deprecated (since 1.70)
13890
+ * @deprecated As of version 1.70.
13775
13891
  */
13776
13892
  setEnabled(
13777
13893
  /**
@@ -13788,7 +13904,7 @@ declare module "sap/ushell/ui5service/UserStatus" {
13788
13904
  * their online status
13789
13905
  *
13790
13906
  * @since 1.46
13791
- * @deprecated (since 1.70)
13907
+ * @deprecated As of version 1.70.
13792
13908
  */
13793
13909
  setStatus(
13794
13910
  /**
@@ -13849,7 +13965,7 @@ declare namespace sap {
13849
13965
  *
13850
13966
  *
13851
13967
  * @since 1.15.0
13852
- * @deprecated (since 1.120)
13968
+ * @deprecated As of version 1.120.
13853
13969
  *
13854
13970
  * @returns Resolves once the container is available.
13855
13971
  */
@@ -13925,6 +14041,8 @@ declare namespace sap {
13925
14041
 
13926
14042
  "sap/ushell/api/S4MyHome": undefined;
13927
14043
 
14044
+ "sap/ushell/api/SAPBusinessClient": undefined;
14045
+
13928
14046
  "sap/ushell/api/workpage/Designtime": undefined;
13929
14047
 
13930
14048
  "sap/ushell/api/workpage/Runtime": undefined;
@@ -13989,6 +14107,8 @@ declare namespace sap {
13989
14107
 
13990
14108
  "sap/ushell/services/FrameBoundExtension/ToolArea": undefined;
13991
14109
 
14110
+ "sap/ushell/services/FrameBoundExtension/UserSettingsEntry": undefined;
14111
+
13992
14112
  "sap/ushell/services/LaunchPage": undefined;
13993
14113
 
13994
14114
  "sap/ushell/services/Message": undefined;