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