@openui5/ts-types-esm 1.100.0 → 1.102.1

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.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.100.0
1
+ // For Library Version: 1.102.1
2
2
 
3
3
  declare module "sap/ui/integration/library" {
4
4
  import { URI } from "sap/ui/core/library";
@@ -29,7 +29,7 @@ declare module "sap/ui/integration/library" {
29
29
  /**
30
30
  * @EXPERIMENTAL (since 1.76)
31
31
  *
32
- * Used for custom actions
32
+ * Used for custom actions.
33
33
  */
34
34
  Custom = "Custom",
35
35
  /**
@@ -51,7 +51,7 @@ declare module "sap/ui/integration/library" {
51
51
  */
52
52
  MonthChange = "MonthChange",
53
53
  /**
54
- * Used for navigation actions
54
+ * Used for navigation actions.
55
55
  */
56
56
  Navigation = "Navigation",
57
57
  /**
@@ -61,7 +61,7 @@ declare module "sap/ui/integration/library" {
61
61
  */
62
62
  ShowCard = "ShowCard",
63
63
  /**
64
- * Used for submit actions
64
+ * Used for submit actions.
65
65
  */
66
66
  Submit = "Submit",
67
67
  }
@@ -208,6 +208,8 @@ declare module "sap/ui/integration/ActionDefinition" {
208
208
  * it with the information contained in `oClassInfo`.
209
209
  *
210
210
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
211
+ *
212
+ * @returns Created class / constructor function
211
213
  */
212
214
  static extend<T extends Record<string, unknown>>(
213
215
  /**
@@ -226,6 +228,8 @@ declare module "sap/ui/integration/ActionDefinition" {
226
228
  ): Function;
227
229
  /**
228
230
  * Returns a metadata object for class sap.ui.integration.ActionDefinition.
231
+ *
232
+ * @returns Metadata object describing this class
229
233
  */
230
234
  static getMetadata(): ElementMetadata;
231
235
  /**
@@ -235,6 +239,8 @@ declare module "sap/ui/integration/ActionDefinition" {
235
239
  * otherwise it will be bound to this `sap.ui.integration.ActionDefinition` itself.
236
240
  *
237
241
  * Fired when the action button is pressed.
242
+ *
243
+ * @returns Reference to `this` in order to allow method chaining
238
244
  */
239
245
  attachPress(
240
246
  /**
@@ -259,6 +265,8 @@ declare module "sap/ui/integration/ActionDefinition" {
259
265
  * otherwise it will be bound to this `sap.ui.integration.ActionDefinition` itself.
260
266
  *
261
267
  * Fired when the action button is pressed.
268
+ *
269
+ * @returns Reference to `this` in order to allow method chaining
262
270
  */
263
271
  attachPress(
264
272
  /**
@@ -275,6 +283,8 @@ declare module "sap/ui/integration/ActionDefinition" {
275
283
  * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.ui.integration.ActionDefinition`.
276
284
  *
277
285
  * The passed function and listener object must match the ones used for event registration.
286
+ *
287
+ * @returns Reference to `this` in order to allow method chaining
278
288
  */
279
289
  detachPress(
280
290
  /**
@@ -288,6 +298,8 @@ declare module "sap/ui/integration/ActionDefinition" {
288
298
  ): this;
289
299
  /**
290
300
  * Fires event {@link #event:press press} to attached listeners.
301
+ *
302
+ * @returns Reference to `this` in order to allow method chaining
291
303
  */
292
304
  firePress(
293
305
  /**
@@ -301,6 +313,8 @@ declare module "sap/ui/integration/ActionDefinition" {
301
313
  * The type of the action button.
302
314
  *
303
315
  * Default value is `Transparent`.
316
+ *
317
+ * @returns Value of property `buttonType`
304
318
  */
305
319
  getButtonType(): ButtonType | keyof typeof ButtonType;
306
320
  /**
@@ -310,18 +324,24 @@ declare module "sap/ui/integration/ActionDefinition" {
310
324
  * be focused and they are out of the navigation tab-chain.
311
325
  *
312
326
  * Default value is `true`.
327
+ *
328
+ * @returns Value of property `enabled`
313
329
  */
314
330
  getEnabled(): boolean;
315
331
  /**
316
332
  * Gets current value of property {@link #getIcon icon}.
317
333
  *
318
334
  * The icon of the action button.
335
+ *
336
+ * @returns Value of property `icon`
319
337
  */
320
338
  getIcon(): URI;
321
339
  /**
322
340
  * Gets current value of property {@link #getParameters parameters}.
323
341
  *
324
342
  * The parameters of the action.
343
+ *
344
+ * @returns Value of property `parameters`
325
345
  */
326
346
  getParameters(): object;
327
347
  /**
@@ -330,12 +350,16 @@ declare module "sap/ui/integration/ActionDefinition" {
330
350
  * The text of the action button.
331
351
  *
332
352
  * Default value is `empty string`.
353
+ *
354
+ * @returns Value of property `text`
333
355
  */
334
356
  getText(): string;
335
357
  /**
336
358
  * Gets current value of property {@link #getType type}.
337
359
  *
338
360
  * The type of the action.
361
+ *
362
+ * @returns Value of property `type`
339
363
  */
340
364
  getType(): CardActionType | keyof typeof CardActionType;
341
365
  /**
@@ -344,6 +368,8 @@ declare module "sap/ui/integration/ActionDefinition" {
344
368
  * Whether the action button should be visible on the screen.
345
369
  *
346
370
  * Default value is `true`.
371
+ *
372
+ * @returns Value of property `visible`
347
373
  */
348
374
  getVisible(): boolean;
349
375
  /**
@@ -354,6 +380,8 @@ declare module "sap/ui/integration/ActionDefinition" {
354
380
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
355
381
  *
356
382
  * Default value is `Transparent`.
383
+ *
384
+ * @returns Reference to `this` in order to allow method chaining
357
385
  */
358
386
  setButtonType(
359
387
  /**
@@ -370,6 +398,8 @@ declare module "sap/ui/integration/ActionDefinition" {
370
398
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
371
399
  *
372
400
  * Default value is `true`.
401
+ *
402
+ * @returns Reference to `this` in order to allow method chaining
373
403
  */
374
404
  setEnabled(
375
405
  /**
@@ -383,6 +413,8 @@ declare module "sap/ui/integration/ActionDefinition" {
383
413
  * The icon of the action button.
384
414
  *
385
415
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
416
+ *
417
+ * @returns Reference to `this` in order to allow method chaining
386
418
  */
387
419
  setIcon(
388
420
  /**
@@ -396,6 +428,8 @@ declare module "sap/ui/integration/ActionDefinition" {
396
428
  * The parameters of the action.
397
429
  *
398
430
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
431
+ *
432
+ * @returns Reference to `this` in order to allow method chaining
399
433
  */
400
434
  setParameters(
401
435
  /**
@@ -411,6 +445,8 @@ declare module "sap/ui/integration/ActionDefinition" {
411
445
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
412
446
  *
413
447
  * Default value is `empty string`.
448
+ *
449
+ * @returns Reference to `this` in order to allow method chaining
414
450
  */
415
451
  setText(
416
452
  /**
@@ -424,6 +460,8 @@ declare module "sap/ui/integration/ActionDefinition" {
424
460
  * The type of the action.
425
461
  *
426
462
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
463
+ *
464
+ * @returns Reference to `this` in order to allow method chaining
427
465
  */
428
466
  setType(
429
467
  /**
@@ -439,6 +477,8 @@ declare module "sap/ui/integration/ActionDefinition" {
439
477
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
440
478
  *
441
479
  * Default value is `true`.
480
+ *
481
+ * @returns Reference to `this` in order to allow method chaining
442
482
  */
443
483
  setVisible(
444
484
  /**
@@ -452,7 +492,10 @@ declare module "sap/ui/integration/ActionDefinition" {
452
492
  /**
453
493
  * The type of the action.
454
494
  */
455
- type?: (CardActionType | keyof typeof CardActionType) | PropertyBindingInfo;
495
+ type?:
496
+ | (CardActionType | keyof typeof CardActionType)
497
+ | PropertyBindingInfo
498
+ | `{${string}}`;
456
499
 
457
500
  /**
458
501
  * The text of the action button.
@@ -462,28 +505,31 @@ declare module "sap/ui/integration/ActionDefinition" {
462
505
  /**
463
506
  * The icon of the action button.
464
507
  */
465
- icon?: URI | PropertyBindingInfo;
508
+ icon?: URI | PropertyBindingInfo | `{${string}}`;
466
509
 
467
510
  /**
468
511
  * The type of the action button.
469
512
  */
470
- buttonType?: (ButtonType | keyof typeof ButtonType) | PropertyBindingInfo;
513
+ buttonType?:
514
+ | (ButtonType | keyof typeof ButtonType)
515
+ | PropertyBindingInfo
516
+ | `{${string}}`;
471
517
 
472
518
  /**
473
519
  * Indicates whether the user can interact with the action button or not. **Note**: Disabled controls cannot
474
520
  * be focused and they are out of the navigation tab-chain.
475
521
  */
476
- enabled?: boolean | PropertyBindingInfo;
522
+ enabled?: boolean | PropertyBindingInfo | `{${string}}`;
477
523
 
478
524
  /**
479
525
  * Whether the action button should be visible on the screen.
480
526
  */
481
- visible?: boolean | PropertyBindingInfo;
527
+ visible?: boolean | PropertyBindingInfo | `{${string}}`;
482
528
 
483
529
  /**
484
530
  * The parameters of the action.
485
531
  */
486
- parameters?: object | PropertyBindingInfo;
532
+ parameters?: object | PropertyBindingInfo | `{${string}}`;
487
533
 
488
534
  /**
489
535
  * Fired when the action button is pressed.
@@ -552,6 +598,8 @@ declare module "sap/ui/integration/Designtime" {
552
598
  * with the information contained in `oClassInfo`.
553
599
  *
554
600
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.ManagedObject.extend}.
601
+ *
602
+ * @returns Created class / constructor function
555
603
  */
556
604
  static extend<T extends Record<string, unknown>>(
557
605
  /**
@@ -570,10 +618,14 @@ declare module "sap/ui/integration/Designtime" {
570
618
  ): Function;
571
619
  /**
572
620
  * Returns a metadata object for class sap.ui.integration.Designtime.
621
+ *
622
+ * @returns Metadata object describing this class
573
623
  */
574
624
  static getMetadata(): ManagedObjectMetadata;
575
625
  /**
576
626
  * Returns an interface to the card, which uses this extension.
627
+ *
628
+ * @returns An interface to the card.
577
629
  */
578
630
  getCard(): CardFacade;
579
631
  }
@@ -591,6 +643,8 @@ declare module "sap/ui/integration/designtime/baseEditor/validator/IsBoolean" {
591
643
  interface IsBoolean {
592
644
  /**
593
645
  * Validator function
646
+ *
647
+ * @returns Validation result
594
648
  */
595
649
  validate(
596
650
  /**
@@ -613,6 +667,8 @@ declare module "sap/ui/integration/designtime/baseEditor/validator/IsDate" {
613
667
  interface IsDate {
614
668
  /**
615
669
  * Validator function
670
+ *
671
+ * @returns Validation result
616
672
  */
617
673
  validate(
618
674
  /**
@@ -635,6 +691,8 @@ declare module "sap/ui/integration/designtime/baseEditor/validator/IsInteger" {
635
691
  interface IsInteger {
636
692
  /**
637
693
  * Validator function
694
+ *
695
+ * @returns Validation result
638
696
  */
639
697
  validate(
640
698
  /**
@@ -657,6 +715,8 @@ declare module "sap/ui/integration/designtime/baseEditor/validator/IsNumber" {
657
715
  interface IsNumber {
658
716
  /**
659
717
  * Validator function
718
+ *
719
+ * @returns Validation result
660
720
  */
661
721
  validate(
662
722
  /**
@@ -679,6 +739,8 @@ declare module "sap/ui/integration/designtime/baseEditor/validator/IsSelectedKey
679
739
  interface IsSelectedKey {
680
740
  /**
681
741
  * Validator function
742
+ *
743
+ * @returns Validation result
682
744
  */
683
745
  validate(
684
746
  /**
@@ -710,6 +772,8 @@ declare module "sap/ui/integration/designtime/baseEditor/validator/IsStringList"
710
772
  interface IsStringList {
711
773
  /**
712
774
  * Validator function
775
+ *
776
+ * @returns Validation result
713
777
  */
714
778
  validate(
715
779
  /**
@@ -732,6 +796,8 @@ declare module "sap/ui/integration/designtime/baseEditor/validator/IsUniqueKey"
732
796
  interface IsUniqueKey {
733
797
  /**
734
798
  * Validator function
799
+ *
800
+ * @returns Validation result
735
801
  */
736
802
  validate(
737
803
  /**
@@ -767,6 +833,8 @@ declare module "sap/ui/integration/designtime/baseEditor/validator/IsUniqueList"
767
833
  interface IsUniqueList {
768
834
  /**
769
835
  * Validator function
836
+ *
837
+ * @returns Validation result
770
838
  */
771
839
  validate(
772
840
  /**
@@ -789,6 +857,8 @@ declare module "sap/ui/integration/designtime/baseEditor/validator/IsValidBindin
789
857
  interface IsValidBinding {
790
858
  /**
791
859
  * Validator function
860
+ *
861
+ * @returns Validation result
792
862
  */
793
863
  validate(
794
864
  /**
@@ -820,6 +890,8 @@ declare module "sap/ui/integration/designtime/baseEditor/validator/MaxLength" {
820
890
  interface MaxLength {
821
891
  /**
822
892
  * Validator function
893
+ *
894
+ * @returns Validation result
823
895
  */
824
896
  validate(
825
897
  /**
@@ -842,6 +914,8 @@ declare module "sap/ui/integration/designtime/baseEditor/validator/NotABinding"
842
914
  interface NotABinding {
843
915
  /**
844
916
  * Validator function
917
+ *
918
+ * @returns Validation result
845
919
  */
846
920
  validate(
847
921
  /**
@@ -867,6 +941,8 @@ declare module "sap/ui/integration/editor/Editor" {
867
941
  * @EXPERIMENTAL (since 1.94)
868
942
  *
869
943
  * Performs an HTTP request using the given configuration.
944
+ *
945
+ * @returns Resolves when the request is successful, rejects otherwise.
870
946
  */
871
947
  request(
872
948
  /**
@@ -963,6 +1039,8 @@ declare module "sap/ui/integration/editor/Extension" {
963
1039
  * it with the information contained in `oClassInfo`.
964
1040
  *
965
1041
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.ManagedObject.extend}.
1042
+ *
1043
+ * @returns Created class / constructor function
966
1044
  */
967
1045
  static extend<T extends Record<string, unknown>>(
968
1046
  /**
@@ -981,10 +1059,14 @@ declare module "sap/ui/integration/editor/Extension" {
981
1059
  ): Function;
982
1060
  /**
983
1061
  * Returns a metadata object for class sap.ui.integration.editor.Extension.
1062
+ *
1063
+ * @returns Metadata object describing this class
984
1064
  */
985
1065
  static getMetadata(): ManagedObjectMetadata;
986
1066
  /**
987
1067
  * Returns an interface to the editor, which uses this extension.
1068
+ *
1069
+ * @returns An interface to the card.
988
1070
  */
989
1071
  getEditor(): CardFacade;
990
1072
  /**
@@ -993,6 +1075,8 @@ declare module "sap/ui/integration/editor/Extension" {
993
1075
  * Gets current value of property {@link #getFormatters formatters}.
994
1076
  *
995
1077
  * The formatters, which can be used in the manifest.
1078
+ *
1079
+ * @returns Value of property `formatters`
996
1080
  */
997
1081
  getFormatters(): object;
998
1082
  /**
@@ -1007,7 +1091,7 @@ declare module "sap/ui/integration/editor/Extension" {
1007
1091
  *
1008
1092
  * The formatters, which can be used in the manifest.
1009
1093
  */
1010
- formatters?: object | PropertyBindingInfo;
1094
+ formatters?: object | PropertyBindingInfo | `{${string}}`;
1011
1095
  }
1012
1096
  }
1013
1097
 
@@ -1071,6 +1155,8 @@ declare module "sap/ui/integration/Extension" {
1071
1155
  * the information contained in `oClassInfo`.
1072
1156
  *
1073
1157
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.ManagedObject.extend}.
1158
+ *
1159
+ * @returns Created class / constructor function
1074
1160
  */
1075
1161
  static extend<T extends Record<string, unknown>>(
1076
1162
  /**
@@ -1089,6 +1175,8 @@ declare module "sap/ui/integration/Extension" {
1089
1175
  ): Function;
1090
1176
  /**
1091
1177
  * Returns a metadata object for class sap.ui.integration.Extension.
1178
+ *
1179
+ * @returns Metadata object describing this class
1092
1180
  */
1093
1181
  static getMetadata(): ManagedObjectMetadata;
1094
1182
  /**
@@ -1100,6 +1188,8 @@ declare module "sap/ui/integration/Extension" {
1100
1188
  * otherwise it will be bound to this `sap.ui.integration.Extension` itself.
1101
1189
  *
1102
1190
  * Fired when an action is triggered in the card.
1191
+ *
1192
+ * @returns Reference to `this` in order to allow method chaining
1103
1193
  */
1104
1194
  attachAction(
1105
1195
  /**
@@ -1125,6 +1215,8 @@ declare module "sap/ui/integration/Extension" {
1125
1215
  * otherwise it will be bound to this `sap.ui.integration.Extension` itself.
1126
1216
  *
1127
1217
  * Fired when an action is triggered in the card.
1218
+ *
1219
+ * @returns Reference to `this` in order to allow method chaining
1128
1220
  */
1129
1221
  attachAction(
1130
1222
  /**
@@ -1142,6 +1234,8 @@ declare module "sap/ui/integration/Extension" {
1142
1234
  * Detaches event handler `fnFunction` from the {@link #event:action action} event of this `sap.ui.integration.Extension`.
1143
1235
  *
1144
1236
  * The passed function and listener object must match the ones used for event registration.
1237
+ *
1238
+ * @returns Reference to `this` in order to allow method chaining
1145
1239
  */
1146
1240
  detachAction(
1147
1241
  /**
@@ -1160,6 +1254,8 @@ declare module "sap/ui/integration/Extension" {
1160
1254
  *
1161
1255
  * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
1162
1256
  * event object. The return value of this method indicates whether the default action should be executed.
1257
+ *
1258
+ * @returns Whether or not to prevent the default action
1163
1259
  */
1164
1260
  fireAction(
1165
1261
  /**
@@ -1195,10 +1291,14 @@ declare module "sap/ui/integration/Extension" {
1195
1291
  * Gets current value of property {@link #getActions actions}.
1196
1292
  *
1197
1293
  * The actions configuration.
1294
+ *
1295
+ * @returns Value of property `actions`
1198
1296
  */
1199
1297
  getActions(): CardMenuAction[];
1200
1298
  /**
1201
1299
  * Returns an interface to the card, which uses this extension.
1300
+ *
1301
+ * @returns An interface to the card.
1202
1302
  */
1203
1303
  getCard(): CardFacade;
1204
1304
  /**
@@ -1207,6 +1307,8 @@ declare module "sap/ui/integration/Extension" {
1207
1307
  * Gets current value of property {@link #getFormatters formatters}.
1208
1308
  *
1209
1309
  * The formatters, which can be used in the manifest.
1310
+ *
1311
+ * @returns Value of property `formatters`
1210
1312
  */
1211
1313
  getFormatters(): object;
1212
1314
  /**
@@ -1222,14 +1324,14 @@ declare module "sap/ui/integration/Extension" {
1222
1324
  *
1223
1325
  * The actions configuration.
1224
1326
  */
1225
- actions?: CardMenuAction[] | PropertyBindingInfo;
1327
+ actions?: CardMenuAction[] | PropertyBindingInfo | `{${string}}`;
1226
1328
 
1227
1329
  /**
1228
1330
  * @EXPERIMENTAL (since 1.79)
1229
1331
  *
1230
1332
  * The formatters, which can be used in the manifest.
1231
1333
  */
1232
- formatters?: object | PropertyBindingInfo;
1334
+ formatters?: object | PropertyBindingInfo | `{${string}}`;
1233
1335
 
1234
1336
  /**
1235
1337
  * @EXPERIMENTAL (since 1.75)
@@ -1298,6 +1400,8 @@ declare module "sap/ui/integration/Host" {
1298
1400
  * information contained in `oClassInfo`.
1299
1401
  *
1300
1402
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
1403
+ *
1404
+ * @returns Created class / constructor function
1301
1405
  */
1302
1406
  static extend<T extends Record<string, unknown>>(
1303
1407
  /**
@@ -1316,6 +1420,8 @@ declare module "sap/ui/integration/Host" {
1316
1420
  ): Function;
1317
1421
  /**
1318
1422
  * Returns a metadata object for class sap.ui.integration.Host.
1423
+ *
1424
+ * @returns Metadata object describing this class
1319
1425
  */
1320
1426
  static getMetadata(): ElementMetadata;
1321
1427
  /**
@@ -1327,6 +1433,8 @@ declare module "sap/ui/integration/Host" {
1327
1433
  * otherwise it will be bound to this `sap.ui.integration.Host` itself.
1328
1434
  *
1329
1435
  * Fired when an action is triggered.
1436
+ *
1437
+ * @returns Reference to `this` in order to allow method chaining
1330
1438
  */
1331
1439
  attachAction(
1332
1440
  /**
@@ -1352,6 +1460,8 @@ declare module "sap/ui/integration/Host" {
1352
1460
  * otherwise it will be bound to this `sap.ui.integration.Host` itself.
1353
1461
  *
1354
1462
  * Fired when an action is triggered.
1463
+ *
1464
+ * @returns Reference to `this` in order to allow method chaining
1355
1465
  */
1356
1466
  attachAction(
1357
1467
  /**
@@ -1374,6 +1484,8 @@ declare module "sap/ui/integration/Host" {
1374
1484
  *
1375
1485
  * Fired when some card configuration settings are changed as a result of user interaction. For example
1376
1486
  * - filter value is changed.
1487
+ *
1488
+ * @returns Reference to `this` in order to allow method chaining
1377
1489
  */
1378
1490
  attachCardConfigurationChange(
1379
1491
  /**
@@ -1401,6 +1513,8 @@ declare module "sap/ui/integration/Host" {
1401
1513
  *
1402
1514
  * Fired when some card configuration settings are changed as a result of user interaction. For example
1403
1515
  * - filter value is changed.
1516
+ *
1517
+ * @returns Reference to `this` in order to allow method chaining
1404
1518
  */
1405
1519
  attachCardConfigurationChange(
1406
1520
  /**
@@ -1421,6 +1535,8 @@ declare module "sap/ui/integration/Host" {
1421
1535
  * otherwise it will be bound to this `sap.ui.integration.Host` itself.
1422
1536
  *
1423
1537
  * Fired when a message from channels like navigator.serviceWorker is received.
1538
+ *
1539
+ * @returns Reference to `this` in order to allow method chaining
1424
1540
  */
1425
1541
  attachMessage(
1426
1542
  /**
@@ -1446,6 +1562,8 @@ declare module "sap/ui/integration/Host" {
1446
1562
  * otherwise it will be bound to this `sap.ui.integration.Host` itself.
1447
1563
  *
1448
1564
  * Fired when a message from channels like navigator.serviceWorker is received.
1565
+ *
1566
+ * @returns Reference to `this` in order to allow method chaining
1449
1567
  */
1450
1568
  attachMessage(
1451
1569
  /**
@@ -1489,6 +1607,8 @@ declare module "sap/ui/integration/Host" {
1489
1607
  * Detaches event handler `fnFunction` from the {@link #event:action action} event of this `sap.ui.integration.Host`.
1490
1608
  *
1491
1609
  * The passed function and listener object must match the ones used for event registration.
1610
+ *
1611
+ * @returns Reference to `this` in order to allow method chaining
1492
1612
  */
1493
1613
  detachAction(
1494
1614
  /**
@@ -1507,6 +1627,8 @@ declare module "sap/ui/integration/Host" {
1507
1627
  * event of this `sap.ui.integration.Host`.
1508
1628
  *
1509
1629
  * The passed function and listener object must match the ones used for event registration.
1630
+ *
1631
+ * @returns Reference to `this` in order to allow method chaining
1510
1632
  */
1511
1633
  detachCardConfigurationChange(
1512
1634
  /**
@@ -1524,6 +1646,8 @@ declare module "sap/ui/integration/Host" {
1524
1646
  * Detaches event handler `fnFunction` from the {@link #event:message message} event of this `sap.ui.integration.Host`.
1525
1647
  *
1526
1648
  * The passed function and listener object must match the ones used for event registration.
1649
+ *
1650
+ * @returns Reference to `this` in order to allow method chaining
1527
1651
  */
1528
1652
  detachMessage(
1529
1653
  /**
@@ -1542,6 +1666,8 @@ declare module "sap/ui/integration/Host" {
1542
1666
  *
1543
1667
  * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
1544
1668
  * event object. The return value of this method indicates whether the default action should be executed.
1669
+ *
1670
+ * @returns Whether or not to prevent the default action
1545
1671
  */
1546
1672
  fireAction(
1547
1673
  /**
@@ -1574,6 +1700,8 @@ declare module "sap/ui/integration/Host" {
1574
1700
  * @EXPERIMENTAL (since 1.96)
1575
1701
  *
1576
1702
  * Fires event {@link #event:cardConfigurationChange cardConfigurationChange} to attached listeners.
1703
+ *
1704
+ * @returns Reference to `this` in order to allow method chaining
1577
1705
  */
1578
1706
  fireCardConfigurationChange(
1579
1707
  /**
@@ -1603,6 +1731,8 @@ declare module "sap/ui/integration/Host" {
1603
1731
  * @EXPERIMENTAL (since 1.91)
1604
1732
  *
1605
1733
  * Fires event {@link #event:message message} to attached listeners.
1734
+ *
1735
+ * @returns Reference to `this` in order to allow method chaining
1606
1736
  */
1607
1737
  fireMessage(
1608
1738
  /**
@@ -1618,6 +1748,8 @@ declare module "sap/ui/integration/Host" {
1618
1748
  * Gets current value of property {@link #getActions actions}.
1619
1749
  *
1620
1750
  * The actions configuration.
1751
+ *
1752
+ * @returns Value of property `actions`
1621
1753
  */
1622
1754
  getActions(): CardMenuAction[];
1623
1755
  /**
@@ -1633,6 +1765,8 @@ declare module "sap/ui/integration/Host" {
1633
1765
  *
1634
1766
  * The context information and texts should be translated as they appear in the design-time UI of the Card
1635
1767
  * Editor.
1768
+ *
1769
+ * @returns A promise which contains the context structure.
1636
1770
  */
1637
1771
  getContexts(): Promise<any>;
1638
1772
  /**
@@ -1647,6 +1781,8 @@ declare module "sap/ui/integration/Host" {
1647
1781
  *
1648
1782
  * Example path to the current user id of the context sPath = "sap.workzone/currentUser/id" parameter: {
1649
1783
  * userId: { value: "{context>sap.workzone/currentUser/id}" resolves to UserId } }
1784
+ *
1785
+ * @returns A promise which resolves with the value of this context.
1650
1786
  */
1651
1787
  getContextValue(
1652
1788
  /**
@@ -1658,6 +1794,8 @@ declare module "sap/ui/integration/Host" {
1658
1794
  * @EXPERIMENTAL (since 1.97)
1659
1795
  *
1660
1796
  * Resolves the CSRF token and returns a Promise with its value.
1797
+ *
1798
+ * @returns A promise which resolves the CSRF token to its value.
1661
1799
  */
1662
1800
  getCsrfToken(
1663
1801
  /**
@@ -1667,6 +1805,8 @@ declare module "sap/ui/integration/Host" {
1667
1805
  ): Promise<any>;
1668
1806
  /**
1669
1807
  * Resolves the destination and returns its URL.
1808
+ *
1809
+ * @returns A promise which resolves with the URL of the destination.
1670
1810
  */
1671
1811
  getDestination(
1672
1812
  /**
@@ -1679,6 +1819,8 @@ declare module "sap/ui/integration/Host" {
1679
1819
  *
1680
1820
  * Returns the list of destinations for the Card Editor design-time environment List entries are objects
1681
1821
  * that contain at least the name. { "name": "DestinationName" }
1822
+ *
1823
+ * @returns A promise which resolves with the list of destinations.
1682
1824
  */
1683
1825
  getDestinations(): Promise<any>;
1684
1826
  /**
@@ -1693,6 +1835,8 @@ declare module "sap/ui/integration/Host" {
1693
1835
  *
1694
1836
  * The callback receives `destinationName` as parameter and returns a string with the URL. Or alternatively
1695
1837
  * the callback may return a `Promise` with the URL as an argument.
1838
+ *
1839
+ * @returns Value of property `resolveDestination`
1696
1840
  */
1697
1841
  getResolveDestination(): Function;
1698
1842
  /**
@@ -1703,6 +1847,8 @@ declare module "sap/ui/integration/Host" {
1703
1847
  * The actions configuration.
1704
1848
  *
1705
1849
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1850
+ *
1851
+ * @returns Reference to `this` in order to allow method chaining
1706
1852
  */
1707
1853
  setActions(
1708
1854
  /**
@@ -1724,6 +1870,8 @@ declare module "sap/ui/integration/Host" {
1724
1870
  * the callback may return a `Promise` with the URL as an argument.
1725
1871
  *
1726
1872
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1873
+ *
1874
+ * @returns Reference to `this` in order to allow method chaining
1727
1875
  */
1728
1876
  setResolveDestination(
1729
1877
  /**
@@ -1739,7 +1887,7 @@ declare module "sap/ui/integration/Host" {
1739
1887
  *
1740
1888
  * The actions configuration.
1741
1889
  */
1742
- actions?: CardMenuAction[] | PropertyBindingInfo;
1890
+ actions?: CardMenuAction[] | PropertyBindingInfo | `{${string}}`;
1743
1891
 
1744
1892
  /**
1745
1893
  * A function that resolves the given destination name to a URL.
@@ -1752,7 +1900,7 @@ declare module "sap/ui/integration/Host" {
1752
1900
  * The callback receives `destinationName` as parameter and returns a string with the URL. Or alternatively
1753
1901
  * the callback may return a `Promise` with the URL as an argument.
1754
1902
  */
1755
- resolveDestination?: Function | PropertyBindingInfo;
1903
+ resolveDestination?: Function | PropertyBindingInfo | `{${string}}`;
1756
1904
 
1757
1905
  /**
1758
1906
  * @EXPERIMENTAL (since 1.75)
@@ -1834,8 +1982,8 @@ declare module "sap/ui/integration/widgets/Card" {
1834
1982
  * - The dimensions of the card inside a layout of choice, using the `width` and `height` properties
1835
1983
  * - The behavior for the actions described in the manifest.json file, using the action event
1836
1984
  *
1837
- * **You can learn more about integration cards in the Card
1838
- * Explorer**
1985
+ * **You can learn more about integration cards in the {@link demo:sap/ui/integration/demokit/cardExplorer/index.html
1986
+ * Card Explorer}**
1839
1987
  *
1840
1988
  * When to use
1841
1989
  * - When you want to reuse the card across apps.
@@ -1889,6 +2037,8 @@ declare module "sap/ui/integration/widgets/Card" {
1889
2037
  * with the information contained in `oClassInfo`.
1890
2038
  *
1891
2039
  * `oClassInfo` might contain the same kind of information as described in {@link sap.f.CardBase.extend}.
2040
+ *
2041
+ * @returns Created class / constructor function
1892
2042
  */
1893
2043
  static extend<T extends Record<string, unknown>>(
1894
2044
  /**
@@ -1907,6 +2057,8 @@ declare module "sap/ui/integration/widgets/Card" {
1907
2057
  ): Function;
1908
2058
  /**
1909
2059
  * Returns a metadata object for class sap.ui.integration.widgets.Card.
2060
+ *
2061
+ * @returns Metadata object describing this class
1910
2062
  */
1911
2063
  static getMetadata(): ElementMetadata;
1912
2064
  /**
@@ -1914,6 +2066,8 @@ declare module "sap/ui/integration/widgets/Card" {
1914
2066
  * @EXPERIMENTAL (since 1.85)
1915
2067
  *
1916
2068
  * Adds some actionDefinition to the aggregation {@link #getActionDefinitions actionDefinitions}.
2069
+ *
2070
+ * @returns Reference to `this` in order to allow method chaining
1917
2071
  */
1918
2072
  addActionDefinition(
1919
2073
  /**
@@ -1930,6 +2084,8 @@ declare module "sap/ui/integration/widgets/Card" {
1930
2084
  * otherwise it will be bound to this `sap.ui.integration.widgets.Card` itself.
1931
2085
  *
1932
2086
  * Fired when an action is triggered on the card.
2087
+ *
2088
+ * @returns Reference to `this` in order to allow method chaining
1933
2089
  */
1934
2090
  attachAction(
1935
2091
  /**
@@ -1955,6 +2111,8 @@ declare module "sap/ui/integration/widgets/Card" {
1955
2111
  * otherwise it will be bound to this `sap.ui.integration.widgets.Card` itself.
1956
2112
  *
1957
2113
  * Fired when an action is triggered on the card.
2114
+ *
2115
+ * @returns Reference to `this` in order to allow method chaining
1958
2116
  */
1959
2117
  attachAction(
1960
2118
  /**
@@ -1977,6 +2135,8 @@ declare module "sap/ui/integration/widgets/Card" {
1977
2135
  *
1978
2136
  * Fired when some configuration settings are changed as a result of user interaction. For example - filter
1979
2137
  * value is changed.
2138
+ *
2139
+ * @returns Reference to `this` in order to allow method chaining
1980
2140
  */
1981
2141
  attachConfigurationChange(
1982
2142
  /**
@@ -2004,6 +2164,8 @@ declare module "sap/ui/integration/widgets/Card" {
2004
2164
  *
2005
2165
  * Fired when some configuration settings are changed as a result of user interaction. For example - filter
2006
2166
  * value is changed.
2167
+ *
2168
+ * @returns Reference to `this` in order to allow method chaining
2007
2169
  */
2008
2170
  attachConfigurationChange(
2009
2171
  /**
@@ -2026,6 +2188,8 @@ declare module "sap/ui/integration/widgets/Card" {
2026
2188
  * and initialized.
2027
2189
  *
2028
2190
  * Note: The card's content may not be available yet because it may depend on other resources to load.
2191
+ *
2192
+ * @returns Reference to `this` in order to allow method chaining
2029
2193
  */
2030
2194
  attachManifestApplied(
2031
2195
  /**
@@ -2053,6 +2217,8 @@ declare module "sap/ui/integration/widgets/Card" {
2053
2217
  * and initialized.
2054
2218
  *
2055
2219
  * Note: The card's content may not be available yet because it may depend on other resources to load.
2220
+ *
2221
+ * @returns Reference to `this` in order to allow method chaining
2056
2222
  */
2057
2223
  attachManifestApplied(
2058
2224
  /**
@@ -2073,6 +2239,8 @@ declare module "sap/ui/integration/widgets/Card" {
2073
2239
  * otherwise it will be bound to this `sap.ui.integration.widgets.Card` itself.
2074
2240
  *
2075
2241
  * Fired when the manifest is loaded.
2242
+ *
2243
+ * @returns Reference to `this` in order to allow method chaining
2076
2244
  */
2077
2245
  attachManifestReady(
2078
2246
  /**
@@ -2098,6 +2266,8 @@ declare module "sap/ui/integration/widgets/Card" {
2098
2266
  * otherwise it will be bound to this `sap.ui.integration.widgets.Card` itself.
2099
2267
  *
2100
2268
  * Fired when the manifest is loaded.
2269
+ *
2270
+ * @returns Reference to `this` in order to allow method chaining
2101
2271
  */
2102
2272
  attachManifestReady(
2103
2273
  /**
@@ -2114,6 +2284,8 @@ declare module "sap/ui/integration/widgets/Card" {
2114
2284
  * @EXPERIMENTAL (since 1.85)
2115
2285
  *
2116
2286
  * Destroys all the actionDefinitions in the aggregation {@link #getActionDefinitions actionDefinitions}.
2287
+ *
2288
+ * @returns Reference to `this` in order to allow method chaining
2117
2289
  */
2118
2290
  destroyActionDefinitions(): this;
2119
2291
  /**
@@ -2122,6 +2294,8 @@ declare module "sap/ui/integration/widgets/Card" {
2122
2294
  * Detaches event handler `fnFunction` from the {@link #event:action action} event of this `sap.ui.integration.widgets.Card`.
2123
2295
  *
2124
2296
  * The passed function and listener object must match the ones used for event registration.
2297
+ *
2298
+ * @returns Reference to `this` in order to allow method chaining
2125
2299
  */
2126
2300
  detachAction(
2127
2301
  /**
@@ -2140,6 +2314,8 @@ declare module "sap/ui/integration/widgets/Card" {
2140
2314
  * of this `sap.ui.integration.widgets.Card`.
2141
2315
  *
2142
2316
  * The passed function and listener object must match the ones used for event registration.
2317
+ *
2318
+ * @returns Reference to `this` in order to allow method chaining
2143
2319
  */
2144
2320
  detachConfigurationChange(
2145
2321
  /**
@@ -2156,6 +2332,8 @@ declare module "sap/ui/integration/widgets/Card" {
2156
2332
  * this `sap.ui.integration.widgets.Card`.
2157
2333
  *
2158
2334
  * The passed function and listener object must match the ones used for event registration.
2335
+ *
2336
+ * @returns Reference to `this` in order to allow method chaining
2159
2337
  */
2160
2338
  detachManifestApplied(
2161
2339
  /**
@@ -2174,6 +2352,8 @@ declare module "sap/ui/integration/widgets/Card" {
2174
2352
  * `sap.ui.integration.widgets.Card`.
2175
2353
  *
2176
2354
  * The passed function and listener object must match the ones used for event registration.
2355
+ *
2356
+ * @returns Reference to `this` in order to allow method chaining
2177
2357
  */
2178
2358
  detachManifestReady(
2179
2359
  /**
@@ -2192,6 +2372,8 @@ declare module "sap/ui/integration/widgets/Card" {
2192
2372
  *
2193
2373
  * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
2194
2374
  * event object. The return value of this method indicates whether the default action should be executed.
2375
+ *
2376
+ * @returns Whether or not to prevent the default action
2195
2377
  */
2196
2378
  fireAction(
2197
2379
  /**
@@ -2220,6 +2402,8 @@ declare module "sap/ui/integration/widgets/Card" {
2220
2402
  * @EXPERIMENTAL (since 1.96)
2221
2403
  *
2222
2404
  * Fires event {@link #event:configurationChange configurationChange} to attached listeners.
2405
+ *
2406
+ * @returns Reference to `this` in order to allow method chaining
2223
2407
  */
2224
2408
  fireConfigurationChange(
2225
2409
  /**
@@ -2243,6 +2427,8 @@ declare module "sap/ui/integration/widgets/Card" {
2243
2427
  ): this;
2244
2428
  /**
2245
2429
  * Fires event {@link #event:manifestApplied manifestApplied} to attached listeners.
2430
+ *
2431
+ * @returns Reference to `this` in order to allow method chaining
2246
2432
  */
2247
2433
  fireManifestApplied(
2248
2434
  /**
@@ -2254,6 +2440,8 @@ declare module "sap/ui/integration/widgets/Card" {
2254
2440
  * @EXPERIMENTAL (since 1.72)
2255
2441
  *
2256
2442
  * Fires event {@link #event:manifestReady manifestReady} to attached listeners.
2443
+ *
2444
+ * @returns Reference to `this` in order to allow method chaining
2257
2445
  */
2258
2446
  fireManifestReady(
2259
2447
  /**
@@ -2279,18 +2467,26 @@ declare module "sap/ui/integration/widgets/Card" {
2279
2467
  *
2280
2468
  * Defines the base URL of the Card Manifest. It should be used when manifest property is an object instead
2281
2469
  * of a URL.
2470
+ *
2471
+ * @returns Value of property `baseUrl`
2282
2472
  */
2283
2473
  getBaseUrl(): URI;
2284
2474
  /**
2285
2475
  * Implements sap.f.ICard interface.
2476
+ *
2477
+ * @returns The content of the card
2286
2478
  */
2287
2479
  getCardContent(): Control;
2288
2480
  /**
2289
2481
  * Implements sap.f.ICard interface.
2482
+ *
2483
+ * @returns The header of the card
2290
2484
  */
2291
2485
  getCardHeader(): cards.IHeader;
2292
2486
  /**
2293
2487
  * Implements sap.f.ICard interface.
2488
+ *
2489
+ * @returns The position of the header of the card.
2294
2490
  */
2295
2491
  getCardHeaderPosition():
2296
2492
  | cards.HeaderPosition
@@ -2305,6 +2501,8 @@ declare module "sap/ui/integration/widgets/Card" {
2305
2501
  * - Use this method when the manifest is ready. Check `manifestReady` event.
2306
2502
  *
2307
2503
  * - Use when developing a Component card.
2504
+ *
2505
+ * @returns Object containing parameters in format `{parameterKey: parameterValue}`.
2308
2506
  */
2309
2507
  getCombinedParameters(): Record<string, any>;
2310
2508
  /**
@@ -2316,10 +2514,14 @@ declare module "sap/ui/integration/widgets/Card" {
2316
2514
  * Defines the state of the `Card`. When set to `Inactive`, the `Card` doesn't make requests.
2317
2515
  *
2318
2516
  * Default value is `Active`.
2517
+ *
2518
+ * @returns Value of property `dataMode`
2319
2519
  */
2320
2520
  getDataMode(): CardDataMode | keyof typeof CardDataMode;
2321
2521
  /**
2322
2522
  * Returns the DOM Element that should get the focus.
2523
+ *
2524
+ * @returns Returns the DOM Element that should get the focus
2323
2525
  */
2324
2526
  getFocusDomRef(): Element;
2325
2527
  /**
@@ -2330,10 +2532,14 @@ declare module "sap/ui/integration/widgets/Card" {
2330
2532
  * @EXPERIMENTAL (since 1.77)
2331
2533
  *
2332
2534
  * Gets the instance of the `host` association.
2535
+ *
2536
+ * @returns The host object associated with this card.
2333
2537
  */
2334
2538
  getHostInstance(): Host;
2335
2539
  /**
2336
2540
  * Overwrites getter for card manifest.
2541
+ *
2542
+ * @returns Cloned of the parameters.
2337
2543
  */
2338
2544
  getManifest(): string | Object;
2339
2545
  /**
@@ -2357,6 +2563,9 @@ declare module "sap/ui/integration/widgets/Card" {
2357
2563
  * {"content": {"header": {"title": "My new title"}}}
2358
2564
  * ]
2359
2565
  * ```
2566
+ *
2567
+ *
2568
+ * @returns Value of property `manifestChanges`
2360
2569
  */
2361
2570
  getManifestChanges(): object[];
2362
2571
  /**
@@ -2365,6 +2574,8 @@ declare module "sap/ui/integration/widgets/Card" {
2365
2574
  * Returns a value from the Manifest based on the specified path.
2366
2575
  *
2367
2576
  * **Note** Use this method when the manifest is ready. Check `manifestReady` event.
2577
+ *
2578
+ * @returns The value at the specified path.
2368
2579
  */
2369
2580
  getManifestEntry(
2370
2581
  /**
@@ -2378,6 +2589,9 @@ declare module "sap/ui/integration/widgets/Card" {
2378
2589
  * Gets translated text from the i18n properties files configured for this card.
2379
2590
  *
2380
2591
  * For more details see {@link module:sap/base/i18n/ResourceBundle#getText}.
2592
+ *
2593
+ * @returns The value belonging to the key, if found; otherwise the key itself or `undefined` depending
2594
+ * on `bIgnoreKeyFallback`.
2381
2595
  */
2382
2596
  getTranslatedText(
2383
2597
  /**
@@ -2413,6 +2627,8 @@ declare module "sap/ui/integration/widgets/Card" {
2413
2627
  *
2414
2628
  * Checks for the provided `sap.ui.integration.ActionDefinition` in the aggregation {@link #getActionDefinitions
2415
2629
  * actionDefinitions}. and returns its index if found or -1 otherwise.
2630
+ *
2631
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
2416
2632
  */
2417
2633
  indexOfActionDefinition(
2418
2634
  /**
@@ -2425,6 +2641,8 @@ declare module "sap/ui/integration/widgets/Card" {
2425
2641
  * @EXPERIMENTAL (since 1.85)
2426
2642
  *
2427
2643
  * Inserts a actionDefinition into the aggregation {@link #getActionDefinitions actionDefinitions}.
2644
+ *
2645
+ * @returns Reference to `this` in order to allow method chaining
2428
2646
  */
2429
2647
  insertActionDefinition(
2430
2648
  /**
@@ -2440,6 +2658,9 @@ declare module "sap/ui/integration/widgets/Card" {
2440
2658
  ): this;
2441
2659
  /**
2442
2660
  * @EXPERIMENTAL (since 1.65)
2661
+ *
2662
+ *
2663
+ * @returns If the card is ready or not.
2443
2664
  */
2444
2665
  isReady(): boolean;
2445
2666
  /**
@@ -2451,6 +2672,8 @@ declare module "sap/ui/integration/widgets/Card" {
2451
2672
  * Returns a promise that resolves with an object { designtime: the designtime modules response manifest:
2452
2673
  * the complete manifest json } The promise is rejected if the module cannot be loaded with an object: {
2453
2674
  * error: "Card.designtime not found" }
2675
+ *
2676
+ * @returns Promise resolves after the designtime configuration is loaded.
2454
2677
  */
2455
2678
  loadDesigntime(): Promise<any>;
2456
2679
  /**
@@ -2470,6 +2693,8 @@ declare module "sap/ui/integration/widgets/Card" {
2470
2693
  * @EXPERIMENTAL (since 1.85)
2471
2694
  *
2472
2695
  * Removes a actionDefinition from the aggregation {@link #getActionDefinitions actionDefinitions}.
2696
+ *
2697
+ * @returns The removed actionDefinition or `null`
2473
2698
  */
2474
2699
  removeActionDefinition(
2475
2700
  /**
@@ -2484,12 +2709,16 @@ declare module "sap/ui/integration/widgets/Card" {
2484
2709
  * Removes all the controls from the aggregation {@link #getActionDefinitions actionDefinitions}.
2485
2710
  *
2486
2711
  * Additionally, it unregisters them from the hosting UIArea.
2712
+ *
2713
+ * @returns An array of the removed elements (might be empty)
2487
2714
  */
2488
2715
  removeAllActionDefinitions(): ActionDefinition[];
2489
2716
  /**
2490
2717
  * @EXPERIMENTAL (since 1.79)
2491
2718
  *
2492
2719
  * Performs an HTTP request using the given configuration.
2720
+ *
2721
+ * @returns Resolves when the request is successful, rejects otherwise.
2493
2722
  */
2494
2723
  request(
2495
2724
  /**
@@ -2531,6 +2760,8 @@ declare module "sap/ui/integration/widgets/Card" {
2531
2760
  ): Promise<any>;
2532
2761
  /**
2533
2762
  * Resolves the destination and returns its URL.
2763
+ *
2764
+ * @returns A promise which resolves with the URL of the destination.
2534
2765
  */
2535
2766
  resolveDestination(
2536
2767
  /**
@@ -2548,6 +2779,8 @@ declare module "sap/ui/integration/widgets/Card" {
2548
2779
  * of a URL.
2549
2780
  *
2550
2781
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2782
+ *
2783
+ * @returns Reference to `this` in order to allow method chaining
2551
2784
  */
2552
2785
  setBaseUrl(
2553
2786
  /**
@@ -2560,6 +2793,8 @@ declare module "sap/ui/integration/widgets/Card" {
2560
2793
  * @EXPERIMENTAL (since 1.65)
2561
2794
  *
2562
2795
  * Sets a new value for the `dataMode` property.
2796
+ *
2797
+ * @returns Pointer to the control instance to allow method chaining.
2563
2798
  */
2564
2799
  setDataMode(
2565
2800
  /**
@@ -2569,6 +2804,8 @@ declare module "sap/ui/integration/widgets/Card" {
2569
2804
  ): this;
2570
2805
  /**
2571
2806
  * Sets the associated {@link #getHost host}.
2807
+ *
2808
+ * @returns Reference to `this` in order to allow method chaining
2572
2809
  */
2573
2810
  setHost(
2574
2811
  /**
@@ -2585,6 +2822,8 @@ declare module "sap/ui/integration/widgets/Card" {
2585
2822
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2586
2823
  *
2587
2824
  * Default value is `empty string`.
2825
+ *
2826
+ * @returns Reference to `this` in order to allow method chaining
2588
2827
  */
2589
2828
  setManifest(
2590
2829
  /**
@@ -2616,6 +2855,8 @@ declare module "sap/ui/integration/widgets/Card" {
2616
2855
  *
2617
2856
  *
2618
2857
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2858
+ *
2859
+ * @returns Reference to `this` in order to allow method chaining
2619
2860
  */
2620
2861
  setManifestChanges(
2621
2862
  /**
@@ -2702,6 +2943,8 @@ declare module "sap/ui/integration/widgets/Card" {
2702
2943
  * @EXPERIMENTAL (since 1.85)
2703
2944
  *
2704
2945
  * Adds some actionDefinition to the aggregation {@link #getActionDefinitions actionDefinitions}.
2946
+ *
2947
+ * @returns Reference to `this` in order to allow method chaining
2705
2948
  */
2706
2949
  addActionDefinition(
2707
2950
  /**
@@ -2717,6 +2960,8 @@ declare module "sap/ui/integration/widgets/Card" {
2717
2960
  *
2718
2961
  * Defines the base URL of the Card Manifest. It should be used when manifest property is an object instead
2719
2962
  * of a URL.
2963
+ *
2964
+ * @returns Value of property `baseUrl`
2720
2965
  */
2721
2966
  getBaseUrl(): URI;
2722
2967
  /**
@@ -2729,6 +2974,8 @@ declare module "sap/ui/integration/widgets/Card" {
2729
2974
  * - Use this method when the manifest is ready. Check `manifestReady` event.
2730
2975
  *
2731
2976
  * - Use when developing a Component card.
2977
+ *
2978
+ * @returns Object containing parameters in format `{parameterKey: parameterValue}`.
2732
2979
  */
2733
2980
  getCombinedParameters(): Record<string, any>;
2734
2981
  /**
@@ -2737,6 +2984,8 @@ declare module "sap/ui/integration/widgets/Card" {
2737
2984
  * Returns a value from the Manifest based on the specified path.
2738
2985
  *
2739
2986
  * **Note** Use this method when the manifest is ready. Check `manifestReady` event.
2987
+ *
2988
+ * @returns The value at the specified path.
2740
2989
  */
2741
2990
  getManifestEntry(
2742
2991
  /**
@@ -2751,6 +3000,8 @@ declare module "sap/ui/integration/widgets/Card" {
2751
3000
  *
2752
3001
  * Overrides the default values of the parameters, which are defined in the manifest. The value is an object
2753
3002
  * containing parameters in format `{parameterKey: parameterValue}`.
3003
+ *
3004
+ * @returns Value of property `parameters`
2754
3005
  */
2755
3006
  getParameters(): object;
2756
3007
  /**
@@ -2759,6 +3010,9 @@ declare module "sap/ui/integration/widgets/Card" {
2759
3010
  * Gets translated text from the i18n properties files configured for this card.
2760
3011
  *
2761
3012
  * For more details see {@link module:sap/base/i18n/ResourceBundle#getText}.
3013
+ *
3014
+ * @returns The value belonging to the key, if found; otherwise the key itself or `undefined` depending
3015
+ * on `bIgnoreKeyFallback`.
2762
3016
  */
2763
3017
  getTranslatedText(
2764
3018
  /**
@@ -2794,6 +3048,8 @@ declare module "sap/ui/integration/widgets/Card" {
2794
3048
  *
2795
3049
  * Checks for the provided `sap.ui.integration.ActionDefinition` in the aggregation {@link #getActionDefinitions
2796
3050
  * actionDefinitions}. and returns its index if found or -1 otherwise.
3051
+ *
3052
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
2797
3053
  */
2798
3054
  indexOfActionDefinition(
2799
3055
  /**
@@ -2806,6 +3062,8 @@ declare module "sap/ui/integration/widgets/Card" {
2806
3062
  * @EXPERIMENTAL (since 1.85)
2807
3063
  *
2808
3064
  * Inserts a actionDefinition into the aggregation {@link #getActionDefinitions actionDefinitions}.
3065
+ *
3066
+ * @returns Reference to `this` in order to allow method chaining
2809
3067
  */
2810
3068
  insertActionDefinition(
2811
3069
  /**
@@ -2836,6 +3094,8 @@ declare module "sap/ui/integration/widgets/Card" {
2836
3094
  * @EXPERIMENTAL (since 1.85)
2837
3095
  *
2838
3096
  * Removes a actionDefinition from the aggregation {@link #getActionDefinitions actionDefinitions}.
3097
+ *
3098
+ * @returns The removed actionDefinition or `null`
2839
3099
  */
2840
3100
  removeActionDefinition(
2841
3101
  /**
@@ -2847,6 +3107,8 @@ declare module "sap/ui/integration/widgets/Card" {
2847
3107
  * @EXPERIMENTAL (since 1.79)
2848
3108
  *
2849
3109
  * Performs an HTTP request using the given configuration.
3110
+ *
3111
+ * @returns Resolves when the request is successful, rejects otherwise.
2850
3112
  */
2851
3113
  request(
2852
3114
  /**
@@ -2888,6 +3150,8 @@ declare module "sap/ui/integration/widgets/Card" {
2888
3150
  ): Promise<any>;
2889
3151
  /**
2890
3152
  * Resolves the destination and returns its URL.
3153
+ *
3154
+ * @returns A promise which resolves with the URL of the destination.
2891
3155
  */
2892
3156
  resolveDestination(
2893
3157
  /**
@@ -2966,7 +3230,7 @@ declare module "sap/ui/integration/widgets/Card" {
2966
3230
  /**
2967
3231
  * The URL of the manifest or an object.
2968
3232
  */
2969
- manifest?: any | PropertyBindingInfo;
3233
+ manifest?: any | PropertyBindingInfo | `{${string}}`;
2970
3234
 
2971
3235
  /**
2972
3236
  * @EXPERIMENTAL (since 1.65)
@@ -2974,7 +3238,7 @@ declare module "sap/ui/integration/widgets/Card" {
2974
3238
  * Overrides the default values of the parameters, which are defined in the manifest. The value is an object
2975
3239
  * containing parameters in format `{parameterKey: parameterValue}`.
2976
3240
  */
2977
- parameters?: object | PropertyBindingInfo;
3241
+ parameters?: object | PropertyBindingInfo | `{${string}}`;
2978
3242
 
2979
3243
  /**
2980
3244
  * @SINCE 1.65
@@ -2982,7 +3246,10 @@ declare module "sap/ui/integration/widgets/Card" {
2982
3246
  *
2983
3247
  * Defines the state of the `Card`. When set to `Inactive`, the `Card` doesn't make requests.
2984
3248
  */
2985
- dataMode?: (CardDataMode | keyof typeof CardDataMode) | PropertyBindingInfo;
3249
+ dataMode?:
3250
+ | (CardDataMode | keyof typeof CardDataMode)
3251
+ | PropertyBindingInfo
3252
+ | `{${string}}`;
2986
3253
 
2987
3254
  /**
2988
3255
  * @SINCE 1.70
@@ -2991,7 +3258,7 @@ declare module "sap/ui/integration/widgets/Card" {
2991
3258
  * Defines the base URL of the Card Manifest. It should be used when manifest property is an object instead
2992
3259
  * of a URL.
2993
3260
  */
2994
- baseUrl?: URI | PropertyBindingInfo;
3261
+ baseUrl?: URI | PropertyBindingInfo | `{${string}}`;
2995
3262
 
2996
3263
  /**
2997
3264
  * @SINCE 1.76
@@ -3013,7 +3280,7 @@ declare module "sap/ui/integration/widgets/Card" {
3013
3280
  * ]
3014
3281
  * ```
3015
3282
  */
3016
- manifestChanges?: object[] | PropertyBindingInfo;
3283
+ manifestChanges?: object[] | PropertyBindingInfo | `{${string}}`;
3017
3284
 
3018
3285
  /**
3019
3286
  * @SINCE 1.85
@@ -3025,7 +3292,8 @@ declare module "sap/ui/integration/widgets/Card" {
3025
3292
  actionDefinitions?:
3026
3293
  | ActionDefinition[]
3027
3294
  | ActionDefinition
3028
- | AggregationBindingInfo;
3295
+ | AggregationBindingInfo
3296
+ | `{${string}}`;
3029
3297
 
3030
3298
  /**
3031
3299
  * The host.
@@ -3085,6 +3353,8 @@ declare namespace sap {
3085
3353
  namespace IsInIconPool {
3086
3354
  /**
3087
3355
  * Validator function
3356
+ *
3357
+ * @returns Validation result
3088
3358
  */
3089
3359
  function validate(
3090
3360
  /**