@openui5/ts-types 1.99.1 → 1.102.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.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.99.1
1
+ // For Library Version: 1.102.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -21,6 +21,8 @@ declare namespace sap {
21
21
  namespace IsInIconPool {
22
22
  /**
23
23
  * Validator function
24
+ *
25
+ * @returns Validation result
24
26
  */
25
27
  function validate(
26
28
  /**
@@ -42,6 +44,8 @@ declare namespace sap {
42
44
  interface IsBoolean {
43
45
  /**
44
46
  * Validator function
47
+ *
48
+ * @returns Validation result
45
49
  */
46
50
  validate(
47
51
  /**
@@ -61,6 +65,8 @@ declare namespace sap {
61
65
  interface IsDate {
62
66
  /**
63
67
  * Validator function
68
+ *
69
+ * @returns Validation result
64
70
  */
65
71
  validate(
66
72
  /**
@@ -80,6 +86,8 @@ declare namespace sap {
80
86
  interface IsInteger {
81
87
  /**
82
88
  * Validator function
89
+ *
90
+ * @returns Validation result
83
91
  */
84
92
  validate(
85
93
  /**
@@ -99,6 +107,8 @@ declare namespace sap {
99
107
  interface IsNumber {
100
108
  /**
101
109
  * Validator function
110
+ *
111
+ * @returns Validation result
102
112
  */
103
113
  validate(
104
114
  /**
@@ -118,6 +128,8 @@ declare namespace sap {
118
128
  interface IsSelectedKey {
119
129
  /**
120
130
  * Validator function
131
+ *
132
+ * @returns Validation result
121
133
  */
122
134
  validate(
123
135
  /**
@@ -146,6 +158,8 @@ declare namespace sap {
146
158
  interface IsStringList {
147
159
  /**
148
160
  * Validator function
161
+ *
162
+ * @returns Validation result
149
163
  */
150
164
  validate(
151
165
  /**
@@ -165,6 +179,8 @@ declare namespace sap {
165
179
  interface IsUniqueKey {
166
180
  /**
167
181
  * Validator function
182
+ *
183
+ * @returns Validation result
168
184
  */
169
185
  validate(
170
186
  /**
@@ -197,6 +213,8 @@ declare namespace sap {
197
213
  interface IsUniqueList {
198
214
  /**
199
215
  * Validator function
216
+ *
217
+ * @returns Validation result
200
218
  */
201
219
  validate(
202
220
  /**
@@ -216,6 +234,8 @@ declare namespace sap {
216
234
  interface IsValidBinding {
217
235
  /**
218
236
  * Validator function
237
+ *
238
+ * @returns Validation result
219
239
  */
220
240
  validate(
221
241
  /**
@@ -244,6 +264,8 @@ declare namespace sap {
244
264
  interface MaxLength {
245
265
  /**
246
266
  * Validator function
267
+ *
268
+ * @returns Validation result
247
269
  */
248
270
  validate(
249
271
  /**
@@ -263,6 +285,8 @@ declare namespace sap {
263
285
  interface NotABinding {
264
286
  /**
265
287
  * Validator function
288
+ *
289
+ * @returns Validation result
266
290
  */
267
291
  validate(
268
292
  /**
@@ -289,6 +313,8 @@ declare namespace sap {
289
313
  * @EXPERIMENTAL (since 1.94)
290
314
  *
291
315
  * Performs an HTTP request using the given configuration.
316
+ *
317
+ * @returns Resolves when the request is successful, rejects otherwise.
292
318
  */
293
319
  request(
294
320
  /**
@@ -337,7 +363,10 @@ declare namespace sap {
337
363
  *
338
364
  * The formatters, which can be used in the manifest.
339
365
  */
340
- formatters?: object | sap.ui.base.ManagedObject.PropertyBindingInfo;
366
+ formatters?:
367
+ | object
368
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
369
+ | `{${string}}`;
341
370
  }
342
371
 
343
372
  /**
@@ -383,6 +412,8 @@ declare namespace sap {
383
412
  * it with the information contained in `oClassInfo`.
384
413
  *
385
414
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.ManagedObject.extend}.
415
+ *
416
+ * @returns Created class / constructor function
386
417
  */
387
418
  static extend<T extends Record<string, unknown>>(
388
419
  /**
@@ -401,10 +432,14 @@ declare namespace sap {
401
432
  ): Function;
402
433
  /**
403
434
  * Returns a metadata object for class sap.ui.integration.editor.Extension.
435
+ *
436
+ * @returns Metadata object describing this class
404
437
  */
405
438
  static getMetadata(): sap.ui.base.ManagedObjectMetadata;
406
439
  /**
407
440
  * Returns an interface to the editor, which uses this extension.
441
+ *
442
+ * @returns An interface to the card.
408
443
  */
409
444
  getEditor(): sap.ui.integration.widgets.CardFacade;
410
445
  /**
@@ -413,6 +448,8 @@ declare namespace sap {
413
448
  * Gets current value of property {@link #getFormatters formatters}.
414
449
  *
415
450
  * The formatters, which can be used in the manifest.
451
+ *
452
+ * @returns Value of property `formatters`
416
453
  */
417
454
  getFormatters(): object;
418
455
  /**
@@ -436,6 +473,8 @@ declare namespace sap {
436
473
  * @EXPERIMENTAL (since 1.85)
437
474
  *
438
475
  * Adds some actionDefinition to the aggregation {@link #getActionDefinitions actionDefinitions}.
476
+ *
477
+ * @returns Reference to `this` in order to allow method chaining
439
478
  */
440
479
  addActionDefinition(
441
480
  /**
@@ -451,6 +490,8 @@ declare namespace sap {
451
490
  *
452
491
  * Defines the base URL of the Card Manifest. It should be used when manifest property is an object instead
453
492
  * of a URL.
493
+ *
494
+ * @returns Value of property `baseUrl`
454
495
  */
455
496
  getBaseUrl(): sap.ui.core.URI;
456
497
  /**
@@ -463,6 +504,8 @@ declare namespace sap {
463
504
  * - Use this method when the manifest is ready. Check `manifestReady` event.
464
505
  *
465
506
  * - Use when developing a Component card.
507
+ *
508
+ * @returns Object containing parameters in format `{parameterKey: parameterValue}`.
466
509
  */
467
510
  getCombinedParameters(): Record<string, any>;
468
511
  /**
@@ -471,6 +514,8 @@ declare namespace sap {
471
514
  * Returns a value from the Manifest based on the specified path.
472
515
  *
473
516
  * **Note** Use this method when the manifest is ready. Check `manifestReady` event.
517
+ *
518
+ * @returns The value at the specified path.
474
519
  */
475
520
  getManifestEntry(
476
521
  /**
@@ -485,6 +530,8 @@ declare namespace sap {
485
530
  *
486
531
  * Overrides the default values of the parameters, which are defined in the manifest. The value is an object
487
532
  * containing parameters in format `{parameterKey: parameterValue}`.
533
+ *
534
+ * @returns Value of property `parameters`
488
535
  */
489
536
  getParameters(): object;
490
537
  /**
@@ -493,6 +540,9 @@ declare namespace sap {
493
540
  * Gets translated text from the i18n properties files configured for this card.
494
541
  *
495
542
  * For more details see {@link module:sap/base/i18n/ResourceBundle#getText}.
543
+ *
544
+ * @returns The value belonging to the key, if found; otherwise the key itself or `undefined` depending
545
+ * on `bIgnoreKeyFallback`.
496
546
  */
497
547
  getTranslatedText(
498
548
  /**
@@ -528,6 +578,8 @@ declare namespace sap {
528
578
  *
529
579
  * Checks for the provided `sap.ui.integration.ActionDefinition` in the aggregation {@link #getActionDefinitions
530
580
  * actionDefinitions}. and returns its index if found or -1 otherwise.
581
+ *
582
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
531
583
  */
532
584
  indexOfActionDefinition(
533
585
  /**
@@ -540,6 +592,8 @@ declare namespace sap {
540
592
  * @EXPERIMENTAL (since 1.85)
541
593
  *
542
594
  * Inserts a actionDefinition into the aggregation {@link #getActionDefinitions actionDefinitions}.
595
+ *
596
+ * @returns Reference to `this` in order to allow method chaining
543
597
  */
544
598
  insertActionDefinition(
545
599
  /**
@@ -570,6 +624,8 @@ declare namespace sap {
570
624
  * @EXPERIMENTAL (since 1.85)
571
625
  *
572
626
  * Removes a actionDefinition from the aggregation {@link #getActionDefinitions actionDefinitions}.
627
+ *
628
+ * @returns The removed actionDefinition or `null`
573
629
  */
574
630
  removeActionDefinition(
575
631
  /**
@@ -584,6 +640,8 @@ declare namespace sap {
584
640
  * @EXPERIMENTAL (since 1.79)
585
641
  *
586
642
  * Performs an HTTP request using the given configuration.
643
+ *
644
+ * @returns Resolves when the request is successful, rejects otherwise.
587
645
  */
588
646
  request(
589
647
  /**
@@ -625,6 +683,8 @@ declare namespace sap {
625
683
  ): Promise<any>;
626
684
  /**
627
685
  * Resolves the destination and returns its URL.
686
+ *
687
+ * @returns A promise which resolves with the URL of the destination.
628
688
  */
629
689
  resolveDestination(
630
690
  /**
@@ -703,7 +763,10 @@ declare namespace sap {
703
763
  /**
704
764
  * The URL of the manifest or an object.
705
765
  */
706
- manifest?: any | sap.ui.base.ManagedObject.PropertyBindingInfo;
766
+ manifest?:
767
+ | any
768
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
769
+ | `{${string}}`;
707
770
 
708
771
  /**
709
772
  * @EXPERIMENTAL (since 1.65)
@@ -711,7 +774,10 @@ declare namespace sap {
711
774
  * Overrides the default values of the parameters, which are defined in the manifest. The value is an object
712
775
  * containing parameters in format `{parameterKey: parameterValue}`.
713
776
  */
714
- parameters?: object | sap.ui.base.ManagedObject.PropertyBindingInfo;
777
+ parameters?:
778
+ | object
779
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
780
+ | `{${string}}`;
715
781
 
716
782
  /**
717
783
  * @SINCE 1.65
@@ -721,7 +787,8 @@ declare namespace sap {
721
787
  */
722
788
  dataMode?:
723
789
  | sap.ui.integration.CardDataMode
724
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
790
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
791
+ | `{${string}}`;
725
792
 
726
793
  /**
727
794
  * @SINCE 1.70
@@ -732,7 +799,8 @@ declare namespace sap {
732
799
  */
733
800
  baseUrl?:
734
801
  | sap.ui.core.URI
735
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
802
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
803
+ | `{${string}}`;
736
804
 
737
805
  /**
738
806
  * @SINCE 1.76
@@ -756,7 +824,8 @@ declare namespace sap {
756
824
  */
757
825
  manifestChanges?:
758
826
  | object[]
759
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
827
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
828
+ | `{${string}}`;
760
829
 
761
830
  /**
762
831
  * @SINCE 1.85
@@ -768,7 +837,8 @@ declare namespace sap {
768
837
  actionDefinitions?:
769
838
  | sap.ui.integration.ActionDefinition[]
770
839
  | sap.ui.integration.ActionDefinition
771
- | sap.ui.base.ManagedObject.AggregationBindingInfo;
840
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
841
+ | `{${string}}`;
772
842
 
773
843
  /**
774
844
  * The host.
@@ -834,8 +904,8 @@ declare namespace sap {
834
904
  * - The dimensions of the card inside a layout of choice, using the `width` and `height` properties
835
905
  * - The behavior for the actions described in the manifest.json file, using the action event
836
906
  *
837
- * **You can learn more about integration cards in the Card
838
- * Explorer**
907
+ * **You can learn more about integration cards in the {@link demo:sap/ui/integration/demokit/cardExplorer/index.html
908
+ * Card Explorer}**
839
909
  *
840
910
  * When to use
841
911
  * - When you want to reuse the card across apps.
@@ -889,6 +959,8 @@ declare namespace sap {
889
959
  * with the information contained in `oClassInfo`.
890
960
  *
891
961
  * `oClassInfo` might contain the same kind of information as described in {@link sap.f.CardBase.extend}.
962
+ *
963
+ * @returns Created class / constructor function
892
964
  */
893
965
  static extend<T extends Record<string, unknown>>(
894
966
  /**
@@ -907,6 +979,8 @@ declare namespace sap {
907
979
  ): Function;
908
980
  /**
909
981
  * Returns a metadata object for class sap.ui.integration.widgets.Card.
982
+ *
983
+ * @returns Metadata object describing this class
910
984
  */
911
985
  static getMetadata(): sap.ui.core.ElementMetadata;
912
986
  /**
@@ -914,6 +988,8 @@ declare namespace sap {
914
988
  * @EXPERIMENTAL (since 1.85)
915
989
  *
916
990
  * Adds some actionDefinition to the aggregation {@link #getActionDefinitions actionDefinitions}.
991
+ *
992
+ * @returns Reference to `this` in order to allow method chaining
917
993
  */
918
994
  addActionDefinition(
919
995
  /**
@@ -930,6 +1006,8 @@ declare namespace sap {
930
1006
  * otherwise it will be bound to this `sap.ui.integration.widgets.Card` itself.
931
1007
  *
932
1008
  * Fired when an action is triggered on the card.
1009
+ *
1010
+ * @returns Reference to `this` in order to allow method chaining
933
1011
  */
934
1012
  attachAction(
935
1013
  /**
@@ -955,6 +1033,8 @@ declare namespace sap {
955
1033
  * otherwise it will be bound to this `sap.ui.integration.widgets.Card` itself.
956
1034
  *
957
1035
  * Fired when an action is triggered on the card.
1036
+ *
1037
+ * @returns Reference to `this` in order to allow method chaining
958
1038
  */
959
1039
  attachAction(
960
1040
  /**
@@ -977,6 +1057,8 @@ declare namespace sap {
977
1057
  *
978
1058
  * Fired when some configuration settings are changed as a result of user interaction. For example - filter
979
1059
  * value is changed.
1060
+ *
1061
+ * @returns Reference to `this` in order to allow method chaining
980
1062
  */
981
1063
  attachConfigurationChange(
982
1064
  /**
@@ -1004,6 +1086,8 @@ declare namespace sap {
1004
1086
  *
1005
1087
  * Fired when some configuration settings are changed as a result of user interaction. For example - filter
1006
1088
  * value is changed.
1089
+ *
1090
+ * @returns Reference to `this` in order to allow method chaining
1007
1091
  */
1008
1092
  attachConfigurationChange(
1009
1093
  /**
@@ -1026,6 +1110,8 @@ declare namespace sap {
1026
1110
  * and initialized.
1027
1111
  *
1028
1112
  * Note: The card's content may not be available yet because it may depend on other resources to load.
1113
+ *
1114
+ * @returns Reference to `this` in order to allow method chaining
1029
1115
  */
1030
1116
  attachManifestApplied(
1031
1117
  /**
@@ -1053,6 +1139,8 @@ declare namespace sap {
1053
1139
  * and initialized.
1054
1140
  *
1055
1141
  * Note: The card's content may not be available yet because it may depend on other resources to load.
1142
+ *
1143
+ * @returns Reference to `this` in order to allow method chaining
1056
1144
  */
1057
1145
  attachManifestApplied(
1058
1146
  /**
@@ -1073,6 +1161,8 @@ declare namespace sap {
1073
1161
  * otherwise it will be bound to this `sap.ui.integration.widgets.Card` itself.
1074
1162
  *
1075
1163
  * Fired when the manifest is loaded.
1164
+ *
1165
+ * @returns Reference to `this` in order to allow method chaining
1076
1166
  */
1077
1167
  attachManifestReady(
1078
1168
  /**
@@ -1098,6 +1188,8 @@ declare namespace sap {
1098
1188
  * otherwise it will be bound to this `sap.ui.integration.widgets.Card` itself.
1099
1189
  *
1100
1190
  * Fired when the manifest is loaded.
1191
+ *
1192
+ * @returns Reference to `this` in order to allow method chaining
1101
1193
  */
1102
1194
  attachManifestReady(
1103
1195
  /**
@@ -1114,6 +1206,8 @@ declare namespace sap {
1114
1206
  * @EXPERIMENTAL (since 1.85)
1115
1207
  *
1116
1208
  * Destroys all the actionDefinitions in the aggregation {@link #getActionDefinitions actionDefinitions}.
1209
+ *
1210
+ * @returns Reference to `this` in order to allow method chaining
1117
1211
  */
1118
1212
  destroyActionDefinitions(): this;
1119
1213
  /**
@@ -1122,6 +1216,8 @@ declare namespace sap {
1122
1216
  * Detaches event handler `fnFunction` from the {@link #event:action action} event of this `sap.ui.integration.widgets.Card`.
1123
1217
  *
1124
1218
  * The passed function and listener object must match the ones used for event registration.
1219
+ *
1220
+ * @returns Reference to `this` in order to allow method chaining
1125
1221
  */
1126
1222
  detachAction(
1127
1223
  /**
@@ -1140,6 +1236,8 @@ declare namespace sap {
1140
1236
  * of this `sap.ui.integration.widgets.Card`.
1141
1237
  *
1142
1238
  * The passed function and listener object must match the ones used for event registration.
1239
+ *
1240
+ * @returns Reference to `this` in order to allow method chaining
1143
1241
  */
1144
1242
  detachConfigurationChange(
1145
1243
  /**
@@ -1156,6 +1254,8 @@ declare namespace sap {
1156
1254
  * this `sap.ui.integration.widgets.Card`.
1157
1255
  *
1158
1256
  * The passed function and listener object must match the ones used for event registration.
1257
+ *
1258
+ * @returns Reference to `this` in order to allow method chaining
1159
1259
  */
1160
1260
  detachManifestApplied(
1161
1261
  /**
@@ -1174,6 +1274,8 @@ declare namespace sap {
1174
1274
  * `sap.ui.integration.widgets.Card`.
1175
1275
  *
1176
1276
  * The passed function and listener object must match the ones used for event registration.
1277
+ *
1278
+ * @returns Reference to `this` in order to allow method chaining
1177
1279
  */
1178
1280
  detachManifestReady(
1179
1281
  /**
@@ -1192,6 +1294,8 @@ declare namespace sap {
1192
1294
  *
1193
1295
  * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
1194
1296
  * event object. The return value of this method indicates whether the default action should be executed.
1297
+ *
1298
+ * @returns Whether or not to prevent the default action
1195
1299
  */
1196
1300
  fireAction(
1197
1301
  /**
@@ -1220,6 +1324,8 @@ declare namespace sap {
1220
1324
  * @EXPERIMENTAL (since 1.96)
1221
1325
  *
1222
1326
  * Fires event {@link #event:configurationChange configurationChange} to attached listeners.
1327
+ *
1328
+ * @returns Reference to `this` in order to allow method chaining
1223
1329
  */
1224
1330
  fireConfigurationChange(
1225
1331
  /**
@@ -1243,6 +1349,8 @@ declare namespace sap {
1243
1349
  ): this;
1244
1350
  /**
1245
1351
  * Fires event {@link #event:manifestApplied manifestApplied} to attached listeners.
1352
+ *
1353
+ * @returns Reference to `this` in order to allow method chaining
1246
1354
  */
1247
1355
  fireManifestApplied(
1248
1356
  /**
@@ -1254,6 +1362,8 @@ declare namespace sap {
1254
1362
  * @EXPERIMENTAL (since 1.72)
1255
1363
  *
1256
1364
  * Fires event {@link #event:manifestReady manifestReady} to attached listeners.
1365
+ *
1366
+ * @returns Reference to `this` in order to allow method chaining
1257
1367
  */
1258
1368
  fireManifestReady(
1259
1369
  /**
@@ -1279,18 +1389,26 @@ declare namespace sap {
1279
1389
  *
1280
1390
  * Defines the base URL of the Card Manifest. It should be used when manifest property is an object instead
1281
1391
  * of a URL.
1392
+ *
1393
+ * @returns Value of property `baseUrl`
1282
1394
  */
1283
1395
  getBaseUrl(): sap.ui.core.URI;
1284
1396
  /**
1285
1397
  * Implements sap.f.ICard interface.
1398
+ *
1399
+ * @returns The content of the card
1286
1400
  */
1287
1401
  getCardContent(): sap.ui.core.Control;
1288
1402
  /**
1289
1403
  * Implements sap.f.ICard interface.
1404
+ *
1405
+ * @returns The header of the card
1290
1406
  */
1291
1407
  getCardHeader(): sap.f.cards.IHeader;
1292
1408
  /**
1293
1409
  * Implements sap.f.ICard interface.
1410
+ *
1411
+ * @returns The position of the header of the card.
1294
1412
  */
1295
1413
  getCardHeaderPosition(): sap.f.cards.HeaderPosition;
1296
1414
  /**
@@ -1303,6 +1421,8 @@ declare namespace sap {
1303
1421
  * - Use this method when the manifest is ready. Check `manifestReady` event.
1304
1422
  *
1305
1423
  * - Use when developing a Component card.
1424
+ *
1425
+ * @returns Object containing parameters in format `{parameterKey: parameterValue}`.
1306
1426
  */
1307
1427
  getCombinedParameters(): Record<string, any>;
1308
1428
  /**
@@ -1314,10 +1434,14 @@ declare namespace sap {
1314
1434
  * Defines the state of the `Card`. When set to `Inactive`, the `Card` doesn't make requests.
1315
1435
  *
1316
1436
  * Default value is `Active`.
1437
+ *
1438
+ * @returns Value of property `dataMode`
1317
1439
  */
1318
1440
  getDataMode(): sap.ui.integration.CardDataMode;
1319
1441
  /**
1320
1442
  * Returns the DOM Element that should get the focus.
1443
+ *
1444
+ * @returns Returns the DOM Element that should get the focus
1321
1445
  */
1322
1446
  getFocusDomRef(): Element;
1323
1447
  /**
@@ -1328,10 +1452,14 @@ declare namespace sap {
1328
1452
  * @EXPERIMENTAL (since 1.77)
1329
1453
  *
1330
1454
  * Gets the instance of the `host` association.
1455
+ *
1456
+ * @returns The host object associated with this card.
1331
1457
  */
1332
1458
  getHostInstance(): sap.ui.integration.Host;
1333
1459
  /**
1334
1460
  * Overwrites getter for card manifest.
1461
+ *
1462
+ * @returns Cloned of the parameters.
1335
1463
  */
1336
1464
  getManifest(): string | Object;
1337
1465
  /**
@@ -1355,6 +1483,9 @@ declare namespace sap {
1355
1483
  * {"content": {"header": {"title": "My new title"}}}
1356
1484
  * ]
1357
1485
  * ```
1486
+ *
1487
+ *
1488
+ * @returns Value of property `manifestChanges`
1358
1489
  */
1359
1490
  getManifestChanges(): object[];
1360
1491
  /**
@@ -1363,6 +1494,8 @@ declare namespace sap {
1363
1494
  * Returns a value from the Manifest based on the specified path.
1364
1495
  *
1365
1496
  * **Note** Use this method when the manifest is ready. Check `manifestReady` event.
1497
+ *
1498
+ * @returns The value at the specified path.
1366
1499
  */
1367
1500
  getManifestEntry(
1368
1501
  /**
@@ -1376,6 +1509,9 @@ declare namespace sap {
1376
1509
  * Gets translated text from the i18n properties files configured for this card.
1377
1510
  *
1378
1511
  * For more details see {@link module:sap/base/i18n/ResourceBundle#getText}.
1512
+ *
1513
+ * @returns The value belonging to the key, if found; otherwise the key itself or `undefined` depending
1514
+ * on `bIgnoreKeyFallback`.
1379
1515
  */
1380
1516
  getTranslatedText(
1381
1517
  /**
@@ -1411,6 +1547,8 @@ declare namespace sap {
1411
1547
  *
1412
1548
  * Checks for the provided `sap.ui.integration.ActionDefinition` in the aggregation {@link #getActionDefinitions
1413
1549
  * actionDefinitions}. and returns its index if found or -1 otherwise.
1550
+ *
1551
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
1414
1552
  */
1415
1553
  indexOfActionDefinition(
1416
1554
  /**
@@ -1423,6 +1561,8 @@ declare namespace sap {
1423
1561
  * @EXPERIMENTAL (since 1.85)
1424
1562
  *
1425
1563
  * Inserts a actionDefinition into the aggregation {@link #getActionDefinitions actionDefinitions}.
1564
+ *
1565
+ * @returns Reference to `this` in order to allow method chaining
1426
1566
  */
1427
1567
  insertActionDefinition(
1428
1568
  /**
@@ -1438,6 +1578,9 @@ declare namespace sap {
1438
1578
  ): this;
1439
1579
  /**
1440
1580
  * @EXPERIMENTAL (since 1.65)
1581
+ *
1582
+ *
1583
+ * @returns If the card is ready or not.
1441
1584
  */
1442
1585
  isReady(): boolean;
1443
1586
  /**
@@ -1449,6 +1592,8 @@ declare namespace sap {
1449
1592
  * Returns a promise that resolves with an object { designtime: the designtime modules response manifest:
1450
1593
  * the complete manifest json } The promise is rejected if the module cannot be loaded with an object: {
1451
1594
  * error: "Card.designtime not found" }
1595
+ *
1596
+ * @returns Promise resolves after the designtime configuration is loaded.
1452
1597
  */
1453
1598
  loadDesigntime(): Promise<any>;
1454
1599
  /**
@@ -1468,6 +1613,8 @@ declare namespace sap {
1468
1613
  * @EXPERIMENTAL (since 1.85)
1469
1614
  *
1470
1615
  * Removes a actionDefinition from the aggregation {@link #getActionDefinitions actionDefinitions}.
1616
+ *
1617
+ * @returns The removed actionDefinition or `null`
1471
1618
  */
1472
1619
  removeActionDefinition(
1473
1620
  /**
@@ -1485,12 +1632,16 @@ declare namespace sap {
1485
1632
  * Removes all the controls from the aggregation {@link #getActionDefinitions actionDefinitions}.
1486
1633
  *
1487
1634
  * Additionally, it unregisters them from the hosting UIArea.
1635
+ *
1636
+ * @returns An array of the removed elements (might be empty)
1488
1637
  */
1489
1638
  removeAllActionDefinitions(): sap.ui.integration.ActionDefinition[];
1490
1639
  /**
1491
1640
  * @EXPERIMENTAL (since 1.79)
1492
1641
  *
1493
1642
  * Performs an HTTP request using the given configuration.
1643
+ *
1644
+ * @returns Resolves when the request is successful, rejects otherwise.
1494
1645
  */
1495
1646
  request(
1496
1647
  /**
@@ -1532,6 +1683,8 @@ declare namespace sap {
1532
1683
  ): Promise<any>;
1533
1684
  /**
1534
1685
  * Resolves the destination and returns its URL.
1686
+ *
1687
+ * @returns A promise which resolves with the URL of the destination.
1535
1688
  */
1536
1689
  resolveDestination(
1537
1690
  /**
@@ -1549,6 +1702,8 @@ declare namespace sap {
1549
1702
  * of a URL.
1550
1703
  *
1551
1704
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1705
+ *
1706
+ * @returns Reference to `this` in order to allow method chaining
1552
1707
  */
1553
1708
  setBaseUrl(
1554
1709
  /**
@@ -1561,6 +1716,8 @@ declare namespace sap {
1561
1716
  * @EXPERIMENTAL (since 1.65)
1562
1717
  *
1563
1718
  * Sets a new value for the `dataMode` property.
1719
+ *
1720
+ * @returns Pointer to the control instance to allow method chaining.
1564
1721
  */
1565
1722
  setDataMode(
1566
1723
  /**
@@ -1570,6 +1727,8 @@ declare namespace sap {
1570
1727
  ): this;
1571
1728
  /**
1572
1729
  * Sets the associated {@link #getHost host}.
1730
+ *
1731
+ * @returns Reference to `this` in order to allow method chaining
1573
1732
  */
1574
1733
  setHost(
1575
1734
  /**
@@ -1586,6 +1745,8 @@ declare namespace sap {
1586
1745
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1587
1746
  *
1588
1747
  * Default value is `empty string`.
1748
+ *
1749
+ * @returns Reference to `this` in order to allow method chaining
1589
1750
  */
1590
1751
  setManifest(
1591
1752
  /**
@@ -1617,6 +1778,8 @@ declare namespace sap {
1617
1778
  *
1618
1779
  *
1619
1780
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1781
+ *
1782
+ * @returns Reference to `this` in order to allow method chaining
1620
1783
  */
1621
1784
  setManifestChanges(
1622
1785
  /**
@@ -1698,7 +1861,8 @@ declare namespace sap {
1698
1861
  */
1699
1862
  type?:
1700
1863
  | sap.ui.integration.CardActionType
1701
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1864
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1865
+ | `{${string}}`;
1702
1866
 
1703
1867
  /**
1704
1868
  * The text of the action button.
@@ -1708,30 +1872,43 @@ declare namespace sap {
1708
1872
  /**
1709
1873
  * The icon of the action button.
1710
1874
  */
1711
- icon?: sap.ui.core.URI | sap.ui.base.ManagedObject.PropertyBindingInfo;
1875
+ icon?:
1876
+ | sap.ui.core.URI
1877
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1878
+ | `{${string}}`;
1712
1879
 
1713
1880
  /**
1714
1881
  * The type of the action button.
1715
1882
  */
1716
1883
  buttonType?:
1717
1884
  | sap.m.ButtonType
1718
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1885
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1886
+ | `{${string}}`;
1719
1887
 
1720
1888
  /**
1721
1889
  * Indicates whether the user can interact with the action button or not. **Note**: Disabled controls cannot
1722
1890
  * be focused and they are out of the navigation tab-chain.
1723
1891
  */
1724
- enabled?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
1892
+ enabled?:
1893
+ | boolean
1894
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1895
+ | `{${string}}`;
1725
1896
 
1726
1897
  /**
1727
1898
  * Whether the action button should be visible on the screen.
1728
1899
  */
1729
- visible?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
1900
+ visible?:
1901
+ | boolean
1902
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1903
+ | `{${string}}`;
1730
1904
 
1731
1905
  /**
1732
1906
  * The parameters of the action.
1733
1907
  */
1734
- parameters?: object | sap.ui.base.ManagedObject.PropertyBindingInfo;
1908
+ parameters?:
1909
+ | object
1910
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1911
+ | `{${string}}`;
1735
1912
 
1736
1913
  /**
1737
1914
  * Fired when the action button is pressed.
@@ -1751,14 +1928,18 @@ declare namespace sap {
1751
1928
  */
1752
1929
  actions?:
1753
1930
  | sap.ui.integration.CardMenuAction[]
1754
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1931
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1932
+ | `{${string}}`;
1755
1933
 
1756
1934
  /**
1757
1935
  * @EXPERIMENTAL (since 1.79)
1758
1936
  *
1759
1937
  * The formatters, which can be used in the manifest.
1760
1938
  */
1761
- formatters?: object | sap.ui.base.ManagedObject.PropertyBindingInfo;
1939
+ formatters?:
1940
+ | object
1941
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1942
+ | `{${string}}`;
1762
1943
 
1763
1944
  /**
1764
1945
  * @EXPERIMENTAL (since 1.75)
@@ -1776,7 +1957,8 @@ declare namespace sap {
1776
1957
  */
1777
1958
  actions?:
1778
1959
  | sap.ui.integration.CardMenuAction[]
1779
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1960
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1961
+ | `{${string}}`;
1780
1962
 
1781
1963
  /**
1782
1964
  * A function that resolves the given destination name to a URL.
@@ -1791,7 +1973,8 @@ declare namespace sap {
1791
1973
  */
1792
1974
  resolveDestination?:
1793
1975
  | Function
1794
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1976
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1977
+ | `{${string}}`;
1795
1978
 
1796
1979
  /**
1797
1980
  * @EXPERIMENTAL (since 1.75)
@@ -1860,6 +2043,8 @@ declare namespace sap {
1860
2043
  * it with the information contained in `oClassInfo`.
1861
2044
  *
1862
2045
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
2046
+ *
2047
+ * @returns Created class / constructor function
1863
2048
  */
1864
2049
  static extend<T extends Record<string, unknown>>(
1865
2050
  /**
@@ -1878,6 +2063,8 @@ declare namespace sap {
1878
2063
  ): Function;
1879
2064
  /**
1880
2065
  * Returns a metadata object for class sap.ui.integration.ActionDefinition.
2066
+ *
2067
+ * @returns Metadata object describing this class
1881
2068
  */
1882
2069
  static getMetadata(): sap.ui.core.ElementMetadata;
1883
2070
  /**
@@ -1887,6 +2074,8 @@ declare namespace sap {
1887
2074
  * otherwise it will be bound to this `sap.ui.integration.ActionDefinition` itself.
1888
2075
  *
1889
2076
  * Fired when the action button is pressed.
2077
+ *
2078
+ * @returns Reference to `this` in order to allow method chaining
1890
2079
  */
1891
2080
  attachPress(
1892
2081
  /**
@@ -1911,6 +2100,8 @@ declare namespace sap {
1911
2100
  * otherwise it will be bound to this `sap.ui.integration.ActionDefinition` itself.
1912
2101
  *
1913
2102
  * Fired when the action button is pressed.
2103
+ *
2104
+ * @returns Reference to `this` in order to allow method chaining
1914
2105
  */
1915
2106
  attachPress(
1916
2107
  /**
@@ -1927,6 +2118,8 @@ declare namespace sap {
1927
2118
  * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.ui.integration.ActionDefinition`.
1928
2119
  *
1929
2120
  * The passed function and listener object must match the ones used for event registration.
2121
+ *
2122
+ * @returns Reference to `this` in order to allow method chaining
1930
2123
  */
1931
2124
  detachPress(
1932
2125
  /**
@@ -1940,6 +2133,8 @@ declare namespace sap {
1940
2133
  ): this;
1941
2134
  /**
1942
2135
  * Fires event {@link #event:press press} to attached listeners.
2136
+ *
2137
+ * @returns Reference to `this` in order to allow method chaining
1943
2138
  */
1944
2139
  firePress(
1945
2140
  /**
@@ -1953,6 +2148,8 @@ declare namespace sap {
1953
2148
  * The type of the action button.
1954
2149
  *
1955
2150
  * Default value is `Transparent`.
2151
+ *
2152
+ * @returns Value of property `buttonType`
1956
2153
  */
1957
2154
  getButtonType(): sap.m.ButtonType;
1958
2155
  /**
@@ -1962,18 +2159,24 @@ declare namespace sap {
1962
2159
  * be focused and they are out of the navigation tab-chain.
1963
2160
  *
1964
2161
  * Default value is `true`.
2162
+ *
2163
+ * @returns Value of property `enabled`
1965
2164
  */
1966
2165
  getEnabled(): boolean;
1967
2166
  /**
1968
2167
  * Gets current value of property {@link #getIcon icon}.
1969
2168
  *
1970
2169
  * The icon of the action button.
2170
+ *
2171
+ * @returns Value of property `icon`
1971
2172
  */
1972
2173
  getIcon(): sap.ui.core.URI;
1973
2174
  /**
1974
2175
  * Gets current value of property {@link #getParameters parameters}.
1975
2176
  *
1976
2177
  * The parameters of the action.
2178
+ *
2179
+ * @returns Value of property `parameters`
1977
2180
  */
1978
2181
  getParameters(): object;
1979
2182
  /**
@@ -1982,12 +2185,16 @@ declare namespace sap {
1982
2185
  * The text of the action button.
1983
2186
  *
1984
2187
  * Default value is `empty string`.
2188
+ *
2189
+ * @returns Value of property `text`
1985
2190
  */
1986
2191
  getText(): string;
1987
2192
  /**
1988
2193
  * Gets current value of property {@link #getType type}.
1989
2194
  *
1990
2195
  * The type of the action.
2196
+ *
2197
+ * @returns Value of property `type`
1991
2198
  */
1992
2199
  getType(): sap.ui.integration.CardActionType;
1993
2200
  /**
@@ -1996,6 +2203,8 @@ declare namespace sap {
1996
2203
  * Whether the action button should be visible on the screen.
1997
2204
  *
1998
2205
  * Default value is `true`.
2206
+ *
2207
+ * @returns Value of property `visible`
1999
2208
  */
2000
2209
  getVisible(): boolean;
2001
2210
  /**
@@ -2006,6 +2215,8 @@ declare namespace sap {
2006
2215
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2007
2216
  *
2008
2217
  * Default value is `Transparent`.
2218
+ *
2219
+ * @returns Reference to `this` in order to allow method chaining
2009
2220
  */
2010
2221
  setButtonType(
2011
2222
  /**
@@ -2022,6 +2233,8 @@ declare namespace sap {
2022
2233
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2023
2234
  *
2024
2235
  * Default value is `true`.
2236
+ *
2237
+ * @returns Reference to `this` in order to allow method chaining
2025
2238
  */
2026
2239
  setEnabled(
2027
2240
  /**
@@ -2035,6 +2248,8 @@ declare namespace sap {
2035
2248
  * The icon of the action button.
2036
2249
  *
2037
2250
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2251
+ *
2252
+ * @returns Reference to `this` in order to allow method chaining
2038
2253
  */
2039
2254
  setIcon(
2040
2255
  /**
@@ -2048,6 +2263,8 @@ declare namespace sap {
2048
2263
  * The parameters of the action.
2049
2264
  *
2050
2265
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2266
+ *
2267
+ * @returns Reference to `this` in order to allow method chaining
2051
2268
  */
2052
2269
  setParameters(
2053
2270
  /**
@@ -2063,6 +2280,8 @@ declare namespace sap {
2063
2280
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2064
2281
  *
2065
2282
  * Default value is `empty string`.
2283
+ *
2284
+ * @returns Reference to `this` in order to allow method chaining
2066
2285
  */
2067
2286
  setText(
2068
2287
  /**
@@ -2076,6 +2295,8 @@ declare namespace sap {
2076
2295
  * The type of the action.
2077
2296
  *
2078
2297
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2298
+ *
2299
+ * @returns Reference to `this` in order to allow method chaining
2079
2300
  */
2080
2301
  setType(
2081
2302
  /**
@@ -2091,6 +2312,8 @@ declare namespace sap {
2091
2312
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2092
2313
  *
2093
2314
  * Default value is `true`.
2315
+ *
2316
+ * @returns Reference to `this` in order to allow method chaining
2094
2317
  */
2095
2318
  setVisible(
2096
2319
  /**
@@ -2149,6 +2372,8 @@ declare namespace sap {
2149
2372
  * with the information contained in `oClassInfo`.
2150
2373
  *
2151
2374
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.ManagedObject.extend}.
2375
+ *
2376
+ * @returns Created class / constructor function
2152
2377
  */
2153
2378
  static extend<T extends Record<string, unknown>>(
2154
2379
  /**
@@ -2167,10 +2392,14 @@ declare namespace sap {
2167
2392
  ): Function;
2168
2393
  /**
2169
2394
  * Returns a metadata object for class sap.ui.integration.Designtime.
2395
+ *
2396
+ * @returns Metadata object describing this class
2170
2397
  */
2171
2398
  static getMetadata(): sap.ui.base.ManagedObjectMetadata;
2172
2399
  /**
2173
2400
  * Returns an interface to the card, which uses this extension.
2401
+ *
2402
+ * @returns An interface to the card.
2174
2403
  */
2175
2404
  getCard(): sap.ui.integration.widgets.CardFacade;
2176
2405
  }
@@ -2217,6 +2446,8 @@ declare namespace sap {
2217
2446
  * the information contained in `oClassInfo`.
2218
2447
  *
2219
2448
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.ManagedObject.extend}.
2449
+ *
2450
+ * @returns Created class / constructor function
2220
2451
  */
2221
2452
  static extend<T extends Record<string, unknown>>(
2222
2453
  /**
@@ -2235,6 +2466,8 @@ declare namespace sap {
2235
2466
  ): Function;
2236
2467
  /**
2237
2468
  * Returns a metadata object for class sap.ui.integration.Extension.
2469
+ *
2470
+ * @returns Metadata object describing this class
2238
2471
  */
2239
2472
  static getMetadata(): sap.ui.base.ManagedObjectMetadata;
2240
2473
  /**
@@ -2246,6 +2479,8 @@ declare namespace sap {
2246
2479
  * otherwise it will be bound to this `sap.ui.integration.Extension` itself.
2247
2480
  *
2248
2481
  * Fired when an action is triggered in the card.
2482
+ *
2483
+ * @returns Reference to `this` in order to allow method chaining
2249
2484
  */
2250
2485
  attachAction(
2251
2486
  /**
@@ -2271,6 +2506,8 @@ declare namespace sap {
2271
2506
  * otherwise it will be bound to this `sap.ui.integration.Extension` itself.
2272
2507
  *
2273
2508
  * Fired when an action is triggered in the card.
2509
+ *
2510
+ * @returns Reference to `this` in order to allow method chaining
2274
2511
  */
2275
2512
  attachAction(
2276
2513
  /**
@@ -2288,6 +2525,8 @@ declare namespace sap {
2288
2525
  * Detaches event handler `fnFunction` from the {@link #event:action action} event of this `sap.ui.integration.Extension`.
2289
2526
  *
2290
2527
  * The passed function and listener object must match the ones used for event registration.
2528
+ *
2529
+ * @returns Reference to `this` in order to allow method chaining
2291
2530
  */
2292
2531
  detachAction(
2293
2532
  /**
@@ -2306,6 +2545,8 @@ declare namespace sap {
2306
2545
  *
2307
2546
  * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
2308
2547
  * event object. The return value of this method indicates whether the default action should be executed.
2548
+ *
2549
+ * @returns Whether or not to prevent the default action
2309
2550
  */
2310
2551
  fireAction(
2311
2552
  /**
@@ -2341,10 +2582,14 @@ declare namespace sap {
2341
2582
  * Gets current value of property {@link #getActions actions}.
2342
2583
  *
2343
2584
  * The actions configuration.
2585
+ *
2586
+ * @returns Value of property `actions`
2344
2587
  */
2345
2588
  getActions(): sap.ui.integration.CardMenuAction[];
2346
2589
  /**
2347
2590
  * Returns an interface to the card, which uses this extension.
2591
+ *
2592
+ * @returns An interface to the card.
2348
2593
  */
2349
2594
  getCard(): sap.ui.integration.widgets.CardFacade;
2350
2595
  /**
@@ -2353,6 +2598,8 @@ declare namespace sap {
2353
2598
  * Gets current value of property {@link #getFormatters formatters}.
2354
2599
  *
2355
2600
  * The formatters, which can be used in the manifest.
2601
+ *
2602
+ * @returns Value of property `formatters`
2356
2603
  */
2357
2604
  getFormatters(): object;
2358
2605
  /**
@@ -2405,6 +2652,8 @@ declare namespace sap {
2405
2652
  * information contained in `oClassInfo`.
2406
2653
  *
2407
2654
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
2655
+ *
2656
+ * @returns Created class / constructor function
2408
2657
  */
2409
2658
  static extend<T extends Record<string, unknown>>(
2410
2659
  /**
@@ -2423,6 +2672,8 @@ declare namespace sap {
2423
2672
  ): Function;
2424
2673
  /**
2425
2674
  * Returns a metadata object for class sap.ui.integration.Host.
2675
+ *
2676
+ * @returns Metadata object describing this class
2426
2677
  */
2427
2678
  static getMetadata(): sap.ui.core.ElementMetadata;
2428
2679
  /**
@@ -2434,6 +2685,8 @@ declare namespace sap {
2434
2685
  * otherwise it will be bound to this `sap.ui.integration.Host` itself.
2435
2686
  *
2436
2687
  * Fired when an action is triggered.
2688
+ *
2689
+ * @returns Reference to `this` in order to allow method chaining
2437
2690
  */
2438
2691
  attachAction(
2439
2692
  /**
@@ -2459,6 +2712,8 @@ declare namespace sap {
2459
2712
  * otherwise it will be bound to this `sap.ui.integration.Host` itself.
2460
2713
  *
2461
2714
  * Fired when an action is triggered.
2715
+ *
2716
+ * @returns Reference to `this` in order to allow method chaining
2462
2717
  */
2463
2718
  attachAction(
2464
2719
  /**
@@ -2481,6 +2736,8 @@ declare namespace sap {
2481
2736
  *
2482
2737
  * Fired when some card configuration settings are changed as a result of user interaction. For example
2483
2738
  * - filter value is changed.
2739
+ *
2740
+ * @returns Reference to `this` in order to allow method chaining
2484
2741
  */
2485
2742
  attachCardConfigurationChange(
2486
2743
  /**
@@ -2508,6 +2765,8 @@ declare namespace sap {
2508
2765
  *
2509
2766
  * Fired when some card configuration settings are changed as a result of user interaction. For example
2510
2767
  * - filter value is changed.
2768
+ *
2769
+ * @returns Reference to `this` in order to allow method chaining
2511
2770
  */
2512
2771
  attachCardConfigurationChange(
2513
2772
  /**
@@ -2528,6 +2787,8 @@ declare namespace sap {
2528
2787
  * otherwise it will be bound to this `sap.ui.integration.Host` itself.
2529
2788
  *
2530
2789
  * Fired when a message from channels like navigator.serviceWorker is received.
2790
+ *
2791
+ * @returns Reference to `this` in order to allow method chaining
2531
2792
  */
2532
2793
  attachMessage(
2533
2794
  /**
@@ -2553,6 +2814,8 @@ declare namespace sap {
2553
2814
  * otherwise it will be bound to this `sap.ui.integration.Host` itself.
2554
2815
  *
2555
2816
  * Fired when a message from channels like navigator.serviceWorker is received.
2817
+ *
2818
+ * @returns Reference to `this` in order to allow method chaining
2556
2819
  */
2557
2820
  attachMessage(
2558
2821
  /**
@@ -2596,6 +2859,8 @@ declare namespace sap {
2596
2859
  * Detaches event handler `fnFunction` from the {@link #event:action action} event of this `sap.ui.integration.Host`.
2597
2860
  *
2598
2861
  * The passed function and listener object must match the ones used for event registration.
2862
+ *
2863
+ * @returns Reference to `this` in order to allow method chaining
2599
2864
  */
2600
2865
  detachAction(
2601
2866
  /**
@@ -2614,6 +2879,8 @@ declare namespace sap {
2614
2879
  * event of this `sap.ui.integration.Host`.
2615
2880
  *
2616
2881
  * The passed function and listener object must match the ones used for event registration.
2882
+ *
2883
+ * @returns Reference to `this` in order to allow method chaining
2617
2884
  */
2618
2885
  detachCardConfigurationChange(
2619
2886
  /**
@@ -2631,6 +2898,8 @@ declare namespace sap {
2631
2898
  * Detaches event handler `fnFunction` from the {@link #event:message message} event of this `sap.ui.integration.Host`.
2632
2899
  *
2633
2900
  * The passed function and listener object must match the ones used for event registration.
2901
+ *
2902
+ * @returns Reference to `this` in order to allow method chaining
2634
2903
  */
2635
2904
  detachMessage(
2636
2905
  /**
@@ -2649,6 +2918,8 @@ declare namespace sap {
2649
2918
  *
2650
2919
  * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
2651
2920
  * event object. The return value of this method indicates whether the default action should be executed.
2921
+ *
2922
+ * @returns Whether or not to prevent the default action
2652
2923
  */
2653
2924
  fireAction(
2654
2925
  /**
@@ -2681,6 +2952,8 @@ declare namespace sap {
2681
2952
  * @EXPERIMENTAL (since 1.96)
2682
2953
  *
2683
2954
  * Fires event {@link #event:cardConfigurationChange cardConfigurationChange} to attached listeners.
2955
+ *
2956
+ * @returns Reference to `this` in order to allow method chaining
2684
2957
  */
2685
2958
  fireCardConfigurationChange(
2686
2959
  /**
@@ -2710,6 +2983,8 @@ declare namespace sap {
2710
2983
  * @EXPERIMENTAL (since 1.91)
2711
2984
  *
2712
2985
  * Fires event {@link #event:message message} to attached listeners.
2986
+ *
2987
+ * @returns Reference to `this` in order to allow method chaining
2713
2988
  */
2714
2989
  fireMessage(
2715
2990
  /**
@@ -2725,6 +3000,8 @@ declare namespace sap {
2725
3000
  * Gets current value of property {@link #getActions actions}.
2726
3001
  *
2727
3002
  * The actions configuration.
3003
+ *
3004
+ * @returns Value of property `actions`
2728
3005
  */
2729
3006
  getActions(): sap.ui.integration.CardMenuAction[];
2730
3007
  /**
@@ -2740,6 +3017,8 @@ declare namespace sap {
2740
3017
  *
2741
3018
  * The context information and texts should be translated as they appear in the design-time UI of the Card
2742
3019
  * Editor.
3020
+ *
3021
+ * @returns A promise which contains the context structure.
2743
3022
  */
2744
3023
  getContexts(): Promise<any>;
2745
3024
  /**
@@ -2754,6 +3033,8 @@ declare namespace sap {
2754
3033
  *
2755
3034
  * Example path to the current user id of the context sPath = "sap.workzone/currentUser/id" parameter: {
2756
3035
  * userId: { value: "{context>sap.workzone/currentUser/id}" resolves to UserId } }
3036
+ *
3037
+ * @returns A promise which resolves with the value of this context.
2757
3038
  */
2758
3039
  getContextValue(
2759
3040
  /**
@@ -2765,6 +3046,8 @@ declare namespace sap {
2765
3046
  * @EXPERIMENTAL (since 1.97)
2766
3047
  *
2767
3048
  * Resolves the CSRF token and returns a Promise with its value.
3049
+ *
3050
+ * @returns A promise which resolves the CSRF token to its value.
2768
3051
  */
2769
3052
  getCsrfToken(
2770
3053
  /**
@@ -2774,6 +3057,8 @@ declare namespace sap {
2774
3057
  ): Promise<any>;
2775
3058
  /**
2776
3059
  * Resolves the destination and returns its URL.
3060
+ *
3061
+ * @returns A promise which resolves with the URL of the destination.
2777
3062
  */
2778
3063
  getDestination(
2779
3064
  /**
@@ -2786,6 +3071,8 @@ declare namespace sap {
2786
3071
  *
2787
3072
  * Returns the list of destinations for the Card Editor design-time environment List entries are objects
2788
3073
  * that contain at least the name. { "name": "DestinationName" }
3074
+ *
3075
+ * @returns A promise which resolves with the list of destinations.
2789
3076
  */
2790
3077
  getDestinations(): Promise<any>;
2791
3078
  /**
@@ -2800,6 +3087,8 @@ declare namespace sap {
2800
3087
  *
2801
3088
  * The callback receives `destinationName` as parameter and returns a string with the URL. Or alternatively
2802
3089
  * the callback may return a `Promise` with the URL as an argument.
3090
+ *
3091
+ * @returns Value of property `resolveDestination`
2803
3092
  */
2804
3093
  getResolveDestination(): Function;
2805
3094
  /**
@@ -2810,6 +3099,8 @@ declare namespace sap {
2810
3099
  * The actions configuration.
2811
3100
  *
2812
3101
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3102
+ *
3103
+ * @returns Reference to `this` in order to allow method chaining
2813
3104
  */
2814
3105
  setActions(
2815
3106
  /**
@@ -2831,6 +3122,8 @@ declare namespace sap {
2831
3122
  * the callback may return a `Promise` with the URL as an argument.
2832
3123
  *
2833
3124
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3125
+ *
3126
+ * @returns Reference to `this` in order to allow method chaining
2834
3127
  */
2835
3128
  setResolveDestination(
2836
3129
  /**
@@ -2863,7 +3156,7 @@ declare namespace sap {
2863
3156
  /**
2864
3157
  * @EXPERIMENTAL (since 1.76)
2865
3158
  *
2866
- * Used for custom actions
3159
+ * Used for custom actions.
2867
3160
  */
2868
3161
  Custom = "Custom",
2869
3162
  /**
@@ -2872,6 +3165,12 @@ declare namespace sap {
2872
3165
  * Date selection. Available only for Calendar cards.
2873
3166
  */
2874
3167
  DateChange = "DateChange",
3168
+ /**
3169
+ * @EXPERIMENTAL (since 1.100)
3170
+ *
3171
+ * Used for hiding the appeared details about the card.
3172
+ */
3173
+ HideCard = "HideCard",
2875
3174
  /**
2876
3175
  * @EXPERIMENTAL (since 1.87)
2877
3176
  *
@@ -2879,11 +3178,17 @@ declare namespace sap {
2879
3178
  */
2880
3179
  MonthChange = "MonthChange",
2881
3180
  /**
2882
- * Used for navigation actions
3181
+ * Used for navigation actions.
2883
3182
  */
2884
3183
  Navigation = "Navigation",
2885
3184
  /**
2886
- * Used for submit actions
3185
+ * @EXPERIMENTAL (since 1.100)
3186
+ *
3187
+ * Used for showing more details about the card.
3188
+ */
3189
+ ShowCard = "ShowCard",
3190
+ /**
3191
+ * Used for submit actions.
2887
3192
  */
2888
3193
  Submit = "Submit",
2889
3194
  }
@@ -3013,6 +3318,8 @@ declare namespace sap {
3013
3318
 
3014
3319
  "sap/ui/integration/designtime/baseEditor/propertyEditor/numberEditor/NumberEditor": undefined;
3015
3320
 
3321
+ "sap/ui/integration/designtime/baseEditor/propertyEditor/objectArrayEditor/ObjectArrayEditor": undefined;
3322
+
3016
3323
  "sap/ui/integration/designtime/baseEditor/propertyEditor/PropertyEditorFactory": undefined;
3017
3324
 
3018
3325
  "sap/ui/integration/designtime/baseEditor/propertyEditor/selectEditor/SelectEditor": undefined;
@@ -3081,12 +3388,16 @@ declare namespace sap {
3081
3388
 
3082
3389
  "sap/ui/integration/editor/fields/IntegerField": undefined;
3083
3390
 
3084
- "sap/ui/integration/editor/fields/ListField": undefined;
3085
-
3086
3391
  "sap/ui/integration/editor/fields/NumberField": undefined;
3087
3392
 
3393
+ "sap/ui/integration/editor/fields/ObjectField": undefined;
3394
+
3395
+ "sap/ui/integration/editor/fields/ObjectListField": undefined;
3396
+
3088
3397
  "sap/ui/integration/editor/fields/StringField": undefined;
3089
3398
 
3399
+ "sap/ui/integration/editor/fields/StringListField": undefined;
3400
+
3090
3401
  "sap/ui/integration/editor/fields/viz/ColorSelect": undefined;
3091
3402
 
3092
3403
  "sap/ui/integration/editor/fields/viz/IconSelect": undefined;