@sapui5/ts-types 1.101.1 → 1.103.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 +1757 -134
  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 +1 -669
  8. package/types/sap.f.d.ts +1948 -123
  9. package/types/sap.fe.common.d.ts +1 -1
  10. package/types/sap.fe.core.d.ts +29 -1091
  11. package/types/sap.fe.macros.d.ts +58 -589
  12. package/types/sap.fe.navigation.d.ts +7 -1175
  13. package/types/sap.fe.templates.d.ts +2 -140
  14. package/types/sap.fe.test.d.ts +476 -213
  15. package/types/sap.feedback.ui.d.ts +1 -1
  16. package/types/sap.gantt.d.ts +7540 -559
  17. package/types/sap.insights.d.ts +21 -0
  18. package/types/sap.landvisz.d.ts +1029 -80
  19. package/types/sap.m.d.ts +17162 -1399
  20. package/types/sap.makit.d.ts +579 -58
  21. package/types/sap.me.d.ts +579 -52
  22. package/types/sap.ndc.d.ts +137 -7
  23. package/types/sap.ovp.d.ts +5 -1
  24. package/types/sap.rules.ui.d.ts +171 -15
  25. package/types/sap.sac.df.d.ts +1629 -252
  26. package/types/sap.sac.grid.d.ts +91 -8
  27. package/types/sap.suite.ui.commons.d.ts +5573 -454
  28. package/types/sap.suite.ui.generic.template.d.ts +228 -54
  29. package/types/sap.suite.ui.microchart.d.ts +1814 -173
  30. package/types/sap.tnt.d.ts +282 -22
  31. package/types/sap.ui.codeeditor.d.ts +89 -8
  32. package/types/sap.ui.commons.d.ts +3818 -347
  33. package/types/sap.ui.comp.d.ts +3965 -303
  34. package/types/sap.ui.core.d.ts +6395 -258
  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 +3 -1
  38. package/types/sap.ui.generic.app.d.ts +245 -64
  39. package/types/sap.ui.generic.template.d.ts +1 -1
  40. package/types/sap.ui.integration.d.ts +318 -25
  41. package/types/sap.ui.layout.d.ts +1883 -239
  42. package/types/sap.ui.mdc.d.ts +1 -1
  43. package/types/sap.ui.richtexteditor.d.ts +341 -50
  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 +1057 -87
  48. package/types/sap.ui.testrecorder.d.ts +1 -1
  49. package/types/sap.ui.unified.d.ts +2738 -236
  50. package/types/sap.ui.ux3.d.ts +2421 -223
  51. package/types/sap.ui.vbm.d.ts +2006 -126
  52. package/types/sap.ui.vk.d.ts +5369 -326
  53. package/types/sap.ui.vtm.d.ts +1144 -52
  54. package/types/sap.uiext.inbox.d.ts +425 -24
  55. package/types/sap.ushell.d.ts +1500 -59
  56. package/types/sap.ushell_abap.d.ts +4 -1
  57. package/types/sap.uxap.d.ts +914 -99
  58. package/types/sap.viz.d.ts +5521 -387
  59. package/types/sap.webanalytics.core.d.ts +1 -1
  60. package/types/sap.zen.commons.d.ts +168 -23
  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.103.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,16 +169,22 @@ 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
- * Selects the specified entry in the draft data loss popup
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
- iSelectDraftDataLossOption(): object;
187
+ iSelectDraftDataLossOption(optionKey: any): object;
160
188
  }
161
189
 
162
190
  class DialogMessageAssertions extends sap.fe.test.api.DialogAssertions {
@@ -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,26 @@ 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;
1058
+ /**
1059
+ * Executes the Draft/Saved Version 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
1062
+ */
1063
+ iExecuteDraftAndSavedVersionSwitch(): object;
894
1064
  /**
895
1065
  * Executes the Edit action in the header toolbar of an object page.
1066
+ *
1067
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
896
1068
  */
897
1069
  iExecuteEdit(): object;
898
1070
  /**
899
1071
  * Executes an action in the drop-down menu that is currently open.
1072
+ *
1073
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
900
1074
  */
901
1075
  iExecuteMenuAction(
902
1076
  /**
@@ -906,18 +1080,26 @@ declare namespace sap {
906
1080
  ): object;
907
1081
  /**
908
1082
  * Navigates to the next sub-object page.
1083
+ *
1084
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
909
1085
  */
910
1086
  iExecutePaginatorDown(): object;
911
1087
  /**
912
1088
  * Navigates to the previous sub-object page.
1089
+ *
1090
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
913
1091
  */
914
1092
  iExecutePaginatorUp(): object;
915
1093
  /**
916
1094
  * Executes the Related Apps action in the header toolbar of an object page.
1095
+ *
1096
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
917
1097
  */
918
1098
  iExecuteRelatedApps(): object;
919
1099
  /**
920
1100
  * Executes an action in the selection list that is currently open.
1101
+ *
1102
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
921
1103
  */
922
1104
  iExecuteSelectListAction(
923
1105
  /**
@@ -932,6 +1114,8 @@ declare namespace sap {
932
1114
 
933
1115
  /**
934
1116
  * Executes an action in the header toolbar of a list report.
1117
+ *
1118
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
935
1119
  */
936
1120
  iExecuteAction(
937
1121
  /**
@@ -946,6 +1130,8 @@ declare namespace sap {
946
1130
 
947
1131
  /**
948
1132
  * Checks an action in the header toolbar.
1133
+ *
1134
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
949
1135
  */
950
1136
  iCheckAction(
951
1137
  /**
@@ -959,6 +1145,8 @@ declare namespace sap {
959
1145
  ): object;
960
1146
  /**
961
1147
  * Checks the `Delete` action in the header toolbar.
1148
+ *
1149
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
962
1150
  */
963
1151
  iCheckDelete(
964
1152
  /**
@@ -968,6 +1156,8 @@ declare namespace sap {
968
1156
  ): object;
969
1157
  /**
970
1158
  * Checks the `Edit` action in the header toolbar.
1159
+ *
1160
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
971
1161
  */
972
1162
  iCheckEdit(
973
1163
  /**
@@ -977,6 +1167,8 @@ declare namespace sap {
977
1167
  ): object;
978
1168
  /**
979
1169
  * Checks a field within a field group in the object page header.
1170
+ *
1171
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
980
1172
  */
981
1173
  iCheckFieldInFieldGroup(
982
1174
  /**
@@ -1002,6 +1194,8 @@ declare namespace sap {
1002
1194
  ): object;
1003
1195
  /**
1004
1196
  * Checks the custom facet in the object page header.
1197
+ *
1198
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1005
1199
  */
1006
1200
  iCheckHeaderFacet(
1007
1201
  /**
@@ -1015,6 +1209,8 @@ declare namespace sap {
1015
1209
  ): object;
1016
1210
  /**
1017
1211
  * Checks an action in the popover that is currently open.
1212
+ *
1213
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1018
1214
  */
1019
1215
  iCheckMenuAction(
1020
1216
  /**
@@ -1024,6 +1220,8 @@ declare namespace sap {
1024
1220
  ): object;
1025
1221
  /**
1026
1222
  * Checks the paginator down button.
1223
+ *
1224
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1027
1225
  */
1028
1226
  iCheckPaginatorDown(
1029
1227
  /**
@@ -1033,6 +1231,8 @@ declare namespace sap {
1033
1231
  ): object;
1034
1232
  /**
1035
1233
  * Checks the paginator up button.
1234
+ *
1235
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1036
1236
  */
1037
1237
  iCheckPaginatorUp(
1038
1238
  /**
@@ -1042,6 +1242,8 @@ declare namespace sap {
1042
1242
  ): object;
1043
1243
  /**
1044
1244
  * Checks the `Related Apps` action in the header toolbar.
1245
+ *
1246
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1045
1247
  */
1046
1248
  iCheckRelatedApps(
1047
1249
  /**
@@ -1051,6 +1253,8 @@ declare namespace sap {
1051
1253
  ): object;
1052
1254
  /**
1053
1255
  * Checks the `Save as Tile` action.
1256
+ *
1257
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1054
1258
  */
1055
1259
  iCheckSaveAsTile(
1056
1260
  /**
@@ -1060,6 +1264,8 @@ declare namespace sap {
1060
1264
  ): object;
1061
1265
  /**
1062
1266
  * Checks `Send Email` action.
1267
+ *
1268
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1063
1269
  */
1064
1270
  iCheckSendEmail(
1065
1271
  /**
@@ -1071,6 +1277,8 @@ declare namespace sap {
1071
1277
  * Checks the title and description of the object page.
1072
1278
  *
1073
1279
  * If either title or description is `undefined`, it will not be checked.
1280
+ *
1281
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1074
1282
  */
1075
1283
  iCheckTitle(
1076
1284
  /**
@@ -1089,6 +1297,8 @@ declare namespace sap {
1089
1297
 
1090
1298
  /**
1091
1299
  * Checks an action of the header toolbar.
1300
+ *
1301
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1092
1302
  */
1093
1303
  iCheckAction(
1094
1304
  /**
@@ -1102,6 +1312,8 @@ declare namespace sap {
1102
1312
  ): object;
1103
1313
  /**
1104
1314
  * Checks the `Save as Tile` action.
1315
+ *
1316
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1105
1317
  */
1106
1318
  iCheckSaveAsTile(
1107
1319
  /**
@@ -1111,6 +1323,8 @@ declare namespace sap {
1111
1323
  ): object;
1112
1324
  /**
1113
1325
  * Checks the `Send Email` action.
1326
+ *
1327
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1114
1328
  */
1115
1329
  iCheckSendEmail(
1116
1330
  /**
@@ -1125,6 +1339,8 @@ declare namespace sap {
1125
1339
 
1126
1340
  /**
1127
1341
  * Adds a field as a column to the table.
1342
+ *
1343
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1128
1344
  */
1129
1345
  iAddAdaptationColumn(
1130
1346
  /**
@@ -1134,6 +1350,8 @@ declare namespace sap {
1134
1350
  ): object;
1135
1351
  /**
1136
1352
  * Aggregates the table entries by the specified column.
1353
+ *
1354
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1137
1355
  */
1138
1356
  iAggregateByColumn(
1139
1357
  /**
@@ -1150,6 +1368,8 @@ declare namespace sap {
1150
1368
  ): object;
1151
1369
  /**
1152
1370
  * Adds a filter condition to the filter field.
1371
+ *
1372
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1153
1373
  */
1154
1374
  iChangeFilterField(
1155
1375
  /**
@@ -1170,6 +1390,8 @@ declare namespace sap {
1170
1390
  *
1171
1391
  * If only one parameter is provided, it must be the `mTargetValues` and `mRowValues` is considered undefined.
1172
1392
  * If `vRowValues` are not defined, then the targetValues are inserted in the creationRow.
1393
+ *
1394
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1173
1395
  */
1174
1396
  iChangeRow(
1175
1397
  /**
@@ -1198,6 +1420,8 @@ declare namespace sap {
1198
1420
  *
1199
1421
  * If only one parameter is provided, it must be the `mTargetValues` and `mRowValues` is considered undefined.
1200
1422
  * If `vRowValues` are not defined, then the targetValues are inserted in the creationRow.
1423
+ *
1424
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1201
1425
  */
1202
1426
  iChangeRow(
1203
1427
  /**
@@ -1212,6 +1436,8 @@ declare namespace sap {
1212
1436
  ): object;
1213
1437
  /**
1214
1438
  * Changes the search field.
1439
+ *
1440
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1215
1441
  */
1216
1442
  iChangeSearchField(
1217
1443
  /**
@@ -1221,6 +1447,8 @@ declare namespace sap {
1221
1447
  ): object;
1222
1448
  /**
1223
1449
  * Adds a field to the sorting of the table via the sort dialog.
1450
+ *
1451
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1224
1452
  */
1225
1453
  iChangeSortOrder(
1226
1454
  /**
@@ -1234,6 +1462,8 @@ declare namespace sap {
1234
1462
  ): object;
1235
1463
  /**
1236
1464
  * Collapses a row corresponding to a visual group.
1465
+ *
1466
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1237
1467
  */
1238
1468
  iCollapseGroupRow(
1239
1469
  /**
@@ -1247,6 +1477,8 @@ declare namespace sap {
1247
1477
  ): object;
1248
1478
  /**
1249
1479
  * Executes an action on the table.
1480
+ *
1481
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1250
1482
  */
1251
1483
  iExecuteAction(
1252
1484
  /**
@@ -1256,18 +1488,26 @@ declare namespace sap {
1256
1488
  ): object;
1257
1489
  /**
1258
1490
  * Executes the `Create` action on the table.
1491
+ *
1492
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1259
1493
  */
1260
1494
  iExecuteCreate(): object;
1261
1495
  /**
1262
1496
  * Executes the `Delete` action on the table.
1497
+ *
1498
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1263
1499
  */
1264
1500
  iExecuteDelete(): object;
1265
1501
  /**
1266
1502
  * Executes the `Fullscreen` action on the table.
1503
+ *
1504
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1267
1505
  */
1268
1506
  iExecuteFullScreen(): object;
1269
1507
  /**
1270
1508
  * Executes an action that is available in a certain column within a table row.
1509
+ *
1510
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1271
1511
  */
1272
1512
  iExecuteInlineAction(
1273
1513
  /**
@@ -1288,6 +1528,8 @@ declare namespace sap {
1288
1528
  ): object;
1289
1529
  /**
1290
1530
  * Executes an action that is available in a certain column within a table row.
1531
+ *
1532
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1291
1533
  */
1292
1534
  iExecuteInlineAction(
1293
1535
  /**
@@ -1297,12 +1539,16 @@ declare namespace sap {
1297
1539
  ): object;
1298
1540
  /**
1299
1541
  * Executes the action to create a row in the table.
1542
+ *
1543
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1300
1544
  */
1301
1545
  iExecuteInlineCreate(): object;
1302
1546
  /**
1303
1547
  * Executes a keyboard shortcut on the table or a cell control. If only `sShortcut` is defined, the shortcut
1304
1548
  * is executed on the table directly. If additionally `vRowValues` and `vColumn` are defined, the shortcut
1305
1549
  * is executed on table cell level.
1550
+ *
1551
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1306
1552
  */
1307
1553
  iExecuteKeyboardShortcut(
1308
1554
  /**
@@ -1329,6 +1575,8 @@ declare namespace sap {
1329
1575
  * Executes a keyboard shortcut on the table or a cell control. If only `sShortcut` is defined, the shortcut
1330
1576
  * is executed on the table directly. If additionally `vRowValues` and `vColumn` are defined, the shortcut
1331
1577
  * is executed on table cell level.
1578
+ *
1579
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1332
1580
  */
1333
1581
  iExecuteKeyboardShortcut(
1334
1582
  /**
@@ -1342,6 +1590,8 @@ declare namespace sap {
1342
1590
  ): object;
1343
1591
  /**
1344
1592
  * Executes an action form the drop-down menu that is currently open.
1593
+ *
1594
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1345
1595
  */
1346
1596
  iExecuteMenuAction(
1347
1597
  /**
@@ -1351,6 +1601,8 @@ declare namespace sap {
1351
1601
  ): object;
1352
1602
  /**
1353
1603
  * Executes the `Show/Hide details` action on the table.
1604
+ *
1605
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1354
1606
  */
1355
1607
  iExecuteShowHideDetails(
1356
1608
  /**
@@ -1361,6 +1613,8 @@ declare namespace sap {
1361
1613
  ): object;
1362
1614
  /**
1363
1615
  * Expands a row corresponding to a visual group.
1616
+ *
1617
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1364
1618
  */
1365
1619
  iExpandGroupRow(
1366
1620
  /**
@@ -1374,6 +1628,8 @@ declare namespace sap {
1374
1628
  ): object;
1375
1629
  /**
1376
1630
  * Groups the table entries by the specified column.
1631
+ *
1632
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1377
1633
  */
1378
1634
  iGroupByColumn(
1379
1635
  /**
@@ -1390,6 +1646,8 @@ declare namespace sap {
1390
1646
  ): object;
1391
1647
  /**
1392
1648
  * Pastes data into the table.
1649
+ *
1650
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1393
1651
  */
1394
1652
  iPasteData(
1395
1653
  /**
@@ -1399,6 +1657,8 @@ declare namespace sap {
1399
1657
  ): object;
1400
1658
  /**
1401
1659
  * Presses the control in the table cell.
1660
+ *
1661
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1402
1662
  */
1403
1663
  iPressCell(
1404
1664
  /**
@@ -1419,6 +1679,8 @@ declare namespace sap {
1419
1679
  ): object;
1420
1680
  /**
1421
1681
  * Presses the control in the table cell.
1682
+ *
1683
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1422
1684
  */
1423
1685
  iPressCell(
1424
1686
  /**
@@ -1428,6 +1690,8 @@ declare namespace sap {
1428
1690
  ): object;
1429
1691
  /**
1430
1692
  * Clicks the specified row.
1693
+ *
1694
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1431
1695
  */
1432
1696
  iPressRow(
1433
1697
  /**
@@ -1444,6 +1708,8 @@ declare namespace sap {
1444
1708
  ): object;
1445
1709
  /**
1446
1710
  * Removes a field as a column from the table.
1711
+ *
1712
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1447
1713
  */
1448
1714
  iRemoveAdaptationColumn(
1449
1715
  /**
@@ -1453,6 +1719,8 @@ declare namespace sap {
1453
1719
  ): object;
1454
1720
  /**
1455
1721
  * Removes the variant of the given name.
1722
+ *
1723
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1456
1724
  */
1457
1725
  iRemoveVariant(
1458
1726
  /**
@@ -1462,10 +1730,14 @@ declare namespace sap {
1462
1730
  ): object;
1463
1731
  /**
1464
1732
  * Resets the search field.
1733
+ *
1734
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1465
1735
  */
1466
1736
  iResetSearchField(): object;
1467
1737
  /**
1468
1738
  * Saves a variant under the given name, or overwrites the current one.
1739
+ *
1740
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1469
1741
  */
1470
1742
  iSaveVariant(
1471
1743
  /**
@@ -1475,10 +1747,14 @@ declare namespace sap {
1475
1747
  ): object;
1476
1748
  /**
1477
1749
  * Selects all rows in a table.
1750
+ *
1751
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1478
1752
  */
1479
1753
  iSelectAllRows(): object;
1480
1754
  /**
1481
1755
  * Selects a quick-filter item on the table.
1756
+ *
1757
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1482
1758
  */
1483
1759
  iSelectQuickFilterItem(
1484
1760
  /**
@@ -1495,6 +1771,8 @@ declare namespace sap {
1495
1771
  ): object;
1496
1772
  /**
1497
1773
  * Selects the specified rows.
1774
+ *
1775
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1498
1776
  */
1499
1777
  iSelectRows(
1500
1778
  /**
@@ -1515,6 +1793,8 @@ declare namespace sap {
1515
1793
  ): object;
1516
1794
  /**
1517
1795
  * Selects the chosen variant.
1796
+ *
1797
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1518
1798
  */
1519
1799
  iSelectVariant(
1520
1800
  /**
@@ -1524,6 +1804,8 @@ declare namespace sap {
1524
1804
  ): object;
1525
1805
  /**
1526
1806
  * Sets the variant as the default.
1807
+ *
1808
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1527
1809
  */
1528
1810
  iSetDefaultVariant(
1529
1811
  /**
@@ -1534,6 +1816,8 @@ declare namespace sap {
1534
1816
  ): object;
1535
1817
  /**
1536
1818
  * Sorts the table entries by the specified column.
1819
+ *
1820
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1537
1821
  */
1538
1822
  iSortByColumn(
1539
1823
  /**
@@ -1548,10 +1832,12 @@ declare namespace sap {
1548
1832
  */
1549
1833
  sFieldLabel: string,
1550
1834
 
1551
- bDescending: undefined
1835
+ bDescending: boolean
1552
1836
  ): object;
1553
1837
  /**
1554
1838
  * Sorts the table entries by the specified column.
1839
+ *
1840
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1555
1841
  */
1556
1842
  iSortByColumn(
1557
1843
  /**
@@ -1562,7 +1848,7 @@ declare namespace sap {
1562
1848
  | sap.fe.test.api.ColumnIdentifier
1563
1849
  | number,
1564
1850
 
1565
- bDescending: undefined
1851
+ bDescending: boolean
1566
1852
  ): object;
1567
1853
  }
1568
1854
 
@@ -1571,26 +1857,38 @@ declare namespace sap {
1571
1857
 
1572
1858
  /**
1573
1859
  * Confirms and closes the adaptation dialog of the table.
1860
+ *
1861
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1574
1862
  */
1575
1863
  iConfirmColumnAdaptation(): object;
1576
1864
  /**
1577
1865
  * Confirms and closes the sorting dialog of the table.
1866
+ *
1867
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1578
1868
  */
1579
1869
  iConfirmColumnSorting(): object;
1580
1870
  /**
1581
1871
  * Confirms and closes the filtering dialog of the table.
1872
+ *
1873
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1582
1874
  */
1583
1875
  iConfirmFilterDialog(): object;
1584
1876
  /**
1585
1877
  * Opens the column adaptation dialog of the table.
1878
+ *
1879
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1586
1880
  */
1587
1881
  iOpenColumnAdaptation(): object;
1588
1882
  /**
1589
1883
  * Opens the sorting dialog of the table.
1884
+ *
1885
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1590
1886
  */
1591
1887
  iOpenColumnSorting(): object;
1592
1888
  /**
1593
1889
  * Opens the filtering dialog of the table.
1890
+ *
1891
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1594
1892
  */
1595
1893
  iOpenFilterDialog(): object;
1596
1894
  }
@@ -1600,6 +1898,8 @@ declare namespace sap {
1600
1898
 
1601
1899
  /**
1602
1900
  * Checks the state of a table action.
1901
+ *
1902
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1603
1903
  */
1604
1904
  iCheckAction(
1605
1905
  /**
@@ -1613,6 +1913,8 @@ declare namespace sap {
1613
1913
  ): object;
1614
1914
  /**
1615
1915
  * Checks a field in the adaptation dialog.
1916
+ *
1917
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1616
1918
  */
1617
1919
  iCheckAdaptationColumn(
1618
1920
  /**
@@ -1626,6 +1928,8 @@ declare namespace sap {
1626
1928
  ): object;
1627
1929
  /**
1628
1930
  * Checks the state of the cells of a table.
1931
+ *
1932
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1629
1933
  */
1630
1934
  iCheckCells(
1631
1935
  /**
@@ -1654,6 +1958,8 @@ declare namespace sap {
1654
1958
  ): object;
1655
1959
  /**
1656
1960
  * Checks the state of the cells of a table.
1961
+ *
1962
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1657
1963
  */
1658
1964
  iCheckCells(
1659
1965
  /**
@@ -1671,18 +1977,26 @@ declare namespace sap {
1671
1977
  ): object;
1672
1978
  /**
1673
1979
  * Checks whether the adaptation button is available for the table.
1980
+ *
1981
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1674
1982
  */
1675
1983
  iCheckColumnAdaptation(): object;
1676
1984
  /**
1677
1985
  * Checks whether the column adaptation dialog is open.
1986
+ *
1987
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1678
1988
  */
1679
1989
  iCheckColumnAdaptationDialog(): object;
1680
1990
  /**
1681
1991
  * Checks whether the filter button is available for the table.
1992
+ *
1993
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1682
1994
  */
1683
1995
  iCheckColumnFiltering(): object;
1684
1996
  /**
1685
1997
  * Checks the state of the columns of the table.
1998
+ *
1999
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1686
2000
  */
1687
2001
  iCheckColumns(
1688
2002
  /**
@@ -1704,10 +2018,14 @@ declare namespace sap {
1704
2018
  ): object;
1705
2019
  /**
1706
2020
  * Checks whether the sort button is available for the table.
2021
+ *
2022
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1707
2023
  */
1708
2024
  iCheckColumnSorting(): object;
1709
2025
  /**
1710
2026
  * Checks the `Create` action of the table.
2027
+ *
2028
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1711
2029
  */
1712
2030
  iCheckCreate(
1713
2031
  /**
@@ -1717,6 +2035,8 @@ declare namespace sap {
1717
2035
  ): object;
1718
2036
  /**
1719
2037
  * Checks the state of the CreationRow button in the table.
2038
+ *
2039
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1720
2040
  */
1721
2041
  iCheckCreationRow(
1722
2042
  /**
@@ -1736,6 +2056,8 @@ declare namespace sap {
1736
2056
  ): object;
1737
2057
  /**
1738
2058
  * Checks the `Delete` action of the table.
2059
+ *
2060
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1739
2061
  */
1740
2062
  iCheckDelete(
1741
2063
  /**
@@ -1745,10 +2067,14 @@ declare namespace sap {
1745
2067
  ): object;
1746
2068
  /**
1747
2069
  * Checks whether the export button is available for the table.
2070
+ *
2071
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1748
2072
  */
1749
2073
  iCheckExport(): object;
1750
2074
  /**
1751
2075
  * Checks a filter field in the filter dialog.
2076
+ *
2077
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1752
2078
  */
1753
2079
  iCheckFilterField(
1754
2080
  /**
@@ -1762,6 +2088,8 @@ declare namespace sap {
1762
2088
  ): object;
1763
2089
  /**
1764
2090
  * Checks the `Fullscreen` action of the table.
2091
+ *
2092
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1765
2093
  */
1766
2094
  iCheckFullScreen(
1767
2095
  /**
@@ -1771,6 +2099,8 @@ declare namespace sap {
1771
2099
  ): object;
1772
2100
  /**
1773
2101
  * Checks an action in the drop-down menu that is currently open.
2102
+ *
2103
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1774
2104
  */
1775
2105
  iCheckMenuAction(
1776
2106
  /**
@@ -1780,6 +2110,8 @@ declare namespace sap {
1780
2110
  ): object;
1781
2111
  /**
1782
2112
  * Checks a messageStrip on a table.
2113
+ *
2114
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1783
2115
  */
1784
2116
  iCheckMessageStrip(
1785
2117
  /**
@@ -1789,10 +2121,14 @@ declare namespace sap {
1789
2121
  ): object;
1790
2122
  /**
1791
2123
  * Checks whether the paste button is available for the table.
2124
+ *
2125
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1792
2126
  */
1793
2127
  iCheckPaste(): object;
1794
2128
  /**
1795
2129
  * Checks the quick filter action of the table.
2130
+ *
2131
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1796
2132
  */
1797
2133
  iCheckQuickFilter(
1798
2134
  /**
@@ -1802,6 +2138,8 @@ declare namespace sap {
1802
2138
  ): object;
1803
2139
  /**
1804
2140
  * Checks the number of items in the quick-filter menu.
2141
+ *
2142
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1805
2143
  */
1806
2144
  iCheckQuickFilterItems(
1807
2145
  /**
@@ -1814,6 +2152,8 @@ declare namespace sap {
1814
2152
  * considered. If `iNumberOfRows` is provided, the number of rows are checked with respect to the provided
1815
2153
  * `mRowValues` (if set) or in total. If `iNumberOfRows` is omitted, it checks for at least one matching
1816
2154
  * row. If `mState` is provided, the row must be in the given state.
2155
+ *
2156
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1817
2157
  */
1818
2158
  iCheckRows(
1819
2159
  /**
@@ -1842,6 +2182,8 @@ declare namespace sap {
1842
2182
  /**
1843
2183
  * Checks the search field in the table toolbar. If the `sSearchText` parameter is `undefined`, the search
1844
2184
  * text is not validated.
2185
+ *
2186
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function that can be used for chaining statements
1845
2187
  */
1846
2188
  iCheckSearchField(
1847
2189
  /**
@@ -1855,6 +2197,8 @@ declare namespace sap {
1855
2197
  ): object;
1856
2198
  /**
1857
2199
  * Checks a field in the sorting dialog.
2200
+ *
2201
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1858
2202
  */
1859
2203
  iCheckSortOrder(
1860
2204
  /**
@@ -1872,6 +2216,8 @@ declare namespace sap {
1872
2216
  ): object;
1873
2217
  /**
1874
2218
  * Checks the state of the table.
2219
+ *
2220
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1875
2221
  */
1876
2222
  iCheckState(
1877
2223
  /**
@@ -1879,6 +2225,12 @@ declare namespace sap {
1879
2225
  */
1880
2226
  mState?: object
1881
2227
  ): object;
2228
+ /**
2229
+ * Checks if the focus is on a table.
2230
+ *
2231
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2232
+ */
2233
+ iSeeFocusOnHeader(): object;
1882
2234
  }
1883
2235
  /**
1884
2236
  * Enum for supported dialog types.
@@ -2106,6 +2458,8 @@ declare namespace sap {
2106
2458
  interface actions {
2107
2459
  /**
2108
2460
  * Collapses or expands the page header.
2461
+ *
2462
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2109
2463
  */
2110
2464
  iCollapseExpandPageHeader(
2111
2465
  /**
@@ -2115,14 +2469,20 @@ declare namespace sap {
2115
2469
  ): object;
2116
2470
  /**
2117
2471
  * Returns a {@link sap.fe.test.api.FilterBarActions} instance.
2472
+ *
2473
+ * @returns The available filter bar actions
2118
2474
  */
2119
2475
  onFilterBar(): sap.fe.test.api.FilterBarActions;
2120
2476
  /**
2121
2477
  * Returns a {@link sap.fe.test.api.HeaderActionsLR} instance.
2478
+ *
2479
+ * @returns The available header actions
2122
2480
  */
2123
2481
  onHeader(): sap.fe.test.api.HeaderActionsLR;
2124
2482
  /**
2125
2483
  * Returns a {@link sap.fe.test.api.TableActions} instance for the specified table.
2484
+ *
2485
+ * @returns The available table actions
2126
2486
  */
2127
2487
  onTable(
2128
2488
  /**
@@ -2139,14 +2499,20 @@ declare namespace sap {
2139
2499
  interface assertions {
2140
2500
  /**
2141
2501
  * Returns a {@link sap.fe.test.api.FilterBarAssertions} instance.
2502
+ *
2503
+ * @returns The available filter bar assertions
2142
2504
  */
2143
2505
  onFilterBar(): sap.fe.test.api.FilterBarAssertions;
2144
2506
  /**
2145
2507
  * Returns a {@link sap.fe.test.api.HeaderAssertionsLR} instance.
2508
+ *
2509
+ * @returns The available header assertions
2146
2510
  */
2147
2511
  onHeader(): sap.fe.test.api.HeaderAssertionsLR;
2148
2512
  /**
2149
2513
  * Returns a {@link sap.fe.test.api.TableAssertions} instance for the specified table.
2514
+ *
2515
+ * @returns The available table assertions
2150
2516
  */
2151
2517
  onTable(
2152
2518
  /**
@@ -2165,6 +2531,8 @@ declare namespace sap {
2165
2531
  interface actions {
2166
2532
  /**
2167
2533
  * Collapses or expands the page header.
2534
+ *
2535
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2168
2536
  */
2169
2537
  iCollapseExpandPageHeader(
2170
2538
  /**
@@ -2174,6 +2542,8 @@ declare namespace sap {
2174
2542
  ): object;
2175
2543
  /**
2176
2544
  * Navigates to or focuses on the defined section.
2545
+ *
2546
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2177
2547
  */
2178
2548
  iGoToSection(
2179
2549
  /**
@@ -2198,10 +2568,14 @@ declare namespace sap {
2198
2568
  ): object;
2199
2569
  /**
2200
2570
  * Returns a {@link sap.fe.test.api.FooterActionsOP} instance.
2571
+ *
2572
+ * @returns The available footer actions
2201
2573
  */
2202
2574
  onFooter(): sap.fe.test.api.FooterActionsOP;
2203
2575
  /**
2204
2576
  * Returns a {@link sap.fe.test.api.FormActions} instance.
2577
+ *
2578
+ * @returns The available form actions
2205
2579
  */
2206
2580
  onForm(
2207
2581
  /**
@@ -2211,10 +2585,14 @@ declare namespace sap {
2211
2585
  ): sap.fe.test.api.FormActions;
2212
2586
  /**
2213
2587
  * Returns a {@link sap.fe.test.api.HeaderActions} instance.
2588
+ *
2589
+ * @returns The available header actions
2214
2590
  */
2215
2591
  onHeader(): sap.fe.test.api.HeaderActions;
2216
2592
  /**
2217
2593
  * Returns a {@link sap.fe.test.api.TableActions} instance for the specified table.
2594
+ *
2595
+ * @returns The available table actions
2218
2596
  */
2219
2597
  onTable(
2220
2598
  /**
@@ -2231,10 +2609,14 @@ declare namespace sap {
2231
2609
  interface assertions {
2232
2610
  /**
2233
2611
  * Returns a {@link sap.fe.test.api.FooterAssertionsOP} instance.
2612
+ *
2613
+ * @returns The available footer assertions
2234
2614
  */
2235
2615
  onFooter(): sap.fe.test.api.FooterAssertionsOP;
2236
2616
  /**
2237
2617
  * Returns a {@link sap.fe.test.api.FormAssertions} instance.
2618
+ *
2619
+ * @returns The available form actions
2238
2620
  */
2239
2621
  onForm(
2240
2622
  /**
@@ -2244,10 +2626,14 @@ declare namespace sap {
2244
2626
  ): sap.fe.test.api.FormAssertions;
2245
2627
  /**
2246
2628
  * Returns a {@link sap.fe.test.api.HeaderAssertions} instance.
2629
+ *
2630
+ * @returns The available header assertions
2247
2631
  */
2248
2632
  onHeader(): sap.fe.test.api.HeaderAssertions;
2249
2633
  /**
2250
2634
  * Returns a {@link sap.fe.test.api.TableAssertions} instance for the specified table.
2635
+ *
2636
+ * @returns The available table assertions
2251
2637
  */
2252
2638
  onTable(
2253
2639
  /**
@@ -2266,18 +2652,26 @@ declare namespace sap {
2266
2652
  interface actions {
2267
2653
  /**
2268
2654
  * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.Action })`.
2655
+ *
2656
+ * @returns The available dialog actions
2269
2657
  */
2270
2658
  onActionDialog(): sap.fe.test.api.DialogActions;
2271
2659
  /**
2272
2660
  * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.Confirmation })`.
2661
+ *
2662
+ * @returns The available dialog actions
2273
2663
  */
2274
2664
  onConfirmationDialog(): sap.fe.test.api.DialogActions;
2275
2665
  /**
2276
2666
  * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.Create })`.
2667
+ *
2668
+ * @returns The available dialog actions
2277
2669
  */
2278
2670
  onCreateDialog(): sap.fe.test.api.DialogCreateActions;
2279
2671
  /**
2280
2672
  * Returns a {@link sap.fe.test.api.DialogActions} instance.
2673
+ *
2674
+ * @returns The available dialog actions
2281
2675
  */
2282
2676
  onDialog(
2283
2677
  /**
@@ -2287,14 +2681,20 @@ declare namespace sap {
2287
2681
  ): sap.fe.test.api.DialogActions;
2288
2682
  /**
2289
2683
  * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.Error })`.
2684
+ *
2685
+ * @returns The available dialog actions
2290
2686
  */
2291
2687
  onErrorDialog(): sap.fe.test.api.DialogActions;
2292
2688
  /**
2293
2689
  * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.Message })`.
2690
+ *
2691
+ * @returns The available dialog actions
2294
2692
  */
2295
2693
  onMessageDialog(): sap.fe.test.api.DialogMessageActions;
2296
2694
  /**
2297
2695
  * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.ValueHelp })`.
2696
+ *
2697
+ * @returns The available dialog actions
2298
2698
  */
2299
2699
  onValueHelpDialog(): sap.fe.test.api.DialogValueHelpActions;
2300
2700
  }
@@ -2306,22 +2706,32 @@ declare namespace sap {
2306
2706
  interface assertions {
2307
2707
  /**
2308
2708
  * Confirms the visibility of the current page.
2709
+ *
2710
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2309
2711
  */
2310
2712
  iSeeThisPage(): object;
2311
2713
  /**
2312
2714
  * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.Action })`.
2715
+ *
2716
+ * @returns The available dialog assertions
2313
2717
  */
2314
2718
  onActionDialog(): sap.fe.test.api.DialogAssertions;
2315
2719
  /**
2316
2720
  * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.Confirmation })`.
2721
+ *
2722
+ * @returns The available dialog assertions
2317
2723
  */
2318
2724
  onConfirmationDialog(): sap.fe.test.api.DialogAssertions;
2319
2725
  /**
2320
2726
  * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.Create })`.
2727
+ *
2728
+ * @returns The available dialog assertions
2321
2729
  */
2322
2730
  onCreateDialog(): sap.fe.test.api.DialogCreateAssertions;
2323
2731
  /**
2324
2732
  * Returns a {@link sap.fe.test.api.DialogAssertions} instance.
2733
+ *
2734
+ * @returns The available dialog actions
2325
2735
  */
2326
2736
  onDialog(
2327
2737
  /**
@@ -2331,220 +2741,26 @@ declare namespace sap {
2331
2741
  ): sap.fe.test.api.DialogAssertions;
2332
2742
  /**
2333
2743
  * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.Error })`.
2744
+ *
2745
+ * @returns The available dialog assertions
2334
2746
  */
2335
2747
  onErrorDialog(): sap.fe.test.api.DialogAssertions;
2336
2748
  /**
2337
2749
  * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.Message })`.
2750
+ *
2751
+ * @returns The available dialog assertions
2338
2752
  */
2339
2753
  onMessageDialog(): sap.fe.test.api.DialogMessageAssertions;
2340
2754
  /**
2341
2755
  * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.ValueHelp })`.
2756
+ *
2757
+ * @returns The available dialog assertions
2342
2758
  */
2343
2759
  onValueHelpDialog(): sap.fe.test.api.DialogValueHelpAssertions;
2344
2760
  }
2345
2761
  const assertions: assertions;
2346
2762
  }
2347
2763
 
2348
- /**
2349
- * All common actions (`When`) for all Opa tests are defined here.
2350
- */
2351
- class BaseActions extends sap.ui.test.Opa5 {
2352
- /**
2353
- * Constructs a new {@link sap.fe.test.Opa5} instance.
2354
- */
2355
- constructor();
2356
-
2357
- /**
2358
- * Creates a new subclass of class sap.fe.test.BaseActions with name `sClassName` and enriches it with the
2359
- * information contained in `oClassInfo`.
2360
- *
2361
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.test.Opa5.extend}.
2362
- */
2363
- static extend<T extends Record<string, unknown>>(
2364
- /**
2365
- * Name of the class being created
2366
- */
2367
- sClassName: string,
2368
- /**
2369
- * Object literal with information about the class
2370
- */
2371
- oClassInfo?: sap.ClassInfo<T, sap.fe.test.BaseActions>,
2372
- /**
2373
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2374
- * used by this class
2375
- */
2376
- FNMetaImpl?: Function
2377
- ): Function;
2378
- /**
2379
- * Returns a metadata object for class sap.fe.test.BaseActions.
2380
- */
2381
- static getMetadata(): sap.ui.base.Metadata;
2382
- /**
2383
- * Closes the open popover via function.
2384
- *
2385
- * NOTE: This function ensures that a certain UI state is maintained in some exceptional cases. This function
2386
- * isn't usually called directly in a journey.
2387
- */
2388
- iClosePopover(): object;
2389
- /**
2390
- * Simulates the pressing of the Esc key for the element in focus.
2391
- */
2392
- iPressEscape(): object;
2393
- }
2394
- /**
2395
- * All common arrangements (`Given`) for all Opa tests are defined here.
2396
- */
2397
- class BaseArrangements extends sap.ui.test.Opa5 {
2398
- /**
2399
- * Constructs a new {@link sap.fe.test.Opa5} instance.
2400
- */
2401
- constructor(
2402
- /**
2403
- * The settings object required for launching the application
2404
- */
2405
- mSettings: {
2406
- /**
2407
- * The URL to the launching page (usually a FLP.html)
2408
- */
2409
- launchUrl: string;
2410
- /**
2411
- * The URL launch parameters
2412
- */
2413
- launchParameters: object;
2414
- }
2415
- );
2416
-
2417
- /**
2418
- * Creates a new subclass of class sap.fe.test.BaseArrangements with name `sClassName` and enriches it with
2419
- * the information contained in `oClassInfo`.
2420
- *
2421
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.test.Opa5.extend}.
2422
- */
2423
- static extend<T extends Record<string, unknown>>(
2424
- /**
2425
- * Name of the class being created
2426
- */
2427
- sClassName: string,
2428
- /**
2429
- * Object literal with information about the class
2430
- */
2431
- oClassInfo?: sap.ClassInfo<T, sap.fe.test.BaseArrangements>,
2432
- /**
2433
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2434
- * used by this class
2435
- */
2436
- FNMetaImpl?: Function
2437
- ): Function;
2438
- /**
2439
- * Returns a metadata object for class sap.fe.test.BaseArrangements.
2440
- */
2441
- static getMetadata(): sap.ui.base.Metadata;
2442
- /**
2443
- * Resets the mock data.
2444
- */
2445
- iResetMockData(
2446
- /**
2447
- * The application id or a uri pointing to the service. One of the following properties needs to be provided
2448
- * within the parameter:
2449
- * ```javascript
2450
- *
2451
- * {
2452
- * :
2453
- * :
2454
- * }
2455
- * ```
2456
- * NOTE: When passing the AppId, the application needs to be running already. Calling the function
2457
- * before the application is started can be done by passing the ServiceUri.
2458
- */
2459
- oAppInfo?: object
2460
- ): object;
2461
- /**
2462
- * Resets the test data.
2463
- */
2464
- iResetTestData(): object;
2465
- /**
2466
- * Simulates a refresh of the page by tearing it down and then restarting it with the very same hash.
2467
- */
2468
- iRestartMyApp(): object;
2469
- /**
2470
- * Starts the app in an IFrame, using the `launchUrl` and `launchParameters` provided via the settings object
2471
- * of the {@link sap.fe.test.BaseArrangements#constructor}.
2472
- */
2473
- iStartMyApp(
2474
- /**
2475
- * The app hash
2476
- */
2477
- sAppHash?: string,
2478
- /**
2479
- * A map with additional URL parameters
2480
- */
2481
- mUrlParameters?: object
2482
- ): object;
2483
- /**
2484
- * Tears down the current application.
2485
- */
2486
- iTearDownMyApp(): object;
2487
- /**
2488
- * Clears the browser's local storage and session storage.
2489
- *
2490
- * NOTE: The function itself is not meant to be called directly within a journey. Instead, it can be overwritten
2491
- * to add custom clean-up functionality when calling {@link sap.fe.test.BaseArrangements#iResetTestData}.
2492
- */
2493
- resetTestData(): object;
2494
- }
2495
- /**
2496
- * All common assertions (`Then`) for all Opa tests are defined here.
2497
- */
2498
- class BaseAssertions extends sap.ui.test.Opa5 {
2499
- /**
2500
- * Constructs a new {@link sap.fe.test.Opa5} instance.
2501
- */
2502
- constructor();
2503
-
2504
- /**
2505
- * Creates a new subclass of class sap.fe.test.BaseAssertions with name `sClassName` and enriches it with
2506
- * the information contained in `oClassInfo`.
2507
- *
2508
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.test.Opa5.extend}.
2509
- */
2510
- static extend<T extends Record<string, unknown>>(
2511
- /**
2512
- * Name of the class being created
2513
- */
2514
- sClassName: string,
2515
- /**
2516
- * Object literal with information about the class
2517
- */
2518
- oClassInfo?: sap.ClassInfo<T, sap.fe.test.BaseAssertions>,
2519
- /**
2520
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2521
- * used by this class
2522
- */
2523
- FNMetaImpl?: Function
2524
- ): Function;
2525
- /**
2526
- * Returns a metadata object for class sap.fe.test.BaseAssertions.
2527
- */
2528
- static getMetadata(): sap.ui.base.Metadata;
2529
- /**
2530
- * Checks whether a {@link sap.m.MessagePage} with given message is shown.
2531
- */
2532
- iSeeMessagePage(
2533
- /**
2534
- * The message shown on the message page
2535
- */
2536
- sMessage: string
2537
- ): object;
2538
- /**
2539
- * Checks whether a {@link sap.m.MessageToast} with the given text is shown.
2540
- */
2541
- iSeeMessageToast(
2542
- /**
2543
- * The text shown in the MessageToast
2544
- */
2545
- sText: string
2546
- ): object;
2547
- }
2548
2764
  /**
2549
2765
  * A JourneyRunner for executing integration tests with given settings.
2550
2766
  */
@@ -2585,6 +2801,8 @@ declare namespace sap {
2585
2801
  * the information contained in `oClassInfo`.
2586
2802
  *
2587
2803
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
2804
+ *
2805
+ * @returns Created class / constructor function
2588
2806
  */
2589
2807
  static extend<T extends Record<string, unknown>>(
2590
2808
  /**
@@ -2603,10 +2821,14 @@ declare namespace sap {
2603
2821
  ): Function;
2604
2822
  /**
2605
2823
  * Gets the global journey runner instance.
2824
+ *
2825
+ * @returns The global default {@link sap.fe.test.JourneyRunner} instance
2606
2826
  */
2607
2827
  static getDefaultRunner(): object;
2608
2828
  /**
2609
2829
  * Returns a metadata object for class sap.fe.test.JourneyRunner.
2830
+ *
2831
+ * @returns Metadata object describing this class
2610
2832
  */
2611
2833
  static getMetadata(): sap.ui.base.Metadata;
2612
2834
  /**
@@ -2633,6 +2855,8 @@ declare namespace sap {
2633
2855
  * by a custom JourneyRunner implementation to provide custom base actions.
2634
2856
  *
2635
2857
  * By default, an instance of {@link sap.fe.test.BaseActions} will be returned.
2858
+ *
2859
+ * @returns An Opa instance for the base actions
2636
2860
  */
2637
2861
  getBaseActions(
2638
2862
  /**
@@ -2648,6 +2872,8 @@ declare namespace sap {
2648
2872
  * overridden by a custom JourneyRunner implementation to provide custom base assertions.
2649
2873
  *
2650
2874
  * By default, an instance of {@link sap.fe.test.BaseArrangements} will be returned.
2875
+ *
2876
+ * @returns An Opa instance for the base arrangements
2651
2877
  */
2652
2878
  getBaseArrangements(
2653
2879
  /**
@@ -2663,6 +2889,8 @@ declare namespace sap {
2663
2889
  * overridden by a custom JourneyRunner implementation to provide custom base assertions.
2664
2890
  *
2665
2891
  * By default, an instance of {@link sap.fe.test.BaseAssertions} will be returned.
2892
+ *
2893
+ * @returns An Opa instance for the base assertions
2666
2894
  */
2667
2895
  getBaseAssertions(
2668
2896
  /**
@@ -2674,6 +2902,8 @@ declare namespace sap {
2674
2902
  * Executes the journeys in the given order.
2675
2903
  *
2676
2904
  * The settings provided as first parameter are merged into the base settings of the JourneyRunner instance.
2905
+ *
2906
+ * @returns A `Promise` that is resolved after all tests have been executed
2677
2907
  */
2678
2908
  run(
2679
2909
  /**
@@ -2714,6 +2944,8 @@ declare namespace sap {
2714
2944
  * Executes the journeys in the given order.
2715
2945
  *
2716
2946
  * The settings provided as first parameter are merged into the base settings of the JourneyRunner instance.
2947
+ *
2948
+ * @returns A `Promise` that is resolved after all tests have been executed
2717
2949
  */
2718
2950
  run(
2719
2951
  /**
@@ -2764,7 +2996,7 @@ declare namespace sap {
2764
2996
  /**
2765
2997
  * Additional custom page functions, provided in an object containing `actions` and `assertions`
2766
2998
  */
2767
- ...aAdditionalPageDefinitions: object[]
2999
+ ...aInAdditionalPageDefinitions: object[]
2768
3000
  );
2769
3001
  }
2770
3002
  /**
@@ -2824,16 +3056,49 @@ declare namespace sap {
2824
3056
  ...aAdditionalPageDefinitions: object[]
2825
3057
  );
2826
3058
 
3059
+ /**
3060
+ * Check an intent-based navigation. The function checks the semantic object and the action within the URL
3061
+ * of an application. Optionally, further URL parameters can be checked.
3062
+ *
3063
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
3064
+ */
3065
+ iCheckIntentBasedNavigation(
3066
+ /**
3067
+ * The semantic object of the application
3068
+ */
3069
+ sSemanticObject: string,
3070
+ /**
3071
+ * The action of the application
3072
+ */
3073
+ sAction: string,
3074
+ /**
3075
+ * More URL parameters to be checked. The pattern is:
3076
+ * ```javascript
3077
+ *
3078
+ * [{
3079
+ * property: <expected name of URL parameter>,
3080
+ * value: <expected value of URL parameter>
3081
+ * }]
3082
+ * ```
3083
+ */
3084
+ aURLParams?: any[]
3085
+ ): object;
2827
3086
  /**
2828
3087
  * Navigates back via shell back button.
3088
+ *
3089
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2829
3090
  */
2830
3091
  iNavigateBack(): object;
2831
3092
  /**
2832
- * Navigates to the launch pad via home button.
3093
+ * Navigates to the launch pad via the home button.
3094
+ *
3095
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2833
3096
  */
2834
3097
  iNavigateHome(): object;
2835
3098
  /**
2836
3099
  * Navigates via a navigation item in the shell's navigation menu.
3100
+ *
3101
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2837
3102
  */
2838
3103
  iNavigateViaMenu(
2839
3104
  /**
@@ -2843,10 +3108,14 @@ declare namespace sap {
2843
3108
  ): object;
2844
3109
  /**
2845
3110
  * Opens the navigation menu in the shell header.
3111
+ *
3112
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2846
3113
  */
2847
3114
  iOpenNavigationMenu(): object;
2848
3115
  /**
2849
3116
  * Selecting a tile in the launchpad by its target app, for example `iPressTile("SalesOrder-manage")`.
3117
+ *
3118
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2850
3119
  */
2851
3120
  iPressTile(
2852
3121
  /**
@@ -2923,12 +3192,6 @@ declare namespace sap {
2923
3192
 
2924
3193
  "sap/fe/test/api/TableAssertions": undefined;
2925
3194
 
2926
- "sap/fe/test/BaseActions": undefined;
2927
-
2928
- "sap/fe/test/BaseArrangements": undefined;
2929
-
2930
- "sap/fe/test/BaseAssertions": undefined;
2931
-
2932
3195
  "sap/fe/test/JourneyRunner": undefined;
2933
3196
 
2934
3197
  "sap/fe/test/library": undefined;