@sapui5/ts-types 1.128.1 → 1.129.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (67) hide show
  1. package/package.json +1 -1
  2. package/types/sap.apf.d.ts +1 -1
  3. package/types/sap.ca.ui.d.ts +1 -1
  4. package/types/sap.chart.d.ts +1 -1
  5. package/types/sap.collaboration.d.ts +1 -1
  6. package/types/sap.cux.home.d.ts +37 -0
  7. package/types/sap.esh.search.ui.d.ts +1 -1
  8. package/types/sap.f.d.ts +1 -1
  9. package/types/sap.fe.base.d.ts +1 -1
  10. package/types/sap.fe.core.d.ts +10 -10
  11. package/types/sap.fe.ina.d.ts +1 -1
  12. package/types/sap.fe.macros.d.ts +116 -30
  13. package/types/sap.fe.navigation.d.ts +9 -2
  14. package/types/sap.fe.placeholder.d.ts +1 -1
  15. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  16. package/types/sap.fe.templates.d.ts +1 -1
  17. package/types/sap.fe.test.d.ts +1 -1
  18. package/types/sap.fe.tools.d.ts +1 -1
  19. package/types/sap.feedback.ui.d.ts +1 -1
  20. package/types/sap.gantt.d.ts +17 -4
  21. package/types/sap.insights.d.ts +7 -1
  22. package/types/sap.m.d.ts +195 -27
  23. package/types/sap.makit.d.ts +1 -1
  24. package/types/sap.me.d.ts +1 -1
  25. package/types/sap.ndc.d.ts +1 -1
  26. package/types/sap.ovp.d.ts +1 -1
  27. package/types/sap.rules.ui.d.ts +1 -1
  28. package/types/sap.sac.df.d.ts +355 -20
  29. package/types/sap.suite.ui.commons.d.ts +118 -2
  30. package/types/sap.suite.ui.generic.template.d.ts +27 -1
  31. package/types/sap.suite.ui.microchart.d.ts +1 -1
  32. package/types/sap.tnt.d.ts +1 -1
  33. package/types/sap.ui.codeeditor.d.ts +1 -1
  34. package/types/sap.ui.commons.d.ts +1 -1
  35. package/types/sap.ui.comp.d.ts +427 -982
  36. package/types/sap.ui.core.d.ts +59 -65
  37. package/types/sap.ui.dt.d.ts +1 -1
  38. package/types/sap.ui.export.d.ts +7 -1
  39. package/types/sap.ui.fl.d.ts +13 -1
  40. package/types/sap.ui.generic.app.d.ts +1 -1
  41. package/types/sap.ui.generic.template.d.ts +1 -1
  42. package/types/sap.ui.integration.d.ts +37 -1
  43. package/types/sap.ui.layout.d.ts +1 -1
  44. package/types/sap.ui.mdc.d.ts +531 -27
  45. package/types/sap.ui.richtexteditor.d.ts +1 -1
  46. package/types/sap.ui.rta.d.ts +1 -1
  47. package/types/sap.ui.suite.d.ts +1 -1
  48. package/types/sap.ui.support.d.ts +1 -1
  49. package/types/sap.ui.table.d.ts +71 -18
  50. package/types/sap.ui.testrecorder.d.ts +1 -1
  51. package/types/sap.ui.unified.d.ts +103 -1
  52. package/types/sap.ui.ux3.d.ts +1 -1
  53. package/types/sap.ui.vbm.d.ts +1 -1
  54. package/types/sap.ui.vk.d.ts +1 -1
  55. package/types/sap.ui.vtm.d.ts +1 -1
  56. package/types/sap.ui.webc.common.d.ts +1 -1
  57. package/types/sap.ui.webc.fiori.d.ts +1 -1
  58. package/types/sap.ui.webc.main.d.ts +1 -1
  59. package/types/sap.uiext.inbox.d.ts +1 -1
  60. package/types/sap.ushell.d.ts +43 -25
  61. package/types/sap.ushell_abap.d.ts +1 -1
  62. package/types/sap.uxap.d.ts +1 -1
  63. package/types/sap.viz.d.ts +1 -1
  64. package/types/sap.webanalytics.core.d.ts +1 -1
  65. package/types/sap.zen.commons.d.ts +1 -1
  66. package/types/sap.zen.crosstab.d.ts +1 -1
  67. package/types/sap.zen.dsh.d.ts +1 -1
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.128.0
1
+ // For Library Version: 1.129.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.128.0
1
+ // For Library Version: 1.129.0
2
2
 
3
3
  declare module "sap/ui/rta/api/startAdaptation" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.128.0
1
+ // For Library Version: 1.129.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.128.0
1
+ // For Library Version: 1.129.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.128.0
1
+ // For Library Version: 1.129.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -862,6 +862,15 @@ declare namespace sap {
862
862
  | sap.ui.base.ManagedObject.PropertyBindingInfo
863
863
  | `{${string}}`;
864
864
 
865
+ /**
866
+ * The maximum number of displayed rows. If not set, the maximum number of rows is determined by the viewport
867
+ * height of the device.
868
+ */
869
+ maxRowCount?:
870
+ | int
871
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
872
+ | `{${string}}`;
873
+
865
874
  /**
866
875
  * The number of rows in the fixed area at the top. If the number of fixed rows exceeds the number of displayed
867
876
  * rows, the number of fixed rows is reduced. The table may limit the possible number of fixed rows.
@@ -1400,6 +1409,18 @@ declare namespace sap {
1400
1409
  * @returns Value of property `fixedTopRowCount`
1401
1410
  */
1402
1411
  getFixedTopRowCount(): int;
1412
+ /**
1413
+ * Gets current value of property {@link #getMaxRowCount maxRowCount}.
1414
+ *
1415
+ * The maximum number of displayed rows. If not set, the maximum number of rows is determined by the viewport
1416
+ * height of the device.
1417
+ *
1418
+ * Default value is `-1`.
1419
+ *
1420
+ *
1421
+ * @returns Value of property `maxRowCount`
1422
+ */
1423
+ getMaxRowCount(): int;
1403
1424
  /**
1404
1425
  * Gets current value of property {@link #getMinRowCount minRowCount}.
1405
1426
  *
@@ -1475,6 +1496,25 @@ declare namespace sap {
1475
1496
  */
1476
1497
  iFixedTopRowCount?: int
1477
1498
  ): this;
1499
+ /**
1500
+ * Sets a new value for property {@link #getMaxRowCount maxRowCount}.
1501
+ *
1502
+ * The maximum number of displayed rows. If not set, the maximum number of rows is determined by the viewport
1503
+ * height of the device.
1504
+ *
1505
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1506
+ *
1507
+ * Default value is `-1`.
1508
+ *
1509
+ *
1510
+ * @returns Reference to `this` in order to allow method chaining
1511
+ */
1512
+ setMaxRowCount(
1513
+ /**
1514
+ * New value for property `maxRowCount`
1515
+ */
1516
+ iMaxRowCount?: int
1517
+ ): this;
1478
1518
  /**
1479
1519
  * Sets a new value for property {@link #getMinRowCount minRowCount}.
1480
1520
  *
@@ -1921,7 +1961,8 @@ declare namespace sap {
1921
1961
  * the binding property for sorting must be specified. For example, if the first name and last name are
1922
1962
  * displayed in the same column, only one of the two can be defined as `sortProperty`.
1923
1963
  *
1924
- * A column menu entry for sorting can only be generated if the `sortProperty` is set.
1964
+ * A column menu entry for sorting can only be generated if the `headerMenu` association and `sortProperty`
1965
+ * are set.
1925
1966
  */
1926
1967
  sortProperty?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1927
1968
 
@@ -1940,8 +1981,8 @@ declare namespace sap {
1940
1981
  * Therefore the binding property for filtering must be specified. For example, if the first name and last
1941
1982
  * name are displayed in the same column, only one of the two can be defined as `filterProperty`.
1942
1983
  *
1943
- * A column menu entry for filtering can only be generated if the `filterProperty` is set. The default menu
1944
- * entry is a text input field.
1984
+ * A column menu entry for filtering can only be generated if the `headerMenu` association and `filterProperty`
1985
+ * are set. The default menu entry is a text input field.
1945
1986
  */
1946
1987
  filterProperty?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1947
1988
 
@@ -2026,7 +2067,8 @@ declare namespace sap {
2026
2067
  name?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
2027
2068
 
2028
2069
  /**
2029
- * Defines if the filter menu entry is displayed
2070
+ * Defines if the filter menu entry is displayed. **Note**: It only takes effect if the `headerMenu` association
2071
+ * is set.
2030
2072
  *
2031
2073
  * @since 1.13.0
2032
2074
  */
@@ -2036,7 +2078,8 @@ declare namespace sap {
2036
2078
  | `{${string}}`;
2037
2079
 
2038
2080
  /**
2039
- * Defines if the sort menu entries are displayed
2081
+ * Defines if the sort menu entries are displayed. **Note**: It only takes effect if the `headerMenu` association
2082
+ * is set.
2040
2083
  *
2041
2084
  * @since 1.13.0
2042
2085
  */
@@ -2433,7 +2476,9 @@ declare namespace sap {
2433
2476
  * rows minus number of fixed rows), this number is used as the `scrollThreshold`. If the value is 0, no
2434
2477
  * threshold is applied during scrolling. The value -1 applies the same value as the `threshold` property.
2435
2478
  *
2436
- * **Note:** This property only takes effect if it is set to a positive integer value.
2479
+ * **Note:** This property only takes effect if it is set to a positive integer value.
2480
+ *
2481
+ * The value of the `scrollThreshold` should be higher than the `threshold` value to avoid unnecessary requests.
2437
2482
  *
2438
2483
  * For `AnalyticalTable` and `TreeTable`, the `scrollThreshold` property must be higher than the `threshold`
2439
2484
  * property to take effect.
@@ -4760,8 +4805,8 @@ declare namespace sap {
4760
4805
  * Therefore the binding property for filtering must be specified. For example, if the first name and last
4761
4806
  * name are displayed in the same column, only one of the two can be defined as `filterProperty`.
4762
4807
  *
4763
- * A column menu entry for filtering can only be generated if the `filterProperty` is set. The default menu
4764
- * entry is a text input field.
4808
+ * A column menu entry for filtering can only be generated if the `headerMenu` association and `filterProperty`
4809
+ * are set. The default menu entry is a text input field.
4765
4810
  *
4766
4811
  *
4767
4812
  * @returns Value of property `filterProperty`
@@ -4948,7 +4993,8 @@ declare namespace sap {
4948
4993
  /**
4949
4994
  * Gets current value of property {@link #getShowFilterMenuEntry showFilterMenuEntry}.
4950
4995
  *
4951
- * Defines if the filter menu entry is displayed
4996
+ * Defines if the filter menu entry is displayed. **Note**: It only takes effect if the `headerMenu` association
4997
+ * is set.
4952
4998
  *
4953
4999
  * Default value is `true`.
4954
5000
  *
@@ -4960,7 +5006,8 @@ declare namespace sap {
4960
5006
  /**
4961
5007
  * Gets current value of property {@link #getShowSortMenuEntry showSortMenuEntry}.
4962
5008
  *
4963
- * Defines if the sort menu entries are displayed
5009
+ * Defines if the sort menu entries are displayed. **Note**: It only takes effect if the `headerMenu` association
5010
+ * is set.
4964
5011
  *
4965
5012
  * Default value is `true`.
4966
5013
  *
@@ -5006,7 +5053,8 @@ declare namespace sap {
5006
5053
  * the binding property for sorting must be specified. For example, if the first name and last name are
5007
5054
  * displayed in the same column, only one of the two can be defined as `sortProperty`.
5008
5055
  *
5009
- * A column menu entry for sorting can only be generated if the `sortProperty` is set.
5056
+ * A column menu entry for sorting can only be generated if the `headerMenu` association and `sortProperty`
5057
+ * are set.
5010
5058
  *
5011
5059
  *
5012
5060
  * @returns Value of property `sortProperty`
@@ -5206,8 +5254,8 @@ declare namespace sap {
5206
5254
  * Therefore the binding property for filtering must be specified. For example, if the first name and last
5207
5255
  * name are displayed in the same column, only one of the two can be defined as `filterProperty`.
5208
5256
  *
5209
- * A column menu entry for filtering can only be generated if the `filterProperty` is set. The default menu
5210
- * entry is a text input field.
5257
+ * A column menu entry for filtering can only be generated if the `headerMenu` association and `filterProperty`
5258
+ * are set. The default menu entry is a text input field.
5211
5259
  *
5212
5260
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5213
5261
  *
@@ -5452,7 +5500,8 @@ declare namespace sap {
5452
5500
  /**
5453
5501
  * Sets a new value for property {@link #getShowFilterMenuEntry showFilterMenuEntry}.
5454
5502
  *
5455
- * Defines if the filter menu entry is displayed
5503
+ * Defines if the filter menu entry is displayed. **Note**: It only takes effect if the `headerMenu` association
5504
+ * is set.
5456
5505
  *
5457
5506
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5458
5507
  *
@@ -5471,7 +5520,8 @@ declare namespace sap {
5471
5520
  /**
5472
5521
  * Sets a new value for property {@link #getShowSortMenuEntry showSortMenuEntry}.
5473
5522
  *
5474
- * Defines if the sort menu entries are displayed
5523
+ * Defines if the sort menu entries are displayed. **Note**: It only takes effect if the `headerMenu` association
5524
+ * is set.
5475
5525
  *
5476
5526
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5477
5527
  *
@@ -5538,7 +5588,8 @@ declare namespace sap {
5538
5588
  * the binding property for sorting must be specified. For example, if the first name and last name are
5539
5589
  * displayed in the same column, only one of the two can be defined as `sortProperty`.
5540
5590
  *
5541
- * A column menu entry for sorting can only be generated if the `sortProperty` is set.
5591
+ * A column menu entry for sorting can only be generated if the `headerMenu` association and `sortProperty`
5592
+ * are set.
5542
5593
  *
5543
5594
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
5544
5595
  *
@@ -8796,7 +8847,9 @@ declare namespace sap {
8796
8847
  * rows minus number of fixed rows), this number is used as the `scrollThreshold`. If the value is 0, no
8797
8848
  * threshold is applied during scrolling. The value -1 applies the same value as the `threshold` property.
8798
8849
  *
8799
- * **Note:** This property only takes effect if it is set to a positive integer value.
8850
+ * **Note:** This property only takes effect if it is set to a positive integer value.
8851
+ *
8852
+ * The value of the `scrollThreshold` should be higher than the `threshold` value to avoid unnecessary requests.
8800
8853
  *
8801
8854
  * For `AnalyticalTable` and `TreeTable`, the `scrollThreshold` property must be higher than the `threshold`
8802
8855
  * property to take effect.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.128.0
1
+ // For Library Version: 1.129.0
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.128.0
1
+ // For Library Version: 1.129.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -7644,6 +7644,13 @@ declare namespace sap {
7644
7644
  * menu item. This event and the event of the menu items are redundant.
7645
7645
  */
7646
7646
  itemSelect?: (oEvent: Menu$ItemSelectEvent) => void;
7647
+
7648
+ /**
7649
+ * Fired when the menu is closed.
7650
+ *
7651
+ * @since 1.129
7652
+ */
7653
+ closed?: (oEvent: sap.ui.base.Event) => void;
7647
7654
  }
7648
7655
 
7649
7656
  /**
@@ -8753,6 +8760,11 @@ declare namespace sap {
8753
8760
  requestHeaders?: object[];
8754
8761
  }
8755
8762
 
8763
+ /**
8764
+ * Parameters of the Menu#closed event.
8765
+ */
8766
+ interface Menu$ClosedEventParameters {}
8767
+
8756
8768
  /**
8757
8769
  * Parameters of the Menu#itemSelect event.
8758
8770
  */
@@ -18109,6 +18121,55 @@ declare namespace sap {
18109
18121
  */
18110
18122
  oItem: sap.ui.unified.IMenuItem
18111
18123
  ): this;
18124
+ /**
18125
+ * Attaches event handler `fnFunction` to the {@link #event:closed closed} event of this `sap.ui.unified.Menu`.
18126
+ *
18127
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
18128
+ * otherwise it will be bound to this `sap.ui.unified.Menu` itself.
18129
+ *
18130
+ * Fired when the menu is closed.
18131
+ *
18132
+ * @since 1.129
18133
+ *
18134
+ * @returns Reference to `this` in order to allow method chaining
18135
+ */
18136
+ attachClosed(
18137
+ /**
18138
+ * An application-specific payload object that will be passed to the event handler along with the event
18139
+ * object when firing the event
18140
+ */
18141
+ oData: object,
18142
+ /**
18143
+ * The function to be called when the event occurs
18144
+ */
18145
+ fnFunction: (p1: sap.ui.base.Event) => void,
18146
+ /**
18147
+ * Context object to call the event handler with. Defaults to this `sap.ui.unified.Menu` itself
18148
+ */
18149
+ oListener?: object
18150
+ ): this;
18151
+ /**
18152
+ * Attaches event handler `fnFunction` to the {@link #event:closed closed} event of this `sap.ui.unified.Menu`.
18153
+ *
18154
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
18155
+ * otherwise it will be bound to this `sap.ui.unified.Menu` itself.
18156
+ *
18157
+ * Fired when the menu is closed.
18158
+ *
18159
+ * @since 1.129
18160
+ *
18161
+ * @returns Reference to `this` in order to allow method chaining
18162
+ */
18163
+ attachClosed(
18164
+ /**
18165
+ * The function to be called when the event occurs
18166
+ */
18167
+ fnFunction: (p1: sap.ui.base.Event) => void,
18168
+ /**
18169
+ * Context object to call the event handler with. Defaults to this `sap.ui.unified.Menu` itself
18170
+ */
18171
+ oListener?: object
18172
+ ): this;
18112
18173
  /**
18113
18174
  * Attaches event handler `fnFunction` to the {@link #event:itemSelect itemSelect} event of this `sap.ui.unified.Menu`.
18114
18175
  *
@@ -18171,6 +18232,25 @@ declare namespace sap {
18171
18232
  * @returns Reference to `this` in order to allow method chaining
18172
18233
  */
18173
18234
  destroyItems(): this;
18235
+ /**
18236
+ * Detaches event handler `fnFunction` from the {@link #event:closed closed} event of this `sap.ui.unified.Menu`.
18237
+ *
18238
+ * The passed function and listener object must match the ones used for event registration.
18239
+ *
18240
+ * @since 1.129
18241
+ *
18242
+ * @returns Reference to `this` in order to allow method chaining
18243
+ */
18244
+ detachClosed(
18245
+ /**
18246
+ * The function to be called, when the event occurs
18247
+ */
18248
+ fnFunction: (p1: sap.ui.base.Event) => void,
18249
+ /**
18250
+ * Context object on which the given function had to be called
18251
+ */
18252
+ oListener?: object
18253
+ ): this;
18174
18254
  /**
18175
18255
  * Detaches event handler `fnFunction` from the {@link #event:itemSelect itemSelect} event of this `sap.ui.unified.Menu`.
18176
18256
  *
@@ -18189,6 +18269,20 @@ declare namespace sap {
18189
18269
  */
18190
18270
  oListener?: object
18191
18271
  ): this;
18272
+ /**
18273
+ * Fires event {@link #event:closed closed} to attached listeners.
18274
+ *
18275
+ * @since 1.129
18276
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
18277
+ *
18278
+ * @returns Reference to `this` in order to allow method chaining
18279
+ */
18280
+ fireClosed(
18281
+ /**
18282
+ * Parameters to pass along with the event
18283
+ */
18284
+ mParameters?: object
18285
+ ): this;
18192
18286
  /**
18193
18287
  * Fires event {@link #event:itemSelect itemSelect} to attached listeners.
18194
18288
  *
@@ -22725,6 +22819,14 @@ declare namespace sap {
22725
22819
  FileUploader
22726
22820
  >;
22727
22821
 
22822
+ /**
22823
+ * Event object of the Menu#closed event.
22824
+ */
22825
+ type Menu$ClosedEvent = sap.ui.base.Event<
22826
+ Menu$ClosedEventParameters,
22827
+ Menu
22828
+ >;
22829
+
22728
22830
  /**
22729
22831
  * Event object of the Menu#itemSelect event.
22730
22832
  */
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.128.0
1
+ // For Library Version: 1.129.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.128.0
1
+ // For Library Version: 1.129.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.128.0
1
+ // For Library Version: 1.129.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.128.0
1
+ // For Library Version: 1.129.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.128.0
1
+ // For Library Version: 1.129.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.128.0
1
+ // For Library Version: 1.129.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.128.0
1
+ // For Library Version: 1.129.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.128.0
1
+ // For Library Version: 1.129.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace uiext {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.128.1
1
+ // For Library Version: 1.129.0
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -12987,11 +12987,15 @@ declare namespace sap {
12987
12987
  }
12988
12988
 
12989
12989
  /**
12990
- * The Unified Shell's ShellUIService service.
12990
+ * The ShellUIService for the unified shell can be used to modify the app title or the app hierarchy.
12991
12991
  *
12992
- * Allows apps to interact with the Fiori Launchpad UI. The service is injected in the app components by
12993
- * the FLP renderer before the corresponding apps start. To consume the service, app components should declare
12992
+ * Usage:
12993
+ *
12994
+ * Allows apps to interact with the SAP Fiori launchpad UI. A defined service is injected in the app components
12995
+ * by the FLP before the corresponding apps start. To consume the service, app components should declare
12994
12996
  * it in their "manifest.json" as follows:
12997
+ *
12998
+ *
12995
12999
  * ```javascript
12996
13000
  *
12997
13001
  * {
@@ -13008,28 +13012,38 @@ declare namespace sap {
13008
13012
  * ```
13009
13013
  *
13010
13014
  *
13011
- * The service can be then retrieved and consumed from the app root component as in the following example:
13015
+ * The service can then be retrieved and consumed by the app component as in the following example:
13016
+ *
13012
13017
  *
13013
13018
  * ```javascript
13014
13019
  *
13015
- * // Component.js (the app root component)
13020
+ * // Component.js (the app component)
13016
13021
  * ...
13017
- * this.getService("ShellUIService").then( // promise is returned
13018
- * function (oService) {
13019
- * oService.setTitle("Application Title");
13020
- * },
13021
- * function (oError) {
13022
- * Log.error("Cannot get ShellUIService", oError, "my.app.Component");
13023
- * }
13024
- * );
13022
+ * this.getService("ShellUIService") // promise is returned
13023
+ * .then(function (oService) {
13024
+ * oService.setTitle("Application Title");
13025
+ * })
13026
+ * .catch(function (oError) {
13027
+ * Log.error("Cannot get ShellUIService", oError, "my.app.Component");
13028
+ * });
13025
13029
  * ...
13026
13030
  * ```
13027
13031
  *
13028
13032
  *
13033
+ * The ShellUIService can also be used within nested components. Every component receives a separate instance
13034
+ * of the service. All service instances are independent and do not share any state. With this they can
13035
+ * also overwrite each other's settings. Nested components have to define the service in their own manifest
13036
+ * as well.
13037
+ *
13038
+ * **Note:** The ShellUIService is intended for use by applications only and should not be used by plugins.
13039
+ *
13040
+ * Auto Title and Hierarchy:
13041
+ *
13029
13042
  * The ShellUIService can work together with the routing defined in a UI5 app to set title and hierarchy
13030
13043
  * automatically, as the navigation within the app occurs. This can be achieved by enabling the ShellUIService
13031
13044
  * to load instantly and configuring one or both `setTitle` and `setHierarchy` options to `auto` in the
13032
- * app manifest, as shown in the example below:
13045
+ * app manifest. Using this mechanism disables the API to manually set the title or hierarchy via `setTitle`
13046
+ * and `setHierarchy`.
13033
13047
  *
13034
13048
  *
13035
13049
  * ```javascript
@@ -13051,12 +13065,9 @@ declare namespace sap {
13051
13065
  * ```
13052
13066
  *
13053
13067
  *
13054
- * Note that the `setHierarchy` or `setTitle` methods should not be actively called by the application when
13055
- * title and hierarchy are set automatically.
13056
- *
13057
13068
  * **Note:** Please be aware that the sapFiori2Adaptation configuration of the application may cause the
13058
13069
  * ShellUIService service to work incorrectly. We recommend to disable the sapFiori2Adaptation configuration
13059
- * for the new applications if you use ShellUIService.
13070
+ * for the new applications if you use the ShellUIService.
13060
13071
  *
13061
13072
  * @since 1.38.0
13062
13073
  */
@@ -13100,23 +13111,22 @@ declare namespace sap {
13100
13111
  */
13101
13112
  static getMetadata(): sap.ui.base.Metadata;
13102
13113
  /**
13103
- * Returns the title that was last set via {@link setTitle}.
13114
+ * Returns the current title shown in the header. This might differ from the title set by the via {@link #setTitle}.
13104
13115
  *
13105
13116
  * @since 1.38.0
13106
13117
  *
13107
- * @returns The title that was last set via {@link setTitle}.
13118
+ * @returns The current title.
13108
13119
  */
13109
13120
  getTitle(): string;
13110
13121
  /**
13111
- * Displays the given hierarchy in the shell header.
13122
+ * Displays the given hierarchy in the shell header. The default app hierarchy is applied if no parameter
13123
+ * is given.
13112
13124
  *
13113
13125
  * @since 1.38.0
13114
13126
  */
13115
13127
  setHierarchy(
13116
13128
  /**
13117
13129
  * An array representing hierarchies of the currently displayed app.
13118
- *
13119
- * The default app hierarchy is applied if no parameter is given.
13120
13130
  */
13121
13131
  aHierarchyLevels?: sap.ushell.ui5service.ShellUIService.AppInfo[]
13122
13132
  ): void;
@@ -13681,12 +13691,16 @@ declare namespace sap {
13681
13691
  }
13682
13692
 
13683
13693
  interface IUI5DefineDependencyNames {
13694
+ "sap/ushell/api/Copilot": undefined;
13695
+
13684
13696
  "sap/ushell/api/Inbox": undefined;
13685
13697
 
13686
13698
  "sap/ushell/api/NewExperience": undefined;
13687
13699
 
13688
13700
  "sap/ushell/api/RTA": undefined;
13689
13701
 
13702
+ "sap/ushell/api/S4MyHome": undefined;
13703
+
13690
13704
  "sap/ushell/api/workpage/Designtime": undefined;
13691
13705
 
13692
13706
  "sap/ushell/api/workpage/Runtime": undefined;
@@ -13803,6 +13817,8 @@ declare namespace sap {
13803
13817
 
13804
13818
  "sap/ushell/services/UsageAnalytics": undefined;
13805
13819
 
13820
+ "sap/ushell/services/UserDefaultParameters": undefined;
13821
+
13806
13822
  "sap/ushell/services/UserInfo": undefined;
13807
13823
 
13808
13824
  "sap/ushell/services/UserRecents": undefined;
@@ -13831,7 +13847,9 @@ declare namespace sap {
13831
13847
 
13832
13848
  "sap/ushell/ui/tile/StaticTile": undefined;
13833
13849
 
13834
- "sap/ushell/ui5service/_ShellUIService/shelluiservice.class.factory": undefined;
13850
+ "sap/ushell/ui5service/ShellUIService": undefined;
13851
+
13852
+ "sap/ushell/ui5service/ShellUIServiceFactory": undefined;
13835
13853
 
13836
13854
  "sap/ushell/ui5service/UserStatus": undefined;
13837
13855
 
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.128.1
1
+ // For Library Version: 1.129.0
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.128.0
1
+ // For Library Version: 1.129.0
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.128.0
1
+ // For Library Version: 1.129.0
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.128.0
1
+ // For Library Version: 1.129.0
2
2
 
3
3
  declare namespace sap {}
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.128.0
1
+ // For Library Version: 1.129.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace zen {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.128.0
1
+ // For Library Version: 1.129.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace zen {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.128.0
1
+ // For Library Version: 1.129.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace zen {