@openui5/ts-types-esm 1.99.1 → 1.102.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,60 @@
1
- // For Library Version: 1.99.1
1
+ // For Library Version: 1.102.0
2
+
3
+ declare module "sap/ui/mdc/filterbar/vh/FilterContainer" {
4
+ import Metadata from "sap/ui/base/Metadata";
5
+
6
+ /**
7
+ * @SINCE 1.84.0
8
+ *
9
+ * The FilterContainer is a IFilterContainer implementation for `AlignedFlowLayout`
10
+ */
11
+ export default class FilterContainer
12
+ /* was: sap.ui.mdc.filterbar.IFilterContainer */ extends Object {
13
+ /**
14
+ * Constructor for a new filterBar/vh/FilterContainer.
15
+ *
16
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
17
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
18
+ * of the syntax of the settings object.
19
+ */
20
+ constructor(
21
+ /**
22
+ * ID for the new control, generated automatically if no ID is given
23
+ */
24
+ sId?: string
25
+ );
26
+
27
+ /**
28
+ * Creates a new subclass of class sap.ui.mdc.filterbar.vh.FilterContainer with name `sClassName` and enriches
29
+ * it with the information contained in `oClassInfo`.
30
+ *
31
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.mdc.filterbar.IFilterContainer.extend}.
32
+ *
33
+ * @returns Created class / constructor function
34
+ */
35
+ static extend<T extends Record<string, unknown>>(
36
+ /**
37
+ * Name of the class being created
38
+ */
39
+ sClassName: string,
40
+ /**
41
+ * Object literal with information about the class
42
+ */
43
+ oClassInfo?: sap.ClassInfo<T, FilterContainer>,
44
+ /**
45
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
46
+ * used by this class
47
+ */
48
+ FNMetaImpl?: Function
49
+ ): Function;
50
+ /**
51
+ * Returns a metadata object for class sap.ui.mdc.filterbar.vh.FilterContainer.
52
+ *
53
+ * @returns Metadata object describing this class
54
+ */
55
+ static getMetadata(): Metadata;
56
+ }
57
+ }
2
58
 
3
59
  declare namespace sap {
4
60
  interface IUI5DefineDependencyNames {
@@ -52,6 +108,8 @@ declare namespace sap {
52
108
 
53
109
  "sap/ui/mdc/enum/PersistenceMode": undefined;
54
110
 
111
+ "sap/ui/mdc/enum/PropagationReason": undefined;
112
+
55
113
  "sap/ui/mdc/enum/SelectType": undefined;
56
114
 
57
115
  "sap/ui/mdc/Field": undefined;
@@ -118,10 +176,18 @@ declare namespace sap {
118
176
 
119
177
  "sap/ui/mdc/FilterBar": undefined;
120
178
 
179
+ "sap/ui/mdc/filterbar/aligned/FilterContainer": undefined;
180
+
181
+ "sap/ui/mdc/filterbar/aligned/FilterItemLayout": undefined;
182
+
121
183
  "sap/ui/mdc/filterbar/FilterBarBase": undefined;
122
184
 
123
185
  "sap/ui/mdc/filterbar/vh/CollectiveSearchSelect": undefined;
124
186
 
187
+ "sap/ui/mdc/filterbar/vh/FilterBar": undefined;
188
+
189
+ "sap/ui/mdc/filterbar/vh/FilterContainer": undefined;
190
+
125
191
  "sap/ui/mdc/FilterBarDelegate": undefined;
126
192
 
127
193
  "sap/ui/mdc/FilterField": undefined;
@@ -140,6 +206,8 @@ declare namespace sap {
140
206
 
141
207
  "sap/ui/mdc/mixin/PromiseMixin": undefined;
142
208
 
209
+ "sap/ui/mdc/mixin/PropertyHelperMixin": undefined;
210
+
143
211
  "sap/ui/mdc/MultiValueField": undefined;
144
212
 
145
213
  "sap/ui/mdc/odata/v4/FieldBaseDelegate": undefined;
@@ -148,6 +216,8 @@ declare namespace sap {
148
216
 
149
217
  "sap/ui/mdc/odata/v4/TableDelegate": undefined;
150
218
 
219
+ "sap/ui/mdc/odata/v4/ValueHelpDelegate": undefined;
220
+
151
221
  "sap/ui/mdc/p13n/AdaptationProvider": undefined;
152
222
 
153
223
  "sap/ui/mdc/p13n/Engine": undefined;
@@ -174,6 +244,8 @@ declare namespace sap {
174
244
 
175
245
  "sap/ui/mdc/table/ResponsiveTableType": undefined;
176
246
 
247
+ "sap/ui/mdc/table/RowActionItem": undefined;
248
+
177
249
  "sap/ui/mdc/table/RowSettings": undefined;
178
250
 
179
251
  "sap/ui/mdc/table/TableTypeBase": undefined;
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.99.1
1
+ // For Library Version: 1.102.0
2
2
 
3
3
  declare module "sap/ui/rta/api/startAdaptation" {
4
4
  import Control from "sap/ui/core/Control";
@@ -12,6 +12,8 @@ declare module "sap/ui/rta/api/startAdaptation" {
12
12
  * Starts UI adaptation, initiated for an application at the passed root control instance. With this API
13
13
  * you are also able to modify the UI adaptation plugins list and or add some event handler functions to
14
14
  * be called on start, failed and stop events.
15
+ *
16
+ * @returns Resolves when UI adaptation was successfully started
15
17
  */
16
18
  export default function startAdaptation(
17
19
  /**
@@ -67,6 +69,8 @@ declare module "sap/ui/rta/api/startKeyUserAdaptation" {
67
69
  *
68
70
  * Starts key user adaptation, initiated for an application at the passed root control instance. It subsequently
69
71
  * extends to all valid child controls.
72
+ *
73
+ * @returns Resolves when UI adaptation was successfully started
70
74
  */
71
75
  export default function startKeyUserAdaptation(
72
76
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.99.1
1
+ // For Library Version: 1.102.0
2
2
 
3
3
  declare module "sap/ui/suite/library" {
4
4
  /**
@@ -79,6 +79,8 @@ declare module "sap/ui/suite/TaskCircle" {
79
79
  * information contained in `oClassInfo`.
80
80
  *
81
81
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
82
+ *
83
+ * @returns Created class / constructor function
82
84
  */
83
85
  static extend<T extends Record<string, unknown>>(
84
86
  /**
@@ -97,10 +99,14 @@ declare module "sap/ui/suite/TaskCircle" {
97
99
  ): Function;
98
100
  /**
99
101
  * Returns a metadata object for class sap.ui.suite.TaskCircle.
102
+ *
103
+ * @returns Metadata object describing this class
100
104
  */
101
105
  static getMetadata(): ElementMetadata;
102
106
  /**
103
107
  * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
108
+ *
109
+ * @returns Reference to `this` in order to allow method chaining
104
110
  */
105
111
  addAriaDescribedBy(
106
112
  /**
@@ -110,6 +116,8 @@ declare module "sap/ui/suite/TaskCircle" {
110
116
  ): this;
111
117
  /**
112
118
  * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
119
+ *
120
+ * @returns Reference to `this` in order to allow method chaining
113
121
  */
114
122
  addAriaLabelledBy(
115
123
  /**
@@ -124,6 +132,8 @@ declare module "sap/ui/suite/TaskCircle" {
124
132
  * otherwise it will be bound to this `sap.ui.suite.TaskCircle` itself.
125
133
  *
126
134
  * Event is fired when the user clicks the control.
135
+ *
136
+ * @returns Reference to `this` in order to allow method chaining
127
137
  */
128
138
  attachPress(
129
139
  /**
@@ -147,6 +157,8 @@ declare module "sap/ui/suite/TaskCircle" {
147
157
  * otherwise it will be bound to this `sap.ui.suite.TaskCircle` itself.
148
158
  *
149
159
  * Event is fired when the user clicks the control.
160
+ *
161
+ * @returns Reference to `this` in order to allow method chaining
150
162
  */
151
163
  attachPress(
152
164
  /**
@@ -162,6 +174,8 @@ declare module "sap/ui/suite/TaskCircle" {
162
174
  * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.ui.suite.TaskCircle`.
163
175
  *
164
176
  * The passed function and listener object must match the ones used for event registration.
177
+ *
178
+ * @returns Reference to `this` in order to allow method chaining
165
179
  */
166
180
  detachPress(
167
181
  /**
@@ -175,6 +189,8 @@ declare module "sap/ui/suite/TaskCircle" {
175
189
  ): this;
176
190
  /**
177
191
  * Fires event {@link #event:press press} to attached listeners.
192
+ *
193
+ * @returns Reference to `this` in order to allow method chaining
178
194
  */
179
195
  firePress(
180
196
  /**
@@ -202,6 +218,8 @@ declare module "sap/ui/suite/TaskCircle" {
202
218
  * Color of the circle. The default color is red.
203
219
  *
204
220
  * Default value is `Gray`.
221
+ *
222
+ * @returns Value of property `color`
205
223
  */
206
224
  getColor(): TaskCircleColor | keyof typeof TaskCircleColor;
207
225
  /**
@@ -210,6 +228,8 @@ declare module "sap/ui/suite/TaskCircle" {
210
228
  * Upper limit of the displayed values. Default is 100.
211
229
  *
212
230
  * Default value is `100`.
231
+ *
232
+ * @returns Value of property `maxValue`
213
233
  */
214
234
  getMaxValue(): int;
215
235
  /**
@@ -218,6 +238,8 @@ declare module "sap/ui/suite/TaskCircle" {
218
238
  * Lower limit of the displayed values. Default is 0.
219
239
  *
220
240
  * Default value is `0`.
241
+ *
242
+ * @returns Value of property `minValue`
221
243
  */
222
244
  getMinValue(): int;
223
245
  /**
@@ -227,18 +249,26 @@ declare module "sap/ui/suite/TaskCircle" {
227
249
  * it controls the size of the circle.
228
250
  *
229
251
  * Default value is `0`.
252
+ *
253
+ * @returns Value of property `value`
230
254
  */
231
255
  getValue(): int;
232
256
  /**
233
257
  * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
258
+ *
259
+ * @returns An array of the removed elements (might be empty)
234
260
  */
235
261
  removeAllAriaDescribedBy(): ID[];
236
262
  /**
237
263
  * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
264
+ *
265
+ * @returns An array of the removed elements (might be empty)
238
266
  */
239
267
  removeAllAriaLabelledBy(): ID[];
240
268
  /**
241
269
  * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
270
+ *
271
+ * @returns The removed ariaDescribedBy or `null`
242
272
  */
243
273
  removeAriaDescribedBy(
244
274
  /**
@@ -248,6 +278,8 @@ declare module "sap/ui/suite/TaskCircle" {
248
278
  ): ID;
249
279
  /**
250
280
  * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
281
+ *
282
+ * @returns The removed ariaLabelledBy or `null`
251
283
  */
252
284
  removeAriaLabelledBy(
253
285
  /**
@@ -263,6 +295,8 @@ declare module "sap/ui/suite/TaskCircle" {
263
295
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
264
296
  *
265
297
  * Default value is `Gray`.
298
+ *
299
+ * @returns Reference to `this` in order to allow method chaining
266
300
  */
267
301
  setColor(
268
302
  /**
@@ -278,6 +312,8 @@ declare module "sap/ui/suite/TaskCircle" {
278
312
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
279
313
  *
280
314
  * Default value is `100`.
315
+ *
316
+ * @returns Reference to `this` in order to allow method chaining
281
317
  */
282
318
  setMaxValue(
283
319
  /**
@@ -293,6 +329,8 @@ declare module "sap/ui/suite/TaskCircle" {
293
329
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
294
330
  *
295
331
  * Default value is `0`.
332
+ *
333
+ * @returns Reference to `this` in order to allow method chaining
296
334
  */
297
335
  setMinValue(
298
336
  /**
@@ -309,6 +347,8 @@ declare module "sap/ui/suite/TaskCircle" {
309
347
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
310
348
  *
311
349
  * Default value is `0`.
350
+ *
351
+ * @returns Reference to `this` in order to allow method chaining
312
352
  */
313
353
  setValue(
314
354
  /**
@@ -323,24 +363,25 @@ declare module "sap/ui/suite/TaskCircle" {
323
363
  * Current value of the task circle to be displayed. In dependency of the parameters maxValue and minValue
324
364
  * it controls the size of the circle.
325
365
  */
326
- value?: int | PropertyBindingInfo;
366
+ value?: int | PropertyBindingInfo | `{${string}}`;
327
367
 
328
368
  /**
329
369
  * Upper limit of the displayed values. Default is 100.
330
370
  */
331
- maxValue?: int | PropertyBindingInfo;
371
+ maxValue?: int | PropertyBindingInfo | `{${string}}`;
332
372
 
333
373
  /**
334
374
  * Lower limit of the displayed values. Default is 0.
335
375
  */
336
- minValue?: int | PropertyBindingInfo;
376
+ minValue?: int | PropertyBindingInfo | `{${string}}`;
337
377
 
338
378
  /**
339
379
  * Color of the circle. The default color is red.
340
380
  */
341
381
  color?:
342
382
  | (TaskCircleColor | keyof typeof TaskCircleColor)
343
- | PropertyBindingInfo;
383
+ | PropertyBindingInfo
384
+ | `{${string}}`;
344
385
 
345
386
  /**
346
387
  * Association to controls / ids which label this control (see WAI-ARIA attribute aria-labelledby).
@@ -413,6 +454,8 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
413
454
  * it with the information contained in `oClassInfo`.
414
455
  *
415
456
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
457
+ *
458
+ * @returns Created class / constructor function
416
459
  */
417
460
  static extend<T extends Record<string, unknown>>(
418
461
  /**
@@ -431,10 +474,14 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
431
474
  ): Function;
432
475
  /**
433
476
  * Returns a metadata object for class sap.ui.suite.VerticalProgressIndicator.
477
+ *
478
+ * @returns Metadata object describing this class
434
479
  */
435
480
  static getMetadata(): ElementMetadata;
436
481
  /**
437
482
  * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
483
+ *
484
+ * @returns Reference to `this` in order to allow method chaining
438
485
  */
439
486
  addAriaDescribedBy(
440
487
  /**
@@ -444,6 +491,8 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
444
491
  ): this;
445
492
  /**
446
493
  * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
494
+ *
495
+ * @returns Reference to `this` in order to allow method chaining
447
496
  */
448
497
  addAriaLabelledBy(
449
498
  /**
@@ -458,6 +507,8 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
458
507
  * otherwise it will be bound to this `sap.ui.suite.VerticalProgressIndicator` itself.
459
508
  *
460
509
  * Event is fired when the user clicks the control.
510
+ *
511
+ * @returns Reference to `this` in order to allow method chaining
461
512
  */
462
513
  attachPress(
463
514
  /**
@@ -482,6 +533,8 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
482
533
  * otherwise it will be bound to this `sap.ui.suite.VerticalProgressIndicator` itself.
483
534
  *
484
535
  * Event is fired when the user clicks the control.
536
+ *
537
+ * @returns Reference to `this` in order to allow method chaining
485
538
  */
486
539
  attachPress(
487
540
  /**
@@ -498,6 +551,8 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
498
551
  * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.ui.suite.VerticalProgressIndicator`.
499
552
  *
500
553
  * The passed function and listener object must match the ones used for event registration.
554
+ *
555
+ * @returns Reference to `this` in order to allow method chaining
501
556
  */
502
557
  detachPress(
503
558
  /**
@@ -511,6 +566,8 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
511
566
  ): this;
512
567
  /**
513
568
  * Fires event {@link #event:press press} to attached listeners.
569
+ *
570
+ * @returns Reference to `this` in order to allow method chaining
514
571
  */
515
572
  firePress(
516
573
  /**
@@ -537,18 +594,26 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
537
594
  *
538
595
  * The numerical value between 0 and 100 which determines the height of the vertical bar. Values higher
539
596
  * than 100 will be displayed as 100%, values lower than zero will be displayed as 0%.
597
+ *
598
+ * @returns Value of property `percentage`
540
599
  */
541
600
  getPercentage(): int;
542
601
  /**
543
602
  * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
603
+ *
604
+ * @returns An array of the removed elements (might be empty)
544
605
  */
545
606
  removeAllAriaDescribedBy(): ID[];
546
607
  /**
547
608
  * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
609
+ *
610
+ * @returns An array of the removed elements (might be empty)
548
611
  */
549
612
  removeAllAriaLabelledBy(): ID[];
550
613
  /**
551
614
  * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
615
+ *
616
+ * @returns The removed ariaDescribedBy or `null`
552
617
  */
553
618
  removeAriaDescribedBy(
554
619
  /**
@@ -558,6 +623,8 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
558
623
  ): ID;
559
624
  /**
560
625
  * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
626
+ *
627
+ * @returns The removed ariaLabelledBy or `null`
561
628
  */
562
629
  removeAriaLabelledBy(
563
630
  /**
@@ -569,6 +636,8 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
569
636
  * Property setter for the Percentage, which determines the height of the vertical bar. Values higher than
570
637
  * 100 will be displayed as 100%, values lower than zero will be displayed as 0%. A new rendering is not
571
638
  * necessary, only the bar will be moved
639
+ *
640
+ * @returns `this` to allow method chaining
572
641
  */
573
642
  setPercentage(iPercentage: int): this;
574
643
  }
@@ -578,7 +647,7 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
578
647
  * The numerical value between 0 and 100 which determines the height of the vertical bar. Values higher
579
648
  * than 100 will be displayed as 100%, values lower than zero will be displayed as 0%.
580
649
  */
581
- percentage?: int | PropertyBindingInfo;
650
+ percentage?: int | PropertyBindingInfo | `{${string}}`;
582
651
 
583
652
  /**
584
653
  * Association to controls / ids which label this control (see WAI-ARIA attribute aria-labelledby).
@@ -1,8 +1,8 @@
1
- // For Library Version: 1.99.1
1
+ // For Library Version: 1.102.0
2
2
 
3
3
  declare module "sap/ui/support/library" {
4
4
  /**
5
- * @SINCE 1.99.1
5
+ * @SINCE 1.50
6
6
  *
7
7
  * Defines the Audiences.
8
8
  */
@@ -21,7 +21,7 @@ declare module "sap/ui/support/library" {
21
21
  Internal = "Internal",
22
22
  }
23
23
  /**
24
- * @SINCE 1.99.1
24
+ * @SINCE 1.50
25
25
  *
26
26
  * Issue Categories.
27
27
  */
@@ -43,6 +43,8 @@ declare module "sap/ui/support/library" {
43
43
  */
44
44
  DataModel = "DataModel",
45
45
  /**
46
+ * @SINCE 1.58
47
+ *
46
48
  * Fiori Guidelines issue category.
47
49
  */
48
50
  FioriGuidelines = "FioriGuidelines",
@@ -55,6 +57,8 @@ declare module "sap/ui/support/library" {
55
57
  */
56
58
  Memory = "Memory",
57
59
  /**
60
+ * @SINCE 1.60
61
+ *
58
62
  * Modularization issue category.
59
63
  */
60
64
  Modularization = "Modularization",
@@ -76,7 +80,7 @@ declare module "sap/ui/support/library" {
76
80
  Usage = "Usage",
77
81
  }
78
82
  /**
79
- * @SINCE 1.99.1
83
+ * @SINCE 1.58
80
84
  *
81
85
  * Analysis history formats.
82
86
  */
@@ -91,7 +95,7 @@ declare module "sap/ui/support/library" {
91
95
  String = "String",
92
96
  }
93
97
  /**
94
- * @SINCE 1.99.1
98
+ * @SINCE 1.50
95
99
  *
96
100
  * Defines severity types.
97
101
  */
@@ -110,7 +114,7 @@ declare module "sap/ui/support/library" {
110
114
  Medium = "Medium",
111
115
  }
112
116
  /**
113
- * @SINCE 1.99.1
117
+ * @SINCE 1.60
114
118
  *
115
119
  * Contains the available system presets.
116
120
  */
@@ -184,6 +188,8 @@ declare module "sap/ui/support/RuleAnalyzer" {
184
188
  * @SINCE 1.60
185
189
  *
186
190
  * Adds new temporary rule when in silent mode
191
+ *
192
+ * @returns Rule creation status. Possible values are "success" or description of why adding failed.
187
193
  */
188
194
  addRule(
189
195
  /**
@@ -197,6 +203,8 @@ declare module "sap/ui/support/RuleAnalyzer" {
197
203
  *
198
204
  * Allows to choose a particular execution scope - desired part of the UI to be checked and a flexible way
199
205
  * to specify the list of rules to be used.
206
+ *
207
+ * @returns Notifies the finished state by starting the Analyzer
200
208
  */
201
209
  analyze(
202
210
  /**
@@ -231,10 +239,15 @@ declare module "sap/ui/support/RuleAnalyzer" {
231
239
  ): Promise<any>;
232
240
  /**
233
241
  * Returns the history of all executed analyses.
242
+ *
243
+ * @returns Array of history objects in the order of analyses performed. The results of the last analysis
244
+ * are contained in the last element in the array.
234
245
  */
235
246
  getAnalysisHistory(): AnalysisResult[];
236
247
  /**
237
248
  * Returns the history of all executed analyses into formatted output depending on the passed format.
249
+ *
250
+ * @returns All analysis history objects in the correct format.
238
251
  */
239
252
  getFormattedAnalysisHistory(
240
253
  /**
@@ -244,6 +257,8 @@ declare module "sap/ui/support/RuleAnalyzer" {
244
257
  ): any;
245
258
  /**
246
259
  * Returns the result of the last analysis performed.
260
+ *
261
+ * @returns Last analysis history.
247
262
  */
248
263
  getLastAnalysisHistory(): AnalysisResult;
249
264
  }
@@ -264,12 +279,6 @@ declare namespace sap {
264
279
  namespace support {
265
280
  export const CoreFacade: undefined;
266
281
 
267
- /**
268
- * Overview: These channels enable the user to hook to the {@link sap.ui.support.WindowCommunicationBus
269
- * } Usage: These channels are used for communication with Main.
270
- */
271
- export const WCBChannels: undefined;
272
-
273
282
  /**
274
283
  * Creates a RuleSet. The RuleSet can store multiple rules concerning namespaces. Usage: The RuleSet is
275
284
  * an interface used to create, update and delete rulesets.
@@ -277,6 +286,8 @@ declare namespace sap {
277
286
  namespace RuleSet {
278
287
  /**
279
288
  * Adds rules to RuleSet.
289
+ *
290
+ * @returns sRuleVerificationStatus Verification status
280
291
  */
281
292
  function addRule(
282
293
  /**
@@ -290,6 +301,8 @@ declare namespace sap {
290
301
  function clearAllRuleSets(): void;
291
302
  /**
292
303
  * Gets all rules from the RuleSet.
304
+ *
305
+ * @returns All rules within the current RuleSet
293
306
  */
294
307
  function getRules(): object;
295
308
  /**
@@ -322,6 +335,8 @@ declare namespace sap {
322
335
  ): void;
323
336
  /**
324
337
  * Updates rules from the RuleSet.
338
+ *
339
+ * @returns sRuleVerification Rule Verification status
325
340
  */
326
341
  function updateRule(
327
342
  /**
@@ -357,6 +372,10 @@ declare namespace sap {
357
372
  class ExecutionScope {
358
373
  constructor();
359
374
 
375
+ /**
376
+ *
377
+ * @returns Array of matched elements
378
+ */
360
379
  static getElements(
361
380
  /**
362
381
  * Object with specific filtering options
@@ -378,6 +397,8 @@ declare namespace sap {
378
397
  ): any[];
379
398
  /**
380
399
  * Gets elements by their type
400
+ *
401
+ * @returns Array of matched elements
381
402
  */
382
403
  static getElementsByClassName(
383
404
  /**
@@ -387,6 +408,8 @@ declare namespace sap {
387
408
  ): any[];
388
409
  /**
389
410
  * Gets the logged objects by object type
411
+ *
412
+ * @returns Array of logged objects
390
413
  */
391
414
  static getLoggedObjects(
392
415
  /**
@@ -396,10 +419,14 @@ declare namespace sap {
396
419
  ): any[];
397
420
  /**
398
421
  * Returns all public elements, i.e. elements that are part of public API aggregations
422
+ *
423
+ * @returns Array of matched elements
399
424
  */
400
425
  static getPublicElements(): any[];
401
426
  /**
402
427
  * Gets the type of the execution scope
428
+ *
429
+ * @returns The type of the execution scope. Possible values are `global`, `subtree` or `components`.
403
430
  */
404
431
  static getType(): string;
405
432
  }