@sapui5/ts-types-esm 1.139.0 → 1.140.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 (69) hide show
  1. package/package.json +1 -1
  2. package/types/sap.apf.d.ts +1 -1
  3. package/types/sap.ca.ui.d.ts +1 -1
  4. package/types/sap.chart.d.ts +1 -1
  5. package/types/sap.collaboration.d.ts +1 -1
  6. package/types/sap.cux.home.d.ts +0 -1623
  7. package/types/sap.esh.search.ui.d.ts +1 -2297
  8. package/types/sap.f.d.ts +59 -11
  9. package/types/sap.fe.ariba.d.ts +1 -1
  10. package/types/sap.fe.base.d.ts +1 -5
  11. package/types/sap.fe.controls.d.ts +1 -1
  12. package/types/sap.fe.core.d.ts +15 -8
  13. package/types/sap.fe.ina.d.ts +1 -1
  14. package/types/sap.fe.macros.d.ts +3 -10
  15. package/types/sap.fe.navigation.d.ts +1 -1
  16. package/types/sap.fe.placeholder.d.ts +1 -1
  17. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  18. package/types/sap.fe.templates.d.ts +1 -1
  19. package/types/sap.fe.test.d.ts +1 -1
  20. package/types/sap.fe.tools.d.ts +1 -1
  21. package/types/sap.feedback.ui.d.ts +1 -1
  22. package/types/sap.gantt.d.ts +41 -11
  23. package/types/sap.insights.d.ts +130 -2
  24. package/types/sap.m.d.ts +645 -274
  25. package/types/sap.makit.d.ts +1 -1
  26. package/types/sap.me.d.ts +1 -1
  27. package/types/sap.ndc.d.ts +1 -1
  28. package/types/sap.ovp.d.ts +1 -1
  29. package/types/sap.rules.ui.d.ts +1 -1
  30. package/types/sap.sac.df.d.ts +99 -1
  31. package/types/sap.suite.ui.commons.d.ts +1 -1
  32. package/types/sap.suite.ui.generic.template.d.ts +1 -1
  33. package/types/sap.suite.ui.microchart.d.ts +1 -1
  34. package/types/sap.tnt.d.ts +5 -1
  35. package/types/sap.ui.codeeditor.d.ts +1 -1
  36. package/types/sap.ui.commons.d.ts +1 -1
  37. package/types/sap.ui.comp.d.ts +16 -1
  38. package/types/sap.ui.core.d.ts +402 -97
  39. package/types/sap.ui.dt.d.ts +1 -1
  40. package/types/sap.ui.export.d.ts +1 -1
  41. package/types/sap.ui.fl.d.ts +1 -7
  42. package/types/sap.ui.generic.app.d.ts +1 -1
  43. package/types/sap.ui.generic.template.d.ts +1 -1
  44. package/types/sap.ui.integration.d.ts +13 -13
  45. package/types/sap.ui.layout.d.ts +1 -1
  46. package/types/sap.ui.mdc.d.ts +80 -28
  47. package/types/sap.ui.richtexteditor.d.ts +1 -1
  48. package/types/sap.ui.rta.d.ts +1 -1
  49. package/types/sap.ui.suite.d.ts +1 -1
  50. package/types/sap.ui.support.d.ts +1 -1
  51. package/types/sap.ui.table.d.ts +568 -1
  52. package/types/sap.ui.testrecorder.d.ts +1 -1
  53. package/types/sap.ui.unified.d.ts +1 -1
  54. package/types/sap.ui.ux3.d.ts +1 -1
  55. package/types/sap.ui.vbm.d.ts +1 -1
  56. package/types/sap.ui.vk.d.ts +307 -6
  57. package/types/sap.ui.vtm.d.ts +1 -1
  58. package/types/sap.ui.webc.common.d.ts +1 -1
  59. package/types/sap.ui.webc.fiori.d.ts +1 -1
  60. package/types/sap.ui.webc.main.d.ts +1 -1
  61. package/types/sap.uiext.inbox.d.ts +1 -1
  62. package/types/sap.ushell.d.ts +10 -6
  63. package/types/sap.ushell_abap.d.ts +3 -1
  64. package/types/sap.uxap.d.ts +1 -1
  65. package/types/sap.viz.d.ts +1 -1
  66. package/types/sap.webanalytics.core.d.ts +1 -1
  67. package/types/sap.zen.commons.d.ts +1 -1
  68. package/types/sap.zen.crosstab.d.ts +1 -1
  69. package/types/sap.zen.dsh.d.ts +1 -1
@@ -1,1628 +1,5 @@
1
1
  // For Library Version: 0.0.1
2
2
 
3
- declare module "sap/cux/home/App" {
4
- import { default as BaseApp, $BaseAppSettings } from "sap/cux/home/BaseApp";
5
-
6
- /**
7
- * App class for managing and storing Apps.
8
- *
9
- * @since 1.121.0
10
- */
11
- export default class App extends BaseApp {
12
- /**
13
- * Constructor for a new App.
14
- */
15
- constructor(
16
- /**
17
- * ID for the new app, generated automatically if an ID is not provided
18
- */
19
- id?: string,
20
- /**
21
- * Initial settings for the new app
22
- */
23
- settings?: /* was: sap.cux.home.App.$AppSettings */ any
24
- );
25
- }
26
- /**
27
- * Describes the settings that can be provided to the App constructor.
28
- */
29
- export interface $AppSettings extends $BaseAppSettings {}
30
- }
31
-
32
- declare module "sap/cux/home/AppsContainer" {
33
- import {
34
- default as BaseContainer,
35
- $BaseContainerSettings,
36
- } from "sap/cux/home/BaseContainer";
37
-
38
- /**
39
- * Container class for managing and storing apps.
40
- *
41
- * @since 1.121
42
- */
43
- export default class AppsContainer extends BaseContainer {
44
- /**
45
- * Constructor for a new app container.
46
- */
47
- constructor(
48
- /**
49
- * ID for the new control, generated automatically if an ID is not provided
50
- */
51
- id?: string,
52
- /**
53
- * Initial settings for the new control
54
- */
55
- settings?: /* was: sap.cux.home.AppsContainer.$AppsContainerSettings */ any
56
- );
57
- }
58
- /**
59
- * Describes the settings that can be provided to the AppsContainer constructor.
60
- */
61
- export interface $AppsContainerSettings extends $BaseContainerSettings {}
62
- }
63
-
64
- declare module "sap/cux/home/BaseApp" {
65
- import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
66
-
67
- /**
68
- * Base App class for managing and storing Apps.
69
- *
70
- * @since 1.121.0
71
- */
72
- export default abstract class BaseApp extends UI5Element {
73
- /**
74
- * Constructor for a new Base App.
75
- */
76
- constructor(
77
- /**
78
- * ID for the new app, generated automatically if an ID is not provided
79
- */
80
- id?: string,
81
- /**
82
- * Initial settings for the new app
83
- */
84
- settings?: /* was: sap.cux.home.BaseApp.$BaseAppSettings */ any
85
- );
86
- }
87
- /**
88
- * Describes the settings that can be provided to the BaseApp constructor.
89
- */
90
- export interface $BaseAppSettings extends $ElementSettings {}
91
- }
92
-
93
- declare module "sap/cux/home/BaseContainer" {
94
- import { default as Control, $ControlSettings } from "sap/ui/core/Control";
95
-
96
- import { CSSSize } from "sap/ui/core/library";
97
-
98
- import {
99
- PropertyBindingInfo,
100
- AggregationBindingInfo,
101
- } from "sap/ui/base/ManagedObject";
102
-
103
- import Button from "sap/m/Button";
104
-
105
- import BasePanel from "sap/cux/home/BasePanel";
106
-
107
- import MenuItem from "sap/cux/home/MenuItem";
108
-
109
- /**
110
- * Abstract base class for all container controls in the Home Page Layout.
111
- *
112
- * @since 1.121
113
- */
114
- export default abstract class BaseContainer extends Control {
115
- /**
116
- * Constructor for a new Base Container.
117
- */
118
- constructor(
119
- /**
120
- * ID for the new control, generated automatically if an ID is not provided
121
- */
122
- id?: string,
123
- /**
124
- * Initial settings for the new control
125
- */
126
- settings?: /* was: sap.cux.home.BaseContainer.$BaseContainerSettings */ any
127
- );
128
-
129
- /**
130
- * Gets current value of property height.
131
- *
132
- *
133
- * @returns Value of property `height`
134
- */
135
- getHeight(): CSSSize;
136
- /**
137
- * Gets current value of property width.
138
- *
139
- *
140
- * @returns Value of property `width`
141
- */
142
- getWidth(): CSSSize;
143
- /**
144
- * Gets current value of property height.
145
- *
146
- *
147
- * @returns Value of property `height`
148
- */
149
- setHeight(): CSSSize;
150
- /**
151
- * Gets current value of property width.
152
- *
153
- *
154
- * @returns Value of property `width`
155
- */
156
- setWidth(): CSSSize;
157
- }
158
- /**
159
- * Describes the settings that can be provided to the BaseContainer constructor.
160
- */
161
- export interface $BaseContainerSettings extends $ControlSettings {
162
- /**
163
- * Height to be set for the container.
164
- */
165
- height?: CSSSize | PropertyBindingInfo | `{${string}}`;
166
-
167
- /**
168
- * Width to be set for the container.
169
- */
170
- width?: CSSSize | PropertyBindingInfo | `{${string}}`;
171
-
172
- /**
173
- * This aggregation contains the actions that should be displayed within the container.
174
- */
175
- actionButtons?: Button[] | Button | AggregationBindingInfo | `{${string}}`;
176
-
177
- /**
178
- * The container content aggregation which should be of type BasePanel.
179
- */
180
- content?: BasePanel[] | BasePanel | AggregationBindingInfo | `{${string}}`;
181
-
182
- /**
183
- * This aggregation holds the items that should be shown within the dropdown menu of the container.
184
- */
185
- menuItems?: MenuItem[] | MenuItem | AggregationBindingInfo | `{${string}}`;
186
- }
187
- }
188
-
189
- declare module "sap/cux/home/BaseLayout" {
190
- import { default as Page, $PageSettings } from "sap/m/Page";
191
-
192
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
193
-
194
- /**
195
- * Abstract base class for My Home layout.
196
- *
197
- * @since 1.121
198
- */
199
- export default abstract class BaseLayout extends Page {
200
- /**
201
- * Constructor for a new Base Layout.
202
- */
203
- constructor(
204
- /**
205
- * ID for the new control, generated automatically if an ID is not provided
206
- */
207
- id?: string,
208
- /**
209
- * Initial settings for the new control
210
- */
211
- settings?: /* was: sap.cux.home.BaseLayout.$BaseLayoutSettings */ any
212
- );
213
-
214
- /**
215
- * Gets current value of property persContainerId.
216
- *
217
- *
218
- * @returns Value of property `persContainerId`
219
- */
220
- getPersContainerId(): string;
221
- /**
222
- * Gets current value of property persContainerId.
223
- *
224
- *
225
- * @returns Value of property `persContainerId`
226
- */
227
- setPersContainerId(): string;
228
- /**
229
- * Sets SettingsDialog aggregation.
230
- * Overridden to update cached settings panels.
231
- * Sets the aggregated settingsDialog.
232
- * The settings dialog aggregation which controls settings for my home controls.
233
- * It should be of type BaseSettingsDialog.
234
- * If Not provided, a default settings dialog will be created from sap.cux.home.SettingsDialog.
235
- * In case of only custom settings panels, the settings dialog should be created and set manually from sap.cux.home.SettingsDialog.
236
- *
237
- *
238
- *
239
- * @returns the dialog for chaining
240
- */
241
- setSettingsDialog(): this;
242
- }
243
- /**
244
- * Describes the settings that can be provided to the BaseLayout constructor.
245
- */
246
- export interface $BaseLayoutSettings extends $PageSettings {
247
- /**
248
- * Container ID for Ushell Personalisation.
249
- * This property holds the ID of the personalization container.
250
- * It is used to store and retrieve personalized settings for the control.
251
- */
252
- persContainerId?: string | PropertyBindingInfo;
253
- }
254
- }
255
-
256
- declare module "sap/cux/home/BaseNewsItem" {
257
- import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
258
-
259
- /**
260
- * Base class for managing and storing News items.
261
- *
262
- * @since 1.121
263
- */
264
- export default class BaseNewsItem extends UI5Element {
265
- /**
266
- * Constructor for a new Base News Item.
267
- */
268
- constructor(
269
- /**
270
- * ID for the new base news item, generated automatically if an ID is not provided
271
- */
272
- id?: string,
273
- /**
274
- * Initial settings for the new base news item
275
- */
276
- settings?: /* was: sap.cux.home.BaseNewsItem.$BaseNewsItemSettings */ any
277
- );
278
- }
279
- /**
280
- * Describes the settings that can be provided to the BaseNewsItem constructor.
281
- */
282
- export interface $BaseNewsItemSettings extends $ElementSettings {}
283
- }
284
-
285
- declare module "sap/cux/home/BaseNewsPanel" {
286
- import {
287
- default as BasePanel,
288
- $BasePanelSettings,
289
- } from "sap/cux/home/BasePanel";
290
-
291
- /**
292
- * Base Panel class for managing and storing News.
293
- *
294
- * @since 1.121
295
- */
296
- export default abstract class BaseNewsPanel extends BasePanel {
297
- /**
298
- * Constructor for a new Base News Panel.
299
- */
300
- constructor(
301
- /**
302
- * ID for the new panel, generated automatically if an ID is not provided
303
- */
304
- id?: string,
305
- /**
306
- * Initial settings for the new panel
307
- */
308
- settings?: /* was: sap.cux.home.BaseNewsPanel.$BaseNewsPanelSettings */ any
309
- );
310
- }
311
- /**
312
- * Describes the settings that can be provided to the BaseNewsPanel constructor.
313
- */
314
- export interface $BaseNewsPanelSettings extends $BasePanelSettings {}
315
- }
316
-
317
- declare module "sap/cux/home/BasePagePanel" {
318
- import {
319
- default as BasePanel,
320
- $BasePanelSettings,
321
- } from "sap/cux/home/BasePanel";
322
-
323
- /**
324
- * Base Panel class for managing and storing Pages.
325
- *
326
- * @since 1.121
327
- */
328
- export default abstract class BasePagePanel extends BasePanel {
329
- /**
330
- * Constructor for a new Base Page Panel.
331
- */
332
- constructor(
333
- /**
334
- * ID for the new panel, generated automatically if an ID is not provided
335
- */
336
- id?: string,
337
- /**
338
- * Initial settings for the new panel
339
- */
340
- settings?: /* was: sap.cux.home.BasePagePanel.$BasePagePanelSettings */ any
341
- );
342
- }
343
- /**
344
- * Describes the settings that can be provided to the BasePagePanel constructor.
345
- */
346
- export interface $BasePagePanelSettings extends $BasePanelSettings {}
347
- }
348
-
349
- declare module "sap/cux/home/BasePanel" {
350
- import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
351
-
352
- /**
353
- * Abstract base class for all panels placed in {@link sap.cux.home.BaseContainer }.
354
- *
355
- * @since 1.121
356
- */
357
- export default abstract class BasePanel extends UI5Element {
358
- /**
359
- * Constructor for a new Base Panel.
360
- */
361
- constructor(
362
- /**
363
- * ID for the new control, generated automatically if an ID is not provided
364
- */
365
- id?: string,
366
- /**
367
- * Initial settings for the new control
368
- */
369
- settings?: /* was: sap.cux.home.BasePanel.$BasePanelSettings */ any
370
- );
371
- }
372
- /**
373
- * Describes the settings that can be provided to the BasePanel constructor.
374
- */
375
- export interface $BasePanelSettings extends $ElementSettings {}
376
- }
377
-
378
- declare module "sap/cux/home/BaseSettingsDialog" {
379
- import { default as Dialog, $DialogSettings } from "sap/m/Dialog";
380
-
381
- import BaseSettingsPanel from "sap/cux/home/BaseSettingsPanel";
382
-
383
- /**
384
- * Abstract base class for custom settings dialog for {@link sap.cux.home.BaseLayout }.
385
- *
386
- * @since 1.121
387
- */
388
- export default abstract class BaseSettingsDialog extends Dialog {
389
- /**
390
- * Constructor for a new Base Settings Dialog.
391
- */
392
- constructor(
393
- /**
394
- * ID for the new control, generated automatically if an ID is not provided
395
- */
396
- id?: string,
397
- /**
398
- * Initial settings for the new control
399
- */
400
- settings?: /* was: sap.cux.home.BaseSettingsDialog.$BaseSettingsDialogSettings */ any
401
- );
402
-
403
- /**
404
- * Adds a new panel at the end of the available panels.
405
- * Overridden to update cached panels.
406
- * Adds some panel to the aggregation "panels".
407
- * Contains the panels aggregation and should be of type BaseSettingsPanel.
408
- *
409
- *
410
- *
411
- * @returns the dialog for chaining
412
- */
413
- addPanel(): BaseSettingsDialog;
414
- /**
415
- * Returns all the panels in the dialog.
416
- * Overridden to return cached panels.
417
- * Gets content of aggregation "panels".
418
- * Contains the panels aggregation and should be of type BaseSettingsPanel.
419
- *
420
- *
421
- *
422
- * @returns panel array
423
- */
424
- getPanels(): BaseSettingsPanel[];
425
- /**
426
- * Init lifecycle method
427
- */
428
- init(): void;
429
- /**
430
- * Adds a new panel to the 'panels' aggregation at the index.
431
- * Overridden to update cached panels.
432
- * Inserts a panel into the aggregation "panels".
433
- * Contains the panels aggregation and should be of type BaseSettingsPanel.
434
- *
435
- *
436
- *
437
- * @returns Returns 'this' to allow method chaining.
438
- */
439
- insertPanel(
440
- /**
441
- * The panel to insert.
442
- */
443
- panel: BaseSettingsPanel,
444
- /**
445
- * The index at which to insert the panel.
446
- */
447
- index: number
448
- ): BaseSettingsDialog;
449
- /**
450
- * Removes all panels from the dialog, clears the internal panel cache.
451
- * Overridden to update cached panels.
452
- * Removes all the controls from the aggregation "panels".
453
- * Additionally, it unregisters them from the hosting UIArea.
454
- * Contains the panels aggregation and should be of type BaseSettingsPanel.
455
- *
456
- *
457
- *
458
- * @returns An empty array representing the removed panels.
459
- */
460
- removeAllPanels(): BaseSettingsPanel[];
461
- /**
462
- * Removes a panel from the dialog and updates the cache.
463
- * Removes a panel from the aggregation "panels".
464
- * Contains the panels aggregation and should be of type BaseSettingsPanel.
465
- *
466
- *
467
- *
468
- * @returns The removed panel.
469
- */
470
- removePanel(
471
- /**
472
- * - The panel to remove.
473
- */
474
- panel: BaseSettingsPanel
475
- ): BaseSettingsPanel;
476
- }
477
- /**
478
- * Describes the settings that can be provided to the BaseSettingsDialog constructor.
479
- */
480
- export interface $BaseSettingsDialogSettings extends $DialogSettings {}
481
- }
482
-
483
- declare module "sap/cux/home/BaseSettingsPanel" {
484
- import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
485
-
486
- import Button from "sap/m/Button";
487
-
488
- /**
489
- * Abstract base class for panels inside My Home Settings Dialog.
490
- *
491
- * @since 1.121
492
- */
493
- export default abstract class BaseSettingsPanel extends UI5Element {
494
- /**
495
- * Constructor for a new Base Settings Panel.
496
- */
497
- constructor(
498
- /**
499
- * ID for the new control, generated automatically if an ID is not provided
500
- */
501
- id?: string,
502
- /**
503
- * Initial settings for the new control
504
- */
505
- settings?: /* was: sap.cux.home.BaseSettingsPanel.$BaseSettingsPanelSettings */ any
506
- );
507
-
508
- /**
509
- * Adds an action button to the panel.
510
- *
511
- *
512
- * @returns The instance of the panel for chaining.
513
- */
514
- addActionButton(
515
- /**
516
- * - The button to add.
517
- */
518
- button: Button
519
- ): BaseSettingsPanel;
520
- /**
521
- * Add Changes made by user in case of KeyUser Settings Panel.
522
- */
523
- addKeyUserChanges(): void;
524
- /**
525
- * Clear all KeyUser Changes made by user.
526
- */
527
- clearKeyUserChanges(): void;
528
- /**
529
- * Retrieves the action buttons from the panel.
530
- *
531
- *
532
- * @returns array of action buttons.
533
- */
534
- getActionButtons(): Button[];
535
- /**
536
- * Returns the KeyUser Changes made by user.
537
- */
538
- getKeyUserChanges(): /* was: sap.cux.home.interface.KeyUserInterface.IKeyUserChange */ any[];
539
- /**
540
- * Init lifecycle method
541
- */
542
- init(): void;
543
- /**
544
- * Inserts an action button at a specific index in the panel.
545
- *
546
- *
547
- * @returns The instance of the panel for chaining.
548
- */
549
- insertActionButton(
550
- /**
551
- * - The button to insert.
552
- */
553
- button: Button,
554
- /**
555
- * - The index at which to insert the button.
556
- */
557
- index: number
558
- ): BaseSettingsPanel;
559
- /**
560
- * Checks if the panel is supported. To be overridden by subclasses.
561
- *
562
- *
563
- * @returns A promise that resolves to true if the panel is supported.
564
- */
565
- isSupported(): Promise<boolean>;
566
- /**
567
- * Removes an action button from the panel.
568
- *
569
- *
570
- * @returns The removed button or null if not found.
571
- */
572
- removeActionButton(
573
- /**
574
- * - The button to remove.
575
- */
576
- button: Button
577
- ): null | Button;
578
- }
579
- /**
580
- * Describes the settings that can be provided to the BaseSettingsPanel constructor.
581
- */
582
- export interface $BaseSettingsPanelSettings extends $ElementSettings {}
583
- }
584
-
585
- declare module "sap/cux/home/CardsPanel" {
586
- import {
587
- default as BasePanel,
588
- $BasePanelSettings,
589
- } from "sap/cux/home/BasePanel";
590
-
591
- /**
592
- * Panel class for managing and storing Insights Cards.
593
- *
594
- * @since 1.122.0
595
- */
596
- export default class CardsPanel extends BasePanel {
597
- /**
598
- * Constructor for a new card panel.
599
- */
600
- constructor(
601
- /**
602
- * ID for the new control, generated automatically if an ID is not provided
603
- */
604
- id?: string,
605
- /**
606
- * Initial settings for the new control
607
- */
608
- settings?: /* was: sap.cux.home.CardsPanel.$CardsPanelSettings */ any
609
- );
610
-
611
- /**
612
- * Triggers a full refresh of the Insights Cards's data and UI.
613
- * Reloads all the user cards within the Insights Cards section by reinitializing relevant services
614
- * and re-rendering the panel.
615
- *
616
- *
617
- *
618
- * @returns A promise that resolves once the Insights Cards section has been refreshed.
619
- */
620
- refreshData(): Promise<void>;
621
- }
622
- /**
623
- * Describes the settings that can be provided to the CardsPanel constructor.
624
- */
625
- export interface $CardsPanelSettings extends $BasePanelSettings {}
626
- }
627
-
628
- declare module "sap/cux/home/ErrorPanel" {
629
- import {
630
- default as BasePanel,
631
- $BasePanelSettings,
632
- } from "sap/cux/home/BasePanel";
633
-
634
- /**
635
- * Panel class for displaying Error Message.
636
- *
637
- * @since 1.122.0
638
- */
639
- export default class ErrorPanel extends BasePanel {
640
- /**
641
- * Constructor for a new Error Panel.
642
- */
643
- constructor(
644
- /**
645
- * ID for the new panel, generated automatically if an ID is not provided
646
- */
647
- id?: string,
648
- /**
649
- * Initial settings for the new panel
650
- */
651
- settings?: /* was: sap.cux.home.ErrorPanel.$ErrorPanelSettings */ any
652
- );
653
- }
654
- /**
655
- * Describes the settings that can be provided to the ErrorPanel constructor.
656
- */
657
- export interface $ErrorPanelSettings extends $BasePanelSettings {}
658
- }
659
-
660
- declare module "sap/cux/home/FavAppPanel" {
661
- /**
662
- * Provides the FavAppPanel Class.
663
- *
664
- * @since 1.121.0
665
- */
666
- export default class FavAppPanel
667
- extends /* was: sap.cux.home.BaseAppPersPanel */ Object
668
- {
669
- /**
670
- * Constructor for a new favorite app panel.
671
- */
672
- constructor(
673
- /**
674
- * ID for the new control, generated automatically if an ID is not provided
675
- */
676
- id?: string,
677
- /**
678
- * Initial settings for the new control
679
- */
680
- settings?: /* was: sap.cux.home.BasePanel.$BasePanelSettings */ any
681
- );
682
- }
683
- }
684
-
685
- declare module "sap/cux/home/FrequentAppPanel" {
686
- /**
687
- * Provides the class for managing frequent apps.
688
- *
689
- * @since 1.121.0
690
- */
691
- export default class FrequentAppPanel
692
- extends /* was: sap.cux.home.BaseAppPersPanel */ Object
693
- {
694
- /**
695
- * Constructor for a new frequent app panel.
696
- */
697
- constructor(
698
- /**
699
- * ID for the new control, generated automatically if an ID is not provided
700
- */
701
- id?: string,
702
- /**
703
- * Initial settings for the new control
704
- */
705
- settings?: /* was: sap.cux.home.BasePanel.$BasePanelSettings */ any
706
- );
707
- }
708
- }
709
-
710
- declare module "sap/cux/home/Group" {
711
- import { default as BaseApp, $BaseAppSettings } from "sap/cux/home/BaseApp";
712
-
713
- /**
714
- * Class for managing apps group.
715
- *
716
- * @since 1.121.0
717
- */
718
- export default class Group extends BaseApp {
719
- /**
720
- * Constructor for a new Group.
721
- */
722
- constructor(
723
- /**
724
- * ID for the new group, generated automatically if an ID is not provided
725
- */
726
- id?: string,
727
- /**
728
- * Initial settings for the new group
729
- */
730
- settings?: /* was: sap.cux.home.Group.$GroupSettings */ any
731
- );
732
- }
733
- /**
734
- * Describes the settings that can be provided to the Group constructor.
735
- */
736
- export interface $GroupSettings extends $BaseAppSettings {}
737
- }
738
-
739
- declare module "sap/cux/home/InsightsContainer" {
740
- import {
741
- default as BaseContainer,
742
- $BaseContainerSettings,
743
- } from "sap/cux/home/BaseContainer";
744
-
745
- /**
746
- * Container class for managing and storing Insights Tiles and Insights Cards.
747
- *
748
- * @since 1.121
749
- */
750
- export default class InsightsContainer extends BaseContainer {
751
- /**
752
- * Constructor for a new Insights container.
753
- */
754
- constructor(
755
- /**
756
- * ID for the new control, generated automatically if an ID is not provided
757
- */
758
- id?: string,
759
- /**
760
- * Initial settings for the new control
761
- */
762
- settings?: /* was: sap.cux.home.BaseContainer.$BaseContainerSettings */ any
763
- );
764
- }
765
- /**
766
- * Describes the settings that can be provided to the InsightsContainer constructor.
767
- */
768
- export interface $InsightsContainerSettings extends $BaseContainerSettings {}
769
- }
770
-
771
- declare module "sap/cux/home/IToDoPanel" {
772
- import Context from "sap/ui/model/Context";
773
-
774
- import Control from "sap/ui/core/Control";
775
-
776
- /**
777
- * Common Interface for creating To-Do Panels displayed in the {@link sap.cux.home.ToDosContainer }.
778
- *
779
- * @since 1.121
780
- */
781
- export interface IToDoPanel {
782
- __implements__sap_cux_home_IToDoPanel: boolean;
783
-
784
- /**
785
- * Generate a default card template for the To Do Panel.
786
- * An extended panel can have it's own template by overridding
787
- * this method and providing a custom card template.
788
- *
789
- *
790
- * @returns The generated card template.
791
- */
792
- generateCardTemplate(
793
- /**
794
- * The ID for the template.
795
- */
796
- id: string,
797
- /**
798
- * The context required for the template.
799
- */
800
- context: Context
801
- ): Control;
802
- /**
803
- * Provides custom request URLs specific to the To-Do Panel.
804
- *
805
- *
806
- * @returns An array of request URLs.
807
- */
808
- generateRequestUrls(
809
- /**
810
- * - The number of cards which will be displayed in the To-Do Panel.
811
- */
812
- cardCount: number
813
- ): string[];
814
- /**
815
- * Retrieves the text for the "No Data" message for the To-Do Panel.
816
- *
817
- *
818
- * @returns The text for the "No Data" message.
819
- */
820
- getNoDataText(): string;
821
- /**
822
- * Handles the data received from a batch request.
823
- * This hook can be used to process the data before it is displayed.
824
- *
825
- *
826
- * @returns A promise that resolves when the data has been processed.
827
- */
828
- onDataReceived(
829
- /**
830
- * - The data received from the request.
831
- */
832
- data: any[],
833
- /**
834
- * - Optional request options.
835
- */
836
- options?: /* was: sap.cux.home.ToDoPanel.RequestOptions */ any
837
- ): Promise<void>;
838
- }
839
- }
840
-
841
- declare module "sap/cux/home/Layout" {
842
- import {
843
- default as BaseLayout,
844
- $BaseLayoutSettings,
845
- } from "sap/cux/home/BaseLayout";
846
-
847
- /**
848
- * Layout class for the My Home layout.
849
- *
850
- * @since 1.121
851
- */
852
- export default class Layout extends BaseLayout {
853
- /**
854
- * Constructor for a new layout.
855
- */
856
- constructor(
857
- /**
858
- * ID for the new control, generated automatically if an ID is not provided
859
- */
860
- id?: string,
861
- /**
862
- * Initial settings for the new control
863
- */
864
- settings?: /* was: sap.cux.home.BaseLayout.$BaseLayoutSettings */ any
865
- );
866
- }
867
- /**
868
- * Describes the settings that can be provided to the Layout constructor.
869
- */
870
- export interface $LayoutSettings extends $BaseLayoutSettings {}
871
- }
872
-
873
- declare module "sap/cux/home/library" {
874
- /**
875
- * Supported News Types for {@link sap.cux.home.NewsPanel }.
876
- *
877
- * @since 1.121
878
- */
879
- export enum NewsType {}
880
- }
881
-
882
- declare module "sap/cux/home/MenuItem" {
883
- import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
884
-
885
- import { URI } from "sap/ui/core/library";
886
-
887
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
888
-
889
- import Event from "sap/ui/base/Event";
890
-
891
- /**
892
- * Class for managing and storing menu items.
893
- *
894
- * @since 1.121
895
- */
896
- export default class MenuItem extends UI5Element {
897
- /**
898
- * Constructor for a new menu item.
899
- */
900
- constructor(
901
- /**
902
- * ID for the new control, generated automatically if an ID is not provided
903
- */
904
- id?: string,
905
- /**
906
- * Initial settings for the new control
907
- */
908
- settings?: /* was: sap.cux.home.MenuItem.$MenuItemSettings */ any
909
- );
910
-
911
- /**
912
- * Gets current value of property icon.
913
- *
914
- *
915
- * @returns Value of property `icon`
916
- */
917
- getIcon(): URI;
918
- /**
919
- * Gets current value of property title.
920
- *
921
- *
922
- * @returns Value of property `title`
923
- */
924
- getTitle(): string;
925
- /**
926
- * Gets current value of property type.
927
- *
928
- *
929
- * @returns Value of property `type`
930
- */
931
- getType(): string;
932
- /**
933
- * Gets current value of property visible.
934
- *
935
- *
936
- * @returns Value of property `visible`
937
- */
938
- getVisible(): boolean;
939
- /**
940
- * Gets current value of property icon.
941
- *
942
- *
943
- * @returns Value of property `icon`
944
- */
945
- setIcon(): URI;
946
- /**
947
- * Gets current value of property title.
948
- *
949
- *
950
- * @returns Value of property `title`
951
- */
952
- setTitle(): string;
953
- /**
954
- * Gets current value of property type.
955
- *
956
- *
957
- * @returns Value of property `type`
958
- */
959
- setType(): string;
960
- /**
961
- * Gets current value of property visible.
962
- *
963
- *
964
- * @returns Value of property `visible`
965
- */
966
- setVisible(): boolean;
967
- }
968
- /**
969
- * Describes the settings that can be provided to the MenuItem constructor.
970
- */
971
- export interface $MenuItemSettings extends $ElementSettings {
972
- /**
973
- * Icon of the menu item.
974
- */
975
- icon?: URI | PropertyBindingInfo | `{${string}}`;
976
-
977
- /**
978
- * Title of the menu item.
979
- */
980
- title?: string | PropertyBindingInfo;
981
-
982
- /**
983
- * Type of the menu item visualization in the menu list
984
- */
985
- type?: string | PropertyBindingInfo;
986
-
987
- /**
988
- * Visibility of the menu item in the menu list
989
- */
990
- visible?: boolean | PropertyBindingInfo | `{${string}}`;
991
- }
992
-
993
- /**
994
- * Parameters of the MenuItem#press event.
995
- */
996
- export interface MenuItem$PressEventParameters {}
997
-
998
- /**
999
- * Event object of the MenuItem#press event.
1000
- */
1001
- export type MenuItem$PressEvent = Event<
1002
- MenuItem$PressEventParameters,
1003
- MenuItem
1004
- >;
1005
- }
1006
-
1007
- declare module "sap/cux/home/NewsAndPagesContainer" {
1008
- import {
1009
- default as BaseContainer,
1010
- $BaseContainerSettings,
1011
- } from "sap/cux/home/BaseContainer";
1012
-
1013
- /**
1014
- * Container class for managing and storing News and Pages.
1015
- *
1016
- * @since 1.121
1017
- */
1018
- export default class NewsAndPagesContainer extends BaseContainer {
1019
- /**
1020
- * Constructor for the new News and Pages container.
1021
- */
1022
- constructor(
1023
- /**
1024
- * ID for the new control, generated automatically if an ID is not provided
1025
- */
1026
- id?: string,
1027
- /**
1028
- * Initial settings for the new control
1029
- */
1030
- settings?: /* was: sap.cux.home.NewsAndPagesContainer.$NewsAndPagesContainerSettings */ any
1031
- );
1032
- }
1033
- /**
1034
- * Describes the settings that can be provided to the NewsAndPagesContainer constructor.
1035
- */
1036
- export interface $NewsAndPagesContainerSettings
1037
- extends $BaseContainerSettings {}
1038
- }
1039
-
1040
- declare module "sap/cux/home/NewsPanel" {
1041
- import {
1042
- default as BaseNewsPanel,
1043
- $BaseNewsPanelSettings,
1044
- } from "sap/cux/home/BaseNewsPanel";
1045
-
1046
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1047
-
1048
- /**
1049
- * Panel class for managing and storing News.
1050
- *
1051
- * @since 1.121
1052
- */
1053
- export default class NewsPanel extends BaseNewsPanel {
1054
- /**
1055
- * Constructor for a new News Panel.
1056
- */
1057
- constructor(
1058
- /**
1059
- * ID for the new control, generated automatically if an ID is not provided
1060
- */
1061
- id?: string,
1062
- /**
1063
- * Initial settings for the new control
1064
- */
1065
- settings?: /* was: sap.cux.home.BaseNewsPanel.$BaseNewsPanelSettings */ any
1066
- );
1067
-
1068
- /**
1069
- * Gets current value of property url.
1070
- *
1071
- *
1072
- * @returns Value of property `url`
1073
- */
1074
- getUrl(): string;
1075
- /**
1076
- * Gets current value of property url.
1077
- *
1078
- *
1079
- * @returns Value of property `url`
1080
- */
1081
- setUrl(): string;
1082
- }
1083
- /**
1084
- * Describes the settings that can be provided to the NewsPanel constructor.
1085
- */
1086
- export interface $NewsPanelSettings extends $BaseNewsPanelSettings {
1087
- /**
1088
- * The URL of the news item.
1089
- */
1090
- url?: string | PropertyBindingInfo;
1091
- }
1092
- }
1093
-
1094
- declare module "sap/cux/home/NoDataContainer" {
1095
- import {
1096
- default as BaseContainer,
1097
- $BaseContainerSettings,
1098
- } from "sap/cux/home/BaseContainer";
1099
-
1100
- /**
1101
- * Container class to show no data content.
1102
- *
1103
- * @since 1.121
1104
- */
1105
- export default class NoDataContainer extends BaseContainer {
1106
- /**
1107
- * Constructor for a new NoData Container.
1108
- */
1109
- constructor(
1110
- /**
1111
- * ID for the new control, generated automatically if an ID is not provided
1112
- */
1113
- id?: string,
1114
- /**
1115
- * Initial settings for the new control
1116
- */
1117
- settings?: /* was: sap.cux.home.BaseContainer.$BaseContainerSettings */ any
1118
- );
1119
- }
1120
- /**
1121
- * Describes the settings that can be provided to the NoDataContainer constructor.
1122
- */
1123
- export interface $NoDataContainerSettings extends $BaseContainerSettings {}
1124
- }
1125
-
1126
- declare module "sap/cux/home/PagePanel" {
1127
- import {
1128
- default as BasePagePanel,
1129
- $BasePagePanelSettings,
1130
- } from "sap/cux/home/BasePagePanel";
1131
-
1132
- /**
1133
- * Panel class for managing and storing Pages.
1134
- *
1135
- * @since 1.122
1136
- */
1137
- export default class PagePanel extends BasePagePanel {
1138
- /**
1139
- * Constructor for a new Page panel.
1140
- */
1141
- constructor(
1142
- /**
1143
- * ID for the new control, generated automatically if an ID is not provided
1144
- */
1145
- id?: string,
1146
- /**
1147
- * Initial settings for the new control
1148
- */
1149
- settings?: /* was: sap.cux.home.BasePagePanel.$BasePagePanelSettings */ any
1150
- );
1151
- }
1152
- /**
1153
- * Describes the settings that can be provided to the PagePanel constructor.
1154
- */
1155
- export interface $PagePanelSettings extends $BasePagePanelSettings {}
1156
- }
1157
-
1158
- declare module "sap/cux/home/RecentAppPanel" {
1159
- /**
1160
- * Provides class for managing Recently Used apps.
1161
- *
1162
- * @since 1.121.0
1163
- */
1164
- export default class RecentAppPanel
1165
- extends /* was: sap.cux.home.BaseAppPersPanel */ Object
1166
- {
1167
- /**
1168
- * Constructor for a new Recently Used apps Panel.
1169
- */
1170
- constructor(
1171
- /**
1172
- * ID for the new control, generated automatically if an ID is not provided
1173
- */
1174
- id?: string,
1175
- /**
1176
- * Initial settings for the new control
1177
- */
1178
- settings?: /* was: sap.cux.home.BasePanel.$BasePanelSettings */ any
1179
- );
1180
- }
1181
- }
1182
-
1183
- declare module "sap/cux/home/RecommendedAppPanel" {
1184
- /**
1185
- * Provides the RecommendedAppPanel Class.
1186
- *
1187
- * @since 1.128.0
1188
- */
1189
- export default class RecommendedAppPanel
1190
- extends /* was: sap.cux.home.BaseAppPersPanel */ Object
1191
- {
1192
- /**
1193
- * Constructor for a new Recommended Apps Panel.
1194
- */
1195
- constructor(
1196
- /**
1197
- * ID for the new control, generated automatically if an ID is not provided
1198
- */
1199
- id?: string,
1200
- /**
1201
- * Initial settings for the new control
1202
- */
1203
- settings?: /* was: sap.cux.home.BasePanel.$BasePanelSettings */ any
1204
- );
1205
- }
1206
- }
1207
-
1208
- declare module "sap/cux/home/SituationPanel" {
1209
- import {
1210
- default as ToDoPanel,
1211
- $ToDoPanelSettings,
1212
- } from "sap/cux/home/ToDoPanel";
1213
-
1214
- /**
1215
- * Panel class for managing and storing Situation cards.
1216
- *
1217
- * @since 1.121
1218
- */
1219
- export default class SituationPanel extends ToDoPanel {
1220
- /**
1221
- * Constructor for a new Situation Panel.
1222
- */
1223
- constructor(
1224
- /**
1225
- * ID for the new control, generated automatically if an ID is not provided
1226
- */
1227
- id?: string,
1228
- /**
1229
- * Initial settings for the new control
1230
- */
1231
- settings?: /* was: sap.cux.home.ToDoPanel.$ToDoPanelSettings */ any
1232
- );
1233
- }
1234
- /**
1235
- * Describes the settings that can be provided to the SituationPanel constructor.
1236
- */
1237
- export interface $SituationPanelSettings extends $ToDoPanelSettings {}
1238
- }
1239
-
1240
- declare module "sap/cux/home/SpaceInsightsPanel" {
1241
- import {
1242
- default as BasePanel,
1243
- $BasePanelSettings,
1244
- } from "sap/cux/home/BasePanel";
1245
-
1246
- /**
1247
- * Tiles Panel class for managing and storing Space Insights Tiles.
1248
- */
1249
- export default class SpaceInsightsPanel extends BasePanel {
1250
- /**
1251
- * Constructor for a new Tiles Panel.
1252
- */
1253
- constructor(
1254
- /**
1255
- * ID for the new control, generated automatically if an ID is not provided
1256
- */
1257
- id?: string,
1258
- /**
1259
- * Initial settings for the new control
1260
- */
1261
- settings?: /* was: sap.cux.home.SpaceInsightsPanel.$SpaceInsightsPanelSettings */ any
1262
- );
1263
- }
1264
- /**
1265
- * Describes the settings that can be provided to the SpaceInsightsPanel constructor.
1266
- */
1267
- export interface $SpaceInsightsPanelSettings extends $BasePanelSettings {}
1268
- }
1269
-
1270
- declare module "sap/cux/home/SpacePanel" {
1271
- /**
1272
- * Provides the SpacePanel Class.
1273
- */
1274
- export default class SpacePanel
1275
- extends /* was: sap.cux.home.BaseAppPersPanel */ Object
1276
- {
1277
- /**
1278
- * Constructor for a new favorite app panel.
1279
- */
1280
- constructor(
1281
- /**
1282
- * ID for the new control, generated automatically if an ID is not provided
1283
- */
1284
- id?: string,
1285
- /**
1286
- * Initial settings for the new control
1287
- */
1288
- settings?: /* was: sap.cux.home.SpacePanel.$SpacePanelSettings */ any
1289
- );
1290
- }
1291
- }
1292
-
1293
- declare module "sap/cux/home/TaskPanel" {
1294
- import {
1295
- default as ToDoPanel,
1296
- $ToDoPanelSettings,
1297
- } from "sap/cux/home/ToDoPanel";
1298
-
1299
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1300
-
1301
- /**
1302
- * Panel class for managing and storing Task cards.
1303
- *
1304
- * @since 1.121
1305
- */
1306
- export default class TaskPanel extends ToDoPanel {
1307
- /**
1308
- * Constructor for a new Task Panel.
1309
- */
1310
- constructor(
1311
- /**
1312
- * ID for the new control, generated automatically if an ID is not provided
1313
- */
1314
- id?: string,
1315
- /**
1316
- * Initial settings for the new control
1317
- */
1318
- settings?: /* was: sap.cux.home.TaskPanel.$TaskPanelSettings */ any
1319
- );
1320
-
1321
- /**
1322
- * Gets current value of property customAttributeUrl.
1323
- *
1324
- *
1325
- * @returns Value of property `customAttributeUrl`
1326
- */
1327
- getCustomAttributeUrl(): string;
1328
- /**
1329
- * Gets current value of property enableActions.
1330
- *
1331
- *
1332
- * @returns Value of property `enableActions`
1333
- */
1334
- getEnableActions(): boolean;
1335
- /**
1336
- * Gets current value of property customAttributeUrl.
1337
- *
1338
- *
1339
- * @returns Value of property `customAttributeUrl`
1340
- */
1341
- setCustomAttributeUrl(): string;
1342
- /**
1343
- * Gets current value of property enableActions.
1344
- *
1345
- *
1346
- * @returns Value of property `enableActions`
1347
- */
1348
- setEnableActions(): boolean;
1349
- }
1350
- /**
1351
- * Describes the settings that can be provided to the TaskPanel constructor.
1352
- */
1353
- export interface $TaskPanelSettings extends $ToDoPanelSettings {
1354
- /**
1355
- * Specifies the URL that fetches the custom attributes to be displayed along with the task cards.
1356
- */
1357
- customAttributeUrl?: string | PropertyBindingInfo;
1358
-
1359
- /**
1360
- * Specifies if actions should be enabled for the task cards.
1361
- */
1362
- enableActions?: boolean | PropertyBindingInfo | `{${string}}`;
1363
- }
1364
- }
1365
-
1366
- declare module "sap/cux/home/TilesPanel" {
1367
- import {
1368
- default as BasePanel,
1369
- $BasePanelSettings,
1370
- } from "sap/cux/home/BasePanel";
1371
-
1372
- /**
1373
- * Tiles Panel class for managing and storing Insights Tiles.
1374
- *
1375
- * @since 1.122.0
1376
- */
1377
- export default class TilesPanel extends BasePanel {
1378
- /**
1379
- * Constructor for a new Tiles Panel.
1380
- */
1381
- constructor(
1382
- /**
1383
- * ID for the new control, generated automatically if an ID is not provided
1384
- */
1385
- id?: string,
1386
- /**
1387
- * Initial settings for the new control
1388
- */
1389
- settings?: /* was: sap.cux.home.TilesPanel.$TilesPanelSettings */ any
1390
- );
1391
- }
1392
- /**
1393
- * Describes the settings that can be provided to the TilesPanel constructor.
1394
- */
1395
- export interface $TilesPanelSettings extends $BasePanelSettings {}
1396
- }
1397
-
1398
- declare module "sap/cux/home/ToDoPanel" {
1399
- import {
1400
- default as BasePanel,
1401
- $BasePanelSettings,
1402
- } from "sap/cux/home/BasePanel";
1403
-
1404
- import { IToDoPanel } from "sap/cux/home/IToDoPanel";
1405
-
1406
- import Context from "sap/ui/model/Context";
1407
-
1408
- import Control from "sap/ui/core/Control";
1409
-
1410
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1411
-
1412
- /**
1413
- * Abstract Panel class for managing and storing To-Do cards.
1414
- *
1415
- * @since 1.121
1416
- */
1417
- export default abstract class ToDoPanel
1418
- extends BasePanel
1419
- implements IToDoPanel
1420
- {
1421
- __implements__sap_cux_home_IToDoPanel: boolean;
1422
- /**
1423
- * Constructor for a new To-Dos Panel.
1424
- */
1425
- constructor(
1426
- /**
1427
- * ID for the new control, generated automatically if an ID is not provided
1428
- */
1429
- id?: string,
1430
- /**
1431
- * Initial settings for the new control
1432
- */
1433
- settings?: /* was: sap.cux.home.ToDoPanel.$ToDoPanelSettings */ any
1434
- );
1435
-
1436
- /**
1437
- * Generates the card template for the Current Panel.
1438
- *
1439
- *
1440
- * @returns The generated card template.
1441
- */
1442
- generateCardTemplate(
1443
- /**
1444
- * The ID for the template.
1445
- */
1446
- id: string,
1447
- /**
1448
- * The context for the template.
1449
- */
1450
- context: Context
1451
- ): Control;
1452
- /**
1453
- * Generates request URLs for fetching data based on the specified card count.
1454
- *
1455
- *
1456
- * @returns An array of request URLs.
1457
- */
1458
- generateRequestUrls(
1459
- /**
1460
- * - The number of cards to retrieve.
1461
- */
1462
- cardCount: number
1463
- ): string[];
1464
- /**
1465
- * Gets current value of property baseUrl.
1466
- *
1467
- *
1468
- * @returns Value of property `baseUrl`
1469
- */
1470
- getBaseUrl(): string;
1471
- /**
1472
- * Gets current value of property countUrl.
1473
- *
1474
- *
1475
- * @returns Value of property `countUrl`
1476
- */
1477
- getCountUrl(): string;
1478
- /**
1479
- * Gets current value of property dataUrl.
1480
- *
1481
- *
1482
- * @returns Value of property `dataUrl`
1483
- */
1484
- getDataUrl(): string;
1485
- /**
1486
- * Get the text for the "No Data" message.
1487
- *
1488
- *
1489
- * @returns The text for the "No Data" message.
1490
- */
1491
- getNoDataText(): string;
1492
- /**
1493
- * Gets current value of property targetAppUrl.
1494
- *
1495
- *
1496
- * @returns Value of property `targetAppUrl`
1497
- */
1498
- getTargetAppUrl(): string;
1499
- /**
1500
- * A promise that resolves when the data has been processed.
1501
- * This method can be overridden to perform additional data processing operations.
1502
- */
1503
- onDataReceived(
1504
- /**
1505
- * - Data retrieved from the batch call.
1506
- */
1507
- results?: any[],
1508
- /**
1509
- * - Additional options for parsing the data.
1510
- * Structure may vary based on the backend service.
1511
- */
1512
- options?: /* was: sap.cux.home.ToDoPanel.RequestOptions */ any
1513
- ): Promise<void>;
1514
- /**
1515
- * Gets current value of property baseUrl.
1516
- *
1517
- *
1518
- * @returns Value of property `baseUrl`
1519
- */
1520
- setBaseUrl(): string;
1521
- /**
1522
- * Gets current value of property countUrl.
1523
- *
1524
- *
1525
- * @returns Value of property `countUrl`
1526
- */
1527
- setCountUrl(): string;
1528
- /**
1529
- * Gets current value of property dataUrl.
1530
- *
1531
- *
1532
- * @returns Value of property `dataUrl`
1533
- */
1534
- setDataUrl(): string;
1535
- /**
1536
- * Gets current value of property targetAppUrl.
1537
- *
1538
- *
1539
- * @returns Value of property `targetAppUrl`
1540
- */
1541
- setTargetAppUrl(): string;
1542
- }
1543
- /**
1544
- * Describes the settings that can be provided to the ToDoPanel constructor.
1545
- */
1546
- export interface $ToDoPanelSettings extends $BasePanelSettings {
1547
- /**
1548
- * Specifies the base URL for batching requests sent from the panel.
1549
- */
1550
- baseUrl?: string | PropertyBindingInfo;
1551
-
1552
- /**
1553
- * Specifies the URL for fetching the count of requested to-do cards.
1554
- */
1555
- countUrl?: string | PropertyBindingInfo;
1556
-
1557
- /**
1558
- * Specifies the URL from where the to-do cards should be fetched.
1559
- */
1560
- dataUrl?: string | PropertyBindingInfo;
1561
-
1562
- /**
1563
- * Specifies the URL of the target application associated with the to-do cards.
1564
- */
1565
- targetAppUrl?: string | PropertyBindingInfo;
1566
- }
1567
- }
1568
-
1569
- declare module "sap/cux/home/ToDosContainer" {
1570
- import {
1571
- default as BaseContainer,
1572
- $BaseContainerSettings,
1573
- } from "sap/cux/home/BaseContainer";
1574
-
1575
- /**
1576
- * Container class for managing and storing To-Do cards.
1577
- *
1578
- * @since 1.121
1579
- */
1580
- export default class ToDosContainer extends BaseContainer {
1581
- /**
1582
- * Constructor for a new To-Dos container.
1583
- */
1584
- constructor(
1585
- /**
1586
- * Initial settings for the new control
1587
- */
1588
- settings?: $ToDosContainerSettings
1589
- );
1590
- /**
1591
- * Constructor for a new To-Dos container.
1592
- */
1593
- constructor(
1594
- /**
1595
- * ID for the new control, generated automatically if an ID is not provided
1596
- */
1597
- id?: string,
1598
- /**
1599
- * Initial settings for the new control
1600
- */
1601
- settings?: $ToDosContainerSettings
1602
- );
1603
-
1604
- /**
1605
- * Gets the selected key of the To-Dos container.
1606
- * If no selected key is set, it defaults to the first item.
1607
- *
1608
- *
1609
- * @returns The selected key.
1610
- */
1611
- getSelectedKey(): string;
1612
- /**
1613
- * Asynchronously refreshes the section by forcing all inner panels to be reloaded.
1614
- *
1615
- *
1616
- * @returns A promise that resolves when the section is successfully refreshed.
1617
- */
1618
- refreshData(): Promise<void>;
1619
- }
1620
- /**
1621
- * Describes the settings that can be provided to the ToDosContainer constructor.
1622
- */
1623
- export interface $ToDosContainerSettings extends $BaseContainerSettings {}
1624
- }
1625
-
1626
3
  declare namespace sap {
1627
4
  interface IUI5DefineDependencyNames {
1628
5
  "sap/cux/home/App": undefined;