@sapui5/types 1.113.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/LICENSE.txt +35 -0
  2. package/README.md +35 -0
  3. package/package.json +23 -0
  4. package/types/index.d.ts +67 -0
  5. package/types/sap.apf.d.ts +1026 -0
  6. package/types/sap.ca.ui.d.ts +14005 -0
  7. package/types/sap.chart.d.ts +4815 -0
  8. package/types/sap.collaboration.d.ts +2704 -0
  9. package/types/sap.esh.search.ui.d.ts +1595 -0
  10. package/types/sap.f.d.ts +20085 -0
  11. package/types/sap.fe.core.d.ts +1508 -0
  12. package/types/sap.fe.macros.d.ts +975 -0
  13. package/types/sap.fe.navigation.d.ts +917 -0
  14. package/types/sap.fe.templates.d.ts +522 -0
  15. package/types/sap.fe.test.d.ts +3533 -0
  16. package/types/sap.feedback.ui.d.ts +3 -0
  17. package/types/sap.gantt.d.ts +51684 -0
  18. package/types/sap.insights.d.ts +23 -0
  19. package/types/sap.landvisz.d.ts +7952 -0
  20. package/types/sap.m.d.ts +147796 -0
  21. package/types/sap.makit.d.ts +4533 -0
  22. package/types/sap.me.d.ts +3665 -0
  23. package/types/sap.ndc.d.ts +774 -0
  24. package/types/sap.ovp.d.ts +176 -0
  25. package/types/sap.rules.ui.d.ts +1471 -0
  26. package/types/sap.sac.df.d.ts +2292 -0
  27. package/types/sap.sac.grid.d.ts +774 -0
  28. package/types/sap.suite.ui.commons.d.ts +46971 -0
  29. package/types/sap.suite.ui.generic.template.d.ts +3431 -0
  30. package/types/sap.suite.ui.microchart.d.ts +12652 -0
  31. package/types/sap.tnt.d.ts +2227 -0
  32. package/types/sap.ui.codeeditor.d.ts +693 -0
  33. package/types/sap.ui.commons.d.ts +30235 -0
  34. package/types/sap.ui.comp.d.ts +37411 -0
  35. package/types/sap.ui.core.d.ts +78872 -0
  36. package/types/sap.ui.dt.d.ts +3 -0
  37. package/types/sap.ui.export.d.ts +843 -0
  38. package/types/sap.ui.fl.d.ts +1663 -0
  39. package/types/sap.ui.generic.app.d.ts +2683 -0
  40. package/types/sap.ui.generic.template.d.ts +3 -0
  41. package/types/sap.ui.integration.d.ts +4032 -0
  42. package/types/sap.ui.layout.d.ts +14472 -0
  43. package/types/sap.ui.mdc.d.ts +476 -0
  44. package/types/sap.ui.richtexteditor.d.ts +1666 -0
  45. package/types/sap.ui.rta.d.ts +124 -0
  46. package/types/sap.ui.suite.d.ts +685 -0
  47. package/types/sap.ui.support.d.ts +453 -0
  48. package/types/sap.ui.table.d.ts +9325 -0
  49. package/types/sap.ui.testrecorder.d.ts +9 -0
  50. package/types/sap.ui.unified.d.ts +20640 -0
  51. package/types/sap.ui.ux3.d.ts +18288 -0
  52. package/types/sap.ui.vbm.d.ts +17251 -0
  53. package/types/sap.ui.vk.d.ts +42381 -0
  54. package/types/sap.ui.vtm.d.ts +10547 -0
  55. package/types/sap.ui.webc.common.d.ts +113 -0
  56. package/types/sap.ui.webc.fiori.d.ts +13850 -0
  57. package/types/sap.ui.webc.main.d.ts +40833 -0
  58. package/types/sap.uiext.inbox.d.ts +4079 -0
  59. package/types/sap.ushell.d.ts +10255 -0
  60. package/types/sap.ushell_abap.d.ts +9 -0
  61. package/types/sap.uxap.d.ts +7636 -0
  62. package/types/sap.viz.d.ts +51209 -0
  63. package/types/sap.webanalytics.core.d.ts +3 -0
  64. package/types/sap.zen.commons.d.ts +1542 -0
  65. package/types/sap.zen.crosstab.d.ts +1159 -0
  66. package/types/sap.zen.dsh.d.ts +2132 -0
@@ -0,0 +1,4032 @@
1
+ // For Library Version: 1.113.0
2
+
3
+ declare module "sap/ui/integration/library" {
4
+ import { URI } from "sap/ui/core/library";
5
+
6
+ import { ButtonType } from "sap/m/library";
7
+
8
+ /**
9
+ * @SINCE 1.96
10
+ *
11
+ * Defines the layout type of the List card attributes.
12
+ */
13
+ export enum AttributesLayoutType {
14
+ /**
15
+ * One column.
16
+ */
17
+ OneColumn = "OneColumn",
18
+ /**
19
+ * Two columns.
20
+ */
21
+ TwoColumns = "TwoColumns",
22
+ }
23
+ /**
24
+ * @EXPERIMENTAL (since 1.64) - Disclaimer: this property is in a beta state - incompatible API changes
25
+ * may be done before its official public release. Use at your own discretion.
26
+ *
27
+ * Enumeration of possible card action types.
28
+ */
29
+ export enum CardActionType {
30
+ /**
31
+ * @EXPERIMENTAL (since 1.76)
32
+ *
33
+ * Used for custom actions.
34
+ */
35
+ Custom = "Custom",
36
+ /**
37
+ * @EXPERIMENTAL (since 1.87)
38
+ *
39
+ * Date selection. Available only for Calendar cards.
40
+ */
41
+ DateChange = "DateChange",
42
+ /**
43
+ * @EXPERIMENTAL (since 1.100)
44
+ *
45
+ * Used for hiding the appeared details about the card.
46
+ */
47
+ HideCard = "HideCard",
48
+ /**
49
+ * @EXPERIMENTAL (since 1.87)
50
+ *
51
+ * Month selection. Available only for Calendar cards.
52
+ */
53
+ MonthChange = "MonthChange",
54
+ /**
55
+ * Used for navigation actions.
56
+ */
57
+ Navigation = "Navigation",
58
+ /**
59
+ * @EXPERIMENTAL (since 1.100)
60
+ *
61
+ * Used for showing more details about the card.
62
+ */
63
+ ShowCard = "ShowCard",
64
+ /**
65
+ * Used for submit actions.
66
+ */
67
+ Submit = "Submit",
68
+ }
69
+ /**
70
+ * @SINCE 1.86
71
+ *
72
+ * Defines the areas in a card.
73
+ */
74
+ export enum CardArea {
75
+ /**
76
+ * The content area.
77
+ */
78
+ Content = "Content",
79
+ /**
80
+ * The filters area.
81
+ */
82
+ Filters = "Filters",
83
+ /**
84
+ * The header.
85
+ */
86
+ Header = "Header",
87
+ }
88
+ /**
89
+ * @SINCE 1.65
90
+ * @EXPERIMENTAL (since 1.65)
91
+ *
92
+ * Possible data modes for `{@link sap.ui.integration.widgets.Card}`.
93
+ */
94
+ export enum CardDataMode {
95
+ /**
96
+ * When in this mode, the card can make requests.
97
+ */
98
+ Active = "Active",
99
+ /**
100
+ * When in this mode, the card starts processing the manifest when the card is in the viewport.
101
+ */
102
+ Auto = "Auto",
103
+ /**
104
+ * When in this mode, the card cannot make requests.
105
+ */
106
+ Inactive = "Inactive",
107
+ }
108
+ /**
109
+ * @SINCE 1.109
110
+ * @EXPERIMENTAL (since 1.109)
111
+ *
112
+ * Possible designs for `{@link sap.ui.integration.widgets.Card}`.
113
+ */
114
+ export enum CardDesign {
115
+ /**
116
+ * When in this mode, the card has a solid background.
117
+ */
118
+ Solid = "Solid",
119
+ /**
120
+ * When in this mode, the card background is transparent.
121
+ */
122
+ Transparent = "Transparent",
123
+ }
124
+ /**
125
+ * @EXPERIMENTAL (since 1.79)
126
+ *
127
+ * An object type that represents card menu action properties.
128
+ */
129
+ export type CardMenuAction = {
130
+ /**
131
+ * The type of the action.
132
+ */
133
+ type: CardActionType | keyof typeof CardActionType;
134
+ /**
135
+ * The text of the action button.
136
+ */
137
+ text: string;
138
+ /**
139
+ * The icon of the action button.
140
+ */
141
+ icon: URI;
142
+ /**
143
+ * The tooltip of the action button.
144
+ */
145
+ tooltip: string;
146
+ /**
147
+ * The type of the action button.
148
+ */
149
+ buttonType: ButtonType | keyof typeof ButtonType;
150
+ /**
151
+ * If the action is enabled. Default value is `true`.
152
+ */
153
+ enabled: boolean | Function;
154
+ /**
155
+ * If the action is visible. Default value is `true`.
156
+ */
157
+ visible: boolean | Function;
158
+ /**
159
+ * The action function.
160
+ */
161
+ action: Function;
162
+ /**
163
+ * The parameters of the action.
164
+ */
165
+ parameters: object;
166
+ };
167
+
168
+ /**
169
+ * @SINCE 1.112
170
+ * @EXPERIMENTAL (since 1.112)
171
+ *
172
+ * Preview modes for `{@link sap.ui.integration.widgets.Card}`. Helpful in scenarios when the end user is
173
+ * choosing or configuring a card.
174
+ */
175
+ export enum CardPreviewMode {
176
+ /**
177
+ * Card displays abstract preview. No data requests are made.
178
+ */
179
+ Abstract = "Abstract",
180
+ /**
181
+ * Card displays mocked data, loaded using a data request as configured in the manifest.
182
+ */
183
+ MockData = "MockData",
184
+ /**
185
+ * Card displays real data.
186
+ */
187
+ Off = "Off",
188
+ }
189
+ }
190
+
191
+ declare module "sap/ui/integration/ActionDefinition" {
192
+ import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
193
+
194
+ import Event from "sap/ui/base/Event";
195
+
196
+ import { ButtonType } from "sap/m/library";
197
+
198
+ import { URI } from "sap/ui/core/library";
199
+
200
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
201
+
202
+ import { CardActionType } from "sap/ui/integration/library";
203
+
204
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
205
+
206
+ /**
207
+ * @SINCE 1.85
208
+ * @EXPERIMENTAL (since 1.85) - Disclaimer: this class is in a beta state - incompatible API changes may
209
+ * be done before its official public release. Use at your own discretion.
210
+ *
211
+ * Represents an action, which appears in the header of {@link sap.ui.integration.widgets.Card}. Useful
212
+ * in `Component` card and `Extension`.
213
+ */
214
+ export default class ActionDefinition extends UI5Element {
215
+ /**
216
+ * Constructor for a new `ActionDefinition`.
217
+ *
218
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
219
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
220
+ * of the syntax of the settings object.
221
+ */
222
+ constructor(
223
+ /**
224
+ * Initial settings for the new ActionDefinition.
225
+ */
226
+ mSettings?: $ActionDefinitionSettings
227
+ );
228
+ /**
229
+ * Constructor for a new `ActionDefinition`.
230
+ *
231
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
232
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
233
+ * of the syntax of the settings object.
234
+ */
235
+ constructor(
236
+ /**
237
+ * ID for the new ActionDefinition, generated automatically if no ID is given.
238
+ */
239
+ sId?: string,
240
+ /**
241
+ * Initial settings for the new ActionDefinition.
242
+ */
243
+ mSettings?: $ActionDefinitionSettings
244
+ );
245
+
246
+ /**
247
+ * Creates a new subclass of class sap.ui.integration.ActionDefinition with name `sClassName` and enriches
248
+ * it with the information contained in `oClassInfo`.
249
+ *
250
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
251
+ *
252
+ * @returns Created class / constructor function
253
+ */
254
+ static extend<T extends Record<string, unknown>>(
255
+ /**
256
+ * Name of the class being created
257
+ */
258
+ sClassName: string,
259
+ /**
260
+ * Object literal with information about the class
261
+ */
262
+ oClassInfo?: sap.ClassInfo<T, ActionDefinition>,
263
+ /**
264
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
265
+ * used by this class
266
+ */
267
+ FNMetaImpl?: Function
268
+ ): Function;
269
+ /**
270
+ * Returns a metadata object for class sap.ui.integration.ActionDefinition.
271
+ *
272
+ * @returns Metadata object describing this class
273
+ */
274
+ static getMetadata(): ElementMetadata;
275
+ /**
276
+ * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.ui.integration.ActionDefinition`.
277
+ *
278
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
279
+ * otherwise it will be bound to this `sap.ui.integration.ActionDefinition` itself.
280
+ *
281
+ * Fired when the action button is pressed.
282
+ *
283
+ * @returns Reference to `this` in order to allow method chaining
284
+ */
285
+ attachPress(
286
+ /**
287
+ * An application-specific payload object that will be passed to the event handler along with the event
288
+ * object when firing the event
289
+ */
290
+ oData: object,
291
+ /**
292
+ * The function to be called when the event occurs
293
+ */
294
+ fnFunction: (p1: Event) => void,
295
+ /**
296
+ * Context object to call the event handler with. Defaults to this `sap.ui.integration.ActionDefinition`
297
+ * itself
298
+ */
299
+ oListener?: object
300
+ ): this;
301
+ /**
302
+ * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.ui.integration.ActionDefinition`.
303
+ *
304
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
305
+ * otherwise it will be bound to this `sap.ui.integration.ActionDefinition` itself.
306
+ *
307
+ * Fired when the action button is pressed.
308
+ *
309
+ * @returns Reference to `this` in order to allow method chaining
310
+ */
311
+ attachPress(
312
+ /**
313
+ * The function to be called when the event occurs
314
+ */
315
+ fnFunction: (p1: Event) => void,
316
+ /**
317
+ * Context object to call the event handler with. Defaults to this `sap.ui.integration.ActionDefinition`
318
+ * itself
319
+ */
320
+ oListener?: object
321
+ ): this;
322
+ /**
323
+ * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.ui.integration.ActionDefinition`.
324
+ *
325
+ * The passed function and listener object must match the ones used for event registration.
326
+ *
327
+ * @returns Reference to `this` in order to allow method chaining
328
+ */
329
+ detachPress(
330
+ /**
331
+ * The function to be called, when the event occurs
332
+ */
333
+ fnFunction: (p1: Event) => void,
334
+ /**
335
+ * Context object on which the given function had to be called
336
+ */
337
+ oListener?: object
338
+ ): this;
339
+ /**
340
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
341
+ *
342
+ * Fires event {@link #event:press press} to attached listeners.
343
+ *
344
+ * @returns Reference to `this` in order to allow method chaining
345
+ */
346
+ firePress(
347
+ /**
348
+ * Parameters to pass along with the event
349
+ */
350
+ mParameters?: object
351
+ ): this;
352
+ /**
353
+ * Gets current value of property {@link #getButtonType buttonType}.
354
+ *
355
+ * The type of the action button.
356
+ *
357
+ * Default value is `Transparent`.
358
+ *
359
+ * @returns Value of property `buttonType`
360
+ */
361
+ getButtonType(): ButtonType | keyof typeof ButtonType;
362
+ /**
363
+ * Gets current value of property {@link #getEnabled enabled}.
364
+ *
365
+ * Indicates whether the user can interact with the action button or not. **Note**: Disabled controls cannot
366
+ * be focused and they are out of the navigation tab-chain.
367
+ *
368
+ * Default value is `true`.
369
+ *
370
+ * @returns Value of property `enabled`
371
+ */
372
+ getEnabled(): boolean;
373
+ /**
374
+ * Gets current value of property {@link #getIcon icon}.
375
+ *
376
+ * The icon of the action button.
377
+ *
378
+ * @returns Value of property `icon`
379
+ */
380
+ getIcon(): URI;
381
+ /**
382
+ * Gets current value of property {@link #getParameters parameters}.
383
+ *
384
+ * The parameters of the action.
385
+ *
386
+ * @returns Value of property `parameters`
387
+ */
388
+ getParameters(): object;
389
+ /**
390
+ * Gets current value of property {@link #getText text}.
391
+ *
392
+ * The text of the action button.
393
+ *
394
+ * Default value is `empty string`.
395
+ *
396
+ * @returns Value of property `text`
397
+ */
398
+ getText(): string;
399
+ /**
400
+ * Gets current value of property {@link #getType type}.
401
+ *
402
+ * The type of the action.
403
+ *
404
+ * @returns Value of property `type`
405
+ */
406
+ getType(): CardActionType | keyof typeof CardActionType;
407
+ /**
408
+ * Gets current value of property {@link #getVisible visible}.
409
+ *
410
+ * Whether the action button should be visible on the screen.
411
+ *
412
+ * Default value is `true`.
413
+ *
414
+ * @returns Value of property `visible`
415
+ */
416
+ getVisible(): boolean;
417
+ /**
418
+ * Sets a new value for property {@link #getButtonType buttonType}.
419
+ *
420
+ * The type of the action button.
421
+ *
422
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
423
+ *
424
+ * Default value is `Transparent`.
425
+ *
426
+ * @returns Reference to `this` in order to allow method chaining
427
+ */
428
+ setButtonType(
429
+ /**
430
+ * New value for property `buttonType`
431
+ */
432
+ sButtonType?: ButtonType | keyof typeof ButtonType
433
+ ): this;
434
+ /**
435
+ * Sets a new value for property {@link #getEnabled enabled}.
436
+ *
437
+ * Indicates whether the user can interact with the action button or not. **Note**: Disabled controls cannot
438
+ * be focused and they are out of the navigation tab-chain.
439
+ *
440
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
441
+ *
442
+ * Default value is `true`.
443
+ *
444
+ * @returns Reference to `this` in order to allow method chaining
445
+ */
446
+ setEnabled(
447
+ /**
448
+ * New value for property `enabled`
449
+ */
450
+ bEnabled?: boolean
451
+ ): this;
452
+ /**
453
+ * Sets a new value for property {@link #getIcon icon}.
454
+ *
455
+ * The icon of the action button.
456
+ *
457
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
458
+ *
459
+ * @returns Reference to `this` in order to allow method chaining
460
+ */
461
+ setIcon(
462
+ /**
463
+ * New value for property `icon`
464
+ */
465
+ sIcon: URI
466
+ ): this;
467
+ /**
468
+ * Sets a new value for property {@link #getParameters parameters}.
469
+ *
470
+ * The parameters of the action.
471
+ *
472
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
473
+ *
474
+ * @returns Reference to `this` in order to allow method chaining
475
+ */
476
+ setParameters(
477
+ /**
478
+ * New value for property `parameters`
479
+ */
480
+ oParameters: object
481
+ ): this;
482
+ /**
483
+ * Sets a new value for property {@link #getText text}.
484
+ *
485
+ * The text of the action button.
486
+ *
487
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
488
+ *
489
+ * Default value is `empty string`.
490
+ *
491
+ * @returns Reference to `this` in order to allow method chaining
492
+ */
493
+ setText(
494
+ /**
495
+ * New value for property `text`
496
+ */
497
+ sText?: string
498
+ ): this;
499
+ /**
500
+ * Sets a new value for property {@link #getType type}.
501
+ *
502
+ * The type of the action.
503
+ *
504
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
505
+ *
506
+ * @returns Reference to `this` in order to allow method chaining
507
+ */
508
+ setType(
509
+ /**
510
+ * New value for property `type`
511
+ */
512
+ sType: CardActionType | keyof typeof CardActionType
513
+ ): this;
514
+ /**
515
+ * Sets a new value for property {@link #getVisible visible}.
516
+ *
517
+ * Whether the action button should be visible on the screen.
518
+ *
519
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
520
+ *
521
+ * Default value is `true`.
522
+ *
523
+ * @returns Reference to `this` in order to allow method chaining
524
+ */
525
+ setVisible(
526
+ /**
527
+ * New value for property `visible`
528
+ */
529
+ bVisible?: boolean
530
+ ): this;
531
+ }
532
+
533
+ export interface $ActionDefinitionSettings extends $ElementSettings {
534
+ /**
535
+ * The type of the action.
536
+ */
537
+ type?:
538
+ | (CardActionType | keyof typeof CardActionType)
539
+ | PropertyBindingInfo
540
+ | `{${string}}`;
541
+
542
+ /**
543
+ * The text of the action button.
544
+ */
545
+ text?: string | PropertyBindingInfo;
546
+
547
+ /**
548
+ * The icon of the action button.
549
+ */
550
+ icon?: URI | PropertyBindingInfo | `{${string}}`;
551
+
552
+ /**
553
+ * The type of the action button.
554
+ */
555
+ buttonType?:
556
+ | (ButtonType | keyof typeof ButtonType)
557
+ | PropertyBindingInfo
558
+ | `{${string}}`;
559
+
560
+ /**
561
+ * Indicates whether the user can interact with the action button or not. **Note**: Disabled controls cannot
562
+ * be focused and they are out of the navigation tab-chain.
563
+ */
564
+ enabled?: boolean | PropertyBindingInfo | `{${string}}`;
565
+
566
+ /**
567
+ * Whether the action button should be visible on the screen.
568
+ */
569
+ visible?: boolean | PropertyBindingInfo | `{${string}}`;
570
+
571
+ /**
572
+ * The parameters of the action.
573
+ */
574
+ parameters?: object | PropertyBindingInfo | `{${string}}`;
575
+
576
+ /**
577
+ * Fired when the action button is pressed.
578
+ */
579
+ press?: (oEvent: Event) => void;
580
+ }
581
+ }
582
+
583
+ declare module "sap/ui/integration/Designtime" {
584
+ import {
585
+ default as ManagedObject,
586
+ $ManagedObjectSettings,
587
+ } from "sap/ui/base/ManagedObject";
588
+
589
+ import { CardFacade } from "sap/ui/integration/widgets/Card";
590
+
591
+ import ManagedObjectMetadata from "sap/ui/base/ManagedObjectMetadata";
592
+
593
+ /**
594
+ * @SINCE 1.75
595
+ * @EXPERIMENTAL (since 1.75)
596
+ *
597
+ * Brings JavaScript capabilities for an {@link sap.ui.integration.widgets.Card} where custom logic can
598
+ * be implemented.
599
+ */
600
+ export default class Designtime extends ManagedObject {
601
+ /**
602
+ * Constructor for a new `Designtime`.
603
+ *
604
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
605
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
606
+ * of the syntax of the settings object.
607
+ *
608
+ * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.base.ManagedObject#constructor
609
+ * sap.ui.base.ManagedObject} can be used.
610
+ */
611
+ constructor(
612
+ /**
613
+ * Initial settings for the new Designtime.
614
+ */
615
+ mSettings?: $DesigntimeSettings
616
+ );
617
+ /**
618
+ * Constructor for a new `Designtime`.
619
+ *
620
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
621
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
622
+ * of the syntax of the settings object.
623
+ *
624
+ * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.base.ManagedObject#constructor
625
+ * sap.ui.base.ManagedObject} can be used.
626
+ */
627
+ constructor(
628
+ /**
629
+ * ID for the new Designtime, generated automatically if no ID is given.
630
+ */
631
+ sId?: string,
632
+ /**
633
+ * Initial settings for the new Designtime.
634
+ */
635
+ mSettings?: $DesigntimeSettings
636
+ );
637
+
638
+ /**
639
+ * Creates a new subclass of class sap.ui.integration.Designtime with name `sClassName` and enriches it
640
+ * with the information contained in `oClassInfo`.
641
+ *
642
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.ManagedObject.extend}.
643
+ *
644
+ * @returns Created class / constructor function
645
+ */
646
+ static extend<T extends Record<string, unknown>>(
647
+ /**
648
+ * Name of the class being created
649
+ */
650
+ sClassName: string,
651
+ /**
652
+ * Object literal with information about the class
653
+ */
654
+ oClassInfo?: sap.ClassInfo<T, Designtime>,
655
+ /**
656
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
657
+ * used by this class
658
+ */
659
+ FNMetaImpl?: Function
660
+ ): Function;
661
+ /**
662
+ * Returns a metadata object for class sap.ui.integration.Designtime.
663
+ *
664
+ * @returns Metadata object describing this class
665
+ */
666
+ static getMetadata(): ManagedObjectMetadata;
667
+ /**
668
+ * Returns an interface to the card, which uses this extension.
669
+ *
670
+ * @returns An interface to the card.
671
+ */
672
+ getCard(): CardFacade;
673
+ }
674
+
675
+ export interface $DesigntimeSettings extends $ManagedObjectSettings {}
676
+ }
677
+
678
+ declare module "sap/ui/integration/designtime/baseEditor/validator/IsBoolean" {
679
+ /**
680
+ * @SINCE 1.81
681
+ * @EXPERIMENTAL - 1.81
682
+ *
683
+ * Validates if the provided value is a boolean or binding string.
684
+ */
685
+ interface IsBoolean {
686
+ /**
687
+ * Validator function
688
+ *
689
+ * @returns Validation result
690
+ */
691
+ validate(
692
+ /**
693
+ * Value to validate
694
+ */
695
+ vValue: boolean | string
696
+ ): boolean;
697
+ }
698
+ const IsBoolean: IsBoolean;
699
+ export default IsBoolean;
700
+ }
701
+
702
+ declare module "sap/ui/integration/designtime/baseEditor/validator/IsDate" {
703
+ /**
704
+ * @SINCE 1.81
705
+ * @EXPERIMENTAL - 1.81
706
+ *
707
+ * Validates if the provided value can be parsed to a valid date.
708
+ */
709
+ interface IsDate {
710
+ /**
711
+ * Validator function
712
+ *
713
+ * @returns Validation result
714
+ */
715
+ validate(
716
+ /**
717
+ * Date string to validate
718
+ */
719
+ sDateString: string
720
+ ): boolean;
721
+ }
722
+ const IsDate: IsDate;
723
+ export default IsDate;
724
+ }
725
+
726
+ declare module "sap/ui/integration/designtime/baseEditor/validator/IsInteger" {
727
+ /**
728
+ * @SINCE 1.81
729
+ * @EXPERIMENTAL - 1.81
730
+ *
731
+ * Validates if the provided value is an integer or binding string.
732
+ */
733
+ interface IsInteger {
734
+ /**
735
+ * Validator function
736
+ *
737
+ * @returns Validation result
738
+ */
739
+ validate(
740
+ /**
741
+ * Value to validate
742
+ */
743
+ vValue: number | string
744
+ ): boolean;
745
+ }
746
+ const IsInteger: IsInteger;
747
+ export default IsInteger;
748
+ }
749
+
750
+ declare module "sap/ui/integration/designtime/baseEditor/validator/IsNumber" {
751
+ /**
752
+ * @SINCE 1.81
753
+ * @EXPERIMENTAL - 1.81
754
+ *
755
+ * Validates if the provided value is a number or binding string.
756
+ */
757
+ interface IsNumber {
758
+ /**
759
+ * Validator function
760
+ *
761
+ * @returns Validation result
762
+ */
763
+ validate(
764
+ /**
765
+ * Value to validate
766
+ */
767
+ vValue: number | string
768
+ ): boolean;
769
+ }
770
+ const IsNumber: IsNumber;
771
+ export default IsNumber;
772
+ }
773
+
774
+ declare module "sap/ui/integration/designtime/baseEditor/validator/IsSelectedKey" {
775
+ /**
776
+ * @SINCE 1.81
777
+ * @EXPERIMENTAL - 1.81
778
+ *
779
+ * Validates if the provided value is one of the given keys.
780
+ */
781
+ interface IsSelectedKey {
782
+ /**
783
+ * Validator function
784
+ *
785
+ * @returns Validation result
786
+ */
787
+ validate(
788
+ /**
789
+ * Key to validate
790
+ */
791
+ sValue: string,
792
+ /**
793
+ * Validator config
794
+ */
795
+ oConfig: {
796
+ /**
797
+ * Available keys
798
+ */
799
+ keys: string[];
800
+ }
801
+ ): boolean;
802
+ }
803
+ const IsSelectedKey: IsSelectedKey;
804
+ export default IsSelectedKey;
805
+ }
806
+
807
+ declare module "sap/ui/integration/designtime/baseEditor/validator/IsStringList" {
808
+ /**
809
+ * @SINCE 1.81
810
+ * @EXPERIMENTAL - 1.81
811
+ *
812
+ * Validates if none of the provided values is an invalid binding.
813
+ */
814
+ interface IsStringList {
815
+ /**
816
+ * Validator function
817
+ *
818
+ * @returns Validation result
819
+ */
820
+ validate(
821
+ /**
822
+ * Strings to validate
823
+ */
824
+ aValue: string[]
825
+ ): boolean;
826
+ }
827
+ const IsStringList: IsStringList;
828
+ export default IsStringList;
829
+ }
830
+
831
+ declare module "sap/ui/integration/designtime/baseEditor/validator/IsUniqueKey" {
832
+ /**
833
+ * @SINCE 1.81
834
+ * @EXPERIMENTAL - 1.81
835
+ *
836
+ * Validates if the provided key is unique in a list of given keys.
837
+ */
838
+ interface IsUniqueKey {
839
+ /**
840
+ * Validator function
841
+ *
842
+ * @returns Validation result
843
+ */
844
+ validate(
845
+ /**
846
+ * New key value to validate
847
+ */
848
+ sValue: string,
849
+ /**
850
+ * Validator config
851
+ */
852
+ oConfig: {
853
+ /**
854
+ * Existing keys
855
+ */
856
+ keys: string[];
857
+ /**
858
+ * Previous key value
859
+ */
860
+ currentKey: string;
861
+ }
862
+ ): boolean;
863
+ }
864
+ const IsUniqueKey: IsUniqueKey;
865
+ export default IsUniqueKey;
866
+ }
867
+
868
+ declare module "sap/ui/integration/designtime/baseEditor/validator/IsUniqueList" {
869
+ /**
870
+ * @SINCE 1.81
871
+ * @EXPERIMENTAL - 1.81
872
+ *
873
+ * Validates if the provided list contains no duplicates.
874
+ */
875
+ interface IsUniqueList {
876
+ /**
877
+ * Validator function
878
+ *
879
+ * @returns Validation result
880
+ */
881
+ validate(
882
+ /**
883
+ * List to validate
884
+ */
885
+ aValue: string
886
+ ): boolean;
887
+ }
888
+ const IsUniqueList: IsUniqueList;
889
+ export default IsUniqueList;
890
+ }
891
+
892
+ declare module "sap/ui/integration/designtime/baseEditor/validator/IsValidBinding" {
893
+ /**
894
+ * @SINCE 1.81
895
+ * @EXPERIMENTAL - 1.81
896
+ *
897
+ * Validates if the provided value is a valid binding.
898
+ */
899
+ interface IsValidBinding {
900
+ /**
901
+ * Validator function
902
+ *
903
+ * @returns Validation result
904
+ */
905
+ validate(
906
+ /**
907
+ * Value to validate
908
+ */
909
+ sValue: string,
910
+ /**
911
+ * Validator config
912
+ */
913
+ oConfig: {
914
+ /**
915
+ * Whether strings which don't contain a binding are allowed, default is false
916
+ */
917
+ allowPlainStrings: boolean;
918
+ }
919
+ ): boolean;
920
+ }
921
+ const IsValidBinding: IsValidBinding;
922
+ export default IsValidBinding;
923
+ }
924
+
925
+ declare module "sap/ui/integration/designtime/baseEditor/validator/MaxLength" {
926
+ /**
927
+ * @SINCE 1.81
928
+ * @EXPERIMENTAL - 1.81
929
+ *
930
+ * Validates if the provided value doesn't exceed the maximum length.
931
+ */
932
+ interface MaxLength {
933
+ /**
934
+ * Validator function
935
+ *
936
+ * @returns Validation result
937
+ */
938
+ validate(
939
+ /**
940
+ * Value to validate
941
+ */
942
+ vValue: boolean | string
943
+ ): boolean;
944
+ }
945
+ const MaxLength: MaxLength;
946
+ export default MaxLength;
947
+ }
948
+
949
+ declare module "sap/ui/integration/designtime/baseEditor/validator/NotABinding" {
950
+ /**
951
+ * @SINCE 1.81
952
+ * @EXPERIMENTAL - 1.81
953
+ *
954
+ * Validates if the provided value doesn't contain a binding.
955
+ */
956
+ interface NotABinding {
957
+ /**
958
+ * Validator function
959
+ *
960
+ * @returns Validation result
961
+ */
962
+ validate(
963
+ /**
964
+ * Value to validate
965
+ */
966
+ sValue: string
967
+ ): boolean;
968
+ }
969
+ const NotABinding: NotABinding;
970
+ export default NotABinding;
971
+ }
972
+
973
+ declare module "sap/ui/integration/editor/Editor" {
974
+ /**
975
+ * @EXPERIMENTAL (since 1.94)
976
+ *
977
+ * Facade of the {@link sap.ui.integration.editor.Editor} control.
978
+ */
979
+ export interface EditorFacade {
980
+ __implements__sap_ui_integration_editor_EditorFacade: boolean;
981
+
982
+ /**
983
+ * @EXPERIMENTAL (since 1.94)
984
+ *
985
+ * Performs an HTTP request using the given configuration.
986
+ *
987
+ * @returns Resolves when the request is successful, rejects otherwise.
988
+ */
989
+ request(
990
+ /**
991
+ * The configuration of the request.
992
+ */
993
+ oConfiguration: {
994
+ /**
995
+ * The URL of the resource.
996
+ */
997
+ URL: string;
998
+ /**
999
+ * The mode of the request. Possible values are "cors", "no-cors", "same-origin".
1000
+ */
1001
+ mode?: string;
1002
+ /**
1003
+ * The HTTP method. Possible values are "GET", "POST".
1004
+ */
1005
+ method?: string;
1006
+ /**
1007
+ * The request parameters. If the method is "POST" the parameters will be put as key/value pairs into the
1008
+ * body of the request.
1009
+ */
1010
+ parameters?: Object;
1011
+ /**
1012
+ * The expected Content-Type of the response. Possible values are "xml", "json", "text", "script", "html",
1013
+ * "jsonp". Note: Complex Binding is not supported when a dataType is provided. Serialization of the response
1014
+ * to an object is up to the developer.
1015
+ */
1016
+ dataType?: Object;
1017
+ /**
1018
+ * The HTTP headers of the request.
1019
+ */
1020
+ headers?: Object;
1021
+ /**
1022
+ * Indicates whether cross-site requests should be made using credentials.
1023
+ */
1024
+ withCredentials?: boolean;
1025
+ }
1026
+ ): Promise<any>;
1027
+ }
1028
+ }
1029
+
1030
+ declare module "sap/ui/integration/editor/Extension" {
1031
+ import {
1032
+ default as Extension1,
1033
+ $ExtensionSettings as $ExtensionSettings1,
1034
+ } from "sap/ui/integration/Extension";
1035
+
1036
+ import { CardFacade } from "sap/ui/integration/widgets/Card";
1037
+
1038
+ /**
1039
+ * @SINCE 1.94
1040
+ *
1041
+ * Brings JavaScript capabilities for an {@link sap.ui.integration.editor.Editor} where custom logic can
1042
+ * be implemented.
1043
+ */
1044
+ export default class Extension extends Extension1 {
1045
+ /**
1046
+ * Constructor for a new `Extension`.
1047
+ */
1048
+ constructor(
1049
+ /**
1050
+ * Initial settings for the new extension.
1051
+ */
1052
+ mSettings?: $ExtensionSettings
1053
+ );
1054
+ /**
1055
+ * Constructor for a new `Extension`.
1056
+ */
1057
+ constructor(
1058
+ /**
1059
+ * ID for the new extension, generated automatically if no ID is given.
1060
+ */
1061
+ sId?: string,
1062
+ /**
1063
+ * Initial settings for the new extension.
1064
+ */
1065
+ mSettings?: $ExtensionSettings
1066
+ );
1067
+
1068
+ /**
1069
+ * Returns an interface to the editor, which uses this extension.
1070
+ *
1071
+ * @returns An interface to the card.
1072
+ */
1073
+ getEditor(): CardFacade;
1074
+ /**
1075
+ * Called when the editor is ready.
1076
+ */
1077
+ onEditorReady(): void;
1078
+ }
1079
+
1080
+ export interface $ExtensionSettings extends $ExtensionSettings1 {}
1081
+ }
1082
+
1083
+ declare module "sap/ui/integration/Extension" {
1084
+ import {
1085
+ default as ManagedObject,
1086
+ $ManagedObjectSettings,
1087
+ PropertyBindingInfo,
1088
+ } from "sap/ui/base/ManagedObject";
1089
+
1090
+ import Event from "sap/ui/base/Event";
1091
+
1092
+ import Control from "sap/ui/core/Control";
1093
+
1094
+ import { CardActionType, CardMenuAction } from "sap/ui/integration/library";
1095
+
1096
+ import { CardFacade } from "sap/ui/integration/widgets/Card";
1097
+
1098
+ import ManagedObjectMetadata from "sap/ui/base/ManagedObjectMetadata";
1099
+
1100
+ /**
1101
+ * @SINCE 1.75
1102
+ *
1103
+ * Brings JavaScript capabilities for an {@link sap.ui.integration.widgets.Card} where custom logic can
1104
+ * be implemented.
1105
+ */
1106
+ export default class Extension extends ManagedObject {
1107
+ /**
1108
+ * Constructor for a new `Extension`.
1109
+ *
1110
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1111
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1112
+ * of the syntax of the settings object.
1113
+ */
1114
+ constructor(
1115
+ /**
1116
+ * Initial settings for the new extension.
1117
+ */
1118
+ mSettings?: $ExtensionSettings
1119
+ );
1120
+ /**
1121
+ * Constructor for a new `Extension`.
1122
+ *
1123
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1124
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1125
+ * of the syntax of the settings object.
1126
+ */
1127
+ constructor(
1128
+ /**
1129
+ * ID for the new extension, generated automatically if no ID is given.
1130
+ */
1131
+ sId?: string,
1132
+ /**
1133
+ * Initial settings for the new extension.
1134
+ */
1135
+ mSettings?: $ExtensionSettings
1136
+ );
1137
+
1138
+ /**
1139
+ * Creates a new subclass of class sap.ui.integration.Extension with name `sClassName` and enriches it with
1140
+ * the information contained in `oClassInfo`.
1141
+ *
1142
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.ManagedObject.extend}.
1143
+ *
1144
+ * @returns Created class / constructor function
1145
+ */
1146
+ static extend<T extends Record<string, unknown>>(
1147
+ /**
1148
+ * Name of the class being created
1149
+ */
1150
+ sClassName: string,
1151
+ /**
1152
+ * Object literal with information about the class
1153
+ */
1154
+ oClassInfo?: sap.ClassInfo<T, Extension>,
1155
+ /**
1156
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1157
+ * used by this class
1158
+ */
1159
+ FNMetaImpl?: Function
1160
+ ): Function;
1161
+ /**
1162
+ * Returns a metadata object for class sap.ui.integration.Extension.
1163
+ *
1164
+ * @returns Metadata object describing this class
1165
+ */
1166
+ static getMetadata(): ManagedObjectMetadata;
1167
+ /**
1168
+ * @EXPERIMENTAL (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
1169
+ * be done before its official public release. Use at your own discretion.
1170
+ *
1171
+ * Attaches event handler `fnFunction` to the {@link #event:action action} event of this `sap.ui.integration.Extension`.
1172
+ *
1173
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1174
+ * otherwise it will be bound to this `sap.ui.integration.Extension` itself.
1175
+ *
1176
+ * Fired when an action is triggered in the card.
1177
+ *
1178
+ * When an action is triggered in the card it can be handled on several places by "action" event handlers.
1179
+ * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
1180
+ * one to handle the action by calling `oEvent.preventDefault()`.
1181
+ *
1182
+ * @returns Reference to `this` in order to allow method chaining
1183
+ */
1184
+ attachAction(
1185
+ /**
1186
+ * An application-specific payload object that will be passed to the event handler along with the event
1187
+ * object when firing the event
1188
+ */
1189
+ oData: object,
1190
+ /**
1191
+ * The function to be called when the event occurs
1192
+ */
1193
+ fnFunction: (p1: Event) => void,
1194
+ /**
1195
+ * Context object to call the event handler with. Defaults to this `sap.ui.integration.Extension` itself
1196
+ */
1197
+ oListener?: object
1198
+ ): this;
1199
+ /**
1200
+ * @EXPERIMENTAL (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
1201
+ * be done before its official public release. Use at your own discretion.
1202
+ *
1203
+ * Attaches event handler `fnFunction` to the {@link #event:action action} event of this `sap.ui.integration.Extension`.
1204
+ *
1205
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1206
+ * otherwise it will be bound to this `sap.ui.integration.Extension` itself.
1207
+ *
1208
+ * Fired when an action is triggered in the card.
1209
+ *
1210
+ * When an action is triggered in the card it can be handled on several places by "action" event handlers.
1211
+ * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
1212
+ * one to handle the action by calling `oEvent.preventDefault()`.
1213
+ *
1214
+ * @returns Reference to `this` in order to allow method chaining
1215
+ */
1216
+ attachAction(
1217
+ /**
1218
+ * The function to be called when the event occurs
1219
+ */
1220
+ fnFunction: (p1: Event) => void,
1221
+ /**
1222
+ * Context object to call the event handler with. Defaults to this `sap.ui.integration.Extension` itself
1223
+ */
1224
+ oListener?: object
1225
+ ): this;
1226
+ /**
1227
+ * @EXPERIMENTAL (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
1228
+ * be done before its official public release. Use at your own discretion.
1229
+ *
1230
+ * Detaches event handler `fnFunction` from the {@link #event:action action} event of this `sap.ui.integration.Extension`.
1231
+ *
1232
+ * The passed function and listener object must match the ones used for event registration.
1233
+ *
1234
+ * @returns Reference to `this` in order to allow method chaining
1235
+ */
1236
+ detachAction(
1237
+ /**
1238
+ * The function to be called, when the event occurs
1239
+ */
1240
+ fnFunction: (p1: Event) => void,
1241
+ /**
1242
+ * Context object on which the given function had to be called
1243
+ */
1244
+ oListener?: object
1245
+ ): this;
1246
+ /**
1247
+ * @EXPERIMENTAL (since 1.113) - The API might change.
1248
+ *
1249
+ * Starts the process of fetching a resource from the network, returning a promise that is fulfilled once
1250
+ * the response is available. Use this method to override the default behavior when fetching network resources.
1251
+ * Mimics the browser native Fetch API.
1252
+ *
1253
+ * @returns A `Promise` that resolves to a `Response` object.
1254
+ */
1255
+ fetch(
1256
+ /**
1257
+ * This defines the resource that you wish to fetch.
1258
+ */
1259
+ sResource: string,
1260
+ /**
1261
+ * An object containing any custom settings that you want to apply to the request.
1262
+ */
1263
+ mOptions: object,
1264
+ /**
1265
+ * The map of request settings defined in the card manifest. Use this only for reading, they can not be
1266
+ * modified.
1267
+ */
1268
+ mRequestSettings: object
1269
+ ): Promise<Response>;
1270
+ /**
1271
+ * @EXPERIMENTAL (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
1272
+ * be done before its official public release. Use at your own discretion.
1273
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1274
+ *
1275
+ * Fires event {@link #event:action action} to attached listeners.
1276
+ *
1277
+ * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
1278
+ * event object. The return value of this method indicates whether the default action should be executed.
1279
+ *
1280
+ * @returns Whether or not to prevent the default action
1281
+ */
1282
+ fireAction(
1283
+ /**
1284
+ * Parameters to pass along with the event
1285
+ */
1286
+ mParameters?: {
1287
+ /**
1288
+ * The card the action is fired from.
1289
+ */
1290
+ card?: Control;
1291
+ /**
1292
+ * The action configuration.
1293
+ */
1294
+ actionConfig?: object;
1295
+ /**
1296
+ * The action source.
1297
+ */
1298
+ actionSource?: Control;
1299
+ /**
1300
+ * The parameters related to the triggered action.
1301
+ */
1302
+ parameters?: object;
1303
+ /**
1304
+ * The type of the action.
1305
+ */
1306
+ type?: CardActionType | keyof typeof CardActionType;
1307
+ }
1308
+ ): boolean;
1309
+ /**
1310
+ * @deprecated (since 1.85) - This property is replaced by the `actions` aggregation of the card;
1311
+ * @EXPERIMENTAL (since 1.75) - Disclaimer: this property is in a beta state - incompatible API changes
1312
+ * may be done before its official public release. Use at your own discretion.
1313
+ *
1314
+ * Gets current value of property {@link #getActions actions}.
1315
+ *
1316
+ * The actions configuration.
1317
+ *
1318
+ * @returns Value of property `actions`
1319
+ */
1320
+ getActions(): CardMenuAction[];
1321
+ /**
1322
+ * Returns an interface to the card, which uses this extension.
1323
+ *
1324
+ * @returns An interface to the card.
1325
+ */
1326
+ getCard(): CardFacade;
1327
+ /**
1328
+ * Gets current value of property {@link #getFormatters formatters}.
1329
+ *
1330
+ * The formatters that can be used in the manifest.
1331
+ *
1332
+ * @returns Value of property `formatters`
1333
+ */
1334
+ getFormatters(): Record<string, () => void> | undefined;
1335
+ /**
1336
+ * @EXPERIMENTAL (since 1.108)
1337
+ *
1338
+ * Override this method to lazy load dependencies for the extension.
1339
+ *
1340
+ * @returns Returns a promise. The card will wait for this promise to be resolved before continuing with
1341
+ * the initialization.
1342
+ */
1343
+ loadDependencies(): Promise<any>;
1344
+ /**
1345
+ * Called after the card is initialized.
1346
+ */
1347
+ onCardReady(): void;
1348
+ /**
1349
+ * Sets current value of property {@link #setFormatters formatters}.
1350
+ *
1351
+ * The formatters that can be used in the manifest. When called with a value of `null` or `undefined`, the
1352
+ * default value of the property will be restored.
1353
+ *
1354
+ * @returns Reference to `this` in order to allow method chaining
1355
+ */
1356
+ setFormatters(
1357
+ /**
1358
+ * New value of property `formatters`
1359
+ */
1360
+ aFormatters?: Record<string, Function>
1361
+ ): this;
1362
+ }
1363
+
1364
+ export interface $ExtensionSettings extends $ManagedObjectSettings {
1365
+ /**
1366
+ * @deprecated (since 1.85) - This property is replaced by the `actions` aggregation of the card;
1367
+ * @EXPERIMENTAL (since 1.75) - Disclaimer: this property is in a beta state - incompatible API changes
1368
+ * may be done before its official public release. Use at your own discretion.
1369
+ *
1370
+ * The actions configuration.
1371
+ */
1372
+ actions?: CardMenuAction[] | PropertyBindingInfo | `{${string}}`;
1373
+
1374
+ /**
1375
+ * @EXPERIMENTAL (since 1.79)
1376
+ *
1377
+ * The formatters that can be used in the manifest.
1378
+ */
1379
+ formatters?: object | PropertyBindingInfo | `{${string}}`;
1380
+
1381
+ /**
1382
+ * @EXPERIMENTAL (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
1383
+ * be done before its official public release. Use at your own discretion.
1384
+ *
1385
+ * Fired when an action is triggered in the card.
1386
+ *
1387
+ * When an action is triggered in the card it can be handled on several places by "action" event handlers.
1388
+ * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
1389
+ * one to handle the action by calling `oEvent.preventDefault()`.
1390
+ */
1391
+ action?: (oEvent: Event) => void;
1392
+ }
1393
+ }
1394
+
1395
+ declare module "sap/ui/integration/Host" {
1396
+ import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
1397
+
1398
+ import Event from "sap/ui/base/Event";
1399
+
1400
+ import Control from "sap/ui/core/Control";
1401
+
1402
+ import { CardActionType, CardMenuAction } from "sap/ui/integration/library";
1403
+
1404
+ import Card from "sap/ui/integration/widgets/Card";
1405
+
1406
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
1407
+
1408
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1409
+
1410
+ /**
1411
+ * @SINCE 1.75
1412
+ * @EXPERIMENTAL (since 1.75)
1413
+ *
1414
+ * Provides application-level functions and services to an integration card.
1415
+ *
1416
+ * Examples may include, but are not limited to options like: share a card, remove a card.
1417
+ */
1418
+ export default class Host extends UI5Element {
1419
+ /**
1420
+ * Constructor for a new `Host`.
1421
+ *
1422
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1423
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1424
+ * of the syntax of the settings object.
1425
+ */
1426
+ constructor(
1427
+ /**
1428
+ * Initial settings for the new host.
1429
+ */
1430
+ mSettings?: $HostSettings
1431
+ );
1432
+ /**
1433
+ * Constructor for a new `Host`.
1434
+ *
1435
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1436
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1437
+ * of the syntax of the settings object.
1438
+ */
1439
+ constructor(
1440
+ /**
1441
+ * ID for the new host, generated automatically if no ID is given.
1442
+ */
1443
+ sId?: string,
1444
+ /**
1445
+ * Initial settings for the new host.
1446
+ */
1447
+ mSettings?: $HostSettings
1448
+ );
1449
+
1450
+ /**
1451
+ * Creates a new subclass of class sap.ui.integration.Host with name `sClassName` and enriches it with the
1452
+ * information contained in `oClassInfo`.
1453
+ *
1454
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
1455
+ *
1456
+ * @returns Created class / constructor function
1457
+ */
1458
+ static extend<T extends Record<string, unknown>>(
1459
+ /**
1460
+ * Name of the class being created
1461
+ */
1462
+ sClassName: string,
1463
+ /**
1464
+ * Object literal with information about the class
1465
+ */
1466
+ oClassInfo?: sap.ClassInfo<T, Host>,
1467
+ /**
1468
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1469
+ * used by this class
1470
+ */
1471
+ FNMetaImpl?: Function
1472
+ ): Function;
1473
+ /**
1474
+ * Returns a metadata object for class sap.ui.integration.Host.
1475
+ *
1476
+ * @returns Metadata object describing this class
1477
+ */
1478
+ static getMetadata(): ElementMetadata;
1479
+ /**
1480
+ * @EXPERIMENTAL (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
1481
+ * be done before its official public release. Use at your own discretion.
1482
+ *
1483
+ * Attaches event handler `fnFunction` to the {@link #event:action action} event of this `sap.ui.integration.Host`.
1484
+ *
1485
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1486
+ * otherwise it will be bound to this `sap.ui.integration.Host` itself.
1487
+ *
1488
+ * Fired when an action is triggered.
1489
+ *
1490
+ * When an action is triggered in the card it can be handled on several places by "action" event handlers.
1491
+ * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
1492
+ * one to handle the action by calling `oEvent.preventDefault()`.
1493
+ *
1494
+ * @returns Reference to `this` in order to allow method chaining
1495
+ */
1496
+ attachAction(
1497
+ /**
1498
+ * An application-specific payload object that will be passed to the event handler along with the event
1499
+ * object when firing the event
1500
+ */
1501
+ oData: object,
1502
+ /**
1503
+ * The function to be called when the event occurs
1504
+ */
1505
+ fnFunction: (p1: Event) => void,
1506
+ /**
1507
+ * Context object to call the event handler with. Defaults to this `sap.ui.integration.Host` itself
1508
+ */
1509
+ oListener?: object
1510
+ ): this;
1511
+ /**
1512
+ * @EXPERIMENTAL (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
1513
+ * be done before its official public release. Use at your own discretion.
1514
+ *
1515
+ * Attaches event handler `fnFunction` to the {@link #event:action action} event of this `sap.ui.integration.Host`.
1516
+ *
1517
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1518
+ * otherwise it will be bound to this `sap.ui.integration.Host` itself.
1519
+ *
1520
+ * Fired when an action is triggered.
1521
+ *
1522
+ * When an action is triggered in the card it can be handled on several places by "action" event handlers.
1523
+ * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
1524
+ * one to handle the action by calling `oEvent.preventDefault()`.
1525
+ *
1526
+ * @returns Reference to `this` in order to allow method chaining
1527
+ */
1528
+ attachAction(
1529
+ /**
1530
+ * The function to be called when the event occurs
1531
+ */
1532
+ fnFunction: (p1: Event) => void,
1533
+ /**
1534
+ * Context object to call the event handler with. Defaults to this `sap.ui.integration.Host` itself
1535
+ */
1536
+ oListener?: object
1537
+ ): this;
1538
+ /**
1539
+ * @EXPERIMENTAL (since 1.96)
1540
+ *
1541
+ * Attaches event handler `fnFunction` to the {@link #event:cardConfigurationChange cardConfigurationChange}
1542
+ * event of this `sap.ui.integration.Host`.
1543
+ *
1544
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1545
+ * otherwise it will be bound to this `sap.ui.integration.Host` itself.
1546
+ *
1547
+ * Fired when some card configuration settings are changed as a result of user interaction. For example
1548
+ * - filter value is changed.
1549
+ *
1550
+ * @returns Reference to `this` in order to allow method chaining
1551
+ */
1552
+ attachCardConfigurationChange(
1553
+ /**
1554
+ * An application-specific payload object that will be passed to the event handler along with the event
1555
+ * object when firing the event
1556
+ */
1557
+ oData: object,
1558
+ /**
1559
+ * The function to be called when the event occurs
1560
+ */
1561
+ fnFunction: (p1: Event) => void,
1562
+ /**
1563
+ * Context object to call the event handler with. Defaults to this `sap.ui.integration.Host` itself
1564
+ */
1565
+ oListener?: object
1566
+ ): this;
1567
+ /**
1568
+ * @EXPERIMENTAL (since 1.96)
1569
+ *
1570
+ * Attaches event handler `fnFunction` to the {@link #event:cardConfigurationChange cardConfigurationChange}
1571
+ * event of this `sap.ui.integration.Host`.
1572
+ *
1573
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1574
+ * otherwise it will be bound to this `sap.ui.integration.Host` itself.
1575
+ *
1576
+ * Fired when some card configuration settings are changed as a result of user interaction. For example
1577
+ * - filter value is changed.
1578
+ *
1579
+ * @returns Reference to `this` in order to allow method chaining
1580
+ */
1581
+ attachCardConfigurationChange(
1582
+ /**
1583
+ * The function to be called when the event occurs
1584
+ */
1585
+ fnFunction: (p1: Event) => void,
1586
+ /**
1587
+ * Context object to call the event handler with. Defaults to this `sap.ui.integration.Host` itself
1588
+ */
1589
+ oListener?: object
1590
+ ): this;
1591
+ /**
1592
+ * @EXPERIMENTAL (since 1.107)
1593
+ *
1594
+ * Attaches event handler `fnFunction` to the {@link #event:cardStateChanged cardStateChanged} event of
1595
+ * this `sap.ui.integration.Host`.
1596
+ *
1597
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1598
+ * otherwise it will be bound to this `sap.ui.integration.Host` itself.
1599
+ *
1600
+ * Fired when the state of a card is changed. For example - the card is ready, new page is selected inside
1601
+ * the card, a filter is changed or data is refreshed.
1602
+ *
1603
+ * @returns Reference to `this` in order to allow method chaining
1604
+ */
1605
+ attachCardStateChanged(
1606
+ /**
1607
+ * An application-specific payload object that will be passed to the event handler along with the event
1608
+ * object when firing the event
1609
+ */
1610
+ oData: object,
1611
+ /**
1612
+ * The function to be called when the event occurs
1613
+ */
1614
+ fnFunction: (p1: Event) => void,
1615
+ /**
1616
+ * Context object to call the event handler with. Defaults to this `sap.ui.integration.Host` itself
1617
+ */
1618
+ oListener?: object
1619
+ ): this;
1620
+ /**
1621
+ * @EXPERIMENTAL (since 1.107)
1622
+ *
1623
+ * Attaches event handler `fnFunction` to the {@link #event:cardStateChanged cardStateChanged} event of
1624
+ * this `sap.ui.integration.Host`.
1625
+ *
1626
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1627
+ * otherwise it will be bound to this `sap.ui.integration.Host` itself.
1628
+ *
1629
+ * Fired when the state of a card is changed. For example - the card is ready, new page is selected inside
1630
+ * the card, a filter is changed or data is refreshed.
1631
+ *
1632
+ * @returns Reference to `this` in order to allow method chaining
1633
+ */
1634
+ attachCardStateChanged(
1635
+ /**
1636
+ * The function to be called when the event occurs
1637
+ */
1638
+ fnFunction: (p1: Event) => void,
1639
+ /**
1640
+ * Context object to call the event handler with. Defaults to this `sap.ui.integration.Host` itself
1641
+ */
1642
+ oListener?: object
1643
+ ): this;
1644
+ /**
1645
+ * @EXPERIMENTAL (since 1.91)
1646
+ *
1647
+ * Attaches event handler `fnFunction` to the {@link #event:message message} event of this `sap.ui.integration.Host`.
1648
+ *
1649
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1650
+ * otherwise it will be bound to this `sap.ui.integration.Host` itself.
1651
+ *
1652
+ * Fired when a message from channels like navigator.serviceWorker is received.
1653
+ *
1654
+ * @returns Reference to `this` in order to allow method chaining
1655
+ */
1656
+ attachMessage(
1657
+ /**
1658
+ * An application-specific payload object that will be passed to the event handler along with the event
1659
+ * object when firing the event
1660
+ */
1661
+ oData: object,
1662
+ /**
1663
+ * The function to be called when the event occurs
1664
+ */
1665
+ fnFunction: (p1: Event) => void,
1666
+ /**
1667
+ * Context object to call the event handler with. Defaults to this `sap.ui.integration.Host` itself
1668
+ */
1669
+ oListener?: object
1670
+ ): this;
1671
+ /**
1672
+ * @EXPERIMENTAL (since 1.91)
1673
+ *
1674
+ * Attaches event handler `fnFunction` to the {@link #event:message message} event of this `sap.ui.integration.Host`.
1675
+ *
1676
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1677
+ * otherwise it will be bound to this `sap.ui.integration.Host` itself.
1678
+ *
1679
+ * Fired when a message from channels like navigator.serviceWorker is received.
1680
+ *
1681
+ * @returns Reference to `this` in order to allow method chaining
1682
+ */
1683
+ attachMessage(
1684
+ /**
1685
+ * The function to be called when the event occurs
1686
+ */
1687
+ fnFunction: (p1: Event) => void,
1688
+ /**
1689
+ * Context object to call the event handler with. Defaults to this `sap.ui.integration.Host` itself
1690
+ */
1691
+ oListener?: object
1692
+ ): this;
1693
+ /**
1694
+ * @EXPERIMENTAL (since 1.97)
1695
+ *
1696
+ * This function is called when a CSRF token has expired.
1697
+ */
1698
+ csrfTokenExpired(
1699
+ /**
1700
+ * The CSRF token configuration.
1701
+ */
1702
+ mCSRFTokenConfig: {
1703
+ data: object;
1704
+ }
1705
+ ): void;
1706
+ /**
1707
+ * @EXPERIMENTAL (since 1.97)
1708
+ *
1709
+ * This function is called when a CSRF token is fetched.
1710
+ */
1711
+ csrfTokenFetched(
1712
+ /**
1713
+ * The CSRF token configuration.
1714
+ */
1715
+ mCSRFTokenConfig: {
1716
+ data: object;
1717
+ },
1718
+ /**
1719
+ * A promise which resolves the CSRF token to its value.
1720
+ */
1721
+ pCSRFTokenValuePromise: Promise<string>
1722
+ ): void;
1723
+ /**
1724
+ * @EXPERIMENTAL (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
1725
+ * be done before its official public release. Use at your own discretion.
1726
+ *
1727
+ * Detaches event handler `fnFunction` from the {@link #event:action action} event of this `sap.ui.integration.Host`.
1728
+ *
1729
+ * The passed function and listener object must match the ones used for event registration.
1730
+ *
1731
+ * @returns Reference to `this` in order to allow method chaining
1732
+ */
1733
+ detachAction(
1734
+ /**
1735
+ * The function to be called, when the event occurs
1736
+ */
1737
+ fnFunction: (p1: Event) => void,
1738
+ /**
1739
+ * Context object on which the given function had to be called
1740
+ */
1741
+ oListener?: object
1742
+ ): this;
1743
+ /**
1744
+ * @EXPERIMENTAL (since 1.96)
1745
+ *
1746
+ * Detaches event handler `fnFunction` from the {@link #event:cardConfigurationChange cardConfigurationChange}
1747
+ * event of this `sap.ui.integration.Host`.
1748
+ *
1749
+ * The passed function and listener object must match the ones used for event registration.
1750
+ *
1751
+ * @returns Reference to `this` in order to allow method chaining
1752
+ */
1753
+ detachCardConfigurationChange(
1754
+ /**
1755
+ * The function to be called, when the event occurs
1756
+ */
1757
+ fnFunction: (p1: Event) => void,
1758
+ /**
1759
+ * Context object on which the given function had to be called
1760
+ */
1761
+ oListener?: object
1762
+ ): this;
1763
+ /**
1764
+ * @EXPERIMENTAL (since 1.107)
1765
+ *
1766
+ * Detaches event handler `fnFunction` from the {@link #event:cardStateChanged cardStateChanged} event of
1767
+ * this `sap.ui.integration.Host`.
1768
+ *
1769
+ * The passed function and listener object must match the ones used for event registration.
1770
+ *
1771
+ * @returns Reference to `this` in order to allow method chaining
1772
+ */
1773
+ detachCardStateChanged(
1774
+ /**
1775
+ * The function to be called, when the event occurs
1776
+ */
1777
+ fnFunction: (p1: Event) => void,
1778
+ /**
1779
+ * Context object on which the given function had to be called
1780
+ */
1781
+ oListener?: object
1782
+ ): this;
1783
+ /**
1784
+ * @EXPERIMENTAL (since 1.91)
1785
+ *
1786
+ * Detaches event handler `fnFunction` from the {@link #event:message message} event of this `sap.ui.integration.Host`.
1787
+ *
1788
+ * The passed function and listener object must match the ones used for event registration.
1789
+ *
1790
+ * @returns Reference to `this` in order to allow method chaining
1791
+ */
1792
+ detachMessage(
1793
+ /**
1794
+ * The function to be called, when the event occurs
1795
+ */
1796
+ fnFunction: (p1: Event) => void,
1797
+ /**
1798
+ * Context object on which the given function had to be called
1799
+ */
1800
+ oListener?: object
1801
+ ): this;
1802
+ /**
1803
+ * @EXPERIMENTAL (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
1804
+ * be done before its official public release. Use at your own discretion.
1805
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1806
+ *
1807
+ * Fires event {@link #event:action action} to attached listeners.
1808
+ *
1809
+ * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
1810
+ * event object. The return value of this method indicates whether the default action should be executed.
1811
+ *
1812
+ * @returns Whether or not to prevent the default action
1813
+ */
1814
+ fireAction(
1815
+ /**
1816
+ * Parameters to pass along with the event
1817
+ */
1818
+ mParameters?: {
1819
+ /**
1820
+ * The card the action is fired from.
1821
+ */
1822
+ card?: Control;
1823
+ /**
1824
+ * The action configuration.
1825
+ */
1826
+ actionConfig?: object;
1827
+ /**
1828
+ * The action source.
1829
+ */
1830
+ actionSource?: Control;
1831
+ /**
1832
+ * The parameters related to the triggered action.
1833
+ */
1834
+ parameters?: object;
1835
+ /**
1836
+ * The type of the action.
1837
+ */
1838
+ type?: CardActionType | keyof typeof CardActionType;
1839
+ }
1840
+ ): boolean;
1841
+ /**
1842
+ * @EXPERIMENTAL (since 1.96)
1843
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1844
+ *
1845
+ * Fires event {@link #event:cardConfigurationChange cardConfigurationChange} to attached listeners.
1846
+ *
1847
+ * @returns Reference to `this` in order to allow method chaining
1848
+ */
1849
+ fireCardConfigurationChange(
1850
+ /**
1851
+ * Parameters to pass along with the event
1852
+ */
1853
+ mParameters?: {
1854
+ /**
1855
+ * The card the changes are fired from.
1856
+ */
1857
+ card?: Control;
1858
+ /**
1859
+ * Changed configuration settings.
1860
+ *
1861
+ * Example:
1862
+ * ```javascript
1863
+ *
1864
+ * {
1865
+ * "/sap.card/configuration/filters/shipper/value": "key3",
1866
+ * "/sap.card/configuration/filters/item/value": "key2"
1867
+ * }
1868
+ * ```
1869
+ */
1870
+ changes?: object;
1871
+ }
1872
+ ): this;
1873
+ /**
1874
+ * @EXPERIMENTAL (since 1.107)
1875
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1876
+ *
1877
+ * Fires event {@link #event:cardStateChanged cardStateChanged} to attached listeners.
1878
+ *
1879
+ * @returns Reference to `this` in order to allow method chaining
1880
+ */
1881
+ fireCardStateChanged(
1882
+ /**
1883
+ * Parameters to pass along with the event
1884
+ */
1885
+ mParameters?: {
1886
+ /**
1887
+ * The card the changes are fired from.
1888
+ */
1889
+ card?: Control;
1890
+ }
1891
+ ): this;
1892
+ /**
1893
+ * @EXPERIMENTAL (since 1.91)
1894
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1895
+ *
1896
+ * Fires event {@link #event:message message} to attached listeners.
1897
+ *
1898
+ * @returns Reference to `this` in order to allow method chaining
1899
+ */
1900
+ fireMessage(
1901
+ /**
1902
+ * Parameters to pass along with the event
1903
+ */
1904
+ mParameters?: {
1905
+ data?: object;
1906
+ }
1907
+ ): this;
1908
+ /**
1909
+ * @EXPERIMENTAL (since 1.75) - Disclaimer: this property is in a beta state - incompatible API changes
1910
+ * may be done before its official public release. Use at your own discretion.
1911
+ *
1912
+ * Gets current value of property {@link #getActions actions}.
1913
+ *
1914
+ * The actions configuration.
1915
+ *
1916
+ * @returns Value of property `actions`
1917
+ */
1918
+ getActions(): CardMenuAction[];
1919
+ /**
1920
+ * @SINCE 1.83
1921
+ *
1922
+ * Returns the context object for the Card Editor design-time environment Contexts can be used to configure
1923
+ * Cards with information available in the host environment. Each entry in the list should contain design-time
1924
+ * information. A label, placeholder, and description should be provided.
1925
+ *
1926
+ * Example Context Structure: { "sap.workzone": { "currentUser: { "id": { "label": "Id of the Work Zone
1927
+ * user", "placeholder": "Work Zone user id", "description": "The value will change based on the logged
1928
+ * on user" } } } ... }
1929
+ *
1930
+ * The context information and texts should be translated as they appear in the design-time UI of the Card
1931
+ * Editor.
1932
+ *
1933
+ * @returns A promise which contains the context structure.
1934
+ */
1935
+ getContexts(): Promise<object>;
1936
+ /**
1937
+ * @SINCE 1.83
1938
+ *
1939
+ * Resolves the value for a given path in the context of the host Contexts can be used to configure Cards
1940
+ * with information available in the host environment.
1941
+ *
1942
+ * Example Context Structure: { "sap.workzone": { "currentUser: { "id": { "label": "Id of the Work Zone
1943
+ * user", "placeholder": "Work Zone user id", "description": "The value will change based on the logged
1944
+ * on user" } } } ... }
1945
+ *
1946
+ * Example path to the current user id of the context sPath = "sap.workzone/currentUser/id" parameter: {
1947
+ * userId: { value: "{context>sap.workzone/currentUser/id}" resolves to UserId } }
1948
+ *
1949
+ * @returns A promise which resolves with the value of this context.
1950
+ */
1951
+ getContextValue(
1952
+ /**
1953
+ * The path to a context
1954
+ */
1955
+ sPath: string
1956
+ ): Promise<null>;
1957
+ /**
1958
+ * @EXPERIMENTAL (since 1.97)
1959
+ *
1960
+ * Resolves the CSRF token and returns a Promise with its value.
1961
+ *
1962
+ * @returns A promise which resolves the CSRF token to its value.
1963
+ */
1964
+ getCsrfToken(
1965
+ /**
1966
+ * The CSRF token configuration.
1967
+ */
1968
+ mCSRFTokenConfig: {
1969
+ data: object;
1970
+ }
1971
+ ): Promise<string>;
1972
+ /**
1973
+ * Resolves the destination and returns its URL.
1974
+ *
1975
+ * @returns A promise which resolves with the URL of the destination.
1976
+ */
1977
+ getDestination(
1978
+ /**
1979
+ * The name of the destination.
1980
+ */
1981
+ sDestinationName: string,
1982
+ /**
1983
+ * The card that depends on the destination.
1984
+ */
1985
+ oCard: Card
1986
+ ): Promise<string>;
1987
+ /**
1988
+ * @SINCE 1.83
1989
+ *
1990
+ * Returns the list of destinations for the Card Editor design-time environment List entries are objects
1991
+ * that contain at least the name. { "name": "DestinationName" }
1992
+ *
1993
+ * @returns A promise which resolves with the list of destinations.
1994
+ */
1995
+ getDestinations(): Promise<object[]>;
1996
+ /**
1997
+ * Gets current value of property {@link #getResolveDestination resolveDestination}.
1998
+ *
1999
+ * A function that resolves the given destination name to a URL.
2000
+ *
2001
+ * The Card calls this function when it needs to send a request to a destination. Function returns the URL
2002
+ * to which the request is sent.
2003
+ *
2004
+ * If a card depends on a destination, but this callback is not implemented, an error will be logged.
2005
+ *
2006
+ * The callback receives `destinationName` as parameter and returns a string with the URL. Or alternatively
2007
+ * the callback may return a `Promise` with the URL as an argument.
2008
+ *
2009
+ * @returns Value of property `resolveDestination`
2010
+ */
2011
+ getResolveDestination():
2012
+ | ((p1: string, p2: Card) => string | Promise<string>)
2013
+ | undefined;
2014
+ /**
2015
+ * @EXPERIMENTAL (since 1.75) - Disclaimer: this property is in a beta state - incompatible API changes
2016
+ * may be done before its official public release. Use at your own discretion.
2017
+ *
2018
+ * Sets a new value for property {@link #getActions actions}.
2019
+ *
2020
+ * The actions configuration.
2021
+ *
2022
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2023
+ *
2024
+ * @returns Reference to `this` in order to allow method chaining
2025
+ */
2026
+ setActions(
2027
+ /**
2028
+ * New value for property `actions`
2029
+ */
2030
+ sActions: CardMenuAction[]
2031
+ ): this;
2032
+ /**
2033
+ * Sets a new value for property {@link #setResolveDestination resolveDestination}.
2034
+ *
2035
+ * A function that resolves the given destination name to a URL. The Card calls this function when it needs
2036
+ * to send a request to a destination. Function returns the URL to which the request is sent. If a card
2037
+ * depends on a destination, but this callback is not implemented, an error will be logged. The callback
2038
+ * receives `destinationName` as parameter and returns a string with the URL. Or alternatively the callback
2039
+ * may return a `Promise` with the URL as an argument.
2040
+ *
2041
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2042
+ *
2043
+ * @returns Reference to `this` in order to allow method chaining
2044
+ */
2045
+ setResolveDestination(
2046
+ /**
2047
+ * New value for property `resolveDestination`
2048
+ */
2049
+ fnResolveDestination?: (p1: string, p2: Card) => string | Promise<string>
2050
+ ): this;
2051
+ }
2052
+
2053
+ export interface $HostSettings extends $ElementSettings {
2054
+ /**
2055
+ * @EXPERIMENTAL (since 1.75) - Disclaimer: this property is in a beta state - incompatible API changes
2056
+ * may be done before its official public release. Use at your own discretion.
2057
+ *
2058
+ * The actions configuration.
2059
+ */
2060
+ actions?: CardMenuAction[] | PropertyBindingInfo | `{${string}}`;
2061
+
2062
+ /**
2063
+ * A function that resolves the given destination name to a URL.
2064
+ *
2065
+ * The Card calls this function when it needs to send a request to a destination. Function returns the URL
2066
+ * to which the request is sent.
2067
+ *
2068
+ * If a card depends on a destination, but this callback is not implemented, an error will be logged.
2069
+ *
2070
+ * The callback receives `destinationName` as parameter and returns a string with the URL. Or alternatively
2071
+ * the callback may return a `Promise` with the URL as an argument.
2072
+ */
2073
+ resolveDestination?: Function | PropertyBindingInfo | `{${string}}`;
2074
+
2075
+ /**
2076
+ * @EXPERIMENTAL (since 1.75) - Disclaimer: this event is in a beta state - incompatible API changes may
2077
+ * be done before its official public release. Use at your own discretion.
2078
+ *
2079
+ * Fired when an action is triggered.
2080
+ *
2081
+ * When an action is triggered in the card it can be handled on several places by "action" event handlers.
2082
+ * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
2083
+ * one to handle the action by calling `oEvent.preventDefault()`.
2084
+ */
2085
+ action?: (oEvent: Event) => void;
2086
+
2087
+ /**
2088
+ * @EXPERIMENTAL (since 1.96)
2089
+ *
2090
+ * Fired when some card configuration settings are changed as a result of user interaction. For example
2091
+ * - filter value is changed.
2092
+ */
2093
+ cardConfigurationChange?: (oEvent: Event) => void;
2094
+
2095
+ /**
2096
+ * @EXPERIMENTAL (since 1.107)
2097
+ *
2098
+ * Fired when the state of a card is changed. For example - the card is ready, new page is selected inside
2099
+ * the card, a filter is changed or data is refreshed.
2100
+ */
2101
+ cardStateChanged?: (oEvent: Event) => void;
2102
+
2103
+ /**
2104
+ * @EXPERIMENTAL (since 1.91)
2105
+ *
2106
+ * Fired when a message from channels like navigator.serviceWorker is received.
2107
+ */
2108
+ message?: (oEvent: Event) => void;
2109
+ }
2110
+ }
2111
+
2112
+ declare module "sap/ui/integration/widgets/Card" {
2113
+ import { default as CardBase, $CardBaseSettings } from "sap/f/CardBase";
2114
+
2115
+ import ActionDefinition from "sap/ui/integration/ActionDefinition";
2116
+
2117
+ import Event from "sap/ui/base/Event";
2118
+
2119
+ import Control from "sap/ui/core/Control";
2120
+
2121
+ import {
2122
+ CardActionType,
2123
+ CardDataMode,
2124
+ CardDesign,
2125
+ CardPreviewMode,
2126
+ CardArea,
2127
+ } from "sap/ui/integration/library";
2128
+
2129
+ import { URI, ID, MessageType } from "sap/ui/core/library";
2130
+
2131
+ import Host from "sap/ui/integration/Host";
2132
+
2133
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
2134
+
2135
+ import {
2136
+ PropertyBindingInfo,
2137
+ AggregationBindingInfo,
2138
+ } from "sap/ui/base/ManagedObject";
2139
+
2140
+ /**
2141
+ * @SINCE 1.62
2142
+ *
2143
+ * A control that represents a container with a header and content.
2144
+ *
2145
+ * Overview: Cards are small user interface elements which provide the most important information from an
2146
+ * app, related to a specific role or task. The information is represented in a compact manner, allowing
2147
+ * for actions to be executed. Cards can be described as small representations of an app which can be integrated
2148
+ * in different systems.
2149
+ *
2150
+ * The integration card is defined in a declarative way, using a manifest.json to be:
2151
+ * - Easily integrated into apps
2152
+ * - Easily reused across apps
2153
+ * - Understandable by other technologies
2154
+ * - Self-contained (has a built-in functionality and doesn't need external configuration)
2155
+ * - Dynamic parameter handling
2156
+ * - Clear separation of the roles of the card and app developers
2157
+ *
2158
+ * The role of the card developer is to describe the card in a manifest.json file and define:
2159
+ * - Header
2160
+ * - Content
2161
+ * - Data source
2162
+ * - Possible actions
2163
+ *
2164
+ * The role of the app developer is to integrate the card into the app and define:
2165
+ * - The dimensions of the card inside a layout of choice, using the `width` and `height` properties
2166
+ * - The behavior for the actions described in the manifest.json file, using the action event
2167
+ *
2168
+ * **You can learn more about integration cards in the {@link demo:sap/ui/integration/demokit/cardExplorer/index.html
2169
+ * Card Explorer}**
2170
+ *
2171
+ * When to use
2172
+ * - When you want to reuse the card across apps.
2173
+ * - When you need easy integration and configuration.
2174
+ *
2175
+ * When not to use
2176
+ * - When you need more header and content flexibility.
2177
+ * - When you have to achieve simple card visualization. For such cases, use: {@link sap.f.Card sap.f.Card}.
2178
+ *
2179
+ * - When you have to use an application model. For such cases, use: {@link sap.f.Card sap.f.Card}.
2180
+ * - When you need complex behavior. For such cases, use: {@link sap.f.Card sap.f.Card}.
2181
+ */
2182
+ export default class Card extends CardBase {
2183
+ /**
2184
+ * Constructor for a new `Card`.
2185
+ *
2186
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2187
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
2188
+ * of the syntax of the settings object.
2189
+ * See:
2190
+ * {@link topic:5b46b03f024542ba802d99d67bc1a3f4 Cards}
2191
+ */
2192
+ constructor(
2193
+ /**
2194
+ * Initial settings for the new control
2195
+ */
2196
+ mSettings?: $CardSettings
2197
+ );
2198
+ /**
2199
+ * Constructor for a new `Card`.
2200
+ *
2201
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2202
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
2203
+ * of the syntax of the settings object.
2204
+ * See:
2205
+ * {@link topic:5b46b03f024542ba802d99d67bc1a3f4 Cards}
2206
+ */
2207
+ constructor(
2208
+ /**
2209
+ * ID for the new control, generated automatically if no ID is given
2210
+ */
2211
+ sId?: string,
2212
+ /**
2213
+ * Initial settings for the new control
2214
+ */
2215
+ mSettings?: $CardSettings
2216
+ );
2217
+
2218
+ /**
2219
+ * Creates a new subclass of class sap.ui.integration.widgets.Card with name `sClassName` and enriches it
2220
+ * with the information contained in `oClassInfo`.
2221
+ *
2222
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.f.CardBase.extend}.
2223
+ *
2224
+ * @returns Created class / constructor function
2225
+ */
2226
+ static extend<T extends Record<string, unknown>>(
2227
+ /**
2228
+ * Name of the class being created
2229
+ */
2230
+ sClassName: string,
2231
+ /**
2232
+ * Object literal with information about the class
2233
+ */
2234
+ oClassInfo?: sap.ClassInfo<T, Card>,
2235
+ /**
2236
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2237
+ * used by this class
2238
+ */
2239
+ FNMetaImpl?: Function
2240
+ ): Function;
2241
+ /**
2242
+ * Returns a metadata object for class sap.ui.integration.widgets.Card.
2243
+ *
2244
+ * @returns Metadata object describing this class
2245
+ */
2246
+ static getMetadata(): ElementMetadata;
2247
+ /**
2248
+ * @SINCE 1.85
2249
+ * @EXPERIMENTAL (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
2250
+ * may be done before its official public release. Use at your own discretion.
2251
+ *
2252
+ * Adds some actionDefinition to the aggregation {@link #getActionDefinitions actionDefinitions}.
2253
+ *
2254
+ * @returns Reference to `this` in order to allow method chaining
2255
+ */
2256
+ addActionDefinition(
2257
+ /**
2258
+ * The actionDefinition to add; if empty, nothing is inserted
2259
+ */
2260
+ oActionDefinition: ActionDefinition
2261
+ ): this;
2262
+ /**
2263
+ * @EXPERIMENTAL (since 1.64) - Disclaimer: this event is in a beta state - incompatible API changes may
2264
+ * be done before its official public release. Use at your own discretion.
2265
+ *
2266
+ * Attaches event handler `fnFunction` to the {@link #event:action action} event of this `sap.ui.integration.widgets.Card`.
2267
+ *
2268
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2269
+ * otherwise it will be bound to this `sap.ui.integration.widgets.Card` itself.
2270
+ *
2271
+ * Fired when an action is triggered on the card.
2272
+ *
2273
+ * When an action is triggered in the card it can be handled on several places by "action" event handlers.
2274
+ * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
2275
+ * one to handle the action by calling `oEvent.preventDefault()`.
2276
+ *
2277
+ * @returns Reference to `this` in order to allow method chaining
2278
+ */
2279
+ attachAction(
2280
+ /**
2281
+ * An application-specific payload object that will be passed to the event handler along with the event
2282
+ * object when firing the event
2283
+ */
2284
+ oData: object,
2285
+ /**
2286
+ * The function to be called when the event occurs
2287
+ */
2288
+ fnFunction: (p1: Event) => void,
2289
+ /**
2290
+ * Context object to call the event handler with. Defaults to this `sap.ui.integration.widgets.Card` itself
2291
+ */
2292
+ oListener?: object
2293
+ ): this;
2294
+ /**
2295
+ * @EXPERIMENTAL (since 1.64) - Disclaimer: this event is in a beta state - incompatible API changes may
2296
+ * be done before its official public release. Use at your own discretion.
2297
+ *
2298
+ * Attaches event handler `fnFunction` to the {@link #event:action action} event of this `sap.ui.integration.widgets.Card`.
2299
+ *
2300
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2301
+ * otherwise it will be bound to this `sap.ui.integration.widgets.Card` itself.
2302
+ *
2303
+ * Fired when an action is triggered on the card.
2304
+ *
2305
+ * When an action is triggered in the card it can be handled on several places by "action" event handlers.
2306
+ * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
2307
+ * one to handle the action by calling `oEvent.preventDefault()`.
2308
+ *
2309
+ * @returns Reference to `this` in order to allow method chaining
2310
+ */
2311
+ attachAction(
2312
+ /**
2313
+ * The function to be called when the event occurs
2314
+ */
2315
+ fnFunction: (p1: Event) => void,
2316
+ /**
2317
+ * Context object to call the event handler with. Defaults to this `sap.ui.integration.widgets.Card` itself
2318
+ */
2319
+ oListener?: object
2320
+ ): this;
2321
+ /**
2322
+ * @EXPERIMENTAL (since 1.96)
2323
+ *
2324
+ * Attaches event handler `fnFunction` to the {@link #event:configurationChange configurationChange} event
2325
+ * of this `sap.ui.integration.widgets.Card`.
2326
+ *
2327
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2328
+ * otherwise it will be bound to this `sap.ui.integration.widgets.Card` itself.
2329
+ *
2330
+ * Fired when some configuration settings are changed as a result of user interaction. For example - filter
2331
+ * value is changed.
2332
+ *
2333
+ * @returns Reference to `this` in order to allow method chaining
2334
+ */
2335
+ attachConfigurationChange(
2336
+ /**
2337
+ * An application-specific payload object that will be passed to the event handler along with the event
2338
+ * object when firing the event
2339
+ */
2340
+ oData: object,
2341
+ /**
2342
+ * The function to be called when the event occurs
2343
+ */
2344
+ fnFunction: (p1: Event) => void,
2345
+ /**
2346
+ * Context object to call the event handler with. Defaults to this `sap.ui.integration.widgets.Card` itself
2347
+ */
2348
+ oListener?: object
2349
+ ): this;
2350
+ /**
2351
+ * @EXPERIMENTAL (since 1.96)
2352
+ *
2353
+ * Attaches event handler `fnFunction` to the {@link #event:configurationChange configurationChange} event
2354
+ * of this `sap.ui.integration.widgets.Card`.
2355
+ *
2356
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2357
+ * otherwise it will be bound to this `sap.ui.integration.widgets.Card` itself.
2358
+ *
2359
+ * Fired when some configuration settings are changed as a result of user interaction. For example - filter
2360
+ * value is changed.
2361
+ *
2362
+ * @returns Reference to `this` in order to allow method chaining
2363
+ */
2364
+ attachConfigurationChange(
2365
+ /**
2366
+ * The function to be called when the event occurs
2367
+ */
2368
+ fnFunction: (p1: Event) => void,
2369
+ /**
2370
+ * Context object to call the event handler with. Defaults to this `sap.ui.integration.widgets.Card` itself
2371
+ */
2372
+ oListener?: object
2373
+ ): this;
2374
+ /**
2375
+ * Attaches event handler `fnFunction` to the {@link #event:manifestApplied manifestApplied} event of this
2376
+ * `sap.ui.integration.widgets.Card`.
2377
+ *
2378
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2379
+ * otherwise it will be bound to this `sap.ui.integration.widgets.Card` itself.
2380
+ *
2381
+ * Fired when card utilities (like `DataProviderFactory`) and the card elements (like header) are created
2382
+ * and initialized.
2383
+ *
2384
+ * Note: The card's content may not be available yet because it may depend on other resources to load.
2385
+ *
2386
+ * @returns Reference to `this` in order to allow method chaining
2387
+ */
2388
+ attachManifestApplied(
2389
+ /**
2390
+ * An application-specific payload object that will be passed to the event handler along with the event
2391
+ * object when firing the event
2392
+ */
2393
+ oData: object,
2394
+ /**
2395
+ * The function to be called when the event occurs
2396
+ */
2397
+ fnFunction: (p1: Event) => void,
2398
+ /**
2399
+ * Context object to call the event handler with. Defaults to this `sap.ui.integration.widgets.Card` itself
2400
+ */
2401
+ oListener?: object
2402
+ ): this;
2403
+ /**
2404
+ * Attaches event handler `fnFunction` to the {@link #event:manifestApplied manifestApplied} event of this
2405
+ * `sap.ui.integration.widgets.Card`.
2406
+ *
2407
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2408
+ * otherwise it will be bound to this `sap.ui.integration.widgets.Card` itself.
2409
+ *
2410
+ * Fired when card utilities (like `DataProviderFactory`) and the card elements (like header) are created
2411
+ * and initialized.
2412
+ *
2413
+ * Note: The card's content may not be available yet because it may depend on other resources to load.
2414
+ *
2415
+ * @returns Reference to `this` in order to allow method chaining
2416
+ */
2417
+ attachManifestApplied(
2418
+ /**
2419
+ * The function to be called when the event occurs
2420
+ */
2421
+ fnFunction: (p1: Event) => void,
2422
+ /**
2423
+ * Context object to call the event handler with. Defaults to this `sap.ui.integration.widgets.Card` itself
2424
+ */
2425
+ oListener?: object
2426
+ ): this;
2427
+ /**
2428
+ * @EXPERIMENTAL (since 1.72)
2429
+ *
2430
+ * Attaches event handler `fnFunction` to the {@link #event:manifestReady manifestReady} event of this `sap.ui.integration.widgets.Card`.
2431
+ *
2432
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2433
+ * otherwise it will be bound to this `sap.ui.integration.widgets.Card` itself.
2434
+ *
2435
+ * Fired when the manifest is loaded.
2436
+ *
2437
+ * @returns Reference to `this` in order to allow method chaining
2438
+ */
2439
+ attachManifestReady(
2440
+ /**
2441
+ * An application-specific payload object that will be passed to the event handler along with the event
2442
+ * object when firing the event
2443
+ */
2444
+ oData: object,
2445
+ /**
2446
+ * The function to be called when the event occurs
2447
+ */
2448
+ fnFunction: (p1: Event) => void,
2449
+ /**
2450
+ * Context object to call the event handler with. Defaults to this `sap.ui.integration.widgets.Card` itself
2451
+ */
2452
+ oListener?: object
2453
+ ): this;
2454
+ /**
2455
+ * @EXPERIMENTAL (since 1.72)
2456
+ *
2457
+ * Attaches event handler `fnFunction` to the {@link #event:manifestReady manifestReady} event of this `sap.ui.integration.widgets.Card`.
2458
+ *
2459
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2460
+ * otherwise it will be bound to this `sap.ui.integration.widgets.Card` itself.
2461
+ *
2462
+ * Fired when the manifest is loaded.
2463
+ *
2464
+ * @returns Reference to `this` in order to allow method chaining
2465
+ */
2466
+ attachManifestReady(
2467
+ /**
2468
+ * The function to be called when the event occurs
2469
+ */
2470
+ fnFunction: (p1: Event) => void,
2471
+ /**
2472
+ * Context object to call the event handler with. Defaults to this `sap.ui.integration.widgets.Card` itself
2473
+ */
2474
+ oListener?: object
2475
+ ): this;
2476
+ /**
2477
+ * @EXPERIMENTAL (since 1.107)
2478
+ *
2479
+ * Attaches event handler `fnFunction` to the {@link #event:stateChanged stateChanged} event of this `sap.ui.integration.widgets.Card`.
2480
+ *
2481
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2482
+ * otherwise it will be bound to this `sap.ui.integration.widgets.Card` itself.
2483
+ *
2484
+ * Fired when the state of the card is changed. For example - the card is ready, new page is selected, a
2485
+ * filter is changed or data is refreshed.
2486
+ *
2487
+ * @returns Reference to `this` in order to allow method chaining
2488
+ */
2489
+ attachStateChanged(
2490
+ /**
2491
+ * An application-specific payload object that will be passed to the event handler along with the event
2492
+ * object when firing the event
2493
+ */
2494
+ oData: object,
2495
+ /**
2496
+ * The function to be called when the event occurs
2497
+ */
2498
+ fnFunction: (p1: Event) => void,
2499
+ /**
2500
+ * Context object to call the event handler with. Defaults to this `sap.ui.integration.widgets.Card` itself
2501
+ */
2502
+ oListener?: object
2503
+ ): this;
2504
+ /**
2505
+ * @EXPERIMENTAL (since 1.107)
2506
+ *
2507
+ * Attaches event handler `fnFunction` to the {@link #event:stateChanged stateChanged} event of this `sap.ui.integration.widgets.Card`.
2508
+ *
2509
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2510
+ * otherwise it will be bound to this `sap.ui.integration.widgets.Card` itself.
2511
+ *
2512
+ * Fired when the state of the card is changed. For example - the card is ready, new page is selected, a
2513
+ * filter is changed or data is refreshed.
2514
+ *
2515
+ * @returns Reference to `this` in order to allow method chaining
2516
+ */
2517
+ attachStateChanged(
2518
+ /**
2519
+ * The function to be called when the event occurs
2520
+ */
2521
+ fnFunction: (p1: Event) => void,
2522
+ /**
2523
+ * Context object to call the event handler with. Defaults to this `sap.ui.integration.widgets.Card` itself
2524
+ */
2525
+ oListener?: object
2526
+ ): this;
2527
+ /**
2528
+ * @SINCE 1.85
2529
+ * @EXPERIMENTAL (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
2530
+ * may be done before its official public release. Use at your own discretion.
2531
+ *
2532
+ * Destroys all the actionDefinitions in the aggregation {@link #getActionDefinitions actionDefinitions}.
2533
+ *
2534
+ * @returns Reference to `this` in order to allow method chaining
2535
+ */
2536
+ destroyActionDefinitions(): this;
2537
+ /**
2538
+ * @EXPERIMENTAL (since 1.64) - Disclaimer: this event is in a beta state - incompatible API changes may
2539
+ * be done before its official public release. Use at your own discretion.
2540
+ *
2541
+ * Detaches event handler `fnFunction` from the {@link #event:action action} event of this `sap.ui.integration.widgets.Card`.
2542
+ *
2543
+ * The passed function and listener object must match the ones used for event registration.
2544
+ *
2545
+ * @returns Reference to `this` in order to allow method chaining
2546
+ */
2547
+ detachAction(
2548
+ /**
2549
+ * The function to be called, when the event occurs
2550
+ */
2551
+ fnFunction: (p1: Event) => void,
2552
+ /**
2553
+ * Context object on which the given function had to be called
2554
+ */
2555
+ oListener?: object
2556
+ ): this;
2557
+ /**
2558
+ * @EXPERIMENTAL (since 1.96)
2559
+ *
2560
+ * Detaches event handler `fnFunction` from the {@link #event:configurationChange configurationChange} event
2561
+ * of this `sap.ui.integration.widgets.Card`.
2562
+ *
2563
+ * The passed function and listener object must match the ones used for event registration.
2564
+ *
2565
+ * @returns Reference to `this` in order to allow method chaining
2566
+ */
2567
+ detachConfigurationChange(
2568
+ /**
2569
+ * The function to be called, when the event occurs
2570
+ */
2571
+ fnFunction: (p1: Event) => void,
2572
+ /**
2573
+ * Context object on which the given function had to be called
2574
+ */
2575
+ oListener?: object
2576
+ ): this;
2577
+ /**
2578
+ * Detaches event handler `fnFunction` from the {@link #event:manifestApplied manifestApplied} event of
2579
+ * this `sap.ui.integration.widgets.Card`.
2580
+ *
2581
+ * The passed function and listener object must match the ones used for event registration.
2582
+ *
2583
+ * @returns Reference to `this` in order to allow method chaining
2584
+ */
2585
+ detachManifestApplied(
2586
+ /**
2587
+ * The function to be called, when the event occurs
2588
+ */
2589
+ fnFunction: (p1: Event) => void,
2590
+ /**
2591
+ * Context object on which the given function had to be called
2592
+ */
2593
+ oListener?: object
2594
+ ): this;
2595
+ /**
2596
+ * @EXPERIMENTAL (since 1.72)
2597
+ *
2598
+ * Detaches event handler `fnFunction` from the {@link #event:manifestReady manifestReady} event of this
2599
+ * `sap.ui.integration.widgets.Card`.
2600
+ *
2601
+ * The passed function and listener object must match the ones used for event registration.
2602
+ *
2603
+ * @returns Reference to `this` in order to allow method chaining
2604
+ */
2605
+ detachManifestReady(
2606
+ /**
2607
+ * The function to be called, when the event occurs
2608
+ */
2609
+ fnFunction: (p1: Event) => void,
2610
+ /**
2611
+ * Context object on which the given function had to be called
2612
+ */
2613
+ oListener?: object
2614
+ ): this;
2615
+ /**
2616
+ * @EXPERIMENTAL (since 1.107)
2617
+ *
2618
+ * Detaches event handler `fnFunction` from the {@link #event:stateChanged stateChanged} event of this `sap.ui.integration.widgets.Card`.
2619
+ *
2620
+ * The passed function and listener object must match the ones used for event registration.
2621
+ *
2622
+ * @returns Reference to `this` in order to allow method chaining
2623
+ */
2624
+ detachStateChanged(
2625
+ /**
2626
+ * The function to be called, when the event occurs
2627
+ */
2628
+ fnFunction: (p1: Event) => void,
2629
+ /**
2630
+ * Context object on which the given function had to be called
2631
+ */
2632
+ oListener?: object
2633
+ ): this;
2634
+ /**
2635
+ * @EXPERIMENTAL (since 1.64) - Disclaimer: this event is in a beta state - incompatible API changes may
2636
+ * be done before its official public release. Use at your own discretion.
2637
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2638
+ *
2639
+ * Fires event {@link #event:action action} to attached listeners.
2640
+ *
2641
+ * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
2642
+ * event object. The return value of this method indicates whether the default action should be executed.
2643
+ *
2644
+ * @returns Whether or not to prevent the default action
2645
+ */
2646
+ fireAction(
2647
+ /**
2648
+ * Parameters to pass along with the event
2649
+ */
2650
+ mParameters?: {
2651
+ /**
2652
+ * The action source.
2653
+ */
2654
+ actionSource?: Control;
2655
+ /**
2656
+ * The manifest parameters related to the triggered action.
2657
+ */
2658
+ manifestParameters?: object;
2659
+ /**
2660
+ * The parameters related to the triggered action.
2661
+ */
2662
+ parameters?: object;
2663
+ /**
2664
+ * The type of the action.
2665
+ */
2666
+ type?: CardActionType | keyof typeof CardActionType;
2667
+ }
2668
+ ): boolean;
2669
+ /**
2670
+ * @EXPERIMENTAL (since 1.96)
2671
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2672
+ *
2673
+ * Fires event {@link #event:configurationChange configurationChange} to attached listeners.
2674
+ *
2675
+ * @returns Reference to `this` in order to allow method chaining
2676
+ */
2677
+ fireConfigurationChange(
2678
+ /**
2679
+ * Parameters to pass along with the event
2680
+ */
2681
+ mParameters?: {
2682
+ /**
2683
+ * Changed configuration settings.
2684
+ *
2685
+ * Example:
2686
+ * ```javascript
2687
+ *
2688
+ * {
2689
+ * "/sap.card/configuration/filters/shipper/value": "key3",
2690
+ * "/sap.card/configuration/filters/item/value": "key2",
2691
+ * }
2692
+ * ```
2693
+ */
2694
+ changes?: object;
2695
+ }
2696
+ ): this;
2697
+ /**
2698
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2699
+ *
2700
+ * Fires event {@link #event:manifestApplied manifestApplied} to attached listeners.
2701
+ *
2702
+ * @returns Reference to `this` in order to allow method chaining
2703
+ */
2704
+ fireManifestApplied(
2705
+ /**
2706
+ * Parameters to pass along with the event
2707
+ */
2708
+ mParameters?: object
2709
+ ): this;
2710
+ /**
2711
+ * @EXPERIMENTAL (since 1.72)
2712
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2713
+ *
2714
+ * Fires event {@link #event:manifestReady manifestReady} to attached listeners.
2715
+ *
2716
+ * @returns Reference to `this` in order to allow method chaining
2717
+ */
2718
+ fireManifestReady(
2719
+ /**
2720
+ * Parameters to pass along with the event
2721
+ */
2722
+ mParameters?: object
2723
+ ): this;
2724
+ /**
2725
+ * @EXPERIMENTAL (since 1.107)
2726
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2727
+ *
2728
+ * Fires event {@link #event:stateChanged stateChanged} to attached listeners.
2729
+ *
2730
+ * @returns Reference to `this` in order to allow method chaining
2731
+ */
2732
+ fireStateChanged(
2733
+ /**
2734
+ * Parameters to pass along with the event
2735
+ */
2736
+ mParameters?: object
2737
+ ): this;
2738
+ /**
2739
+ * @SINCE 1.85
2740
+ * @EXPERIMENTAL (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
2741
+ * may be done before its official public release. Use at your own discretion.
2742
+ *
2743
+ * Gets content of aggregation {@link #getActionDefinitions actionDefinitions}.
2744
+ *
2745
+ * Actions definitions from which actions in the header menu of the card are created. **Note**: This aggregation
2746
+ * is destroyed when the property `manifest` changes.
2747
+ */
2748
+ getActionDefinitions(): ActionDefinition[];
2749
+ /**
2750
+ * @SINCE 1.70
2751
+ * @EXPERIMENTAL (since 1.70)
2752
+ *
2753
+ * Gets current value of property {@link #getBaseUrl baseUrl}.
2754
+ *
2755
+ * Defines the base URL of the Card Manifest. It should be used when manifest property is an object instead
2756
+ * of a URL.
2757
+ *
2758
+ * @returns Value of property `baseUrl`
2759
+ */
2760
+ getBaseUrl(): URI;
2761
+ /**
2762
+ * @EXPERIMENTAL (since 1.77)
2763
+ *
2764
+ * Gets values of manifest parameters combined with the parameters from `parameters` property.
2765
+ *
2766
+ * **Notes**
2767
+ *
2768
+ * - Use this method when the manifest is ready. Check `manifestReady` event.
2769
+ *
2770
+ * - Use when developing a Component card.
2771
+ *
2772
+ * @returns Object containing parameters in format `{parameterKey: parameterValue}`.
2773
+ */
2774
+ getCombinedParameters(): Record<string, any>;
2775
+ /**
2776
+ * @SINCE 1.65
2777
+ * @EXPERIMENTAL (since 1.65)
2778
+ *
2779
+ * Gets current value of property {@link #getDataMode dataMode}.
2780
+ *
2781
+ * Defines the state of the `Card`. When set to `Inactive`, the `Card` doesn't make requests.
2782
+ *
2783
+ * Default value is `Auto`.
2784
+ *
2785
+ * @returns Value of property `dataMode`
2786
+ */
2787
+ getDataMode(): CardDataMode | keyof typeof CardDataMode;
2788
+ /**
2789
+ * @SINCE 1.109
2790
+ * @EXPERIMENTAL (since 1.109)
2791
+ *
2792
+ * Gets current value of property {@link #getDesign design}.
2793
+ *
2794
+ * Defines the design of the `Card`.
2795
+ *
2796
+ * Default value is `Solid`.
2797
+ *
2798
+ * @returns Value of property `design`
2799
+ */
2800
+ getDesign(): CardDesign | keyof typeof CardDesign;
2801
+ /**
2802
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2803
+ *
2804
+ * Returns the DOM Element that should get the focus.
2805
+ *
2806
+ * @returns Returns the DOM Element that should get the focus
2807
+ */
2808
+ getFocusDomRef(): Element;
2809
+ /**
2810
+ * ID of the element which is the current target of the association {@link #getHost host}, or `null`.
2811
+ */
2812
+ getHost(): ID;
2813
+ /**
2814
+ * @EXPERIMENTAL (since 1.77)
2815
+ *
2816
+ * Gets the instance of the `host` association.
2817
+ *
2818
+ * @returns The host object associated with this card.
2819
+ */
2820
+ getHostInstance(): Host;
2821
+ /**
2822
+ * Overwrites getter for card manifest.
2823
+ *
2824
+ * @returns Cloned of the parameters.
2825
+ */
2826
+ getManifest(): string | Object;
2827
+ /**
2828
+ * @SINCE 1.76
2829
+ * @EXPERIMENTAL (since 1.76) - This API might be removed when a permanent solution for flexibility changes
2830
+ * is implemented.
2831
+ *
2832
+ * Gets current value of property {@link #getManifestChanges manifestChanges}.
2833
+ *
2834
+ * Defines a list of configuration settings, which will be merged into the original manifest.
2835
+ *
2836
+ * This can be a list of flexibility changes generated during designtime.
2837
+ *
2838
+ * Each item in the array represents a separate level of changes. For example, the first item might be created
2839
+ * by an administrator, the second by a page administrator and the third by the end user.
2840
+ *
2841
+ * The order of the items is the order in which the changes will be merged on top of each other. So the
2842
+ * last item will overwrite the previous items where the paths match.
2843
+ *
2844
+ * Example:
2845
+ * ```javascript
2846
+ *
2847
+ * [
2848
+ * {
2849
+ * // Administrator
2850
+ * "/sap.card/header/title": "My Configured Title in Default Language",
2851
+ * "/sap.card/content/maxItems": 10,
2852
+ * "texts": {
2853
+ * "en-US": {
2854
+ * "/sap.card/header/title": "My Configured Title in US-English"
2855
+ * }
2856
+ * }
2857
+ * },
2858
+ * {
2859
+ * // Page administrator
2860
+ * "/sap.card/content/maxItems": 5
2861
+ * },
2862
+ * {
2863
+ * // End user
2864
+ * "/sap.card/header/title": "Title by End User",
2865
+ * "/sap.card/content/maxItems": 8
2866
+ * }
2867
+ * ]
2868
+ * ```
2869
+ *
2870
+ *
2871
+ * @returns Value of property `manifestChanges`
2872
+ */
2873
+ getManifestChanges(): object[];
2874
+ /**
2875
+ * @EXPERIMENTAL (since 1.77)
2876
+ *
2877
+ * Returns a value from the Manifest based on the specified path.
2878
+ *
2879
+ * **Note** Use this method when the manifest is ready. Check `manifestReady` event.
2880
+ *
2881
+ * @returns The value at the specified path.
2882
+ */
2883
+ getManifestEntry(
2884
+ /**
2885
+ * The path to return a value for.
2886
+ */
2887
+ sPath: string
2888
+ ): any;
2889
+ /**
2890
+ * @SINCE 1.112
2891
+ * @EXPERIMENTAL (since 1.112)
2892
+ *
2893
+ * Gets current value of property {@link #getPreviewMode previewMode}.
2894
+ *
2895
+ * Preview mode of the `Card`. Helpful in scenarios when the end user is choosing or configuring a card.
2896
+ *
2897
+ * - When set to "MockData", the card data is loaded, using a data request, as configured in the "data/mockData"
2898
+ * in the manifest. If such configuration is missing, then the real data is loaded.
2899
+ * - When set to "Abstract", the card shows abstract placeholder without loading data.
2900
+ * - When set to "Off", the card displays real data.
2901
+ *
2902
+ * Default value is `Off`.
2903
+ *
2904
+ * @returns Value of property `previewMode`
2905
+ */
2906
+ getPreviewMode(): CardPreviewMode | keyof typeof CardPreviewMode;
2907
+ /**
2908
+ * Gets current value of property {@link #getReferenceId referenceId}.
2909
+ *
2910
+ * Optional property which can be used by the host to reference the card. It will be forwarded to any children
2911
+ * cards. Does not affect the card behavior.
2912
+ *
2913
+ * Default value is `empty string`.
2914
+ *
2915
+ * @returns Value of property `referenceId`
2916
+ */
2917
+ getReferenceId(): string;
2918
+ /**
2919
+ * @EXPERIMENTAL (since 1.83) - The API might change.
2920
+ *
2921
+ * Gets translated text from the i18n properties files configured for this card.
2922
+ *
2923
+ * For more details see {@link module:sap/base/i18n/ResourceBundle#getText}.
2924
+ *
2925
+ * @returns The value belonging to the key, if found; otherwise the key itself or `undefined` depending
2926
+ * on `bIgnoreKeyFallback`.
2927
+ */
2928
+ getTranslatedText(
2929
+ /**
2930
+ * Key to retrieve the text for
2931
+ */
2932
+ sKey: string,
2933
+ /**
2934
+ * List of parameter values which should replace the placeholders "{n}" (n is the index) in
2935
+ * the found locale-specific string value. Note that the replacement is done whenever `aArgs` is given,
2936
+ * no matter whether the text contains placeholders or not and no matter whether `aArgs` contains a value
2937
+ * for n or not.
2938
+ */
2939
+ aArgs?: string[],
2940
+ /**
2941
+ * If set, `undefined` is returned instead of the key string, when the key is not found in any bundle or
2942
+ * fallback bundle.
2943
+ */
2944
+ bIgnoreKeyFallback?: boolean
2945
+ ): string;
2946
+ /**
2947
+ * Hides the loading placeholders on the whole card, or a particular section of the card.
2948
+ */
2949
+ hideLoadingPlaceholders(
2950
+ /**
2951
+ * Area of the card to show the loading placeholders on. Possible options are 'Header', 'Content', 'Filters'.
2952
+ * Leave empty to hide loading placeholders on all areas of the card.
2953
+ */
2954
+ eCardArea?: CardArea | keyof typeof CardArea
2955
+ ): void;
2956
+ /**
2957
+ * @SINCE 1.85
2958
+ * @EXPERIMENTAL (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
2959
+ * may be done before its official public release. Use at your own discretion.
2960
+ *
2961
+ * Checks for the provided `sap.ui.integration.ActionDefinition` in the aggregation {@link #getActionDefinitions
2962
+ * actionDefinitions}. and returns its index if found or -1 otherwise.
2963
+ *
2964
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
2965
+ */
2966
+ indexOfActionDefinition(
2967
+ /**
2968
+ * The actionDefinition whose index is looked for
2969
+ */
2970
+ oActionDefinition: ActionDefinition
2971
+ ): int;
2972
+ /**
2973
+ * @SINCE 1.85
2974
+ * @EXPERIMENTAL (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
2975
+ * may be done before its official public release. Use at your own discretion.
2976
+ *
2977
+ * Inserts a actionDefinition into the aggregation {@link #getActionDefinitions actionDefinitions}.
2978
+ *
2979
+ * @returns Reference to `this` in order to allow method chaining
2980
+ */
2981
+ insertActionDefinition(
2982
+ /**
2983
+ * The actionDefinition to insert; if empty, nothing is inserted
2984
+ */
2985
+ oActionDefinition: ActionDefinition,
2986
+ /**
2987
+ * The `0`-based index the actionDefinition should be inserted at; for a negative value of `iIndex`, the
2988
+ * actionDefinition is inserted at position 0; for a value greater than the current size of the aggregation,
2989
+ * the actionDefinition is inserted at the last position
2990
+ */
2991
+ iIndex: int
2992
+ ): this;
2993
+ /**
2994
+ * @EXPERIMENTAL (since 1.65) - The API might change.
2995
+ *
2996
+ *
2997
+ * @returns If the card is ready or not.
2998
+ */
2999
+ isReady(): boolean;
3000
+ /**
3001
+ * @EXPERIMENTAL (since 1.73)
3002
+ *
3003
+ * Loads the module designtime/Card.designtime or the module given in "sap.card": { "designtime": "designtime/Own.designtime"
3004
+ * } This file should contain the designtime configuration for the card.
3005
+ *
3006
+ * Returns a promise that resolves with an object { designtime: the designtime modules response manifest:
3007
+ * the complete manifest json } The promise is rejected if the module cannot be loaded with an object: {
3008
+ * error: "Card.designtime not found" }
3009
+ *
3010
+ * @returns Promise resolves after the designtime configuration is loaded.
3011
+ */
3012
+ loadDesigntime(): Promise<object>;
3013
+ /**
3014
+ * @EXPERIMENTAL (since 1.65) - The API might change.
3015
+ *
3016
+ * Refreshes the card by re-applying the manifest settings and triggering all data requests.
3017
+ */
3018
+ refresh(): void;
3019
+ /**
3020
+ * @SINCE 1.95
3021
+ *
3022
+ * Refreshes the card data by triggering all data requests.
3023
+ */
3024
+ refreshData(): void;
3025
+ /**
3026
+ * @SINCE 1.85
3027
+ * @EXPERIMENTAL (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
3028
+ * may be done before its official public release. Use at your own discretion.
3029
+ *
3030
+ * Removes a actionDefinition from the aggregation {@link #getActionDefinitions actionDefinitions}.
3031
+ *
3032
+ * @returns The removed actionDefinition or `null`
3033
+ */
3034
+ removeActionDefinition(
3035
+ /**
3036
+ * The actionDefinition to remove or its index or id
3037
+ */
3038
+ vActionDefinition: int | string | ActionDefinition
3039
+ ): ActionDefinition | null;
3040
+ /**
3041
+ * @SINCE 1.85
3042
+ * @EXPERIMENTAL (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
3043
+ * may be done before its official public release. Use at your own discretion.
3044
+ *
3045
+ * Removes all the controls from the aggregation {@link #getActionDefinitions actionDefinitions}.
3046
+ *
3047
+ * Additionally, it unregisters them from the hosting UIArea.
3048
+ *
3049
+ * @returns An array of the removed elements (might be empty)
3050
+ */
3051
+ removeAllActionDefinitions(): ActionDefinition[];
3052
+ /**
3053
+ * @EXPERIMENTAL (since 1.79)
3054
+ *
3055
+ * Performs an HTTP request using the given configuration.
3056
+ *
3057
+ * @returns Resolves when the request is successful, rejects otherwise.
3058
+ */
3059
+ request(
3060
+ /**
3061
+ * The configuration of the request.
3062
+ */
3063
+ oConfiguration: {
3064
+ /**
3065
+ * The URL of the resource.
3066
+ */
3067
+ url: string;
3068
+ /**
3069
+ * The mode of the request. Possible values are "cors", "no-cors", "same-origin".
3070
+ */
3071
+ mode?: string;
3072
+ /**
3073
+ * The HTTP method. Possible values are "GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", and "HEAD".
3074
+ */
3075
+ method?: string;
3076
+ /**
3077
+ * The request parameters. If the HTTP method is "POST", "PUT", "PATCH", or "DELETE" the parameters will
3078
+ * be put as key/value pairs into the body of the request.
3079
+ */
3080
+ parameters?: object;
3081
+ /**
3082
+ * Deprecated. Use the correct Accept headers and correct Content-Type header in the response.
3083
+ */
3084
+ dataType?: string;
3085
+ /**
3086
+ * The HTTP headers of the request.
3087
+ */
3088
+ headers?: object;
3089
+ /**
3090
+ * Indicates whether cross-site requests should be made using credentials.
3091
+ */
3092
+ withCredentials?: boolean;
3093
+ }
3094
+ ): Promise<any>;
3095
+ /**
3096
+ * Resolves the destination and returns its URL.
3097
+ *
3098
+ * @returns A promise which resolves with the URL of the destination.
3099
+ */
3100
+ resolveDestination(
3101
+ /**
3102
+ * The destination's key used in the configuration.
3103
+ */
3104
+ sKey: string
3105
+ ): Promise<string>;
3106
+ /**
3107
+ * @SINCE 1.70
3108
+ * @EXPERIMENTAL (since 1.70)
3109
+ *
3110
+ * Sets a new value for property {@link #getBaseUrl baseUrl}.
3111
+ *
3112
+ * Defines the base URL of the Card Manifest. It should be used when manifest property is an object instead
3113
+ * of a URL.
3114
+ *
3115
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3116
+ *
3117
+ * @returns Reference to `this` in order to allow method chaining
3118
+ */
3119
+ setBaseUrl(
3120
+ /**
3121
+ * New value for property `baseUrl`
3122
+ */
3123
+ sBaseUrl?: URI
3124
+ ): this;
3125
+ /**
3126
+ * @SINCE 1.65
3127
+ * @EXPERIMENTAL (since 1.65) - API might change.
3128
+ *
3129
+ * Sets a new value for the `dataMode` property.
3130
+ *
3131
+ * @returns Pointer to the control instance to allow method chaining.
3132
+ */
3133
+ setDataMode(
3134
+ /**
3135
+ * The mode to set to the Card.
3136
+ */
3137
+ sMode: CardDataMode | keyof typeof CardDataMode
3138
+ ): this;
3139
+ /**
3140
+ * @SINCE 1.109
3141
+ * @EXPERIMENTAL (since 1.109)
3142
+ *
3143
+ * Sets a new value for property {@link #getDesign design}.
3144
+ *
3145
+ * Defines the design of the `Card`.
3146
+ *
3147
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3148
+ *
3149
+ * Default value is `Solid`.
3150
+ *
3151
+ * @returns Reference to `this` in order to allow method chaining
3152
+ */
3153
+ setDesign(
3154
+ /**
3155
+ * New value for property `design`
3156
+ */
3157
+ sDesign?: CardDesign | keyof typeof CardDesign
3158
+ ): this;
3159
+ /**
3160
+ * Sets the associated {@link #getHost host}.
3161
+ *
3162
+ * @returns Reference to `this` in order to allow method chaining
3163
+ */
3164
+ setHost(
3165
+ /**
3166
+ * ID of an element which becomes the new target of this host association; alternatively, an element instance
3167
+ * may be given
3168
+ */
3169
+ oHost: ID | Control
3170
+ ): this;
3171
+ /**
3172
+ * Sets a new value for property {@link #getManifest manifest}.
3173
+ *
3174
+ * The URL of the manifest or an object.
3175
+ *
3176
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3177
+ *
3178
+ * Default value is `empty string`.
3179
+ *
3180
+ * @returns Reference to `this` in order to allow method chaining
3181
+ */
3182
+ setManifest(
3183
+ /**
3184
+ * New value for property `manifest`
3185
+ */
3186
+ oManifest?: any
3187
+ ): this;
3188
+ /**
3189
+ * @SINCE 1.76
3190
+ * @EXPERIMENTAL (since 1.76) - This API might be removed when a permanent solution for flexibility changes
3191
+ * is implemented.
3192
+ *
3193
+ * Sets a new value for property {@link #getManifestChanges manifestChanges}.
3194
+ *
3195
+ * Defines a list of configuration settings, which will be merged into the original manifest.
3196
+ *
3197
+ * This can be a list of flexibility changes generated during designtime.
3198
+ *
3199
+ * Each item in the array represents a separate level of changes. For example, the first item might be created
3200
+ * by an administrator, the second by a page administrator and the third by the end user.
3201
+ *
3202
+ * The order of the items is the order in which the changes will be merged on top of each other. So the
3203
+ * last item will overwrite the previous items where the paths match.
3204
+ *
3205
+ * Example:
3206
+ * ```javascript
3207
+ *
3208
+ * [
3209
+ * {
3210
+ * // Administrator
3211
+ * "/sap.card/header/title": "My Configured Title in Default Language",
3212
+ * "/sap.card/content/maxItems": 10,
3213
+ * "texts": {
3214
+ * "en-US": {
3215
+ * "/sap.card/header/title": "My Configured Title in US-English"
3216
+ * }
3217
+ * }
3218
+ * },
3219
+ * {
3220
+ * // Page administrator
3221
+ * "/sap.card/content/maxItems": 5
3222
+ * },
3223
+ * {
3224
+ * // End user
3225
+ * "/sap.card/header/title": "Title by End User",
3226
+ * "/sap.card/content/maxItems": 8
3227
+ * }
3228
+ * ]
3229
+ * ```
3230
+ *
3231
+ *
3232
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3233
+ *
3234
+ * @returns Reference to `this` in order to allow method chaining
3235
+ */
3236
+ setManifestChanges(
3237
+ /**
3238
+ * New value for property `manifestChanges`
3239
+ */
3240
+ sManifestChanges: object[]
3241
+ ): this;
3242
+ /**
3243
+ * @SINCE 1.112
3244
+ * @EXPERIMENTAL (since 1.112)
3245
+ *
3246
+ * Sets a new value for property {@link #getPreviewMode previewMode}.
3247
+ *
3248
+ * Preview mode of the `Card`. Helpful in scenarios when the end user is choosing or configuring a card.
3249
+ *
3250
+ * - When set to "MockData", the card data is loaded, using a data request, as configured in the "data/mockData"
3251
+ * in the manifest. If such configuration is missing, then the real data is loaded.
3252
+ * - When set to "Abstract", the card shows abstract placeholder without loading data.
3253
+ * - When set to "Off", the card displays real data.
3254
+ *
3255
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3256
+ *
3257
+ * Default value is `Off`.
3258
+ *
3259
+ * @returns Reference to `this` in order to allow method chaining
3260
+ */
3261
+ setPreviewMode(
3262
+ /**
3263
+ * New value for property `previewMode`
3264
+ */
3265
+ sPreviewMode?: CardPreviewMode | keyof typeof CardPreviewMode
3266
+ ): this;
3267
+ /**
3268
+ * Sets a new value for property {@link #getReferenceId referenceId}.
3269
+ *
3270
+ * Optional property which can be used by the host to reference the card. It will be forwarded to any children
3271
+ * cards. Does not affect the card behavior.
3272
+ *
3273
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3274
+ *
3275
+ * Default value is `empty string`.
3276
+ *
3277
+ * @returns Reference to `this` in order to allow method chaining
3278
+ */
3279
+ setReferenceId(
3280
+ /**
3281
+ * New value for property `referenceId`
3282
+ */
3283
+ sReferenceId?: string
3284
+ ): this;
3285
+ /**
3286
+ * Displays the loading placeholders on the whole card, or a particular area of the card. **Note:** Only
3287
+ * areas that contain binding will receive a loading placeholder.
3288
+ */
3289
+ showLoadingPlaceholders(
3290
+ /**
3291
+ * Area of the card to show the loading placeholders on. Possible options are 'Header', 'Content', 'Filters'.
3292
+ * Leave empty to show loading placeholders on all areas of the card.
3293
+ */
3294
+ eCardArea?: CardArea | keyof typeof CardArea
3295
+ ): void;
3296
+ /**
3297
+ * @EXPERIMENTAL (since 1.81)
3298
+ *
3299
+ * Displays a message strip above the content with the given text. There can be only 1 message displayed.
3300
+ * If there is a previous message, it is removed. Can be used only after the `manifestApplied` event is
3301
+ * fired.
3302
+ */
3303
+ showMessage(
3304
+ /**
3305
+ * The message.
3306
+ */
3307
+ sMessage: string,
3308
+ /**
3309
+ * Type of the message.
3310
+ */
3311
+ sType: MessageType | keyof typeof MessageType
3312
+ ): void;
3313
+ /**
3314
+ * @EXPERIMENTAL (since 1.84)
3315
+ *
3316
+ * Triggers an action inside the card.
3317
+ *
3318
+ * Use this method if you need to trigger an action programmatically from inside an `Extension` or from
3319
+ * a Component card.
3320
+ *
3321
+ * For other use cases use the manifest to define the actions. See {@link https://ui5.sap.com/test-resources/sap/ui/integration/demokit/cardExplorer/webapp/index.html#/learn/features/cardActions}
3322
+ *
3323
+ * Example:
3324
+ * ```javascript
3325
+ *
3326
+ * oCard.triggerAction({
3327
+ * type: "Navigation",
3328
+ * parameters: {
3329
+ * url: "...",
3330
+ * target: "_blank"
3331
+ * }
3332
+ * });
3333
+ * ```
3334
+ */
3335
+ triggerAction(
3336
+ /**
3337
+ * The settings of the action.
3338
+ */
3339
+ oAction: {
3340
+ /**
3341
+ * The type of the action.
3342
+ */
3343
+ type: CardActionType | keyof typeof CardActionType;
3344
+ /**
3345
+ * Additional parameters which will be used by the action handler to perform the action.
3346
+ */
3347
+ parameters?: object;
3348
+ }
3349
+ ): void;
3350
+ /**
3351
+ * @EXPERIMENTAL
3352
+ *
3353
+ * Causes all of the controls within the Card that support validation to validate their data.
3354
+ *
3355
+ * @returns if all of the controls validated successfully; otherwise, false
3356
+ */
3357
+ validateControls(): boolean;
3358
+ }
3359
+ /**
3360
+ * @EXPERIMENTAL (since 1.79)
3361
+ *
3362
+ * Facade of the {@link sap.ui.integration.widgets.Card} control.
3363
+ */
3364
+ export interface CardFacade {
3365
+ __implements__sap_ui_integration_widgets_CardFacade: boolean;
3366
+
3367
+ /**
3368
+ * @SINCE 1.85
3369
+ * @EXPERIMENTAL (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
3370
+ * may be done before its official public release. Use at your own discretion.
3371
+ *
3372
+ * Adds some actionDefinition to the aggregation {@link #getActionDefinitions actionDefinitions}.
3373
+ *
3374
+ * @returns Reference to `this` in order to allow method chaining
3375
+ */
3376
+ addActionDefinition(
3377
+ /**
3378
+ * The actionDefinition to add; if empty, nothing is inserted
3379
+ */
3380
+ oActionDefinition: ActionDefinition
3381
+ ): this;
3382
+ /**
3383
+ * @SINCE 1.70
3384
+ * @EXPERIMENTAL (since 1.70)
3385
+ *
3386
+ * Gets current value of property {@link #getBaseUrl baseUrl}.
3387
+ *
3388
+ * Defines the base URL of the Card Manifest. It should be used when manifest property is an object instead
3389
+ * of a URL.
3390
+ *
3391
+ * @returns Value of property `baseUrl`
3392
+ */
3393
+ getBaseUrl(): URI;
3394
+ /**
3395
+ * @EXPERIMENTAL (since 1.77)
3396
+ *
3397
+ * Gets values of manifest parameters combined with the parameters from `parameters` property.
3398
+ *
3399
+ * **Notes**
3400
+ *
3401
+ * - Use this method when the manifest is ready. Check `manifestReady` event.
3402
+ *
3403
+ * - Use when developing a Component card.
3404
+ *
3405
+ * @returns Object containing parameters in format `{parameterKey: parameterValue}`.
3406
+ */
3407
+ getCombinedParameters(): Record<string, any>;
3408
+ /**
3409
+ * @EXPERIMENTAL (since 1.77)
3410
+ *
3411
+ * Returns a value from the Manifest based on the specified path.
3412
+ *
3413
+ * **Note** Use this method when the manifest is ready. Check `manifestReady` event.
3414
+ *
3415
+ * @returns The value at the specified path.
3416
+ */
3417
+ getManifestEntry(
3418
+ /**
3419
+ * The path to return a value for.
3420
+ */
3421
+ sPath: string
3422
+ ): any;
3423
+ /**
3424
+ * @EXPERIMENTAL (since 1.65) - This property might be changed in future.
3425
+ *
3426
+ * Gets current value of property {@link #getParameters parameters}.
3427
+ *
3428
+ * Overrides the default values of the parameters, which are defined in the manifest. The value is an object
3429
+ * containing parameters in format `{parameterKey: parameterValue}`.
3430
+ *
3431
+ * @returns Value of property `parameters`
3432
+ */
3433
+ getParameters(): object;
3434
+ /**
3435
+ * @EXPERIMENTAL (since 1.83) - The API might change.
3436
+ *
3437
+ * Gets translated text from the i18n properties files configured for this card.
3438
+ *
3439
+ * For more details see {@link module:sap/base/i18n/ResourceBundle#getText}.
3440
+ *
3441
+ * @returns The value belonging to the key, if found; otherwise the key itself or `undefined` depending
3442
+ * on `bIgnoreKeyFallback`.
3443
+ */
3444
+ getTranslatedText(
3445
+ /**
3446
+ * Key to retrieve the text for
3447
+ */
3448
+ sKey: string,
3449
+ /**
3450
+ * List of parameter values which should replace the placeholders "{n}" (n is the index) in
3451
+ * the found locale-specific string value. Note that the replacement is done whenever `aArgs` is given,
3452
+ * no matter whether the text contains placeholders or not and no matter whether `aArgs` contains a value
3453
+ * for n or not.
3454
+ */
3455
+ aArgs?: string[],
3456
+ /**
3457
+ * If set, `undefined` is returned instead of the key string, when the key is not found in any bundle or
3458
+ * fallback bundle.
3459
+ */
3460
+ bIgnoreKeyFallback?: boolean
3461
+ ): string;
3462
+ /**
3463
+ * Hides the loading placeholders on the whole card, or a particular section of the card.
3464
+ */
3465
+ hideLoadingPlaceholders(
3466
+ /**
3467
+ * Area of the card to show the loading placeholders on. Possible options are 'Header', 'Content', 'Filters'.
3468
+ * Leave empty to hide loading placeholders on all areas of the card.
3469
+ */
3470
+ eCardArea?: CardArea | keyof typeof CardArea
3471
+ ): void;
3472
+ /**
3473
+ * @SINCE 1.85
3474
+ * @EXPERIMENTAL (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
3475
+ * may be done before its official public release. Use at your own discretion.
3476
+ *
3477
+ * Checks for the provided `sap.ui.integration.ActionDefinition` in the aggregation {@link #getActionDefinitions
3478
+ * actionDefinitions}. and returns its index if found or -1 otherwise.
3479
+ *
3480
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
3481
+ */
3482
+ indexOfActionDefinition(
3483
+ /**
3484
+ * The actionDefinition whose index is looked for
3485
+ */
3486
+ oActionDefinition: ActionDefinition
3487
+ ): int;
3488
+ /**
3489
+ * @SINCE 1.85
3490
+ * @EXPERIMENTAL (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
3491
+ * may be done before its official public release. Use at your own discretion.
3492
+ *
3493
+ * Inserts a actionDefinition into the aggregation {@link #getActionDefinitions actionDefinitions}.
3494
+ *
3495
+ * @returns Reference to `this` in order to allow method chaining
3496
+ */
3497
+ insertActionDefinition(
3498
+ /**
3499
+ * The actionDefinition to insert; if empty, nothing is inserted
3500
+ */
3501
+ oActionDefinition: ActionDefinition,
3502
+ /**
3503
+ * The `0`-based index the actionDefinition should be inserted at; for a negative value of `iIndex`, the
3504
+ * actionDefinition is inserted at position 0; for a value greater than the current size of the aggregation,
3505
+ * the actionDefinition is inserted at the last position
3506
+ */
3507
+ iIndex: int
3508
+ ): this;
3509
+ /**
3510
+ * @EXPERIMENTAL (since 1.65) - The API might change.
3511
+ *
3512
+ * Refreshes the card by re-applying the manifest settings and triggering all data requests.
3513
+ */
3514
+ refresh(): void;
3515
+ /**
3516
+ * @SINCE 1.95
3517
+ *
3518
+ * Refreshes the card data by triggering all data requests.
3519
+ */
3520
+ refreshData(): void;
3521
+ /**
3522
+ * @SINCE 1.85
3523
+ * @EXPERIMENTAL (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
3524
+ * may be done before its official public release. Use at your own discretion.
3525
+ *
3526
+ * Removes a actionDefinition from the aggregation {@link #getActionDefinitions actionDefinitions}.
3527
+ *
3528
+ * @returns The removed actionDefinition or `null`
3529
+ */
3530
+ removeActionDefinition(
3531
+ /**
3532
+ * The actionDefinition to remove or its index or id
3533
+ */
3534
+ vActionDefinition: int | string | ActionDefinition
3535
+ ): ActionDefinition | null;
3536
+ /**
3537
+ * @EXPERIMENTAL (since 1.79)
3538
+ *
3539
+ * Performs an HTTP request using the given configuration.
3540
+ *
3541
+ * @returns Resolves when the request is successful, rejects otherwise.
3542
+ */
3543
+ request(
3544
+ /**
3545
+ * The configuration of the request.
3546
+ */
3547
+ oConfiguration: {
3548
+ /**
3549
+ * The URL of the resource.
3550
+ */
3551
+ url: string;
3552
+ /**
3553
+ * The mode of the request. Possible values are "cors", "no-cors", "same-origin".
3554
+ */
3555
+ mode?: string;
3556
+ /**
3557
+ * The HTTP method. Possible values are "GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", and "HEAD".
3558
+ */
3559
+ method?: string;
3560
+ /**
3561
+ * The request parameters. If the HTTP method is "POST", "PUT", "PATCH", or "DELETE" the parameters will
3562
+ * be put as key/value pairs into the body of the request.
3563
+ */
3564
+ parameters?: object;
3565
+ /**
3566
+ * Deprecated. Use the correct Accept headers and correct Content-Type header in the response.
3567
+ */
3568
+ dataType?: string;
3569
+ /**
3570
+ * The HTTP headers of the request.
3571
+ */
3572
+ headers?: object;
3573
+ /**
3574
+ * Indicates whether cross-site requests should be made using credentials.
3575
+ */
3576
+ withCredentials?: boolean;
3577
+ }
3578
+ ): Promise<any>;
3579
+ /**
3580
+ * Resolves the destination and returns its URL.
3581
+ *
3582
+ * @returns A promise which resolves with the URL of the destination.
3583
+ */
3584
+ resolveDestination(
3585
+ /**
3586
+ * The destination's key used in the configuration.
3587
+ */
3588
+ sKey: string
3589
+ ): Promise<string>;
3590
+ /**
3591
+ * Displays the loading placeholders on the whole card, or a particular area of the card. **Note:** Only
3592
+ * areas that contain binding will receive a loading placeholder.
3593
+ */
3594
+ showLoadingPlaceholders(
3595
+ /**
3596
+ * Area of the card to show the loading placeholders on. Possible options are 'Header', 'Content', 'Filters'.
3597
+ * Leave empty to show loading placeholders on all areas of the card.
3598
+ */
3599
+ eCardArea?: CardArea | keyof typeof CardArea
3600
+ ): void;
3601
+ /**
3602
+ * @EXPERIMENTAL (since 1.81)
3603
+ *
3604
+ * Displays a message strip above the content with the given text. There can be only 1 message displayed.
3605
+ * If there is a previous message, it is removed. Can be used only after the `manifestApplied` event is
3606
+ * fired.
3607
+ */
3608
+ showMessage(
3609
+ /**
3610
+ * The message.
3611
+ */
3612
+ sMessage: string,
3613
+ /**
3614
+ * Type of the message.
3615
+ */
3616
+ sType: MessageType | keyof typeof MessageType
3617
+ ): void;
3618
+ /**
3619
+ * @EXPERIMENTAL (since 1.84)
3620
+ *
3621
+ * Triggers an action inside the card.
3622
+ *
3623
+ * Use this method if you need to trigger an action programmatically from inside an `Extension` or from
3624
+ * a Component card.
3625
+ *
3626
+ * For other use cases use the manifest to define the actions. See {@link https://ui5.sap.com/test-resources/sap/ui/integration/demokit/cardExplorer/webapp/index.html#/learn/features/cardActions}
3627
+ *
3628
+ * Example:
3629
+ * ```javascript
3630
+ *
3631
+ * oCard.triggerAction({
3632
+ * type: "Navigation",
3633
+ * parameters: {
3634
+ * url: "...",
3635
+ * target: "_blank"
3636
+ * }
3637
+ * });
3638
+ * ```
3639
+ */
3640
+ triggerAction(
3641
+ /**
3642
+ * The settings of the action.
3643
+ */
3644
+ oAction: {
3645
+ /**
3646
+ * The type of the action.
3647
+ */
3648
+ type: CardActionType | keyof typeof CardActionType;
3649
+ /**
3650
+ * Additional parameters which will be used by the action handler to perform the action.
3651
+ */
3652
+ parameters?: object;
3653
+ }
3654
+ ): void;
3655
+ /**
3656
+ * @EXPERIMENTAL
3657
+ *
3658
+ * Causes all of the controls within the Card that support validation to validate their data.
3659
+ *
3660
+ * @returns if all of the controls validated successfully; otherwise, false
3661
+ */
3662
+ validateControls(): boolean;
3663
+ }
3664
+
3665
+ export interface $CardSettings extends $CardBaseSettings {
3666
+ /**
3667
+ * Optional property which can be used by the host to reference the card. It will be forwarded to any children
3668
+ * cards. Does not affect the card behavior.
3669
+ */
3670
+ referenceId?: string | PropertyBindingInfo;
3671
+
3672
+ /**
3673
+ * The URL of the manifest or an object.
3674
+ */
3675
+ manifest?: any | PropertyBindingInfo | `{${string}}`;
3676
+
3677
+ /**
3678
+ * @EXPERIMENTAL (since 1.65) - This property might be changed in future.
3679
+ *
3680
+ * Overrides the default values of the parameters, which are defined in the manifest. The value is an object
3681
+ * containing parameters in format `{parameterKey: parameterValue}`.
3682
+ */
3683
+ parameters?: object | PropertyBindingInfo | `{${string}}`;
3684
+
3685
+ /**
3686
+ * @SINCE 1.65
3687
+ * @EXPERIMENTAL (since 1.65)
3688
+ *
3689
+ * Defines the state of the `Card`. When set to `Inactive`, the `Card` doesn't make requests.
3690
+ */
3691
+ dataMode?:
3692
+ | (CardDataMode | keyof typeof CardDataMode)
3693
+ | PropertyBindingInfo
3694
+ | `{${string}}`;
3695
+
3696
+ /**
3697
+ * @SINCE 1.70
3698
+ * @EXPERIMENTAL (since 1.70)
3699
+ *
3700
+ * Defines the base URL of the Card Manifest. It should be used when manifest property is an object instead
3701
+ * of a URL.
3702
+ */
3703
+ baseUrl?: URI | PropertyBindingInfo | `{${string}}`;
3704
+
3705
+ /**
3706
+ * @SINCE 1.76
3707
+ * @EXPERIMENTAL (since 1.76) - This API might be removed when a permanent solution for flexibility changes
3708
+ * is implemented.
3709
+ *
3710
+ * Defines a list of configuration settings, which will be merged into the original manifest.
3711
+ *
3712
+ * This can be a list of flexibility changes generated during designtime.
3713
+ *
3714
+ * Each item in the array represents a separate level of changes. For example, the first item might be created
3715
+ * by an administrator, the second by a page administrator and the third by the end user.
3716
+ *
3717
+ * The order of the items is the order in which the changes will be merged on top of each other. So the
3718
+ * last item will overwrite the previous items where the paths match.
3719
+ *
3720
+ * Example:
3721
+ * ```javascript
3722
+ *
3723
+ * [
3724
+ * {
3725
+ * // Administrator
3726
+ * "/sap.card/header/title": "My Configured Title in Default Language",
3727
+ * "/sap.card/content/maxItems": 10,
3728
+ * "texts": {
3729
+ * "en-US": {
3730
+ * "/sap.card/header/title": "My Configured Title in US-English"
3731
+ * }
3732
+ * }
3733
+ * },
3734
+ * {
3735
+ * // Page administrator
3736
+ * "/sap.card/content/maxItems": 5
3737
+ * },
3738
+ * {
3739
+ * // End user
3740
+ * "/sap.card/header/title": "Title by End User",
3741
+ * "/sap.card/content/maxItems": 8
3742
+ * }
3743
+ * ]
3744
+ * ```
3745
+ */
3746
+ manifestChanges?: object[] | PropertyBindingInfo | `{${string}}`;
3747
+
3748
+ /**
3749
+ * @SINCE 1.109
3750
+ * @EXPERIMENTAL (since 1.109)
3751
+ *
3752
+ * Defines the design of the `Card`.
3753
+ */
3754
+ design?:
3755
+ | (CardDesign | keyof typeof CardDesign)
3756
+ | PropertyBindingInfo
3757
+ | `{${string}}`;
3758
+
3759
+ /**
3760
+ * @SINCE 1.112
3761
+ * @EXPERIMENTAL (since 1.112)
3762
+ *
3763
+ * Preview mode of the `Card`. Helpful in scenarios when the end user is choosing or configuring a card.
3764
+ *
3765
+ * - When set to "MockData", the card data is loaded, using a data request, as configured in the "data/mockData"
3766
+ * in the manifest. If such configuration is missing, then the real data is loaded.
3767
+ * - When set to "Abstract", the card shows abstract placeholder without loading data.
3768
+ * - When set to "Off", the card displays real data.
3769
+ */
3770
+ previewMode?:
3771
+ | (CardPreviewMode | keyof typeof CardPreviewMode)
3772
+ | PropertyBindingInfo
3773
+ | `{${string}}`;
3774
+
3775
+ /**
3776
+ * @SINCE 1.85
3777
+ * @EXPERIMENTAL (since 1.85) - Disclaimer: this aggregation is in a beta state - incompatible API changes
3778
+ * may be done before its official public release. Use at your own discretion.
3779
+ *
3780
+ * Actions definitions from which actions in the header menu of the card are created. **Note**: This aggregation
3781
+ * is destroyed when the property `manifest` changes.
3782
+ */
3783
+ actionDefinitions?:
3784
+ | ActionDefinition[]
3785
+ | ActionDefinition
3786
+ | AggregationBindingInfo
3787
+ | `{${string}}`;
3788
+
3789
+ /**
3790
+ * The host.
3791
+ */
3792
+ host?: Control | string;
3793
+
3794
+ /**
3795
+ * @EXPERIMENTAL (since 1.64) - Disclaimer: this event is in a beta state - incompatible API changes may
3796
+ * be done before its official public release. Use at your own discretion.
3797
+ *
3798
+ * Fired when an action is triggered on the card.
3799
+ *
3800
+ * When an action is triggered in the card it can be handled on several places by "action" event handlers.
3801
+ * In consecutive order those places are: `Extension`, `Card`, `Host`. Each of them can prevent the next
3802
+ * one to handle the action by calling `oEvent.preventDefault()`.
3803
+ */
3804
+ action?: (oEvent: Event) => void;
3805
+
3806
+ /**
3807
+ * @EXPERIMENTAL (since 1.96)
3808
+ *
3809
+ * Fired when some configuration settings are changed as a result of user interaction. For example - filter
3810
+ * value is changed.
3811
+ */
3812
+ configurationChange?: (oEvent: Event) => void;
3813
+
3814
+ /**
3815
+ * @EXPERIMENTAL (since 1.72)
3816
+ *
3817
+ * Fired when the manifest is loaded.
3818
+ */
3819
+ manifestReady?: (oEvent: Event) => void;
3820
+
3821
+ /**
3822
+ * Fired when card utilities (like `DataProviderFactory`) and the card elements (like header) are created
3823
+ * and initialized.
3824
+ *
3825
+ * Note: The card's content may not be available yet because it may depend on other resources to load.
3826
+ */
3827
+ manifestApplied?: (oEvent: Event) => void;
3828
+
3829
+ /**
3830
+ * @EXPERIMENTAL (since 1.107)
3831
+ *
3832
+ * Fired when the state of the card is changed. For example - the card is ready, new page is selected, a
3833
+ * filter is changed or data is refreshed.
3834
+ */
3835
+ stateChanged?: (oEvent: Event) => void;
3836
+ }
3837
+ }
3838
+
3839
+ declare namespace sap {
3840
+ namespace ui {
3841
+ /**
3842
+ * @SINCE 1.62
3843
+ *
3844
+ * SAPUI5 library with controls specialized for SAP Fiori apps.
3845
+ */
3846
+ namespace integration {
3847
+ namespace designtime {
3848
+ namespace baseEditor {
3849
+ namespace propertyEditor {
3850
+ namespace iconEditor {
3851
+ /**
3852
+ * @SINCE 1.81
3853
+ * @EXPERIMENTAL - 1.81
3854
+ *
3855
+ * Validates if the provided value belongs to the icon pool.
3856
+ */
3857
+ namespace IsInIconPool {
3858
+ /**
3859
+ * Validator function
3860
+ *
3861
+ * @returns Validation result
3862
+ */
3863
+ function validate(
3864
+ /**
3865
+ * Value to validate
3866
+ */
3867
+ vValue: boolean | string
3868
+ ): boolean;
3869
+ }
3870
+ }
3871
+ }
3872
+ }
3873
+ }
3874
+ }
3875
+ }
3876
+
3877
+ interface IUI5DefineDependencyNames {
3878
+ "sap/ui/integration/ActionDefinition": undefined;
3879
+
3880
+ "sap/ui/integration/Designtime": undefined;
3881
+
3882
+ "sap/ui/integration/designtime/baseEditor/BaseEditor": undefined;
3883
+
3884
+ "sap/ui/integration/designtime/baseEditor/layout/Form": undefined;
3885
+
3886
+ "sap/ui/integration/designtime/baseEditor/PropertyEditor": undefined;
3887
+
3888
+ "sap/ui/integration/designtime/baseEditor/propertyEditor/arrayEditor/ArrayEditor": undefined;
3889
+
3890
+ "sap/ui/integration/designtime/baseEditor/propertyEditor/BasePropertyEditor": undefined;
3891
+
3892
+ "sap/ui/integration/designtime/baseEditor/propertyEditor/booleanEditor/BooleanEditor": undefined;
3893
+
3894
+ "sap/ui/integration/designtime/baseEditor/propertyEditor/codeEditor/CodeEditor": undefined;
3895
+
3896
+ "sap/ui/integration/designtime/baseEditor/propertyEditor/dateEditor/DateEditor": undefined;
3897
+
3898
+ "sap/ui/integration/designtime/baseEditor/propertyEditor/dateTimeEditor/DateTimeEditor": undefined;
3899
+
3900
+ "sap/ui/integration/designtime/baseEditor/propertyEditor/enumStringEditor/EnumStringEditor": undefined;
3901
+
3902
+ "sap/ui/integration/designtime/baseEditor/propertyEditor/groupEditor/GroupEditor": undefined;
3903
+
3904
+ "sap/ui/integration/designtime/baseEditor/propertyEditor/iconEditor/IconEditor": undefined;
3905
+
3906
+ "sap/ui/integration/designtime/baseEditor/propertyEditor/integerEditor/IntegerEditor": undefined;
3907
+
3908
+ "sap/ui/integration/designtime/baseEditor/propertyEditor/jsonEditor/JsonEditor": undefined;
3909
+
3910
+ "sap/ui/integration/designtime/baseEditor/propertyEditor/listEditor/ListEditor": undefined;
3911
+
3912
+ "sap/ui/integration/designtime/baseEditor/propertyEditor/mapEditor/MapEditor": undefined;
3913
+
3914
+ "sap/ui/integration/designtime/baseEditor/propertyEditor/multiSelectEditor/MultiSelectEditor": undefined;
3915
+
3916
+ "sap/ui/integration/designtime/baseEditor/propertyEditor/numberEditor/NumberEditor": undefined;
3917
+
3918
+ "sap/ui/integration/designtime/baseEditor/propertyEditor/objectArrayEditor/ObjectArrayEditor": undefined;
3919
+
3920
+ "sap/ui/integration/designtime/baseEditor/propertyEditor/PropertyEditorFactory": undefined;
3921
+
3922
+ "sap/ui/integration/designtime/baseEditor/propertyEditor/selectEditor/SelectEditor": undefined;
3923
+
3924
+ "sap/ui/integration/designtime/baseEditor/propertyEditor/separatorEditor/SeparatorEditor": undefined;
3925
+
3926
+ "sap/ui/integration/designtime/baseEditor/propertyEditor/stringEditor/StringEditor": undefined;
3927
+
3928
+ "sap/ui/integration/designtime/baseEditor/propertyEditor/textAreaEditor/TextAreaEditor": undefined;
3929
+
3930
+ "sap/ui/integration/designtime/baseEditor/PropertyEditors": undefined;
3931
+
3932
+ "sap/ui/integration/designtime/baseEditor/util/unset": undefined;
3933
+
3934
+ "sap/ui/integration/designtime/baseEditor/validator/IsBoolean": undefined;
3935
+
3936
+ "sap/ui/integration/designtime/baseEditor/validator/IsDate": undefined;
3937
+
3938
+ "sap/ui/integration/designtime/baseEditor/validator/IsInteger": undefined;
3939
+
3940
+ "sap/ui/integration/designtime/baseEditor/validator/IsNumber": undefined;
3941
+
3942
+ "sap/ui/integration/designtime/baseEditor/validator/IsSelectedKey": undefined;
3943
+
3944
+ "sap/ui/integration/designtime/baseEditor/validator/IsStringList": undefined;
3945
+
3946
+ "sap/ui/integration/designtime/baseEditor/validator/IsUniqueKey": undefined;
3947
+
3948
+ "sap/ui/integration/designtime/baseEditor/validator/IsUniqueList": undefined;
3949
+
3950
+ "sap/ui/integration/designtime/baseEditor/validator/IsValidBinding": undefined;
3951
+
3952
+ "sap/ui/integration/designtime/baseEditor/validator/MaxLength": undefined;
3953
+
3954
+ "sap/ui/integration/designtime/baseEditor/validator/NotABinding": undefined;
3955
+
3956
+ "sap/ui/integration/designtime/baseEditor/validator/ValidatorRegistry": undefined;
3957
+
3958
+ "sap/ui/integration/designtime/cardEditor/propertyEditor/complexMapEditor/ComplexMapEditor": undefined;
3959
+
3960
+ "sap/ui/integration/designtime/cardEditor/propertyEditor/destinationsEditor/DestinationsEditor": undefined;
3961
+
3962
+ "sap/ui/integration/designtime/cardEditor/propertyEditor/filtersEditor/FiltersEditor": undefined;
3963
+
3964
+ "sap/ui/integration/designtime/cardEditor/propertyEditor/iconEditor/IconEditor": undefined;
3965
+
3966
+ "sap/ui/integration/designtime/cardEditor/propertyEditor/parametersEditor/ParametersEditor": undefined;
3967
+
3968
+ "sap/ui/integration/designtime/editor/CardPreview": undefined;
3969
+
3970
+ "sap/ui/integration/editor/Editor": undefined;
3971
+
3972
+ "sap/ui/integration/editor/Extension": undefined;
3973
+
3974
+ "sap/ui/integration/editor/fields/BaseField": undefined;
3975
+
3976
+ "sap/ui/integration/editor/fields/BooleanField": undefined;
3977
+
3978
+ "sap/ui/integration/editor/fields/DateField": undefined;
3979
+
3980
+ "sap/ui/integration/editor/fields/DateTimeField": undefined;
3981
+
3982
+ "sap/ui/integration/editor/fields/DestinationField": undefined;
3983
+
3984
+ "sap/ui/integration/editor/fields/fragment/Controller": undefined;
3985
+
3986
+ "sap/ui/integration/editor/fields/GroupField": undefined;
3987
+
3988
+ "sap/ui/integration/editor/fields/IntegerField": undefined;
3989
+
3990
+ "sap/ui/integration/editor/fields/NumberField": undefined;
3991
+
3992
+ "sap/ui/integration/editor/fields/ObjectField": undefined;
3993
+
3994
+ "sap/ui/integration/editor/fields/ObjectListField": undefined;
3995
+
3996
+ "sap/ui/integration/editor/fields/StringField": undefined;
3997
+
3998
+ "sap/ui/integration/editor/fields/StringListField": undefined;
3999
+
4000
+ "sap/ui/integration/editor/fields/viz/ColorSelect": undefined;
4001
+
4002
+ "sap/ui/integration/editor/fields/viz/IconSelect": undefined;
4003
+
4004
+ "sap/ui/integration/editor/fields/viz/ShapeSelect": undefined;
4005
+
4006
+ "sap/ui/integration/editor/fields/viz/VizBase": undefined;
4007
+
4008
+ "sap/ui/integration/editor/Settings": undefined;
4009
+
4010
+ "sap/ui/integration/Extension": undefined;
4011
+
4012
+ "sap/ui/integration/Host": undefined;
4013
+
4014
+ "sap/ui/integration/library": undefined;
4015
+
4016
+ "sap/ui/integration/services/Service": undefined;
4017
+
4018
+ "sap/ui/integration/util/CsrfTokenHandler": undefined;
4019
+
4020
+ "sap/ui/integration/util/DataProvider": undefined;
4021
+
4022
+ "sap/ui/integration/util/DataProviderFactory": undefined;
4023
+
4024
+ "sap/ui/integration/util/ManifestResolver": undefined;
4025
+
4026
+ "sap/ui/integration/util/RequestDataProvider": undefined;
4027
+
4028
+ "sap/ui/integration/util/SkeletonCard": undefined;
4029
+
4030
+ "sap/ui/integration/widgets/Card": undefined;
4031
+ }
4032
+ }