@sapui5/types 1.120.8 → 1.120.9

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 (49) hide show
  1. package/package.json +1 -1
  2. package/types/sap.chart.d.ts +1 -1
  3. package/types/sap.esh.search.ui.d.ts +243 -227
  4. package/types/sap.f.d.ts +1 -1
  5. package/types/sap.fe.core.d.ts +149 -115
  6. package/types/sap.fe.macros.d.ts +38 -18
  7. package/types/sap.fe.navigation.d.ts +56 -21
  8. package/types/sap.fe.placeholder.d.ts +1 -1
  9. package/types/sap.fe.templates.d.ts +16 -5
  10. package/types/sap.fe.test.d.ts +229 -7
  11. package/types/sap.fe.tools.d.ts +1 -1
  12. package/types/sap.gantt.d.ts +3731 -1701
  13. package/types/sap.insights.d.ts +51 -43
  14. package/types/sap.m.d.ts +3 -3
  15. package/types/sap.makit.d.ts +1 -1
  16. package/types/sap.me.d.ts +1 -1
  17. package/types/sap.ndc.d.ts +1 -1
  18. package/types/sap.ovp.d.ts +9 -7
  19. package/types/sap.suite.ui.commons.d.ts +3007 -999
  20. package/types/sap.suite.ui.generic.template.d.ts +1 -1
  21. package/types/sap.suite.ui.microchart.d.ts +1 -1
  22. package/types/sap.tnt.d.ts +1 -1
  23. package/types/sap.ui.codeeditor.d.ts +1 -1
  24. package/types/sap.ui.commons.d.ts +1 -1
  25. package/types/sap.ui.comp.d.ts +1 -1
  26. package/types/sap.ui.core.d.ts +1 -1
  27. package/types/sap.ui.dt.d.ts +1 -1
  28. package/types/sap.ui.export.d.ts +1 -1
  29. package/types/sap.ui.fl.d.ts +1 -1
  30. package/types/sap.ui.integration.d.ts +1 -1
  31. package/types/sap.ui.layout.d.ts +1 -1
  32. package/types/sap.ui.mdc.d.ts +2 -2
  33. package/types/sap.ui.richtexteditor.d.ts +1 -1
  34. package/types/sap.ui.rta.d.ts +1 -1
  35. package/types/sap.ui.suite.d.ts +1 -1
  36. package/types/sap.ui.support.d.ts +1 -1
  37. package/types/sap.ui.table.d.ts +1 -1
  38. package/types/sap.ui.testrecorder.d.ts +1 -1
  39. package/types/sap.ui.unified.d.ts +1 -1
  40. package/types/sap.ui.ux3.d.ts +1 -1
  41. package/types/sap.ui.vk.d.ts +2655 -738
  42. package/types/sap.ui.webc.common.d.ts +1 -1
  43. package/types/sap.ui.webc.fiori.d.ts +1 -1
  44. package/types/sap.ui.webc.main.d.ts +1 -1
  45. package/types/sap.uiext.inbox.d.ts +1 -1
  46. package/types/sap.ushell.d.ts +1 -1
  47. package/types/sap.ushell_abap.d.ts +1 -1
  48. package/types/sap.uxap.d.ts +1 -1
  49. package/types/sap.viz.d.ts +1 -1
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.4
1
+ // For Library Version: 1.120.6
2
2
 
3
3
  declare module "sap/fe/core/AppComponent" {
4
4
  import {
@@ -47,6 +47,7 @@ declare module "sap/fe/core/AppComponent" {
47
47
  * To change page configuration use the {@link sap.fe.core.AppComponent#changePageConfiguration } method.
48
48
  *
49
49
  *
50
+ *
50
51
  * @returns A promise without any value to allow asynchronous processes
51
52
  */
52
53
  initializeFeatureToggles(): Promise<void>;
@@ -65,19 +66,20 @@ declare module "sap/fe/core/BaseController" {
65
66
  import View from "sap/ui/core/mvc/View";
66
67
 
67
68
  /**
68
- * @since 1.90.0
69
- *
70
69
  * Internal base controller class for SAP Fiori elements application.
71
70
  * If you want to extend a base controller for your custom page, please use for sap.fe.core.PageController.
71
+ *
72
+ *
73
+ * @since 1.90.0
72
74
  */
73
75
  export default class BaseController extends Controller {
74
76
  constructor();
75
77
 
76
78
  /**
77
- * @since 1.91.0
78
- *
79
79
  * Returns the current app component.
80
80
  *
81
+ * @since 1.91.0
82
+ *
81
83
  * @returns The app component or, if not found, null
82
84
  */
83
85
  getAppComponent(): AppComponent;
@@ -94,6 +96,7 @@ declare module "sap/fe/core/BaseController" {
94
96
  /**
95
97
  * Convenience method for setting the view model in every controller of the application.
96
98
  *
99
+ *
97
100
  * @returns The view instance
98
101
  */
99
102
  setModel(
@@ -127,12 +130,13 @@ declare module "sap/fe/core/ExtensionAPI" {
127
130
  import Context from "sap/ui/model/Context";
128
131
 
129
132
  /**
130
- * @since 1.79.0
131
- *
132
133
  * Common Extension API for all pages of SAP Fiori elements for OData V4.
133
134
  * To correctly integrate your app extension coding with SAP Fiori elements, use only the extensionAPI of
134
135
  * SAP Fiori elements. Don't access or manipulate controls, properties, models, or other internal objects
135
136
  * created by the SAP Fiori elements framework.
137
+ *
138
+ *
139
+ * @since 1.79.0
136
140
  */
137
141
  export default class ExtensionAPI extends BaseObject {
138
142
  constructor();
@@ -150,6 +154,7 @@ declare module "sap/fe/core/ExtensionAPI" {
150
154
  * Access a control by its ID. If you attempt to access an internal control instead of the stable API, the
151
155
  * method will raise an error.
152
156
  *
157
+ *
153
158
  * @returns The requested control, if found in the view / section.
154
159
  */
155
160
  byId(
@@ -161,12 +166,14 @@ declare module "sap/fe/core/ExtensionAPI" {
161
166
  /**
162
167
  * Retrieves the editFlow controller extension for this page.
163
168
  *
169
+ *
164
170
  * @returns The editFlow controller extension
165
171
  */
166
172
  getEditFlow(): EditFlow;
167
173
  /**
168
174
  * Retrieves the intentBasedNavigation controller extension for this page.
169
175
  *
176
+ *
170
177
  * @returns The intentBasedNavigation controller extension
171
178
  */
172
179
  getIntentBasedNavigation(): IntentBasedNavigation;
@@ -189,6 +196,7 @@ declare module "sap/fe/core/ExtensionAPI" {
189
196
  * .
190
197
  * editMode is deprecated and should not be used anymore. Use isEditable instead.
191
198
  *
199
+ *
192
200
  * @returns The required model
193
201
  */
194
202
  getModel(
@@ -200,12 +208,14 @@ declare module "sap/fe/core/ExtensionAPI" {
200
208
  /**
201
209
  * Retrieves the routing controller extension for this page.
202
210
  *
211
+ *
203
212
  * @returns The routing controller extension
204
213
  */
205
214
  getRouting(): Routing;
206
215
  /**
207
216
  * Load a fragment and go through the template preprocessor with the current page context.
208
217
  *
218
+ *
209
219
  * @returns The fragment definition
210
220
  */
211
221
  loadFragment(
@@ -261,6 +271,7 @@ declare module "sap/fe/core/ExtensionAPI" {
261
271
  * Triggers an update of the app state.
262
272
  * Should be called if the state of a control, or any other state-relevant information, was changed.
263
273
  *
274
+ *
264
275
  * @returns A promise that resolves with the new app state object.
265
276
  */
266
277
  updateAppState(): Promise<object | void>;
@@ -269,9 +280,9 @@ declare module "sap/fe/core/ExtensionAPI" {
269
280
 
270
281
  declare module "sap/fe/core/library" {
271
282
  /**
272
- * @since 1.86.0
273
- *
274
283
  * Possible initial load (first app startup) modes for a ListReport.
284
+ *
285
+ * @since 1.86.0
275
286
  */
276
287
  export enum InitialLoadMode {
277
288
  /**
@@ -295,11 +306,12 @@ declare module "sap/fe/core/PageController" {
295
306
  import ExtensionAPI from "sap/fe/core/ExtensionAPI";
296
307
 
297
308
  /**
298
- * @since 1.88.0
299
- *
300
309
  * Base controller class for your custom page used inside an SAP Fiori elements application.
301
310
  * This controller provides preconfigured extensions that will ensure you have the basic functionalities
302
311
  * required to use the building blocks.
312
+ *
313
+ *
314
+ * @since 1.88.0
303
315
  */
304
316
  export default class PageController extends BaseController {
305
317
  constructor();
@@ -307,6 +319,7 @@ declare module "sap/fe/core/PageController" {
307
319
  /**
308
320
  * Get the extension API for the current page.
309
321
  *
322
+ *
310
323
  * @returns The extension API.
311
324
  */
312
325
  getExtensionAPI(): ExtensionAPI;
@@ -317,9 +330,9 @@ declare module "sap/fe/core/controllerextensions/BaseControllerExtension" {
317
330
  import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
318
331
 
319
332
  /**
320
- * @since 1.118.0
321
- *
322
333
  * A base implementation for controller extension used internally in sap.fe for central functionalities.
334
+ *
335
+ * @since 1.118.0
323
336
  */
324
337
  export default class BaseControllerExtension extends ControllerExtension {
325
338
  constructor();
@@ -336,18 +349,18 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
336
349
  import ODataModel from "sap/ui/model/odata/v4/ODataModel";
337
350
 
338
351
  /**
339
- * @since 1.90.0
340
- *
341
352
  * A controller extension offering hooks into the edit flow of the application
353
+ *
354
+ * @since 1.90.0
342
355
  */
343
356
  export default class EditFlow extends BaseControllerExtension {
344
357
  constructor();
345
358
 
346
359
  /**
347
- * @since 1.90.0
348
- *
349
360
  * Submit the current set of changes and navigate back.
350
361
  *
362
+ * @since 1.90.0
363
+ *
351
364
  * @returns Promise resolves once the changes have been saved
352
365
  */
353
366
  applyDocument(
@@ -357,10 +370,10 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
357
370
  oContext: Context
358
371
  ): Promise<void>;
359
372
  /**
360
- * @since 1.90.0
361
- *
362
373
  * Discard the editable document.
363
374
  *
375
+ * @since 1.90.0
376
+ *
364
377
  * @returns Promise resolves once editable document has been discarded
365
378
  */
366
379
  cancelDocument(
@@ -383,10 +396,10 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
383
396
  }
384
397
  ): Promise<any>;
385
398
  /**
386
- * @since 1.90.0
387
- *
388
399
  * Creates a new document.
389
400
  *
401
+ * @since 1.90.0
402
+ *
390
403
  * @returns Promise resolves once the object has been created
391
404
  */
392
405
  createDocument(
@@ -439,10 +452,10 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
439
452
  }
440
453
  ): Promise<void>;
441
454
  /**
442
- * @since 1.90.0
443
- *
444
455
  * Deletes the document.
445
456
  *
457
+ * @since 1.90.0
458
+ *
446
459
  * @returns Promise resolves once document has been deleted
447
460
  */
448
461
  deleteDocument(
@@ -465,10 +478,10 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
465
478
  }
466
479
  ): Promise<void>;
467
480
  /**
468
- * @since 1.90.0
469
- *
470
481
  * Creates a draft document for the existing active document.
471
482
  *
483
+ * @since 1.90.0
484
+ *
472
485
  * @returns Promise resolves once the editable document is available with the editable context
473
486
  */
474
487
  editDocument(
@@ -478,11 +491,11 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
478
491
  oContext: Context
479
492
  ): Promise<Context | void>;
480
493
  /**
481
- * @since 1.90.0
482
- *
483
494
  * Invokes an action (bound or unbound) and tracks the changes so that other pages can be refreshed and
484
495
  * show the updated data upon navigation.
485
496
  *
497
+ * @since 1.90.0
498
+ *
486
499
  * @returns A promise which resolves once the action has been executed, providing the response
487
500
  */
488
501
  invokeAction(
@@ -539,14 +552,14 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
539
552
  }
540
553
  ): Promise<void>;
541
554
  /**
542
- * @since 1.116.0
543
- *
544
555
  * This function can be used to execute code after the 'Create' action.
545
556
  * You can execute custom coding in this function.
546
557
  * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
547
558
  * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
548
559
  *
549
560
  *
561
+ * @since 1.116.0
562
+ *
550
563
  * @returns A promise to be returned by the overridden method.
551
564
  */
552
565
  onAfterCreate(
@@ -561,14 +574,14 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
561
574
  }
562
575
  ): Promise<void>;
563
576
  /**
564
- * @since 1.116.0
565
- *
566
577
  * This function can be used to execute code after the 'Delete' action.
567
578
  * You can execute custom coding in this function.
568
579
  * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
569
580
  * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
570
581
  *
571
582
  *
583
+ * @since 1.116.0
584
+ *
572
585
  * @returns A promise to be returned by the overridden method.
573
586
  */
574
587
  onAfterDelete(
@@ -583,14 +596,14 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
583
596
  }
584
597
  ): Promise<void>;
585
598
  /**
586
- * @since 1.116.0
587
- *
588
599
  * This function can be used to execute code after the 'Discard' action.
589
600
  * You can execute custom coding in this function.
590
601
  * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
591
602
  * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
592
603
  *
593
604
  *
605
+ * @since 1.116.0
606
+ *
594
607
  * @returns A promise to be returned by the overridden method.
595
608
  */
596
609
  onAfterDiscard(
@@ -605,14 +618,14 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
605
618
  }
606
619
  ): Promise<void>;
607
620
  /**
608
- * @since 1.116.0
609
- *
610
621
  * This function can be used to execute code after the 'Edit' action.
611
622
  * You can execute custom coding in this function.
612
623
  * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
613
624
  * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
614
625
  *
615
626
  *
627
+ * @since 1.116.0
628
+ *
616
629
  * @returns A promise to be returned by the overridden method.
617
630
  */
618
631
  onAfterEdit(
@@ -627,14 +640,14 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
627
640
  }
628
641
  ): Promise<void>;
629
642
  /**
630
- * @since 1.116.0
631
- *
632
643
  * This function can be used to execute code after the 'Save' action.
633
644
  * You can execute custom coding in this function.
634
645
  * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
635
646
  * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
636
647
  *
637
648
  *
649
+ * @since 1.116.0
650
+ *
638
651
  * @returns A promise to be returned by the overridden method.
639
652
  */
640
653
  onAfterSave(
@@ -649,8 +662,6 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
649
662
  }
650
663
  ): Promise<void>;
651
664
  /**
652
- * @since 1.98.0
653
- *
654
665
  * This function can be used to intercept the 'Create' action. You can execute custom coding in this function.
655
666
  * The framework waits for the returned promise to be resolved before continuing the 'Create' action.
656
667
  * If you reject the promise, the 'Create' action is stopped.
@@ -658,6 +669,8 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
658
669
  * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
659
670
  *
660
671
  *
672
+ * @since 1.98.0
673
+ *
661
674
  * @returns A promise to be returned by the overridden method. If resolved, the 'Create' action is triggered.
662
675
  * If rejected, the 'Create' action is not triggered.
663
676
  */
@@ -677,8 +690,6 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
677
690
  }
678
691
  ): Promise<void>;
679
692
  /**
680
- * @since 1.98.0
681
- *
682
693
  * This function can be used to intercept the 'Delete' action. You can execute custom coding in this function.
683
694
  * The framework waits for the returned promise to be resolved before continuing the 'Delete' action.
684
695
  * If you reject the promise, the 'Delete' action is stopped.
@@ -686,6 +697,8 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
686
697
  * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
687
698
  *
688
699
  *
700
+ * @since 1.98.0
701
+ *
689
702
  * @returns A promise to be returned by the overridden method. If resolved, the 'Delete' action is triggered.
690
703
  * If rejected, the 'Delete' action is not triggered.
691
704
  */
@@ -701,8 +714,6 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
701
714
  }
702
715
  ): Promise<void>;
703
716
  /**
704
- * @since 1.98.0
705
- *
706
717
  * This function can be used to intercept the 'Discard' action. You can execute custom coding in this function.
707
718
  * The framework waits for the returned promise to be resolved before continuing the 'Discard' action.
708
719
  * If you reject the promise, the 'Discard' action is stopped and the user stays in edit mode.
@@ -710,6 +721,8 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
710
721
  * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
711
722
  *
712
723
  *
724
+ * @since 1.98.0
725
+ *
713
726
  * @returns A promise to be returned by the overridden method. If resolved, the 'Discard' action is triggered.
714
727
  * If rejected, the 'Discard' action is not triggered and the user stays in edit mode.
715
728
  */
@@ -725,8 +738,6 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
725
738
  }
726
739
  ): Promise<void>;
727
740
  /**
728
- * @since 1.98.0
729
- *
730
741
  * This function can be used to intercept the 'Edit' action. You can execute custom coding in this function.
731
742
  * The framework waits for the returned promise to be resolved before continuing the 'Edit' action.
732
743
  * If you reject the promise, the 'Edit' action is stopped and the user stays in display mode.
@@ -734,6 +745,8 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
734
745
  * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
735
746
  *
736
747
  *
748
+ * @since 1.98.0
749
+ *
737
750
  * @returns A promise to be returned by the overridden method. If resolved, the 'Edit' action is triggered.
738
751
  * If rejected, the 'Edit' action is not triggered and the user stays in display mode.
739
752
  */
@@ -749,8 +762,6 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
749
762
  }
750
763
  ): Promise<void>;
751
764
  /**
752
- * @since 1.90.0
753
- *
754
765
  * This function can be used to intercept the 'Save' action. You can execute custom coding in this function.
755
766
  * The framework waits for the returned promise to be resolved before continuing the 'Save' action.
756
767
  * If you reject the promise, the 'Save' action is stopped and the user stays in edit mode.
@@ -758,6 +769,8 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
758
769
  * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
759
770
  *
760
771
  *
772
+ * @since 1.90.0
773
+ *
761
774
  * @returns A promise to be returned by the overridden method. If resolved, the 'Save' action is triggered.
762
775
  * If rejected, the 'Save' action is not triggered and the user stays in edit mode.
763
776
  */
@@ -773,10 +786,10 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
773
786
  }
774
787
  ): Promise<void>;
775
788
  /**
776
- * @since 1.90.0
777
- *
778
789
  * Saves a new document after checking it.
779
790
  *
791
+ * @since 1.90.0
792
+ *
780
793
  * @returns Promise resolves once save is complete
781
794
  */
782
795
  saveDocument(
@@ -786,11 +799,11 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
786
799
  oContext: Context
787
800
  ): Promise<void>;
788
801
  /**
789
- * @since 1.90.0
790
- *
791
802
  * Secured execution of the given function. Ensures that the function is only executed when certain conditions
792
803
  * are fulfilled.
793
804
  *
805
+ * @since 1.90.0
806
+ *
794
807
  * @returns A promise that is rejected if the execution is prohibited and resolved by the promise returned
795
808
  * by the fnFunction.
796
809
  */
@@ -826,10 +839,10 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
826
839
  }
827
840
  ): Promise<void>;
828
841
  /**
829
- * @since 1.90.0
830
- *
831
842
  * Updates the draft status and displays the error messages if there are errors during an update.
832
843
  *
844
+ * @since 1.90.0
845
+ *
833
846
  * @returns Promise resolves once draft status has been updated
834
847
  */
835
848
  updateDocument(
@@ -852,18 +865,18 @@ declare module "sap/fe/core/controllerextensions/IntentBasedNavigation" {
852
865
  import SelectionVariant from "sap/fe/navigation/SelectionVariant";
853
866
 
854
867
  /**
855
- * @since 1.86.0
856
- *
857
868
  * Controller extension providing hooks for intent-based navigation
869
+ *
870
+ * @since 1.86.0
858
871
  */
859
872
  export default class IntentBasedNavigation extends ControllerExtension {
860
873
  constructor();
861
874
 
862
875
  /**
863
- * @since 1.86.0
864
- *
865
876
  * Provides a hook to customize the {@link sap.fe.navigation.SelectionVariant } related to the intent-based
866
877
  * navigation.
878
+ *
879
+ * @since 1.86.0
867
880
  */
868
881
  adaptNavigationContext(
869
882
  /**
@@ -885,9 +898,9 @@ declare module "sap/fe/core/controllerextensions/IntentBasedNavigation" {
885
898
  }
886
899
  ): void;
887
900
  /**
888
- * @since 1.86.0
889
- *
890
901
  * Navigates to an intent defined by an outbound definition in the manifest.
902
+ *
903
+ * @since 1.86.0
891
904
  */
892
905
  navigateOutbound(
893
906
  /**
@@ -912,18 +925,15 @@ declare module "sap/fe/core/controllerextensions/MessageHandler" {
912
925
  import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
913
926
 
914
927
  /**
928
+ * A controller extension offering message handling.
929
+ *
915
930
  * @since 1.90.0
916
931
  * @experimental (since 1.90.0)
917
- *
918
- * A controller extension offering message handling.
919
932
  */
920
933
  export default class MessageHandler extends ControllerExtension {
921
934
  constructor();
922
935
 
923
936
  /**
924
- * @since 1.90.0
925
- * @experimental (since 1.90.0)
926
- *
927
937
  * Shows a message dialog with transition messages if there are any.
928
938
  * The message dialog is shown as a modal dialog. Once the user confirms the dialog, all transition messages
929
939
  * are removed from the message model. If there is more than one message, a list of messages is shown. The
@@ -932,6 +942,9 @@ declare module "sap/fe/core/controllerextensions/MessageHandler" {
932
942
  * the dialog immediately shows the details of the message. If there is just one success message, a message
933
943
  * toast is shown instead.
934
944
  *
945
+ * @since 1.90.0
946
+ * @experimental (since 1.90.0)
947
+ *
935
948
  * @returns A promise that is resolved once the user closes the dialog. If there are no messages
936
949
  * to be shown, the promise is resolved immediately
937
950
  */
@@ -947,17 +960,17 @@ declare module "sap/fe/core/controllerextensions/Paginator" {
947
960
  import Context from "sap/ui/model/odata/v4/Context";
948
961
 
949
962
  /**
950
- * @since 1.94.0
951
- *
952
963
  * Controller extension providing hooks for the navigation using paginators
964
+ *
965
+ * @since 1.94.0
953
966
  */
954
967
  export default class Paginator extends ControllerExtension {
955
968
  constructor();
956
969
 
957
970
  /**
958
- * @since 1.94.0
959
- *
960
971
  * Initiates the paginator control.
972
+ *
973
+ * @since 1.94.0
961
974
  */
962
975
  initialize(
963
976
  /**
@@ -970,9 +983,9 @@ declare module "sap/fe/core/controllerextensions/Paginator" {
970
983
  oContext?: Context
971
984
  ): void;
972
985
  /**
973
- * @since 1.94.0
974
- *
975
986
  * Returns the updated context after the paginator operation.
987
+ *
988
+ * @since 1.94.0
976
989
  */
977
990
  onContextUpdate(
978
991
  /**
@@ -989,17 +1002,17 @@ declare module "sap/fe/core/controllerextensions/Routing" {
989
1002
  import Context from "sap/ui/model/odata/v4/Context";
990
1003
 
991
1004
  /**
992
- * @since 1.86.0
993
- *
994
1005
  * A controller extension offering hooks into the routing flow of the application
1006
+ *
1007
+ * @since 1.86.0
995
1008
  */
996
1009
  export default class Routing extends ControllerExtension {
997
1010
  constructor();
998
1011
 
999
1012
  /**
1000
- * @since 1.90.0
1001
- *
1002
1013
  * Allows navigation to a specific context.
1014
+ *
1015
+ * @since 1.90.0
1003
1016
  */
1004
1017
  navigate(
1005
1018
  /**
@@ -1010,6 +1023,7 @@ declare module "sap/fe/core/controllerextensions/Routing" {
1010
1023
  /**
1011
1024
  * Navigate to another target.
1012
1025
  *
1026
+ *
1013
1027
  * @returns Promise that is resolved when the navigation is finalized
1014
1028
  */
1015
1029
  navigateToRoute(
@@ -1023,12 +1037,13 @@ declare module "sap/fe/core/controllerextensions/Routing" {
1023
1037
  oParameters?: object
1024
1038
  ): Promise<boolean>;
1025
1039
  /**
1026
- * @since 1.90.0
1027
- *
1028
1040
  * This function is used to intercept the routing event after binding a page.
1029
1041
  * If it is declared as an extension, it allows you to intercept and change the normal flow of binding.
1030
1042
  * This function is not called directly, but overridden separately by consuming controllers.
1031
1043
  * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
1044
+ *
1045
+ *
1046
+ * @since 1.90.0
1032
1047
  */
1033
1048
  onAfterBinding(
1034
1049
  /**
@@ -1037,12 +1052,13 @@ declare module "sap/fe/core/controllerextensions/Routing" {
1037
1052
  oContext: object
1038
1053
  ): void;
1039
1054
  /**
1040
- * @since 1.90.0
1041
- *
1042
1055
  * This function is used to intercept the routing event before binding a page.
1043
1056
  * If it is declared as an extension, it allows you to intercept and change the normal flow of binding.
1044
1057
  * This function is not called directly, but overridden separately by consuming controllers.
1045
1058
  * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
1059
+ *
1060
+ *
1061
+ * @since 1.90.0
1046
1062
  */
1047
1063
  onBeforeBinding(
1048
1064
  /**
@@ -1051,8 +1067,6 @@ declare module "sap/fe/core/controllerextensions/Routing" {
1051
1067
  oContext: object
1052
1068
  ): void;
1053
1069
  /**
1054
- * @since 1.86.0
1055
- *
1056
1070
  * This function can be used to intercept the routing event happening during the normal process of navigating
1057
1071
  * from one page to another (like clicking on the table row to navigate, or when pagination buttons are
1058
1072
  * clicked).
@@ -1065,6 +1079,8 @@ declare module "sap/fe/core/controllerextensions/Routing" {
1065
1079
  * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
1066
1080
  *
1067
1081
  *
1082
+ * @since 1.86.0
1083
+ *
1068
1084
  * @returns `true` to prevent the default execution, false to keep the standard behavior
1069
1085
  */
1070
1086
  onBeforeNavigation(
@@ -1085,19 +1101,19 @@ declare module "sap/fe/core/controllerextensions/Share" {
1085
1101
  import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
1086
1102
 
1087
1103
  /**
1088
- * @since 1.86.0
1089
- *
1090
1104
  * A controller extension offering hooks into the routing flow of the application
1105
+ *
1106
+ * @since 1.86.0
1091
1107
  */
1092
1108
  export default class Share extends ControllerExtension {
1093
1109
  constructor();
1094
1110
 
1095
1111
  /**
1096
- * @since 1.93.0
1097
- *
1098
1112
  * Adapts the metadata used while sharing the page URL via 'Send Email', 'Share in SAP Jam', and 'Save as
1099
1113
  * Tile'.
1100
1114
  *
1115
+ * @since 1.93.0
1116
+ *
1101
1117
  * @returns Share Metadata or a Promise resolving the Share Metadata
1102
1118
  */
1103
1119
  adaptShareMetadata(
@@ -1170,9 +1186,9 @@ declare module "sap/fe/core/controllerextensions/Share" {
1170
1186
  | Promise</* was: sap.fe.core.controllerextensions.Share.ShareMetadata */ any>
1171
1187
  | /* was: sap.fe.core.controllerextensions.Share.ShareMetadata */ any;
1172
1188
  /**
1173
- * @since 1.93.0
1174
- *
1175
1189
  * Opens the share sheet.
1190
+ *
1191
+ * @since 1.93.0
1176
1192
  */
1177
1193
  openShareSheet(
1178
1194
  /**
@@ -1191,20 +1207,22 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
1191
1207
  import SelectionVariant from "sap/fe/navigation/SelectionVariant";
1192
1208
 
1193
1209
  /**
1194
- * @since 1.85.0
1195
- *
1196
1210
  * A controller extension offering hooks for state handling
1197
1211
  * If you need to maintain a specific state for your application, you can use the controller extension.
1212
+ *
1213
+ *
1214
+ * @since 1.85.0
1198
1215
  */
1199
1216
  export default class ViewState extends ControllerExtension {
1200
1217
  constructor();
1201
1218
 
1202
1219
  /**
1203
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1204
- *
1205
1220
  * This function should add all controls relevant for refreshing to the provided control array.
1206
1221
  * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
1207
1222
  * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
1223
+ *
1224
+ *
1225
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1208
1226
  */
1209
1227
  adaptBindingRefreshControls(
1210
1228
  /**
@@ -1213,11 +1231,12 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
1213
1231
  aCollectedControls: ManagedObject[]
1214
1232
  ): void;
1215
1233
  /**
1216
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1217
- *
1218
1234
  * Customize the `refreshBinding` function for a certain control.
1219
1235
  * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
1220
1236
  * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
1237
+ *
1238
+ *
1239
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1221
1240
  */
1222
1241
  adaptBindingRefreshHandler(
1223
1242
  /**
@@ -1230,11 +1249,12 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
1230
1249
  oControlHandler: any[]
1231
1250
  ): void;
1232
1251
  /**
1233
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1234
- *
1235
1252
  * Customize the `retrieve` and `apply` functions for a certain control.
1236
1253
  * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
1237
1254
  * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
1255
+ *
1256
+ *
1257
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1238
1258
  */
1239
1259
  adaptControlStateHandler(
1240
1260
  /**
@@ -1247,12 +1267,13 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
1247
1267
  aControlHandler: object[]
1248
1268
  ): void;
1249
1269
  /**
1250
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1251
- *
1252
1270
  * This function should add all controls for given view that should be considered for the state handling
1253
1271
  * to the provided control array.
1254
1272
  * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
1255
1273
  * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
1274
+ *
1275
+ *
1276
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1256
1277
  */
1257
1278
  adaptStateControls(
1258
1279
  /**
@@ -1261,11 +1282,12 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
1261
1282
  aCollectedControls: ManagedObject[]
1262
1283
  ): void;
1263
1284
  /**
1264
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1265
- *
1266
1285
  * Applying additional, not control related, states - is called only if navigation type is iAppState.
1267
1286
  * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
1268
1287
  * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
1288
+ *
1289
+ *
1290
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1269
1291
  */
1270
1292
  applyAdditionalStates(
1271
1293
  /**
@@ -1278,8 +1300,6 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
1278
1300
  aPromises: Promise<any>
1279
1301
  ): void;
1280
1302
  /**
1281
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1282
- *
1283
1303
  * Defines whether the view state should only be applied once initially.
1284
1304
  * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
1285
1305
  * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.Instead }.
@@ -1287,16 +1307,19 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
1287
1307
  * You should only override this method for custom pages and not for the standard ListReportPage and ObjectPage!
1288
1308
  *
1289
1309
  *
1310
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1311
+ *
1290
1312
  * @returns If `true`, only the initial view state is applied once,
1291
1313
  * else any new view state is also applied on follow-up calls (default)
1292
1314
  */
1293
1315
  applyInitialStateOnly(): boolean;
1294
1316
  /**
1295
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1296
- *
1297
1317
  * Apply navigation parameters is not called if the navigation type is iAppState
1298
1318
  * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
1299
1319
  * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
1320
+ *
1321
+ *
1322
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1300
1323
  */
1301
1324
  applyNavigationParameters(
1302
1325
  /**
@@ -1328,6 +1351,7 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
1328
1351
  /**
1329
1352
  * Applies the given view state to this extensions view.
1330
1353
  *
1354
+ *
1331
1355
  * @returns Promise for async state handling
1332
1356
  */
1333
1357
  applyViewState(
@@ -1345,11 +1369,12 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
1345
1369
  skipMerge?: boolean
1346
1370
  ): Promise<void>;
1347
1371
  /**
1348
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1349
- *
1350
1372
  * Hook to react when state for given view was applied.
1351
1373
  * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
1352
1374
  * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
1375
+ *
1376
+ *
1377
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1353
1378
  */
1354
1379
  onAfterStateApplied(
1355
1380
  /**
@@ -1358,11 +1383,12 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
1358
1383
  aPromises: Promise<any>
1359
1384
  ): void;
1360
1385
  /**
1361
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1362
- *
1363
1386
  * Hook to react before a state for given view is applied.
1364
1387
  * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
1365
1388
  * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
1389
+ *
1390
+ *
1391
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1366
1392
  */
1367
1393
  onBeforeStateApplied(
1368
1394
  /**
@@ -1383,12 +1409,13 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
1383
1409
  */
1384
1410
  onSuspend(): void;
1385
1411
  /**
1386
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1387
- *
1388
1412
  * Extend the map of additional states (not control bound) to be added to the current view state of the
1389
1413
  * given view.
1390
1414
  * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
1391
1415
  * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After }.
1416
+ *
1417
+ *
1418
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1392
1419
  */
1393
1420
  retrieveAdditionalStates(
1394
1421
  /**
@@ -1401,6 +1428,7 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
1401
1428
  * When this function is called more than once before finishing, all but the final response will resolve
1402
1429
  * to `undefined`.
1403
1430
  *
1431
+ *
1404
1432
  * @returns A promise resolving the view state
1405
1433
  */
1406
1434
  retrieveViewState(): Promise<object | undefined>;
@@ -1430,9 +1458,6 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
1430
1458
 
1431
1459
  declare module "sap/fe/core/fpm/Component" {
1432
1460
  /**
1433
- * @since 1.92.0
1434
- * @experimental (since 1.92.0)
1435
- *
1436
1461
  * Component that can be used as a wrapper component for custom pages.
1437
1462
  * The component can be used in case you want to use SAP Fiori elements Building Blocks or XML template
1438
1463
  * constructions. You can either extend the component and set the viewName and contextPath within your code
@@ -1454,6 +1479,11 @@ declare module "sap/fe/core/fpm/Component" {
1454
1479
  * }
1455
1480
  * }
1456
1481
  * ```
1482
+ *
1483
+ *
1484
+ *
1485
+ * @since 1.92.0
1486
+ * @experimental (since 1.92.0)
1457
1487
  */
1458
1488
  export default class Component
1459
1489
  /* was: sap.fe.core.TemplateComponent */ extends Object {
@@ -1463,12 +1493,13 @@ declare module "sap/fe/core/fpm/Component" {
1463
1493
 
1464
1494
  declare module "sap/fe/core/rootView/Fcl.controller" {
1465
1495
  /**
1466
- * @since 1.110.0
1467
- *
1468
1496
  * Base controller class for your own root view with an sap.f.FlexibleColumnLayout control.
1469
1497
  * By using or extending this controller, you can use your own root view with the sap.fe.core.AppComponent
1470
1498
  * and
1471
1499
  * you can make use of SAP Fiori elements pages and SAP Fiori elements building blocks.
1500
+ *
1501
+ *
1502
+ * @since 1.110.0
1472
1503
  */
1473
1504
  export default class Fcl
1474
1505
  /* was: sap.fe.core.rootView.RootViewBaseController */ extends Object {
@@ -1477,6 +1508,7 @@ declare module "sap/fe/core/rootView/Fcl.controller" {
1477
1508
  /**
1478
1509
  * Method that creates a new Page to display the IllustratedMessage containing the current error.
1479
1510
  *
1511
+ *
1480
1512
  * @returns A promise that creates a Page to display the error
1481
1513
  */
1482
1514
  displayErrorPage(): Promise<boolean>;
@@ -1485,12 +1517,13 @@ declare module "sap/fe/core/rootView/Fcl.controller" {
1485
1517
 
1486
1518
  declare module "sap/fe/core/rootView/NavContainer.controller" {
1487
1519
  /**
1488
- * @since 1.108.0
1489
- *
1490
1520
  * Base controller class for your own root view with a sap.m.NavContainer control.
1491
1521
  * By using or extending this controller you can use your own root view with the sap.fe.core.AppComponent
1492
1522
  * and
1493
1523
  * you can make use of SAP Fiori elements pages and SAP Fiori elements building blocks.
1524
+ *
1525
+ *
1526
+ * @since 1.108.0
1494
1527
  */
1495
1528
  export default class NavContainer
1496
1529
  /* was: sap.fe.core.rootView.RootViewBaseController */ extends Object {
@@ -1499,6 +1532,7 @@ declare module "sap/fe/core/rootView/NavContainer.controller" {
1499
1532
  /**
1500
1533
  * Method that creates a new Page to display the IllustratedMessage containing the current error.
1501
1534
  *
1535
+ *
1502
1536
  * @returns A promise that creates a Page to display the error
1503
1537
  */
1504
1538
  displayErrorPage(): Promise<boolean>;