@sapui5/types 1.113.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 (66) hide show
  1. package/LICENSE.txt +35 -0
  2. package/README.md +35 -0
  3. package/package.json +23 -0
  4. package/types/index.d.ts +67 -0
  5. package/types/sap.apf.d.ts +1026 -0
  6. package/types/sap.ca.ui.d.ts +14005 -0
  7. package/types/sap.chart.d.ts +4815 -0
  8. package/types/sap.collaboration.d.ts +2704 -0
  9. package/types/sap.esh.search.ui.d.ts +1595 -0
  10. package/types/sap.f.d.ts +20085 -0
  11. package/types/sap.fe.core.d.ts +1508 -0
  12. package/types/sap.fe.macros.d.ts +975 -0
  13. package/types/sap.fe.navigation.d.ts +917 -0
  14. package/types/sap.fe.templates.d.ts +522 -0
  15. package/types/sap.fe.test.d.ts +3533 -0
  16. package/types/sap.feedback.ui.d.ts +3 -0
  17. package/types/sap.gantt.d.ts +51684 -0
  18. package/types/sap.insights.d.ts +23 -0
  19. package/types/sap.landvisz.d.ts +7952 -0
  20. package/types/sap.m.d.ts +147796 -0
  21. package/types/sap.makit.d.ts +4533 -0
  22. package/types/sap.me.d.ts +3665 -0
  23. package/types/sap.ndc.d.ts +774 -0
  24. package/types/sap.ovp.d.ts +176 -0
  25. package/types/sap.rules.ui.d.ts +1471 -0
  26. package/types/sap.sac.df.d.ts +2292 -0
  27. package/types/sap.sac.grid.d.ts +774 -0
  28. package/types/sap.suite.ui.commons.d.ts +46971 -0
  29. package/types/sap.suite.ui.generic.template.d.ts +3431 -0
  30. package/types/sap.suite.ui.microchart.d.ts +12652 -0
  31. package/types/sap.tnt.d.ts +2227 -0
  32. package/types/sap.ui.codeeditor.d.ts +693 -0
  33. package/types/sap.ui.commons.d.ts +30235 -0
  34. package/types/sap.ui.comp.d.ts +37411 -0
  35. package/types/sap.ui.core.d.ts +78872 -0
  36. package/types/sap.ui.dt.d.ts +3 -0
  37. package/types/sap.ui.export.d.ts +843 -0
  38. package/types/sap.ui.fl.d.ts +1663 -0
  39. package/types/sap.ui.generic.app.d.ts +2683 -0
  40. package/types/sap.ui.generic.template.d.ts +3 -0
  41. package/types/sap.ui.integration.d.ts +4032 -0
  42. package/types/sap.ui.layout.d.ts +14472 -0
  43. package/types/sap.ui.mdc.d.ts +476 -0
  44. package/types/sap.ui.richtexteditor.d.ts +1666 -0
  45. package/types/sap.ui.rta.d.ts +124 -0
  46. package/types/sap.ui.suite.d.ts +685 -0
  47. package/types/sap.ui.support.d.ts +453 -0
  48. package/types/sap.ui.table.d.ts +9325 -0
  49. package/types/sap.ui.testrecorder.d.ts +9 -0
  50. package/types/sap.ui.unified.d.ts +20640 -0
  51. package/types/sap.ui.ux3.d.ts +18288 -0
  52. package/types/sap.ui.vbm.d.ts +17251 -0
  53. package/types/sap.ui.vk.d.ts +42381 -0
  54. package/types/sap.ui.vtm.d.ts +10547 -0
  55. package/types/sap.ui.webc.common.d.ts +113 -0
  56. package/types/sap.ui.webc.fiori.d.ts +13850 -0
  57. package/types/sap.ui.webc.main.d.ts +40833 -0
  58. package/types/sap.uiext.inbox.d.ts +4079 -0
  59. package/types/sap.ushell.d.ts +10255 -0
  60. package/types/sap.ushell_abap.d.ts +9 -0
  61. package/types/sap.uxap.d.ts +7636 -0
  62. package/types/sap.viz.d.ts +51209 -0
  63. package/types/sap.webanalytics.core.d.ts +3 -0
  64. package/types/sap.zen.commons.d.ts +1542 -0
  65. package/types/sap.zen.crosstab.d.ts +1159 -0
  66. package/types/sap.zen.dsh.d.ts +2132 -0
@@ -0,0 +1,3533 @@
1
+ // For Library Version: 1.113.0
2
+
3
+ declare module "sap/fe/test/library" {}
4
+
5
+ declare module "sap/fe/test/api/BaseAPI" {
6
+ import DialogType from "sap/fe/test/api/DialogType";
7
+
8
+ /**
9
+ * An action parameter dialog field identifier
10
+ */
11
+ export type ActionDialogFieldIdentifier = {
12
+ /**
13
+ * The name of the field
14
+ */
15
+ property: string;
16
+ };
17
+
18
+ /**
19
+ * An action identifier
20
+ */
21
+ export type ActionIdentifier = {
22
+ /**
23
+ * The name of the service
24
+ */
25
+ service: string;
26
+ /**
27
+ * The name of the action
28
+ */
29
+ action: string;
30
+ /**
31
+ * Defines whether the action is a bound action (default: false)
32
+ */
33
+ unbound?: boolean;
34
+ };
35
+
36
+ /**
37
+ * An dialog field identifier
38
+ */
39
+ export type DialogFieldIdentifier = {
40
+ /**
41
+ * The name of the field In case of an action parameter dialog, this is the fieldname only
42
+ * ```javascript
43
+ *
44
+ * {
45
+ * property:
46
+ * }
47
+ * ```
48
+ * In case of a create dialog, the concatenation of the entity and fieldname has to be provided
49
+ *
50
+ * ```javascript
51
+ *
52
+ * {
53
+ * property: ::
54
+ * }
55
+ * ```
56
+ */
57
+ property: string;
58
+ };
59
+
60
+ /**
61
+ * A dialog identifier
62
+ */
63
+ export type DialogIdentifier = {
64
+ /**
65
+ * The type of the dialog
66
+ */
67
+ type: DialogType;
68
+ };
69
+
70
+ /**
71
+ * A field identifier
72
+ */
73
+ export type FieldIdentifier = {
74
+ /**
75
+ * The name of the field group containing the field
76
+ */
77
+ fieldGroup?: string;
78
+ /**
79
+ * The name of the field
80
+ */
81
+ property: string;
82
+ /**
83
+ * The name of the connected field containing the field
84
+ */
85
+ connectedFields?: string;
86
+ };
87
+
88
+ /**
89
+ * A section identifier
90
+ */
91
+ export type SectionIdentifier = {
92
+ /**
93
+ * The name of the section facet
94
+ */
95
+ section: string;
96
+ /**
97
+ * The name of the sub-section facet
98
+ */
99
+ subSection?: string;
100
+ };
101
+
102
+ /**
103
+ * A table identifier
104
+ */
105
+ export type TableIdentifier = {
106
+ /**
107
+ * The name of the navigation property used for the table
108
+ */
109
+ property: string;
110
+ /**
111
+ * The name of a qualifier for the table
112
+ */
113
+ qualifier?: string;
114
+ };
115
+
116
+ /**
117
+ * A view identifier
118
+ */
119
+ export type ViewIdentifier = {
120
+ /**
121
+ * The name of the view as defined in the manifest file
122
+ */
123
+ key: string;
124
+ };
125
+ }
126
+
127
+ declare module "sap/fe/test/api/TableAPI" {
128
+ /**
129
+ * A column identifier
130
+ */
131
+ export type ColumnIdentifier = {
132
+ /**
133
+ * The technical name of the column
134
+ */
135
+ name: string;
136
+ };
137
+
138
+ export default class TableAPI {
139
+ constructor();
140
+
141
+ /**
142
+ * Confirms and closes the adaptation dialog of the table.
143
+ *
144
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
145
+ */
146
+ iConfirmColumnAdaptation(): object;
147
+ /**
148
+ * Confirms and closes the sorting dialog of the table.
149
+ *
150
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
151
+ */
152
+ iConfirmColumnSorting(): object;
153
+ /**
154
+ * Confirms and closes the filtering dialog of the table.
155
+ *
156
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
157
+ */
158
+ iConfirmFilterDialog(): object;
159
+ /**
160
+ * Opens the column adaptation dialog of the table.
161
+ *
162
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
163
+ */
164
+ iOpenColumnAdaptation(): object;
165
+ /**
166
+ * Opens the sorting dialog of the table.
167
+ *
168
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
169
+ */
170
+ iOpenColumnSorting(): object;
171
+ /**
172
+ * Opens the filtering dialog of the table.
173
+ *
174
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
175
+ */
176
+ iOpenFilterDialog(): object;
177
+ }
178
+ }
179
+
180
+ declare module "sap/fe/test/api/DialogActions" {
181
+ import { DialogFieldIdentifier } from "sap/fe/test/api/BaseAPI";
182
+
183
+ export default class DialogActions {
184
+ constructor();
185
+
186
+ /**
187
+ * Cancels the dialog by clicking the corresponding button (for example, 'Cancel').
188
+ *
189
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
190
+ */
191
+ iCancel(): object;
192
+ /**
193
+ * Changes the content of a field in a dialog.
194
+ *
195
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
196
+ */
197
+ iChangeDialogField(
198
+ /**
199
+ * The identifier of the field
200
+ */
201
+ vFieldIdentifier: DialogFieldIdentifier,
202
+ /**
203
+ * The new target value.
204
+ */
205
+ vValue?: string,
206
+ /**
207
+ * Set to `true` to clear previously set filters, otherwise all previously set values will be kept
208
+ */
209
+ bClearFirst?: boolean
210
+ ): object;
211
+ /**
212
+ * Closes the dialog by pressing the 'Escape' key.
213
+ *
214
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
215
+ */
216
+ iClose(): object;
217
+ /**
218
+ * Confirms the dialog by clicking the corresponding button (for example, 'OK').
219
+ *
220
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
221
+ */
222
+ iConfirm(): object;
223
+ }
224
+ }
225
+
226
+ declare module "sap/fe/test/api/DialogAssertions" {
227
+ import {
228
+ ActionDialogFieldIdentifier,
229
+ DialogFieldIdentifier,
230
+ } from "sap/fe/test/api/BaseAPI";
231
+
232
+ export default class DialogAssertions {
233
+ constructor();
234
+
235
+ /**
236
+ * Checks the content and state of a field in an action parameter dialog.
237
+ *
238
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
239
+ */
240
+ iCheckActionParameterDialogField(
241
+ /**
242
+ * The identifier of the field
243
+ */
244
+ vFieldIdentifier: ActionDialogFieldIdentifier,
245
+ /**
246
+ * Expected value(s) of the field. if passed as an object, the following pattern will be considered:
247
+ * ```javascript
248
+ *
249
+ * {
250
+ * value: , // optional
251
+ * }
252
+ * ```
253
+ */
254
+ vValue?: string | any[] | object,
255
+ /**
256
+ * Defines the expected state of the field
257
+ */
258
+ mState?: object
259
+ ): object;
260
+ /**
261
+ * Checks the cancellation button of the dialog.
262
+ *
263
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
264
+ */
265
+ iCheckCancel(
266
+ /**
267
+ * Defines the expected state of the button
268
+ */
269
+ mButtonState?: object
270
+ ): object;
271
+ /**
272
+ * Checks the confirmation button of the dialog.
273
+ *
274
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
275
+ */
276
+ iCheckConfirm(
277
+ /**
278
+ * Defines the expected state of the button
279
+ */
280
+ mButtonState?: object
281
+ ): object;
282
+ /**
283
+ * Checks the content and state of a field in a dialog.
284
+ *
285
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
286
+ */
287
+ iCheckDialogField(
288
+ /**
289
+ * The identifier of the field
290
+ */
291
+ vFieldIdentifier: DialogFieldIdentifier,
292
+ /**
293
+ * Expected value(s) of the field. if passed as an object, the following pattern will be considered:
294
+ * ```javascript
295
+ *
296
+ * {
297
+ * value: , // optional
298
+ * }
299
+ * ```
300
+ */
301
+ vValue?: string | any[] | object,
302
+ /**
303
+ * Defines the expected state of the field
304
+ */
305
+ mState?: object
306
+ ): object;
307
+ /**
308
+ * Checks the dialog.
309
+ *
310
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
311
+ */
312
+ iCheckState(
313
+ /**
314
+ * Defines the expected state of the dialog
315
+ */
316
+ mDialogState?: object
317
+ ): object;
318
+ }
319
+ }
320
+
321
+ declare module "sap/fe/test/api/DialogCreateActions" {
322
+ import DialogActions from "sap/fe/test/api/DialogActions";
323
+
324
+ export default class DialogCreateActions extends DialogActions {
325
+ constructor();
326
+
327
+ /**
328
+ * Executes the `Create` action on the create dialog.
329
+ *
330
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
331
+ */
332
+ iExecuteCreate(): object;
333
+ }
334
+ }
335
+
336
+ declare module "sap/fe/test/api/DialogCreateAssertions" {
337
+ import DialogAssertions from "sap/fe/test/api/DialogAssertions";
338
+
339
+ export default class DialogCreateAssertions extends DialogAssertions {
340
+ constructor();
341
+
342
+ /**
343
+ * Checks the `Create` action on the dialog.
344
+ *
345
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
346
+ */
347
+ iCheckCreate(
348
+ /**
349
+ * Defines the expected state of the button
350
+ */
351
+ mState?: object
352
+ ): object;
353
+ }
354
+ }
355
+
356
+ declare module "sap/fe/test/api/DialogMessageActions" {
357
+ import DialogActions from "sap/fe/test/api/DialogActions";
358
+
359
+ export default class DialogMessageActions extends DialogActions {
360
+ constructor();
361
+
362
+ /**
363
+ * Executes the `Back` action on the message dialog.
364
+ *
365
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
366
+ */
367
+ iExecuteBack(): object;
368
+ /**
369
+ * Executes the `Refresh` action on the message dialog.
370
+ *
371
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
372
+ */
373
+ iExecuteRefresh(): object;
374
+ /**
375
+ * Selects the specified entry in the draft data loss popup.
376
+ *
377
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
378
+ */
379
+ iSelectDraftDataLossOption(optionKey: any): object;
380
+ }
381
+ }
382
+
383
+ declare module "sap/fe/test/api/DialogMessageAssertions" {
384
+ import DialogAssertions from "sap/fe/test/api/DialogAssertions";
385
+
386
+ export default class DialogMessageAssertions extends DialogAssertions {
387
+ constructor();
388
+
389
+ /**
390
+ * Checks the `Back` action on the message dialog.
391
+ *
392
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
393
+ */
394
+ iCheckBack(
395
+ /**
396
+ * Defines the expected state of the button
397
+ */
398
+ mState?: object
399
+ ): object;
400
+ /**
401
+ * Checks whether a certain message is shown in the dialog.
402
+ *
403
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
404
+ */
405
+ iCheckMessage(
406
+ /**
407
+ * Defines the expected state of the message, e.g. `{ title: "My message" }`
408
+ */
409
+ oMessage?: object
410
+ ): object;
411
+ /**
412
+ * Checks the `Refresh` action on the dialog.
413
+ *
414
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
415
+ */
416
+ iCheckRefresh(
417
+ /**
418
+ * Defines the expected state of the button
419
+ */
420
+ mState?: object
421
+ ): object;
422
+ }
423
+ }
424
+
425
+ declare module "sap/fe/test/api/DialogType" {
426
+ /**
427
+ * Enum for supported dialog types.
428
+ */
429
+ enum DialogType {
430
+ /**
431
+ * A default dialog for action parameters
432
+ */
433
+ Action = "undefined",
434
+ /**
435
+ * A simple dialog supporting base checks and actions such as 'Confirm' and 'Cancel'
436
+ */
437
+ Confirmation = "undefined",
438
+ /**
439
+ * A dialog used for creating a new object
440
+ */
441
+ Create = "undefined",
442
+ /**
443
+ * A dialog used for showing an error message
444
+ */
445
+ Error = "undefined",
446
+ /**
447
+ * A message dialog for showing back-end messages
448
+ */
449
+ Message = "undefined",
450
+ /**
451
+ * A ValueHelp dialog that has a condition definition panel or a filterable selection table
452
+ */
453
+ ValueHelp = "undefined",
454
+ }
455
+ export default DialogType;
456
+ }
457
+
458
+ declare module "sap/fe/test/api/DialogValueHelpActions" {
459
+ import DialogActions from "sap/fe/test/api/DialogActions";
460
+
461
+ import { FilterFieldIdentifier } from "sap/fe/test/api/FilterBarAPI";
462
+
463
+ export default class DialogValueHelpActions extends DialogActions {
464
+ constructor();
465
+
466
+ /**
467
+ * Adds a new condition.
468
+ *
469
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
470
+ */
471
+ iAddCondition(
472
+ /**
473
+ * The condition operator, like EQ, BT, LT, GT (see also {@link sap.ui.model.filter.FilterOperator})
474
+ */
475
+ sOperator: string,
476
+ /**
477
+ * The values to be set. If the operator requires more than one value, like BT (between), an array with
478
+ * the two entries is expected
479
+ */
480
+ vValues: string | string[]
481
+ ): object;
482
+ /**
483
+ * Changes an existing condition.
484
+ *
485
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
486
+ */
487
+ iChangeCondition(
488
+ /**
489
+ * The condition operator, like EQ, BT, LT, GT (see also {@link sap.ui.model.filter.FilterOperator})
490
+ */
491
+ sOperator: string,
492
+ /**
493
+ * The values to be set. If the operator requires more than one value like BT (between) an array with the
494
+ * two entries is expected
495
+ */
496
+ vValues: string | string[],
497
+ /**
498
+ * The index of the condition to be altered. If not set, the index 0 is used
499
+ */
500
+ iConditionIndex?: number
501
+ ): object;
502
+ /**
503
+ * Changes the value of a filter field.
504
+ *
505
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
506
+ */
507
+ iChangeFilterField(
508
+ /**
509
+ * The identifier of the filter field
510
+ */
511
+ vFieldIdentifier: string | FilterFieldIdentifier,
512
+ /**
513
+ * The new target value.
514
+ */
515
+ vValue?: string,
516
+ /**
517
+ * Set to `true` to clear previously set filters, otherwise all previously set values will be kept
518
+ */
519
+ bClearFirst?: boolean
520
+ ): object;
521
+ /**
522
+ * Changes the value of the search field.
523
+ *
524
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
525
+ */
526
+ iChangeSearchField(
527
+ /**
528
+ * The new search value.
529
+ */
530
+ sSearchText?: string
531
+ ): object;
532
+ /**
533
+ * Starts the search.
534
+ *
535
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
536
+ */
537
+ iExecuteSearch(): object;
538
+ /**
539
+ * Clicks the `Hide/Show Filters` button.
540
+ *
541
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
542
+ */
543
+ iExecuteShowHideFilters(): object;
544
+ /**
545
+ * Navigates to the `Define Conditions` tab.
546
+ *
547
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
548
+ */
549
+ iGoToDefineConditions(): object;
550
+ /**
551
+ * Navigates to the `Search and Select` tab.
552
+ *
553
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
554
+ */
555
+ iGoToSearchAndSelect(): object;
556
+ /**
557
+ * Removes an existing condition.
558
+ *
559
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
560
+ */
561
+ iRemoveCondition(
562
+ /**
563
+ * The index of the condition to be removed. If not set, the index 0 is used
564
+ */
565
+ iConditionIndex?: number
566
+ ): object;
567
+ /**
568
+ * Resets the search field value.
569
+ *
570
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
571
+ */
572
+ iResetSearchField(): object;
573
+ /**
574
+ * Selects the specified rows.
575
+ *
576
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
577
+ */
578
+ iSelectRows(
579
+ /**
580
+ * Defines the row values of the target row. The pattern is:
581
+ * ```javascript
582
+ *
583
+ * {
584
+ * <column-name-or-index>: <expected-value>
585
+ * }
586
+ * ```
587
+ * Alternatively, the 0-based row index can be used.
588
+ */
589
+ vRowValues?: object | number,
590
+ /**
591
+ * Defines the expected state of the row
592
+ */
593
+ mState?: object
594
+ ): object;
595
+ }
596
+ }
597
+
598
+ declare module "sap/fe/test/api/DialogValueHelpAssertions" {
599
+ import DialogAssertions from "sap/fe/test/api/DialogAssertions";
600
+
601
+ import { FilterFieldIdentifier } from "sap/fe/test/api/FilterBarAPI";
602
+
603
+ export default class DialogValueHelpAssertions extends DialogAssertions {
604
+ constructor();
605
+
606
+ /**
607
+ * Checks the `Define conditions` tab in a value help dialog. Please be aware that the tab control of the
608
+ * toolbar is checked.
609
+ *
610
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
611
+ */
612
+ iCheckDefineConditions(
613
+ /**
614
+ * Defines the expected state of the filter bar
615
+ */
616
+ mState?: object
617
+ ): object;
618
+ /**
619
+ * Checks the filter bar.
620
+ *
621
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
622
+ */
623
+ iCheckFilterBar(
624
+ /**
625
+ * Defines the expected state of the filter bar
626
+ */
627
+ mState?: object
628
+ ): object;
629
+ /**
630
+ * Checks a filter field. If `vConditionValues` is `undefined`, the current condition values are ignored.
631
+ *
632
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
633
+ */
634
+ iCheckFilterField(
635
+ /**
636
+ * The identifier of the filter field
637
+ */
638
+ vFieldIdentifier: object | FilterFieldIdentifier,
639
+ /**
640
+ * The expected value(s) of the filter field
641
+ */
642
+ vConditionValues?: string | object | any[],
643
+ /**
644
+ * The expected operator
645
+ */
646
+ sOperator?: string,
647
+ /**
648
+ * Defines the expected state of the filter field
649
+ */
650
+ mState?: object
651
+ ): object;
652
+ /**
653
+ * Checks the rows of a table. If `mRowValues` is provided, only rows with the corresponding values are
654
+ * considered. If `iNumberOfRows` is provided, the number of rows are checked with respect to the provided
655
+ * `mRowValues` (if set) or in total. If `iNumberOfRows` is omitted, it checks for at least one matching
656
+ * row. If `mState` is provided, the row must be in the given state.
657
+ *
658
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
659
+ */
660
+ iCheckRows(
661
+ /**
662
+ * Defines the row values of the target row. The pattern is:
663
+ * ```javascript
664
+ *
665
+ * {
666
+ * <column-name-or-index>: <expected-value>
667
+ * }
668
+ * ```
669
+ */
670
+ mRowValues?: object,
671
+ /**
672
+ * The expected number of rows considering `mRowValues` and `mRowState`
673
+ */
674
+ iExpectedNumberOfRows?: number,
675
+ /**
676
+ * Defines the expected state of the target row
677
+ */
678
+ mState?: object
679
+ ): object;
680
+ /**
681
+ * Checks the `Search and Select` tab in a value help dialog. Please be aware that the tab control of the
682
+ * toolbar is checked.
683
+ *
684
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
685
+ */
686
+ iCheckSearchAndSelect(
687
+ /**
688
+ * Defines the expected state of the filter bar
689
+ */
690
+ mState?: object
691
+ ): object;
692
+ /**
693
+ * Checks the search field in the filter bar. If the `sSearchText` parameter is `undefined`, the search
694
+ * text is not validated.
695
+ *
696
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
697
+ */
698
+ iCheckSearchField(
699
+ /**
700
+ * The expected text in the search field
701
+ */
702
+ sSearchText?: string,
703
+ /**
704
+ * Defines the expected state of the search field
705
+ */
706
+ mState?: object
707
+ ): object;
708
+ /**
709
+ * Checks the dialog.
710
+ *
711
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
712
+ */
713
+ iCheckState(
714
+ /**
715
+ * Defines the expected state of the dialog
716
+ */
717
+ mDialogState?: object
718
+ ): object;
719
+ /**
720
+ * Checks the table.
721
+ *
722
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
723
+ */
724
+ iCheckTable(
725
+ /**
726
+ * Defines the expected state of the search field
727
+ */
728
+ mState?: object
729
+ ): object;
730
+ }
731
+ }
732
+
733
+ declare module "sap/fe/test/api/EditState" {
734
+ /**
735
+ * Enum for supported editing states.
736
+ */
737
+ enum EditState {
738
+ /**
739
+ * All
740
+ */
741
+ All = "undefined",
742
+ /**
743
+ * All (Hiding Drafts)
744
+ */
745
+ AllHidingDrafts = "undefined",
746
+ /**
747
+ * Locked by Another User
748
+ */
749
+ Locked = "undefined",
750
+ /**
751
+ * Own Draft
752
+ */
753
+ OwnDraft = "undefined",
754
+ /**
755
+ * Unchanged
756
+ */
757
+ Unchanged = "undefined",
758
+ /**
759
+ * Unsaved Changes by Another User
760
+ */
761
+ UnsavedChanges = "undefined",
762
+ }
763
+ export default EditState;
764
+ }
765
+
766
+ declare module "sap/fe/test/api/FilterBarActions" {
767
+ import {
768
+ default as FilterBarAPI,
769
+ FilterFieldIdentifier,
770
+ } from "sap/fe/test/api/FilterBarAPI";
771
+
772
+ import EditState from "sap/fe/test/api/EditState";
773
+
774
+ export default class FilterBarActions extends FilterBarAPI {
775
+ constructor();
776
+
777
+ /**
778
+ * Adds a field as a filter field.
779
+ *
780
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
781
+ */
782
+ iAddAdaptationFilterField(
783
+ /**
784
+ * The identifier of the field
785
+ */
786
+ vFieldIdentifier: string | FilterFieldIdentifier
787
+ ): object;
788
+ /**
789
+ * Changes the editing status filter field.
790
+ *
791
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
792
+ */
793
+ iChangeEditingStatus(
794
+ /**
795
+ * Value of an edit state
796
+ */
797
+ sEditState: EditState
798
+ ): object;
799
+ /**
800
+ * Changes the value of the defined filter field.
801
+ *
802
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
803
+ */
804
+ iChangeFilterField(
805
+ /**
806
+ * The identifier for the filter field
807
+ */
808
+ vFieldIdentifier: string | FilterFieldIdentifier,
809
+ /**
810
+ * The new target value
811
+ */
812
+ vValue?: string,
813
+ /**
814
+ * Set to `true` to clear previously set filters, otherwise all previously set values will be kept
815
+ */
816
+ bClearFirst?: boolean
817
+ ): object;
818
+ /**
819
+ * Changes the search field.
820
+ *
821
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
822
+ */
823
+ iChangeSearchField(
824
+ /**
825
+ * The new search text
826
+ */
827
+ sSearchText?: string
828
+ ): object;
829
+ /**
830
+ * Executes a keyboard shortcut.
831
+ *
832
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
833
+ */
834
+ iExecuteKeyboardShortcut(
835
+ /**
836
+ * Pattern for the shortcut
837
+ */
838
+ sShortcut: string,
839
+ /**
840
+ * The identifier of the field
841
+ */
842
+ vFieldIdentifier?: string | FilterFieldIdentifier
843
+ ): object;
844
+ /**
845
+ * Executes the search with the current filters.
846
+ *
847
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
848
+ */
849
+ iExecuteSearch(): object;
850
+ /**
851
+ * Opens the value help of the given field.
852
+ *
853
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, that can be used for chaining statements
854
+ */
855
+ iOpenValueHelp(
856
+ /**
857
+ * The identifier of the filter field
858
+ */
859
+ vFieldIdentifier: string | FilterFieldIdentifier
860
+ ): object;
861
+ /**
862
+ * Removes a field as a filter field.
863
+ *
864
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
865
+ */
866
+ iRemoveAdaptationFilterField(
867
+ /**
868
+ * The identifier of the field
869
+ */
870
+ vFieldIdentifier: string | FilterFieldIdentifier
871
+ ): object;
872
+ /**
873
+ * Resets the search field.
874
+ *
875
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
876
+ */
877
+ iResetSearchField(): object;
878
+ /**
879
+ * Saves a variant under the given name, or overwrites the current variant.
880
+ *
881
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
882
+ */
883
+ iSaveVariant(
884
+ /**
885
+ * The name of the new variant. If no new variant name is defined, the current variant will be overwritten.
886
+ */
887
+ sVariantName?: string,
888
+ /**
889
+ * Saves the new variant with option "Set as Default".
890
+ */
891
+ bSetAsDefault?: string,
892
+ /**
893
+ * Saves the new variant with option "Apply Automatically".
894
+ */
895
+ bApplyAutomatically?: string
896
+ ): object;
897
+ /**
898
+ * Selects the chosen variant.
899
+ *
900
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
901
+ */
902
+ iSelectVariant(
903
+ /**
904
+ * The name of the variant to be selected
905
+ */
906
+ sVariantName: string
907
+ ): object;
908
+ }
909
+ }
910
+
911
+ declare module "sap/fe/test/api/FilterBarAPI" {
912
+ export default class FilterBarAPI {
913
+ constructor();
914
+
915
+ /**
916
+ * Confirms the filter bar adaptation. It can be used in an action chain as well as in an assertion chain.
917
+ *
918
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
919
+ */
920
+ iConfirmFilterAdaptation(): object;
921
+ /**
922
+ * Opens the filter bar adaptation. It can be used in an action chain as well as in an assertion chain.
923
+ *
924
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
925
+ */
926
+ iOpenFilterAdaptation(): object;
927
+ }
928
+ /**
929
+ * A filter field identifier
930
+ */
931
+ export type FilterFieldIdentifier = {
932
+ /**
933
+ * The name of the property
934
+ */
935
+ property: string;
936
+ };
937
+ }
938
+
939
+ declare module "sap/fe/test/api/FilterBarAssertions" {
940
+ import {
941
+ default as FilterBarAPI,
942
+ FilterFieldIdentifier,
943
+ } from "sap/fe/test/api/FilterBarAPI";
944
+
945
+ import EditState from "sap/fe/test/api/EditState";
946
+
947
+ export default class FilterBarAssertions extends FilterBarAPI {
948
+ constructor();
949
+
950
+ /**
951
+ * Checks a field in the adaptation dialog.
952
+ *
953
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
954
+ */
955
+ iCheckAdaptationFilterField(
956
+ /**
957
+ * The identifier of the filter field, or its label
958
+ */
959
+ vFieldIdentifier: string | FilterFieldIdentifier,
960
+ /**
961
+ * Defines the expected state of the filter field in the adaptation dialog
962
+ */
963
+ mState?: object
964
+ ): object;
965
+ /**
966
+ * Check the filter field for the editing status.
967
+ *
968
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
969
+ */
970
+ iCheckEditingStatus(
971
+ /**
972
+ * The expected edit state value
973
+ */
974
+ sEditState?: EditState,
975
+ /**
976
+ * Defines the expected state of the filter field
977
+ */
978
+ mFieldState?: object
979
+ ): object;
980
+ /**
981
+ * Checks whether the filter adaptation dialog is open.
982
+ *
983
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
984
+ */
985
+ iCheckFilterAdaptation(): object;
986
+ /**
987
+ * Checks a filter field. If `vConditionValues` is `undefined`, the current condition values are ignored.
988
+ *
989
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
990
+ */
991
+ iCheckFilterField(
992
+ /**
993
+ * The identifier of the filter field
994
+ */
995
+ vFieldIdentifier: object | FilterFieldIdentifier,
996
+ /**
997
+ * The expected value(s) of the filter field
998
+ */
999
+ vConditionValues?: string | object | any[],
1000
+ /**
1001
+ * The expected operator
1002
+ */
1003
+ sOperator?: string,
1004
+ /**
1005
+ * Defines the expected state of the filter field
1006
+ */
1007
+ mState?: object
1008
+ ): object;
1009
+ /**
1010
+ * Checks the search button.
1011
+ *
1012
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1013
+ */
1014
+ iCheckSearch(
1015
+ /**
1016
+ * Defines the expected state of the Go button
1017
+ */
1018
+ mState?: object
1019
+ ): object;
1020
+ /**
1021
+ * Checks the search field in the filter bar. If the `sSearchText` parameter is `undefined`, the search
1022
+ * text is not validated.
1023
+ *
1024
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1025
+ */
1026
+ iCheckSearchField(
1027
+ /**
1028
+ * The expected text in the search field
1029
+ */
1030
+ sSearchText?: string,
1031
+ /**
1032
+ * Defines the expected state of the search field
1033
+ */
1034
+ mState?: object
1035
+ ): object;
1036
+ /**
1037
+ * Checks the filter bar.
1038
+ *
1039
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1040
+ */
1041
+ iCheckState(
1042
+ /**
1043
+ * Defines the expected state of the filter bar
1044
+ */
1045
+ mFilterBarState?: object
1046
+ ): object;
1047
+ /**
1048
+ * Checks if the focus is on the filter field.
1049
+ *
1050
+ * @returns The result of the {@link sa p.ui.test.Opa5#waitFor} function, to be used for chained statements
1051
+ */
1052
+ iSeeFocusOnFilterField(
1053
+ /**
1054
+ * The field label
1055
+ */
1056
+ sFilterFieldLabel?: string
1057
+ ): object;
1058
+ /**
1059
+ * Checks if the focus is on the Go Button of the filter bar.
1060
+ *
1061
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1062
+ */
1063
+ iSeeFocusOnGoButton(): object;
1064
+ }
1065
+ }
1066
+
1067
+ declare module "sap/fe/test/api/FooterActionsBase" {
1068
+ import { ActionIdentifier } from "sap/fe/test/api/BaseAPI";
1069
+
1070
+ export default class FooterActionsBase {
1071
+ constructor();
1072
+
1073
+ /**
1074
+ * Executes a footer action.
1075
+ *
1076
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1077
+ */
1078
+ iExecuteAction(
1079
+ /**
1080
+ * The identifier of the action or its label
1081
+ */
1082
+ vActionIdentifier?: string | ActionIdentifier
1083
+ ): object;
1084
+ }
1085
+ }
1086
+
1087
+ declare module "sap/fe/test/api/FooterActionsOP" {
1088
+ import FooterActionsBase from "sap/fe/test/api/FooterActionsBase";
1089
+
1090
+ export default class FooterActionsOP extends FooterActionsBase {
1091
+ constructor();
1092
+
1093
+ /**
1094
+ * Confirms the Cancel action when user clicks `Cancel` in draft mode.
1095
+ *
1096
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1097
+ */
1098
+ iConfirmCancel(): object;
1099
+ /**
1100
+ * Executes the Apply action in the footer bar of a sub-object page.
1101
+ *
1102
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1103
+ */
1104
+ iExecuteApply(): object;
1105
+ /**
1106
+ * Executes the Cancel action in the footer bar of the object page.
1107
+ *
1108
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1109
+ */
1110
+ iExecuteCancel(): object;
1111
+ /**
1112
+ * Executes the Save or Create action in the footer bar of the object page.
1113
+ *
1114
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1115
+ */
1116
+ iExecuteSave(): object;
1117
+ }
1118
+ }
1119
+
1120
+ declare module "sap/fe/test/api/FooterAssertionsBase" {
1121
+ import { ActionIdentifier } from "sap/fe/test/api/BaseAPI";
1122
+
1123
+ export default class FooterAssertionsBase {
1124
+ constructor();
1125
+
1126
+ /**
1127
+ * Checks the state of an action in the footer bar.
1128
+ *
1129
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1130
+ */
1131
+ iCheckAction(
1132
+ /**
1133
+ * The identifier of an action
1134
+ */
1135
+ vActionIdentifier: string | ActionIdentifier,
1136
+ /**
1137
+ * Defines the expected state of the button
1138
+ */
1139
+ mState?: object
1140
+ ): object;
1141
+ /**
1142
+ * Checks the state of the footer bar.
1143
+ *
1144
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1145
+ */
1146
+ iCheckState(
1147
+ /**
1148
+ * Defines the expected state of the footer bar
1149
+ */
1150
+ mState?: object
1151
+ ): object;
1152
+ }
1153
+ }
1154
+
1155
+ declare module "sap/fe/test/api/FooterAssertionsOP" {
1156
+ import FooterAssertionsBase from "sap/fe/test/api/FooterAssertionsBase";
1157
+
1158
+ export default class FooterAssertionsOP extends FooterAssertionsBase {
1159
+ constructor();
1160
+
1161
+ /**
1162
+ * Checks the state of the Apply action in the footer bar.
1163
+ *
1164
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1165
+ */
1166
+ iCheckApply(
1167
+ /**
1168
+ * Defines the expected state of the button
1169
+ */
1170
+ mState?: object
1171
+ ): object;
1172
+ /**
1173
+ * Checks the state of the Cancel action in the footer bar.
1174
+ *
1175
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1176
+ */
1177
+ iCheckCancel(
1178
+ /**
1179
+ * Defines the expected state of the button
1180
+ */
1181
+ mState?: object
1182
+ ): object;
1183
+ /**
1184
+ * Checks for draft state 'Clear' in the footer bar.
1185
+ *
1186
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1187
+ */
1188
+ iCheckDraftStateClear(): object;
1189
+ /**
1190
+ * Checks for draft state 'Saved' in the footer bar.
1191
+ *
1192
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1193
+ */
1194
+ iCheckDraftStateSaved(): object;
1195
+ /**
1196
+ * Checks the state of the Save or Create action in the footer bar.
1197
+ *
1198
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1199
+ */
1200
+ iCheckSave(
1201
+ /**
1202
+ * Defines the expected state of the button
1203
+ */
1204
+ mState?: object
1205
+ ): object;
1206
+ }
1207
+ }
1208
+
1209
+ declare module "sap/fe/test/api/FormActions" {
1210
+ import FormAPI from "sap/fe/test/api/FormAPI";
1211
+
1212
+ import { FieldIdentifier, ActionIdentifier } from "sap/fe/test/api/BaseAPI";
1213
+
1214
+ export default class FormActions extends FormAPI {
1215
+ constructor();
1216
+
1217
+ /**
1218
+ * Changes the value of a field within a form.
1219
+ *
1220
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1221
+ */
1222
+ iChangeField(
1223
+ /**
1224
+ * The identifier of the field
1225
+ */
1226
+ vFieldIdentifier: FieldIdentifier | string,
1227
+ /**
1228
+ * The value to be set for the field
1229
+ */
1230
+ sValue?: string
1231
+ ): object;
1232
+ /**
1233
+ * Toggles the value of a checkbox within a form.
1234
+ *
1235
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1236
+ */
1237
+ iClickCheckBox(
1238
+ /**
1239
+ * The identifier of the field
1240
+ */
1241
+ vFieldIdentifier: FieldIdentifier
1242
+ ): object;
1243
+ /**
1244
+ * Clicks a link within a form.
1245
+ *
1246
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1247
+ */
1248
+ iClickLink(
1249
+ /**
1250
+ * The identifier of the field
1251
+ */
1252
+ vFieldIdentifier: FieldIdentifier | string
1253
+ ): object;
1254
+ /**
1255
+ * Executes an action assigned to a form in a subsection.
1256
+ *
1257
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1258
+ */
1259
+ iExecuteAction(
1260
+ /**
1261
+ * The identifier of the action or its label
1262
+ */
1263
+ vActionIdentifier: string | ActionIdentifier
1264
+ ): object;
1265
+ /**
1266
+ * Executes the Show Less action of a form in a subsection.
1267
+ *
1268
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1269
+ */
1270
+ iExecuteShowLess(): object;
1271
+ /**
1272
+ * Executes the Show More action of a form in a subsection.
1273
+ *
1274
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1275
+ */
1276
+ iExecuteShowMore(): object;
1277
+ /**
1278
+ * Opens the value help of the given field.
1279
+ *
1280
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function that can be used for chaining statements
1281
+ */
1282
+ iOpenValueHelp(
1283
+ /**
1284
+ * The identifier of the field
1285
+ */
1286
+ vFieldIdentifier: string | FieldIdentifier
1287
+ ): object;
1288
+ }
1289
+ }
1290
+
1291
+ declare module "sap/fe/test/api/FormAPI" {
1292
+ export default class FormAPI {
1293
+ constructor();
1294
+ }
1295
+ /**
1296
+ * A form identifier
1297
+ */
1298
+ export type FormIdentifier = {
1299
+ /**
1300
+ * The facet ID
1301
+ */
1302
+ section: string;
1303
+ /**
1304
+ * The fieldgroup ID
1305
+ */
1306
+ fieldGroup: string;
1307
+ /**
1308
+ * Is it about the editable header facet
1309
+ */
1310
+ isHeaderFacet?: boolean;
1311
+ };
1312
+ }
1313
+
1314
+ declare module "sap/fe/test/api/FormAssertions" {
1315
+ import FormAPI from "sap/fe/test/api/FormAPI";
1316
+
1317
+ import { ActionIdentifier, FieldIdentifier } from "sap/fe/test/api/BaseAPI";
1318
+
1319
+ export default class FormAssertions extends FormAPI {
1320
+ constructor();
1321
+
1322
+ /**
1323
+ * Checks the state of an action in a subsection.
1324
+ *
1325
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1326
+ */
1327
+ iCheckAction(
1328
+ /**
1329
+ * The identifier of an action
1330
+ */
1331
+ vActionIdentifier: string | ActionIdentifier,
1332
+ /**
1333
+ * Defines the expected state of the button
1334
+ */
1335
+ mState?: object
1336
+ ): object;
1337
+ /**
1338
+ * Checks the content and state of a field within a form.
1339
+ *
1340
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1341
+ */
1342
+ iCheckField(
1343
+ /**
1344
+ * The identifier of the field
1345
+ */
1346
+ vFieldIdentifier: string | FieldIdentifier,
1347
+ /**
1348
+ * Expected value(s) of the field. if passed as an object, the following pattern will be considered:
1349
+ * ```javascript
1350
+ *
1351
+ * {
1352
+ * value: , // optional
1353
+ * description: // optional
1354
+ * }
1355
+ * ```
1356
+ */
1357
+ vValue?: string | any[] | object,
1358
+ /**
1359
+ * Defines the expected state of the field
1360
+ */
1361
+ mState?: object
1362
+ ): object;
1363
+ /**
1364
+ * Checks the field is a link with the given text and state.
1365
+ *
1366
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1367
+ */
1368
+ iCheckLink(
1369
+ /**
1370
+ * The identifier of the field
1371
+ */
1372
+ vFieldIdentifier: string | FieldIdentifier,
1373
+ /**
1374
+ * The link text
1375
+ */
1376
+ sText?: string,
1377
+ /**
1378
+ * Defines the expected state of the field
1379
+ */
1380
+ mState?: object
1381
+ ): object;
1382
+ /**
1383
+ * Checks the Show Less action of a form in a subsection.
1384
+ *
1385
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1386
+ */
1387
+ iCheckShowLess(
1388
+ /**
1389
+ * Defines the expected state of the button
1390
+ */
1391
+ mState?: object
1392
+ ): object;
1393
+ /**
1394
+ * Checks the Show More action of a form in a subsection.
1395
+ *
1396
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1397
+ */
1398
+ iCheckShowMore(
1399
+ /**
1400
+ * Defines the expected state of the button
1401
+ */
1402
+ mState?: object
1403
+ ): object;
1404
+ /**
1405
+ * Checks the state of the form.
1406
+ *
1407
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1408
+ */
1409
+ iCheckState(
1410
+ /**
1411
+ * Defines the expected state of the form
1412
+ */
1413
+ mState: object
1414
+ ): object;
1415
+ }
1416
+ }
1417
+
1418
+ declare module "sap/fe/test/api/HeaderActions" {
1419
+ import { ActionIdentifier } from "sap/fe/test/api/BaseAPI";
1420
+
1421
+ export default class HeaderActions {
1422
+ constructor();
1423
+
1424
+ /**
1425
+ * Executes an action in the header toolbar of an object page.
1426
+ *
1427
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1428
+ */
1429
+ iExecuteAction(
1430
+ /**
1431
+ * The identifier of the action
1432
+ */
1433
+ vActionIdentifier: string | ActionIdentifier
1434
+ ): object;
1435
+ /**
1436
+ * Executes the Delete action in the header toolbar of an object page.
1437
+ *
1438
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1439
+ */
1440
+ iExecuteDelete(): object;
1441
+ /**
1442
+ * Executes the Draft/Saved Version action in the header toolbar of an object page.
1443
+ *
1444
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1445
+ */
1446
+ iExecuteDraftAndSavedVersionSwitch(): object;
1447
+ /**
1448
+ * Executes the Edit action in the header toolbar of an object page.
1449
+ *
1450
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1451
+ */
1452
+ iExecuteEdit(): object;
1453
+ /**
1454
+ * Executes an action in the drop-down menu that is currently open.
1455
+ *
1456
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1457
+ */
1458
+ iExecuteMenuAction(
1459
+ /**
1460
+ * The label of the action or its state
1461
+ */
1462
+ vAction: string | object
1463
+ ): object;
1464
+ /**
1465
+ * Navigates to the next sub-object page.
1466
+ *
1467
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1468
+ */
1469
+ iExecutePaginatorDown(): object;
1470
+ /**
1471
+ * Navigates to the previous sub-object page.
1472
+ *
1473
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1474
+ */
1475
+ iExecutePaginatorUp(): object;
1476
+ /**
1477
+ * Executes the Related Apps action in the header toolbar of an object page.
1478
+ *
1479
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1480
+ */
1481
+ iExecuteRelatedApps(): object;
1482
+ /**
1483
+ * Executes an action in the selection list that is currently open.
1484
+ *
1485
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1486
+ */
1487
+ iExecuteSelectListAction(
1488
+ /**
1489
+ * The label of the action or its state
1490
+ */
1491
+ vAction: string | object
1492
+ ): object;
1493
+ }
1494
+ }
1495
+
1496
+ declare module "sap/fe/test/api/HeaderActionsLR" {
1497
+ import { ActionIdentifier } from "sap/fe/test/api/BaseAPI";
1498
+
1499
+ export default class HeaderActionsLR {
1500
+ constructor();
1501
+
1502
+ /**
1503
+ * Executes an action in the header toolbar of a list report.
1504
+ *
1505
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1506
+ */
1507
+ iExecuteAction(
1508
+ /**
1509
+ * The identifier of the action
1510
+ */
1511
+ vActionIdentifier?: string | ActionIdentifier
1512
+ ): object;
1513
+ }
1514
+ }
1515
+
1516
+ declare module "sap/fe/test/api/HeaderAssertions" {
1517
+ import { ActionIdentifier, FieldIdentifier } from "sap/fe/test/api/BaseAPI";
1518
+
1519
+ import { HeaderFacetIdentifier } from "sap/fe/test/api/HeaderAPI";
1520
+
1521
+ export default class HeaderAssertions {
1522
+ constructor();
1523
+
1524
+ /**
1525
+ * Checks an action in the header toolbar.
1526
+ *
1527
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1528
+ */
1529
+ iCheckAction(
1530
+ /**
1531
+ * The identifier of the action
1532
+ */
1533
+ vActionIdentifier: string | ActionIdentifier,
1534
+ /**
1535
+ * Defines the expected state of the button
1536
+ */
1537
+ mState?: object
1538
+ ): object;
1539
+ /**
1540
+ * Checks the `Delete` action in the header toolbar.
1541
+ *
1542
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1543
+ */
1544
+ iCheckDelete(
1545
+ /**
1546
+ * Defines the expected state of the button
1547
+ */
1548
+ mState?: object
1549
+ ): object;
1550
+ /**
1551
+ * Checks the `Edit` action in the header toolbar.
1552
+ *
1553
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1554
+ */
1555
+ iCheckEdit(
1556
+ /**
1557
+ * Defines the expected state of the button
1558
+ */
1559
+ mState?: object
1560
+ ): object;
1561
+ /**
1562
+ * Checks a field within a field group in the object page header.
1563
+ *
1564
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1565
+ */
1566
+ iCheckFieldInFieldGroup(
1567
+ /**
1568
+ * The identifier of the field
1569
+ */
1570
+ vFieldIdentifier: FieldIdentifier | string,
1571
+ /**
1572
+ * The value to check. If it is an array, the first entry is considered as the value and the second as the
1573
+ * description. If it is an object it must follow this pattern:
1574
+ * ```javascript
1575
+ *
1576
+ * {
1577
+ * value: , // optional
1578
+ * description: // optional
1579
+ * }
1580
+ * ```
1581
+ */
1582
+ vValue?: string | any[] | object,
1583
+ /**
1584
+ * Defines the expected state of the field
1585
+ */
1586
+ mState?: object
1587
+ ): object;
1588
+ /**
1589
+ * Checks the custom facet in the object page header.
1590
+ *
1591
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1592
+ */
1593
+ iCheckHeaderFacet(
1594
+ /**
1595
+ * The Identifier of the header facet
1596
+ */
1597
+ vFacetIdentifier: HeaderFacetIdentifier,
1598
+ /**
1599
+ * Defines the expected state
1600
+ */
1601
+ mState?: object
1602
+ ): object;
1603
+ /**
1604
+ * Checks an action in the popover that is currently open.
1605
+ *
1606
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1607
+ */
1608
+ iCheckMenuAction(
1609
+ /**
1610
+ * The state map or label of the action
1611
+ */
1612
+ vAction: object | string
1613
+ ): object;
1614
+ /**
1615
+ * Checks the paginator down button.
1616
+ *
1617
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1618
+ */
1619
+ iCheckPaginatorDown(
1620
+ /**
1621
+ * Defines the expected state of the button
1622
+ */
1623
+ mState: object
1624
+ ): object;
1625
+ /**
1626
+ * Checks the paginator up button.
1627
+ *
1628
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1629
+ */
1630
+ iCheckPaginatorUp(
1631
+ /**
1632
+ * Defines the expected state of the button
1633
+ */
1634
+ mState: object
1635
+ ): object;
1636
+ /**
1637
+ * Checks the `Related Apps` action in the header toolbar.
1638
+ *
1639
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1640
+ */
1641
+ iCheckRelatedApps(
1642
+ /**
1643
+ * Defines the expected state of the button
1644
+ */
1645
+ mState?: object
1646
+ ): object;
1647
+ /**
1648
+ * Checks the `Save as Tile` action.
1649
+ *
1650
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1651
+ */
1652
+ iCheckSaveAsTile(
1653
+ /**
1654
+ * Defines the expected state of the button
1655
+ */
1656
+ mState?: object
1657
+ ): object;
1658
+ /**
1659
+ * Checks `Send Email` action.
1660
+ *
1661
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1662
+ */
1663
+ iCheckSendEmail(
1664
+ /**
1665
+ * Defines the expected state of the button
1666
+ */
1667
+ mState?: object
1668
+ ): object;
1669
+ /**
1670
+ * Checks the title and description of the object page.
1671
+ *
1672
+ * If either title or description is `undefined`, it will not be checked.
1673
+ *
1674
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1675
+ */
1676
+ iCheckTitle(
1677
+ /**
1678
+ * Title of the object page header
1679
+ */
1680
+ sTitle?: string,
1681
+ /**
1682
+ * Description of the object page header
1683
+ */
1684
+ sDescription?: string
1685
+ ): object;
1686
+ }
1687
+ }
1688
+
1689
+ declare module "sap/fe/test/api/HeaderAssertionsLR" {
1690
+ import { ActionIdentifier } from "sap/fe/test/api/BaseAPI";
1691
+
1692
+ export default class HeaderAssertionsLR {
1693
+ constructor();
1694
+
1695
+ /**
1696
+ * Checks an action of the header toolbar.
1697
+ *
1698
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1699
+ */
1700
+ iCheckAction(
1701
+ /**
1702
+ * The identifier of the action, or its label
1703
+ */
1704
+ vActionIdentifier?: string | ActionIdentifier,
1705
+ /**
1706
+ * Defines the expected state of the button
1707
+ */
1708
+ mState?: object
1709
+ ): object;
1710
+ /**
1711
+ * Checks the `Save as Tile` action.
1712
+ *
1713
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1714
+ */
1715
+ iCheckSaveAsTile(
1716
+ /**
1717
+ * Defines the expected state of the button
1718
+ */
1719
+ mState?: object
1720
+ ): object;
1721
+ /**
1722
+ * Checks the `Send Email` action.
1723
+ *
1724
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1725
+ */
1726
+ iCheckSendEmail(
1727
+ /**
1728
+ * Defines the expected state of the button
1729
+ */
1730
+ mState?: object
1731
+ ): object;
1732
+ }
1733
+ }
1734
+
1735
+ declare module "sap/fe/test/api/HeaderAPI" {
1736
+ /**
1737
+ * An identifier for the header facet
1738
+ */
1739
+ export type HeaderFacetIdentifier = {
1740
+ /**
1741
+ * The identifier of the facet
1742
+ */
1743
+ facetId: string;
1744
+ /**
1745
+ * Defines whether the facet is a collection facet (default: `false`)
1746
+ */
1747
+ collection?: boolean;
1748
+ /**
1749
+ * Defines whether the facet is a custom header facet (default: `false`)
1750
+ */
1751
+ custom?: boolean;
1752
+ };
1753
+ }
1754
+
1755
+ declare module "sap/fe/test/api/TableActions" {
1756
+ import {
1757
+ default as TableAPI,
1758
+ ColumnIdentifier,
1759
+ } from "sap/fe/test/api/TableAPI";
1760
+
1761
+ import { SortOrder } from "sap/ui/core/library";
1762
+
1763
+ import { ActionIdentifier } from "sap/fe/test/api/BaseAPI";
1764
+
1765
+ export default class TableActions extends TableAPI {
1766
+ constructor();
1767
+
1768
+ /**
1769
+ * Adds a field as a column to the table.
1770
+ *
1771
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1772
+ */
1773
+ iAddAdaptationColumn(
1774
+ /**
1775
+ * The identifier of the column field, or its label
1776
+ */
1777
+ vColumnIdentifier: string | ColumnIdentifier
1778
+ ): object;
1779
+ /**
1780
+ * Aggregates the table entries by the specified column.
1781
+ *
1782
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1783
+ */
1784
+ iAggregateByColumn(
1785
+ /**
1786
+ * The identifier of the column field, its label or index
1787
+ */
1788
+ vColumnIdentifier: string | ColumnIdentifier | number,
1789
+ /**
1790
+ * The target field to group on. If undefined, parameter vColumnIdentifier is used as label to identify
1791
+ * the toggle button.
1792
+ */
1793
+ sFieldLabel?: string
1794
+ ): object;
1795
+ /**
1796
+ * Adds a filter condition to the filter field.
1797
+ *
1798
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1799
+ */
1800
+ iChangeFilterField(
1801
+ /**
1802
+ * The identifier of the column
1803
+ */
1804
+ vColumnIdentifier: string | ColumnIdentifier,
1805
+ /**
1806
+ * Defines the value of the filter field condition
1807
+ */
1808
+ vValue: string | object,
1809
+ /**
1810
+ * Set to `true` to clear previously set filters, otherwise all previously set values will be kept
1811
+ */
1812
+ bClearFirst?: boolean
1813
+ ): object;
1814
+ /**
1815
+ * Changes the specified row. The given value map must match exactly one row.
1816
+ *
1817
+ * If only one parameter is provided, it must be the `mTargetValues` and `mRowValues` is considered undefined.
1818
+ * If `vRowValues` are not defined, then the targetValues are inserted in the creationRow.
1819
+ *
1820
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1821
+ */
1822
+ iChangeRow(
1823
+ /**
1824
+ * Defines the row values of the target row. The pattern is:
1825
+ * ```javascript
1826
+ *
1827
+ * {
1828
+ * <column-name-or-index>: <expected-value>
1829
+ * }
1830
+ * ```
1831
+ * Alternatively, the 0-based row index can be used.
1832
+ */
1833
+ vRowValues: object | number,
1834
+ /**
1835
+ * A map of columns (either name or index) to its new value. The columns do not need to match the ones defined
1836
+ * in `vRowValues`.
1837
+ */
1838
+ mTargetValues: object,
1839
+ /**
1840
+ * If true, we keep the focus on the modified cell and don't press enter to validate the input
1841
+ */
1842
+ bInputNotFinalized: boolean
1843
+ ): object;
1844
+ /**
1845
+ * Changes the specified row. The given value map must match exactly one row.
1846
+ *
1847
+ * If only one parameter is provided, it must be the `mTargetValues` and `mRowValues` is considered undefined.
1848
+ * If `vRowValues` are not defined, then the targetValues are inserted in the creationRow.
1849
+ *
1850
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1851
+ */
1852
+ iChangeRow(
1853
+ /**
1854
+ * A map of columns (either name or index) to its new value. The columns do not need to match the ones defined
1855
+ * in `vRowValues`.
1856
+ */
1857
+ mTargetValues: object,
1858
+ /**
1859
+ * If true, we keep the focus on the modified cell and don't press enter to validate the input
1860
+ */
1861
+ bInputNotFinalized: boolean
1862
+ ): object;
1863
+ /**
1864
+ * Changes the search field.
1865
+ *
1866
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1867
+ */
1868
+ iChangeSearchField(
1869
+ /**
1870
+ * The new search text
1871
+ */
1872
+ sSearchText?: string
1873
+ ): object;
1874
+ /**
1875
+ * Adds a field to the sorting of the table via the sort dialog.
1876
+ *
1877
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1878
+ */
1879
+ iChangeSortOrder(
1880
+ /**
1881
+ * The identifier of the column field, or its label
1882
+ */
1883
+ vColumnIdentifier: string | ColumnIdentifier,
1884
+ /**
1885
+ * The sort order, default is {@link sap.ui.core.SortOrder.Ascending}
1886
+ */
1887
+ sSortOrder?: SortOrder | keyof typeof SortOrder
1888
+ ): object;
1889
+ /**
1890
+ * Collapses a row corresponding to a visual group.
1891
+ *
1892
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1893
+ */
1894
+ iCollapseGroupRow(
1895
+ /**
1896
+ * The level of the group row to be collapsed (1-based)
1897
+ */
1898
+ iLevel: number,
1899
+ /**
1900
+ * The title of the group row to be collapsed
1901
+ */
1902
+ sTitle: string
1903
+ ): object;
1904
+ /**
1905
+ * Executes an action on the table.
1906
+ *
1907
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1908
+ */
1909
+ iExecuteAction(
1910
+ /**
1911
+ * The identifier of the action, or its label
1912
+ */
1913
+ vActionIdentifier?: string | ActionIdentifier
1914
+ ): object;
1915
+ /**
1916
+ * Executes the `Create` action on the table.
1917
+ *
1918
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1919
+ */
1920
+ iExecuteCreate(): object;
1921
+ /**
1922
+ * Executes the `Delete` action on the table.
1923
+ *
1924
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1925
+ */
1926
+ iExecuteDelete(): object;
1927
+ /**
1928
+ * Executes the `Fullscreen` action on the table.
1929
+ *
1930
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1931
+ */
1932
+ iExecuteFullScreen(): object;
1933
+ /**
1934
+ * Executes an action that is available in a certain column within a table row.
1935
+ *
1936
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1937
+ */
1938
+ iExecuteInlineAction(
1939
+ /**
1940
+ * Defines the row values of the target row. The pattern is:
1941
+ * ```javascript
1942
+ *
1943
+ * {
1944
+ * <column-name-or-index>: <expected-value>
1945
+ * }
1946
+ * ```
1947
+ * Alternatively, the 0-based row index can be used.
1948
+ */
1949
+ vRowValues: object | number,
1950
+ /**
1951
+ * The column name, label or index
1952
+ */
1953
+ vColumn: string | number
1954
+ ): object;
1955
+ /**
1956
+ * Executes an action that is available in a certain column within a table row.
1957
+ *
1958
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1959
+ */
1960
+ iExecuteInlineAction(
1961
+ /**
1962
+ * The column name, label or index
1963
+ */
1964
+ vColumn: string | number
1965
+ ): object;
1966
+ /**
1967
+ * Executes the action to create a row in the table.
1968
+ *
1969
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1970
+ */
1971
+ iExecuteInlineCreate(): object;
1972
+ /**
1973
+ * Executes a keyboard shortcut on the table or a cell control. If only `sShortcut` is defined, the shortcut
1974
+ * is executed on the table directly. If additionally `vRowValues` and `vColumn` are defined, the shortcut
1975
+ * is executed on table cell level.
1976
+ *
1977
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1978
+ */
1979
+ iExecuteKeyboardShortcut(
1980
+ /**
1981
+ * The shortcut pattern
1982
+ */
1983
+ sShortcut: string,
1984
+ /**
1985
+ * Defines the row values of the target row. The pattern is:
1986
+ * ```javascript
1987
+ *
1988
+ * {
1989
+ * <column-name-or-index>: <expected-value>
1990
+ * }
1991
+ * ```
1992
+ * Alternatively, the 0-based row index can be used.
1993
+ */
1994
+ vRowValues: object | number,
1995
+ /**
1996
+ * The column name, label or index
1997
+ */
1998
+ vColumn: string | number
1999
+ ): object;
2000
+ /**
2001
+ * Executes a keyboard shortcut on the table or a cell control. If only `sShortcut` is defined, the shortcut
2002
+ * is executed on the table directly. If additionally `vRowValues` and `vColumn` are defined, the shortcut
2003
+ * is executed on table cell level.
2004
+ *
2005
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2006
+ */
2007
+ iExecuteKeyboardShortcut(
2008
+ /**
2009
+ * The shortcut pattern
2010
+ */
2011
+ sShortcut: string,
2012
+ /**
2013
+ * The column name, label or index
2014
+ */
2015
+ vColumn: string | number
2016
+ ): object;
2017
+ /**
2018
+ * Executes an action form the drop-down menu that is currently open.
2019
+ *
2020
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2021
+ */
2022
+ iExecuteMenuAction(
2023
+ /**
2024
+ * The label of the action or its state
2025
+ */
2026
+ vAction: string | object
2027
+ ): object;
2028
+ /**
2029
+ * Executes the `Show/Hide details` action on the table.
2030
+ *
2031
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2032
+ */
2033
+ iExecuteShowHideDetails(
2034
+ /**
2035
+ * Optional parameter to enforce a certain state (showing details yes/no corresponds to true/false); if
2036
+ * not set, state is toggled
2037
+ */
2038
+ bShowDetails?: boolean
2039
+ ): object;
2040
+ /**
2041
+ * Expands a row corresponding to a visual group.
2042
+ *
2043
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2044
+ */
2045
+ iExpandGroupRow(
2046
+ /**
2047
+ * The level of the group row to be expanded (1-based)
2048
+ */
2049
+ iLevel: number,
2050
+ /**
2051
+ * The title of the group row to be expanded
2052
+ */
2053
+ sTitle: string
2054
+ ): object;
2055
+ /**
2056
+ * Groups the table entries by the specified column.
2057
+ *
2058
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2059
+ */
2060
+ iGroupByColumn(
2061
+ /**
2062
+ * The identifier of the column field, its label or index
2063
+ */
2064
+ vColumnIdentifier: string | ColumnIdentifier | number,
2065
+ /**
2066
+ * The target field for grouping. If undefined, parameter vColumnIdentifier is used as label to identify
2067
+ * the toggle button.
2068
+ */
2069
+ sFieldLabel?: string
2070
+ ): object;
2071
+ /**
2072
+ * Pastes data into the table.
2073
+ *
2074
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2075
+ */
2076
+ iPasteData(
2077
+ /**
2078
+ * The data to be pasted
2079
+ */
2080
+ aData: string[][]
2081
+ ): object;
2082
+ /**
2083
+ * Presses the control in the table cell.
2084
+ *
2085
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2086
+ */
2087
+ iPressCell(
2088
+ /**
2089
+ * Specifies the target row by column-value map, e.g.
2090
+ * ```javascript
2091
+ *
2092
+ * {
2093
+ * 0: "Max",
2094
+ * "Last Name": "Mustermann"
2095
+ * }
2096
+ * ```
2097
+ */
2098
+ mRowValues: object,
2099
+ /**
2100
+ * The column name, label or index
2101
+ */
2102
+ vColumn: string | number
2103
+ ): object;
2104
+ /**
2105
+ * Presses the control in the table cell.
2106
+ *
2107
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2108
+ */
2109
+ iPressCell(
2110
+ /**
2111
+ * The column name, label or index
2112
+ */
2113
+ vColumn: string | number
2114
+ ): object;
2115
+ /**
2116
+ * Clicks the specified row.
2117
+ *
2118
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2119
+ */
2120
+ iPressRow(
2121
+ /**
2122
+ * Defines the row values of the target row. The pattern is:
2123
+ * ```javascript
2124
+ *
2125
+ * {
2126
+ * <column-name-or-index>: <expected-value>
2127
+ * }
2128
+ * ```
2129
+ * Alternatively, the 0-based row index can be used.
2130
+ */
2131
+ vRowValues?: object | number
2132
+ ): object;
2133
+ /**
2134
+ * Removes a field as a column from the table.
2135
+ *
2136
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2137
+ */
2138
+ iRemoveAdaptationColumn(
2139
+ /**
2140
+ * The identifier of the column field, or its label
2141
+ */
2142
+ vColumnIdentifier: string | ColumnIdentifier
2143
+ ): object;
2144
+ /**
2145
+ * Removes the variant of the given name.
2146
+ *
2147
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2148
+ */
2149
+ iRemoveVariant(
2150
+ /**
2151
+ * The name of the variant to be removed
2152
+ */
2153
+ sVariantName: string
2154
+ ): object;
2155
+ /**
2156
+ * Resets the search field.
2157
+ *
2158
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2159
+ */
2160
+ iResetSearchField(): object;
2161
+ /**
2162
+ * Saves a variant under the given name, or overwrites the current one.
2163
+ *
2164
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2165
+ */
2166
+ iSaveVariant(
2167
+ /**
2168
+ * The name of the new variant. If omitted, the current variant will be overwritten
2169
+ */
2170
+ sVariantName?: string
2171
+ ): object;
2172
+ /**
2173
+ * Selects all rows in a table.
2174
+ *
2175
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2176
+ */
2177
+ iSelectAllRows(): object;
2178
+ /**
2179
+ * Selects a quick-filter item on the table.
2180
+ *
2181
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2182
+ */
2183
+ iSelectQuickFilterItem(
2184
+ /**
2185
+ * If passed as an object, the following pattern will be considered:
2186
+ * ```javascript
2187
+ *
2188
+ * {
2189
+ * :
2190
+ * }
2191
+ * ```
2192
+ * If using a plain string as the identifier, it is considered the item label
2193
+ */
2194
+ vItemIdentifier?: object | string
2195
+ ): object;
2196
+ /**
2197
+ * Selects the specified rows.
2198
+ *
2199
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2200
+ */
2201
+ iSelectRows(
2202
+ /**
2203
+ * Defines the row values of the target row. The pattern is:
2204
+ * ```javascript
2205
+ *
2206
+ * {
2207
+ * <column-name-or-index>: <expected-value>
2208
+ * }
2209
+ * ```
2210
+ * Alternatively, the 0-based row index can be used.
2211
+ */
2212
+ vRowValues?: object | number,
2213
+ /**
2214
+ * Defines the expected state of the row
2215
+ */
2216
+ mState?: object
2217
+ ): object;
2218
+ /**
2219
+ * Selects the chosen variant.
2220
+ *
2221
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2222
+ */
2223
+ iSelectVariant(
2224
+ /**
2225
+ * The name of the variant to be selected
2226
+ */
2227
+ sVariantName: string
2228
+ ): object;
2229
+ /**
2230
+ * Sets the variant as the default.
2231
+ *
2232
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2233
+ */
2234
+ iSetDefaultVariant(
2235
+ /**
2236
+ * The name of the variant to be set as the default variant. If omitted, the Standard variant is set as
2237
+ * the default
2238
+ */
2239
+ sVariantName: string
2240
+ ): object;
2241
+ /**
2242
+ * Sorts the table entries by the specified column.
2243
+ *
2244
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2245
+ */
2246
+ iSortByColumn(
2247
+ /**
2248
+ * The identifier of the column field, its label or index
2249
+ */
2250
+ vColumnIdentifier: string | ColumnIdentifier | number,
2251
+ /**
2252
+ * The target field for sorting in case the field label differs from the column label or in case of a complex
2253
+ * property
2254
+ */
2255
+ sFieldLabel?: string,
2256
+ /**
2257
+ * Sorting (true=descending, false=ascending (default))
2258
+ */
2259
+ bDescending?: boolean,
2260
+ /**
2261
+ * Set to `true` to clear previously set sortings (default), otherwise all previously set sorting fields
2262
+ * will be kept.
2263
+ */
2264
+ bClearFirst?: boolean
2265
+ ): object;
2266
+ }
2267
+ }
2268
+
2269
+ declare module "sap/fe/test/api/TableAssertions" {
2270
+ import {
2271
+ default as TableAPI,
2272
+ ColumnIdentifier,
2273
+ } from "sap/fe/test/api/TableAPI";
2274
+
2275
+ import { ActionIdentifier } from "sap/fe/test/api/BaseAPI";
2276
+
2277
+ import { SortOrder } from "sap/ui/core/library";
2278
+
2279
+ export default class TableAssertions extends TableAPI {
2280
+ constructor();
2281
+
2282
+ /**
2283
+ * Checks the state of a table action.
2284
+ *
2285
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2286
+ */
2287
+ iCheckAction(
2288
+ /**
2289
+ * The identifier of the action, or its label
2290
+ */
2291
+ vActionIdentifier: string | ActionIdentifier,
2292
+ /**
2293
+ * Defines the expected state of the button
2294
+ */
2295
+ mState?: object
2296
+ ): object;
2297
+ /**
2298
+ * Checks a field in the adaptation dialog.
2299
+ *
2300
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2301
+ */
2302
+ iCheckAdaptationColumn(
2303
+ /**
2304
+ * The identifier of the column, or its label
2305
+ */
2306
+ vColumnIdentifier: string | ColumnIdentifier,
2307
+ /**
2308
+ * Defines the expected state of the field control in the adaptation dialog
2309
+ */
2310
+ mState?: object
2311
+ ): object;
2312
+ /**
2313
+ * Checks the state of the cells of a table.
2314
+ *
2315
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2316
+ */
2317
+ iCheckCells(
2318
+ /**
2319
+ * Defines the row values of the target row. The pattern is:
2320
+ * ```javascript
2321
+ *
2322
+ * {
2323
+ * <column-name-or-index>: <expected-value>
2324
+ * }
2325
+ * ```
2326
+ * Alternatively, the 0-based row index can be used.
2327
+ */
2328
+ vRowValues: object | number,
2329
+ /**
2330
+ * A map of columns and their state. The map looks like
2331
+ * ```javascript
2332
+ *
2333
+ * {
2334
+ * <column-name-or-index>: {
2335
+ * header: "My header"
2336
+ * }
2337
+ * }
2338
+ * ```
2339
+ */
2340
+ mColumnStateMap: object
2341
+ ): object;
2342
+ /**
2343
+ * Checks the state of the cells of a table.
2344
+ *
2345
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2346
+ */
2347
+ iCheckCells(
2348
+ /**
2349
+ * A map of columns and their state. The map looks like
2350
+ * ```javascript
2351
+ *
2352
+ * {
2353
+ * <column-name-or-index>: {
2354
+ * header: "My header"
2355
+ * }
2356
+ * }
2357
+ * ```
2358
+ */
2359
+ mColumnStateMap: object
2360
+ ): object;
2361
+ /**
2362
+ * Checks whether the adaptation button is available for the table.
2363
+ *
2364
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2365
+ */
2366
+ iCheckColumnAdaptation(): object;
2367
+ /**
2368
+ * Checks whether the column adaptation dialog is open.
2369
+ *
2370
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2371
+ */
2372
+ iCheckColumnAdaptationDialog(): object;
2373
+ /**
2374
+ * Checks whether the filter button is available for the table.
2375
+ *
2376
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2377
+ */
2378
+ iCheckColumnFiltering(): object;
2379
+ /**
2380
+ * Checks the state of the columns of the table.
2381
+ *
2382
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2383
+ */
2384
+ iCheckColumns(
2385
+ /**
2386
+ * The expected number of columns
2387
+ */
2388
+ iExpectedNumberOfColumns?: number,
2389
+ /**
2390
+ * A map of columns and their expected state. The map looks like
2391
+ * ```javascript
2392
+ *
2393
+ * {
2394
+ * <columnName | columnLabel | columnIndex>: {
2395
+ * header: "My header"
2396
+ * }
2397
+ * }
2398
+ * ```
2399
+ */
2400
+ mColumnStateMap?: object
2401
+ ): object;
2402
+ /**
2403
+ * Checks whether the sort button is available for the table.
2404
+ *
2405
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2406
+ */
2407
+ iCheckColumnSorting(): object;
2408
+ /**
2409
+ * Checks the `Create` action of the table.
2410
+ *
2411
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2412
+ */
2413
+ iCheckCreate(
2414
+ /**
2415
+ * Defines the expected state of the button
2416
+ */
2417
+ mState?: object
2418
+ ): object;
2419
+ /**
2420
+ * Checks the state of the CreationRow button in the table.
2421
+ *
2422
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2423
+ */
2424
+ iCheckCreationRow(
2425
+ /**
2426
+ * Defines the expected row values. The pattern is:
2427
+ * ```javascript
2428
+ *
2429
+ * {
2430
+ * <column-name-or-index>: <expected-value>
2431
+ * }
2432
+ * ```
2433
+ */
2434
+ mRowValues?: object,
2435
+ /**
2436
+ * Defines the expected state of the target row
2437
+ */
2438
+ mState?: object
2439
+ ): object;
2440
+ /**
2441
+ * Checks the `Delete` action of the table.
2442
+ *
2443
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2444
+ */
2445
+ iCheckDelete(
2446
+ /**
2447
+ * Defines the expected state of the button
2448
+ */
2449
+ mState?: object
2450
+ ): object;
2451
+ /**
2452
+ * Checks whether the export button is available for the table.
2453
+ *
2454
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2455
+ */
2456
+ iCheckExport(): object;
2457
+ /**
2458
+ * Checks, if a filter field is available in the filter dialog.
2459
+ *
2460
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2461
+ */
2462
+ iCheckFilterField(
2463
+ /**
2464
+ * The identifier of the field, or its label
2465
+ */
2466
+ vColumnIdentifier: string | ColumnIdentifier,
2467
+ /**
2468
+ * Defines the expected state of the field control in the filter dialog
2469
+ */
2470
+ mState?: object
2471
+ ): object;
2472
+ /**
2473
+ * Checks the `Fullscreen` action of the table.
2474
+ *
2475
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2476
+ */
2477
+ iCheckFullScreen(
2478
+ /**
2479
+ * Defines the expected state of the button
2480
+ */
2481
+ mState?: object
2482
+ ): object;
2483
+ /**
2484
+ * Checks an action in the drop-down menu that is currently open.
2485
+ *
2486
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2487
+ */
2488
+ iCheckMenuAction(
2489
+ /**
2490
+ * The label of the action, or its state
2491
+ */
2492
+ vAction: object | string
2493
+ ): object;
2494
+ /**
2495
+ * Checks a messageStrip on a table.
2496
+ *
2497
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2498
+ */
2499
+ iCheckMessageStrip(
2500
+ /**
2501
+ * Defines the expected properties of the messageStrip in the table
2502
+ */
2503
+ mProperty?: object
2504
+ ): object;
2505
+ /**
2506
+ * Checks whether the paste button is available for the table.
2507
+ *
2508
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2509
+ */
2510
+ iCheckPaste(): object;
2511
+ /**
2512
+ * Checks the quick filter action of the table.
2513
+ *
2514
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2515
+ */
2516
+ iCheckQuickFilter(
2517
+ /**
2518
+ * Defines the expected state of the control
2519
+ */
2520
+ mState?: object
2521
+ ): object;
2522
+ /**
2523
+ * Checks the number of items in the quick-filter menu.
2524
+ *
2525
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2526
+ */
2527
+ iCheckQuickFilterItems(
2528
+ /**
2529
+ * The expected number of quick-filter items
2530
+ */
2531
+ iExpectedNumberOfItems: number
2532
+ ): object;
2533
+ /**
2534
+ * Checks the rows of a table. If `mRowValues` is provided, only rows with the corresponding values are
2535
+ * considered. If `iNumberOfRows` is provided, the number of rows are checked with respect to the provided
2536
+ * `mRowValues` (if set) or in total. If `iNumberOfRows` is omitted, it checks for at least one matching
2537
+ * row. If `mState` is provided, the row must be in the given state.
2538
+ *
2539
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2540
+ */
2541
+ iCheckRows(
2542
+ /**
2543
+ * Defines the row values of the target row. The pattern is:
2544
+ * ```javascript
2545
+ *
2546
+ * {
2547
+ * <column-name-or-index>: <expected-value>
2548
+ * }
2549
+ * ```
2550
+ */
2551
+ mRowValues?: object,
2552
+ /**
2553
+ * The expected number of rows considering `mRowValues` and `mRowState`
2554
+ */
2555
+ iExpectedNumberOfRows?: number,
2556
+ /**
2557
+ * Defines the expected state of the target row
2558
+ */
2559
+ mState?: object,
2560
+ /**
2561
+ * Defines the cells of the identified rows which are expected to the hidden (visible=false). You can also
2562
+ * use test function iCheckCells to explicitly check a specific cell of a row.
2563
+ */
2564
+ vHiddenCells?: any[]
2565
+ ): object;
2566
+ /**
2567
+ * Checks the search field in the table toolbar. If the `sSearchText` parameter is `undefined`, the search
2568
+ * text is not validated.
2569
+ *
2570
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function that can be used for chaining statements
2571
+ */
2572
+ iCheckSearchField(
2573
+ /**
2574
+ * The expected text in the search field
2575
+ */
2576
+ sSearchText?: string,
2577
+ /**
2578
+ * Defines the expected state of the search field
2579
+ */
2580
+ mState?: object
2581
+ ): object;
2582
+ /**
2583
+ * Checks a field in the sorting dialog.
2584
+ *
2585
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2586
+ */
2587
+ iCheckSortOrder(
2588
+ /**
2589
+ * The identifier of the column, or its label
2590
+ */
2591
+ vColumnIdentifier: string | ColumnIdentifier,
2592
+ /**
2593
+ * The sort order of the column, default is {@link sap.ui.core.SortOrder.Ascending}
2594
+ */
2595
+ sSortOrder?: SortOrder | keyof typeof SortOrder,
2596
+ /**
2597
+ * Defines if the order is checked via sorting dialog, or via the column itself
2598
+ */
2599
+ bCheckPersonalization?: boolean
2600
+ ): object;
2601
+ /**
2602
+ * Checks the state of the table.
2603
+ *
2604
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2605
+ */
2606
+ iCheckState(
2607
+ /**
2608
+ * Defines the expected state of the table
2609
+ */
2610
+ mState?: object
2611
+ ): object;
2612
+ /**
2613
+ * Checks if the focus is on a table.
2614
+ *
2615
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2616
+ */
2617
+ iSeeFocusOnHeader(): object;
2618
+ /**
2619
+ * Checks if the focus is on a table row.
2620
+ *
2621
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2622
+ */
2623
+ iSeeFocusOnRow(
2624
+ /**
2625
+ * The expected focused row
2626
+ */
2627
+ iRowIndex: number
2628
+ ): object;
2629
+ }
2630
+ }
2631
+
2632
+ declare module "sap/fe/test/JourneyRunner" {
2633
+ import BaseObject from "sap/ui/base/Object";
2634
+
2635
+ import Opa from "sap/ui/test/Opa";
2636
+
2637
+ import Metadata from "sap/ui/base/Metadata";
2638
+
2639
+ /**
2640
+ * A JourneyRunner for executing integration tests with given settings.
2641
+ */
2642
+ export default class JourneyRunner extends BaseObject {
2643
+ /**
2644
+ * Constructs a new JourneyRunner instance.
2645
+ */
2646
+ constructor(
2647
+ /**
2648
+ * The settings object
2649
+ */
2650
+ mSettings?: {
2651
+ /**
2652
+ * The available Opa pages
2653
+ */
2654
+ pages?: object;
2655
+ /**
2656
+ * The Opa configuration applied via {@link sap.ui.test.Opa5#sap.ui.test.Opa5.extendConfig}
2657
+ */
2658
+ opaConfig?: object;
2659
+ /**
2660
+ * The URL to the launching page (usually a FLP.html)
2661
+ */
2662
+ launchUrl?: string;
2663
+ /**
2664
+ * The URL launch parameters
2665
+ */
2666
+ launchParameters?: object;
2667
+ /**
2668
+ * If false (default), only one JourneyRunner is executed at a time
2669
+ */
2670
+ async?: boolean;
2671
+ }
2672
+ );
2673
+
2674
+ /**
2675
+ * Creates a new subclass of class sap.fe.test.JourneyRunner with name `sClassName` and enriches it with
2676
+ * the information contained in `oClassInfo`.
2677
+ *
2678
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
2679
+ *
2680
+ * @returns Created class / constructor function
2681
+ */
2682
+ static extend<T extends Record<string, unknown>>(
2683
+ /**
2684
+ * Name of the class being created
2685
+ */
2686
+ sClassName: string,
2687
+ /**
2688
+ * Object literal with information about the class
2689
+ */
2690
+ oClassInfo?: sap.ClassInfo<T, JourneyRunner>,
2691
+ /**
2692
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2693
+ * used by this class
2694
+ */
2695
+ FNMetaImpl?: Function
2696
+ ): Function;
2697
+ /**
2698
+ * Gets the global journey runner instance.
2699
+ *
2700
+ * @returns The global default {@link sap.fe.test.JourneyRunner} instance
2701
+ */
2702
+ static getDefaultRunner(): object;
2703
+ /**
2704
+ * Returns a metadata object for class sap.fe.test.JourneyRunner.
2705
+ *
2706
+ * @returns Metadata object describing this class
2707
+ */
2708
+ static getMetadata(): Metadata;
2709
+ /**
2710
+ * Static function to run the default runner with given parameters. Shortcut for
2711
+ * ```javascript
2712
+ * JourneyRunner.getDefaultRunner().run(mSettings, Journey1, Journey2, ...)```
2713
+ * See {@link sap.fe.test.JourneyRunner#run} for parameter details.
2714
+ */
2715
+ static run(): void;
2716
+ /**
2717
+ * Sets the global journey runner instance.
2718
+ */
2719
+ static setDefaultRunner(
2720
+ /**
2721
+ * Defines the global default {@link sap.fe.test.JourneyRunner} instance
2722
+ */
2723
+ oDefaultRunner: JourneyRunner
2724
+ ): void;
2725
+ /**
2726
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2727
+ *
2728
+ * Returns the base action instance to be used for {@link sap.ui.test.Opa5#sap.ui.test.Opa5.extendConfig}
2729
+ * `actions` setting.
2730
+ *
2731
+ * This function is only used if `actions` is not defined via the runner settings. It is meant to be overridden
2732
+ * by a custom JourneyRunner implementation to provide custom base actions.
2733
+ *
2734
+ * By default, an instance of {@link sap.fe.test.BaseActions} will be returned.
2735
+ *
2736
+ * @returns An Opa instance for the base actions
2737
+ */
2738
+ getBaseActions(): Opa;
2739
+ /**
2740
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2741
+ *
2742
+ * Returns the base arrangements instance to be used for {@link sap.ui.test.Opa5#sap.ui.test.Opa5.extendConfig}
2743
+ * `arrangements` setting.
2744
+ *
2745
+ * This function is only used if `arrangements` is not defined via the runner settings. It is meant to be
2746
+ * overridden by a custom JourneyRunner implementation to provide custom base assertions.
2747
+ *
2748
+ * By default, an instance of {@link sap.fe.test.BaseArrangements} will be returned.
2749
+ *
2750
+ * @returns An Opa instance for the base arrangements
2751
+ */
2752
+ getBaseArrangements(
2753
+ /**
2754
+ * The settings object of the runner instance
2755
+ */
2756
+ mSettings: object
2757
+ ): Opa;
2758
+ /**
2759
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2760
+ *
2761
+ * Returns the base assertions instance to be used for {@link sap.ui.test.Opa5#sap.ui.test.Opa5.extendConfig}
2762
+ * `assertions` setting.
2763
+ *
2764
+ * This function is only used if `assertions` is not defined via the runner settings. It is meant to be
2765
+ * overridden by a custom JourneyRunner implementation to provide custom base assertions.
2766
+ *
2767
+ * By default, an instance of {@link sap.fe.test.BaseAssertions} will be returned.
2768
+ *
2769
+ * @returns An Opa instance for the base assertions
2770
+ */
2771
+ getBaseAssertions(): Opa;
2772
+ /**
2773
+ * Executes the journeys in the given order.
2774
+ *
2775
+ * The settings provided as first parameter are merged into the base settings of the JourneyRunner instance.
2776
+ *
2777
+ * @returns A `Promise` that is resolved after all tests have been executed
2778
+ */
2779
+ run(
2780
+ /**
2781
+ * The settings object for the tests to run. Overrides instance settings
2782
+ */
2783
+ mSettings: {
2784
+ /**
2785
+ * The available Opa pages
2786
+ */
2787
+ pages?: object;
2788
+ /**
2789
+ * The Opa configuration applied via {@link sap.ui.test.Opa5#sap.ui.test.Opa5.extendConfig}
2790
+ */
2791
+ opaConfig?: object;
2792
+ /**
2793
+ * The URL to the launching page (usually a FLP.html)
2794
+ */
2795
+ launchUrl?: string;
2796
+ /**
2797
+ * The URL launch parameters
2798
+ */
2799
+ launchParameters?: object;
2800
+ /**
2801
+ * If false (default), only one JourneyRunner is executed at a time
2802
+ */
2803
+ async?: boolean;
2804
+ },
2805
+ /**
2806
+ * The journeys to be executed. If a journey is represented as a string, it will be interpreted as a module
2807
+ * path to the file that should be loaded. Else it is expected to be a function. Alternatively, instead
2808
+ * of being wrapped in an array, the journeys can also be given as separate parameters:
2809
+ * ```javascript
2810
+ * .run(mSettings, Journey1, Journey2, ...)```
2811
+ */
2812
+ _vJourneys: Array<() => void> | string[]
2813
+ ): object;
2814
+ /**
2815
+ * Executes the journeys in the given order.
2816
+ *
2817
+ * The settings provided as first parameter are merged into the base settings of the JourneyRunner instance.
2818
+ *
2819
+ * @returns A `Promise` that is resolved after all tests have been executed
2820
+ */
2821
+ run(
2822
+ /**
2823
+ * The journeys to be executed. If a journey is represented as a string, it will be interpreted as a module
2824
+ * path to the file that should be loaded. Else it is expected to be a function. Alternatively, instead
2825
+ * of being wrapped in an array, the journeys can also be given as separate parameters:
2826
+ * ```javascript
2827
+ * .run(mSettings, Journey1, Journey2, ...)```
2828
+ */
2829
+ _vJourneys: Array<() => void> | string[]
2830
+ ): object;
2831
+ }
2832
+ }
2833
+
2834
+ declare module "sap/fe/test/ListReport" {
2835
+ import TemplatePage from "sap/fe/test/TemplatePage";
2836
+
2837
+ import { ViewIdentifier, TableIdentifier } from "sap/fe/test/api/BaseAPI";
2838
+
2839
+ import FilterBarActions from "sap/fe/test/api/FilterBarActions";
2840
+
2841
+ import HeaderActionsLR from "sap/fe/test/api/HeaderActionsLR";
2842
+
2843
+ import TableActions from "sap/fe/test/api/TableActions";
2844
+
2845
+ import FilterBarAssertions from "sap/fe/test/api/FilterBarAssertions";
2846
+
2847
+ import HeaderAssertionsLR from "sap/fe/test/api/HeaderAssertionsLR";
2848
+
2849
+ import TableAssertions from "sap/fe/test/api/TableAssertions";
2850
+
2851
+ /**
2852
+ * Provides a test page definition for a list report page with the corresponding parameters.
2853
+ *
2854
+ * Sample usage:
2855
+ * ```javascript
2856
+ *
2857
+ * var oListReportDefinition = new ListReport({ appId: "MyApp", componentId: "MyListReportId", entitySet: "MyEntitySet" });
2858
+ * ```
2859
+ */
2860
+ export default class ListReport extends TemplatePage {
2861
+ /**
2862
+ * Constructs a new ListReport definition.
2863
+ */
2864
+ constructor(
2865
+ /**
2866
+ * The required parameters
2867
+ */
2868
+ oPageDefinition: {
2869
+ /**
2870
+ * The app id (defined in the manifest root)
2871
+ */
2872
+ appId: string;
2873
+ /**
2874
+ * The component id (defined in the target section for the list report within the manifest)
2875
+ */
2876
+ componentId: string;
2877
+ /**
2878
+ * The entitySet (optional)(defined in the settings of the corresponding target component within the manifest)
2879
+ */
2880
+ entitySet: string;
2881
+ /**
2882
+ * The contextPath (optional)(defined in the settings of the corresponding target component within the manifest)
2883
+ */
2884
+ contextPath: string;
2885
+ },
2886
+ /**
2887
+ * Additional custom page functions, provided in an object containing `actions` and `assertions`
2888
+ */
2889
+ ..._aInAdditionalPageDefinitions: object[]
2890
+ );
2891
+ }
2892
+ /**
2893
+ * ListReport actions
2894
+ */
2895
+ export interface actions {
2896
+ /**
2897
+ * Collapses or expands the page header.
2898
+ *
2899
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2900
+ */
2901
+ iCollapseExpandPageHeader(
2902
+ /**
2903
+ * Defines whether the header should be collapsed, else it is expanded (default)
2904
+ */
2905
+ bCollapse?: boolean
2906
+ ): object;
2907
+ /**
2908
+ * Navigates to or focuses on the defined view of a Multiple Views List Report table.
2909
+ *
2910
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2911
+ */
2912
+ iGoToView(
2913
+ /**
2914
+ * The identifier of a view as defined in the manifest file, or its label passed as a string if passed as
2915
+ * an object, the following pattern will be considered:
2916
+ * ```javascript
2917
+ *
2918
+ * {
2919
+ * key: ,
2920
+ * }
2921
+ * ```
2922
+ * Depending on property 'keepPreviousPersonalization' in the manifest the key could be set different
2923
+ * within the id of the table. If necessary please check the UI control tree within the debugger.
2924
+ */
2925
+ vViewIdentifier: string | ViewIdentifier
2926
+ ): object;
2927
+ /**
2928
+ * Returns a {@link sap.fe.test.api.FilterBarActions} instance.
2929
+ *
2930
+ * @returns The available filter bar actions
2931
+ */
2932
+ onFilterBar(): FilterBarActions;
2933
+ /**
2934
+ * Returns a {@link sap.fe.test.api.HeaderActionsLR} instance.
2935
+ *
2936
+ * @returns The available header actions
2937
+ */
2938
+ onHeader(): HeaderActionsLR;
2939
+ /**
2940
+ * Returns a {@link sap.fe.test.api.TableActions} instance for the specified table.
2941
+ *
2942
+ * @returns The available table actions
2943
+ */
2944
+ onTable(
2945
+ /**
2946
+ * The identifier of the table, or its header title
2947
+ */
2948
+ vTableIdentifier: string | TableIdentifier
2949
+ ): TableActions;
2950
+ }
2951
+ export const actions: actions;
2952
+
2953
+ /**
2954
+ * ListReport assertions
2955
+ */
2956
+ export interface assertions {
2957
+ /**
2958
+ * Checks the view of a Multiple View List Report table.
2959
+ *
2960
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2961
+ */
2962
+ iCheckView(
2963
+ /**
2964
+ * The identifier of a view as defined in the manifest file, or its label passed as a string if passed as
2965
+ * an object, the following pattern will be considered:
2966
+ * ```javascript
2967
+ *
2968
+ * {
2969
+ * key: ,
2970
+ * }
2971
+ * ```
2972
+ * Depending on property 'keepPreviousPersonalization' in the manifest, the key could be set differently
2973
+ * within the id of the table. If necessary please check the UI control tree within the debugger.
2974
+ */
2975
+ vViewIdentifier: string | ViewIdentifier,
2976
+ /**
2977
+ * An object containing properties of the view to be checked Example:
2978
+ * ```javascript
2979
+ *
2980
+ * {
2981
+ * count: ,
2982
+ * }
2983
+ * ```
2984
+ */
2985
+ mState: object
2986
+ ): object;
2987
+ /**
2988
+ * Returns a {@link sap.fe.test.api.FilterBarAssertions} instance.
2989
+ *
2990
+ * @returns The available filter bar assertions
2991
+ */
2992
+ onFilterBar(): FilterBarAssertions;
2993
+ /**
2994
+ * Returns a {@link sap.fe.test.api.HeaderAssertionsLR} instance.
2995
+ *
2996
+ * @returns The available header assertions
2997
+ */
2998
+ onHeader(): HeaderAssertionsLR;
2999
+ /**
3000
+ * Returns a {@link sap.fe.test.api.TableAssertions} instance for the specified table.
3001
+ *
3002
+ * @returns The available table assertions
3003
+ */
3004
+ onTable(
3005
+ /**
3006
+ * The identifier of the table, or its header title
3007
+ */
3008
+ vTableIdentifier: string | TableIdentifier
3009
+ ): TableAssertions;
3010
+ }
3011
+ export const assertions: assertions;
3012
+ }
3013
+
3014
+ declare module "sap/fe/test/ObjectPage" {
3015
+ import TemplatePage from "sap/fe/test/TemplatePage";
3016
+
3017
+ import { SectionIdentifier, TableIdentifier } from "sap/fe/test/api/BaseAPI";
3018
+
3019
+ import FilterBarActions from "sap/fe/test/api/FilterBarActions";
3020
+
3021
+ import FooterActionsOP from "sap/fe/test/api/FooterActionsOP";
3022
+
3023
+ import { FormIdentifier } from "sap/fe/test/api/FormAPI";
3024
+
3025
+ import FormActions from "sap/fe/test/api/FormActions";
3026
+
3027
+ import HeaderActions from "sap/fe/test/api/HeaderActions";
3028
+
3029
+ import TableActions from "sap/fe/test/api/TableActions";
3030
+
3031
+ import FilterBarAssertions from "sap/fe/test/api/FilterBarAssertions";
3032
+
3033
+ import FooterAssertionsOP from "sap/fe/test/api/FooterAssertionsOP";
3034
+
3035
+ import FormAssertions from "sap/fe/test/api/FormAssertions";
3036
+
3037
+ import HeaderAssertions from "sap/fe/test/api/HeaderAssertions";
3038
+
3039
+ import TableAssertions from "sap/fe/test/api/TableAssertions";
3040
+
3041
+ /**
3042
+ * Provides a test page definition for an object page with the corresponding parameters.
3043
+ *
3044
+ * Sample usage:
3045
+ * ```javascript
3046
+ *
3047
+ * var oObjectPageDefinition = new ObjectPage({ appId: "MyApp", componentId: "MyObjectPageId", entitySet: "MyEntitySet" });
3048
+ * ```
3049
+ */
3050
+ export default class ObjectPage extends TemplatePage {
3051
+ /**
3052
+ * Constructs a new ObjectPage instance.
3053
+ */
3054
+ constructor(
3055
+ /**
3056
+ * The required parameters
3057
+ */
3058
+ oPageDefinition: {
3059
+ /**
3060
+ * The app id (defined in the manifest root)
3061
+ */
3062
+ appId: string;
3063
+ /**
3064
+ * The component id (defined in the target section for the list report within the manifest)
3065
+ */
3066
+ componentId: string;
3067
+ /**
3068
+ * The entitySet (defined in the settings of the corresponding target component within the manifest)
3069
+ */
3070
+ entitySet: string;
3071
+ /**
3072
+ * The contextPath (optional)(defined in the settings of the corresponding target component within the manifest)
3073
+ */
3074
+ contextPath: string;
3075
+ },
3076
+ /**
3077
+ * Additional custom page functions, provided in an object containing `actions` and `assertions`
3078
+ */
3079
+ ..._aAdditionalPageDefinitions: object[]
3080
+ );
3081
+ }
3082
+ /**
3083
+ * ObjectPage actions
3084
+ */
3085
+ export interface actions {
3086
+ /**
3087
+ * Collapses or expands the page header.
3088
+ *
3089
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
3090
+ */
3091
+ iCollapseExpandPageHeader(
3092
+ /**
3093
+ * Defines whether header should be collapsed, else it gets expanded (default)
3094
+ */
3095
+ bCollapse?: boolean
3096
+ ): object;
3097
+ /**
3098
+ * Navigates to or focuses on the defined section.
3099
+ *
3100
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
3101
+ */
3102
+ iGoToSection(
3103
+ /**
3104
+ * The identifier of a section, or its label if passed as an object, the following pattern will be considered:
3105
+ *
3106
+ * ```javascript
3107
+ *
3108
+ * {
3109
+ * section: ,
3110
+ * subSection:
3111
+ * }
3112
+ * ```
3113
+ * to open the editable header section use pattern:
3114
+ * ```javascript
3115
+ *
3116
+ * {
3117
+ * section: "EditableHeaderSection"
3118
+ * }
3119
+ * ```
3120
+ */
3121
+ vSectionIdentifier: string | SectionIdentifier
3122
+ ): object;
3123
+ /**
3124
+ * Returns a {@link sap.fe.test.api.FilterBarActions} instance.
3125
+ *
3126
+ * @returns The available filter bar actions
3127
+ */
3128
+ onFilterBar(
3129
+ /**
3130
+ * The identifier of the filterbar
3131
+ */
3132
+ vFilterBarIdentifier: /* was: sap.fe.test.api.FilterBarIdentifier */
3133
+ | any
3134
+ | string
3135
+ ): FilterBarActions;
3136
+ /**
3137
+ * Returns a {@link sap.fe.test.api.FooterActionsOP} instance.
3138
+ *
3139
+ * @returns The available footer actions
3140
+ */
3141
+ onFooter(): FooterActionsOP;
3142
+ /**
3143
+ * Returns a {@link sap.fe.test.api.FormActions} instance.
3144
+ *
3145
+ * @returns The available form actions
3146
+ */
3147
+ onForm(
3148
+ /**
3149
+ * The identifier of the form, or its title
3150
+ */
3151
+ vFormIdentifier: FormIdentifier | string
3152
+ ): FormActions;
3153
+ /**
3154
+ * Returns a {@link sap.fe.test.api.HeaderActions} instance.
3155
+ *
3156
+ * @returns The available header actions
3157
+ */
3158
+ onHeader(): HeaderActions;
3159
+ /**
3160
+ * Returns a {@link sap.fe.test.api.TableActions} instance for the specified table.
3161
+ *
3162
+ * @returns The available table actions
3163
+ */
3164
+ onTable(
3165
+ /**
3166
+ * The identifier of the table, or its header title
3167
+ */
3168
+ vTableIdentifier: string | TableIdentifier
3169
+ ): TableActions;
3170
+ }
3171
+ export const actions: actions;
3172
+
3173
+ /**
3174
+ * ObjectPage assertions
3175
+ */
3176
+ export interface assertions {
3177
+ /**
3178
+ * Returns a {@link sap.fe.test.api.FilterBarAssertions} instance.
3179
+ *
3180
+ * @returns The available filter bar assertions
3181
+ */
3182
+ onFilterBar(
3183
+ /**
3184
+ * The identifier of the filterbar
3185
+ */
3186
+ vFilterBarIdentifier: /* was: sap.fe.test.api.FilterBarIdentifier */
3187
+ | any
3188
+ | string
3189
+ ): FilterBarAssertions;
3190
+ /**
3191
+ * Returns a {@link sap.fe.test.api.FooterAssertionsOP} instance.
3192
+ *
3193
+ * @returns The available footer assertions
3194
+ */
3195
+ onFooter(): FooterAssertionsOP;
3196
+ /**
3197
+ * Returns a {@link sap.fe.test.api.FormAssertions} instance.
3198
+ *
3199
+ * @returns The available form actions
3200
+ */
3201
+ onForm(
3202
+ /**
3203
+ * The identifier of the form, or its title
3204
+ */
3205
+ vFormIdentifier: FormIdentifier | string
3206
+ ): FormAssertions;
3207
+ /**
3208
+ * Returns a {@link sap.fe.test.api.HeaderAssertions} instance.
3209
+ *
3210
+ * @returns The available header assertions
3211
+ */
3212
+ onHeader(): HeaderAssertions;
3213
+ /**
3214
+ * Returns a {@link sap.fe.test.api.TableAssertions} instance for the specified table.
3215
+ *
3216
+ * @returns The available table assertions
3217
+ */
3218
+ onTable(
3219
+ /**
3220
+ * The identifier of the table, or its header title
3221
+ */
3222
+ vTableIdentifier: string | TableIdentifier
3223
+ ): TableAssertions;
3224
+ }
3225
+ export const assertions: assertions;
3226
+ }
3227
+
3228
+ declare module "sap/fe/test/Shell" {
3229
+ /**
3230
+ * Provides a test page definition for the shell.
3231
+ *
3232
+ * When using {@link sap.fe.test.JourneyRunner}, this page is made available by default via `onTheShell`.
3233
+ */
3234
+ export default class Shell {
3235
+ /**
3236
+ * Constructs a test page definition for the shell.
3237
+ */
3238
+ constructor(
3239
+ /**
3240
+ * Additional custom page functions, provided in an object containing `actions` and `assertions`
3241
+ */
3242
+ ...aAdditionalPageDefinitions: object[]
3243
+ );
3244
+
3245
+ /**
3246
+ * Check an intent-based navigation. The function checks the semantic object and the action within the URL
3247
+ * of an application. Optionally, further URL parameters can be checked.
3248
+ *
3249
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
3250
+ */
3251
+ iCheckIntentBasedNavigation(
3252
+ /**
3253
+ * The semantic object of the application
3254
+ */
3255
+ sSemanticObject: string,
3256
+ /**
3257
+ * The action of the application
3258
+ */
3259
+ sAction: string,
3260
+ /**
3261
+ * More URL parameters to be checked. The pattern is:
3262
+ * ```javascript
3263
+ *
3264
+ * [{
3265
+ * property: <expected name of URL parameter>,
3266
+ * value: <expected value of URL parameter>
3267
+ * }]
3268
+ * ```
3269
+ */
3270
+ aURLParams?: any[]
3271
+ ): object;
3272
+ /**
3273
+ * Navigates back via shell back button.
3274
+ *
3275
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
3276
+ */
3277
+ iNavigateBack(): object;
3278
+ /**
3279
+ * Navigates to the launch pad via the home button.
3280
+ *
3281
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
3282
+ */
3283
+ iNavigateHome(): object;
3284
+ /**
3285
+ * Navigates via a navigation item in the shell's navigation menu.
3286
+ *
3287
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
3288
+ */
3289
+ iNavigateViaMenu(
3290
+ /**
3291
+ * The label of the navigation item
3292
+ */
3293
+ sItem: string
3294
+ ): object;
3295
+ /**
3296
+ * Opens the navigation menu in the shell header.
3297
+ *
3298
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
3299
+ */
3300
+ iOpenNavigationMenu(
3301
+ /**
3302
+ * The title of the navigation menu to be clicked. If undefined the menu is identified by the internal id
3303
+ * only.
3304
+ */
3305
+ NavigationTitle?: string
3306
+ ): object;
3307
+ /**
3308
+ * Selecting a tile in the launchpad by its target app, for example `iPressTile("SalesOrder-manage")`.
3309
+ *
3310
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
3311
+ */
3312
+ iPressTile(
3313
+ /**
3314
+ * The target application (hash)
3315
+ */
3316
+ sTarget: string
3317
+ ): object;
3318
+ }
3319
+ }
3320
+
3321
+ declare module "sap/fe/test/TemplatePage" {
3322
+ import DialogActions from "sap/fe/test/api/DialogActions";
3323
+
3324
+ import DialogCreateActions from "sap/fe/test/api/DialogCreateActions";
3325
+
3326
+ import { DialogIdentifier } from "sap/fe/test/api/BaseAPI";
3327
+
3328
+ import DialogMessageActions from "sap/fe/test/api/DialogMessageActions";
3329
+
3330
+ import DialogValueHelpActions from "sap/fe/test/api/DialogValueHelpActions";
3331
+
3332
+ import DialogAssertions from "sap/fe/test/api/DialogAssertions";
3333
+
3334
+ import DialogCreateAssertions from "sap/fe/test/api/DialogCreateAssertions";
3335
+
3336
+ import DialogMessageAssertions from "sap/fe/test/api/DialogMessageAssertions";
3337
+
3338
+ import DialogValueHelpAssertions from "sap/fe/test/api/DialogValueHelpAssertions";
3339
+
3340
+ /**
3341
+ * Provides a test page definition for a template page with the corresponding parameters.
3342
+ */
3343
+ export default class TemplatePage {
3344
+ constructor();
3345
+ }
3346
+ /**
3347
+ * TemplatePage actions
3348
+ */
3349
+ export interface actions {
3350
+ /**
3351
+ * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.Action })`.
3352
+ *
3353
+ * @returns The available dialog actions
3354
+ */
3355
+ onActionDialog(): DialogActions;
3356
+ /**
3357
+ * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.Confirmation })`.
3358
+ *
3359
+ * @returns The available dialog actions
3360
+ */
3361
+ onConfirmationDialog(): DialogActions;
3362
+ /**
3363
+ * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.Create })`.
3364
+ *
3365
+ * @returns The available dialog actions
3366
+ */
3367
+ onCreateDialog(): DialogCreateActions;
3368
+ /**
3369
+ * Returns a {@link sap.fe.test.api.DialogActions} instance.
3370
+ *
3371
+ * @returns The available dialog actions
3372
+ */
3373
+ onDialog(
3374
+ /**
3375
+ * The identifier of the dialog, or its title
3376
+ */
3377
+ vDialogIdentifier: string | DialogIdentifier
3378
+ ): DialogActions;
3379
+ /**
3380
+ * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.Error })`.
3381
+ *
3382
+ * @returns The available dialog actions
3383
+ */
3384
+ onErrorDialog(): DialogActions;
3385
+ /**
3386
+ * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.Message })`.
3387
+ *
3388
+ * @returns The available dialog actions
3389
+ */
3390
+ onMessageDialog(): DialogMessageActions;
3391
+ /**
3392
+ * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.ValueHelp })`.
3393
+ *
3394
+ * @returns The available dialog actions
3395
+ */
3396
+ onValueHelpDialog(): DialogValueHelpActions;
3397
+ }
3398
+ export const actions: actions;
3399
+
3400
+ /**
3401
+ * Assertions that are available to all template pages used in SAP Fiori elements.
3402
+ */
3403
+ export interface assertions {
3404
+ /**
3405
+ * Confirms the visibility of the current page.
3406
+ *
3407
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
3408
+ */
3409
+ iSeeThisPage(): object;
3410
+ /**
3411
+ * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.Action })`.
3412
+ *
3413
+ * @returns The available dialog assertions
3414
+ */
3415
+ onActionDialog(): DialogAssertions;
3416
+ /**
3417
+ * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.Confirmation })`.
3418
+ *
3419
+ * @returns The available dialog assertions
3420
+ */
3421
+ onConfirmationDialog(): DialogAssertions;
3422
+ /**
3423
+ * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.Create })`.
3424
+ *
3425
+ * @returns The available dialog assertions
3426
+ */
3427
+ onCreateDialog(): DialogCreateAssertions;
3428
+ /**
3429
+ * Returns a {@link sap.fe.test.api.DialogAssertions} instance.
3430
+ *
3431
+ * @returns The available dialog actions
3432
+ */
3433
+ onDialog(
3434
+ /**
3435
+ * The identifier of the dialog, or its title
3436
+ */
3437
+ vDialogIdentifier: string | DialogIdentifier
3438
+ ): DialogAssertions;
3439
+ /**
3440
+ * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.Error })`.
3441
+ *
3442
+ * @returns The available dialog assertions
3443
+ */
3444
+ onErrorDialog(): DialogAssertions;
3445
+ /**
3446
+ * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.Message })`.
3447
+ *
3448
+ * @returns The available dialog assertions
3449
+ */
3450
+ onMessageDialog(): DialogMessageAssertions;
3451
+ /**
3452
+ * Shortcut for `onDialog({ type: sap.fe.test.api.DialogType.ValueHelp })`.
3453
+ *
3454
+ * @returns The available dialog assertions
3455
+ */
3456
+ onValueHelpDialog(): DialogValueHelpAssertions;
3457
+ }
3458
+ export const assertions: assertions;
3459
+ }
3460
+
3461
+ declare namespace sap {
3462
+ interface IUI5DefineDependencyNames {
3463
+ "sap/fe/test/api/BaseAPI": undefined;
3464
+
3465
+ "sap/fe/test/api/DialogActions": undefined;
3466
+
3467
+ "sap/fe/test/api/DialogAssertions": undefined;
3468
+
3469
+ "sap/fe/test/api/DialogCreateActions": undefined;
3470
+
3471
+ "sap/fe/test/api/DialogCreateAssertions": undefined;
3472
+
3473
+ "sap/fe/test/api/DialogMessageActions": undefined;
3474
+
3475
+ "sap/fe/test/api/DialogMessageAssertions": undefined;
3476
+
3477
+ "sap/fe/test/api/DialogType": undefined;
3478
+
3479
+ "sap/fe/test/api/DialogValueHelpActions": undefined;
3480
+
3481
+ "sap/fe/test/api/DialogValueHelpAssertions": undefined;
3482
+
3483
+ "sap/fe/test/api/EditState": undefined;
3484
+
3485
+ "sap/fe/test/api/FilterBarActions": undefined;
3486
+
3487
+ "sap/fe/test/api/FilterBarAPI": undefined;
3488
+
3489
+ "sap/fe/test/api/FilterBarAssertions": undefined;
3490
+
3491
+ "sap/fe/test/api/FooterActionsBase": undefined;
3492
+
3493
+ "sap/fe/test/api/FooterActionsOP": undefined;
3494
+
3495
+ "sap/fe/test/api/FooterAssertionsBase": undefined;
3496
+
3497
+ "sap/fe/test/api/FooterAssertionsOP": undefined;
3498
+
3499
+ "sap/fe/test/api/FormActions": undefined;
3500
+
3501
+ "sap/fe/test/api/FormAPI": undefined;
3502
+
3503
+ "sap/fe/test/api/FormAssertions": undefined;
3504
+
3505
+ "sap/fe/test/api/HeaderActions": undefined;
3506
+
3507
+ "sap/fe/test/api/HeaderActionsLR": undefined;
3508
+
3509
+ "sap/fe/test/api/HeaderAPI": undefined;
3510
+
3511
+ "sap/fe/test/api/HeaderAssertions": undefined;
3512
+
3513
+ "sap/fe/test/api/HeaderAssertionsLR": undefined;
3514
+
3515
+ "sap/fe/test/api/TableActions": undefined;
3516
+
3517
+ "sap/fe/test/api/TableAPI": undefined;
3518
+
3519
+ "sap/fe/test/api/TableAssertions": undefined;
3520
+
3521
+ "sap/fe/test/JourneyRunner": undefined;
3522
+
3523
+ "sap/fe/test/library": undefined;
3524
+
3525
+ "sap/fe/test/ListReport": undefined;
3526
+
3527
+ "sap/fe/test/ObjectPage": undefined;
3528
+
3529
+ "sap/fe/test/Shell": undefined;
3530
+
3531
+ "sap/fe/test/TemplatePage": undefined;
3532
+ }
3533
+ }