@sapui5/ts-types 1.101.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.
Files changed (62) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +1 -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 +375 -29
  6. package/types/sap.collaboration.d.ts +320 -40
  7. package/types/sap.esh.search.ui.d.ts +1 -669
  8. package/types/sap.f.d.ts +1785 -100
  9. package/types/sap.fe.common.d.ts +1 -1
  10. package/types/sap.fe.core.d.ts +70 -2
  11. package/types/sap.fe.macros.d.ts +78 -34
  12. package/types/sap.fe.navigation.d.ts +144 -4
  13. package/types/sap.fe.templates.d.ts +26 -5
  14. package/types/sap.fe.test.d.ts +497 -2
  15. package/types/sap.feedback.ui.d.ts +1 -1
  16. package/types/sap.gantt.d.ts +7203 -502
  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 +16491 -1149
  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 +171 -15
  25. package/types/sap.sac.df.d.ts +1430 -215
  26. package/types/sap.sac.grid.d.ts +91 -8
  27. package/types/sap.suite.ui.commons.d.ts +5515 -396
  28. package/types/sap.suite.ui.generic.template.d.ts +157 -69
  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 +3853 -276
  34. package/types/sap.ui.core.d.ts +6248 -313
  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 +238 -64
  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 +1 -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 +30 -1
  47. package/types/sap.ui.table.d.ts +1050 -80
  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 +5353 -310
  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 +1488 -49
  56. package/types/sap.ushell_abap.d.ts +4 -1
  57. package/types/sap.uxap.d.ts +902 -87
  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 +165 -20
  61. package/types/sap.zen.crosstab.d.ts +217 -21
  62. package/types/sap.zen.dsh.d.ts +227 -14
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.101.1
1
+ // For Library Version: 1.102.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace fe {
@@ -12,10 +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
19
  /**
18
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
19
23
  */
20
24
  iChangeDialogField(
21
25
  /**
@@ -33,10 +37,14 @@ declare namespace sap {
33
37
  ): object;
34
38
  /**
35
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
36
42
  */
37
43
  iClose(): object;
38
44
  /**
39
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
40
48
  */
41
49
  iConfirm(): object;
42
50
  }
@@ -46,6 +54,8 @@ declare namespace sap {
46
54
 
47
55
  /**
48
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
49
59
  */
50
60
  iCheckActionParameterDialogField(
51
61
  /**
@@ -69,6 +79,8 @@ declare namespace sap {
69
79
  ): object;
70
80
  /**
71
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
72
84
  */
73
85
  iCheckCancel(
74
86
  /**
@@ -78,6 +90,8 @@ declare namespace sap {
78
90
  ): object;
79
91
  /**
80
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
81
95
  */
82
96
  iCheckConfirm(
83
97
  /**
@@ -87,6 +101,8 @@ declare namespace sap {
87
101
  ): object;
88
102
  /**
89
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
90
106
  */
91
107
  iCheckDialogField(
92
108
  /**
@@ -110,6 +126,8 @@ declare namespace sap {
110
126
  ): object;
111
127
  /**
112
128
  * Checks the dialog.
129
+ *
130
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
113
131
  */
114
132
  iCheckState(
115
133
  /**
@@ -124,6 +142,8 @@ declare namespace sap {
124
142
 
125
143
  /**
126
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
127
147
  */
128
148
  iExecuteCreate(): object;
129
149
  }
@@ -133,6 +153,8 @@ declare namespace sap {
133
153
 
134
154
  /**
135
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
136
158
  */
137
159
  iCheckCreate(
138
160
  /**
@@ -147,14 +169,20 @@ declare namespace sap {
147
169
 
148
170
  /**
149
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
150
174
  */
151
175
  iExecuteBack(): object;
152
176
  /**
153
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
154
180
  */
155
181
  iExecuteRefresh(): object;
156
182
  /**
157
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
158
186
  */
159
187
  iSelectDraftDataLossOption(): object;
160
188
  }
@@ -164,6 +192,8 @@ declare namespace sap {
164
192
 
165
193
  /**
166
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
167
197
  */
168
198
  iCheckBack(
169
199
  /**
@@ -173,6 +203,8 @@ declare namespace sap {
173
203
  ): object;
174
204
  /**
175
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
176
208
  */
177
209
  iCheckMessage(
178
210
  /**
@@ -182,6 +214,8 @@ declare namespace sap {
182
214
  ): object;
183
215
  /**
184
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
185
219
  */
186
220
  iCheckRefresh(
187
221
  /**
@@ -196,6 +230,8 @@ declare namespace sap {
196
230
 
197
231
  /**
198
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
199
235
  */
200
236
  iAddCondition(
201
237
  /**
@@ -210,6 +246,8 @@ declare namespace sap {
210
246
  ): object;
211
247
  /**
212
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
213
251
  */
214
252
  iChangeCondition(
215
253
  /**
@@ -228,6 +266,8 @@ declare namespace sap {
228
266
  ): object;
229
267
  /**
230
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
231
271
  */
232
272
  iChangeFilterField(
233
273
  /**
@@ -245,6 +285,8 @@ declare namespace sap {
245
285
  ): object;
246
286
  /**
247
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
248
290
  */
249
291
  iChangeSearchField(
250
292
  /**
@@ -254,22 +296,32 @@ declare namespace sap {
254
296
  ): object;
255
297
  /**
256
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
257
301
  */
258
302
  iExecuteSearch(): object;
259
303
  /**
260
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
261
307
  */
262
308
  iExecuteShowHideFilters(): object;
263
309
  /**
264
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
265
313
  */
266
314
  iGoToDefineConditions(): object;
267
315
  /**
268
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
269
319
  */
270
320
  iGoToSearchAndSelect(): object;
271
321
  /**
272
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
273
325
  */
274
326
  iRemoveCondition(
275
327
  /**
@@ -279,10 +331,14 @@ declare namespace sap {
279
331
  ): object;
280
332
  /**
281
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
282
336
  */
283
337
  iResetSearchField(): object;
284
338
  /**
285
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
286
342
  */
287
343
  iSelectRows(
288
344
  /**
@@ -309,6 +365,8 @@ declare namespace sap {
309
365
 
310
366
  /**
311
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
312
370
  */
313
371
  iCheckDefineConditions(
314
372
  /**
@@ -318,6 +376,8 @@ declare namespace sap {
318
376
  ): object;
319
377
  /**
320
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
321
381
  */
322
382
  iCheckFilterBar(
323
383
  /**
@@ -327,6 +387,8 @@ declare namespace sap {
327
387
  ): object;
328
388
  /**
329
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
330
392
  */
331
393
  iCheckFilterField(
332
394
  /**
@@ -351,6 +413,8 @@ declare namespace sap {
351
413
  * considered. If `iNumberOfRows` is provided, the number of rows are checked with respect to the provided
352
414
  * `mRowValues` (if set) or in total. If `iNumberOfRows` is omitted, it checks for at least one matching
353
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
354
418
  */
355
419
  iCheckRows(
356
420
  /**
@@ -374,6 +438,8 @@ declare namespace sap {
374
438
  ): object;
375
439
  /**
376
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
377
443
  */
378
444
  iCheckSearchAndSelect(
379
445
  /**
@@ -384,6 +450,8 @@ declare namespace sap {
384
450
  /**
385
451
  * Checks the search field in the filter bar. If the `sSearchText` parameter is `undefined`, the search
386
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
387
455
  */
388
456
  iCheckSearchField(
389
457
  /**
@@ -397,6 +465,8 @@ declare namespace sap {
397
465
  ): object;
398
466
  /**
399
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
400
470
  */
401
471
  iCheckTable(
402
472
  /**
@@ -411,6 +481,8 @@ declare namespace sap {
411
481
 
412
482
  /**
413
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
414
486
  */
415
487
  iAddAdaptationFilterField(
416
488
  /**
@@ -420,6 +492,8 @@ declare namespace sap {
420
492
  ): object;
421
493
  /**
422
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
423
497
  */
424
498
  iChangeEditingStatus(
425
499
  /**
@@ -429,6 +503,8 @@ declare namespace sap {
429
503
  ): object;
430
504
  /**
431
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
432
508
  */
433
509
  iChangeFilterField(
434
510
  /**
@@ -446,6 +522,8 @@ declare namespace sap {
446
522
  ): object;
447
523
  /**
448
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
449
527
  */
450
528
  iChangeSearchField(
451
529
  /**
@@ -455,6 +533,8 @@ declare namespace sap {
455
533
  ): object;
456
534
  /**
457
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
458
538
  */
459
539
  iExecuteKeyboardShortcut(
460
540
  /**
@@ -468,10 +548,14 @@ declare namespace sap {
468
548
  ): object;
469
549
  /**
470
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
471
553
  */
472
554
  iExecuteSearch(): object;
473
555
  /**
474
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
475
559
  */
476
560
  iOpenValueHelp(
477
561
  /**
@@ -481,6 +565,8 @@ declare namespace sap {
481
565
  ): object;
482
566
  /**
483
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
484
570
  */
485
571
  iRemoveAdaptationFilterField(
486
572
  /**
@@ -490,10 +576,14 @@ declare namespace sap {
490
576
  ): object;
491
577
  /**
492
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
493
581
  */
494
582
  iResetSearchField(): object;
495
583
  /**
496
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
497
587
  */
498
588
  iSaveVariant(
499
589
  /**
@@ -511,6 +601,8 @@ declare namespace sap {
511
601
  ): object;
512
602
  /**
513
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
514
606
  */
515
607
  iSelectVariant(
516
608
  /**
@@ -525,10 +617,14 @@ declare namespace sap {
525
617
 
526
618
  /**
527
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
528
622
  */
529
623
  iConfirmFilterAdaptation(): object;
530
624
  /**
531
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
532
628
  */
533
629
  iOpenFilterAdaptation(): object;
534
630
  }
@@ -538,6 +634,8 @@ declare namespace sap {
538
634
 
539
635
  /**
540
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
541
639
  */
542
640
  iCheckAdaptationFilterField(
543
641
  /**
@@ -551,6 +649,8 @@ declare namespace sap {
551
649
  ): object;
552
650
  /**
553
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
554
654
  */
555
655
  iCheckEditingStatus(
556
656
  /**
@@ -564,10 +664,14 @@ declare namespace sap {
564
664
  ): object;
565
665
  /**
566
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
567
669
  */
568
670
  iCheckFilterAdaptation(): object;
569
671
  /**
570
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
571
675
  */
572
676
  iCheckFilterField(
573
677
  /**
@@ -589,6 +693,8 @@ declare namespace sap {
589
693
  ): object;
590
694
  /**
591
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
592
698
  */
593
699
  iCheckSearch(
594
700
  /**
@@ -599,6 +705,8 @@ declare namespace sap {
599
705
  /**
600
706
  * Checks the search field in the filter bar. If the `sSearchText` parameter is `undefined`, the search
601
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
602
710
  */
603
711
  iCheckSearchField(
604
712
  /**
@@ -612,6 +720,8 @@ declare namespace sap {
612
720
  ): object;
613
721
  /**
614
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
615
725
  */
616
726
  iCheckState(
617
727
  /**
@@ -626,6 +736,8 @@ declare namespace sap {
626
736
 
627
737
  /**
628
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
629
741
  */
630
742
  iExecuteAction(
631
743
  /**
@@ -640,18 +752,26 @@ declare namespace sap {
640
752
 
641
753
  /**
642
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
643
757
  */
644
758
  iConfirmCancel(): object;
645
759
  /**
646
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
647
763
  */
648
764
  iExecuteApply(): object;
649
765
  /**
650
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
651
769
  */
652
770
  iExecuteCancel(): object;
653
771
  /**
654
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
655
775
  */
656
776
  iExecuteSave(): object;
657
777
  }
@@ -661,6 +781,8 @@ declare namespace sap {
661
781
 
662
782
  /**
663
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
664
786
  */
665
787
  iCheckAction(
666
788
  /**
@@ -674,6 +796,8 @@ declare namespace sap {
674
796
  ): object;
675
797
  /**
676
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
677
801
  */
678
802
  iCheckState(
679
803
  /**
@@ -688,6 +812,8 @@ declare namespace sap {
688
812
 
689
813
  /**
690
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
691
817
  */
692
818
  iCheckApply(
693
819
  /**
@@ -697,6 +823,8 @@ declare namespace sap {
697
823
  ): object;
698
824
  /**
699
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
700
828
  */
701
829
  iCheckCancel(
702
830
  /**
@@ -706,14 +834,20 @@ declare namespace sap {
706
834
  ): object;
707
835
  /**
708
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
709
839
  */
710
840
  iCheckDraftStateClear(): object;
711
841
  /**
712
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
713
845
  */
714
846
  iCheckDraftStateSaved(): object;
715
847
  /**
716
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
717
851
  */
718
852
  iCheckSave(
719
853
  /**
@@ -728,6 +862,8 @@ declare namespace sap {
728
862
 
729
863
  /**
730
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
731
867
  */
732
868
  iChangeField(
733
869
  /**
@@ -741,6 +877,8 @@ declare namespace sap {
741
877
  ): object;
742
878
  /**
743
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
744
882
  */
745
883
  iClickCheckBox(
746
884
  /**
@@ -750,6 +888,8 @@ declare namespace sap {
750
888
  ): object;
751
889
  /**
752
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
753
893
  */
754
894
  iClickLink(
755
895
  /**
@@ -759,6 +899,8 @@ declare namespace sap {
759
899
  ): object;
760
900
  /**
761
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
762
904
  */
763
905
  iExecuteAction(
764
906
  /**
@@ -768,14 +910,20 @@ declare namespace sap {
768
910
  ): object;
769
911
  /**
770
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
771
915
  */
772
916
  iExecuteShowLess(): object;
773
917
  /**
774
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
775
921
  */
776
922
  iExecuteShowMore(): object;
777
923
  /**
778
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
779
927
  */
780
928
  iOpenValueHelp(
781
929
  /**
@@ -794,6 +942,8 @@ declare namespace sap {
794
942
 
795
943
  /**
796
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
797
947
  */
798
948
  iCheckAction(
799
949
  /**
@@ -807,6 +957,8 @@ declare namespace sap {
807
957
  ): object;
808
958
  /**
809
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
810
962
  */
811
963
  iCheckField(
812
964
  /**
@@ -831,6 +983,8 @@ declare namespace sap {
831
983
  ): object;
832
984
  /**
833
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
834
988
  */
835
989
  iCheckLink(
836
990
  /**
@@ -848,6 +1002,8 @@ declare namespace sap {
848
1002
  ): object;
849
1003
  /**
850
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
851
1007
  */
852
1008
  iCheckShowLess(
853
1009
  /**
@@ -857,6 +1013,8 @@ declare namespace sap {
857
1013
  ): object;
858
1014
  /**
859
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
860
1018
  */
861
1019
  iCheckShowMore(
862
1020
  /**
@@ -866,6 +1024,8 @@ declare namespace sap {
866
1024
  ): object;
867
1025
  /**
868
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
869
1029
  */
870
1030
  iCheckState(
871
1031
  /**
@@ -880,6 +1040,8 @@ declare namespace sap {
880
1040
 
881
1041
  /**
882
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
883
1045
  */
884
1046
  iExecuteAction(
885
1047
  /**
@@ -889,14 +1051,20 @@ declare namespace sap {
889
1051
  ): object;
890
1052
  /**
891
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
892
1056
  */
893
1057
  iExecuteDelete(): object;
894
1058
  /**
895
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
896
1062
  */
897
1063
  iExecuteEdit(): object;
898
1064
  /**
899
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
900
1068
  */
901
1069
  iExecuteMenuAction(
902
1070
  /**
@@ -906,18 +1074,26 @@ declare namespace sap {
906
1074
  ): object;
907
1075
  /**
908
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
909
1079
  */
910
1080
  iExecutePaginatorDown(): object;
911
1081
  /**
912
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
913
1085
  */
914
1086
  iExecutePaginatorUp(): object;
915
1087
  /**
916
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
917
1091
  */
918
1092
  iExecuteRelatedApps(): object;
919
1093
  /**
920
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
921
1097
  */
922
1098
  iExecuteSelectListAction(
923
1099
  /**
@@ -932,6 +1108,8 @@ declare namespace sap {
932
1108
 
933
1109
  /**
934
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
935
1113
  */
936
1114
  iExecuteAction(
937
1115
  /**
@@ -946,6 +1124,8 @@ declare namespace sap {
946
1124
 
947
1125
  /**
948
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
949
1129
  */
950
1130
  iCheckAction(
951
1131
  /**
@@ -959,6 +1139,8 @@ declare namespace sap {
959
1139
  ): object;
960
1140
  /**
961
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
962
1144
  */
963
1145
  iCheckDelete(
964
1146
  /**
@@ -968,6 +1150,8 @@ declare namespace sap {
968
1150
  ): object;
969
1151
  /**
970
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
971
1155
  */
972
1156
  iCheckEdit(
973
1157
  /**
@@ -977,6 +1161,8 @@ declare namespace sap {
977
1161
  ): object;
978
1162
  /**
979
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
980
1166
  */
981
1167
  iCheckFieldInFieldGroup(
982
1168
  /**
@@ -1002,6 +1188,8 @@ declare namespace sap {
1002
1188
  ): object;
1003
1189
  /**
1004
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
1005
1193
  */
1006
1194
  iCheckHeaderFacet(
1007
1195
  /**
@@ -1015,6 +1203,8 @@ declare namespace sap {
1015
1203
  ): object;
1016
1204
  /**
1017
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
1018
1208
  */
1019
1209
  iCheckMenuAction(
1020
1210
  /**
@@ -1024,6 +1214,8 @@ declare namespace sap {
1024
1214
  ): object;
1025
1215
  /**
1026
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
1027
1219
  */
1028
1220
  iCheckPaginatorDown(
1029
1221
  /**
@@ -1033,6 +1225,8 @@ declare namespace sap {
1033
1225
  ): object;
1034
1226
  /**
1035
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
1036
1230
  */
1037
1231
  iCheckPaginatorUp(
1038
1232
  /**
@@ -1042,6 +1236,8 @@ declare namespace sap {
1042
1236
  ): object;
1043
1237
  /**
1044
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
1045
1241
  */
1046
1242
  iCheckRelatedApps(
1047
1243
  /**
@@ -1051,6 +1247,8 @@ declare namespace sap {
1051
1247
  ): object;
1052
1248
  /**
1053
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
1054
1252
  */
1055
1253
  iCheckSaveAsTile(
1056
1254
  /**
@@ -1060,6 +1258,8 @@ declare namespace sap {
1060
1258
  ): object;
1061
1259
  /**
1062
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
1063
1263
  */
1064
1264
  iCheckSendEmail(
1065
1265
  /**
@@ -1071,6 +1271,8 @@ declare namespace sap {
1071
1271
  * Checks the title and description of the object page.
1072
1272
  *
1073
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
1074
1276
  */
1075
1277
  iCheckTitle(
1076
1278
  /**
@@ -1089,6 +1291,8 @@ declare namespace sap {
1089
1291
 
1090
1292
  /**
1091
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
1092
1296
  */
1093
1297
  iCheckAction(
1094
1298
  /**
@@ -1102,6 +1306,8 @@ declare namespace sap {
1102
1306
  ): object;
1103
1307
  /**
1104
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
1105
1311
  */
1106
1312
  iCheckSaveAsTile(
1107
1313
  /**
@@ -1111,6 +1317,8 @@ declare namespace sap {
1111
1317
  ): object;
1112
1318
  /**
1113
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
1114
1322
  */
1115
1323
  iCheckSendEmail(
1116
1324
  /**
@@ -1125,6 +1333,8 @@ declare namespace sap {
1125
1333
 
1126
1334
  /**
1127
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
1128
1338
  */
1129
1339
  iAddAdaptationColumn(
1130
1340
  /**
@@ -1134,6 +1344,8 @@ declare namespace sap {
1134
1344
  ): object;
1135
1345
  /**
1136
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
1137
1349
  */
1138
1350
  iAggregateByColumn(
1139
1351
  /**
@@ -1150,6 +1362,8 @@ declare namespace sap {
1150
1362
  ): object;
1151
1363
  /**
1152
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
1153
1367
  */
1154
1368
  iChangeFilterField(
1155
1369
  /**
@@ -1170,6 +1384,8 @@ declare namespace sap {
1170
1384
  *
1171
1385
  * If only one parameter is provided, it must be the `mTargetValues` and `mRowValues` is considered undefined.
1172
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
1173
1389
  */
1174
1390
  iChangeRow(
1175
1391
  /**
@@ -1198,6 +1414,8 @@ declare namespace sap {
1198
1414
  *
1199
1415
  * If only one parameter is provided, it must be the `mTargetValues` and `mRowValues` is considered undefined.
1200
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
1201
1419
  */
1202
1420
  iChangeRow(
1203
1421
  /**
@@ -1212,6 +1430,8 @@ declare namespace sap {
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,10 +2857,14 @@ 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;
2442
2864
  /**
2443
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
2444
2868
  */
2445
2869
  iResetMockData(
2446
2870
  /**
@@ -2460,15 +2884,21 @@ declare namespace sap {
2460
2884
  ): object;
2461
2885
  /**
2462
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
2463
2889
  */
2464
2890
  iResetTestData(): object;
2465
2891
  /**
2466
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
2467
2895
  */
2468
2896
  iRestartMyApp(): object;
2469
2897
  /**
2470
2898
  * Starts the app in an IFrame, using the `launchUrl` and `launchParameters` provided via the settings object
2471
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
2472
2902
  */
2473
2903
  iStartMyApp(
2474
2904
  /**
@@ -2482,6 +2912,8 @@ declare namespace sap {
2482
2912
  ): object;
2483
2913
  /**
2484
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
2485
2917
  */
2486
2918
  iTearDownMyApp(): object;
2487
2919
  /**
@@ -2489,6 +2921,8 @@ declare namespace sap {
2489
2921
  *
2490
2922
  * NOTE: The function itself is not meant to be called directly within a journey. Instead, it can be overwritten
2491
2923
  * to add custom clean-up functionality when calling {@link sap.fe.test.BaseArrangements#iResetTestData}.
2924
+ *
2925
+ * @returns A `Promise` object
2492
2926
  */
2493
2927
  resetTestData(): object;
2494
2928
  }
@@ -2506,6 +2940,8 @@ declare namespace sap {
2506
2940
  * the information contained in `oClassInfo`.
2507
2941
  *
2508
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
2509
2945
  */
2510
2946
  static extend<T extends Record<string, unknown>>(
2511
2947
  /**
@@ -2524,10 +2960,14 @@ declare namespace sap {
2524
2960
  ): Function;
2525
2961
  /**
2526
2962
  * Returns a metadata object for class sap.fe.test.BaseAssertions.
2963
+ *
2964
+ * @returns Metadata object describing this class
2527
2965
  */
2528
2966
  static getMetadata(): sap.ui.base.Metadata;
2529
2967
  /**
2530
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
2531
2971
  */
2532
2972
  iSeeMessagePage(
2533
2973
  /**
@@ -2537,6 +2977,8 @@ declare namespace sap {
2537
2977
  ): object;
2538
2978
  /**
2539
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
2540
2982
  */
2541
2983
  iSeeMessageToast(
2542
2984
  /**
@@ -2585,6 +3027,8 @@ declare namespace sap {
2585
3027
  * the information contained in `oClassInfo`.
2586
3028
  *
2587
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
2588
3032
  */
2589
3033
  static extend<T extends Record<string, unknown>>(
2590
3034
  /**
@@ -2603,10 +3047,14 @@ declare namespace sap {
2603
3047
  ): Function;
2604
3048
  /**
2605
3049
  * Gets the global journey runner instance.
3050
+ *
3051
+ * @returns The global default {@link sap.fe.test.JourneyRunner} instance
2606
3052
  */
2607
3053
  static getDefaultRunner(): object;
2608
3054
  /**
2609
3055
  * Returns a metadata object for class sap.fe.test.JourneyRunner.
3056
+ *
3057
+ * @returns Metadata object describing this class
2610
3058
  */
2611
3059
  static getMetadata(): sap.ui.base.Metadata;
2612
3060
  /**
@@ -2633,6 +3081,8 @@ declare namespace sap {
2633
3081
  * by a custom JourneyRunner implementation to provide custom base actions.
2634
3082
  *
2635
3083
  * By default, an instance of {@link sap.fe.test.BaseActions} will be returned.
3084
+ *
3085
+ * @returns An Opa instance for the base actions
2636
3086
  */
2637
3087
  getBaseActions(
2638
3088
  /**
@@ -2648,6 +3098,8 @@ declare namespace sap {
2648
3098
  * overridden by a custom JourneyRunner implementation to provide custom base assertions.
2649
3099
  *
2650
3100
  * By default, an instance of {@link sap.fe.test.BaseArrangements} will be returned.
3101
+ *
3102
+ * @returns An Opa instance for the base arrangements
2651
3103
  */
2652
3104
  getBaseArrangements(
2653
3105
  /**
@@ -2663,6 +3115,8 @@ declare namespace sap {
2663
3115
  * overridden by a custom JourneyRunner implementation to provide custom base assertions.
2664
3116
  *
2665
3117
  * By default, an instance of {@link sap.fe.test.BaseAssertions} will be returned.
3118
+ *
3119
+ * @returns An Opa instance for the base assertions
2666
3120
  */
2667
3121
  getBaseAssertions(
2668
3122
  /**
@@ -2674,6 +3128,8 @@ declare namespace sap {
2674
3128
  * Executes the journeys in the given order.
2675
3129
  *
2676
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
2677
3133
  */
2678
3134
  run(
2679
3135
  /**
@@ -2714,6 +3170,8 @@ declare namespace sap {
2714
3170
  * Executes the journeys in the given order.
2715
3171
  *
2716
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
2717
3175
  */
2718
3176
  run(
2719
3177
  /**
@@ -2824,16 +3282,49 @@ declare namespace sap {
2824
3282
  ...aAdditionalPageDefinitions: object[]
2825
3283
  );
2826
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;
2827
3312
  /**
2828
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
2829
3316
  */
2830
3317
  iNavigateBack(): object;
2831
3318
  /**
2832
- * 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
2833
3322
  */
2834
3323
  iNavigateHome(): object;
2835
3324
  /**
2836
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
2837
3328
  */
2838
3329
  iNavigateViaMenu(
2839
3330
  /**
@@ -2843,10 +3334,14 @@ declare namespace sap {
2843
3334
  ): object;
2844
3335
  /**
2845
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
2846
3339
  */
2847
3340
  iOpenNavigationMenu(): object;
2848
3341
  /**
2849
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
2850
3345
  */
2851
3346
  iPressTile(
2852
3347
  /**