@sapui5/types 1.115.0 → 1.116.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 (66) hide show
  1. package/README.md +5 -3
  2. package/package.json +1 -1
  3. package/types/index.d.ts +11 -3
  4. package/types/sap.apf.d.ts +47 -40
  5. package/types/sap.ca.ui.d.ts +171 -161
  6. package/types/sap.chart.d.ts +56 -47
  7. package/types/sap.collaboration.d.ts +31 -38
  8. package/types/sap.esh.search.ui.d.ts +112 -109
  9. package/types/sap.f.d.ts +718 -786
  10. package/types/sap.fe.core.d.ts +206 -92
  11. package/types/sap.fe.macros.d.ts +66 -40
  12. package/types/sap.fe.navigation.d.ts +9 -13
  13. package/types/sap.fe.placeholder.d.ts +3 -0
  14. package/types/sap.fe.templates.d.ts +11 -9
  15. package/types/sap.fe.test.d.ts +40 -69
  16. package/types/sap.fe.tools.d.ts +3 -0
  17. package/types/sap.feedback.ui.d.ts +1 -1
  18. package/types/sap.gantt.d.ts +1223 -1502
  19. package/types/sap.insights.d.ts +3 -3
  20. package/types/sap.landvisz.d.ts +73 -67
  21. package/types/sap.m.d.ts +6504 -6706
  22. package/types/sap.makit.d.ts +55 -56
  23. package/types/sap.me.d.ts +71 -79
  24. package/types/sap.ndc.d.ts +44 -36
  25. package/types/sap.ovp.d.ts +25 -8
  26. package/types/sap.rules.ui.d.ts +38 -51
  27. package/types/sap.sac.df.d.ts +11 -12
  28. package/types/sap.suite.ui.commons.d.ts +1180 -1233
  29. package/types/sap.suite.ui.generic.template.d.ts +75 -82
  30. package/types/sap.suite.ui.microchart.d.ts +280 -291
  31. package/types/sap.tnt.d.ts +119 -86
  32. package/types/sap.ui.codeeditor.d.ts +28 -25
  33. package/types/sap.ui.commons.d.ts +691 -684
  34. package/types/sap.ui.comp.d.ts +2247 -2189
  35. package/types/sap.ui.core.d.ts +2434 -2444
  36. package/types/sap.ui.dt.d.ts +1 -1
  37. package/types/sap.ui.export.d.ts +38 -33
  38. package/types/sap.ui.fl.d.ts +55 -82
  39. package/types/sap.ui.generic.app.d.ts +39 -43
  40. package/types/sap.ui.generic.template.d.ts +1 -1
  41. package/types/sap.ui.integration.d.ts +401 -292
  42. package/types/sap.ui.layout.d.ts +369 -420
  43. package/types/sap.ui.mdc.d.ts +1557 -1344
  44. package/types/sap.ui.richtexteditor.d.ts +40 -33
  45. package/types/sap.ui.rta.d.ts +7 -7
  46. package/types/sap.ui.suite.d.ts +13 -11
  47. package/types/sap.ui.support.d.ts +12 -13
  48. package/types/sap.ui.table.d.ts +366 -368
  49. package/types/sap.ui.testrecorder.d.ts +1 -1
  50. package/types/sap.ui.unified.d.ts +961 -1007
  51. package/types/sap.ui.ux3.d.ts +663 -653
  52. package/types/sap.ui.vbm.d.ts +568 -541
  53. package/types/sap.ui.vk.d.ts +1511 -1834
  54. package/types/sap.ui.vtm.d.ts +335 -329
  55. package/types/sap.ui.webc.common.d.ts +7 -9
  56. package/types/sap.ui.webc.fiori.d.ts +1099 -509
  57. package/types/sap.ui.webc.main.d.ts +4937 -1323
  58. package/types/sap.uiext.inbox.d.ts +73 -63
  59. package/types/sap.ushell.d.ts +492 -1024
  60. package/types/sap.ushell_abap.d.ts +1 -1
  61. package/types/sap.uxap.d.ts +244 -277
  62. package/types/sap.viz.d.ts +993 -856
  63. package/types/sap.webanalytics.core.d.ts +1 -1
  64. package/types/sap.zen.commons.d.ts +7 -12
  65. package/types/sap.zen.crosstab.d.ts +4 -7
  66. package/types/sap.zen.dsh.d.ts +133 -157
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.115.0
1
+ // For Library Version: 1.116.0
2
2
 
3
3
  declare module "sap/suite/ui/generic/template/library" {
4
4
  /**
@@ -43,7 +43,7 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
43
43
  */
44
44
  interface controllerFrameworkExtensions {
45
45
  /**
46
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
46
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
47
47
  *
48
48
  * This method is called by SAP Fiori elements before triggering an external navigation. Application developers
49
49
  * can override this method and programmatically adapt the parameters which are passed to the target application.
@@ -70,14 +70,14 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
70
70
  }
71
71
  ): void;
72
72
  /**
73
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
73
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
74
74
  *
75
75
  * This method is called by SAP Fiori elements whenever the busy state is switched off. Application developers
76
76
  * can override this method, access the message model and adapt the transient messages related to the component.
77
77
  */
78
78
  adaptTransientMessageExtension(): void;
79
79
  /**
80
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
80
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
81
81
  *
82
82
  * This method is called by SAP Fiori elements when a smart link in a table is clicked. Application developers
83
83
  * can override this method and invoke the oParams.getSourceInfo method to find out the information about
@@ -105,7 +105,7 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
105
105
  }
106
106
  ): boolean;
107
107
  /**
108
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
108
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
109
109
  *
110
110
  * This method is called by SAP Fiori elements before persisting the AppState. Application developers can
111
111
  * override this method for persisting the state of custom controls. State of the custom control (controls)
@@ -119,7 +119,7 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
119
119
  oCustomData: object
120
120
  ): void;
121
121
  /**
122
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
122
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
123
123
  *
124
124
  * This method is called in the AppState creation lifecycle. Application developers can override this method,
125
125
  * return an array of all selection fields set on SmartFilterBar using custom code as default and doesn't
@@ -131,7 +131,7 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
131
131
  */
132
132
  getVisibleSelectionsWithDefaults(): any[];
133
133
  /**
134
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
134
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
135
135
  *
136
136
  * This method is called by SAP Fiori elements in the startup life cycle of a component. Application developers
137
137
  * can override this method and modify the startup object. For an example, when the application is started,
@@ -156,7 +156,7 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
156
156
  }
157
157
  ): void;
158
158
  /**
159
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
159
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
160
160
  *
161
161
  * This method is called by SAP Fiori elements when the table data is getting exported. Application developers
162
162
  * can override this method to add/remove the filters in the exported file.
@@ -181,7 +181,7 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
181
181
  }
182
182
  ): void;
183
183
  /**
184
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
184
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
185
185
  *
186
186
  * This method is called by SAP Fiori elements before binding a chart. Application developers can override
187
187
  * this method and programmatically modify parameters or filters before chart triggers a query to retrieve
@@ -196,7 +196,7 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
196
196
  oEvent: Event
197
197
  ): void;
198
198
  /**
199
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
199
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
200
200
  *
201
201
  * This method is called by SAP Fiori elements before binding a filterable KPI. Application developers can
202
202
  * override this method to modify parameters or filters for a filterable KPI.
@@ -216,7 +216,7 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
216
216
  sKPIId: string
217
217
  ): void;
218
218
  /**
219
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
219
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
220
220
  *
221
221
  * This method is called by SAP Fiori elements before binding a table. Application developers can override
222
222
  * this method and programmatically modify parameters or filters before the table triggers a query to retrieve
@@ -231,7 +231,7 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
231
231
  oEvent: Event
232
232
  ): void;
233
233
  /**
234
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
234
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
235
235
  *
236
236
  * This method is called by SAP Fiori elements before binding a visual filter. Application developers can
237
237
  * override this method and programmatically modify parameters, filters, or influence sorting before the
@@ -275,7 +275,7 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
275
275
  }
276
276
  ): void;
277
277
  /**
278
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
278
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
279
279
  *
280
280
  * This method should be implemented whenever application uses onListNavigationExtension for internal navigation.
281
281
  * In this case the implementation of this method should provide an 'inverse' mapping to the transformation
@@ -308,7 +308,7 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
308
308
  fnSetPath: Function
309
309
  ): void;
310
310
  /**
311
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
311
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
312
312
  *
313
313
  * This method is called by SAP Fiori elements when the Clear button on the filter dialog is clicked. Application
314
314
  * developers can override this method to clear custom filters.
@@ -320,14 +320,14 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
320
320
  oEvent: Event
321
321
  ): void;
322
322
  /**
323
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
323
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
324
324
  *
325
325
  * This method is called by Fiori elements on the initialization of View. Application developers can override
326
326
  * this method & perform internal setup in this hook.
327
327
  */
328
328
  onInit(): void;
329
329
  /**
330
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
330
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
331
331
  *
332
332
  * This method is called by SAP Fiori elements once the smart filter bar is initialized with a variant.
333
333
  * Application developers can override this method when there is a custom filter field bound outside the
@@ -340,7 +340,7 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
340
340
  oEvent: Event
341
341
  ): void;
342
342
  /**
343
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
343
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
344
344
  *
345
345
  * This method is called when the user leaves the app and this page has been displayed within the same app
346
346
  * session (this is the time since last opening the app) at least once. Moreover, it is called for all pages
@@ -358,7 +358,7 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
358
358
  bIsDestroyed: boolean
359
359
  ): Function;
360
360
  /**
361
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
361
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
362
362
  *
363
363
  * This method is called by SAP Fiori elements when a chevron navigation is triggered from a table. Application
364
364
  * developers can override this method and perform conditional (internal or external) navigation from different
@@ -384,7 +384,7 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
384
384
  bReplaceInHistory: boolean
385
385
  ): boolean;
386
386
  /**
387
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
387
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
388
388
  *
389
389
  * This method is called by SAP Fiori elements when the Share functionality is triggered. Application developers
390
390
  * can adapt the service URL passed as a parameter to this method. Adapted service URL will be used in the
@@ -402,7 +402,7 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/controllerFrame
402
402
  }
403
403
  ): void;
404
404
  /**
405
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
405
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
406
406
  *
407
407
  * This method is called by SAP Fiori elements while applying the AppState. This method should be overridden
408
408
  * with `getCustomAppStateDataExtension`. The custom data retrieved from the AppState will be passed as
@@ -431,7 +431,7 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/extensionAPI/Ex
431
431
 
432
432
  import Context from "sap/ui/model/Context";
433
433
 
434
- class ExtensionAPI extends BaseObject {
434
+ export default class ExtensionAPI extends BaseObject {
435
435
  /**
436
436
  * API to be used in extensions of AnalyticalListPage. Breakout coding can access an instance of this class
437
437
  * via `this.extensionAPI`. Do not instantiate yourself.
@@ -613,7 +613,6 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/extensionAPI/Ex
613
613
  onClose?: Function
614
614
  ): void;
615
615
  }
616
- export default ExtensionAPI;
617
616
  }
618
617
 
619
618
  declare module "sap/suite/ui/generic/template/Canvas/extensionAPI/ExtensionAPI" {
@@ -635,7 +634,7 @@ declare module "sap/suite/ui/generic/template/Canvas/extensionAPI/ExtensionAPI"
635
634
 
636
635
  import Context from "sap/ui/model/Context";
637
636
 
638
- class ExtensionAPI extends BaseObject {
637
+ export default class ExtensionAPI extends BaseObject {
639
638
  /**
640
639
  * API to be used in extensions of Canvas. Breakout coding can access an instance of this class via `this.extensionAPI`.
641
640
  * Do not instantiate yourself.
@@ -883,7 +882,6 @@ declare module "sap/suite/ui/generic/template/Canvas/extensionAPI/ExtensionAPI"
883
882
  }
884
883
  ): Promise<any>;
885
884
  }
886
- export default ExtensionAPI;
887
885
  }
888
886
 
889
887
  declare module "sap/suite/ui/generic/template/extensionAPI/extensionAPI" {
@@ -964,7 +962,7 @@ declare module "sap/suite/ui/generic/template/extensionAPI/NavigationController"
964
962
 
965
963
  import { displayMode } from "sap/suite/ui/generic/template/library";
966
964
 
967
- class NavigationController extends BaseObject {
965
+ export default class NavigationController extends BaseObject {
968
966
  /**
969
967
  * API to be used for navigation in extensions of Smart Template Applications. Breakout coding can access
970
968
  * an instance of this class via {@link sap.suite.ui.generic.template.ListReport.extensionAPI.ExtensionAPI }
@@ -1044,7 +1042,7 @@ declare module "sap/suite/ui/generic/template/extensionAPI/NavigationController"
1044
1042
  */
1045
1043
  replaceInHistory?: boolean;
1046
1044
  /**
1047
- * This gives the provision to the application developer to chosse between "display"/"edit" mode for target
1045
+ * This gives the provision to the application developer to choose between "display"/"edit" mode for target
1048
1046
  * page
1049
1047
  */
1050
1048
  displayMode?: displayMode | keyof typeof displayMode;
@@ -1082,7 +1080,6 @@ declare module "sap/suite/ui/generic/template/extensionAPI/NavigationController"
1082
1080
  mParameters: object
1083
1081
  ): void;
1084
1082
  }
1085
- export default NavigationController;
1086
1083
  }
1087
1084
 
1088
1085
  declare module "sap/suite/ui/generic/template/extensionAPI/ReuseComponentSupport" {
@@ -1150,7 +1147,7 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1150
1147
  /**
1151
1148
  * Smart Templates Application Component
1152
1149
  */
1153
- class AppComponent extends UIComponent {
1150
+ export default class AppComponent extends UIComponent {
1154
1151
  /**
1155
1152
  * Main class used for Smart Template(Fiori elements V2) Application Component
1156
1153
  *
@@ -1253,7 +1250,7 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1253
1250
  oListener?: object
1254
1251
  ): this;
1255
1252
  /**
1256
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1253
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1257
1254
  *
1258
1255
  * Fires event {@link #event:pageDataLoaded pageDataLoaded} to attached listeners.
1259
1256
  *
@@ -1553,7 +1550,6 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1553
1550
  bUseColumnLayoutForSmartForm?: boolean
1554
1551
  ): this;
1555
1552
  }
1556
- export default AppComponent;
1557
1553
 
1558
1554
  export interface $AppComponentSettings extends $UIComponentSettings {
1559
1555
  forceGlobalRefresh?: boolean | PropertyBindingInfo | `{${string}}`;
@@ -1594,7 +1590,9 @@ declare module "sap/suite/ui/generic/template/lib/AppComponent" {
1594
1590
  pageDataLoaded?: (oEvent: Event) => void;
1595
1591
  }
1596
1592
 
1597
- export interface $AppComponentPageDataLoadedEventParameters {}
1593
+ export interface AppComponent$PageDataLoadedEventParameters {}
1594
+
1595
+ export type AppComponent$PageDataLoadedEvent = Event<AppComponent$PageDataLoadedEventParameters>;
1598
1596
  }
1599
1597
 
1600
1598
  declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExtensions" {
@@ -1614,7 +1612,7 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1614
1612
  */
1615
1613
  interface controllerFrameworkExtensions {
1616
1614
  /**
1617
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1615
+ * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1618
1616
  *
1619
1617
  * Obsolete and not called anymore. Kept here to avoid conflicts (in the very unlikely case, Fiori elements
1620
1618
  * would come up with the idea to invent a new extension method with the exact same name some day in future,
@@ -1638,7 +1636,7 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1638
1636
  getVisibleSelectionsWithDefaults: undefined;
1639
1637
 
1640
1638
  /**
1641
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1639
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1642
1640
  *
1643
1641
  * This method is called by SAP Fiori elements before triggering an external navigation. Application developers
1644
1642
  * can override this method and programmatically adapt the parameters which are passed to the target application.
@@ -1665,14 +1663,14 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1665
1663
  }
1666
1664
  ): void;
1667
1665
  /**
1668
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1666
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1669
1667
  *
1670
1668
  * This method is called by SAP Fiori elements whenever the busy state is switched off. Application developers
1671
1669
  * can override this method, access the message model and adapt the transient messages related to the component.
1672
1670
  */
1673
1671
  adaptTransientMessageExtension(): void;
1674
1672
  /**
1675
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1673
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1676
1674
  *
1677
1675
  * This method is called by SAP Fiori elements when the delete operation is triggered. Application developers
1678
1676
  * can override this method in controller extension & perform additional checks before executing the delete
@@ -1693,7 +1691,7 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1693
1691
  }
1694
1692
  ): Promise<any>;
1695
1693
  /**
1696
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1694
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1697
1695
  *
1698
1696
  * This method should be implemented whenever the application needs to have a custom save functionality
1699
1697
  * for multi edit scenario. The logic for save should be defined here and this method should return a promise
@@ -1720,7 +1718,7 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1720
1718
  }>
1721
1719
  ): Promise<any>;
1722
1720
  /**
1723
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1721
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1724
1722
  *
1725
1723
  * This method is called by SAP Fiori elements when a smart link in a table is clicked. Application developers
1726
1724
  * can override this method and invoke the oParams.getSourceInfo method to find out the information about
@@ -1748,7 +1746,7 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1748
1746
  }
1749
1747
  ): boolean;
1750
1748
  /**
1751
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1749
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1752
1750
  *
1753
1751
  * This method is called by SAP Fiori elements before persisting the AppState. Application developers can
1754
1752
  * override this method for persisting the state of custom controls. State of the custom control (controls)
@@ -1777,7 +1775,7 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1777
1775
  oCustomData: object
1778
1776
  ): void;
1779
1777
  /**
1780
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1778
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1781
1779
  *
1782
1780
  * This method is called by SAP Fiori elements when the Create with Filters is executed. Application developers
1783
1781
  * can enable this feature in the LR component by adding createWithFilters in the settings object of the
@@ -1799,7 +1797,7 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1799
1797
  oDefaultValues: object
1800
1798
  ): Map<any, any>;
1801
1799
  /**
1802
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1800
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1803
1801
  *
1804
1802
  * This method is called by SAP Fiori elements in the startup life cycle of a component. Application developers
1805
1803
  * can override this method and modify the startup object. For an example, when the application is started,
@@ -1832,7 +1830,7 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1832
1830
  }
1833
1831
  ): void;
1834
1832
  /**
1835
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1833
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1836
1834
  *
1837
1835
  * This method is called by SAP Fiori elements when the table data is getting exported. Application developers
1838
1836
  * can override this method to add/remove the filters in the exported file.
@@ -1857,7 +1855,7 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1857
1855
  }
1858
1856
  ): void;
1859
1857
  /**
1860
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1858
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1861
1859
  *
1862
1860
  * This method is called by SAP Fiori elements before binding a chart. Application developers can override
1863
1861
  * this method and programmatically modify parameters or filters before chart triggers a query to retrieve
@@ -1874,7 +1872,7 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1874
1872
  oEvent: Event
1875
1873
  ): void;
1876
1874
  /**
1877
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1875
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1878
1876
  *
1879
1877
  * This method is called by SAP Fiori elements before binding a table. Application developers can override
1880
1878
  * this method and programmatically modify parameters or filters before the table triggers a query to retrieve
@@ -1891,7 +1889,7 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1891
1889
  oEvent: Event
1892
1890
  ): void;
1893
1891
  /**
1894
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1892
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1895
1893
  *
1896
1894
  * This method should be implemented whenever application uses onListNavigationExtension for internal navigation.
1897
1895
  * In this case the implementation of this method should provide an 'inverse' mapping to the transformation
@@ -1924,14 +1922,14 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1924
1922
  fnSetPath: Function
1925
1923
  ): void;
1926
1924
  /**
1927
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1925
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1928
1926
  *
1929
1927
  * This method is called by SAP Fiori elements on the initialization of View. Application developers can
1930
1928
  * override this method & perform internal setup in this hook, It is only called once per View instance.
1931
1929
  */
1932
1930
  onInit(): void;
1933
1931
  /**
1934
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1932
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1935
1933
  *
1936
1934
  * This method is called by SAP Fiori elements once the smart filter bar is initialized with a variant.
1937
1935
  *
@@ -1950,7 +1948,7 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1950
1948
  oEvent: Event
1951
1949
  ): void;
1952
1950
  /**
1953
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1951
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1954
1952
  *
1955
1953
  * This method is called when the user leaves the app and this page has been displayed within the same app
1956
1954
  * session (this is the time since last opening the app) at least once. Moreover, it is called for all pages
@@ -1968,7 +1966,7 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1968
1966
  bIsDestroyed: boolean
1969
1967
  ): Function;
1970
1968
  /**
1971
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1969
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1972
1970
  *
1973
1971
  * This method is called by SAP Fiori elements when a chevron navigation is triggered from a table. Application
1974
1972
  * developers can override this method and perform conditional (internal or external) navigation from different
@@ -1994,7 +1992,7 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
1994
1992
  bReplaceInHistory: boolean
1995
1993
  ): boolean;
1996
1994
  /**
1997
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1995
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1998
1996
  *
1999
1997
  * This method is called by SAP Fiori elements when the Share functionality is triggered. Application developers
2000
1998
  * can adapt the service URL passed as a parameter to this method. Adapted service URL will be used in the
@@ -2012,7 +2010,7 @@ declare module "sap/suite/ui/generic/template/ListReport/controllerFrameworkExte
2012
2010
  }
2013
2011
  ): void;
2014
2012
  /**
2015
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2013
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2016
2014
  *
2017
2015
  * This method is called by SAP Fiori elements while applying the AppState. This method should be overridden
2018
2016
  * in combination with `getCustomAppStateDataExtension`. The custom data retrieved from the AppState will
@@ -2052,7 +2050,7 @@ declare module "sap/suite/ui/generic/template/ListReport/extensionAPI/ExtensionA
2052
2050
 
2053
2051
  import NonDraftTransactionController from "sap/suite/ui/generic/template/ListReport/extensionAPI/NonDraftTransactionController";
2054
2052
 
2055
- class ExtensionAPI extends BaseObject {
2053
+ export default class ExtensionAPI extends BaseObject {
2056
2054
  /**
2057
2055
  * API to be used in extensions of ListReport. Breakout coding can access an instance of this class via
2058
2056
  * `this.extensionAPI`. Do not instantiate yourself.
@@ -2106,7 +2104,7 @@ declare module "sap/suite/ui/generic/template/ListReport/extensionAPI/ExtensionA
2106
2104
  */
2107
2105
  getNavigationController(): NavigationController;
2108
2106
  /**
2109
- * @EXPERIMENTAL
2107
+ * @experimental
2110
2108
  *
2111
2109
  * If switching between different table views is enabled, this function returns the selected key.
2112
2110
  *
@@ -2304,7 +2302,7 @@ declare module "sap/suite/ui/generic/template/ListReport/extensionAPI/ExtensionA
2304
2302
  onClose?: Function
2305
2303
  ): void;
2306
2304
  /**
2307
- * @EXPERIMENTAL
2305
+ * @experimental
2308
2306
  *
2309
2307
  * If switching between different table views is enabled, this function sets the selected key.
2310
2308
  */
@@ -2315,7 +2313,6 @@ declare module "sap/suite/ui/generic/template/ListReport/extensionAPI/ExtensionA
2315
2313
  sKey: string
2316
2314
  ): void;
2317
2315
  }
2318
- export default ExtensionAPI;
2319
2316
  }
2320
2317
 
2321
2318
  declare module "sap/suite/ui/generic/template/ListReport/extensionAPI/NonDraftTransactionController" {
@@ -2325,7 +2322,7 @@ declare module "sap/suite/ui/generic/template/ListReport/extensionAPI/NonDraftTr
2325
2322
 
2326
2323
  import Metadata from "sap/ui/base/Metadata";
2327
2324
 
2328
- class NonDraftTransactionController extends BaseObject {
2325
+ export default class NonDraftTransactionController extends BaseObject {
2329
2326
  /**
2330
2327
  * Non draft transaction controller to be used in extensions of ListReport. Breakout coding can access an
2331
2328
  * instance of this class via `ExtensionAPI.getTransactionController`. Do not instantiate yourself.
@@ -2403,7 +2400,6 @@ declare module "sap/suite/ui/generic/template/ListReport/extensionAPI/NonDraftTr
2403
2400
  */
2404
2401
  save(): Promise<any>;
2405
2402
  }
2406
- export default NonDraftTransactionController;
2407
2403
  }
2408
2404
 
2409
2405
  declare module "sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExtensions" {
@@ -2423,7 +2419,7 @@ declare module "sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExte
2423
2419
  */
2424
2420
  interface controllerFrameworkExtensions {
2425
2421
  /**
2426
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2422
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2427
2423
  *
2428
2424
  * This method is called by SAP Fiori elements before triggering an external navigation. Application developers
2429
2425
  * can override this method and programmatically adapt the parameters which are passed to the target application.
@@ -2450,14 +2446,14 @@ declare module "sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExte
2450
2446
  }
2451
2447
  ): void;
2452
2448
  /**
2453
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2449
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2454
2450
  *
2455
2451
  * This method is called by SAP Fiori elements whenever the busy state is switched off. Application developers
2456
2452
  * can override this method, access the message model and adapt the transient messages related to the component.
2457
2453
  */
2458
2454
  adaptTransientMessageExtension(): void;
2459
2455
  /**
2460
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2456
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2461
2457
  *
2462
2458
  * This method will be called by SAP Fiori elements while applying the AppState. The custom state object
2463
2459
  * retrieved from the AppState will be passed as a parameter to this method. Application developers can
@@ -2479,7 +2475,7 @@ declare module "sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExte
2479
2475
  bIsSameAsLast: boolean
2480
2476
  ): void;
2481
2477
  /**
2482
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2478
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2483
2479
  *
2484
2480
  * This method is called by SAP Fiori element when Delete button on the Object Page is clicked. Application
2485
2481
  * developers can override this method & perform additional checks before executing the delete operation.
@@ -2490,7 +2486,7 @@ declare module "sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExte
2490
2486
  */
2491
2487
  beforeDeleteExtension(): Promise<any>;
2492
2488
  /**
2493
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2489
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2494
2490
  *
2495
2491
  * This method is called when the Delete operation is triggered on a table in the Object Page. Application
2496
2492
  * developers can override this method & perform additional checks before executing the delete operation.
@@ -2517,7 +2513,7 @@ declare module "sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExte
2517
2513
  }
2518
2514
  ): Promise<any>;
2519
2515
  /**
2520
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2516
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2521
2517
  *
2522
2518
  * This method is called by SAP Fiori elements when Save button is clicked. Application developers can override
2523
2519
  * this method & perform additional checks before executing the Save operation. Method is expected to return
@@ -2528,7 +2524,7 @@ declare module "sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExte
2528
2524
  */
2529
2525
  beforeSaveExtension(): Promise<any>;
2530
2526
  /**
2531
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2527
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2532
2528
  *
2533
2529
  * This method is called by SAP Fiori elements when a smart link in a table or form is clicked. Application
2534
2530
  * developers can override this method and invoke the oParams.getSourceInfo method to find out the information
@@ -2556,7 +2552,7 @@ declare module "sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExte
2556
2552
  }
2557
2553
  ): boolean;
2558
2554
  /**
2559
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2555
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2560
2556
  *
2561
2557
  * This method is called by SAP Fiori elements when the table data is getting exported. Application developers
2562
2558
  * can override this method to add/remove the filters in the exported file.
@@ -2581,7 +2577,7 @@ declare module "sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExte
2581
2577
  }
2582
2578
  ): void;
2583
2579
  /**
2584
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2580
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2585
2581
  *
2586
2582
  * This method is called by SAP Fiori elements before binding a table. Application developers can override
2587
2583
  * this method and programmatically modify parameters or filters before the table triggers a query to retrieve
@@ -2596,7 +2592,7 @@ declare module "sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExte
2596
2592
  oEvent: Event
2597
2593
  ): void;
2598
2594
  /**
2599
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2595
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2600
2596
  *
2601
2597
  * This method should be implemented whenever application uses onListNavigationExtension for internal navigation.
2602
2598
  * In this case the implementation of this method should provide an 'inverse' mapping to the transformation
@@ -2629,14 +2625,14 @@ declare module "sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExte
2629
2625
  fnSetPath: Function
2630
2626
  ): void;
2631
2627
  /**
2632
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2628
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2633
2629
  *
2634
2630
  * This method is called by SAP Fiori elements on the initialization of View. Application developers can
2635
2631
  * override this method & perform internal setup in this hook.
2636
2632
  */
2637
2633
  onInit(): void;
2638
2634
  /**
2639
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2635
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2640
2636
  *
2641
2637
  * This method is called when the user leaves the app and this page has been displayed within the same app
2642
2638
  * session (this is the time since last opening the app) at least once. Moreover, it is called for all pages
@@ -2654,7 +2650,7 @@ declare module "sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExte
2654
2650
  bIsDestroyed: boolean
2655
2651
  ): Function;
2656
2652
  /**
2657
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2653
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2658
2654
  *
2659
2655
  * This method is called by SAP Fiori elements when a chevron navigation is triggered from a table. Application
2660
2656
  * developers can override this method and perform conditional (internal or external) navigation from different
@@ -2680,7 +2676,7 @@ declare module "sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExte
2680
2676
  bReplaceInHistory: boolean
2681
2677
  ): boolean;
2682
2678
  /**
2683
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2679
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2684
2680
  *
2685
2681
  * This method is called by SAP Fiori elements when the Share functionality is triggered. Application developers
2686
2682
  * can adapt the service URL passed as a parameter to this method. Adapted service URL will be used in the
@@ -2698,7 +2694,7 @@ declare module "sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExte
2698
2694
  }
2699
2695
  ): void;
2700
2696
  /**
2701
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2697
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2702
2698
  *
2703
2699
  * This method is called when the SubSection enters the Viewport first time for an ObjectPage. Method would
2704
2700
  * be called again for the same SubSection only in case ObjectPage binding context is changed. Application
@@ -2713,7 +2709,7 @@ declare module "sap/suite/ui/generic/template/ObjectPage/controllerFrameworkExte
2713
2709
  oSubSection: ObjectPageSubSection
2714
2710
  ): void;
2715
2711
  /**
2716
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2712
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2717
2713
  *
2718
2714
  * This method will be called by SAP Fiori elements before persisting the AppState. Application developers
2719
2715
  * can override this method for persisting the state of custom controls. State of the custom controls should
@@ -2738,7 +2734,7 @@ declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/DraftTrans
2738
2734
 
2739
2735
  import Metadata from "sap/ui/base/Metadata";
2740
2736
 
2741
- class DraftTransactionController extends BaseObject {
2737
+ export default class DraftTransactionController extends BaseObject {
2742
2738
  /**
2743
2739
  * Draft transaction controller to be used in extensions of ObjectPage. Breakout coding can access an instance
2744
2740
  * of this class via `ExtensionAPI.getTransactionController`. Do not instantiate yourself.
@@ -2838,7 +2834,7 @@ declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/DraftTrans
2838
2834
  fnFunction: Function
2839
2835
  ): void;
2840
2836
  /**
2841
- * @EXPERIMENTAL
2837
+ * @experimental
2842
2838
  *
2843
2839
  * Cancel the draft. Note that this method only works when you are on the root of a draft. The normal navigation
2844
2840
  * which follows the cancellation of a draft is executed. Moreover, note that executing this method will
@@ -2849,7 +2845,7 @@ declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/DraftTrans
2849
2845
  */
2850
2846
  discardDraft(): Function;
2851
2847
  /**
2852
- * @EXPERIMENTAL
2848
+ * @experimental
2853
2849
  *
2854
2850
  * checks if side effects exist for the given properties or entities and executes them. if there are pending
2855
2851
  * changes in the model those pending changes are sent as a patch request with the side effect batch request.
@@ -2889,7 +2885,6 @@ declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/DraftTrans
2889
2885
  fnFunction: Function
2890
2886
  ): void;
2891
2887
  }
2892
- export default DraftTransactionController;
2893
2888
  }
2894
2889
 
2895
2890
  declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/ExtensionAPI" {
@@ -2907,7 +2902,7 @@ declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/ExtensionA
2907
2902
 
2908
2903
  import NonDraftTransactionController from "sap/suite/ui/generic/template/ObjectPage/extensionAPI/NonDraftTransactionController";
2909
2904
 
2910
- class ExtensionAPI extends BaseObject {
2905
+ export default class ExtensionAPI extends BaseObject {
2911
2906
  /**
2912
2907
  * API to be used in extensions of ObjectPage. Breakout coding can access an instance of this class via
2913
2908
  * `this.extensionAPI`. Do not instantiate yourself.
@@ -2982,7 +2977,7 @@ declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/ExtensionA
2982
2977
  */
2983
2978
  getNavigationController(): NavigationController;
2984
2979
  /**
2985
- * @EXPERIMENTAL
2980
+ * @experimental
2986
2981
  *
2987
2982
  * This function returns the selected key of selected table of Object Page.
2988
2983
  *
@@ -3245,7 +3240,7 @@ declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/ExtensionA
3245
3240
  onClose?: Function
3246
3241
  ): void;
3247
3242
  /**
3248
- * @EXPERIMENTAL
3243
+ * @experimental
3249
3244
  *
3250
3245
  * This function sets the key in the selected section of the table of Object Page.
3251
3246
  */
@@ -3260,7 +3255,6 @@ declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/ExtensionA
3260
3255
  sKey: string
3261
3256
  ): void;
3262
3257
  }
3263
- export default ExtensionAPI;
3264
3258
  }
3265
3259
 
3266
3260
  declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/NonDraftTransactionController" {
@@ -3270,7 +3264,7 @@ declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/NonDraftTr
3270
3264
 
3271
3265
  import Metadata from "sap/ui/base/Metadata";
3272
3266
 
3273
- class NonDraftTransactionController extends BaseObject {
3267
+ export default class NonDraftTransactionController extends BaseObject {
3274
3268
  /**
3275
3269
  * Non Draft transaction controller to be used in extensions of ObjectPage. Breakout coding can access an
3276
3270
  * instance of this class via `ExtensionAPI.getTransactionController`. Do not instantiate yourself.
@@ -3396,7 +3390,6 @@ declare module "sap/suite/ui/generic/template/ObjectPage/extensionAPI/NonDraftTr
3396
3390
  fnHasUnsavedData: Function
3397
3391
  ): void;
3398
3392
  }
3399
- export default NonDraftTransactionController;
3400
3393
  }
3401
3394
 
3402
3395
  declare namespace sap {