@sapui5/ts-types 1.100.2 → 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.
Files changed (62) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +2 -0
  3. package/types/sap.apf.d.ts +89 -1
  4. package/types/sap.ca.ui.d.ts +1747 -124
  5. package/types/sap.chart.d.ts +376 -30
  6. package/types/sap.collaboration.d.ts +320 -40
  7. package/types/sap.esh.search.ui.d.ts +6 -2
  8. package/types/sap.f.d.ts +2015 -119
  9. package/types/sap.fe.common.d.ts +1 -1
  10. package/types/sap.fe.core.d.ts +77 -64
  11. package/types/sap.fe.macros.d.ts +92 -40
  12. package/types/sap.fe.navigation.d.ts +148 -74
  13. package/types/sap.fe.templates.d.ts +115 -187
  14. package/types/sap.fe.test.d.ts +539 -25
  15. package/types/sap.feedback.ui.d.ts +1 -1
  16. package/types/sap.gantt.d.ts +7242 -516
  17. package/types/sap.insights.d.ts +80 -0
  18. package/types/sap.landvisz.d.ts +1015 -66
  19. package/types/sap.m.d.ts +16699 -1186
  20. package/types/sap.makit.d.ts +575 -54
  21. package/types/sap.me.d.ts +578 -51
  22. package/types/sap.ndc.d.ts +63 -5
  23. package/types/sap.ovp.d.ts +5 -6
  24. package/types/sap.rules.ui.d.ts +209 -18
  25. package/types/sap.sac.df.d.ts +2196 -0
  26. package/types/sap.sac.grid.d.ts +115 -8
  27. package/types/sap.suite.ui.commons.d.ts +5532 -396
  28. package/types/sap.suite.ui.generic.template.d.ts +226 -31
  29. package/types/sap.suite.ui.microchart.d.ts +1801 -160
  30. package/types/sap.tnt.d.ts +279 -19
  31. package/types/sap.ui.codeeditor.d.ts +89 -8
  32. package/types/sap.ui.commons.d.ts +3784 -313
  33. package/types/sap.ui.comp.d.ts +4005 -289
  34. package/types/sap.ui.core.d.ts +6317 -336
  35. package/types/sap.ui.dt.d.ts +1 -1
  36. package/types/sap.ui.export.d.ts +61 -6
  37. package/types/sap.ui.fl.d.ts +1 -1
  38. package/types/sap.ui.generic.app.d.ts +247 -73
  39. package/types/sap.ui.generic.template.d.ts +1 -1
  40. package/types/sap.ui.integration.d.ts +316 -23
  41. package/types/sap.ui.layout.d.ts +1851 -199
  42. package/types/sap.ui.mdc.d.ts +9 -1
  43. package/types/sap.ui.richtexteditor.d.ts +340 -49
  44. package/types/sap.ui.rta.d.ts +5 -1
  45. package/types/sap.ui.suite.d.ts +87 -6
  46. package/types/sap.ui.support.d.ts +39 -6
  47. package/types/sap.ui.table.d.ts +1060 -113
  48. package/types/sap.ui.testrecorder.d.ts +1 -1
  49. package/types/sap.ui.unified.d.ts +2704 -202
  50. package/types/sap.ui.ux3.d.ts +2379 -181
  51. package/types/sap.ui.vbm.d.ts +2002 -197
  52. package/types/sap.ui.vk.d.ts +6027 -327
  53. package/types/sap.ui.vtm.d.ts +1130 -41
  54. package/types/sap.uiext.inbox.d.ts +423 -22
  55. package/types/sap.ushell.d.ts +2036 -161
  56. package/types/sap.ushell_abap.d.ts +4 -1
  57. package/types/sap.uxap.d.ts +903 -88
  58. package/types/sap.viz.d.ts +5514 -380
  59. package/types/sap.webanalytics.core.d.ts +1 -1
  60. package/types/sap.zen.commons.d.ts +249 -1688
  61. package/types/sap.zen.crosstab.d.ts +217 -21
  62. package/types/sap.zen.dsh.d.ts +1505 -4036
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.100.0
1
+ // For Library Version: 1.102.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace fe {
@@ -12,27 +12,14 @@ declare namespace sap {
12
12
 
13
13
  /**
14
14
  * Cancels the dialog by clicking the corresponding button (for example, 'Cancel').
15
+ *
16
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
15
17
  */
16
18
  iCancel(): object;
17
- /**
18
- * Changes the content of a field in an action parameter dialog.
19
- */
20
- iChangeActionParameterDialogField(
21
- /**
22
- * The identifier of the field
23
- */
24
- vFieldIdentifier: sap.fe.test.api.ActionDialogFieldIdentifier,
25
- /**
26
- * The new target value.
27
- */
28
- vValue?: string,
29
- /**
30
- * Set to `true` to clear previously set filters, otherwise all previously set values will be kept
31
- */
32
- bClearFirst?: boolean
33
- ): object;
34
19
  /**
35
20
  * Changes the content of a field in a dialog.
21
+ *
22
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
36
23
  */
37
24
  iChangeDialogField(
38
25
  /**
@@ -50,10 +37,14 @@ declare namespace sap {
50
37
  ): object;
51
38
  /**
52
39
  * Closes the dialog by pressing the 'Escape' key.
40
+ *
41
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
53
42
  */
54
43
  iClose(): object;
55
44
  /**
56
45
  * Confirms the dialog by clicking the corresponding button (for example, 'OK').
46
+ *
47
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
57
48
  */
58
49
  iConfirm(): object;
59
50
  }
@@ -63,6 +54,8 @@ declare namespace sap {
63
54
 
64
55
  /**
65
56
  * Checks the content and state of a field in an action parameter dialog.
57
+ *
58
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
66
59
  */
67
60
  iCheckActionParameterDialogField(
68
61
  /**
@@ -86,6 +79,8 @@ declare namespace sap {
86
79
  ): object;
87
80
  /**
88
81
  * Checks the cancellation button of the dialog.
82
+ *
83
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
89
84
  */
90
85
  iCheckCancel(
91
86
  /**
@@ -95,6 +90,8 @@ declare namespace sap {
95
90
  ): object;
96
91
  /**
97
92
  * Checks the confirmation button of the dialog.
93
+ *
94
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
98
95
  */
99
96
  iCheckConfirm(
100
97
  /**
@@ -104,6 +101,8 @@ declare namespace sap {
104
101
  ): object;
105
102
  /**
106
103
  * Checks the content and state of a field in a dialog.
104
+ *
105
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
107
106
  */
108
107
  iCheckDialogField(
109
108
  /**
@@ -127,6 +126,8 @@ declare namespace sap {
127
126
  ): object;
128
127
  /**
129
128
  * Checks the dialog.
129
+ *
130
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
130
131
  */
131
132
  iCheckState(
132
133
  /**
@@ -141,6 +142,8 @@ declare namespace sap {
141
142
 
142
143
  /**
143
144
  * Executes the `Create` action on the create dialog.
145
+ *
146
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
144
147
  */
145
148
  iExecuteCreate(): object;
146
149
  }
@@ -150,6 +153,8 @@ declare namespace sap {
150
153
 
151
154
  /**
152
155
  * Checks the `Create` action on the dialog.
156
+ *
157
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
153
158
  */
154
159
  iCheckCreate(
155
160
  /**
@@ -162,18 +167,24 @@ declare namespace sap {
162
167
  class DialogMessageActions extends sap.fe.test.api.DialogActions {
163
168
  constructor();
164
169
 
165
- /**
166
- * Confirms the draft message with Discard Draft when navigating back to the list-report.
167
- */
168
- iConfirmDiscardDraft(): object;
169
170
  /**
170
171
  * Executes the `Back` action on the message dialog.
172
+ *
173
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
171
174
  */
172
175
  iExecuteBack(): object;
173
176
  /**
174
177
  * Executes the `Refresh` action on the message dialog.
178
+ *
179
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
175
180
  */
176
181
  iExecuteRefresh(): object;
182
+ /**
183
+ * Selects the specified entry in the draft data loss popup
184
+ *
185
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
186
+ */
187
+ iSelectDraftDataLossOption(): object;
177
188
  }
178
189
 
179
190
  class DialogMessageAssertions extends sap.fe.test.api.DialogAssertions {
@@ -181,6 +192,8 @@ declare namespace sap {
181
192
 
182
193
  /**
183
194
  * Checks the `Back` action on the message dialog.
195
+ *
196
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
184
197
  */
185
198
  iCheckBack(
186
199
  /**
@@ -190,6 +203,8 @@ declare namespace sap {
190
203
  ): object;
191
204
  /**
192
205
  * Checks whether a certain message is shown in the dialog.
206
+ *
207
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
193
208
  */
194
209
  iCheckMessage(
195
210
  /**
@@ -199,6 +214,8 @@ declare namespace sap {
199
214
  ): object;
200
215
  /**
201
216
  * Checks the `Refresh` action on the dialog.
217
+ *
218
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
202
219
  */
203
220
  iCheckRefresh(
204
221
  /**
@@ -213,6 +230,8 @@ declare namespace sap {
213
230
 
214
231
  /**
215
232
  * Adds a new condition.
233
+ *
234
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
216
235
  */
217
236
  iAddCondition(
218
237
  /**
@@ -227,6 +246,8 @@ declare namespace sap {
227
246
  ): object;
228
247
  /**
229
248
  * Changes an existing condition.
249
+ *
250
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
230
251
  */
231
252
  iChangeCondition(
232
253
  /**
@@ -245,6 +266,8 @@ declare namespace sap {
245
266
  ): object;
246
267
  /**
247
268
  * Changes the value of a filter field.
269
+ *
270
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
248
271
  */
249
272
  iChangeFilterField(
250
273
  /**
@@ -262,6 +285,8 @@ declare namespace sap {
262
285
  ): object;
263
286
  /**
264
287
  * Changes the value of the search field.
288
+ *
289
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
265
290
  */
266
291
  iChangeSearchField(
267
292
  /**
@@ -271,22 +296,32 @@ declare namespace sap {
271
296
  ): object;
272
297
  /**
273
298
  * Starts the search.
299
+ *
300
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
274
301
  */
275
302
  iExecuteSearch(): object;
276
303
  /**
277
304
  * Clicks the `Hide/Show Filters` button.
305
+ *
306
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
278
307
  */
279
308
  iExecuteShowHideFilters(): object;
280
309
  /**
281
310
  * Navigates to the `Define Conditions` tab.
311
+ *
312
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
282
313
  */
283
314
  iGoToDefineConditions(): object;
284
315
  /**
285
316
  * Navigates to the `Search and Select` tab.
317
+ *
318
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
286
319
  */
287
320
  iGoToSearchAndSelect(): object;
288
321
  /**
289
322
  * Removes an existing condition.
323
+ *
324
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
290
325
  */
291
326
  iRemoveCondition(
292
327
  /**
@@ -296,10 +331,14 @@ declare namespace sap {
296
331
  ): object;
297
332
  /**
298
333
  * Resets the search field value.
334
+ *
335
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
299
336
  */
300
337
  iResetSearchField(): object;
301
338
  /**
302
339
  * Selects the specified rows.
340
+ *
341
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
303
342
  */
304
343
  iSelectRows(
305
344
  /**
@@ -326,6 +365,8 @@ declare namespace sap {
326
365
 
327
366
  /**
328
367
  * Checks the `Define conditions` tab.
368
+ *
369
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
329
370
  */
330
371
  iCheckDefineConditions(
331
372
  /**
@@ -335,6 +376,8 @@ declare namespace sap {
335
376
  ): object;
336
377
  /**
337
378
  * Checks the filter bar.
379
+ *
380
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
338
381
  */
339
382
  iCheckFilterBar(
340
383
  /**
@@ -344,6 +387,8 @@ declare namespace sap {
344
387
  ): object;
345
388
  /**
346
389
  * Checks a filter field. If `vConditionValues` is `undefined`, the current condition values are ignored.
390
+ *
391
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
347
392
  */
348
393
  iCheckFilterField(
349
394
  /**
@@ -368,6 +413,8 @@ declare namespace sap {
368
413
  * considered. If `iNumberOfRows` is provided, the number of rows are checked with respect to the provided
369
414
  * `mRowValues` (if set) or in total. If `iNumberOfRows` is omitted, it checks for at least one matching
370
415
  * row. If `mState` is provided, the row must be in the given state.
416
+ *
417
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
371
418
  */
372
419
  iCheckRows(
373
420
  /**
@@ -391,6 +438,8 @@ declare namespace sap {
391
438
  ): object;
392
439
  /**
393
440
  * Checks the `Search and Select` tab.
441
+ *
442
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
394
443
  */
395
444
  iCheckSearchAndSelect(
396
445
  /**
@@ -401,6 +450,8 @@ declare namespace sap {
401
450
  /**
402
451
  * Checks the search field in the filter bar. If the `sSearchText` parameter is `undefined`, the search
403
452
  * text is not validated.
453
+ *
454
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
404
455
  */
405
456
  iCheckSearchField(
406
457
  /**
@@ -414,6 +465,8 @@ declare namespace sap {
414
465
  ): object;
415
466
  /**
416
467
  * Checks the table.
468
+ *
469
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
417
470
  */
418
471
  iCheckTable(
419
472
  /**
@@ -428,6 +481,8 @@ declare namespace sap {
428
481
 
429
482
  /**
430
483
  * Adds a field as a filter field.
484
+ *
485
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
431
486
  */
432
487
  iAddAdaptationFilterField(
433
488
  /**
@@ -437,6 +492,8 @@ declare namespace sap {
437
492
  ): object;
438
493
  /**
439
494
  * Changes the editing status filter field.
495
+ *
496
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
440
497
  */
441
498
  iChangeEditingStatus(
442
499
  /**
@@ -446,6 +503,8 @@ declare namespace sap {
446
503
  ): object;
447
504
  /**
448
505
  * Changes the value of the defined filter field.
506
+ *
507
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
449
508
  */
450
509
  iChangeFilterField(
451
510
  /**
@@ -463,6 +522,8 @@ declare namespace sap {
463
522
  ): object;
464
523
  /**
465
524
  * Changes the search field.
525
+ *
526
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
466
527
  */
467
528
  iChangeSearchField(
468
529
  /**
@@ -472,6 +533,8 @@ declare namespace sap {
472
533
  ): object;
473
534
  /**
474
535
  * Executes a keyboard shortcut.
536
+ *
537
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
475
538
  */
476
539
  iExecuteKeyboardShortcut(
477
540
  /**
@@ -485,10 +548,14 @@ declare namespace sap {
485
548
  ): object;
486
549
  /**
487
550
  * Executes the search with the current filters.
551
+ *
552
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
488
553
  */
489
554
  iExecuteSearch(): object;
490
555
  /**
491
556
  * Opens the value help of the given field.
557
+ *
558
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
492
559
  */
493
560
  iOpenValueHelp(
494
561
  /**
@@ -498,6 +565,8 @@ declare namespace sap {
498
565
  ): object;
499
566
  /**
500
567
  * Removes a field as a filter field.
568
+ *
569
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
501
570
  */
502
571
  iRemoveAdaptationFilterField(
503
572
  /**
@@ -507,10 +576,14 @@ declare namespace sap {
507
576
  ): object;
508
577
  /**
509
578
  * Resets the search field.
579
+ *
580
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
510
581
  */
511
582
  iResetSearchField(): object;
512
583
  /**
513
584
  * Saves a variant under the given name, or overwrites the current variant.
585
+ *
586
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
514
587
  */
515
588
  iSaveVariant(
516
589
  /**
@@ -528,6 +601,8 @@ declare namespace sap {
528
601
  ): object;
529
602
  /**
530
603
  * Selects the chosen variant.
604
+ *
605
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
531
606
  */
532
607
  iSelectVariant(
533
608
  /**
@@ -542,10 +617,14 @@ declare namespace sap {
542
617
 
543
618
  /**
544
619
  * Confirms the filter bar adaptation. It can be used in an action chain as well as in an assertion chain.
620
+ *
621
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
545
622
  */
546
623
  iConfirmFilterAdaptation(): object;
547
624
  /**
548
625
  * Opens the filter bar adaptation. It can be used in an action chain as well as in an assertion chain.
626
+ *
627
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
549
628
  */
550
629
  iOpenFilterAdaptation(): object;
551
630
  }
@@ -555,6 +634,8 @@ declare namespace sap {
555
634
 
556
635
  /**
557
636
  * Checks a field in the adaptation dialog.
637
+ *
638
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
558
639
  */
559
640
  iCheckAdaptationFilterField(
560
641
  /**
@@ -568,6 +649,8 @@ declare namespace sap {
568
649
  ): object;
569
650
  /**
570
651
  * Check the filter field for the editing status.
652
+ *
653
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
571
654
  */
572
655
  iCheckEditingStatus(
573
656
  /**
@@ -581,10 +664,14 @@ declare namespace sap {
581
664
  ): object;
582
665
  /**
583
666
  * Checks whether the filter adaptation dialog is open.
667
+ *
668
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
584
669
  */
585
670
  iCheckFilterAdaptation(): object;
586
671
  /**
587
672
  * Checks a filter field. If `vConditionValues` is `undefined`, the current condition values are ignored.
673
+ *
674
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
588
675
  */
589
676
  iCheckFilterField(
590
677
  /**
@@ -606,6 +693,8 @@ declare namespace sap {
606
693
  ): object;
607
694
  /**
608
695
  * Checks the search button.
696
+ *
697
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
609
698
  */
610
699
  iCheckSearch(
611
700
  /**
@@ -616,6 +705,8 @@ declare namespace sap {
616
705
  /**
617
706
  * Checks the search field in the filter bar. If the `sSearchText` parameter is `undefined`, the search
618
707
  * text is not validated.
708
+ *
709
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
619
710
  */
620
711
  iCheckSearchField(
621
712
  /**
@@ -629,6 +720,8 @@ declare namespace sap {
629
720
  ): object;
630
721
  /**
631
722
  * Checks the filter bar.
723
+ *
724
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
632
725
  */
633
726
  iCheckState(
634
727
  /**
@@ -643,6 +736,8 @@ declare namespace sap {
643
736
 
644
737
  /**
645
738
  * Executes a footer action.
739
+ *
740
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
646
741
  */
647
742
  iExecuteAction(
648
743
  /**
@@ -657,18 +752,26 @@ declare namespace sap {
657
752
 
658
753
  /**
659
754
  * Confirms the Cancel action when user clicks `Cancel` in draft mode.
755
+ *
756
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
660
757
  */
661
758
  iConfirmCancel(): object;
662
759
  /**
663
760
  * Executes the Apply action in the footer bar of a sub-object page.
761
+ *
762
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
664
763
  */
665
764
  iExecuteApply(): object;
666
765
  /**
667
766
  * Executes the Cancel action in the footer bar of the object page.
767
+ *
768
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
668
769
  */
669
770
  iExecuteCancel(): object;
670
771
  /**
671
772
  * Executes the Save or Create action in the footer bar of the object page.
773
+ *
774
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
672
775
  */
673
776
  iExecuteSave(): object;
674
777
  }
@@ -678,6 +781,8 @@ declare namespace sap {
678
781
 
679
782
  /**
680
783
  * Checks the state of an action in the footer bar.
784
+ *
785
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
681
786
  */
682
787
  iCheckAction(
683
788
  /**
@@ -691,6 +796,8 @@ declare namespace sap {
691
796
  ): object;
692
797
  /**
693
798
  * Checks the state of the footer bar.
799
+ *
800
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
694
801
  */
695
802
  iCheckState(
696
803
  /**
@@ -705,6 +812,8 @@ declare namespace sap {
705
812
 
706
813
  /**
707
814
  * Checks the state of the Apply action in the footer bar.
815
+ *
816
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
708
817
  */
709
818
  iCheckApply(
710
819
  /**
@@ -714,6 +823,8 @@ declare namespace sap {
714
823
  ): object;
715
824
  /**
716
825
  * Checks the state of the Cancel action in the footer bar.
826
+ *
827
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
717
828
  */
718
829
  iCheckCancel(
719
830
  /**
@@ -723,14 +834,20 @@ declare namespace sap {
723
834
  ): object;
724
835
  /**
725
836
  * Checks for draft state 'Clear' in the footer bar.
837
+ *
838
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
726
839
  */
727
840
  iCheckDraftStateClear(): object;
728
841
  /**
729
842
  * Checks for draft state 'Saved' in the footer bar.
843
+ *
844
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
730
845
  */
731
846
  iCheckDraftStateSaved(): object;
732
847
  /**
733
848
  * Checks the state of the Save or Create action in the footer bar.
849
+ *
850
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
734
851
  */
735
852
  iCheckSave(
736
853
  /**
@@ -745,6 +862,8 @@ declare namespace sap {
745
862
 
746
863
  /**
747
864
  * Changes the value of a field within a form.
865
+ *
866
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
748
867
  */
749
868
  iChangeField(
750
869
  /**
@@ -758,6 +877,8 @@ declare namespace sap {
758
877
  ): object;
759
878
  /**
760
879
  * Toggles the value of a checkbox within a form.
880
+ *
881
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
761
882
  */
762
883
  iClickCheckBox(
763
884
  /**
@@ -767,6 +888,8 @@ declare namespace sap {
767
888
  ): object;
768
889
  /**
769
890
  * Clicks a link within a form.
891
+ *
892
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
770
893
  */
771
894
  iClickLink(
772
895
  /**
@@ -776,6 +899,8 @@ declare namespace sap {
776
899
  ): object;
777
900
  /**
778
901
  * Executes an action assigned to a form in a subsection.
902
+ *
903
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
779
904
  */
780
905
  iExecuteAction(
781
906
  /**
@@ -785,14 +910,20 @@ declare namespace sap {
785
910
  ): object;
786
911
  /**
787
912
  * Executes the Show Less action of a form in a subsection.
913
+ *
914
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
788
915
  */
789
916
  iExecuteShowLess(): object;
790
917
  /**
791
918
  * Executes the Show More action of a form in a subsection.
919
+ *
920
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
792
921
  */
793
922
  iExecuteShowMore(): object;
794
923
  /**
795
924
  * Opens the value help of the given field.
925
+ *
926
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function that can be used for chaining statements
796
927
  */
797
928
  iOpenValueHelp(
798
929
  /**
@@ -811,6 +942,8 @@ declare namespace sap {
811
942
 
812
943
  /**
813
944
  * Checks the state of an action in a subsection.
945
+ *
946
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
814
947
  */
815
948
  iCheckAction(
816
949
  /**
@@ -824,6 +957,8 @@ declare namespace sap {
824
957
  ): object;
825
958
  /**
826
959
  * Checks the content and state of a field within a form.
960
+ *
961
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
827
962
  */
828
963
  iCheckField(
829
964
  /**
@@ -848,6 +983,8 @@ declare namespace sap {
848
983
  ): object;
849
984
  /**
850
985
  * Checks the field is a link with the given text and state.
986
+ *
987
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
851
988
  */
852
989
  iCheckLink(
853
990
  /**
@@ -865,6 +1002,8 @@ declare namespace sap {
865
1002
  ): object;
866
1003
  /**
867
1004
  * Checks the Show Less action of a form in a subsection.
1005
+ *
1006
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
868
1007
  */
869
1008
  iCheckShowLess(
870
1009
  /**
@@ -874,6 +1013,8 @@ declare namespace sap {
874
1013
  ): object;
875
1014
  /**
876
1015
  * Checks the Show More action of a form in a subsection.
1016
+ *
1017
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
877
1018
  */
878
1019
  iCheckShowMore(
879
1020
  /**
@@ -883,6 +1024,8 @@ declare namespace sap {
883
1024
  ): object;
884
1025
  /**
885
1026
  * Checks the state of the form.
1027
+ *
1028
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
886
1029
  */
887
1030
  iCheckState(
888
1031
  /**
@@ -897,6 +1040,8 @@ declare namespace sap {
897
1040
 
898
1041
  /**
899
1042
  * Executes an action in the header toolbar of an object page.
1043
+ *
1044
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
900
1045
  */
901
1046
  iExecuteAction(
902
1047
  /**
@@ -906,14 +1051,20 @@ declare namespace sap {
906
1051
  ): object;
907
1052
  /**
908
1053
  * Executes the Delete action in the header toolbar of an object page.
1054
+ *
1055
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
909
1056
  */
910
1057
  iExecuteDelete(): object;
911
1058
  /**
912
1059
  * Executes the Edit action in the header toolbar of an object page.
1060
+ *
1061
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
913
1062
  */
914
1063
  iExecuteEdit(): object;
915
1064
  /**
916
1065
  * Executes an action in the drop-down menu that is currently open.
1066
+ *
1067
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
917
1068
  */
918
1069
  iExecuteMenuAction(
919
1070
  /**
@@ -923,16 +1074,33 @@ declare namespace sap {
923
1074
  ): object;
924
1075
  /**
925
1076
  * Navigates to the next sub-object page.
1077
+ *
1078
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
926
1079
  */
927
1080
  iExecutePaginatorDown(): object;
928
1081
  /**
929
1082
  * Navigates to the previous sub-object page.
1083
+ *
1084
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
930
1085
  */
931
1086
  iExecutePaginatorUp(): object;
932
1087
  /**
933
1088
  * Executes the Related Apps action in the header toolbar of an object page.
1089
+ *
1090
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
934
1091
  */
935
1092
  iExecuteRelatedApps(): object;
1093
+ /**
1094
+ * Executes an action in the selection list that is currently open.
1095
+ *
1096
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1097
+ */
1098
+ iExecuteSelectListAction(
1099
+ /**
1100
+ * The label of the action or its state
1101
+ */
1102
+ vAction: string | object
1103
+ ): object;
936
1104
  }
937
1105
 
938
1106
  class HeaderActionsLR {
@@ -940,6 +1108,8 @@ declare namespace sap {
940
1108
 
941
1109
  /**
942
1110
  * Executes an action in the header toolbar of a list report.
1111
+ *
1112
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
943
1113
  */
944
1114
  iExecuteAction(
945
1115
  /**
@@ -954,6 +1124,8 @@ declare namespace sap {
954
1124
 
955
1125
  /**
956
1126
  * Checks an action in the header toolbar.
1127
+ *
1128
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
957
1129
  */
958
1130
  iCheckAction(
959
1131
  /**
@@ -967,6 +1139,8 @@ declare namespace sap {
967
1139
  ): object;
968
1140
  /**
969
1141
  * Checks the `Delete` action in the header toolbar.
1142
+ *
1143
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
970
1144
  */
971
1145
  iCheckDelete(
972
1146
  /**
@@ -976,6 +1150,8 @@ declare namespace sap {
976
1150
  ): object;
977
1151
  /**
978
1152
  * Checks the `Edit` action in the header toolbar.
1153
+ *
1154
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
979
1155
  */
980
1156
  iCheckEdit(
981
1157
  /**
@@ -985,6 +1161,8 @@ declare namespace sap {
985
1161
  ): object;
986
1162
  /**
987
1163
  * Checks a field within a field group in the object page header.
1164
+ *
1165
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
988
1166
  */
989
1167
  iCheckFieldInFieldGroup(
990
1168
  /**
@@ -1010,6 +1188,8 @@ declare namespace sap {
1010
1188
  ): object;
1011
1189
  /**
1012
1190
  * Checks the custom facet in the object page header.
1191
+ *
1192
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1013
1193
  */
1014
1194
  iCheckHeaderFacet(
1015
1195
  /**
@@ -1023,6 +1203,8 @@ declare namespace sap {
1023
1203
  ): object;
1024
1204
  /**
1025
1205
  * Checks an action in the popover that is currently open.
1206
+ *
1207
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1026
1208
  */
1027
1209
  iCheckMenuAction(
1028
1210
  /**
@@ -1032,6 +1214,8 @@ declare namespace sap {
1032
1214
  ): object;
1033
1215
  /**
1034
1216
  * Checks the paginator down button.
1217
+ *
1218
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1035
1219
  */
1036
1220
  iCheckPaginatorDown(
1037
1221
  /**
@@ -1041,6 +1225,8 @@ declare namespace sap {
1041
1225
  ): object;
1042
1226
  /**
1043
1227
  * Checks the paginator up button.
1228
+ *
1229
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1044
1230
  */
1045
1231
  iCheckPaginatorUp(
1046
1232
  /**
@@ -1050,6 +1236,8 @@ declare namespace sap {
1050
1236
  ): object;
1051
1237
  /**
1052
1238
  * Checks the `Related Apps` action in the header toolbar.
1239
+ *
1240
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1053
1241
  */
1054
1242
  iCheckRelatedApps(
1055
1243
  /**
@@ -1059,6 +1247,8 @@ declare namespace sap {
1059
1247
  ): object;
1060
1248
  /**
1061
1249
  * Checks the `Save as Tile` action.
1250
+ *
1251
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1062
1252
  */
1063
1253
  iCheckSaveAsTile(
1064
1254
  /**
@@ -1068,6 +1258,8 @@ declare namespace sap {
1068
1258
  ): object;
1069
1259
  /**
1070
1260
  * Checks `Send Email` action.
1261
+ *
1262
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1071
1263
  */
1072
1264
  iCheckSendEmail(
1073
1265
  /**
@@ -1079,6 +1271,8 @@ declare namespace sap {
1079
1271
  * Checks the title and description of the object page.
1080
1272
  *
1081
1273
  * If either title or description is `undefined`, it will not be checked.
1274
+ *
1275
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1082
1276
  */
1083
1277
  iCheckTitle(
1084
1278
  /**
@@ -1097,6 +1291,8 @@ declare namespace sap {
1097
1291
 
1098
1292
  /**
1099
1293
  * Checks an action of the header toolbar.
1294
+ *
1295
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1100
1296
  */
1101
1297
  iCheckAction(
1102
1298
  /**
@@ -1110,6 +1306,8 @@ declare namespace sap {
1110
1306
  ): object;
1111
1307
  /**
1112
1308
  * Checks the `Save as Tile` action.
1309
+ *
1310
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1113
1311
  */
1114
1312
  iCheckSaveAsTile(
1115
1313
  /**
@@ -1119,6 +1317,8 @@ declare namespace sap {
1119
1317
  ): object;
1120
1318
  /**
1121
1319
  * Checks the `Send Email` action.
1320
+ *
1321
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1122
1322
  */
1123
1323
  iCheckSendEmail(
1124
1324
  /**
@@ -1133,6 +1333,8 @@ declare namespace sap {
1133
1333
 
1134
1334
  /**
1135
1335
  * Adds a field as a column to the table.
1336
+ *
1337
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1136
1338
  */
1137
1339
  iAddAdaptationColumn(
1138
1340
  /**
@@ -1142,6 +1344,8 @@ declare namespace sap {
1142
1344
  ): object;
1143
1345
  /**
1144
1346
  * Aggregates the table entries by the specified column.
1347
+ *
1348
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1145
1349
  */
1146
1350
  iAggregateByColumn(
1147
1351
  /**
@@ -1158,6 +1362,8 @@ declare namespace sap {
1158
1362
  ): object;
1159
1363
  /**
1160
1364
  * Adds a filter condition to the filter field.
1365
+ *
1366
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1161
1367
  */
1162
1368
  iChangeFilterField(
1163
1369
  /**
@@ -1178,6 +1384,8 @@ declare namespace sap {
1178
1384
  *
1179
1385
  * If only one parameter is provided, it must be the `mTargetValues` and `mRowValues` is considered undefined.
1180
1386
  * If `vRowValues` are not defined, then the targetValues are inserted in the creationRow.
1387
+ *
1388
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1181
1389
  */
1182
1390
  iChangeRow(
1183
1391
  /**
@@ -1195,23 +1403,35 @@ declare namespace sap {
1195
1403
  * A map of columns (either name or index) to its new value. The columns do not need to match the ones defined
1196
1404
  * in `vRowValues`.
1197
1405
  */
1198
- mTargetValues: object
1406
+ mTargetValues: object,
1407
+ /**
1408
+ * If true, we keep the focus on the modified cell and don't press enter to validate the input
1409
+ */
1410
+ bInputNotFinalized: boolean
1199
1411
  ): object;
1200
1412
  /**
1201
1413
  * Changes the specified row. The given value map must match exactly one row.
1202
1414
  *
1203
1415
  * If only one parameter is provided, it must be the `mTargetValues` and `mRowValues` is considered undefined.
1204
1416
  * If `vRowValues` are not defined, then the targetValues are inserted in the creationRow.
1417
+ *
1418
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1205
1419
  */
1206
1420
  iChangeRow(
1207
1421
  /**
1208
1422
  * A map of columns (either name or index) to its new value. The columns do not need to match the ones defined
1209
1423
  * in `vRowValues`.
1210
1424
  */
1211
- mTargetValues: object
1425
+ mTargetValues: object,
1426
+ /**
1427
+ * If true, we keep the focus on the modified cell and don't press enter to validate the input
1428
+ */
1429
+ bInputNotFinalized: boolean
1212
1430
  ): object;
1213
1431
  /**
1214
1432
  * Changes the search field.
1433
+ *
1434
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1215
1435
  */
1216
1436
  iChangeSearchField(
1217
1437
  /**
@@ -1221,6 +1441,8 @@ declare namespace sap {
1221
1441
  ): object;
1222
1442
  /**
1223
1443
  * Adds a field to the sorting of the table via the sort dialog.
1444
+ *
1445
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1224
1446
  */
1225
1447
  iChangeSortOrder(
1226
1448
  /**
@@ -1234,6 +1456,8 @@ declare namespace sap {
1234
1456
  ): object;
1235
1457
  /**
1236
1458
  * Collapses a row corresponding to a visual group.
1459
+ *
1460
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1237
1461
  */
1238
1462
  iCollapseGroupRow(
1239
1463
  /**
@@ -1247,6 +1471,8 @@ declare namespace sap {
1247
1471
  ): object;
1248
1472
  /**
1249
1473
  * Executes an action on the table.
1474
+ *
1475
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1250
1476
  */
1251
1477
  iExecuteAction(
1252
1478
  /**
@@ -1256,18 +1482,26 @@ declare namespace sap {
1256
1482
  ): object;
1257
1483
  /**
1258
1484
  * Executes the `Create` action on the table.
1485
+ *
1486
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1259
1487
  */
1260
1488
  iExecuteCreate(): object;
1261
1489
  /**
1262
1490
  * Executes the `Delete` action on the table.
1491
+ *
1492
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1263
1493
  */
1264
1494
  iExecuteDelete(): object;
1265
1495
  /**
1266
1496
  * Executes the `Fullscreen` action on the table.
1497
+ *
1498
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1267
1499
  */
1268
1500
  iExecuteFullScreen(): object;
1269
1501
  /**
1270
1502
  * Executes an action that is available in a certain column within a table row.
1503
+ *
1504
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1271
1505
  */
1272
1506
  iExecuteInlineAction(
1273
1507
  /**
@@ -1288,6 +1522,8 @@ declare namespace sap {
1288
1522
  ): object;
1289
1523
  /**
1290
1524
  * Executes an action that is available in a certain column within a table row.
1525
+ *
1526
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1291
1527
  */
1292
1528
  iExecuteInlineAction(
1293
1529
  /**
@@ -1297,12 +1533,16 @@ declare namespace sap {
1297
1533
  ): object;
1298
1534
  /**
1299
1535
  * Executes the action to create a row in the table.
1536
+ *
1537
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1300
1538
  */
1301
1539
  iExecuteInlineCreate(): object;
1302
1540
  /**
1303
1541
  * Executes a keyboard shortcut on the table or a cell control. If only `sShortcut` is defined, the shortcut
1304
1542
  * is executed on the table directly. If additionally `vRowValues` and `vColumn` are defined, the shortcut
1305
1543
  * is executed on table cell level.
1544
+ *
1545
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1306
1546
  */
1307
1547
  iExecuteKeyboardShortcut(
1308
1548
  /**
@@ -1329,6 +1569,8 @@ declare namespace sap {
1329
1569
  * Executes a keyboard shortcut on the table or a cell control. If only `sShortcut` is defined, the shortcut
1330
1570
  * is executed on the table directly. If additionally `vRowValues` and `vColumn` are defined, the shortcut
1331
1571
  * is executed on table cell level.
1572
+ *
1573
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1332
1574
  */
1333
1575
  iExecuteKeyboardShortcut(
1334
1576
  /**
@@ -1342,6 +1584,8 @@ declare namespace sap {
1342
1584
  ): object;
1343
1585
  /**
1344
1586
  * Executes an action form the drop-down menu that is currently open.
1587
+ *
1588
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1345
1589
  */
1346
1590
  iExecuteMenuAction(
1347
1591
  /**
@@ -1351,6 +1595,8 @@ declare namespace sap {
1351
1595
  ): object;
1352
1596
  /**
1353
1597
  * Executes the `Show/Hide details` action on the table.
1598
+ *
1599
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1354
1600
  */
1355
1601
  iExecuteShowHideDetails(
1356
1602
  /**
@@ -1361,6 +1607,8 @@ declare namespace sap {
1361
1607
  ): object;
1362
1608
  /**
1363
1609
  * Expands a row corresponding to a visual group.
1610
+ *
1611
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1364
1612
  */
1365
1613
  iExpandGroupRow(
1366
1614
  /**
@@ -1374,6 +1622,8 @@ declare namespace sap {
1374
1622
  ): object;
1375
1623
  /**
1376
1624
  * Groups the table entries by the specified column.
1625
+ *
1626
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1377
1627
  */
1378
1628
  iGroupByColumn(
1379
1629
  /**
@@ -1390,6 +1640,8 @@ declare namespace sap {
1390
1640
  ): object;
1391
1641
  /**
1392
1642
  * Pastes data into the table.
1643
+ *
1644
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1393
1645
  */
1394
1646
  iPasteData(
1395
1647
  /**
@@ -1399,6 +1651,8 @@ declare namespace sap {
1399
1651
  ): object;
1400
1652
  /**
1401
1653
  * Presses the control in the table cell.
1654
+ *
1655
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1402
1656
  */
1403
1657
  iPressCell(
1404
1658
  /**
@@ -1419,6 +1673,8 @@ declare namespace sap {
1419
1673
  ): object;
1420
1674
  /**
1421
1675
  * Presses the control in the table cell.
1676
+ *
1677
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1422
1678
  */
1423
1679
  iPressCell(
1424
1680
  /**
@@ -1428,6 +1684,8 @@ declare namespace sap {
1428
1684
  ): object;
1429
1685
  /**
1430
1686
  * Clicks the specified row.
1687
+ *
1688
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1431
1689
  */
1432
1690
  iPressRow(
1433
1691
  /**
@@ -1444,6 +1702,8 @@ declare namespace sap {
1444
1702
  ): object;
1445
1703
  /**
1446
1704
  * Removes a field as a column from the table.
1705
+ *
1706
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1447
1707
  */
1448
1708
  iRemoveAdaptationColumn(
1449
1709
  /**
@@ -1453,6 +1713,8 @@ declare namespace sap {
1453
1713
  ): object;
1454
1714
  /**
1455
1715
  * Removes the variant of the given name.
1716
+ *
1717
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1456
1718
  */
1457
1719
  iRemoveVariant(
1458
1720
  /**
@@ -1462,10 +1724,14 @@ declare namespace sap {
1462
1724
  ): object;
1463
1725
  /**
1464
1726
  * Resets the search field.
1727
+ *
1728
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1465
1729
  */
1466
1730
  iResetSearchField(): object;
1467
1731
  /**
1468
1732
  * Saves a variant under the given name, or overwrites the current one.
1733
+ *
1734
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1469
1735
  */
1470
1736
  iSaveVariant(
1471
1737
  /**
@@ -1475,10 +1741,14 @@ declare namespace sap {
1475
1741
  ): object;
1476
1742
  /**
1477
1743
  * Selects all rows in a table.
1744
+ *
1745
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1478
1746
  */
1479
1747
  iSelectAllRows(): object;
1480
1748
  /**
1481
1749
  * Selects a quick-filter item on the table.
1750
+ *
1751
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1482
1752
  */
1483
1753
  iSelectQuickFilterItem(
1484
1754
  /**
@@ -1495,6 +1765,8 @@ declare namespace sap {
1495
1765
  ): object;
1496
1766
  /**
1497
1767
  * Selects the specified rows.
1768
+ *
1769
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1498
1770
  */
1499
1771
  iSelectRows(
1500
1772
  /**
@@ -1515,6 +1787,8 @@ declare namespace sap {
1515
1787
  ): object;
1516
1788
  /**
1517
1789
  * Selects the chosen variant.
1790
+ *
1791
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1518
1792
  */
1519
1793
  iSelectVariant(
1520
1794
  /**
@@ -1524,6 +1798,8 @@ declare namespace sap {
1524
1798
  ): object;
1525
1799
  /**
1526
1800
  * Sets the variant as the default.
1801
+ *
1802
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1527
1803
  */
1528
1804
  iSetDefaultVariant(
1529
1805
  /**
@@ -1534,6 +1810,8 @@ declare namespace sap {
1534
1810
  ): object;
1535
1811
  /**
1536
1812
  * Sorts the table entries by the specified column.
1813
+ *
1814
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1537
1815
  */
1538
1816
  iSortByColumn(
1539
1817
  /**
@@ -1552,6 +1830,8 @@ declare namespace sap {
1552
1830
  ): object;
1553
1831
  /**
1554
1832
  * Sorts the table entries by the specified column.
1833
+ *
1834
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1555
1835
  */
1556
1836
  iSortByColumn(
1557
1837
  /**
@@ -1571,26 +1851,38 @@ declare namespace sap {
1571
1851
 
1572
1852
  /**
1573
1853
  * Confirms and closes the adaptation dialog of the table.
1854
+ *
1855
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1574
1856
  */
1575
1857
  iConfirmColumnAdaptation(): object;
1576
1858
  /**
1577
1859
  * Confirms and closes the sorting dialog of the table.
1860
+ *
1861
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1578
1862
  */
1579
1863
  iConfirmColumnSorting(): object;
1580
1864
  /**
1581
1865
  * Confirms and closes the filtering dialog of the table.
1866
+ *
1867
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1582
1868
  */
1583
1869
  iConfirmFilterDialog(): object;
1584
1870
  /**
1585
1871
  * Opens the column adaptation dialog of the table.
1872
+ *
1873
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1586
1874
  */
1587
1875
  iOpenColumnAdaptation(): object;
1588
1876
  /**
1589
1877
  * Opens the sorting dialog of the table.
1878
+ *
1879
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1590
1880
  */
1591
1881
  iOpenColumnSorting(): object;
1592
1882
  /**
1593
1883
  * Opens the filtering dialog of the table.
1884
+ *
1885
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1594
1886
  */
1595
1887
  iOpenFilterDialog(): object;
1596
1888
  }
@@ -1600,6 +1892,8 @@ declare namespace sap {
1600
1892
 
1601
1893
  /**
1602
1894
  * Checks the state of a table action.
1895
+ *
1896
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1603
1897
  */
1604
1898
  iCheckAction(
1605
1899
  /**
@@ -1613,6 +1907,8 @@ declare namespace sap {
1613
1907
  ): object;
1614
1908
  /**
1615
1909
  * Checks a field in the adaptation dialog.
1910
+ *
1911
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1616
1912
  */
1617
1913
  iCheckAdaptationColumn(
1618
1914
  /**
@@ -1626,6 +1922,8 @@ declare namespace sap {
1626
1922
  ): object;
1627
1923
  /**
1628
1924
  * Checks the state of the cells of a table.
1925
+ *
1926
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1629
1927
  */
1630
1928
  iCheckCells(
1631
1929
  /**
@@ -1654,6 +1952,8 @@ declare namespace sap {
1654
1952
  ): object;
1655
1953
  /**
1656
1954
  * Checks the state of the cells of a table.
1955
+ *
1956
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1657
1957
  */
1658
1958
  iCheckCells(
1659
1959
  /**
@@ -1671,18 +1971,26 @@ declare namespace sap {
1671
1971
  ): object;
1672
1972
  /**
1673
1973
  * Checks whether the adaptation button is available for the table.
1974
+ *
1975
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1674
1976
  */
1675
1977
  iCheckColumnAdaptation(): object;
1676
1978
  /**
1677
1979
  * Checks whether the column adaptation dialog is open.
1980
+ *
1981
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1678
1982
  */
1679
1983
  iCheckColumnAdaptationDialog(): object;
1680
1984
  /**
1681
1985
  * Checks whether the filter button is available for the table.
1986
+ *
1987
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1682
1988
  */
1683
1989
  iCheckColumnFiltering(): object;
1684
1990
  /**
1685
1991
  * Checks the state of the columns of the table.
1992
+ *
1993
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1686
1994
  */
1687
1995
  iCheckColumns(
1688
1996
  /**
@@ -1704,10 +2012,14 @@ declare namespace sap {
1704
2012
  ): object;
1705
2013
  /**
1706
2014
  * Checks whether the sort button is available for the table.
2015
+ *
2016
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1707
2017
  */
1708
2018
  iCheckColumnSorting(): object;
1709
2019
  /**
1710
2020
  * Checks the `Create` action of the table.
2021
+ *
2022
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1711
2023
  */
1712
2024
  iCheckCreate(
1713
2025
  /**
@@ -1717,6 +2029,8 @@ declare namespace sap {
1717
2029
  ): object;
1718
2030
  /**
1719
2031
  * Checks the state of the CreationRow button in the table.
2032
+ *
2033
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1720
2034
  */
1721
2035
  iCheckCreationRow(
1722
2036
  /**
@@ -1736,6 +2050,8 @@ declare namespace sap {
1736
2050
  ): object;
1737
2051
  /**
1738
2052
  * Checks the `Delete` action of the table.
2053
+ *
2054
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1739
2055
  */
1740
2056
  iCheckDelete(
1741
2057
  /**
@@ -1745,10 +2061,14 @@ declare namespace sap {
1745
2061
  ): object;
1746
2062
  /**
1747
2063
  * Checks whether the export button is available for the table.
2064
+ *
2065
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1748
2066
  */
1749
2067
  iCheckExport(): object;
1750
2068
  /**
1751
2069
  * Checks a filter field in the filter dialog.
2070
+ *
2071
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1752
2072
  */
1753
2073
  iCheckFilterField(
1754
2074
  /**
@@ -1762,6 +2082,8 @@ declare namespace sap {
1762
2082
  ): object;
1763
2083
  /**
1764
2084
  * Checks the `Fullscreen` action of the table.
2085
+ *
2086
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1765
2087
  */
1766
2088
  iCheckFullScreen(
1767
2089
  /**
@@ -1771,6 +2093,8 @@ declare namespace sap {
1771
2093
  ): object;
1772
2094
  /**
1773
2095
  * Checks an action in the drop-down menu that is currently open.
2096
+ *
2097
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1774
2098
  */
1775
2099
  iCheckMenuAction(
1776
2100
  /**
@@ -1780,6 +2104,8 @@ declare namespace sap {
1780
2104
  ): object;
1781
2105
  /**
1782
2106
  * Checks a messageStrip on a table.
2107
+ *
2108
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1783
2109
  */
1784
2110
  iCheckMessageStrip(
1785
2111
  /**
@@ -1789,10 +2115,14 @@ declare namespace sap {
1789
2115
  ): object;
1790
2116
  /**
1791
2117
  * Checks whether the paste button is available for the table.
2118
+ *
2119
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1792
2120
  */
1793
2121
  iCheckPaste(): object;
1794
2122
  /**
1795
2123
  * Checks the quick filter action of the table.
2124
+ *
2125
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1796
2126
  */
1797
2127
  iCheckQuickFilter(
1798
2128
  /**
@@ -1802,6 +2132,8 @@ declare namespace sap {
1802
2132
  ): object;
1803
2133
  /**
1804
2134
  * Checks the number of items in the quick-filter menu.
2135
+ *
2136
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1805
2137
  */
1806
2138
  iCheckQuickFilterItems(
1807
2139
  /**
@@ -1814,6 +2146,8 @@ declare namespace sap {
1814
2146
  * considered. If `iNumberOfRows` is provided, the number of rows are checked with respect to the provided
1815
2147
  * `mRowValues` (if set) or in total. If `iNumberOfRows` is omitted, it checks for at least one matching
1816
2148
  * row. If `mState` is provided, the row must be in the given state.
2149
+ *
2150
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1817
2151
  */
1818
2152
  iCheckRows(
1819
2153
  /**
@@ -1842,6 +2176,8 @@ declare namespace sap {
1842
2176
  /**
1843
2177
  * Checks the search field in the table toolbar. If the `sSearchText` parameter is `undefined`, the search
1844
2178
  * text is not validated.
2179
+ *
2180
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function that can be used for chaining statements
1845
2181
  */
1846
2182
  iCheckSearchField(
1847
2183
  /**
@@ -1855,6 +2191,8 @@ declare namespace sap {
1855
2191
  ): object;
1856
2192
  /**
1857
2193
  * Checks a field in the sorting dialog.
2194
+ *
2195
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1858
2196
  */
1859
2197
  iCheckSortOrder(
1860
2198
  /**
@@ -1872,6 +2210,8 @@ declare namespace sap {
1872
2210
  ): object;
1873
2211
  /**
1874
2212
  * Checks the state of the table.
2213
+ *
2214
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1875
2215
  */
1876
2216
  iCheckState(
1877
2217
  /**
@@ -1879,6 +2219,12 @@ declare namespace sap {
1879
2219
  */
1880
2220
  mState?: object
1881
2221
  ): object;
2222
+ /**
2223
+ * Checks if the focus is on a table.
2224
+ *
2225
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2226
+ */
2227
+ iSeeFocusOnHeader(): object;
1882
2228
  }
1883
2229
  /**
1884
2230
  * Enum for supported dialog types.
@@ -2106,6 +2452,8 @@ declare namespace sap {
2106
2452
  interface actions {
2107
2453
  /**
2108
2454
  * Collapses or expands the page header.
2455
+ *
2456
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2109
2457
  */
2110
2458
  iCollapseExpandPageHeader(
2111
2459
  /**
@@ -2115,14 +2463,20 @@ declare namespace sap {
2115
2463
  ): object;
2116
2464
  /**
2117
2465
  * Returns a {@link sap.fe.test.api.FilterBarActions} instance.
2466
+ *
2467
+ * @returns The available filter bar actions
2118
2468
  */
2119
2469
  onFilterBar(): sap.fe.test.api.FilterBarActions;
2120
2470
  /**
2121
2471
  * Returns a {@link sap.fe.test.api.HeaderActionsLR} instance.
2472
+ *
2473
+ * @returns The available header actions
2122
2474
  */
2123
2475
  onHeader(): sap.fe.test.api.HeaderActionsLR;
2124
2476
  /**
2125
2477
  * Returns a {@link sap.fe.test.api.TableActions} instance for the specified table.
2478
+ *
2479
+ * @returns The available table actions
2126
2480
  */
2127
2481
  onTable(
2128
2482
  /**
@@ -2139,14 +2493,20 @@ declare namespace sap {
2139
2493
  interface assertions {
2140
2494
  /**
2141
2495
  * Returns a {@link sap.fe.test.api.FilterBarAssertions} instance.
2496
+ *
2497
+ * @returns The available filter bar assertions
2142
2498
  */
2143
2499
  onFilterBar(): sap.fe.test.api.FilterBarAssertions;
2144
2500
  /**
2145
2501
  * Returns a {@link sap.fe.test.api.HeaderAssertionsLR} instance.
2502
+ *
2503
+ * @returns The available header assertions
2146
2504
  */
2147
2505
  onHeader(): sap.fe.test.api.HeaderAssertionsLR;
2148
2506
  /**
2149
2507
  * Returns a {@link sap.fe.test.api.TableAssertions} instance for the specified table.
2508
+ *
2509
+ * @returns The available table assertions
2150
2510
  */
2151
2511
  onTable(
2152
2512
  /**
@@ -2165,6 +2525,8 @@ declare namespace sap {
2165
2525
  interface actions {
2166
2526
  /**
2167
2527
  * Collapses or expands the page header.
2528
+ *
2529
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2168
2530
  */
2169
2531
  iCollapseExpandPageHeader(
2170
2532
  /**
@@ -2174,6 +2536,8 @@ declare namespace sap {
2174
2536
  ): object;
2175
2537
  /**
2176
2538
  * Navigates to or focuses on the defined section.
2539
+ *
2540
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2177
2541
  */
2178
2542
  iGoToSection(
2179
2543
  /**
@@ -2198,10 +2562,14 @@ declare namespace sap {
2198
2562
  ): object;
2199
2563
  /**
2200
2564
  * Returns a {@link sap.fe.test.api.FooterActionsOP} instance.
2565
+ *
2566
+ * @returns The available footer actions
2201
2567
  */
2202
2568
  onFooter(): sap.fe.test.api.FooterActionsOP;
2203
2569
  /**
2204
2570
  * Returns a {@link sap.fe.test.api.FormActions} instance.
2571
+ *
2572
+ * @returns The available form actions
2205
2573
  */
2206
2574
  onForm(
2207
2575
  /**
@@ -2211,10 +2579,14 @@ declare namespace sap {
2211
2579
  ): sap.fe.test.api.FormActions;
2212
2580
  /**
2213
2581
  * Returns a {@link sap.fe.test.api.HeaderActions} instance.
2582
+ *
2583
+ * @returns The available header actions
2214
2584
  */
2215
2585
  onHeader(): sap.fe.test.api.HeaderActions;
2216
2586
  /**
2217
2587
  * Returns a {@link sap.fe.test.api.TableActions} instance for the specified table.
2588
+ *
2589
+ * @returns The available table actions
2218
2590
  */
2219
2591
  onTable(
2220
2592
  /**
@@ -2231,10 +2603,14 @@ declare namespace sap {
2231
2603
  interface assertions {
2232
2604
  /**
2233
2605
  * Returns a {@link sap.fe.test.api.FooterAssertionsOP} instance.
2606
+ *
2607
+ * @returns The available footer assertions
2234
2608
  */
2235
2609
  onFooter(): sap.fe.test.api.FooterAssertionsOP;
2236
2610
  /**
2237
2611
  * Returns a {@link sap.fe.test.api.FormAssertions} instance.
2612
+ *
2613
+ * @returns The available form actions
2238
2614
  */
2239
2615
  onForm(
2240
2616
  /**
@@ -2244,10 +2620,14 @@ declare namespace sap {
2244
2620
  ): sap.fe.test.api.FormAssertions;
2245
2621
  /**
2246
2622
  * Returns a {@link sap.fe.test.api.HeaderAssertions} instance.
2623
+ *
2624
+ * @returns The available header assertions
2247
2625
  */
2248
2626
  onHeader(): sap.fe.test.api.HeaderAssertions;
2249
2627
  /**
2250
2628
  * Returns a {@link sap.fe.test.api.TableAssertions} instance for the specified table.
2629
+ *
2630
+ * @returns The available table assertions
2251
2631
  */
2252
2632
  onTable(
2253
2633
  /**
@@ -2266,18 +2646,26 @@ declare namespace sap {
2266
2646
  interface actions {
2267
2647
  /**
2268
2648
  * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.Action })`.
2649
+ *
2650
+ * @returns The available dialog actions
2269
2651
  */
2270
2652
  onActionDialog(): sap.fe.test.api.DialogActions;
2271
2653
  /**
2272
2654
  * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.Confirmation })`.
2655
+ *
2656
+ * @returns The available dialog actions
2273
2657
  */
2274
2658
  onConfirmationDialog(): sap.fe.test.api.DialogActions;
2275
2659
  /**
2276
2660
  * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.Create })`.
2661
+ *
2662
+ * @returns The available dialog actions
2277
2663
  */
2278
2664
  onCreateDialog(): sap.fe.test.api.DialogCreateActions;
2279
2665
  /**
2280
2666
  * Returns a {@link sap.fe.test.api.DialogActions} instance.
2667
+ *
2668
+ * @returns The available dialog actions
2281
2669
  */
2282
2670
  onDialog(
2283
2671
  /**
@@ -2287,14 +2675,20 @@ declare namespace sap {
2287
2675
  ): sap.fe.test.api.DialogActions;
2288
2676
  /**
2289
2677
  * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.Error })`.
2678
+ *
2679
+ * @returns The available dialog actions
2290
2680
  */
2291
2681
  onErrorDialog(): sap.fe.test.api.DialogActions;
2292
2682
  /**
2293
2683
  * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.Message })`.
2684
+ *
2685
+ * @returns The available dialog actions
2294
2686
  */
2295
2687
  onMessageDialog(): sap.fe.test.api.DialogMessageActions;
2296
2688
  /**
2297
2689
  * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.ValueHelp })`.
2690
+ *
2691
+ * @returns The available dialog actions
2298
2692
  */
2299
2693
  onValueHelpDialog(): sap.fe.test.api.DialogValueHelpActions;
2300
2694
  }
@@ -2306,22 +2700,32 @@ declare namespace sap {
2306
2700
  interface assertions {
2307
2701
  /**
2308
2702
  * Confirms the visibility of the current page.
2703
+ *
2704
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2309
2705
  */
2310
2706
  iSeeThisPage(): object;
2311
2707
  /**
2312
2708
  * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.Action })`.
2709
+ *
2710
+ * @returns The available dialog assertions
2313
2711
  */
2314
2712
  onActionDialog(): sap.fe.test.api.DialogAssertions;
2315
2713
  /**
2316
2714
  * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.Confirmation })`.
2715
+ *
2716
+ * @returns The available dialog assertions
2317
2717
  */
2318
2718
  onConfirmationDialog(): sap.fe.test.api.DialogAssertions;
2319
2719
  /**
2320
2720
  * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.Create })`.
2721
+ *
2722
+ * @returns The available dialog assertions
2321
2723
  */
2322
2724
  onCreateDialog(): sap.fe.test.api.DialogCreateAssertions;
2323
2725
  /**
2324
2726
  * Returns a {@link sap.fe.test.api.DialogAssertions} instance.
2727
+ *
2728
+ * @returns The available dialog actions
2325
2729
  */
2326
2730
  onDialog(
2327
2731
  /**
@@ -2331,14 +2735,20 @@ declare namespace sap {
2331
2735
  ): sap.fe.test.api.DialogAssertions;
2332
2736
  /**
2333
2737
  * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.Error })`.
2738
+ *
2739
+ * @returns The available dialog assertions
2334
2740
  */
2335
2741
  onErrorDialog(): sap.fe.test.api.DialogAssertions;
2336
2742
  /**
2337
2743
  * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.Message })`.
2744
+ *
2745
+ * @returns The available dialog assertions
2338
2746
  */
2339
2747
  onMessageDialog(): sap.fe.test.api.DialogMessageAssertions;
2340
2748
  /**
2341
2749
  * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.ValueHelp })`.
2750
+ *
2751
+ * @returns The available dialog assertions
2342
2752
  */
2343
2753
  onValueHelpDialog(): sap.fe.test.api.DialogValueHelpAssertions;
2344
2754
  }
@@ -2359,6 +2769,8 @@ declare namespace sap {
2359
2769
  * information contained in `oClassInfo`.
2360
2770
  *
2361
2771
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.test.Opa5.extend}.
2772
+ *
2773
+ * @returns Created class / constructor function
2362
2774
  */
2363
2775
  static extend<T extends Record<string, unknown>>(
2364
2776
  /**
@@ -2377,6 +2789,8 @@ declare namespace sap {
2377
2789
  ): Function;
2378
2790
  /**
2379
2791
  * Returns a metadata object for class sap.fe.test.BaseActions.
2792
+ *
2793
+ * @returns Metadata object describing this class
2380
2794
  */
2381
2795
  static getMetadata(): sap.ui.base.Metadata;
2382
2796
  /**
@@ -2384,10 +2798,14 @@ declare namespace sap {
2384
2798
  *
2385
2799
  * NOTE: This function ensures that a certain UI state is maintained in some exceptional cases. This function
2386
2800
  * isn't usually called directly in a journey.
2801
+ *
2802
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2387
2803
  */
2388
2804
  iClosePopover(): object;
2389
2805
  /**
2390
2806
  * Simulates the pressing of the Esc key for the element in focus.
2807
+ *
2808
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2391
2809
  */
2392
2810
  iPressEscape(): object;
2393
2811
  }
@@ -2419,6 +2837,8 @@ declare namespace sap {
2419
2837
  * the information contained in `oClassInfo`.
2420
2838
  *
2421
2839
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.test.Opa5.extend}.
2840
+ *
2841
+ * @returns Created class / constructor function
2422
2842
  */
2423
2843
  static extend<T extends Record<string, unknown>>(
2424
2844
  /**
@@ -2437,19 +2857,48 @@ declare namespace sap {
2437
2857
  ): Function;
2438
2858
  /**
2439
2859
  * Returns a metadata object for class sap.fe.test.BaseArrangements.
2860
+ *
2861
+ * @returns Metadata object describing this class
2440
2862
  */
2441
2863
  static getMetadata(): sap.ui.base.Metadata;
2864
+ /**
2865
+ * Resets the mock data.
2866
+ *
2867
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2868
+ */
2869
+ iResetMockData(
2870
+ /**
2871
+ * The application id or a uri pointing to the service. One of the following properties needs to be provided
2872
+ * within the parameter:
2873
+ * ```javascript
2874
+ *
2875
+ * {
2876
+ * :
2877
+ * :
2878
+ * }
2879
+ * ```
2880
+ * NOTE: When passing the AppId, the application needs to be running already. Calling the function
2881
+ * before the application is started can be done by passing the ServiceUri.
2882
+ */
2883
+ oAppInfo?: object
2884
+ ): object;
2442
2885
  /**
2443
2886
  * Resets the test data.
2887
+ *
2888
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2444
2889
  */
2445
2890
  iResetTestData(): object;
2446
2891
  /**
2447
2892
  * Simulates a refresh of the page by tearing it down and then restarting it with the very same hash.
2893
+ *
2894
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2448
2895
  */
2449
2896
  iRestartMyApp(): object;
2450
2897
  /**
2451
2898
  * Starts the app in an IFrame, using the `launchUrl` and `launchParameters` provided via the settings object
2452
2899
  * of the {@link sap.fe.test.BaseArrangements#constructor}.
2900
+ *
2901
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2453
2902
  */
2454
2903
  iStartMyApp(
2455
2904
  /**
@@ -2463,6 +2912,8 @@ declare namespace sap {
2463
2912
  ): object;
2464
2913
  /**
2465
2914
  * Tears down the current application.
2915
+ *
2916
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2466
2917
  */
2467
2918
  iTearDownMyApp(): object;
2468
2919
  /**
@@ -2470,6 +2921,8 @@ declare namespace sap {
2470
2921
  *
2471
2922
  * NOTE: The function itself is not meant to be called directly within a journey. Instead, it can be overwritten
2472
2923
  * to add custom clean-up functionality when calling {@link sap.fe.test.BaseArrangements#iResetTestData}.
2924
+ *
2925
+ * @returns A `Promise` object
2473
2926
  */
2474
2927
  resetTestData(): object;
2475
2928
  }
@@ -2487,6 +2940,8 @@ declare namespace sap {
2487
2940
  * the information contained in `oClassInfo`.
2488
2941
  *
2489
2942
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.test.Opa5.extend}.
2943
+ *
2944
+ * @returns Created class / constructor function
2490
2945
  */
2491
2946
  static extend<T extends Record<string, unknown>>(
2492
2947
  /**
@@ -2505,10 +2960,14 @@ declare namespace sap {
2505
2960
  ): Function;
2506
2961
  /**
2507
2962
  * Returns a metadata object for class sap.fe.test.BaseAssertions.
2963
+ *
2964
+ * @returns Metadata object describing this class
2508
2965
  */
2509
2966
  static getMetadata(): sap.ui.base.Metadata;
2510
2967
  /**
2511
2968
  * Checks whether a {@link sap.m.MessagePage} with given message is shown.
2969
+ *
2970
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2512
2971
  */
2513
2972
  iSeeMessagePage(
2514
2973
  /**
@@ -2518,6 +2977,8 @@ declare namespace sap {
2518
2977
  ): object;
2519
2978
  /**
2520
2979
  * Checks whether a {@link sap.m.MessageToast} with the given text is shown.
2980
+ *
2981
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2521
2982
  */
2522
2983
  iSeeMessageToast(
2523
2984
  /**
@@ -2566,6 +3027,8 @@ declare namespace sap {
2566
3027
  * the information contained in `oClassInfo`.
2567
3028
  *
2568
3029
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
3030
+ *
3031
+ * @returns Created class / constructor function
2569
3032
  */
2570
3033
  static extend<T extends Record<string, unknown>>(
2571
3034
  /**
@@ -2584,10 +3047,14 @@ declare namespace sap {
2584
3047
  ): Function;
2585
3048
  /**
2586
3049
  * Gets the global journey runner instance.
3050
+ *
3051
+ * @returns The global default {@link sap.fe.test.JourneyRunner} instance
2587
3052
  */
2588
3053
  static getDefaultRunner(): object;
2589
3054
  /**
2590
3055
  * Returns a metadata object for class sap.fe.test.JourneyRunner.
3056
+ *
3057
+ * @returns Metadata object describing this class
2591
3058
  */
2592
3059
  static getMetadata(): sap.ui.base.Metadata;
2593
3060
  /**
@@ -2614,6 +3081,8 @@ declare namespace sap {
2614
3081
  * by a custom JourneyRunner implementation to provide custom base actions.
2615
3082
  *
2616
3083
  * By default, an instance of {@link sap.fe.test.BaseActions} will be returned.
3084
+ *
3085
+ * @returns An Opa instance for the base actions
2617
3086
  */
2618
3087
  getBaseActions(
2619
3088
  /**
@@ -2629,6 +3098,8 @@ declare namespace sap {
2629
3098
  * overridden by a custom JourneyRunner implementation to provide custom base assertions.
2630
3099
  *
2631
3100
  * By default, an instance of {@link sap.fe.test.BaseArrangements} will be returned.
3101
+ *
3102
+ * @returns An Opa instance for the base arrangements
2632
3103
  */
2633
3104
  getBaseArrangements(
2634
3105
  /**
@@ -2644,6 +3115,8 @@ declare namespace sap {
2644
3115
  * overridden by a custom JourneyRunner implementation to provide custom base assertions.
2645
3116
  *
2646
3117
  * By default, an instance of {@link sap.fe.test.BaseAssertions} will be returned.
3118
+ *
3119
+ * @returns An Opa instance for the base assertions
2647
3120
  */
2648
3121
  getBaseAssertions(
2649
3122
  /**
@@ -2655,6 +3128,8 @@ declare namespace sap {
2655
3128
  * Executes the journeys in the given order.
2656
3129
  *
2657
3130
  * The settings provided as first parameter are merged into the base settings of the JourneyRunner instance.
3131
+ *
3132
+ * @returns A `Promise` that is resolved after all tests have been executed
2658
3133
  */
2659
3134
  run(
2660
3135
  /**
@@ -2695,6 +3170,8 @@ declare namespace sap {
2695
3170
  * Executes the journeys in the given order.
2696
3171
  *
2697
3172
  * The settings provided as first parameter are merged into the base settings of the JourneyRunner instance.
3173
+ *
3174
+ * @returns A `Promise` that is resolved after all tests have been executed
2698
3175
  */
2699
3176
  run(
2700
3177
  /**
@@ -2805,16 +3282,49 @@ declare namespace sap {
2805
3282
  ...aAdditionalPageDefinitions: object[]
2806
3283
  );
2807
3284
 
3285
+ /**
3286
+ * Check an intent-based navigation. The function checks the semantic object and the action within the URL
3287
+ * of an application. Optionally, further URL parameters can be checked.
3288
+ *
3289
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
3290
+ */
3291
+ iCheckIntentBasedNavigation(
3292
+ /**
3293
+ * The semantic object of the application
3294
+ */
3295
+ sSemanticObject: string,
3296
+ /**
3297
+ * The action of the application
3298
+ */
3299
+ sAction: string,
3300
+ /**
3301
+ * More URL parameters to be checked. The pattern is:
3302
+ * ```javascript
3303
+ *
3304
+ * [{
3305
+ * property: <expected name of URL parameter>,
3306
+ * value: <expected value of URL parameter>
3307
+ * }]
3308
+ * ```
3309
+ */
3310
+ aURLParams?: any[]
3311
+ ): object;
2808
3312
  /**
2809
3313
  * Navigates back via shell back button.
3314
+ *
3315
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2810
3316
  */
2811
3317
  iNavigateBack(): object;
2812
3318
  /**
2813
- * Navigates to the launch pad via home button.
3319
+ * Navigates to the launch pad via the home button.
3320
+ *
3321
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2814
3322
  */
2815
3323
  iNavigateHome(): object;
2816
3324
  /**
2817
3325
  * Navigates via a navigation item in the shell's navigation menu.
3326
+ *
3327
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2818
3328
  */
2819
3329
  iNavigateViaMenu(
2820
3330
  /**
@@ -2824,10 +3334,14 @@ declare namespace sap {
2824
3334
  ): object;
2825
3335
  /**
2826
3336
  * Opens the navigation menu in the shell header.
3337
+ *
3338
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2827
3339
  */
2828
3340
  iOpenNavigationMenu(): object;
2829
3341
  /**
2830
3342
  * Selecting a tile in the launchpad by its target app, for example `iPressTile("SalesOrder-manage")`.
3343
+ *
3344
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2831
3345
  */
2832
3346
  iPressTile(
2833
3347
  /**