@sapui5/ts-types 1.102.2 → 1.104.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +3 -0
  3. package/types/sap.apf.d.ts +1 -1
  4. package/types/sap.ca.ui.d.ts +11 -11
  5. package/types/sap.chart.d.ts +2 -2
  6. package/types/sap.collaboration.d.ts +1 -1
  7. package/types/sap.esh.search.ui.d.ts +1 -1
  8. package/types/sap.f.d.ts +320 -24
  9. package/types/sap.fe.common.d.ts +1 -1
  10. package/types/sap.fe.core.d.ts +29 -1159
  11. package/types/sap.fe.macros.d.ts +52 -627
  12. package/types/sap.fe.navigation.d.ts +1 -1309
  13. package/types/sap.fe.templates.d.ts +2 -161
  14. package/types/sap.fe.test.d.ts +12 -244
  15. package/types/sap.feedback.ui.d.ts +1 -1
  16. package/types/sap.gantt.d.ts +343 -63
  17. package/types/sap.insights.d.ts +1 -1
  18. package/types/sap.landvisz.d.ts +15 -15
  19. package/types/sap.m.d.ts +2388 -334
  20. package/types/sap.makit.d.ts +5 -5
  21. package/types/sap.me.d.ts +2 -2
  22. package/types/sap.ndc.d.ts +75 -3
  23. package/types/sap.ovp.d.ts +6 -1
  24. package/types/sap.rules.ui.d.ts +1 -1
  25. package/types/sap.sac.df.d.ts +164 -2
  26. package/types/sap.sac.grid.d.ts +1 -1
  27. package/types/sap.suite.ui.commons.d.ts +556 -76
  28. package/types/sap.suite.ui.generic.template.d.ts +105 -12
  29. package/types/sap.suite.ui.microchart.d.ts +14 -14
  30. package/types/sap.tnt.d.ts +5 -5
  31. package/types/sap.ui.codeeditor.d.ts +1 -1
  32. package/types/sap.ui.commons.d.ts +36 -36
  33. package/types/sap.ui.comp.d.ts +1213 -270
  34. package/types/sap.ui.core.d.ts +384 -111
  35. package/types/sap.ui.dt.d.ts +1 -1
  36. package/types/sap.ui.export.d.ts +3 -3
  37. package/types/sap.ui.fl.d.ts +3 -1
  38. package/types/sap.ui.generic.app.d.ts +13 -6
  39. package/types/sap.ui.generic.template.d.ts +1 -1
  40. package/types/sap.ui.integration.d.ts +43 -64
  41. package/types/sap.ui.layout.d.ts +33 -41
  42. package/types/sap.ui.mdc.d.ts +1 -1
  43. package/types/sap.ui.richtexteditor.d.ts +2 -2
  44. package/types/sap.ui.rta.d.ts +3 -1
  45. package/types/sap.ui.suite.d.ts +1 -1
  46. package/types/sap.ui.support.d.ts +1 -1
  47. package/types/sap.ui.table.d.ts +9 -9
  48. package/types/sap.ui.testrecorder.d.ts +1 -1
  49. package/types/sap.ui.unified.d.ts +115 -35
  50. package/types/sap.ui.ux3.d.ts +43 -43
  51. package/types/sap.ui.vbm.d.ts +28 -188
  52. package/types/sap.ui.vk.d.ts +83 -25
  53. package/types/sap.ui.vtm.d.ts +12 -12
  54. package/types/sap.ui.webc.common.d.ts +118 -0
  55. package/types/sap.ui.webc.fiori.d.ts +13298 -0
  56. package/types/sap.ui.webc.main.d.ts +39842 -0
  57. package/types/sap.uiext.inbox.d.ts +3 -3
  58. package/types/sap.ushell.d.ts +45 -31
  59. package/types/sap.ushell_abap.d.ts +1 -1
  60. package/types/sap.uxap.d.ts +13 -13
  61. package/types/sap.viz.d.ts +8 -8
  62. package/types/sap.webanalytics.core.d.ts +1 -1
  63. package/types/sap.zen.commons.d.ts +4 -4
  64. package/types/sap.zen.crosstab.d.ts +1 -1
  65. package/types/sap.zen.dsh.d.ts +1 -1
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.102.1
1
+ // For Library Version: 1.103.0
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -10,926 +10,45 @@ declare namespace sap {
10
10
  */
11
11
  namespace core {
12
12
  /**
13
- * Collection of controller extensions used internally in SAP Fiori elements exposing a method that you
14
- * can override to allow more flexibility.
13
+ * Main class for components used for an application in SAP Fiori elements.
14
+ *
15
+ * Application developers using the templates and building blocks provided by SAP Fiori elements should
16
+ * create their apps by extending this component. This ensures that all the necessary services that you
17
+ * need for the building blocks and templates to work properly are started.
18
+ *
19
+ * When you use sap.fe.core.AppComponent as the base component, you also need to use a rootView. SAP Fiori
20
+ * elements provides two options:
21
+ * - sap.fe.templates.RootContainer.view.NavContainer when using sap.m.routing.Router
22
+ * - sap.fe.templates.RootContainer.view.Fcl when using sap.f.routing.Router (FCL use case)
15
23
  */
16
- namespace controllerextensions {
17
- /**
18
- * @SINCE 1.90.0
19
- *
20
- *
21
- * A controller extension offering hooks into the edit flow of the application
22
- */
23
- class EditFlow extends sap.ui.core.mvc.ControllerExtension {
24
- constructor();
24
+ export const AppComponent: undefined;
25
25
 
26
- /**
27
- * @SINCE 1.90.0
28
- *
29
- *
30
- * Submit the current set of changes and navigate back.
31
- *
32
- * @returns Promise resolves once the changes have been saved
33
- */
34
- applyDocument(
35
- /**
36
- * Context of the document
37
- */
38
- oContext: object
39
- ): Promise<any>;
40
- /**
41
- * @SINCE 1.90.0
42
- *
43
- *
44
- * Discard the editable document.
45
- *
46
- * @returns Promise resolves once editable document has been discarded
47
- */
48
- cancelDocument(
49
- /**
50
- * Context of the editable document
51
- */
52
- oContext: sap.ui.model.odata.v4.Context,
53
- /**
54
- * Can contain the following attributes:
55
- */
56
- mParameters: {
57
- /**
58
- * This is the control used to open the discard popover
59
- */
60
- control: object;
61
- /**
62
- * Optional, supresses the discard popover and allows custom handling
63
- */
64
- skipDiscardPopover?: boolean;
65
- }
66
- ): Promise<any>;
67
- /**
68
- * @SINCE 1.90.0
69
- *
70
- *
71
- * Creates a new document.
72
- *
73
- * @returns Promise resolves once the object has been created
74
- */
75
- createDocument(
76
- /**
77
- * ODataListBinding object or the binding path for a temporary list binding
78
- */
79
- vListBinding: string | sap.ui.model.odata.v4.ODataListBinding,
80
- /**
81
- * Contains the following attributes:
82
- */
83
- mInParameters: {
84
- /**
85
- * Specifies if the new entry should be created at the top or bottom of a table in case of creationMode
86
- * 'Inline'
87
- */
88
- createAtEnd?: boolean;
89
- /**
90
- * The creation mode using one of the following:
91
- * NewPage - the created document is shown in a new page, depending on whether metadata
92
- * 'Sync', 'Async' or 'Deferred' is used
93
- * Inline - The creation is done inline (in a table)
94
- * External - The creation is done in a different application specified via the parameter
95
- * 'outbound'
96
- */
97
- creationMode: string;
98
- /**
99
- * The navigation target where the document is created in case of creationMode 'External'
100
- */
101
- outbound?: string;
102
- }
103
- ): Promise<any>;
104
- /**
105
- * @SINCE 1.90.0
106
- *
107
- *
108
- * Deletes the document.
109
- *
110
- * @returns Promise resolves once document has been deleted
111
- */
112
- deleteDocument(
113
- /**
114
- * Context of the document
115
- */
116
- oContext: sap.ui.model.odata.v4.Context,
117
- /**
118
- * Can contain the following attributes:
119
- */
120
- mInParameters: {
121
- /**
122
- * Description of the object being deleted
123
- */
124
- description: string;
125
- /**
126
- * Title of the object being deleted
127
- */
128
- title: string;
129
- }
130
- ): Promise<any>;
131
- /**
132
- * @SINCE 1.90.0
133
- *
134
- *
135
- * Creates a draft document for an existing active document.
136
- *
137
- * @returns Promise resolves once the editable document is available
138
- */
139
- editDocument(
140
- /**
141
- * Context of the active document
142
- */
143
- oContext: sap.ui.model.odata.v4.Context
144
- ): Promise<any>;
145
- /**
146
- * @SINCE 1.90.0
147
- *
148
- * Invokes an action (bound or unbound) and tracks the changes so that other pages can be refreshed and
149
- * show the updated data upon navigation.
150
- */
151
- invokeAction(
152
- /**
153
- * The name of the action to be called
154
- */
155
- sActionName: string,
156
- /**
157
- * Contains the following attributes:
158
- */
159
- mInParameters?: {
160
- /**
161
- * For a bound action, a context or an array with contexts for which the action is to be called must be
162
- * provided
163
- */
164
- contexts?:
165
- | sap.ui.model.odata.v4.Context
166
- | sap.ui.model.odata.v4.Context[];
167
- /**
168
- * Mode how actions are to be called: 'ChangeSet' to put all action calls into one changeset, 'Isolated'
169
- * to put them into separate changesets
170
- */
171
- invocationGrouping?: string;
172
- /**
173
- * A human-readable label for the action. This is needed in case the action has a parameter and a parameter
174
- * dialog is shown to the user. The label will be used for the title of the dialog and for the confirmation
175
- * button
176
- */
177
- label?: string;
178
- /**
179
- * For an unbound action, an instance of an OData V4 model must be provided
180
- */
181
- model?: sap.ui.model.odata.v4.ODataModel;
182
- /**
183
- * Boolean value indicating whether navigation is required after the action has been executed. Navigation
184
- * takes place to the context returned by the action
185
- */
186
- requiresNavigation?: boolean;
187
- }
188
- ): Promise<any>;
189
- /**
190
- * @SINCE 1.98.0
191
- *
192
- *
193
- * This function can be used to intercept the 'Create' action. You can execute custom coding in this function.
194
- * The framework waits for the returned promise to be resolved before continuing the 'Create' action.
195
- * If you reject the promise, the 'Create' action is stopped.
196
- * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
197
- * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
198
- *
199
- * @returns A promise to be returned by the overridden method. If resolved, the 'Create' action is triggered.
200
- * If rejected, the 'Create' action is not triggered.
201
- */
202
- onBeforeCreate(
203
- /**
204
- * Object containing the parameters passed to onBeforeCreate
205
- */
206
- mParameters?: {
207
- /**
208
- * Path pointing to the context on which Create action is triggered
209
- */
210
- contextPath?: string;
211
- /**
212
- * Array of values that are filled in the Action Parameter Dialog
213
- */
214
- createParameters?: any[];
215
- }
216
- ): Promise<any>;
217
- /**
218
- * @SINCE 1.98.0
219
- *
220
- *
221
- * This function can be used to intercept the 'Delete' action. You can execute custom coding in this function.
222
- * The framework waits for the returned promise to be resolved before continuing the 'Delete' action.
223
- * If you reject the promise, the 'Delete' action is stopped.
224
- * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
225
- * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
226
- *
227
- * @returns A promise to be returned by the overridden method. If resolved, the 'Delete' action is triggered.
228
- * If rejected, the 'Delete' action is not triggered.
229
- */
230
- onBeforeDelete(
231
- /**
232
- * Object containing the parameters passed to onBeforeDelete
233
- */
234
- mParameters?: {
235
- /**
236
- * An array of contexts that are going to be deleted
237
- */
238
- contexts?: sap.ui.model.odata.v4.Context[];
239
- }
240
- ): Promise<any>;
241
- /**
242
- * @SINCE 1.98.0
243
- *
244
- *
245
- * This function can be used to intercept the 'Discard' action. You can execute custom coding in this function.
246
- * The framework waits for the returned promise to be resolved before continuing the 'Discard' action.
247
- * If you reject the promise, the 'Discard' action is stopped and the user stays in edit mode.
248
- * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
249
- * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
250
- *
251
- * @returns A promise to be returned by the overridden method. If resolved, the 'Discard' action is triggered.
252
- * If rejected, the 'Discard' action is not triggered and the user stays in edit mode.
253
- */
254
- onBeforeDiscard(
255
- /**
256
- * Object containing the parameters passed to onBeforeDiscard
257
- */
258
- mParameters?: {
259
- /**
260
- * Page context that is going to be discarded.
261
- */
262
- context?: sap.ui.model.odata.v4.Context;
263
- }
264
- ): Promise<any>;
265
- /**
266
- * @SINCE 1.98.0
267
- *
268
- *
269
- * This function can be used to intercept the 'Edit' action. You can execute custom coding in this function.
270
- * The framework waits for the returned promise to be resolved before continuing the 'Edit' action.
271
- * If you reject the promise, the 'Edit' action is stopped and the user stays in display mode.
272
- * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
273
- * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
274
- *
275
- * @returns A promise to be returned by the overridden method. If resolved, the 'Edit' action is triggered.
276
- * If rejected, the 'Edit' action is not triggered and the user stays in display mode.
277
- */
278
- onBeforeEdit(
279
- /**
280
- * Object containing the parameters passed to onBeforeEdit
281
- */
282
- mParameters?: {
283
- /**
284
- * Page context that is going to be edited.
285
- */
286
- context?: sap.ui.model.odata.v4.Context;
287
- }
288
- ): Promise<any>;
289
- /**
290
- * @SINCE 1.90.0
291
- *
292
- *
293
- * This function can be used to intercept the 'Save' action. You can execute custom coding in this function.
294
- * The framework waits for the returned promise to be resolved before continuing the 'Save' action.
295
- * If you reject the promise, the 'Save' action is stopped and the user stays in edit mode.
296
- * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
297
- * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
298
- *
299
- * @returns A promise to be returned by the overridden method. If resolved, the 'Save' action is triggered.
300
- * If rejected, the 'Save' action is not triggered and the user stays in edit mode.
301
- */
302
- onBeforeSave(
303
- /**
304
- * Object containing the parameters passed to onBeforeSave
305
- */
306
- mParameters?: {
307
- /**
308
- * Page context that is going to be saved.
309
- */
310
- context?: sap.ui.model.odata.v4.Context;
311
- }
312
- ): Promise<any>;
313
- /**
314
- * @SINCE 1.90.0
315
- *
316
- *
317
- * Saves a new document after checking it.
318
- *
319
- * @returns Promise resolves once save is complete
320
- */
321
- saveDocument(
322
- /**
323
- * Context of the editable document
324
- */
325
- oContext: sap.ui.model.odata.v4.Context,
326
- /**
327
- * undefined
328
- */
329
- mParameters: any
330
- ): Promise<any>;
331
- /**
332
- * @SINCE 1.90.0
333
- *
334
- * @EXPERIMENTAL (since 1.90.0
335
- * )
336
- *
337
- * Secured execution of the given function. Ensures that the function is only executed when certain conditions
338
- * are fulfilled.
339
- *
340
- * @returns A promise that is rejected if the execution is prohibited and resolved by the promise returned
341
- * by the fnFunction.
342
- */
343
- securedExecution(
344
- /**
345
- * The function to be executed. Should return a promise that is settled after completion of the execution.
346
- * If nothing is returned, immediate completion is assumed.
347
- */
348
- fnFunction: Function,
349
- /**
350
- * Definitions of the preconditions to be checked before execution
351
- */
352
- mParameters?: {
353
- /**
354
- * Defines the busy indicator
355
- */
356
- busy?: {
357
- /**
358
- * Executes function only if application isn't busy.
359
- */
360
- check?: boolean;
361
- /**
362
- * Triggers a busy indicator when the function is executed.
363
- */
364
- set?: boolean;
365
- };
366
- /**
367
- * This operation updates the current document without using the bound model and context. As a result, the
368
- * draft status is updated if a draft document exists, and the user has to confirm the cancellation of the
369
- * editing process.
370
- */
371
- updatesDocument?: boolean;
372
- }
373
- ): Promise<any>;
374
- /**
375
- * @SINCE 1.90.0
376
- *
377
- *
378
- * Updates the draft status and displays the error messages if there are errors during an update.
379
- *
380
- * @returns Promise resolves once draft status has been updated
381
- */
382
- updateDocument(
383
- /**
384
- * Context of the updated field
385
- */
386
- oContext: object,
387
- /**
388
- * Promise to determine when the update operation is completed. The promise should be resolved when the
389
- * update operation is completed, so the draft status can be updated.
390
- */
391
- oPromise: Promise<any>
392
- ): undefined | Promise<any>;
393
- }
394
- /**
395
- * @SINCE 1.86.0
396
- *
397
- *
398
- * Controller extension providing hooks for intent-based navigation
399
- */
400
- class IntentBasedNavigation extends sap.ui.core.mvc
401
- .ControllerExtension {
402
- constructor();
403
-
404
- /**
405
- * @SINCE 1.86.0
406
- *
407
- *
408
- * Provides a hook to customize the {@link sap.fe.navigation.SelectionVariant} related to the intent-based
409
- * navigation.
410
- */
411
- adaptNavigationContext(
412
- /**
413
- * SelectionVariant provided by SAP Fiori elements.
414
- */
415
- oSelectionVariant: /* was: sap.fe.core.SelectionVariant */ any,
416
- /**
417
- * Object containing intent-based navigation-related info
418
- */
419
- oNavigationInfo: {
420
- /**
421
- * Action related to the intent
422
- */
423
- action: string;
424
- /**
425
- * Semantic object related to the intent
426
- */
427
- semanticObject: string;
428
- }
429
- ): void;
430
- /**
431
- * @SINCE 1.86.0
432
- *
433
- *
434
- * Navigates to an intent defined by an outbound definition in the manifest.
435
- */
436
- navigateOutbound(
437
- /**
438
- * Identifier to locate the outbound definition in the manifest.
439
- * This provides the semantic object and action for the intent-based navigation.
440
- * Additionally, the outbound definition can be used to provide parameters for intent-based navigation.
441
- * See {@link topic:be0cf40f61184b358b5faedaec98b2da Descriptor for Applications, Components, and Libraries}
442
- * for more information.
443
- */
444
- sOutbound: string,
445
- /**
446
- * Optional map containing key/value pairs to be passed to the intent.
447
- * If mNavigationParameters are provided, the parameters provided in the outbound definition of the manifest
448
- * are ignored.
449
- */
450
- mNavigationParameters: object
451
- ): void;
452
- }
453
- /**
454
- * @SINCE 1.90.0
455
- *
456
- * @EXPERIMENTAL (since 1.90.0
457
- * )
458
- *
459
- * A controller extension offering message handling.
460
- */
461
- class MessageHandler extends sap.ui.core.mvc.ControllerExtension {
462
- constructor();
463
-
464
- /**
465
- * @SINCE 1.90.0
466
- *
467
- * @EXPERIMENTAL (since 1.90.0
468
- * )
469
- *
470
- * Shows a message dialog with transition messages if there are any.
471
- * The message dialog is shown as a modal dialog. Once the user confirms the dialog, all transition messages
472
- * are removed from the message model. If there is more than one message, a list of messages is shown. The
473
- * user
474
- * can filter on message types and can display details as well as the long text. If there is one message,
475
- * the dialog immediately shows the details of the message. If there is just one success message, a message
476
- * toast is shown instead.
477
- *
478
- * @returns A promise that is resolved once the user closes the dialog. If there are no messages
479
- * to be shown, the promise is resolved immediately
480
- */
481
- showMessageDialog(): Promise<any>;
482
- }
483
- /**
484
- * @SINCE 1.94.0
485
- *
486
- *
487
- * Controller extension providing hooks for the navigation using paginators
488
- */
489
- class Paginator extends sap.ui.core.mvc.ControllerExtension {
490
- constructor();
491
-
492
- /**
493
- * @SINCE 1.94.0
494
- *
495
- *
496
- * Initiates the paginator control.
497
- */
498
- initialize(
499
- /**
500
- * ODataListBinding object
501
- */
502
- oBinding: any,
503
- /**
504
- * Current context where the navigation is initiated
505
- */
506
- oContext: sap.ui.model.odata.v4.Context
507
- ): void;
508
- /**
509
- * @SINCE 1.94.0
510
- *
511
- *
512
- * Returns the updated context after the paginator operation.
513
- */
514
- onContextUpdate(
515
- /**
516
- * Final context returned after the paginator action
517
- */
518
- oContext: sap.ui.model.odata.v4.Context
519
- ): void;
520
- }
521
- /**
522
- * @SINCE 1.86.0
523
- *
524
- *
525
- * A controller extension offering hooks into the routing flow of the application
526
- */
527
- class Routing extends sap.ui.core.mvc.ControllerExtension {
528
- constructor();
529
-
530
- /**
531
- * @SINCE 1.90.0
532
- *
533
- *
534
- * Allows navigation to a specific context.
535
- */
536
- navigate(
537
- /**
538
- * Object containing the context to be navigated
539
- */
540
- oContext: sap.ui.model.odata.v4.Context
541
- ): void;
542
- /**
543
- * Navigate to another target.
544
- *
545
- * @returns Promise that is resolved when the navigation is finalized
546
- */
547
- navigateToRoute(
548
- /**
549
- * Name of the target route
550
- */
551
- sTargetRouteName: string,
552
- /**
553
- * Parameters to be used with route to create the target hash
554
- */
555
- oParameters?: any
556
- ): Promise<any>;
557
- /**
558
- * @SINCE 1.90.0
559
- *
560
- *
561
- * This function is used to intercept the routing event after binding a page.
562
- * If it is declared as an extension, it allows you to intercept and change the normal flow of binding.
563
- *
564
- * This function is not called directly, but overridden separately by consuming controllers.
565
- * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
566
- */
567
- onAfterBinding(
568
- /**
569
- * Object containing the context to be navigated
570
- */
571
- oContext: object
572
- ): void;
573
- /**
574
- * @SINCE 1.90.0
575
- *
576
- *
577
- * This function is used to intercept the routing event before binding a page.
578
- * If it is declared as an extension, it allows you to intercept and change the normal flow of binding.
579
- *
580
- * This function is not called directly, but overridden separately by consuming controllers.
581
- * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
582
- */
583
- onBeforeBinding(
584
- /**
585
- * Object containing the context for the navigation
586
- */
587
- oContext: object
588
- ): void;
589
- /**
590
- * @SINCE 1.86.0
591
- *
592
- *
593
- * This function can be used to intercept the routing event happening during the normal process of navigating
594
- * from one page to another.
595
- * If declared as an extension, it allows you to intercept and change the normal navigation flow.
596
- * If you decide to do your own navigation processing, you can return `true` to prevent the default routing
597
- * behavior.
598
- *
599
- * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
600
- * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
601
- *
602
- *
603
- * @returns `true` to prevent the default execution, false to keep the standard behavior
604
- */
605
- onBeforeNavigation(
606
- /**
607
- * Object containing row context and page context
608
- */
609
- mNavigationParameters: {
610
- /**
611
- * The currently selected context
612
- */
613
- bindingContext: sap.ui.model.odata.v4.Context;
614
- }
615
- ): boolean;
616
- }
617
- /**
618
- * @SINCE 1.86.0
619
- *
620
- *
621
- * A controller extension offering hooks into the routing flow of the application
622
- */
623
- class Share extends sap.ui.core.mvc.ControllerExtension {
624
- constructor();
26
+ /**
27
+ * @SINCE 1.90.0
28
+ *
29
+ * Internal base controller class for SAP Fiori elements application.
30
+ *
31
+ * If you want to extend a base controller for your custom page, please use for sap.fe.core.PageController.
32
+ */
33
+ export const BaseController: undefined;
625
34
 
626
- /**
627
- * @SINCE 1.93.0
628
- *
629
- *
630
- * Adapts the metadata used while sharing the page URL via 'Send Email', 'Share in SAP Jam', and 'Save as
631
- * Tile'.
632
- *
633
- * @returns Share Metadata or a Promise resolving the Share Metadata
634
- */
635
- adaptShareMetadata(
636
- /**
637
- * Object containing the share metadata.
638
- */
639
- oShareMetadata: {
640
- /**
641
- * Email-specific metadata.
642
- */
643
- email?: {
644
- /**
645
- * Title that will be used as "email subject" in 'Send Email'. This takes precedence over oShareMetadata.title.
646
- */
647
- title: string;
648
- /**
649
- * URL that will be used specifically for 'Send Email'. This takes precedence over oShareMetadata.url.
650
- */
651
- url: string;
652
- };
653
- /**
654
- * SAP Jam-specific metadata.
655
- */
656
- jam?: {
657
- /**
658
- * Title that will be used as 'share text' in 'Share in SAP Jam'. This takes precedence over oShareMetadata.title.
659
- */
660
- title: string;
661
- /**
662
- * URL that will be used specifically for 'Share in SAP Jam'. This takes precedence over oShareMetadata.url.
663
- */
664
- url: string;
665
- };
666
- /**
667
- * Save as Tile-specific metadata.
668
- */
669
- tile?: {
670
- /**
671
- * Icon to be used for the tile.
672
- */
673
- icon: string;
674
- /**
675
- * Query URL of an OData service from which data for a dynamic tile is read.
676
- */
677
- queryUrl: string;
678
- /**
679
- * Subtitle to be used for the tile.
680
- */
681
- subtitle: string;
682
- /**
683
- * Title to be used for the tile. This takes precedence over oShareMetadata.title.
684
- */
685
- title: string;
686
- /**
687
- * URL that will be used specifically for 'Save as Tile'. This takes precedence over oShareMetadata.url.
688
- */
689
- url: string;
690
- };
691
- /**
692
- * Default title that will be used as 'email subject' in 'Send Email', 'share text' in 'Share in SAP Jam'
693
- * and 'title' in 'Save as Tile'
694
- */
695
- title: string;
696
- /**
697
- * Default URL that will be used via 'Send Email', 'Share in SAP Jam', and 'Save as Tile'
698
- */
699
- url: string;
700
- }
701
- ): object | Promise<any>;
702
- /**
703
- * @SINCE 1.93.0
704
- *
705
- *
706
- * Opens the share sheet.
707
- */
708
- openShareSheet(
709
- /**
710
- * The control to which the ActionSheet is opened.
711
- */
712
- oControl: object
713
- ): void;
714
- }
715
- /**
716
- * @SINCE 1.85.0
717
- *
718
- *
719
- * A controller extension offering hooks for state handling
720
- * If you need to maintain a specific state for your application, you can use the controller extension.
721
- */
722
- class ViewState extends sap.ui.core.mvc.ControllerExtension {
723
- constructor();
35
+ /**
36
+ * @SINCE 1.79.0
37
+ *
38
+ * Common Extension API for all pages of SAP Fiori elements for OData V4.
39
+ */
40
+ export const ExtensionAPI: undefined;
724
41
 
725
- /**
726
- * This function should add all controls relevant for refreshing to the provided control array.
727
- * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
728
- * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
729
- */
730
- adaptBindingRefreshControls(
731
- /**
732
- * The collected controls
733
- */
734
- aCollectedControls: sap.ui.base.ManagedObject[]
735
- ): void;
736
- /**
737
- * Customize the `refreshBinding` function for a certain control.
738
- * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
739
- * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
740
- */
741
- adaptBindingRefreshHandler(
742
- /**
743
- * The control for which the refresh handler is adapted.
744
- */
745
- oControl: sap.ui.base.ManagedObject,
746
- /**
747
- * A plain object which can have one function: `refreshBinding`
748
- */
749
- oControlHandler: any[]
750
- ): void;
751
- /**
752
- * Customize the `retrieve` and `apply` functions for a certain control.
753
- * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
754
- * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
755
- */
756
- adaptControlStateHandler(
757
- /**
758
- * The control to get state handler for
759
- */
760
- oControl: sap.ui.base.ManagedObject,
761
- /**
762
- * A list of plain objects with two functions: `retrieve` and `apply`
763
- */
764
- aControlHandler: object[]
765
- ): void;
766
- /**
767
- * This function should add all controls for given view that should be considered for the state handling
768
- * to the provided control array.
769
- * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
770
- * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
771
- */
772
- adaptStateControls(
773
- /**
774
- * The collected controls
775
- */
776
- aCollectedControls: sap.ui.base.ManagedObject[]
777
- ): void;
778
- /**
779
- * Applying additional, not control related, states - is called only if navigation type is iAppState.
780
- * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
781
- * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
782
- */
783
- applyAdditionalStates(
784
- /**
785
- * The current view state
786
- */
787
- oViewState: object,
788
- /**
789
- * Extensible array of promises to be resolved before continuing
790
- */
791
- aPromises: Promise<any>
792
- ): void;
793
- /**
794
- * Defines whether the view state should only be applied once initially.
795
- * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
796
- * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.Instead}.
797
- *
798
- * Important:
799
- * You should only override this method for custom pages and not for the standard ListReportPage and ObjectPage!
800
- *
801
- *
802
- * @returns If `true`, only the initial view state is applied once,
803
- * else any new view state is also applied on follow-up calls (default)
804
- */
805
- applyInitialStateOnly(): boolean;
806
- /**
807
- * Apply navigation parameters - is called only if navigation type is not iAppState.
808
- * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
809
- * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
810
- */
811
- applyNavigationParameters(
812
- /**
813
- * The current navigation parameter
814
- */
815
- oNavParameter: {
816
- /**
817
- * The actual navigation type
818
- */
819
- navigationType: any;
820
- /**
821
- * Defines whether standard variant must be used in VM
822
- */
823
- requiresStandardVariant?: boolean;
824
- /**
825
- * The selectionVariant from the navigation
826
- */
827
- selectionVariant?: object;
828
- /**
829
- * The selectionVariant defaults from the navigation
830
- */
831
- selectionVariantDefaults?: object;
832
- },
833
- /**
834
- * Extensible array of promises to be resolved before continuing
835
- */
836
- aPromises: Promise<any>
837
- ): void;
838
- /**
839
- * Applies the given view state to this extensions view.
840
- *
841
- * @returns Promise for async state handling
842
- */
843
- applyViewState(
844
- /**
845
- * The view state to apply (can be undefined)
846
- */
847
- oViewState: any,
848
- /**
849
- * The current navigation parameter
850
- */
851
- oNavParameter: {
852
- /**
853
- * The actual navigation type
854
- */
855
- navigationType: any;
856
- /**
857
- * Defines whether standard variant must be used in VM
858
- */
859
- requiresStandardVariant?: boolean;
860
- /**
861
- * The selectionVariant from the navigation
862
- */
863
- selectionVariant?: object;
864
- /**
865
- * The selectionVariant defaults from the navigation
866
- */
867
- selectionVariantDefaults?: object;
868
- }
869
- ): Promise<any>;
870
- /**
871
- * Hook to react when state for given view was applied.
872
- * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
873
- * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
874
- */
875
- onAfterStateApplied(
876
- /**
877
- * Extensible array of promises to be resolved before continuing
878
- */
879
- aPromises: Promise<any>
880
- ): void;
881
- /**
882
- * Hook to react before a state for given view is applied.
883
- * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
884
- * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
885
- */
886
- onBeforeStateApplied(
887
- /**
888
- * Extensible array of promises to be resolved before continuing
889
- */
890
- aPromises: Promise<any>
891
- ): void;
892
- /**
893
- * Called when the application is restored due to keep-alive mode.
894
- */
895
- onRestore(): void;
896
- /**
897
- * Called when the application is suspended due to keep-alive mode.
898
- */
899
- onSuspend(): void;
900
- /**
901
- * Extend the map of additional states (not control bound) to be added to the current view state of the
902
- * given view.
903
- * This function is meant to be individually overridden by consuming controllers, but not to be called directly.
904
- * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.After}.
905
- */
906
- retrieveAdditionalStates(
907
- /**
908
- * The additional state
909
- */
910
- mAdditionalStates: object
911
- ): void;
912
- /**
913
- * Retrieve the view state of this extensions view.
914
- * When this function is called more than once before finishing, all but the final response will resolve
915
- * to `undefined`.
916
- *
917
- * @returns A promise resolving the view state
918
- */
919
- retrieveViewState(): Promise<any>;
920
- }
921
- }
922
42
  /**
923
43
  * Collection of classes provided by SAP Fiori elements for the Flexible Programming Model
924
44
  */
925
45
  namespace fpm {
926
46
  /**
927
47
  * @SINCE 1.92.0
928
- *
929
- * @EXPERIMENTAL (since 1.92.0
930
- * )
48
+ * @EXPERIMENTAL (since 1.92.0)
931
49
  *
932
50
  * Component that can be used as a wrapper component for custom pages.
51
+ *
933
52
  * The component can be used in case you want to use SAP Fiori elements Building Blocks or XML template
934
53
  * constructions. You can either extend the component and set the viewName and contextPath within your code
935
54
  * or you can use it to wrap your custom XML view directly the manifest when you define your custom page
@@ -952,234 +71,9 @@ declare namespace sap {
952
71
  * }
953
72
  * ```
954
73
  */
955
- class Component
956
- /* was: sap.fe.core.TemplateComponent */ extends Object {
957
- constructor();
958
- }
959
- }
960
-
961
- interface $AppComponentSettings
962
- extends sap.ui.core.$UIComponentSettings {}
963
-
964
- /**
965
- * Main class for components used for an application in SAP Fiori elements.
966
- * Application developers using the templates and building blocks provided by SAP Fiori elements should
967
- * create their apps by extending this component.
968
- * This ensures that all the necessary services that you need for the building blocks and templates to work
969
- * properly are started.
970
- *
971
- * When you use sap.fe.core.AppComponent as the base component, you also need to use a rootView. SAP Fiori
972
- * elements provides two options:
973
- *
974
- * - sap.fe.templates.RootContainer.view.NavContainer when using sap.m.routing.Router
975
- *
976
- * - sap.fe.templates.RootContainer.view.Fcl when using sap.f.routing.Router (FCL use case)
977
- */
978
- class AppComponent extends sap.ui.core.UIComponent {
979
- constructor();
980
- }
981
- /**
982
- * @SINCE 1.90.0
983
- *
984
- *
985
- * Internal base controller class for SAP Fiori elements application.
986
- * If you want to extend a base controller for your custom page, please use for sap.fe.core.PageController.
987
- */
988
- class BaseController extends sap.ui.core.mvc.Controller {
989
- constructor();
990
-
991
- /**
992
- * @SINCE 1.91.0
993
- *
994
- *
995
- * Returns the current app component.
996
- *
997
- * @returns The app component or, if not found, null
998
- */
999
- getAppComponent(): sap.fe.core.AppComponent;
1000
- /**
1001
- * Convenience method provided by SAP Fiori elements to enable applications to include the view model by
1002
- * name into each controller.
1003
- *
1004
- * @returns The model instance
1005
- */
1006
- getModel(
1007
- /**
1008
- * The model name
1009
- */
1010
- sName?: string
1011
- ): sap.ui.model.Model;
1012
- /**
1013
- * Convenience method for setting the view model in every controller of the application.
1014
- *
1015
- * @returns The view instance
1016
- */
1017
- setModel(
1018
- /**
1019
- * The model instance
1020
- */
1021
- oModel: sap.ui.model.Model,
1022
- /**
1023
- * The model name
1024
- */
1025
- sName: string
1026
- ): sap.ui.core.mvc.View;
1027
- }
1028
- /**
1029
- * @SINCE 1.79.0
1030
- *
1031
- *
1032
- * Common Extension API for all pages of SAP Fiori elements for OData V4.
1033
- */
1034
- class ExtensionAPI extends sap.ui.base.Object {
1035
- constructor();
1036
-
1037
- /**
1038
- * Add any control as a dependent control to this SAP Fiori elements page.
1039
- */
1040
- addDependent(
1041
- /**
1042
- * Control to be added as a dependent control
1043
- */
1044
- oControl: sap.ui.core.Control
1045
- ): void;
1046
- /**
1047
- * Get access to models managed by SAP Fiori elements.
1048
- *
1049
- * The following models can be accessed:
1050
- *
1051
- *
1052
- * - undefined: the undefined model returns the SAPUI5 OData V4 model bound to this page
1053
- *
1054
- * - i18n / further data models defined in the manifest
1055
- * ui: returns a SAPUI5 JSON model containing UI information.
1056
- * Only the following properties are public and supported:
1057
- *
1058
- *
1059
- * - isEditable: set to true if the application is in edit mode
1060
- *
1061
- *
1062
- * .
1063
- * editMode is deprecated and should not be used anymore. Use isEditable instead.
1064
- *
1065
- * @returns The required model
1066
- */
1067
- getModel(
1068
- /**
1069
- * Name of the model
1070
- */
1071
- sModelName?: string
1072
- ): undefined | sap.ui.model.Model;
1073
- /**
1074
- * Load a fragment and go through the template preprocessor with the current page context.
1075
- *
1076
- * @returns The fragment definition
1077
- */
1078
- loadFragment(
1079
- /**
1080
- * The settings object
1081
- */
1082
- mSettings: {
1083
- /**
1084
- * The contextPath to be used for the templating process
1085
- */
1086
- contextPath: string;
1087
- /**
1088
- * The controller to be attached to the fragment
1089
- */
1090
- controller: object;
1091
- /**
1092
- * The ID of the fragment itself
1093
- */
1094
- id: string;
1095
- /**
1096
- * The initial binding context
1097
- */
1098
- initialBindingContext: sap.ui.model.Context;
1099
- /**
1100
- * The name of the fragment to be loaded
1101
- */
1102
- name: string;
1103
- }
1104
- ): Promise<any>;
1105
- /**
1106
- * Navigate to another target.
1107
- */
1108
- navigateToTarget(
1109
- /**
1110
- * Name of the target route
1111
- */
1112
- sTarget: string,
1113
- /**
1114
- * Context instance
1115
- */
1116
- oContext: sap.ui.model.Context
1117
- ): void;
1118
- /**
1119
- * Remove a dependent control from this SAP Fiori elements page.
1120
- */
1121
- removeDependent(
1122
- /**
1123
- * Control to be added as a dependent control
1124
- */
1125
- oControl: sap.ui.core.Control
1126
- ): void;
1127
- /**
1128
- * Triggers an update of the app state.
1129
- * Should be called if the state of a control, or any other state-relevant information, was changed.
1130
- *
1131
- * @returns A promise that resolves with the new app state object.
1132
- */
1133
- updateAppState(): undefined | Promise<any>;
74
+ export const Component: undefined;
1134
75
  }
1135
- /**
1136
- * @SINCE 1.88.0
1137
- *
1138
- *
1139
- * Base controller class for your custom page used inside an SAP Fiori elements application.
1140
- * This controller provides preconfigured extensions that will ensure you have the basic functionalities
1141
- * required to use the building blocks.
1142
- */
1143
- class PageController extends sap.fe.core.BaseController {
1144
- constructor();
1145
76
 
1146
- /**
1147
- * @SINCE 1.91.0
1148
- *
1149
- *
1150
- * Returns the current app component.
1151
- *
1152
- * @returns The app component or, if not found, null
1153
- */
1154
- getAppComponent(): sap.fe.core.AppComponent;
1155
- /**
1156
- * Convenience method provided by SAP Fiori elements to enable applications to include the view model by
1157
- * name into each controller.
1158
- *
1159
- * @returns The model instance
1160
- */
1161
- getModel(
1162
- /**
1163
- * The model name
1164
- */
1165
- sName?: string
1166
- ): sap.ui.model.Model;
1167
- /**
1168
- * Convenience method for setting the view model in every controller of the application.
1169
- *
1170
- * @returns The view instance
1171
- */
1172
- setModel(
1173
- /**
1174
- * The model instance
1175
- */
1176
- oModel: sap.ui.model.Model,
1177
- /**
1178
- * The model name
1179
- */
1180
- sName: string
1181
- ): sap.ui.core.mvc.View;
1182
- }
1183
77
  /**
1184
78
  * @SINCE 1.86.0
1185
79
  *
@@ -1203,30 +97,6 @@ declare namespace sap {
1203
97
  }
1204
98
 
1205
99
  interface IUI5DefineDependencyNames {
1206
- "sap/fe/core/AppComponent": undefined;
1207
-
1208
- "sap/fe/core/BaseController": undefined;
1209
-
1210
- "sap/fe/core/controllerextensions/EditFlow": undefined;
1211
-
1212
- "sap/fe/core/controllerextensions/IntentBasedNavigation": undefined;
1213
-
1214
- "sap/fe/core/controllerextensions/MessageHandler": undefined;
1215
-
1216
- "sap/fe/core/controllerextensions/Paginator": undefined;
1217
-
1218
- "sap/fe/core/controllerextensions/Routing": undefined;
1219
-
1220
- "sap/fe/core/controllerextensions/Share": undefined;
1221
-
1222
- "sap/fe/core/controllerextensions/ViewState": undefined;
1223
-
1224
- "sap/fe/core/ExtensionAPI": undefined;
1225
-
1226
- "sap/fe/core/fpm/Component": undefined;
1227
-
1228
100
  "sap/fe/core/library": undefined;
1229
-
1230
- "sap/fe/core/PageController": undefined;
1231
101
  }
1232
102
  }