@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,4079 @@
1
+ // For Library Version: 1.113.0
2
+
3
+ declare module "sap/uiext/inbox/library" {}
4
+
5
+ declare module "sap/uiext/inbox/composite/InboxAddAttachmentTile" {
6
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
7
+
8
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
9
+
10
+ /**
11
+ * InboxAddAttachmentTile
12
+ */
13
+ export default class InboxAddAttachmentTile extends Control {
14
+ /**
15
+ * Constructor for a new composite/InboxAddAttachmentTile.
16
+ *
17
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
18
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
19
+ * of the syntax of the settings object.
20
+ *
21
+ * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.core.Control#constructor
22
+ * sap.ui.core.Control} can be used.
23
+ */
24
+ constructor(
25
+ /**
26
+ * initial settings for the new control
27
+ */
28
+ mSettings?: $InboxAddAttachmentTileSettings
29
+ );
30
+ /**
31
+ * Constructor for a new composite/InboxAddAttachmentTile.
32
+ *
33
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
34
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
35
+ * of the syntax of the settings object.
36
+ *
37
+ * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.core.Control#constructor
38
+ * sap.ui.core.Control} can be used.
39
+ */
40
+ constructor(
41
+ /**
42
+ * id for the new control, generated automatically if no id is given
43
+ */
44
+ sId?: string,
45
+ /**
46
+ * initial settings for the new control
47
+ */
48
+ mSettings?: $InboxAddAttachmentTileSettings
49
+ );
50
+
51
+ /**
52
+ * Creates a new subclass of class sap.uiext.inbox.composite.InboxAddAttachmentTile with name `sClassName`
53
+ * and enriches it with the information contained in `oClassInfo`.
54
+ *
55
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
56
+ *
57
+ * @returns Created class / constructor function
58
+ */
59
+ static extend<T extends Record<string, unknown>>(
60
+ /**
61
+ * Name of the class being created
62
+ */
63
+ sClassName: string,
64
+ /**
65
+ * Object literal with information about the class
66
+ */
67
+ oClassInfo?: sap.ClassInfo<T, InboxAddAttachmentTile>,
68
+ /**
69
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
70
+ * used by this class
71
+ */
72
+ FNMetaImpl?: Function
73
+ ): Function;
74
+ /**
75
+ * Returns a metadata object for class sap.uiext.inbox.composite.InboxAddAttachmentTile.
76
+ *
77
+ * @returns Metadata object describing this class
78
+ */
79
+ static getMetadata(): ElementMetadata;
80
+ }
81
+
82
+ export interface $InboxAddAttachmentTileSettings extends $ControlSettings {}
83
+ }
84
+
85
+ declare module "sap/uiext/inbox/composite/InboxAttachmentsTileContainer" {
86
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
87
+
88
+ import InboxAttachmentTile from "sap/uiext/inbox/composite/InboxAttachmentTile";
89
+
90
+ import Event from "sap/ui/base/Event";
91
+
92
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
93
+
94
+ import {
95
+ PropertyBindingInfo,
96
+ AggregationBindingInfo,
97
+ } from "sap/ui/base/ManagedObject";
98
+
99
+ /**
100
+ * InboxAttachmentsTileContainer
101
+ */
102
+ export default class InboxAttachmentsTileContainer extends Control {
103
+ /**
104
+ * Constructor for a new composite/InboxAttachmentsTileContainer.
105
+ *
106
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
107
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
108
+ * of the syntax of the settings object.
109
+ */
110
+ constructor(
111
+ /**
112
+ * initial settings for the new control
113
+ */
114
+ mSettings?: $InboxAttachmentsTileContainerSettings
115
+ );
116
+ /**
117
+ * Constructor for a new composite/InboxAttachmentsTileContainer.
118
+ *
119
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
120
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
121
+ * of the syntax of the settings object.
122
+ */
123
+ constructor(
124
+ /**
125
+ * id for the new control, generated automatically if no id is given
126
+ */
127
+ sId?: string,
128
+ /**
129
+ * initial settings for the new control
130
+ */
131
+ mSettings?: $InboxAttachmentsTileContainerSettings
132
+ );
133
+
134
+ /**
135
+ * Creates a new subclass of class sap.uiext.inbox.composite.InboxAttachmentsTileContainer with name `sClassName`
136
+ * and enriches it with the information contained in `oClassInfo`.
137
+ *
138
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
139
+ *
140
+ * @returns Created class / constructor function
141
+ */
142
+ static extend<T extends Record<string, unknown>>(
143
+ /**
144
+ * Name of the class being created
145
+ */
146
+ sClassName: string,
147
+ /**
148
+ * Object literal with information about the class
149
+ */
150
+ oClassInfo?: sap.ClassInfo<T, InboxAttachmentsTileContainer>,
151
+ /**
152
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
153
+ * used by this class
154
+ */
155
+ FNMetaImpl?: Function
156
+ ): Function;
157
+ /**
158
+ * Returns a metadata object for class sap.uiext.inbox.composite.InboxAttachmentsTileContainer.
159
+ *
160
+ * @returns Metadata object describing this class
161
+ */
162
+ static getMetadata(): ElementMetadata;
163
+ /**
164
+ * Adds some attachment to the aggregation {@link #getAttachments attachments}.
165
+ *
166
+ * @returns Reference to `this` in order to allow method chaining
167
+ */
168
+ addAttachment(
169
+ /**
170
+ * The attachment to add; if empty, nothing is inserted
171
+ */
172
+ oAttachment: InboxAttachmentTile
173
+ ): this;
174
+ /**
175
+ * method to add a header parameter while uploading a file. This method takes header name and header value
176
+ * as input.
177
+ */
178
+ addUploadHeader(): void;
179
+ /**
180
+ * Attaches event handler `fnFunction` to the {@link #event:uploadButtonPress uploadButtonPress} event of
181
+ * this `sap.uiext.inbox.composite.InboxAttachmentsTileContainer`.
182
+ *
183
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
184
+ * otherwise it will be bound to this `sap.uiext.inbox.composite.InboxAttachmentsTileContainer` itself.
185
+ *
186
+ * event is fired to add all the header parameters just before uploading a file
187
+ *
188
+ * @returns Reference to `this` in order to allow method chaining
189
+ */
190
+ attachUploadButtonPress(
191
+ /**
192
+ * An application-specific payload object that will be passed to the event handler along with the event
193
+ * object when firing the event
194
+ */
195
+ oData: object,
196
+ /**
197
+ * The function to be called when the event occurs
198
+ */
199
+ fnFunction: (p1: Event) => void,
200
+ /**
201
+ * Context object to call the event handler with. Defaults to this `sap.uiext.inbox.composite.InboxAttachmentsTileContainer`
202
+ * itself
203
+ */
204
+ oListener?: object
205
+ ): this;
206
+ /**
207
+ * Attaches event handler `fnFunction` to the {@link #event:uploadButtonPress uploadButtonPress} event of
208
+ * this `sap.uiext.inbox.composite.InboxAttachmentsTileContainer`.
209
+ *
210
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
211
+ * otherwise it will be bound to this `sap.uiext.inbox.composite.InboxAttachmentsTileContainer` itself.
212
+ *
213
+ * event is fired to add all the header parameters just before uploading a file
214
+ *
215
+ * @returns Reference to `this` in order to allow method chaining
216
+ */
217
+ attachUploadButtonPress(
218
+ /**
219
+ * The function to be called when the event occurs
220
+ */
221
+ fnFunction: (p1: Event) => void,
222
+ /**
223
+ * Context object to call the event handler with. Defaults to this `sap.uiext.inbox.composite.InboxAttachmentsTileContainer`
224
+ * itself
225
+ */
226
+ oListener?: object
227
+ ): this;
228
+ /**
229
+ * Attaches event handler `fnFunction` to the {@link #event:uploadFailed uploadFailed} event of this `sap.uiext.inbox.composite.InboxAttachmentsTileContainer`.
230
+ *
231
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
232
+ * otherwise it will be bound to this `sap.uiext.inbox.composite.InboxAttachmentsTileContainer` itself.
233
+ *
234
+ * event is fired when uploading a file has failed
235
+ *
236
+ * @returns Reference to `this` in order to allow method chaining
237
+ */
238
+ attachUploadFailed(
239
+ /**
240
+ * An application-specific payload object that will be passed to the event handler along with the event
241
+ * object when firing the event
242
+ */
243
+ oData: object,
244
+ /**
245
+ * The function to be called when the event occurs
246
+ */
247
+ fnFunction: (p1: Event) => void,
248
+ /**
249
+ * Context object to call the event handler with. Defaults to this `sap.uiext.inbox.composite.InboxAttachmentsTileContainer`
250
+ * itself
251
+ */
252
+ oListener?: object
253
+ ): this;
254
+ /**
255
+ * Attaches event handler `fnFunction` to the {@link #event:uploadFailed uploadFailed} event of this `sap.uiext.inbox.composite.InboxAttachmentsTileContainer`.
256
+ *
257
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
258
+ * otherwise it will be bound to this `sap.uiext.inbox.composite.InboxAttachmentsTileContainer` itself.
259
+ *
260
+ * event is fired when uploading a file has failed
261
+ *
262
+ * @returns Reference to `this` in order to allow method chaining
263
+ */
264
+ attachUploadFailed(
265
+ /**
266
+ * The function to be called when the event occurs
267
+ */
268
+ fnFunction: (p1: Event) => void,
269
+ /**
270
+ * Context object to call the event handler with. Defaults to this `sap.uiext.inbox.composite.InboxAttachmentsTileContainer`
271
+ * itself
272
+ */
273
+ oListener?: object
274
+ ): this;
275
+ /**
276
+ * Attaches event handler `fnFunction` to the {@link #event:uploadSuccess uploadSuccess} event of this `sap.uiext.inbox.composite.InboxAttachmentsTileContainer`.
277
+ *
278
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
279
+ * otherwise it will be bound to this `sap.uiext.inbox.composite.InboxAttachmentsTileContainer` itself.
280
+ *
281
+ * event is fired when uploading a file is completed successfully
282
+ *
283
+ * @returns Reference to `this` in order to allow method chaining
284
+ */
285
+ attachUploadSuccess(
286
+ /**
287
+ * An application-specific payload object that will be passed to the event handler along with the event
288
+ * object when firing the event
289
+ */
290
+ oData: object,
291
+ /**
292
+ * The function to be called when the event occurs
293
+ */
294
+ fnFunction: (p1: Event) => void,
295
+ /**
296
+ * Context object to call the event handler with. Defaults to this `sap.uiext.inbox.composite.InboxAttachmentsTileContainer`
297
+ * itself
298
+ */
299
+ oListener?: object
300
+ ): this;
301
+ /**
302
+ * Attaches event handler `fnFunction` to the {@link #event:uploadSuccess uploadSuccess} event of this `sap.uiext.inbox.composite.InboxAttachmentsTileContainer`.
303
+ *
304
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
305
+ * otherwise it will be bound to this `sap.uiext.inbox.composite.InboxAttachmentsTileContainer` itself.
306
+ *
307
+ * event is fired when uploading a file is completed successfully
308
+ *
309
+ * @returns Reference to `this` in order to allow method chaining
310
+ */
311
+ attachUploadSuccess(
312
+ /**
313
+ * The function to be called when the event occurs
314
+ */
315
+ fnFunction: (p1: Event) => void,
316
+ /**
317
+ * Context object to call the event handler with. Defaults to this `sap.uiext.inbox.composite.InboxAttachmentsTileContainer`
318
+ * itself
319
+ */
320
+ oListener?: object
321
+ ): this;
322
+ /**
323
+ * Destroys all the attachments in the aggregation {@link #getAttachments attachments}.
324
+ *
325
+ * @returns Reference to `this` in order to allow method chaining
326
+ */
327
+ destroyAttachments(): this;
328
+ /**
329
+ * Detaches event handler `fnFunction` from the {@link #event:uploadButtonPress uploadButtonPress} event
330
+ * of this `sap.uiext.inbox.composite.InboxAttachmentsTileContainer`.
331
+ *
332
+ * The passed function and listener object must match the ones used for event registration.
333
+ *
334
+ * @returns Reference to `this` in order to allow method chaining
335
+ */
336
+ detachUploadButtonPress(
337
+ /**
338
+ * The function to be called, when the event occurs
339
+ */
340
+ fnFunction: (p1: Event) => void,
341
+ /**
342
+ * Context object on which the given function had to be called
343
+ */
344
+ oListener?: object
345
+ ): this;
346
+ /**
347
+ * Detaches event handler `fnFunction` from the {@link #event:uploadFailed uploadFailed} event of this `sap.uiext.inbox.composite.InboxAttachmentsTileContainer`.
348
+ *
349
+ * The passed function and listener object must match the ones used for event registration.
350
+ *
351
+ * @returns Reference to `this` in order to allow method chaining
352
+ */
353
+ detachUploadFailed(
354
+ /**
355
+ * The function to be called, when the event occurs
356
+ */
357
+ fnFunction: (p1: Event) => void,
358
+ /**
359
+ * Context object on which the given function had to be called
360
+ */
361
+ oListener?: object
362
+ ): this;
363
+ /**
364
+ * Detaches event handler `fnFunction` from the {@link #event:uploadSuccess uploadSuccess} event of this
365
+ * `sap.uiext.inbox.composite.InboxAttachmentsTileContainer`.
366
+ *
367
+ * The passed function and listener object must match the ones used for event registration.
368
+ *
369
+ * @returns Reference to `this` in order to allow method chaining
370
+ */
371
+ detachUploadSuccess(
372
+ /**
373
+ * The function to be called, when the event occurs
374
+ */
375
+ fnFunction: (p1: Event) => void,
376
+ /**
377
+ * Context object on which the given function had to be called
378
+ */
379
+ oListener?: object
380
+ ): this;
381
+ /**
382
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
383
+ *
384
+ * Fires event {@link #event:uploadButtonPress uploadButtonPress} to attached listeners.
385
+ *
386
+ * @returns Reference to `this` in order to allow method chaining
387
+ */
388
+ fireUploadButtonPress(
389
+ /**
390
+ * Parameters to pass along with the event
391
+ */
392
+ mParameters?: object
393
+ ): this;
394
+ /**
395
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
396
+ *
397
+ * Fires event {@link #event:uploadFailed uploadFailed} to attached listeners.
398
+ *
399
+ * @returns Reference to `this` in order to allow method chaining
400
+ */
401
+ fireUploadFailed(
402
+ /**
403
+ * Parameters to pass along with the event
404
+ */
405
+ mParameters?: object
406
+ ): this;
407
+ /**
408
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
409
+ *
410
+ * Fires event {@link #event:uploadSuccess uploadSuccess} to attached listeners.
411
+ *
412
+ * @returns Reference to `this` in order to allow method chaining
413
+ */
414
+ fireUploadSuccess(
415
+ /**
416
+ * Parameters to pass along with the event
417
+ */
418
+ mParameters?: object
419
+ ): this;
420
+ /**
421
+ * Gets content of aggregation {@link #getAttachments attachments}.
422
+ *
423
+ * aggregation for attachments tile
424
+ */
425
+ getAttachments(): InboxAttachmentTile[];
426
+ /**
427
+ * Gets current value of property {@link #getEnteredDescription enteredDescription}.
428
+ *
429
+ * description string entered by user while uploading a file
430
+ *
431
+ * @returns Value of property `enteredDescription`
432
+ */
433
+ getEnteredDescription(): string;
434
+ /**
435
+ * Gets current value of property {@link #getFileName fileName}.
436
+ *
437
+ * name of the selected file for uploading
438
+ *
439
+ * @returns Value of property `fileName`
440
+ */
441
+ getFileName(): string;
442
+ /**
443
+ * Gets current value of property {@link #getFileType fileType}.
444
+ *
445
+ * type of the selected file for uploading
446
+ *
447
+ * @returns Value of property `fileType`
448
+ */
449
+ getFileType(): string;
450
+ /**
451
+ * Gets current value of property {@link #getIsFileSelected isFileSelected}.
452
+ *
453
+ * boolean property to indicate if user has selected a file to upload
454
+ *
455
+ * @returns Value of property `isFileSelected`
456
+ */
457
+ getIsFileSelected(): boolean;
458
+ /**
459
+ * Gets current value of property {@link #getShowAddTile showAddTile}.
460
+ *
461
+ * boolean value to indicate whether to show Add Attachment tile
462
+ *
463
+ * Default value is `true`.
464
+ *
465
+ * @returns Value of property `showAddTile`
466
+ */
467
+ getShowAddTile(): boolean;
468
+ /**
469
+ * Gets current value of property {@link #getUploadUrl uploadUrl}.
470
+ *
471
+ * URL to upload the selected file
472
+ *
473
+ * @returns Value of property `uploadUrl`
474
+ */
475
+ getUploadUrl(): string;
476
+ /**
477
+ * Checks for the provided `sap.uiext.inbox.composite.InboxAttachmentTile` in the aggregation {@link #getAttachments
478
+ * attachments}. and returns its index if found or -1 otherwise.
479
+ *
480
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
481
+ */
482
+ indexOfAttachment(
483
+ /**
484
+ * The attachment whose index is looked for
485
+ */
486
+ oAttachment: InboxAttachmentTile
487
+ ): int;
488
+ /**
489
+ * Inserts a attachment into the aggregation {@link #getAttachments attachments}.
490
+ *
491
+ * @returns Reference to `this` in order to allow method chaining
492
+ */
493
+ insertAttachment(
494
+ /**
495
+ * The attachment to insert; if empty, nothing is inserted
496
+ */
497
+ oAttachment: InboxAttachmentTile,
498
+ /**
499
+ * The `0`-based index the attachment should be inserted at; for a negative value of `iIndex`, the attachment
500
+ * is inserted at position 0; for a value greater than the current size of the aggregation, the attachment
501
+ * is inserted at the last position
502
+ */
503
+ iIndex: int
504
+ ): this;
505
+ /**
506
+ * Removes all the controls from the aggregation {@link #getAttachments attachments}.
507
+ *
508
+ * Additionally, it unregisters them from the hosting UIArea.
509
+ *
510
+ * @returns An array of the removed elements (might be empty)
511
+ */
512
+ removeAllAttachments(): InboxAttachmentTile[];
513
+ /**
514
+ * Removes a attachment from the aggregation {@link #getAttachments attachments}.
515
+ *
516
+ * @returns The removed attachment or `null`
517
+ */
518
+ removeAttachment(
519
+ /**
520
+ * The attachment to remove or its index or id
521
+ */
522
+ vAttachment: int | string | InboxAttachmentTile
523
+ ): InboxAttachmentTile | null;
524
+ /**
525
+ * method to remove a headerParameter of fileUploader
526
+ */
527
+ removeUploadHeader(): void;
528
+ /**
529
+ * Sets a new value for property {@link #getEnteredDescription enteredDescription}.
530
+ *
531
+ * description string entered by user while uploading a file
532
+ *
533
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
534
+ *
535
+ * @returns Reference to `this` in order to allow method chaining
536
+ */
537
+ setEnteredDescription(
538
+ /**
539
+ * New value for property `enteredDescription`
540
+ */
541
+ sEnteredDescription?: string
542
+ ): this;
543
+ /**
544
+ * Sets a new value for property {@link #getFileName fileName}.
545
+ *
546
+ * name of the selected file for uploading
547
+ *
548
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
549
+ *
550
+ * @returns Reference to `this` in order to allow method chaining
551
+ */
552
+ setFileName(
553
+ /**
554
+ * New value for property `fileName`
555
+ */
556
+ sFileName?: string
557
+ ): this;
558
+ /**
559
+ * Sets a new value for property {@link #getFileType fileType}.
560
+ *
561
+ * type of the selected file for uploading
562
+ *
563
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
564
+ *
565
+ * @returns Reference to `this` in order to allow method chaining
566
+ */
567
+ setFileType(
568
+ /**
569
+ * New value for property `fileType`
570
+ */
571
+ sFileType?: string
572
+ ): this;
573
+ /**
574
+ * Sets a new value for property {@link #getIsFileSelected isFileSelected}.
575
+ *
576
+ * boolean property to indicate if user has selected a file to upload
577
+ *
578
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
579
+ *
580
+ * @returns Reference to `this` in order to allow method chaining
581
+ */
582
+ setIsFileSelected(
583
+ /**
584
+ * New value for property `isFileSelected`
585
+ */
586
+ bIsFileSelected?: boolean
587
+ ): this;
588
+ /**
589
+ * Sets a new value for property {@link #getShowAddTile showAddTile}.
590
+ *
591
+ * boolean value to indicate whether to show Add Attachment tile
592
+ *
593
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
594
+ *
595
+ * Default value is `true`.
596
+ *
597
+ * @returns Reference to `this` in order to allow method chaining
598
+ */
599
+ setShowAddTile(
600
+ /**
601
+ * New value for property `showAddTile`
602
+ */
603
+ bShowAddTile?: boolean
604
+ ): this;
605
+ /**
606
+ * Sets a new value for property {@link #getUploadUrl uploadUrl}.
607
+ *
608
+ * URL to upload the selected file
609
+ *
610
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
611
+ *
612
+ * @returns Reference to `this` in order to allow method chaining
613
+ */
614
+ setUploadUrl(
615
+ /**
616
+ * New value for property `uploadUrl`
617
+ */
618
+ sUploadUrl?: string
619
+ ): this;
620
+ }
621
+
622
+ export interface $InboxAttachmentsTileContainerSettings
623
+ extends $ControlSettings {
624
+ /**
625
+ * URL to upload the selected file
626
+ */
627
+ uploadUrl?: string | PropertyBindingInfo;
628
+
629
+ /**
630
+ * name of the selected file for uploading
631
+ */
632
+ fileName?: string | PropertyBindingInfo;
633
+
634
+ /**
635
+ * type of the selected file for uploading
636
+ */
637
+ fileType?: string | PropertyBindingInfo;
638
+
639
+ /**
640
+ * boolean property to indicate if user has selected a file to upload
641
+ */
642
+ isFileSelected?: boolean | PropertyBindingInfo | `{${string}}`;
643
+
644
+ /**
645
+ * description string entered by user while uploading a file
646
+ */
647
+ enteredDescription?: string | PropertyBindingInfo;
648
+
649
+ /**
650
+ * boolean value to indicate whether to show Add Attachment tile
651
+ */
652
+ showAddTile?: boolean | PropertyBindingInfo | `{${string}}`;
653
+
654
+ /**
655
+ * aggregation for attachments tile
656
+ */
657
+ attachments?:
658
+ | InboxAttachmentTile[]
659
+ | InboxAttachmentTile
660
+ | AggregationBindingInfo
661
+ | `{${string}}`;
662
+
663
+ /**
664
+ * event is fired to add all the header parameters just before uploading a file
665
+ */
666
+ uploadButtonPress?: (oEvent: Event) => void;
667
+
668
+ /**
669
+ * event is fired when uploading a file is completed successfully
670
+ */
671
+ uploadSuccess?: (oEvent: Event) => void;
672
+
673
+ /**
674
+ * event is fired when uploading a file has failed
675
+ */
676
+ uploadFailed?: (oEvent: Event) => void;
677
+ }
678
+ }
679
+
680
+ declare module "sap/uiext/inbox/composite/InboxAttachmentTile" {
681
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
682
+
683
+ import Event from "sap/ui/base/Event";
684
+
685
+ import { URI } from "sap/ui/core/library";
686
+
687
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
688
+
689
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
690
+
691
+ /**
692
+ * InboxAttachmentTile
693
+ */
694
+ export default class InboxAttachmentTile extends Control {
695
+ /**
696
+ * Constructor for a new composite/InboxAttachmentTile.
697
+ *
698
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
699
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
700
+ * of the syntax of the settings object.
701
+ */
702
+ constructor(
703
+ /**
704
+ * initial settings for the new control
705
+ */
706
+ mSettings?: $InboxAttachmentTileSettings
707
+ );
708
+ /**
709
+ * Constructor for a new composite/InboxAttachmentTile.
710
+ *
711
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
712
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
713
+ * of the syntax of the settings object.
714
+ */
715
+ constructor(
716
+ /**
717
+ * id for the new control, generated automatically if no id is given
718
+ */
719
+ sId?: string,
720
+ /**
721
+ * initial settings for the new control
722
+ */
723
+ mSettings?: $InboxAttachmentTileSettings
724
+ );
725
+
726
+ /**
727
+ * Creates a new subclass of class sap.uiext.inbox.composite.InboxAttachmentTile with name `sClassName`
728
+ * and enriches it with the information contained in `oClassInfo`.
729
+ *
730
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
731
+ *
732
+ * @returns Created class / constructor function
733
+ */
734
+ static extend<T extends Record<string, unknown>>(
735
+ /**
736
+ * Name of the class being created
737
+ */
738
+ sClassName: string,
739
+ /**
740
+ * Object literal with information about the class
741
+ */
742
+ oClassInfo?: sap.ClassInfo<T, InboxAttachmentTile>,
743
+ /**
744
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
745
+ * used by this class
746
+ */
747
+ FNMetaImpl?: Function
748
+ ): Function;
749
+ /**
750
+ * Returns a metadata object for class sap.uiext.inbox.composite.InboxAttachmentTile.
751
+ *
752
+ * @returns Metadata object describing this class
753
+ */
754
+ static getMetadata(): ElementMetadata;
755
+ /**
756
+ * Attaches event handler `fnFunction` to the {@link #event:deleteAttachment deleteAttachment} event of
757
+ * this `sap.uiext.inbox.composite.InboxAttachmentTile`.
758
+ *
759
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
760
+ * otherwise it will be bound to this `sap.uiext.inbox.composite.InboxAttachmentTile` itself.
761
+ *
762
+ * fire this event to delete the attachment
763
+ *
764
+ * @returns Reference to `this` in order to allow method chaining
765
+ */
766
+ attachDeleteAttachment(
767
+ /**
768
+ * An application-specific payload object that will be passed to the event handler along with the event
769
+ * object when firing the event
770
+ */
771
+ oData: object,
772
+ /**
773
+ * The function to be called when the event occurs
774
+ */
775
+ fnFunction: (p1: Event) => void,
776
+ /**
777
+ * Context object to call the event handler with. Defaults to this `sap.uiext.inbox.composite.InboxAttachmentTile`
778
+ * itself
779
+ */
780
+ oListener?: object
781
+ ): this;
782
+ /**
783
+ * Attaches event handler `fnFunction` to the {@link #event:deleteAttachment deleteAttachment} event of
784
+ * this `sap.uiext.inbox.composite.InboxAttachmentTile`.
785
+ *
786
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
787
+ * otherwise it will be bound to this `sap.uiext.inbox.composite.InboxAttachmentTile` itself.
788
+ *
789
+ * fire this event to delete the attachment
790
+ *
791
+ * @returns Reference to `this` in order to allow method chaining
792
+ */
793
+ attachDeleteAttachment(
794
+ /**
795
+ * The function to be called when the event occurs
796
+ */
797
+ fnFunction: (p1: Event) => void,
798
+ /**
799
+ * Context object to call the event handler with. Defaults to this `sap.uiext.inbox.composite.InboxAttachmentTile`
800
+ * itself
801
+ */
802
+ oListener?: object
803
+ ): this;
804
+ /**
805
+ * Detaches event handler `fnFunction` from the {@link #event:deleteAttachment deleteAttachment} event of
806
+ * this `sap.uiext.inbox.composite.InboxAttachmentTile`.
807
+ *
808
+ * The passed function and listener object must match the ones used for event registration.
809
+ *
810
+ * @returns Reference to `this` in order to allow method chaining
811
+ */
812
+ detachDeleteAttachment(
813
+ /**
814
+ * The function to be called, when the event occurs
815
+ */
816
+ fnFunction: (p1: Event) => void,
817
+ /**
818
+ * Context object on which the given function had to be called
819
+ */
820
+ oListener?: object
821
+ ): this;
822
+ /**
823
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
824
+ *
825
+ * Fires event {@link #event:deleteAttachment deleteAttachment} to attached listeners.
826
+ *
827
+ * @returns Reference to `this` in order to allow method chaining
828
+ */
829
+ fireDeleteAttachment(
830
+ /**
831
+ * Parameters to pass along with the event
832
+ */
833
+ mParameters?: object
834
+ ): this;
835
+ /**
836
+ * Gets current value of property {@link #getCreatedBy createdBy}.
837
+ *
838
+ * name of the user who has uploaded attachment
839
+ *
840
+ * @returns Value of property `createdBy`
841
+ */
842
+ getCreatedBy(): string;
843
+ /**
844
+ * Gets current value of property {@link #getCreationDate creationDate}.
845
+ *
846
+ * creation date of the attachment
847
+ *
848
+ * @returns Value of property `creationDate`
849
+ */
850
+ getCreationDate(): string;
851
+ /**
852
+ * Gets current value of property {@link #getDownloadUrl downloadUrl}.
853
+ *
854
+ * URL for attachment title link to download the attachment.
855
+ *
856
+ * @returns Value of property `downloadUrl`
857
+ */
858
+ getDownloadUrl(): string;
859
+ /**
860
+ * Gets current value of property {@link #getFileDescription fileDescription}.
861
+ *
862
+ * description of the attachment
863
+ *
864
+ * @returns Value of property `fileDescription`
865
+ */
866
+ getFileDescription(): string;
867
+ /**
868
+ * Gets current value of property {@link #getFileName fileName}.
869
+ *
870
+ * Name of the attachment
871
+ *
872
+ * @returns Value of property `fileName`
873
+ */
874
+ getFileName(): string;
875
+ /**
876
+ * Gets current value of property {@link #getFileSize fileSize}.
877
+ *
878
+ * size of the attachment
879
+ *
880
+ * @returns Value of property `fileSize`
881
+ */
882
+ getFileSize(): string;
883
+ /**
884
+ * Gets current value of property {@link #getFileTypeIcon fileTypeIcon}.
885
+ *
886
+ * Icon URI of the file type
887
+ *
888
+ * @returns Value of property `fileTypeIcon`
889
+ */
890
+ getFileTypeIcon(): URI;
891
+ /**
892
+ * Gets current value of property {@link #getShowDeleteButton showDeleteButton}.
893
+ *
894
+ * boolean value to indicate whether to show delete button
895
+ *
896
+ * Default value is `true`.
897
+ *
898
+ * @returns Value of property `showDeleteButton`
899
+ */
900
+ getShowDeleteButton(): boolean;
901
+ /**
902
+ * Sets a new value for property {@link #getCreatedBy createdBy}.
903
+ *
904
+ * name of the user who has uploaded attachment
905
+ *
906
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
907
+ *
908
+ * @returns Reference to `this` in order to allow method chaining
909
+ */
910
+ setCreatedBy(
911
+ /**
912
+ * New value for property `createdBy`
913
+ */
914
+ sCreatedBy?: string
915
+ ): this;
916
+ /**
917
+ * Sets a new value for property {@link #getCreationDate creationDate}.
918
+ *
919
+ * creation date of the attachment
920
+ *
921
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
922
+ *
923
+ * @returns Reference to `this` in order to allow method chaining
924
+ */
925
+ setCreationDate(
926
+ /**
927
+ * New value for property `creationDate`
928
+ */
929
+ sCreationDate?: string
930
+ ): this;
931
+ /**
932
+ * Sets a new value for property {@link #getDownloadUrl downloadUrl}.
933
+ *
934
+ * URL for attachment title link to download the attachment.
935
+ *
936
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
937
+ *
938
+ * @returns Reference to `this` in order to allow method chaining
939
+ */
940
+ setDownloadUrl(
941
+ /**
942
+ * New value for property `downloadUrl`
943
+ */
944
+ sDownloadUrl?: string
945
+ ): this;
946
+ /**
947
+ * Sets a new value for property {@link #getFileDescription fileDescription}.
948
+ *
949
+ * description of the attachment
950
+ *
951
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
952
+ *
953
+ * @returns Reference to `this` in order to allow method chaining
954
+ */
955
+ setFileDescription(
956
+ /**
957
+ * New value for property `fileDescription`
958
+ */
959
+ sFileDescription?: string
960
+ ): this;
961
+ /**
962
+ * Sets a new value for property {@link #getFileName fileName}.
963
+ *
964
+ * Name of the attachment
965
+ *
966
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
967
+ *
968
+ * @returns Reference to `this` in order to allow method chaining
969
+ */
970
+ setFileName(
971
+ /**
972
+ * New value for property `fileName`
973
+ */
974
+ sFileName?: string
975
+ ): this;
976
+ /**
977
+ * Sets a new value for property {@link #getFileSize fileSize}.
978
+ *
979
+ * size of the attachment
980
+ *
981
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
982
+ *
983
+ * @returns Reference to `this` in order to allow method chaining
984
+ */
985
+ setFileSize(
986
+ /**
987
+ * New value for property `fileSize`
988
+ */
989
+ sFileSize?: string
990
+ ): this;
991
+ /**
992
+ * Sets a new value for property {@link #getFileTypeIcon fileTypeIcon}.
993
+ *
994
+ * Icon URI of the file type
995
+ *
996
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
997
+ *
998
+ * @returns Reference to `this` in order to allow method chaining
999
+ */
1000
+ setFileTypeIcon(
1001
+ /**
1002
+ * New value for property `fileTypeIcon`
1003
+ */
1004
+ sFileTypeIcon?: URI
1005
+ ): this;
1006
+ /**
1007
+ * Sets a new value for property {@link #getShowDeleteButton showDeleteButton}.
1008
+ *
1009
+ * boolean value to indicate whether to show delete button
1010
+ *
1011
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1012
+ *
1013
+ * Default value is `true`.
1014
+ *
1015
+ * @returns Reference to `this` in order to allow method chaining
1016
+ */
1017
+ setShowDeleteButton(
1018
+ /**
1019
+ * New value for property `showDeleteButton`
1020
+ */
1021
+ bShowDeleteButton?: boolean
1022
+ ): this;
1023
+ }
1024
+
1025
+ export interface $InboxAttachmentTileSettings extends $ControlSettings {
1026
+ /**
1027
+ * Name of the attachment
1028
+ */
1029
+ fileName?: string | PropertyBindingInfo;
1030
+
1031
+ /**
1032
+ * size of the attachment
1033
+ */
1034
+ fileSize?: string | PropertyBindingInfo;
1035
+
1036
+ /**
1037
+ * description of the attachment
1038
+ */
1039
+ fileDescription?: string | PropertyBindingInfo;
1040
+
1041
+ /**
1042
+ * Icon URI of the file type
1043
+ */
1044
+ fileTypeIcon?: URI | PropertyBindingInfo | `{${string}}`;
1045
+
1046
+ /**
1047
+ * creation date of the attachment
1048
+ */
1049
+ creationDate?: string | PropertyBindingInfo;
1050
+
1051
+ /**
1052
+ * URL for attachment title link to download the attachment.
1053
+ */
1054
+ downloadUrl?: string | PropertyBindingInfo;
1055
+
1056
+ /**
1057
+ * name of the user who has uploaded attachment
1058
+ */
1059
+ createdBy?: string | PropertyBindingInfo;
1060
+
1061
+ /**
1062
+ * boolean value to indicate whether to show delete button
1063
+ */
1064
+ showDeleteButton?: boolean | PropertyBindingInfo | `{${string}}`;
1065
+
1066
+ /**
1067
+ * fire this event to delete the attachment
1068
+ */
1069
+ deleteAttachment?: (oEvent: Event) => void;
1070
+ }
1071
+ }
1072
+
1073
+ declare module "sap/uiext/inbox/composite/InboxBusyIndicator" {
1074
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
1075
+
1076
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
1077
+
1078
+ /**
1079
+ * InboxBusyIndicator
1080
+ */
1081
+ export default class InboxBusyIndicator extends Control {
1082
+ /**
1083
+ * Constructor for a new composite/InboxBusyIndicator.
1084
+ *
1085
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1086
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1087
+ * of the syntax of the settings object.
1088
+ *
1089
+ * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.core.Control#constructor
1090
+ * sap.ui.core.Control} can be used.
1091
+ */
1092
+ constructor(
1093
+ /**
1094
+ * initial settings for the new control
1095
+ */
1096
+ mSettings?: $InboxBusyIndicatorSettings
1097
+ );
1098
+ /**
1099
+ * Constructor for a new composite/InboxBusyIndicator.
1100
+ *
1101
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1102
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1103
+ * of the syntax of the settings object.
1104
+ *
1105
+ * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.core.Control#constructor
1106
+ * sap.ui.core.Control} can be used.
1107
+ */
1108
+ constructor(
1109
+ /**
1110
+ * id for the new control, generated automatically if no id is given
1111
+ */
1112
+ sId?: string,
1113
+ /**
1114
+ * initial settings for the new control
1115
+ */
1116
+ mSettings?: $InboxBusyIndicatorSettings
1117
+ );
1118
+
1119
+ /**
1120
+ * Creates a new subclass of class sap.uiext.inbox.composite.InboxBusyIndicator with name `sClassName` and
1121
+ * enriches it with the information contained in `oClassInfo`.
1122
+ *
1123
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
1124
+ *
1125
+ * @returns Created class / constructor function
1126
+ */
1127
+ static extend<T extends Record<string, unknown>>(
1128
+ /**
1129
+ * Name of the class being created
1130
+ */
1131
+ sClassName: string,
1132
+ /**
1133
+ * Object literal with information about the class
1134
+ */
1135
+ oClassInfo?: sap.ClassInfo<T, InboxBusyIndicator>,
1136
+ /**
1137
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1138
+ * used by this class
1139
+ */
1140
+ FNMetaImpl?: Function
1141
+ ): Function;
1142
+ /**
1143
+ * Returns a metadata object for class sap.uiext.inbox.composite.InboxBusyIndicator.
1144
+ *
1145
+ * @returns Metadata object describing this class
1146
+ */
1147
+ static getMetadata(): ElementMetadata;
1148
+ }
1149
+
1150
+ export interface $InboxBusyIndicatorSettings extends $ControlSettings {}
1151
+ }
1152
+
1153
+ declare module "sap/uiext/inbox/composite/InboxComment" {
1154
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
1155
+
1156
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
1157
+
1158
+ import { URI } from "sap/ui/core/library";
1159
+
1160
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1161
+
1162
+ /**
1163
+ * fsgg
1164
+ */
1165
+ export default class InboxComment extends Control {
1166
+ /**
1167
+ * Constructor for a new composite/InboxComment.
1168
+ *
1169
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1170
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1171
+ * of the syntax of the settings object.
1172
+ */
1173
+ constructor(
1174
+ /**
1175
+ * initial settings for the new control
1176
+ */
1177
+ mSettings?: $InboxCommentSettings
1178
+ );
1179
+ /**
1180
+ * Constructor for a new composite/InboxComment.
1181
+ *
1182
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1183
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1184
+ * of the syntax of the settings object.
1185
+ */
1186
+ constructor(
1187
+ /**
1188
+ * id for the new control, generated automatically if no id is given
1189
+ */
1190
+ sId?: string,
1191
+ /**
1192
+ * initial settings for the new control
1193
+ */
1194
+ mSettings?: $InboxCommentSettings
1195
+ );
1196
+
1197
+ /**
1198
+ * Creates a new subclass of class sap.uiext.inbox.composite.InboxComment with name `sClassName` and enriches
1199
+ * it with the information contained in `oClassInfo`.
1200
+ *
1201
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
1202
+ *
1203
+ * @returns Created class / constructor function
1204
+ */
1205
+ static extend<T extends Record<string, unknown>>(
1206
+ /**
1207
+ * Name of the class being created
1208
+ */
1209
+ sClassName: string,
1210
+ /**
1211
+ * Object literal with information about the class
1212
+ */
1213
+ oClassInfo?: sap.ClassInfo<T, InboxComment>,
1214
+ /**
1215
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1216
+ * used by this class
1217
+ */
1218
+ FNMetaImpl?: Function
1219
+ ): Function;
1220
+ /**
1221
+ * Returns a metadata object for class sap.uiext.inbox.composite.InboxComment.
1222
+ *
1223
+ * @returns Metadata object describing this class
1224
+ */
1225
+ static getMetadata(): ElementMetadata;
1226
+ /**
1227
+ * Gets current value of property {@link #getCreatedBy createdBy}.
1228
+ *
1229
+ * Unique username of the user responsible for adding comment
1230
+ *
1231
+ * @returns Value of property `createdBy`
1232
+ */
1233
+ getCreatedBy(): string;
1234
+ /**
1235
+ * Gets current value of property {@link #getSapOrigin sapOrigin}.
1236
+ *
1237
+ * Represent system origin in case of multi origin scenario
1238
+ *
1239
+ * @returns Value of property `sapOrigin`
1240
+ */
1241
+ getSapOrigin(): string;
1242
+ /**
1243
+ * Gets current value of property {@link #getSender sender}.
1244
+ *
1245
+ * Sender of the comment chunk
1246
+ *
1247
+ * @returns Value of property `sender`
1248
+ */
1249
+ getSender(): string;
1250
+ /**
1251
+ * Gets current value of property {@link #getText text}.
1252
+ *
1253
+ * The FeedChunk text
1254
+ *
1255
+ * @returns Value of property `text`
1256
+ */
1257
+ getText(): string;
1258
+ /**
1259
+ * Gets current value of property {@link #getThumbnailSrc thumbnailSrc}.
1260
+ *
1261
+ * URL to the thumbnail image.
1262
+ *
1263
+ * @returns Value of property `thumbnailSrc`
1264
+ */
1265
+ getThumbnailSrc(): URI;
1266
+ /**
1267
+ * Gets current value of property {@link #getTimestamp timestamp}.
1268
+ *
1269
+ * Format is ISO 8601 YYYY-MM-DDThh:mm:ss.sZ, Z meaning the time is in UTC time zone
1270
+ *
1271
+ * @returns Value of property `timestamp`
1272
+ */
1273
+ getTimestamp(): string;
1274
+ /**
1275
+ * Sets a new value for property {@link #getCreatedBy createdBy}.
1276
+ *
1277
+ * Unique username of the user responsible for adding comment
1278
+ *
1279
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1280
+ *
1281
+ * @returns Reference to `this` in order to allow method chaining
1282
+ */
1283
+ setCreatedBy(
1284
+ /**
1285
+ * New value for property `createdBy`
1286
+ */
1287
+ sCreatedBy?: string
1288
+ ): this;
1289
+ /**
1290
+ * Sets a new value for property {@link #getSapOrigin sapOrigin}.
1291
+ *
1292
+ * Represent system origin in case of multi origin scenario
1293
+ *
1294
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1295
+ *
1296
+ * @returns Reference to `this` in order to allow method chaining
1297
+ */
1298
+ setSapOrigin(
1299
+ /**
1300
+ * New value for property `sapOrigin`
1301
+ */
1302
+ sSapOrigin?: string
1303
+ ): this;
1304
+ /**
1305
+ * Sets a new value for property {@link #getSender sender}.
1306
+ *
1307
+ * Sender of the comment chunk
1308
+ *
1309
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1310
+ *
1311
+ * @returns Reference to `this` in order to allow method chaining
1312
+ */
1313
+ setSender(
1314
+ /**
1315
+ * New value for property `sender`
1316
+ */
1317
+ sSender?: string
1318
+ ): this;
1319
+ /**
1320
+ * Sets a new value for property {@link #getText text}.
1321
+ *
1322
+ * The FeedChunk text
1323
+ *
1324
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1325
+ *
1326
+ * @returns Reference to `this` in order to allow method chaining
1327
+ */
1328
+ setText(
1329
+ /**
1330
+ * New value for property `text`
1331
+ */
1332
+ sText?: string
1333
+ ): this;
1334
+ /**
1335
+ * Sets a new value for property {@link #getThumbnailSrc thumbnailSrc}.
1336
+ *
1337
+ * URL to the thumbnail image.
1338
+ *
1339
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1340
+ *
1341
+ * @returns Reference to `this` in order to allow method chaining
1342
+ */
1343
+ setThumbnailSrc(
1344
+ /**
1345
+ * New value for property `thumbnailSrc`
1346
+ */
1347
+ sThumbnailSrc?: URI
1348
+ ): this;
1349
+ /**
1350
+ * Sets a new value for property {@link #getTimestamp timestamp}.
1351
+ *
1352
+ * Format is ISO 8601 YYYY-MM-DDThh:mm:ss.sZ, Z meaning the time is in UTC time zone
1353
+ *
1354
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1355
+ *
1356
+ * @returns Reference to `this` in order to allow method chaining
1357
+ */
1358
+ setTimestamp(
1359
+ /**
1360
+ * New value for property `timestamp`
1361
+ */
1362
+ sTimestamp?: string
1363
+ ): this;
1364
+ }
1365
+
1366
+ export interface $InboxCommentSettings extends $ControlSettings {
1367
+ /**
1368
+ * Sender of the comment chunk
1369
+ */
1370
+ sender?: string | PropertyBindingInfo;
1371
+
1372
+ /**
1373
+ * Format is ISO 8601 YYYY-MM-DDThh:mm:ss.sZ, Z meaning the time is in UTC time zone
1374
+ */
1375
+ timestamp?: string | PropertyBindingInfo;
1376
+
1377
+ /**
1378
+ * URL to the thumbnail image.
1379
+ */
1380
+ thumbnailSrc?: URI | PropertyBindingInfo | `{${string}}`;
1381
+
1382
+ /**
1383
+ * The FeedChunk text
1384
+ */
1385
+ text?: string | PropertyBindingInfo;
1386
+
1387
+ /**
1388
+ * Unique username of the user responsible for adding comment
1389
+ */
1390
+ createdBy?: string | PropertyBindingInfo;
1391
+
1392
+ /**
1393
+ * Represent system origin in case of multi origin scenario
1394
+ */
1395
+ sapOrigin?: string | PropertyBindingInfo;
1396
+ }
1397
+ }
1398
+
1399
+ declare module "sap/uiext/inbox/composite/InboxTaskComments" {
1400
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
1401
+
1402
+ import InboxComment from "sap/uiext/inbox/composite/InboxComment";
1403
+
1404
+ import Event from "sap/ui/base/Event";
1405
+
1406
+ import { URI } from "sap/ui/core/library";
1407
+
1408
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
1409
+
1410
+ import {
1411
+ PropertyBindingInfo,
1412
+ AggregationBindingInfo,
1413
+ } from "sap/ui/base/ManagedObject";
1414
+
1415
+ /**
1416
+ * InboxTaskComments
1417
+ */
1418
+ export default class InboxTaskComments extends Control {
1419
+ /**
1420
+ * Constructor for a new composite/InboxTaskComments.
1421
+ *
1422
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1423
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1424
+ * of the syntax of the settings object.
1425
+ */
1426
+ constructor(
1427
+ /**
1428
+ * initial settings for the new control
1429
+ */
1430
+ mSettings?: $InboxTaskCommentsSettings
1431
+ );
1432
+ /**
1433
+ * Constructor for a new composite/InboxTaskComments.
1434
+ *
1435
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1436
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1437
+ * of the syntax of the settings object.
1438
+ */
1439
+ constructor(
1440
+ /**
1441
+ * id for the new control, generated automatically if no id is given
1442
+ */
1443
+ sId?: string,
1444
+ /**
1445
+ * initial settings for the new control
1446
+ */
1447
+ mSettings?: $InboxTaskCommentsSettings
1448
+ );
1449
+
1450
+ /**
1451
+ * Creates a new subclass of class sap.uiext.inbox.composite.InboxTaskComments with name `sClassName` and
1452
+ * enriches it with the information contained in `oClassInfo`.
1453
+ *
1454
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
1455
+ *
1456
+ * @returns Created class / constructor function
1457
+ */
1458
+ static extend<T extends Record<string, unknown>>(
1459
+ /**
1460
+ * Name of the class being created
1461
+ */
1462
+ sClassName: string,
1463
+ /**
1464
+ * Object literal with information about the class
1465
+ */
1466
+ oClassInfo?: sap.ClassInfo<T, InboxTaskComments>,
1467
+ /**
1468
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1469
+ * used by this class
1470
+ */
1471
+ FNMetaImpl?: Function
1472
+ ): Function;
1473
+ /**
1474
+ * Returns a metadata object for class sap.uiext.inbox.composite.InboxTaskComments.
1475
+ *
1476
+ * @returns Metadata object describing this class
1477
+ */
1478
+ static getMetadata(): ElementMetadata;
1479
+ /**
1480
+ * Adds some comment to the aggregation {@link #getComments comments}.
1481
+ *
1482
+ * @returns Reference to `this` in order to allow method chaining
1483
+ */
1484
+ addComment(
1485
+ /**
1486
+ * The comment to add; if empty, nothing is inserted
1487
+ */
1488
+ oComment: InboxComment
1489
+ ): this;
1490
+ /**
1491
+ * Attaches event handler `fnFunction` to the {@link #event:commentSubmit commentSubmit} event of this `sap.uiext.inbox.composite.InboxTaskComments`.
1492
+ *
1493
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1494
+ * otherwise it will be bound to this `sap.uiext.inbox.composite.InboxTaskComments` itself.
1495
+ *
1496
+ * Event is raised when submit on the feeder is pressed.
1497
+ *
1498
+ * @returns Reference to `this` in order to allow method chaining
1499
+ */
1500
+ attachCommentSubmit(
1501
+ /**
1502
+ * An application-specific payload object that will be passed to the event handler along with the event
1503
+ * object when firing the event
1504
+ */
1505
+ oData: object,
1506
+ /**
1507
+ * The function to be called when the event occurs
1508
+ */
1509
+ fnFunction: (p1: Event) => void,
1510
+ /**
1511
+ * Context object to call the event handler with. Defaults to this `sap.uiext.inbox.composite.InboxTaskComments`
1512
+ * itself
1513
+ */
1514
+ oListener?: object
1515
+ ): this;
1516
+ /**
1517
+ * Attaches event handler `fnFunction` to the {@link #event:commentSubmit commentSubmit} event of this `sap.uiext.inbox.composite.InboxTaskComments`.
1518
+ *
1519
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1520
+ * otherwise it will be bound to this `sap.uiext.inbox.composite.InboxTaskComments` itself.
1521
+ *
1522
+ * Event is raised when submit on the feeder is pressed.
1523
+ *
1524
+ * @returns Reference to `this` in order to allow method chaining
1525
+ */
1526
+ attachCommentSubmit(
1527
+ /**
1528
+ * The function to be called when the event occurs
1529
+ */
1530
+ fnFunction: (p1: Event) => void,
1531
+ /**
1532
+ * Context object to call the event handler with. Defaults to this `sap.uiext.inbox.composite.InboxTaskComments`
1533
+ * itself
1534
+ */
1535
+ oListener?: object
1536
+ ): this;
1537
+ /**
1538
+ * Destroys all the comments in the aggregation {@link #getComments comments}.
1539
+ *
1540
+ * @returns Reference to `this` in order to allow method chaining
1541
+ */
1542
+ destroyComments(): this;
1543
+ /**
1544
+ * Detaches event handler `fnFunction` from the {@link #event:commentSubmit commentSubmit} event of this
1545
+ * `sap.uiext.inbox.composite.InboxTaskComments`.
1546
+ *
1547
+ * The passed function and listener object must match the ones used for event registration.
1548
+ *
1549
+ * @returns Reference to `this` in order to allow method chaining
1550
+ */
1551
+ detachCommentSubmit(
1552
+ /**
1553
+ * The function to be called, when the event occurs
1554
+ */
1555
+ fnFunction: (p1: Event) => void,
1556
+ /**
1557
+ * Context object on which the given function had to be called
1558
+ */
1559
+ oListener?: object
1560
+ ): this;
1561
+ /**
1562
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1563
+ *
1564
+ * Fires event {@link #event:commentSubmit commentSubmit} to attached listeners.
1565
+ *
1566
+ * @returns Reference to `this` in order to allow method chaining
1567
+ */
1568
+ fireCommentSubmit(
1569
+ /**
1570
+ * Parameters to pass along with the event
1571
+ */
1572
+ mParameters?: object
1573
+ ): this;
1574
+ /**
1575
+ * Gets content of aggregation {@link #getComments comments}.
1576
+ *
1577
+ * URL to the thumbnail image.
1578
+ */
1579
+ getComments(): InboxComment[];
1580
+ /**
1581
+ * Gets current value of property {@link #getFeederSender feederSender}.
1582
+ *
1583
+ * Sender for the comment feeder
1584
+ *
1585
+ * @returns Value of property `feederSender`
1586
+ */
1587
+ getFeederSender(): string;
1588
+ /**
1589
+ * Gets current value of property {@link #getFeederThumbnailSrc feederThumbnailSrc}.
1590
+ *
1591
+ * URL to the thumbnail image for the comment feeder.
1592
+ *
1593
+ * @returns Value of property `feederThumbnailSrc`
1594
+ */
1595
+ getFeederThumbnailSrc(): URI;
1596
+ /**
1597
+ * Gets current value of property {@link #getShowFeeder showFeeder}.
1598
+ *
1599
+ * Boolean value for visibilty of comment feeder
1600
+ *
1601
+ * Default value is `true`.
1602
+ *
1603
+ * @returns Value of property `showFeeder`
1604
+ */
1605
+ getShowFeeder(): boolean;
1606
+ /**
1607
+ * Gets current value of property {@link #getShowHeader showHeader}.
1608
+ *
1609
+ * Boolean value for visibility of header
1610
+ *
1611
+ * Default value is `false`.
1612
+ *
1613
+ * @returns Value of property `showHeader`
1614
+ */
1615
+ getShowHeader(): boolean;
1616
+ /**
1617
+ * Checks for the provided `sap.uiext.inbox.composite.InboxComment` in the aggregation {@link #getComments
1618
+ * comments}. and returns its index if found or -1 otherwise.
1619
+ *
1620
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
1621
+ */
1622
+ indexOfComment(
1623
+ /**
1624
+ * The comment whose index is looked for
1625
+ */
1626
+ oComment: InboxComment
1627
+ ): int;
1628
+ /**
1629
+ * Inserts a comment into the aggregation {@link #getComments comments}.
1630
+ *
1631
+ * @returns Reference to `this` in order to allow method chaining
1632
+ */
1633
+ insertComment(
1634
+ /**
1635
+ * The comment to insert; if empty, nothing is inserted
1636
+ */
1637
+ oComment: InboxComment,
1638
+ /**
1639
+ * The `0`-based index the comment should be inserted at; for a negative value of `iIndex`, the comment
1640
+ * is inserted at position 0; for a value greater than the current size of the aggregation, the comment
1641
+ * is inserted at the last position
1642
+ */
1643
+ iIndex: int
1644
+ ): this;
1645
+ /**
1646
+ * Removes all the controls from the aggregation {@link #getComments comments}.
1647
+ *
1648
+ * Additionally, it unregisters them from the hosting UIArea.
1649
+ *
1650
+ * @returns An array of the removed elements (might be empty)
1651
+ */
1652
+ removeAllComments(): InboxComment[];
1653
+ /**
1654
+ * Removes a comment from the aggregation {@link #getComments comments}.
1655
+ *
1656
+ * @returns The removed comment or `null`
1657
+ */
1658
+ removeComment(
1659
+ /**
1660
+ * The comment to remove or its index or id
1661
+ */
1662
+ vComment: int | string | InboxComment
1663
+ ): InboxComment | null;
1664
+ /**
1665
+ * Sets a new value for property {@link #getFeederSender feederSender}.
1666
+ *
1667
+ * Sender for the comment feeder
1668
+ *
1669
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1670
+ *
1671
+ * @returns Reference to `this` in order to allow method chaining
1672
+ */
1673
+ setFeederSender(
1674
+ /**
1675
+ * New value for property `feederSender`
1676
+ */
1677
+ sFeederSender?: string
1678
+ ): this;
1679
+ /**
1680
+ * Sets a new value for property {@link #getFeederThumbnailSrc feederThumbnailSrc}.
1681
+ *
1682
+ * URL to the thumbnail image for the comment feeder.
1683
+ *
1684
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1685
+ *
1686
+ * @returns Reference to `this` in order to allow method chaining
1687
+ */
1688
+ setFeederThumbnailSrc(
1689
+ /**
1690
+ * New value for property `feederThumbnailSrc`
1691
+ */
1692
+ sFeederThumbnailSrc?: URI
1693
+ ): this;
1694
+ /**
1695
+ * Sets a new value for property {@link #getShowFeeder showFeeder}.
1696
+ *
1697
+ * Boolean value for visibilty of comment feeder
1698
+ *
1699
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1700
+ *
1701
+ * Default value is `true`.
1702
+ *
1703
+ * @returns Reference to `this` in order to allow method chaining
1704
+ */
1705
+ setShowFeeder(
1706
+ /**
1707
+ * New value for property `showFeeder`
1708
+ */
1709
+ bShowFeeder?: boolean
1710
+ ): this;
1711
+ /**
1712
+ * Sets a new value for property {@link #getShowHeader showHeader}.
1713
+ *
1714
+ * Boolean value for visibility of header
1715
+ *
1716
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1717
+ *
1718
+ * Default value is `false`.
1719
+ *
1720
+ * @returns Reference to `this` in order to allow method chaining
1721
+ */
1722
+ setShowHeader(
1723
+ /**
1724
+ * New value for property `showHeader`
1725
+ */
1726
+ bShowHeader?: boolean
1727
+ ): this;
1728
+ }
1729
+
1730
+ export interface $InboxTaskCommentsSettings extends $ControlSettings {
1731
+ /**
1732
+ * Sender for the comment feeder
1733
+ */
1734
+ feederSender?: string | PropertyBindingInfo;
1735
+
1736
+ /**
1737
+ * URL to the thumbnail image for the comment feeder.
1738
+ */
1739
+ feederThumbnailSrc?: URI | PropertyBindingInfo | `{${string}}`;
1740
+
1741
+ /**
1742
+ * Boolean value for visibilty of comment feeder
1743
+ */
1744
+ showFeeder?: boolean | PropertyBindingInfo | `{${string}}`;
1745
+
1746
+ /**
1747
+ * Boolean value for visibility of header
1748
+ */
1749
+ showHeader?: boolean | PropertyBindingInfo | `{${string}}`;
1750
+
1751
+ /**
1752
+ * URL to the thumbnail image.
1753
+ */
1754
+ comments?:
1755
+ | InboxComment[]
1756
+ | InboxComment
1757
+ | AggregationBindingInfo
1758
+ | `{${string}}`;
1759
+
1760
+ /**
1761
+ * Event is raised when submit on the feeder is pressed.
1762
+ */
1763
+ commentSubmit?: (oEvent: Event) => void;
1764
+ }
1765
+ }
1766
+
1767
+ declare module "sap/uiext/inbox/composite/InboxTaskTitleControl" {
1768
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
1769
+
1770
+ import { URI } from "sap/ui/core/library";
1771
+
1772
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
1773
+
1774
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1775
+
1776
+ /**
1777
+ * InboxTaskTitleControl
1778
+ */
1779
+ export default class InboxTaskTitleControl extends Control {
1780
+ /**
1781
+ * Constructor for a new composite/InboxTaskTitleControl.
1782
+ *
1783
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1784
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1785
+ * of the syntax of the settings object.
1786
+ */
1787
+ constructor(
1788
+ /**
1789
+ * initial settings for the new control
1790
+ */
1791
+ mSettings?: $InboxTaskTitleControlSettings
1792
+ );
1793
+ /**
1794
+ * Constructor for a new composite/InboxTaskTitleControl.
1795
+ *
1796
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1797
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1798
+ * of the syntax of the settings object.
1799
+ */
1800
+ constructor(
1801
+ /**
1802
+ * id for the new control, generated automatically if no id is given
1803
+ */
1804
+ sId?: string,
1805
+ /**
1806
+ * initial settings for the new control
1807
+ */
1808
+ mSettings?: $InboxTaskTitleControlSettings
1809
+ );
1810
+
1811
+ /**
1812
+ * Creates a new subclass of class sap.uiext.inbox.composite.InboxTaskTitleControl with name `sClassName`
1813
+ * and enriches it with the information contained in `oClassInfo`.
1814
+ *
1815
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
1816
+ *
1817
+ * @returns Created class / constructor function
1818
+ */
1819
+ static extend<T extends Record<string, unknown>>(
1820
+ /**
1821
+ * Name of the class being created
1822
+ */
1823
+ sClassName: string,
1824
+ /**
1825
+ * Object literal with information about the class
1826
+ */
1827
+ oClassInfo?: sap.ClassInfo<T, InboxTaskTitleControl>,
1828
+ /**
1829
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1830
+ * used by this class
1831
+ */
1832
+ FNMetaImpl?: Function
1833
+ ): Function;
1834
+ /**
1835
+ * Returns a metadata object for class sap.uiext.inbox.composite.InboxTaskTitleControl.
1836
+ *
1837
+ * @returns Metadata object describing this class
1838
+ */
1839
+ static getMetadata(): ElementMetadata;
1840
+ /**
1841
+ * Destroys the titleLink in the aggregation {@link #getTitleLink titleLink}.
1842
+ *
1843
+ * @returns Reference to `this` in order to allow method chaining
1844
+ */
1845
+ destroyTitleLink(): this;
1846
+ /**
1847
+ * Gets current value of property {@link #getCategoryIconURI categoryIconURI}.
1848
+ *
1849
+ * Category icon
1850
+ *
1851
+ * Default value is `'hasCategory'`.
1852
+ *
1853
+ * @returns Value of property `categoryIconURI`
1854
+ */
1855
+ getCategoryIconURI(): URI;
1856
+ /**
1857
+ * Gets current value of property {@link #getHasAttachments hasAttachments}.
1858
+ *
1859
+ * has Attachments
1860
+ *
1861
+ * @returns Value of property `hasAttachments`
1862
+ */
1863
+ getHasAttachments(): boolean;
1864
+ /**
1865
+ * Gets current value of property {@link #getHasComments hasComments}.
1866
+ *
1867
+ * has Comments
1868
+ *
1869
+ * @returns Value of property `hasComments`
1870
+ */
1871
+ getHasComments(): boolean;
1872
+ /**
1873
+ * Gets current value of property {@link #getTaskTitle taskTitle}.
1874
+ *
1875
+ * The Task Title of the Task
1876
+ *
1877
+ * @returns Value of property `taskTitle`
1878
+ */
1879
+ getTaskTitle(): string;
1880
+ /**
1881
+ * Gets content of aggregation {@link #getTitleLink titleLink}.
1882
+ *
1883
+ * Internal aggregation to hold the inner Task Title Link
1884
+ */
1885
+ getTitleLink(): Control;
1886
+ /**
1887
+ * Sets a new value for property {@link #getCategoryIconURI categoryIconURI}.
1888
+ *
1889
+ * Category icon
1890
+ *
1891
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1892
+ *
1893
+ * Default value is `'hasCategory'`.
1894
+ *
1895
+ * @returns Reference to `this` in order to allow method chaining
1896
+ */
1897
+ setCategoryIconURI(
1898
+ /**
1899
+ * New value for property `categoryIconURI`
1900
+ */
1901
+ sCategoryIconURI?: URI
1902
+ ): this;
1903
+ /**
1904
+ * Sets a new value for property {@link #getHasAttachments hasAttachments}.
1905
+ *
1906
+ * has Attachments
1907
+ *
1908
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1909
+ *
1910
+ * @returns Reference to `this` in order to allow method chaining
1911
+ */
1912
+ setHasAttachments(
1913
+ /**
1914
+ * New value for property `hasAttachments`
1915
+ */
1916
+ bHasAttachments?: boolean
1917
+ ): this;
1918
+ /**
1919
+ * Sets a new value for property {@link #getHasComments hasComments}.
1920
+ *
1921
+ * has Comments
1922
+ *
1923
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1924
+ *
1925
+ * @returns Reference to `this` in order to allow method chaining
1926
+ */
1927
+ setHasComments(
1928
+ /**
1929
+ * New value for property `hasComments`
1930
+ */
1931
+ bHasComments?: boolean
1932
+ ): this;
1933
+ /**
1934
+ * Sets a new value for property {@link #getTaskTitle taskTitle}.
1935
+ *
1936
+ * The Task Title of the Task
1937
+ *
1938
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1939
+ *
1940
+ * @returns Reference to `this` in order to allow method chaining
1941
+ */
1942
+ setTaskTitle(
1943
+ /**
1944
+ * New value for property `taskTitle`
1945
+ */
1946
+ sTaskTitle?: string
1947
+ ): this;
1948
+ /**
1949
+ * Sets the aggregated {@link #getTitleLink titleLink}.
1950
+ *
1951
+ * @returns Reference to `this` in order to allow method chaining
1952
+ */
1953
+ setTitleLink(
1954
+ /**
1955
+ * The titleLink to set
1956
+ */
1957
+ oTitleLink: Control
1958
+ ): this;
1959
+ }
1960
+
1961
+ export interface $InboxTaskTitleControlSettings extends $ControlSettings {
1962
+ /**
1963
+ * The Task Title of the Task
1964
+ */
1965
+ taskTitle?: string | PropertyBindingInfo;
1966
+
1967
+ /**
1968
+ * Category icon
1969
+ */
1970
+ categoryIconURI?: URI | PropertyBindingInfo | `{${string}}`;
1971
+
1972
+ /**
1973
+ * has Attachments
1974
+ */
1975
+ hasAttachments?: boolean | PropertyBindingInfo | `{${string}}`;
1976
+
1977
+ /**
1978
+ * has Comments
1979
+ */
1980
+ hasComments?: boolean | PropertyBindingInfo | `{${string}}`;
1981
+
1982
+ /**
1983
+ * Internal aggregation to hold the inner Task Title Link
1984
+ */
1985
+ titleLink?: Control;
1986
+ }
1987
+ }
1988
+
1989
+ declare module "sap/uiext/inbox/composite/InboxUploadAttachmentTile" {
1990
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
1991
+
1992
+ import Event from "sap/ui/base/Event";
1993
+
1994
+ import { URI } from "sap/ui/core/library";
1995
+
1996
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
1997
+
1998
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1999
+
2000
+ /**
2001
+ * InboxUploadAttachmentTile
2002
+ */
2003
+ export default class InboxUploadAttachmentTile extends Control {
2004
+ /**
2005
+ * Constructor for a new composite/InboxUploadAttachmentTile.
2006
+ *
2007
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2008
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
2009
+ * of the syntax of the settings object.
2010
+ */
2011
+ constructor(
2012
+ /**
2013
+ * initial settings for the new control
2014
+ */
2015
+ mSettings?: $InboxUploadAttachmentTileSettings
2016
+ );
2017
+ /**
2018
+ * Constructor for a new composite/InboxUploadAttachmentTile.
2019
+ *
2020
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2021
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
2022
+ * of the syntax of the settings object.
2023
+ */
2024
+ constructor(
2025
+ /**
2026
+ * id for the new control, generated automatically if no id is given
2027
+ */
2028
+ sId?: string,
2029
+ /**
2030
+ * initial settings for the new control
2031
+ */
2032
+ mSettings?: $InboxUploadAttachmentTileSettings
2033
+ );
2034
+
2035
+ /**
2036
+ * Creates a new subclass of class sap.uiext.inbox.composite.InboxUploadAttachmentTile with name `sClassName`
2037
+ * and enriches it with the information contained in `oClassInfo`.
2038
+ *
2039
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
2040
+ *
2041
+ * @returns Created class / constructor function
2042
+ */
2043
+ static extend<T extends Record<string, unknown>>(
2044
+ /**
2045
+ * Name of the class being created
2046
+ */
2047
+ sClassName: string,
2048
+ /**
2049
+ * Object literal with information about the class
2050
+ */
2051
+ oClassInfo?: sap.ClassInfo<T, InboxUploadAttachmentTile>,
2052
+ /**
2053
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2054
+ * used by this class
2055
+ */
2056
+ FNMetaImpl?: Function
2057
+ ): Function;
2058
+ /**
2059
+ * Returns a metadata object for class sap.uiext.inbox.composite.InboxUploadAttachmentTile.
2060
+ *
2061
+ * @returns Metadata object describing this class
2062
+ */
2063
+ static getMetadata(): ElementMetadata;
2064
+ /**
2065
+ * Attaches event handler `fnFunction` to the {@link #event:uploadSelectedFile uploadSelectedFile} event
2066
+ * of this `sap.uiext.inbox.composite.InboxUploadAttachmentTile`.
2067
+ *
2068
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2069
+ * otherwise it will be bound to this `sap.uiext.inbox.composite.InboxUploadAttachmentTile` itself.
2070
+ *
2071
+ * event is fired when upload for selected file is requested
2072
+ *
2073
+ * @returns Reference to `this` in order to allow method chaining
2074
+ */
2075
+ attachUploadSelectedFile(
2076
+ /**
2077
+ * An application-specific payload object that will be passed to the event handler along with the event
2078
+ * object when firing the event
2079
+ */
2080
+ oData: object,
2081
+ /**
2082
+ * The function to be called when the event occurs
2083
+ */
2084
+ fnFunction: (p1: Event) => void,
2085
+ /**
2086
+ * Context object to call the event handler with. Defaults to this `sap.uiext.inbox.composite.InboxUploadAttachmentTile`
2087
+ * itself
2088
+ */
2089
+ oListener?: object
2090
+ ): this;
2091
+ /**
2092
+ * Attaches event handler `fnFunction` to the {@link #event:uploadSelectedFile uploadSelectedFile} event
2093
+ * of this `sap.uiext.inbox.composite.InboxUploadAttachmentTile`.
2094
+ *
2095
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2096
+ * otherwise it will be bound to this `sap.uiext.inbox.composite.InboxUploadAttachmentTile` itself.
2097
+ *
2098
+ * event is fired when upload for selected file is requested
2099
+ *
2100
+ * @returns Reference to `this` in order to allow method chaining
2101
+ */
2102
+ attachUploadSelectedFile(
2103
+ /**
2104
+ * The function to be called when the event occurs
2105
+ */
2106
+ fnFunction: (p1: Event) => void,
2107
+ /**
2108
+ * Context object to call the event handler with. Defaults to this `sap.uiext.inbox.composite.InboxUploadAttachmentTile`
2109
+ * itself
2110
+ */
2111
+ oListener?: object
2112
+ ): this;
2113
+ /**
2114
+ * Detaches event handler `fnFunction` from the {@link #event:uploadSelectedFile uploadSelectedFile} event
2115
+ * of this `sap.uiext.inbox.composite.InboxUploadAttachmentTile`.
2116
+ *
2117
+ * The passed function and listener object must match the ones used for event registration.
2118
+ *
2119
+ * @returns Reference to `this` in order to allow method chaining
2120
+ */
2121
+ detachUploadSelectedFile(
2122
+ /**
2123
+ * The function to be called, when the event occurs
2124
+ */
2125
+ fnFunction: (p1: Event) => void,
2126
+ /**
2127
+ * Context object on which the given function had to be called
2128
+ */
2129
+ oListener?: object
2130
+ ): this;
2131
+ /**
2132
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2133
+ *
2134
+ * Fires event {@link #event:uploadSelectedFile uploadSelectedFile} to attached listeners.
2135
+ *
2136
+ * @returns Reference to `this` in order to allow method chaining
2137
+ */
2138
+ fireUploadSelectedFile(
2139
+ /**
2140
+ * Parameters to pass along with the event
2141
+ */
2142
+ mParameters?: object
2143
+ ): this;
2144
+ /**
2145
+ * Gets current value of property {@link #getFileName fileName}.
2146
+ *
2147
+ * name of the selected file
2148
+ *
2149
+ * @returns Value of property `fileName`
2150
+ */
2151
+ getFileName(): string;
2152
+ /**
2153
+ * Gets current value of property {@link #getFileTypeIcon fileTypeIcon}.
2154
+ *
2155
+ * icon URI of the selected file type
2156
+ *
2157
+ * @returns Value of property `fileTypeIcon`
2158
+ */
2159
+ getFileTypeIcon(): URI;
2160
+ /**
2161
+ * Sets a new value for property {@link #getFileName fileName}.
2162
+ *
2163
+ * name of the selected file
2164
+ *
2165
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2166
+ *
2167
+ * @returns Reference to `this` in order to allow method chaining
2168
+ */
2169
+ setFileName(
2170
+ /**
2171
+ * New value for property `fileName`
2172
+ */
2173
+ sFileName?: string
2174
+ ): this;
2175
+ /**
2176
+ * Sets a new value for property {@link #getFileTypeIcon fileTypeIcon}.
2177
+ *
2178
+ * icon URI of the selected file type
2179
+ *
2180
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2181
+ *
2182
+ * @returns Reference to `this` in order to allow method chaining
2183
+ */
2184
+ setFileTypeIcon(
2185
+ /**
2186
+ * New value for property `fileTypeIcon`
2187
+ */
2188
+ sFileTypeIcon?: URI
2189
+ ): this;
2190
+ }
2191
+
2192
+ export interface $InboxUploadAttachmentTileSettings extends $ControlSettings {
2193
+ /**
2194
+ * name of the selected file
2195
+ */
2196
+ fileName?: string | PropertyBindingInfo;
2197
+
2198
+ /**
2199
+ * icon URI of the selected file type
2200
+ */
2201
+ fileTypeIcon?: URI | PropertyBindingInfo | `{${string}}`;
2202
+
2203
+ /**
2204
+ * event is fired when upload for selected file is requested
2205
+ */
2206
+ uploadSelectedFile?: (oEvent: Event) => void;
2207
+ }
2208
+ }
2209
+
2210
+ declare module "sap/uiext/inbox/Inbox" {
2211
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
2212
+
2213
+ import Event from "sap/ui/base/Event";
2214
+
2215
+ import Sorter from "sap/ui/model/Sorter";
2216
+
2217
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
2218
+
2219
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
2220
+
2221
+ /**
2222
+ * @deprecated (since 1.38.0)
2223
+ * @EXPERIMENTAL (since 1.5.2) - API is not yet finished and might change completely
2224
+ *
2225
+ * A comprehensive UI design approach with graphical and functional elements for search tasks, filter tasks,
2226
+ * and take actions on the tasks ("Inbox Pattern").
2227
+ */
2228
+ export default class Inbox extends Control {
2229
+ /**
2230
+ * Constructor for a new Inbox.
2231
+ *
2232
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2233
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
2234
+ * of the syntax of the settings object.
2235
+ */
2236
+ constructor(
2237
+ /**
2238
+ * initial settings for the new control
2239
+ */
2240
+ mSettings?: $InboxSettings
2241
+ );
2242
+ /**
2243
+ * Constructor for a new Inbox.
2244
+ *
2245
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2246
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
2247
+ * of the syntax of the settings object.
2248
+ */
2249
+ constructor(
2250
+ /**
2251
+ * id for the new control, generated automatically if no id is given
2252
+ */
2253
+ sId?: string,
2254
+ /**
2255
+ * initial settings for the new control
2256
+ */
2257
+ mSettings?: $InboxSettings
2258
+ );
2259
+
2260
+ /**
2261
+ * Creates a new subclass of class sap.uiext.inbox.Inbox with name `sClassName` and enriches it with the
2262
+ * information contained in `oClassInfo`.
2263
+ *
2264
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
2265
+ *
2266
+ * @returns Created class / constructor function
2267
+ */
2268
+ static extend<T extends Record<string, unknown>>(
2269
+ /**
2270
+ * Name of the class being created
2271
+ */
2272
+ sClassName: string,
2273
+ /**
2274
+ * Object literal with information about the class
2275
+ */
2276
+ oClassInfo?: sap.ClassInfo<T, Inbox>,
2277
+ /**
2278
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2279
+ * used by this class
2280
+ */
2281
+ FNMetaImpl?: Function
2282
+ ): Function;
2283
+ /**
2284
+ * Returns a metadata object for class sap.uiext.inbox.Inbox.
2285
+ *
2286
+ * @returns Metadata object describing this class
2287
+ */
2288
+ static getMetadata(): ElementMetadata;
2289
+ /**
2290
+ * Adds an additional action to inbox
2291
+ */
2292
+ addAction(
2293
+ /**
2294
+ * ID of the new action.
2295
+ */
2296
+ sActionID: string,
2297
+ /**
2298
+ * The Label Text for the new action.
2299
+ */
2300
+ sDisplayText: string,
2301
+ /**
2302
+ * Tooltip for the added action.
2303
+ */
2304
+ sToolTip: string,
2305
+ /**
2306
+ * Function to be called when the action is executed
2307
+ */
2308
+ fnActionHandler: Function,
2309
+ /**
2310
+ * Flag indicating if the action is mass enabled.Default value is true.
2311
+ */
2312
+ bMassEnabled: boolean
2313
+ ): Inbox;
2314
+ /**
2315
+ * Attaches event handler `fnFunction` to the {@link #event:oDataRequestCompleted oDataRequestCompleted}
2316
+ * event of this `sap.uiext.inbox.Inbox`.
2317
+ *
2318
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2319
+ * otherwise it will be bound to this `sap.uiext.inbox.Inbox` itself.
2320
+ *
2321
+ * If handleBindings property is set to true , the control assumes an oData model is set and handles the
2322
+ * complete logic within. In this case once the oData request is complete, this event is fired with additional
2323
+ * parameters.
2324
+ *
2325
+ * @returns Reference to `this` in order to allow method chaining
2326
+ */
2327
+ attachODataRequestCompleted(
2328
+ /**
2329
+ * An application-specific payload object that will be passed to the event handler along with the event
2330
+ * object when firing the event
2331
+ */
2332
+ oData: object,
2333
+ /**
2334
+ * The function to be called when the event occurs
2335
+ */
2336
+ fnFunction: (p1: Event) => void,
2337
+ /**
2338
+ * Context object to call the event handler with. Defaults to this `sap.uiext.inbox.Inbox` itself
2339
+ */
2340
+ oListener?: object
2341
+ ): this;
2342
+ /**
2343
+ * Attaches event handler `fnFunction` to the {@link #event:oDataRequestCompleted oDataRequestCompleted}
2344
+ * event of this `sap.uiext.inbox.Inbox`.
2345
+ *
2346
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2347
+ * otherwise it will be bound to this `sap.uiext.inbox.Inbox` itself.
2348
+ *
2349
+ * If handleBindings property is set to true , the control assumes an oData model is set and handles the
2350
+ * complete logic within. In this case once the oData request is complete, this event is fired with additional
2351
+ * parameters.
2352
+ *
2353
+ * @returns Reference to `this` in order to allow method chaining
2354
+ */
2355
+ attachODataRequestCompleted(
2356
+ /**
2357
+ * The function to be called when the event occurs
2358
+ */
2359
+ fnFunction: (p1: Event) => void,
2360
+ /**
2361
+ * Context object to call the event handler with. Defaults to this `sap.uiext.inbox.Inbox` itself
2362
+ */
2363
+ oListener?: object
2364
+ ): this;
2365
+ /**
2366
+ * Attaches event handler `fnFunction` to the {@link #event:refresh refresh} event of this `sap.uiext.inbox.Inbox`.
2367
+ *
2368
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2369
+ * otherwise it will be bound to this `sap.uiext.inbox.Inbox` itself.
2370
+ *
2371
+ * this event is fires to handle refresh Action, when the handleBindings property is set to false.
2372
+ *
2373
+ * @returns Reference to `this` in order to allow method chaining
2374
+ */
2375
+ attachRefresh(
2376
+ /**
2377
+ * An application-specific payload object that will be passed to the event handler along with the event
2378
+ * object when firing the event
2379
+ */
2380
+ oData: object,
2381
+ /**
2382
+ * The function to be called when the event occurs
2383
+ */
2384
+ fnFunction: (p1: Event) => void,
2385
+ /**
2386
+ * Context object to call the event handler with. Defaults to this `sap.uiext.inbox.Inbox` itself
2387
+ */
2388
+ oListener?: object
2389
+ ): this;
2390
+ /**
2391
+ * Attaches event handler `fnFunction` to the {@link #event:refresh refresh} event of this `sap.uiext.inbox.Inbox`.
2392
+ *
2393
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2394
+ * otherwise it will be bound to this `sap.uiext.inbox.Inbox` itself.
2395
+ *
2396
+ * this event is fires to handle refresh Action, when the handleBindings property is set to false.
2397
+ *
2398
+ * @returns Reference to `this` in order to allow method chaining
2399
+ */
2400
+ attachRefresh(
2401
+ /**
2402
+ * The function to be called when the event occurs
2403
+ */
2404
+ fnFunction: (p1: Event) => void,
2405
+ /**
2406
+ * Context object to call the event handler with. Defaults to this `sap.uiext.inbox.Inbox` itself
2407
+ */
2408
+ oListener?: object
2409
+ ): this;
2410
+ /**
2411
+ * Attaches event handler `fnFunction` to the {@link #event:taskAction taskAction} event of this `sap.uiext.inbox.Inbox`.
2412
+ *
2413
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2414
+ * otherwise it will be bound to this `sap.uiext.inbox.Inbox` itself.
2415
+ *
2416
+ * this event is fires to handle task Actions - Claim, Release, when the handleBindings property is set
2417
+ * to false.
2418
+ *
2419
+ * @returns Reference to `this` in order to allow method chaining
2420
+ */
2421
+ attachTaskAction(
2422
+ /**
2423
+ * An application-specific payload object that will be passed to the event handler along with the event
2424
+ * object when firing the event
2425
+ */
2426
+ oData: object,
2427
+ /**
2428
+ * The function to be called when the event occurs
2429
+ */
2430
+ fnFunction: (p1: Event) => void,
2431
+ /**
2432
+ * Context object to call the event handler with. Defaults to this `sap.uiext.inbox.Inbox` itself
2433
+ */
2434
+ oListener?: object
2435
+ ): this;
2436
+ /**
2437
+ * Attaches event handler `fnFunction` to the {@link #event:taskAction taskAction} event of this `sap.uiext.inbox.Inbox`.
2438
+ *
2439
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2440
+ * otherwise it will be bound to this `sap.uiext.inbox.Inbox` itself.
2441
+ *
2442
+ * this event is fires to handle task Actions - Claim, Release, when the handleBindings property is set
2443
+ * to false.
2444
+ *
2445
+ * @returns Reference to `this` in order to allow method chaining
2446
+ */
2447
+ attachTaskAction(
2448
+ /**
2449
+ * The function to be called when the event occurs
2450
+ */
2451
+ fnFunction: (p1: Event) => void,
2452
+ /**
2453
+ * Context object to call the event handler with. Defaults to this `sap.uiext.inbox.Inbox` itself
2454
+ */
2455
+ oListener?: object
2456
+ ): this;
2457
+ /**
2458
+ * Attaches event handler `fnFunction` to the {@link #event:taskSelectionChange taskSelectionChange} event
2459
+ * of this `sap.uiext.inbox.Inbox`.
2460
+ *
2461
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2462
+ * otherwise it will be bound to this `sap.uiext.inbox.Inbox` itself.
2463
+ *
2464
+ * This event is fired when table row selection is changed in the list view of Inbox control
2465
+ *
2466
+ * @returns Reference to `this` in order to allow method chaining
2467
+ */
2468
+ attachTaskSelectionChange(
2469
+ /**
2470
+ * An application-specific payload object that will be passed to the event handler along with the event
2471
+ * object when firing the event
2472
+ */
2473
+ oData: object,
2474
+ /**
2475
+ * The function to be called when the event occurs
2476
+ */
2477
+ fnFunction: (p1: Event) => void,
2478
+ /**
2479
+ * Context object to call the event handler with. Defaults to this `sap.uiext.inbox.Inbox` itself
2480
+ */
2481
+ oListener?: object
2482
+ ): this;
2483
+ /**
2484
+ * Attaches event handler `fnFunction` to the {@link #event:taskSelectionChange taskSelectionChange} event
2485
+ * of this `sap.uiext.inbox.Inbox`.
2486
+ *
2487
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2488
+ * otherwise it will be bound to this `sap.uiext.inbox.Inbox` itself.
2489
+ *
2490
+ * This event is fired when table row selection is changed in the list view of Inbox control
2491
+ *
2492
+ * @returns Reference to `this` in order to allow method chaining
2493
+ */
2494
+ attachTaskSelectionChange(
2495
+ /**
2496
+ * The function to be called when the event occurs
2497
+ */
2498
+ fnFunction: (p1: Event) => void,
2499
+ /**
2500
+ * Context object to call the event handler with. Defaults to this `sap.uiext.inbox.Inbox` itself
2501
+ */
2502
+ oListener?: object
2503
+ ): this;
2504
+ /**
2505
+ * Registers a callback function to be invoked to search on the Task Table.
2506
+ */
2507
+ bindSearch(
2508
+ /**
2509
+ * callback function to be called to execute a search
2510
+ */
2511
+ searchCallBack: Function
2512
+ ): Inbox;
2513
+ /**
2514
+ * Registers a callback function to be invoked to populate the Task Execution PopUp.
2515
+ */
2516
+ bindTaskExecutionURL(
2517
+ /**
2518
+ * callback function for getting the execution URL, will be supplied with the task ID and should return
2519
+ * the URL to be displayed with the Task Execution PopUp.
2520
+ */
2521
+ taskExecURLfnCallBack: Function,
2522
+ /**
2523
+ * callback function for getting the status of the task, will be supplied with the task ID and should return
2524
+ * the Task Status.
2525
+ */
2526
+ taskExecURLStatusCallBack: Function
2527
+ ): Inbox;
2528
+ /**
2529
+ * Bind the Inbox Task Collection
2530
+ */
2531
+ bindTasks(
2532
+ /**
2533
+ * Binding path for the element displaying the tasks within the Inbox. This path is the Task Collection
2534
+ * according to the TCM (Task Consumption Model)
2535
+ */
2536
+ sPath: string,
2537
+ /**
2538
+ * Predefined filter that is applied to the Task Collection before displaying the tasks in the Inbox. (sap.uiext.inbox.InboxFilters)
2539
+ */
2540
+ oFilter: object,
2541
+ /**
2542
+ * {}Predefined sorter that is applied to the Task Collection before displaying the tasks in the Inbox.
2543
+ * By default the tasks are sorted on 'CreatedOn' , descending, according to TCM. The sorter is not validated
2544
+ * for the path being a valid TCM Entity Property. The sorter passed will be applied to the oData service
2545
+ * as is. In case the entity Property in the path is a sortable property on the UI, the sorter indicator
2546
+ * for that property will be visible.
2547
+ */
2548
+ oSorter: Sorter
2549
+ ): Inbox;
2550
+ /**
2551
+ * Binds the Task Table Rows to the given path.
2552
+ */
2553
+ bindTaskTable(
2554
+ /**
2555
+ * Binding path for the rows of the Task Table
2556
+ */
2557
+ sPath: string,
2558
+ /**
2559
+ * Predefined filter for the Task Table (sap.uiext.inbox.TaskInitialFilters)
2560
+ */
2561
+ oTaskFilters: object
2562
+ ): Inbox;
2563
+ /**
2564
+ * Registers a callback function to be invoked to populate the TaskType Drill Down. This should return the
2565
+ * array of Values to be populated in the Task Type Drill Down.
2566
+ */
2567
+ bindTaskTypeDynamicFilter(
2568
+ /**
2569
+ * callback function that populates the TaskType Drill Down
2570
+ */
2571
+ taskTypeDynamicFilterCallBack: Function
2572
+ ): Inbox;
2573
+ /**
2574
+ * Clears all the filters applied in Drill Down. (Status, Priority, Date/Time and TaskType).
2575
+ */
2576
+ clearDrillDownFilter(): void;
2577
+ /**
2578
+ * Row Settings applied using the Settings button shall be cleared.
2579
+ */
2580
+ clearRowSettings(): void;
2581
+ /**
2582
+ * Detaches event handler `fnFunction` from the {@link #event:oDataRequestCompleted oDataRequestCompleted}
2583
+ * event of this `sap.uiext.inbox.Inbox`.
2584
+ *
2585
+ * The passed function and listener object must match the ones used for event registration.
2586
+ *
2587
+ * @returns Reference to `this` in order to allow method chaining
2588
+ */
2589
+ detachODataRequestCompleted(
2590
+ /**
2591
+ * The function to be called, when the event occurs
2592
+ */
2593
+ fnFunction: (p1: Event) => void,
2594
+ /**
2595
+ * Context object on which the given function had to be called
2596
+ */
2597
+ oListener?: object
2598
+ ): this;
2599
+ /**
2600
+ * Detaches event handler `fnFunction` from the {@link #event:refresh refresh} event of this `sap.uiext.inbox.Inbox`.
2601
+ *
2602
+ * The passed function and listener object must match the ones used for event registration.
2603
+ *
2604
+ * @returns Reference to `this` in order to allow method chaining
2605
+ */
2606
+ detachRefresh(
2607
+ /**
2608
+ * The function to be called, when the event occurs
2609
+ */
2610
+ fnFunction: (p1: Event) => void,
2611
+ /**
2612
+ * Context object on which the given function had to be called
2613
+ */
2614
+ oListener?: object
2615
+ ): this;
2616
+ /**
2617
+ * Detaches event handler `fnFunction` from the {@link #event:taskAction taskAction} event of this `sap.uiext.inbox.Inbox`.
2618
+ *
2619
+ * The passed function and listener object must match the ones used for event registration.
2620
+ *
2621
+ * @returns Reference to `this` in order to allow method chaining
2622
+ */
2623
+ detachTaskAction(
2624
+ /**
2625
+ * The function to be called, when the event occurs
2626
+ */
2627
+ fnFunction: (p1: Event) => void,
2628
+ /**
2629
+ * Context object on which the given function had to be called
2630
+ */
2631
+ oListener?: object
2632
+ ): this;
2633
+ /**
2634
+ * Detaches event handler `fnFunction` from the {@link #event:taskSelectionChange taskSelectionChange} event
2635
+ * of this `sap.uiext.inbox.Inbox`.
2636
+ *
2637
+ * The passed function and listener object must match the ones used for event registration.
2638
+ *
2639
+ * @returns Reference to `this` in order to allow method chaining
2640
+ */
2641
+ detachTaskSelectionChange(
2642
+ /**
2643
+ * The function to be called, when the event occurs
2644
+ */
2645
+ fnFunction: (p1: Event) => void,
2646
+ /**
2647
+ * Context object on which the given function had to be called
2648
+ */
2649
+ oListener?: object
2650
+ ): this;
2651
+ /**
2652
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2653
+ *
2654
+ * Fires event {@link #event:oDataRequestCompleted oDataRequestCompleted} to attached listeners.
2655
+ *
2656
+ * @returns Reference to `this` in order to allow method chaining
2657
+ */
2658
+ fireODataRequestCompleted(
2659
+ /**
2660
+ * Parameters to pass along with the event
2661
+ */
2662
+ mParameters?: object
2663
+ ): this;
2664
+ /**
2665
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2666
+ *
2667
+ * Fires event {@link #event:refresh refresh} to attached listeners.
2668
+ *
2669
+ * @returns Reference to `this` in order to allow method chaining
2670
+ */
2671
+ fireRefresh(
2672
+ /**
2673
+ * Parameters to pass along with the event
2674
+ */
2675
+ mParameters?: object
2676
+ ): this;
2677
+ /**
2678
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2679
+ *
2680
+ * Fires event {@link #event:taskAction taskAction} to attached listeners.
2681
+ *
2682
+ * @returns Reference to `this` in order to allow method chaining
2683
+ */
2684
+ fireTaskAction(
2685
+ /**
2686
+ * Parameters to pass along with the event
2687
+ */
2688
+ mParameters?: object
2689
+ ): this;
2690
+ /**
2691
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2692
+ *
2693
+ * Fires event {@link #event:taskSelectionChange taskSelectionChange} to attached listeners.
2694
+ *
2695
+ * @returns Reference to `this` in order to allow method chaining
2696
+ */
2697
+ fireTaskSelectionChange(
2698
+ /**
2699
+ * Parameters to pass along with the event
2700
+ */
2701
+ mParameters?: object
2702
+ ): this;
2703
+ /**
2704
+ * Gets current value of property {@link #getHandleBindings handleBindings}.
2705
+ *
2706
+ * set this as true for oData Model. If set as false, the user will need to handle task Actions, search
2707
+ * and Task Execution URL population. See function call back methods.
2708
+ *
2709
+ * Default value is `true`.
2710
+ *
2711
+ * @returns Value of property `handleBindings`
2712
+ */
2713
+ getHandleBindings(): boolean;
2714
+ /**
2715
+ * Gets current value of property {@link #getOpenCompletedTasks openCompletedTasks}.
2716
+ *
2717
+ * set this to true to enable opening of completed tasks.
2718
+ *
2719
+ * Default value is `false`.
2720
+ *
2721
+ * @returns Value of property `openCompletedTasks`
2722
+ */
2723
+ getOpenCompletedTasks(): boolean;
2724
+ /**
2725
+ * Getter for property isSubstitutionEnabled.
2726
+ *
2727
+ * Boolean property to enable the sap.uiext.inbox.SubstitutionRulesManager control (default is false). If
2728
+ * is true, 'Manage Substitution Rules' is visible in settings button, else if it is false the option will
2729
+ * not be visible under settings.
2730
+ *
2731
+ * Default value is false
2732
+ */
2733
+ getSubstitutionEnabled(): boolean;
2734
+ /**
2735
+ * Gets current value of property {@link #getTaskExecutionURLThemeValue taskExecutionURLThemeValue}.
2736
+ *
2737
+ * set the theme URL parameter string to be appended to the task Execution URL. In case of a function callback
2738
+ * set for Task Execution PopUp, this string will not be appended.
2739
+ *
2740
+ * @returns Value of property `taskExecutionURLThemeValue`
2741
+ */
2742
+ getTaskExecutionURLThemeValue(): string;
2743
+ /**
2744
+ * returns the binding for the Task Table
2745
+ */
2746
+ getTaskTableBinding(): object;
2747
+ /**
2748
+ * Inbox is refreshed if task is completed
2749
+ */
2750
+ refresh(
2751
+ /**
2752
+ * Array of Json objects containing TaskInstanceID and SAP__Origin
2753
+ */
2754
+ aTaskUniqueIdentifiers: object[]
2755
+ ): void;
2756
+ /**
2757
+ * Set configuration on Inbox. See APIs in InboxConfiguration
2758
+ */
2759
+ setConfiguration(
2760
+ /**
2761
+ * Configuration object to set the configuration on Inbox. See APIs in InboxConfiguration
2762
+ */
2763
+ oConfiguration: object
2764
+ ): Inbox;
2765
+ /**
2766
+ * Sets a new value for property {@link #getHandleBindings handleBindings}.
2767
+ *
2768
+ * set this as true for oData Model. If set as false, the user will need to handle task Actions, search
2769
+ * and Task Execution URL population. See function call back methods.
2770
+ *
2771
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2772
+ *
2773
+ * Default value is `true`.
2774
+ *
2775
+ * @returns Reference to `this` in order to allow method chaining
2776
+ */
2777
+ setHandleBindings(
2778
+ /**
2779
+ * New value for property `handleBindings`
2780
+ */
2781
+ bHandleBindings?: boolean
2782
+ ): this;
2783
+ /**
2784
+ * Sets a new value for property {@link #getOpenCompletedTasks openCompletedTasks}.
2785
+ *
2786
+ * set this to true to enable opening of completed tasks.
2787
+ *
2788
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2789
+ *
2790
+ * Default value is `false`.
2791
+ *
2792
+ * @returns Reference to `this` in order to allow method chaining
2793
+ */
2794
+ setOpenCompletedTasks(
2795
+ /**
2796
+ * New value for property `openCompletedTasks`
2797
+ */
2798
+ bOpenCompletedTasks?: boolean
2799
+ ): this;
2800
+ /**
2801
+ * Setter for property bOpenTaskUIInNewTab. If set to true, Task UI will opene in a new tab. Default value
2802
+ * is false.
2803
+ */
2804
+ setOpenTaskUIInNewTab(): void;
2805
+ /**
2806
+ * Setter for property isSubstitutionEnabled.
2807
+ *
2808
+ * Boolean property to enable the sap.uiext.inbox.SubstitutionRulesManager control (default is false). If
2809
+ * set to true, 'Manage Substitution Rules' is visible in settings button, else if set to false the option
2810
+ * will not be visible under settings.
2811
+ *
2812
+ * Default value is false
2813
+ */
2814
+ setSubstitutionEnabled(
2815
+ /**
2816
+ * isSubstitutionEnabled
2817
+ */
2818
+ bIsSubstitutionEnabled: boolean,
2819
+ /**
2820
+ * the path
2821
+ */
2822
+ path: string
2823
+ ): void;
2824
+ /**
2825
+ * Sets a new value for property {@link #getTaskExecutionURLThemeValue taskExecutionURLThemeValue}.
2826
+ *
2827
+ * set the theme URL parameter string to be appended to the task Execution URL. In case of a function callback
2828
+ * set for Task Execution PopUp, this string will not be appended.
2829
+ *
2830
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2831
+ *
2832
+ * @returns Reference to `this` in order to allow method chaining
2833
+ */
2834
+ setTaskExecutionURLThemeValue(
2835
+ /**
2836
+ * New value for property `taskExecutionURLThemeValue`
2837
+ */
2838
+ sTaskExecutionURLThemeValue?: string
2839
+ ): this;
2840
+ }
2841
+
2842
+ export interface $InboxSettings extends $ControlSettings {
2843
+ /**
2844
+ * set the theme URL parameter string to be appended to the task Execution URL. In case of a function callback
2845
+ * set for Task Execution PopUp, this string will not be appended.
2846
+ */
2847
+ taskExecutionURLThemeValue?: string | PropertyBindingInfo;
2848
+
2849
+ /**
2850
+ * set this as true for oData Model. If set as false, the user will need to handle task Actions, search
2851
+ * and Task Execution URL population. See function call back methods.
2852
+ */
2853
+ handleBindings?: boolean | PropertyBindingInfo | `{${string}}`;
2854
+
2855
+ /**
2856
+ * set this to true to enable opening of completed tasks.
2857
+ */
2858
+ openCompletedTasks?: boolean | PropertyBindingInfo | `{${string}}`;
2859
+
2860
+ /**
2861
+ * If handleBindings property is set to true , the control assumes an oData model is set and handles the
2862
+ * complete logic within. In this case once the oData request is complete, this event is fired with additional
2863
+ * parameters.
2864
+ */
2865
+ oDataRequestCompleted?: (oEvent: Event) => void;
2866
+
2867
+ /**
2868
+ * this event is fires to handle refresh Action, when the handleBindings property is set to false.
2869
+ */
2870
+ refresh?: (oEvent: Event) => void;
2871
+
2872
+ /**
2873
+ * this event is fires to handle task Actions - Claim, Release, when the handleBindings property is set
2874
+ * to false.
2875
+ */
2876
+ taskAction?: (oEvent: Event) => void;
2877
+
2878
+ /**
2879
+ * This event is fired when table row selection is changed in the list view of Inbox control
2880
+ */
2881
+ taskSelectionChange?: (oEvent: Event) => void;
2882
+ }
2883
+ }
2884
+
2885
+ declare module "sap/uiext/inbox/InboxConfiguration" {
2886
+ import BaseObject from "sap/ui/base/Object";
2887
+
2888
+ import Metadata from "sap/ui/base/Metadata";
2889
+
2890
+ /**
2891
+ * Configuration for Inbox
2892
+ */
2893
+ export default class InboxConfiguration extends BaseObject {
2894
+ /**
2895
+ * Constructor for InboxConfiguration
2896
+ */
2897
+ constructor();
2898
+
2899
+ /**
2900
+ * Creates a new subclass of class sap.uiext.inbox.InboxConfiguration with name `sClassName` and enriches
2901
+ * it with the information contained in `oClassInfo`.
2902
+ *
2903
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
2904
+ *
2905
+ * @returns Created class / constructor function
2906
+ */
2907
+ static extend<T extends Record<string, unknown>>(
2908
+ /**
2909
+ * Name of the class being created
2910
+ */
2911
+ sClassName: string,
2912
+ /**
2913
+ * Object literal with information about the class
2914
+ */
2915
+ oClassInfo?: sap.ClassInfo<T, InboxConfiguration>,
2916
+ /**
2917
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2918
+ * used by this class
2919
+ */
2920
+ FNMetaImpl?: Function
2921
+ ): Function;
2922
+ /**
2923
+ * Returns a metadata object for class sap.uiext.inbox.InboxConfiguration.
2924
+ *
2925
+ * @returns Metadata object describing this class
2926
+ */
2927
+ static getMetadata(): Metadata;
2928
+ /**
2929
+ * Getter for Max Limit for user search in Inbox
2930
+ */
2931
+ getSearchUersMaxLimit(): number;
2932
+ /**
2933
+ * Setter for Max Limit for user search in Inbox
2934
+ */
2935
+ setSearchUersMaxLimit(iMaxLimit: number): void;
2936
+ }
2937
+ }
2938
+
2939
+ declare module "sap/uiext/inbox/InboxFilters" {
2940
+ import BaseObject from "sap/ui/base/Object";
2941
+
2942
+ import Metadata from "sap/ui/base/Metadata";
2943
+
2944
+ import InboxPrimaryFilters from "sap/uiext/inbox/InboxPrimaryFilters";
2945
+
2946
+ import InboxSecondaryFilters from "sap/uiext/inbox/InboxSecondaryFilters";
2947
+
2948
+ /**
2949
+ * PreDefined Filters for Inbox
2950
+ */
2951
+ export default class InboxFilters extends BaseObject {
2952
+ /**
2953
+ * Constructor for InboxFilters
2954
+ */
2955
+ constructor();
2956
+
2957
+ /**
2958
+ * Creates a new subclass of class sap.uiext.inbox.InboxFilters with name `sClassName` and enriches it with
2959
+ * the information contained in `oClassInfo`.
2960
+ *
2961
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
2962
+ *
2963
+ * @returns Created class / constructor function
2964
+ */
2965
+ static extend<T extends Record<string, unknown>>(
2966
+ /**
2967
+ * Name of the class being created
2968
+ */
2969
+ sClassName: string,
2970
+ /**
2971
+ * Object literal with information about the class
2972
+ */
2973
+ oClassInfo?: sap.ClassInfo<T, InboxFilters>,
2974
+ /**
2975
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2976
+ * used by this class
2977
+ */
2978
+ FNMetaImpl?: Function
2979
+ ): Function;
2980
+ /**
2981
+ * Returns a metadata object for class sap.uiext.inbox.InboxFilters.
2982
+ *
2983
+ * @returns Metadata object describing this class
2984
+ */
2985
+ static getMetadata(): Metadata;
2986
+ /**
2987
+ * Getter for Primary filters
2988
+ */
2989
+ getPrimaryFilterr(): InboxPrimaryFilters;
2990
+ /**
2991
+ * Getter for Secondary filters
2992
+ */
2993
+ getSecondaryFilter(): InboxSecondaryFilters;
2994
+ /**
2995
+ * Setter for the Primary filters to be applied
2996
+ */
2997
+ setPrimaryFilter(oPrimaryFilter: InboxPrimaryFilters): void;
2998
+ /**
2999
+ * Setter for Secondary filters to be applied
3000
+ */
3001
+ setSecondaryFilter(oSecondaryFilter: InboxSecondaryFilters): void;
3002
+ }
3003
+ }
3004
+
3005
+ declare module "sap/uiext/inbox/InboxLaunchPad" {
3006
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
3007
+
3008
+ import Event from "sap/ui/base/Event";
3009
+
3010
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
3011
+
3012
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
3013
+
3014
+ /**
3015
+ * @EXPERIMENTAL (since 1.7.0) - API is not yet finished and might change completely
3016
+ *
3017
+ * InboxLaunchPad Documentation to be updated later
3018
+ */
3019
+ export default class InboxLaunchPad extends Control {
3020
+ /**
3021
+ * Constructor for a new InboxLaunchPad.
3022
+ *
3023
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
3024
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
3025
+ * of the syntax of the settings object.
3026
+ */
3027
+ constructor(
3028
+ /**
3029
+ * initial settings for the new control
3030
+ */
3031
+ mSettings?: $InboxLaunchPadSettings
3032
+ );
3033
+ /**
3034
+ * Constructor for a new InboxLaunchPad.
3035
+ *
3036
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
3037
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
3038
+ * of the syntax of the settings object.
3039
+ */
3040
+ constructor(
3041
+ /**
3042
+ * id for the new control, generated automatically if no id is given
3043
+ */
3044
+ sId?: string,
3045
+ /**
3046
+ * initial settings for the new control
3047
+ */
3048
+ mSettings?: $InboxLaunchPadSettings
3049
+ );
3050
+
3051
+ /**
3052
+ * Creates a new subclass of class sap.uiext.inbox.InboxLaunchPad with name `sClassName` and enriches it
3053
+ * with the information contained in `oClassInfo`.
3054
+ *
3055
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
3056
+ *
3057
+ * @returns Created class / constructor function
3058
+ */
3059
+ static extend<T extends Record<string, unknown>>(
3060
+ /**
3061
+ * Name of the class being created
3062
+ */
3063
+ sClassName: string,
3064
+ /**
3065
+ * Object literal with information about the class
3066
+ */
3067
+ oClassInfo?: sap.ClassInfo<T, InboxLaunchPad>,
3068
+ /**
3069
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
3070
+ * used by this class
3071
+ */
3072
+ FNMetaImpl?: Function
3073
+ ): Function;
3074
+ /**
3075
+ * Returns a metadata object for class sap.uiext.inbox.InboxLaunchPad.
3076
+ *
3077
+ * @returns Metadata object describing this class
3078
+ */
3079
+ static getMetadata(): ElementMetadata;
3080
+ /**
3081
+ * Attaches event handler `fnFunction` to the {@link #event:logout logout} event of this `sap.uiext.inbox.InboxLaunchPad`.
3082
+ *
3083
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
3084
+ * otherwise it will be bound to this `sap.uiext.inbox.InboxLaunchPad` itself.
3085
+ *
3086
+ * Fired when the user clicks the "Log-off" button.
3087
+ *
3088
+ * @returns Reference to `this` in order to allow method chaining
3089
+ */
3090
+ attachLogout(
3091
+ /**
3092
+ * An application-specific payload object that will be passed to the event handler along with the event
3093
+ * object when firing the event
3094
+ */
3095
+ oData: object,
3096
+ /**
3097
+ * The function to be called when the event occurs
3098
+ */
3099
+ fnFunction: (p1: Event) => void,
3100
+ /**
3101
+ * Context object to call the event handler with. Defaults to this `sap.uiext.inbox.InboxLaunchPad` itself
3102
+ */
3103
+ oListener?: object
3104
+ ): this;
3105
+ /**
3106
+ * Attaches event handler `fnFunction` to the {@link #event:logout logout} event of this `sap.uiext.inbox.InboxLaunchPad`.
3107
+ *
3108
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
3109
+ * otherwise it will be bound to this `sap.uiext.inbox.InboxLaunchPad` itself.
3110
+ *
3111
+ * Fired when the user clicks the "Log-off" button.
3112
+ *
3113
+ * @returns Reference to `this` in order to allow method chaining
3114
+ */
3115
+ attachLogout(
3116
+ /**
3117
+ * The function to be called when the event occurs
3118
+ */
3119
+ fnFunction: (p1: Event) => void,
3120
+ /**
3121
+ * Context object to call the event handler with. Defaults to this `sap.uiext.inbox.InboxLaunchPad` itself
3122
+ */
3123
+ oListener?: object
3124
+ ): this;
3125
+ /**
3126
+ * Attaches event handler `fnFunction` to the {@link #event:tileSelected tileSelected} event of this `sap.uiext.inbox.InboxLaunchPad`.
3127
+ *
3128
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
3129
+ * otherwise it will be bound to this `sap.uiext.inbox.InboxLaunchPad` itself.
3130
+ *
3131
+ * Fires an event when a tile is selected in Inbox LaunchPad.
3132
+ *
3133
+ * @returns Reference to `this` in order to allow method chaining
3134
+ */
3135
+ attachTileSelected(
3136
+ /**
3137
+ * An application-specific payload object that will be passed to the event handler along with the event
3138
+ * object when firing the event
3139
+ */
3140
+ oData: object,
3141
+ /**
3142
+ * The function to be called when the event occurs
3143
+ */
3144
+ fnFunction: (p1: Event) => void,
3145
+ /**
3146
+ * Context object to call the event handler with. Defaults to this `sap.uiext.inbox.InboxLaunchPad` itself
3147
+ */
3148
+ oListener?: object
3149
+ ): this;
3150
+ /**
3151
+ * Attaches event handler `fnFunction` to the {@link #event:tileSelected tileSelected} event of this `sap.uiext.inbox.InboxLaunchPad`.
3152
+ *
3153
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
3154
+ * otherwise it will be bound to this `sap.uiext.inbox.InboxLaunchPad` itself.
3155
+ *
3156
+ * Fires an event when a tile is selected in Inbox LaunchPad.
3157
+ *
3158
+ * @returns Reference to `this` in order to allow method chaining
3159
+ */
3160
+ attachTileSelected(
3161
+ /**
3162
+ * The function to be called when the event occurs
3163
+ */
3164
+ fnFunction: (p1: Event) => void,
3165
+ /**
3166
+ * Context object to call the event handler with. Defaults to this `sap.uiext.inbox.InboxLaunchPad` itself
3167
+ */
3168
+ oListener?: object
3169
+ ): this;
3170
+ /**
3171
+ * Detaches event handler `fnFunction` from the {@link #event:logout logout} event of this `sap.uiext.inbox.InboxLaunchPad`.
3172
+ *
3173
+ * The passed function and listener object must match the ones used for event registration.
3174
+ *
3175
+ * @returns Reference to `this` in order to allow method chaining
3176
+ */
3177
+ detachLogout(
3178
+ /**
3179
+ * The function to be called, when the event occurs
3180
+ */
3181
+ fnFunction: (p1: Event) => void,
3182
+ /**
3183
+ * Context object on which the given function had to be called
3184
+ */
3185
+ oListener?: object
3186
+ ): this;
3187
+ /**
3188
+ * Detaches event handler `fnFunction` from the {@link #event:tileSelected tileSelected} event of this `sap.uiext.inbox.InboxLaunchPad`.
3189
+ *
3190
+ * The passed function and listener object must match the ones used for event registration.
3191
+ *
3192
+ * @returns Reference to `this` in order to allow method chaining
3193
+ */
3194
+ detachTileSelected(
3195
+ /**
3196
+ * The function to be called, when the event occurs
3197
+ */
3198
+ fnFunction: (p1: Event) => void,
3199
+ /**
3200
+ * Context object on which the given function had to be called
3201
+ */
3202
+ oListener?: object
3203
+ ): this;
3204
+ /**
3205
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
3206
+ *
3207
+ * Fires event {@link #event:logout logout} to attached listeners.
3208
+ *
3209
+ * @returns Reference to `this` in order to allow method chaining
3210
+ */
3211
+ fireLogout(
3212
+ /**
3213
+ * Parameters to pass along with the event
3214
+ */
3215
+ mParameters?: object
3216
+ ): this;
3217
+ /**
3218
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
3219
+ *
3220
+ * Fires event {@link #event:tileSelected tileSelected} to attached listeners.
3221
+ *
3222
+ * @returns Reference to `this` in order to allow method chaining
3223
+ */
3224
+ fireTileSelected(
3225
+ /**
3226
+ * Parameters to pass along with the event
3227
+ */
3228
+ mParameters?: object
3229
+ ): this;
3230
+ /**
3231
+ * Gets current value of property {@link #getLogoSrc logoSrc}.
3232
+ *
3233
+ * Path (src) to the logo icon to be displayed in the Inbox LaunchPad header.
3234
+ *
3235
+ * @returns Value of property `logoSrc`
3236
+ */
3237
+ getLogoSrc(): string;
3238
+ /**
3239
+ * Gets current value of property {@link #getShowLogoutButton showLogoutButton}.
3240
+ *
3241
+ * Property to indicate whether the Logoff button in the header should be displayed or not. Default value
3242
+ * is true.
3243
+ *
3244
+ * Default value is `true`.
3245
+ *
3246
+ * @returns Value of property `showLogoutButton`
3247
+ */
3248
+ getShowLogoutButton(): boolean;
3249
+ /**
3250
+ * Gets current value of property {@link #getShowUserName showUserName}.
3251
+ *
3252
+ * Property to indicate whether loggod on User's Name in the header should be displayed or not. Default
3253
+ * value is true.
3254
+ *
3255
+ * Default value is `true`.
3256
+ *
3257
+ * @returns Value of property `showUserName`
3258
+ */
3259
+ getShowUserName(): boolean;
3260
+ /**
3261
+ * Gets current value of property {@link #getTitle title}.
3262
+ *
3263
+ * The title text appearing in Inbox LaunchPad header bar.
3264
+ *
3265
+ * Default value is `'Inbox Launch Pad Title'`.
3266
+ *
3267
+ * @returns Value of property `title`
3268
+ */
3269
+ getTitle(): string;
3270
+ /**
3271
+ * Gets current value of property {@link #getUserName userName}.
3272
+ *
3273
+ * User name to be shown in the header.
3274
+ *
3275
+ * @returns Value of property `userName`
3276
+ */
3277
+ getUserName(): string;
3278
+ /**
3279
+ * Sets a new value for property {@link #getLogoSrc logoSrc}.
3280
+ *
3281
+ * Path (src) to the logo icon to be displayed in the Inbox LaunchPad header.
3282
+ *
3283
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3284
+ *
3285
+ * @returns Reference to `this` in order to allow method chaining
3286
+ */
3287
+ setLogoSrc(
3288
+ /**
3289
+ * New value for property `logoSrc`
3290
+ */
3291
+ sLogoSrc?: string
3292
+ ): this;
3293
+ /**
3294
+ * Sets a new value for property {@link #getShowLogoutButton showLogoutButton}.
3295
+ *
3296
+ * Property to indicate whether the Logoff button in the header should be displayed or not. Default value
3297
+ * is true.
3298
+ *
3299
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3300
+ *
3301
+ * Default value is `true`.
3302
+ *
3303
+ * @returns Reference to `this` in order to allow method chaining
3304
+ */
3305
+ setShowLogoutButton(
3306
+ /**
3307
+ * New value for property `showLogoutButton`
3308
+ */
3309
+ bShowLogoutButton?: boolean
3310
+ ): this;
3311
+ /**
3312
+ * Sets a new value for property {@link #getShowUserName showUserName}.
3313
+ *
3314
+ * Property to indicate whether loggod on User's Name in the header should be displayed or not. Default
3315
+ * value is true.
3316
+ *
3317
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3318
+ *
3319
+ * Default value is `true`.
3320
+ *
3321
+ * @returns Reference to `this` in order to allow method chaining
3322
+ */
3323
+ setShowUserName(
3324
+ /**
3325
+ * New value for property `showUserName`
3326
+ */
3327
+ bShowUserName?: boolean
3328
+ ): this;
3329
+ /**
3330
+ * Sets a new value for property {@link #getTitle title}.
3331
+ *
3332
+ * The title text appearing in Inbox LaunchPad header bar.
3333
+ *
3334
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3335
+ *
3336
+ * Default value is `'Inbox Launch Pad Title'`.
3337
+ *
3338
+ * @returns Reference to `this` in order to allow method chaining
3339
+ */
3340
+ setTitle(
3341
+ /**
3342
+ * New value for property `title`
3343
+ */
3344
+ sTitle?: string
3345
+ ): this;
3346
+ /**
3347
+ * Sets a new value for property {@link #getUserName userName}.
3348
+ *
3349
+ * User name to be shown in the header.
3350
+ *
3351
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3352
+ *
3353
+ * @returns Reference to `this` in order to allow method chaining
3354
+ */
3355
+ setUserName(
3356
+ /**
3357
+ * New value for property `userName`
3358
+ */
3359
+ sUserName?: string
3360
+ ): this;
3361
+ }
3362
+
3363
+ export interface $InboxLaunchPadSettings extends $ControlSettings {
3364
+ /**
3365
+ * The title text appearing in Inbox LaunchPad header bar.
3366
+ */
3367
+ title?: string | PropertyBindingInfo;
3368
+
3369
+ /**
3370
+ * Path (src) to the logo icon to be displayed in the Inbox LaunchPad header.
3371
+ */
3372
+ logoSrc?: string | PropertyBindingInfo;
3373
+
3374
+ /**
3375
+ * Property to indicate whether the Logoff button in the header should be displayed or not. Default value
3376
+ * is true.
3377
+ */
3378
+ showLogoutButton?: boolean | PropertyBindingInfo | `{${string}}`;
3379
+
3380
+ /**
3381
+ * Property to indicate whether loggod on User's Name in the header should be displayed or not. Default
3382
+ * value is true.
3383
+ */
3384
+ showUserName?: boolean | PropertyBindingInfo | `{${string}}`;
3385
+
3386
+ /**
3387
+ * User name to be shown in the header.
3388
+ */
3389
+ userName?: string | PropertyBindingInfo;
3390
+
3391
+ /**
3392
+ * Fires an event when a tile is selected in Inbox LaunchPad.
3393
+ */
3394
+ tileSelected?: (oEvent: Event) => void;
3395
+
3396
+ /**
3397
+ * Fired when the user clicks the "Log-off" button.
3398
+ */
3399
+ logout?: (oEvent: Event) => void;
3400
+ }
3401
+ }
3402
+
3403
+ declare module "sap/uiext/inbox/InboxPrimaryFilterEnum" {
3404
+ /**
3405
+ * Enumeration for Primary Filters. This value will be applied for the DropDown Filter in Inbox
3406
+ */
3407
+ interface InboxPrimaryFilterEnum {
3408
+ /**
3409
+ * Primary Filter for Completed Tasks
3410
+ */
3411
+ COMPLETED: undefined;
3412
+
3413
+ /**
3414
+ * Primary Filter for Escalated Tasks
3415
+ */
3416
+ ESCALATED: undefined;
3417
+
3418
+ /**
3419
+ * Primary Filter for Open Tasks
3420
+ */
3421
+ OPEN: undefined;
3422
+
3423
+ /**
3424
+ * Primary Filter for Overdue Tasks
3425
+ */
3426
+ OVERDUE: undefined;
3427
+ }
3428
+ const InboxPrimaryFilterEnum: InboxPrimaryFilterEnum;
3429
+ export default InboxPrimaryFilterEnum;
3430
+ }
3431
+
3432
+ declare module "sap/uiext/inbox/InboxPrimaryFilters" {
3433
+ import BaseObject from "sap/ui/base/Object";
3434
+
3435
+ import Metadata from "sap/ui/base/Metadata";
3436
+
3437
+ import InboxPrimaryFilterEnum from "sap/uiext/inbox/InboxPrimaryFilterEnum";
3438
+
3439
+ /**
3440
+ * Primary Filters for Inbox
3441
+ */
3442
+ export default class InboxPrimaryFilters extends BaseObject {
3443
+ /**
3444
+ * Constructor for InboxPrimaryFilters
3445
+ */
3446
+ constructor();
3447
+
3448
+ /**
3449
+ * Creates a new subclass of class sap.uiext.inbox.InboxPrimaryFilters with name `sClassName` and enriches
3450
+ * it with the information contained in `oClassInfo`.
3451
+ *
3452
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
3453
+ *
3454
+ * @returns Created class / constructor function
3455
+ */
3456
+ static extend<T extends Record<string, unknown>>(
3457
+ /**
3458
+ * Name of the class being created
3459
+ */
3460
+ sClassName: string,
3461
+ /**
3462
+ * Object literal with information about the class
3463
+ */
3464
+ oClassInfo?: sap.ClassInfo<T, InboxPrimaryFilters>,
3465
+ /**
3466
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
3467
+ * used by this class
3468
+ */
3469
+ FNMetaImpl?: Function
3470
+ ): Function;
3471
+ /**
3472
+ * Returns a metadata object for class sap.uiext.inbox.InboxPrimaryFilters.
3473
+ *
3474
+ * @returns Metadata object describing this class
3475
+ */
3476
+ static getMetadata(): Metadata;
3477
+ /**
3478
+ * set Primary filter
3479
+ */
3480
+ setFilter(oFilter: InboxPrimaryFilterEnum): void;
3481
+ }
3482
+ }
3483
+
3484
+ declare module "sap/uiext/inbox/InboxSecondaryFilterPathEnum" {
3485
+ /**
3486
+ * Enumeration for Secondary Filter Paths
3487
+ */
3488
+ interface InboxSecondaryFilterPathEnum {
3489
+ /**
3490
+ * Path for DueDate Secondary Filter
3491
+ */
3492
+ DUEDATE: undefined;
3493
+
3494
+ /**
3495
+ * Path for Priority Secondary Filter
3496
+ */
3497
+ PRIORITY: undefined;
3498
+
3499
+ /**
3500
+ * Path for StartDate Secondary Filter
3501
+ */
3502
+ STARTDATE: undefined;
3503
+
3504
+ /**
3505
+ * Path for Status Secondary Filter
3506
+ */
3507
+ STATUS: undefined;
3508
+
3509
+ /**
3510
+ * Path for TaskType Secondary Filter
3511
+ */
3512
+ TASKTYPE: undefined;
3513
+ }
3514
+ const InboxSecondaryFilterPathEnum: InboxSecondaryFilterPathEnum;
3515
+ export default InboxSecondaryFilterPathEnum;
3516
+ }
3517
+
3518
+ declare module "sap/uiext/inbox/InboxSecondaryFilters" {
3519
+ import BaseObject from "sap/ui/base/Object";
3520
+
3521
+ import Metadata from "sap/ui/base/Metadata";
3522
+
3523
+ /**
3524
+ * Secondary Filters for Inbox
3525
+ */
3526
+ export default class InboxSecondaryFilters extends BaseObject {
3527
+ /**
3528
+ * Constructor for InboxSecondaryFilters
3529
+ */
3530
+ constructor();
3531
+
3532
+ /**
3533
+ * Creates a new subclass of class sap.uiext.inbox.InboxSecondaryFilters with name `sClassName` and enriches
3534
+ * it with the information contained in `oClassInfo`.
3535
+ *
3536
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
3537
+ *
3538
+ * @returns Created class / constructor function
3539
+ */
3540
+ static extend<T extends Record<string, unknown>>(
3541
+ /**
3542
+ * Name of the class being created
3543
+ */
3544
+ sClassName: string,
3545
+ /**
3546
+ * Object literal with information about the class
3547
+ */
3548
+ oClassInfo?: sap.ClassInfo<T, InboxSecondaryFilters>,
3549
+ /**
3550
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
3551
+ * used by this class
3552
+ */
3553
+ FNMetaImpl?: Function
3554
+ ): Function;
3555
+ /**
3556
+ * Returns a metadata object for class sap.uiext.inbox.InboxSecondaryFilters.
3557
+ *
3558
+ * @returns Metadata object describing this class
3559
+ */
3560
+ static getMetadata(): Metadata;
3561
+ /**
3562
+ * Set Secondary Filters
3563
+ */
3564
+ setStandardFilters(
3565
+ /**
3566
+ * Array of secondary Filter Objects eg. : {sPath : sap.uiext.inbox.InboxSecondaryFilterPathEnum.Priority,
3567
+ * values : [sap.uiext.inbox.InboxSecondaryFilterValuesEnum.Status.LOW, sap.uiext.inbox.InboxSecondaryFilterValuesEnum.Status.HIGH]}
3568
+ * sPath : {sap.uiext.inbox.InboxSecondaryFilterPathEnum} values : {Array} Array of SecondaryFilterValuesEnums
3569
+ * of {sap.uiext.inbox.InboxSecondaryFilterValuesEnum}
3570
+ */
3571
+ aFilterObjects: any[]
3572
+ ): void;
3573
+ }
3574
+ }
3575
+
3576
+ declare module "sap/uiext/inbox/InboxSecondaryFilterValuesEnum" {
3577
+ /**
3578
+ * Enumeration for Secondary Filter Values
3579
+ */
3580
+ interface InboxSecondaryFilterValuesEnum {
3581
+ /**
3582
+ * Enum Values displayed by DueDate Secondary Filter dropdown are
3583
+ * Today : sap.uiext.inbox.InboxSecondaryFilterValuesEnum.DueDate.TODAY
3584
+ *
3585
+ * Next7Days : sap.uiext.inbox.InboxSecondaryFilterValuesEnum.DueDate.NEXT7DAYS
3586
+ *
3587
+ * Next15Days : sap.uiext.inbox.InboxSecondaryFilterValuesEnum.DueDate.NEXT15DAYS
3588
+ *
3589
+ * Next30Days : sap.uiext.inbox.InboxSecondaryFilterValuesEnum.DueDate.NEXT30DAYS
3590
+ *
3591
+ * NoDueDate : sap.uiext.inbox.InboxSecondaryFilterValuesEnum.DueDate.NODUEDATE
3592
+ */
3593
+ DueDate: undefined;
3594
+
3595
+ /**
3596
+ * Enum Values displayed by Priority Secondary Filter dropdown are
3597
+ * Low : sap.uiext.inbox.InboxSecondaryFilterValuesEnum.Priority.LOW
3598
+ *
3599
+ * Medium : sap.uiext.inbox.InboxSecondaryFilterValuesEnum.Priority.MEDIUM
3600
+ *
3601
+ * High : sap.uiext.inbox.InboxSecondaryFilterValuesEnum.Priority.HIGH
3602
+ *
3603
+ * Very High: sap.uiext.inbox.InboxSecondaryFilterValuesEnum.Priority.VERYHIGH
3604
+ */
3605
+ Priority: undefined;
3606
+
3607
+ /**
3608
+ * Enum Values displayed by the StartDate Secondary Filter are
3609
+ * Today : sap.uiext.inbox.InboxSecondaryFilterValuesEnum.StartDate.TODAY
3610
+ *
3611
+ * Last7Days : sap.uiext.inbox.InboxSecondaryFilterValuesEnum.StartDate.LAST7DAYS
3612
+ *
3613
+ * Last15Days : sap.uiext.inbox.InboxSecondaryFilterValuesEnum.StartDate.LAST15DAYS
3614
+ *
3615
+ * Last30Days : sap.uiext.inbox.InboxSecondaryFilterValuesEnum.StartDate.LAST30DAYS
3616
+ */
3617
+ StartDate: undefined;
3618
+
3619
+ /**
3620
+ * Enum Values displayed by the Status Secondary Filter dropdown are
3621
+ * Ready : sap.uiext.inbox.InboxSecondaryFilterValuesEnum.Status.READY
3622
+ *
3623
+ * Reserved : sap.uiext.inbox.InboxSecondaryFilterValuesEnum.Status.RESERVED
3624
+ *
3625
+ * InProgress : sap.uiext.inbox.InboxSecondaryFilterValuesEnum.Status.INPROGRESS
3626
+ */
3627
+ Status: undefined;
3628
+ }
3629
+ const InboxSecondaryFilterValuesEnum: InboxSecondaryFilterValuesEnum;
3630
+ export default InboxSecondaryFilterValuesEnum;
3631
+ }
3632
+
3633
+ declare module "sap/uiext/inbox/InboxSplitApp" {
3634
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
3635
+
3636
+ import Event from "sap/ui/base/Event";
3637
+
3638
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
3639
+
3640
+ import SplitApp from "sap/m/SplitApp";
3641
+
3642
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
3643
+
3644
+ /**
3645
+ * @EXPERIMENTAL (since 1.7.0) - API is not yet finished and might change completely
3646
+ *
3647
+ * Inbox Split App
3648
+ */
3649
+ export default class InboxSplitApp extends Control {
3650
+ /**
3651
+ * Constructor for a new InboxSplitApp.
3652
+ *
3653
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
3654
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
3655
+ * of the syntax of the settings object.
3656
+ */
3657
+ constructor(
3658
+ /**
3659
+ * initial settings for the new control
3660
+ */
3661
+ mSettings?: $InboxSplitAppSettings
3662
+ );
3663
+ /**
3664
+ * Constructor for a new InboxSplitApp.
3665
+ *
3666
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
3667
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
3668
+ * of the syntax of the settings object.
3669
+ */
3670
+ constructor(
3671
+ /**
3672
+ * id for the new control, generated automatically if no id is given
3673
+ */
3674
+ sId?: string,
3675
+ /**
3676
+ * initial settings for the new control
3677
+ */
3678
+ mSettings?: $InboxSplitAppSettings
3679
+ );
3680
+
3681
+ /**
3682
+ * Creates a new subclass of class sap.uiext.inbox.InboxSplitApp with name `sClassName` and enriches it
3683
+ * with the information contained in `oClassInfo`.
3684
+ *
3685
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
3686
+ *
3687
+ * @returns Created class / constructor function
3688
+ */
3689
+ static extend<T extends Record<string, unknown>>(
3690
+ /**
3691
+ * Name of the class being created
3692
+ */
3693
+ sClassName: string,
3694
+ /**
3695
+ * Object literal with information about the class
3696
+ */
3697
+ oClassInfo?: sap.ClassInfo<T, InboxSplitApp>,
3698
+ /**
3699
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
3700
+ * used by this class
3701
+ */
3702
+ FNMetaImpl?: Function
3703
+ ): Function;
3704
+ /**
3705
+ * Returns a metadata object for class sap.uiext.inbox.InboxSplitApp.
3706
+ *
3707
+ * @returns Metadata object describing this class
3708
+ */
3709
+ static getMetadata(): ElementMetadata;
3710
+ /**
3711
+ * Attaches event handler `fnFunction` to the {@link #event:navButtonPressed navButtonPressed} event of
3712
+ * this `sap.uiext.inbox.InboxSplitApp`.
3713
+ *
3714
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
3715
+ * otherwise it will be bound to this `sap.uiext.inbox.InboxSplitApp` itself.
3716
+ *
3717
+ * Navigation Button of the Master Page is pressed, if visible.
3718
+ *
3719
+ * @returns Reference to `this` in order to allow method chaining
3720
+ */
3721
+ attachNavButtonPressed(
3722
+ /**
3723
+ * An application-specific payload object that will be passed to the event handler along with the event
3724
+ * object when firing the event
3725
+ */
3726
+ oData: object,
3727
+ /**
3728
+ * The function to be called when the event occurs
3729
+ */
3730
+ fnFunction: (p1: Event) => void,
3731
+ /**
3732
+ * Context object to call the event handler with. Defaults to this `sap.uiext.inbox.InboxSplitApp` itself
3733
+ */
3734
+ oListener?: object
3735
+ ): this;
3736
+ /**
3737
+ * Attaches event handler `fnFunction` to the {@link #event:navButtonPressed navButtonPressed} event of
3738
+ * this `sap.uiext.inbox.InboxSplitApp`.
3739
+ *
3740
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
3741
+ * otherwise it will be bound to this `sap.uiext.inbox.InboxSplitApp` itself.
3742
+ *
3743
+ * Navigation Button of the Master Page is pressed, if visible.
3744
+ *
3745
+ * @returns Reference to `this` in order to allow method chaining
3746
+ */
3747
+ attachNavButtonPressed(
3748
+ /**
3749
+ * The function to be called when the event occurs
3750
+ */
3751
+ fnFunction: (p1: Event) => void,
3752
+ /**
3753
+ * Context object to call the event handler with. Defaults to this `sap.uiext.inbox.InboxSplitApp` itself
3754
+ */
3755
+ oListener?: object
3756
+ ): this;
3757
+ /**
3758
+ * Call this method to display data in the InboxSplitApp
3759
+ */
3760
+ bindTasks(aFilters: object[]): InboxSplitApp;
3761
+ /**
3762
+ * Destroys the splitAppl in the aggregation {@link #getSplitAppl splitAppl}.
3763
+ *
3764
+ * @returns Reference to `this` in order to allow method chaining
3765
+ */
3766
+ destroySplitAppl(): this;
3767
+ /**
3768
+ * Detaches event handler `fnFunction` from the {@link #event:navButtonPressed navButtonPressed} event of
3769
+ * this `sap.uiext.inbox.InboxSplitApp`.
3770
+ *
3771
+ * The passed function and listener object must match the ones used for event registration.
3772
+ *
3773
+ * @returns Reference to `this` in order to allow method chaining
3774
+ */
3775
+ detachNavButtonPressed(
3776
+ /**
3777
+ * The function to be called, when the event occurs
3778
+ */
3779
+ fnFunction: (p1: Event) => void,
3780
+ /**
3781
+ * Context object on which the given function had to be called
3782
+ */
3783
+ oListener?: object
3784
+ ): this;
3785
+ /**
3786
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
3787
+ *
3788
+ * Fires event {@link #event:navButtonPressed navButtonPressed} to attached listeners.
3789
+ *
3790
+ * @returns Reference to `this` in order to allow method chaining
3791
+ */
3792
+ fireNavButtonPressed(
3793
+ /**
3794
+ * Parameters to pass along with the event
3795
+ */
3796
+ mParameters?: object
3797
+ ): this;
3798
+ /**
3799
+ * Gets current value of property {@link #getFilters filters}.
3800
+ *
3801
+ * Filters to be applied on the data shown in the MasterPage
3802
+ *
3803
+ * @returns Value of property `filters`
3804
+ */
3805
+ getFilters(): object[];
3806
+ /**
3807
+ * Gets current value of property {@link #getShowMasterPageNavBtn showMasterPageNavBtn}.
3808
+ *
3809
+ * Show/Hide the Navigation Button for the Master Page
3810
+ *
3811
+ * @returns Value of property `showMasterPageNavBtn`
3812
+ */
3813
+ getShowMasterPageNavBtn(): boolean;
3814
+ /**
3815
+ * Gets content of aggregation {@link #getSplitAppl splitAppl}.
3816
+ *
3817
+ * This is the splitApp that is created inside the control
3818
+ */
3819
+ getSplitAppl(): SplitApp;
3820
+ /**
3821
+ * Gets current value of property {@link #getTcmConfiguration tcmConfiguration}.
3822
+ *
3823
+ * TCM Configuration object for control initialization.
3824
+ *
3825
+ * @returns Value of property `tcmConfiguration`
3826
+ */
3827
+ getTcmConfiguration(): object;
3828
+ /**
3829
+ * Gets current value of property {@link #getTcmServiceURL tcmServiceURL}.
3830
+ *
3831
+ * TCM service URL
3832
+ *
3833
+ * @returns Value of property `tcmServiceURL`
3834
+ */
3835
+ getTcmServiceURL(): string;
3836
+ /**
3837
+ * Call this method to reset the search criteria.
3838
+ */
3839
+ resetSearchCriteria(): InboxSplitApp;
3840
+ /**
3841
+ * Sets a new value for property {@link #getFilters filters}.
3842
+ *
3843
+ * Filters to be applied on the data shown in the MasterPage
3844
+ *
3845
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3846
+ *
3847
+ * @returns Reference to `this` in order to allow method chaining
3848
+ */
3849
+ setFilters(
3850
+ /**
3851
+ * New value for property `filters`
3852
+ */
3853
+ sFilters?: object[]
3854
+ ): this;
3855
+ /**
3856
+ * Sets a new value for property {@link #getShowMasterPageNavBtn showMasterPageNavBtn}.
3857
+ *
3858
+ * Show/Hide the Navigation Button for the Master Page
3859
+ *
3860
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3861
+ *
3862
+ * @returns Reference to `this` in order to allow method chaining
3863
+ */
3864
+ setShowMasterPageNavBtn(
3865
+ /**
3866
+ * New value for property `showMasterPageNavBtn`
3867
+ */
3868
+ bShowMasterPageNavBtn?: boolean
3869
+ ): this;
3870
+ /**
3871
+ * Sets the aggregated {@link #getSplitAppl splitAppl}.
3872
+ *
3873
+ * @returns Reference to `this` in order to allow method chaining
3874
+ */
3875
+ setSplitAppl(
3876
+ /**
3877
+ * The splitAppl to set
3878
+ */
3879
+ oSplitAppl: SplitApp
3880
+ ): this;
3881
+ /**
3882
+ * Sets a new value for property {@link #getTcmConfiguration tcmConfiguration}.
3883
+ *
3884
+ * TCM Configuration object for control initialization.
3885
+ *
3886
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3887
+ *
3888
+ * @returns Reference to `this` in order to allow method chaining
3889
+ */
3890
+ setTcmConfiguration(
3891
+ /**
3892
+ * New value for property `tcmConfiguration`
3893
+ */
3894
+ oTcmConfiguration?: object
3895
+ ): this;
3896
+ /**
3897
+ * Sets a new value for property {@link #getTcmServiceURL tcmServiceURL}.
3898
+ *
3899
+ * TCM service URL
3900
+ *
3901
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3902
+ *
3903
+ * @returns Reference to `this` in order to allow method chaining
3904
+ */
3905
+ setTcmServiceURL(
3906
+ /**
3907
+ * New value for property `tcmServiceURL`
3908
+ */
3909
+ sTcmServiceURL?: string
3910
+ ): this;
3911
+ }
3912
+
3913
+ export interface $InboxSplitAppSettings extends $ControlSettings {
3914
+ /**
3915
+ * Show/Hide the Navigation Button for the Master Page
3916
+ */
3917
+ showMasterPageNavBtn?: boolean | PropertyBindingInfo | `{${string}}`;
3918
+
3919
+ /**
3920
+ * TCM service URL
3921
+ */
3922
+ tcmServiceURL?: string | PropertyBindingInfo;
3923
+
3924
+ /**
3925
+ * Filters to be applied on the data shown in the MasterPage
3926
+ */
3927
+ filters?: object[] | PropertyBindingInfo | `{${string}}`;
3928
+
3929
+ /**
3930
+ * TCM Configuration object for control initialization.
3931
+ */
3932
+ tcmConfiguration?: object | PropertyBindingInfo | `{${string}}`;
3933
+
3934
+ /**
3935
+ * This is the splitApp that is created inside the control
3936
+ */
3937
+ splitAppl?: SplitApp;
3938
+
3939
+ /**
3940
+ * Navigation Button of the Master Page is pressed, if visible.
3941
+ */
3942
+ navButtonPressed?: (oEvent: Event) => void;
3943
+ }
3944
+ }
3945
+
3946
+ declare module "sap/uiext/inbox/SubstitutionRulesManager" {
3947
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
3948
+
3949
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
3950
+
3951
+ /**
3952
+ * @EXPERIMENTAL (since 1.7.0) - API is not yet finished and might change completely
3953
+ *
3954
+ * The SubstitutionRulesManager
3955
+ */
3956
+ export default class SubstitutionRulesManager extends Control {
3957
+ /**
3958
+ * Constructor for a new SubstitutionRulesManager.
3959
+ *
3960
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
3961
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
3962
+ * of the syntax of the settings object.
3963
+ *
3964
+ * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.core.Control#constructor
3965
+ * sap.ui.core.Control} can be used.
3966
+ */
3967
+ constructor(
3968
+ /**
3969
+ * initial settings for the new control
3970
+ */
3971
+ mSettings?: $SubstitutionRulesManagerSettings
3972
+ );
3973
+ /**
3974
+ * Constructor for a new SubstitutionRulesManager.
3975
+ *
3976
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
3977
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
3978
+ * of the syntax of the settings object.
3979
+ *
3980
+ * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.core.Control#constructor
3981
+ * sap.ui.core.Control} can be used.
3982
+ */
3983
+ constructor(
3984
+ /**
3985
+ * id for the new control, generated automatically if no id is given
3986
+ */
3987
+ sId?: string,
3988
+ /**
3989
+ * initial settings for the new control
3990
+ */
3991
+ mSettings?: $SubstitutionRulesManagerSettings
3992
+ );
3993
+
3994
+ /**
3995
+ * Creates a new subclass of class sap.uiext.inbox.SubstitutionRulesManager with name `sClassName` and enriches
3996
+ * it with the information contained in `oClassInfo`.
3997
+ *
3998
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
3999
+ *
4000
+ * @returns Created class / constructor function
4001
+ */
4002
+ static extend<T extends Record<string, unknown>>(
4003
+ /**
4004
+ * Name of the class being created
4005
+ */
4006
+ sClassName: string,
4007
+ /**
4008
+ * Object literal with information about the class
4009
+ */
4010
+ oClassInfo?: sap.ClassInfo<T, SubstitutionRulesManager>,
4011
+ /**
4012
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
4013
+ * used by this class
4014
+ */
4015
+ FNMetaImpl?: Function
4016
+ ): Function;
4017
+ /**
4018
+ * Returns a metadata object for class sap.uiext.inbox.SubstitutionRulesManager.
4019
+ *
4020
+ * @returns Metadata object describing this class
4021
+ */
4022
+ static getMetadata(): ElementMetadata;
4023
+ /**
4024
+ * Binds the Substitution Rules to the given path.
4025
+ */
4026
+ bindSubstitutionRules(
4027
+ /**
4028
+ * The path
4029
+ */
4030
+ path: string
4031
+ ): SubstitutionRulesManager;
4032
+ }
4033
+
4034
+ export interface $SubstitutionRulesManagerSettings extends $ControlSettings {}
4035
+ }
4036
+
4037
+ declare namespace sap {
4038
+ interface IUI5DefineDependencyNames {
4039
+ "sap/uiext/inbox/composite/InboxAddAttachmentTile": undefined;
4040
+
4041
+ "sap/uiext/inbox/composite/InboxAttachmentsTileContainer": undefined;
4042
+
4043
+ "sap/uiext/inbox/composite/InboxAttachmentTile": undefined;
4044
+
4045
+ "sap/uiext/inbox/composite/InboxBusyIndicator": undefined;
4046
+
4047
+ "sap/uiext/inbox/composite/InboxComment": undefined;
4048
+
4049
+ "sap/uiext/inbox/composite/InboxTaskComments": undefined;
4050
+
4051
+ "sap/uiext/inbox/composite/InboxTaskTitleControl": undefined;
4052
+
4053
+ "sap/uiext/inbox/composite/InboxUploadAttachmentTile": undefined;
4054
+
4055
+ "sap/uiext/inbox/Inbox": undefined;
4056
+
4057
+ "sap/uiext/inbox/InboxConfiguration": undefined;
4058
+
4059
+ "sap/uiext/inbox/InboxFilters": undefined;
4060
+
4061
+ "sap/uiext/inbox/InboxLaunchPad": undefined;
4062
+
4063
+ "sap/uiext/inbox/InboxPrimaryFilterEnum": undefined;
4064
+
4065
+ "sap/uiext/inbox/InboxPrimaryFilters": undefined;
4066
+
4067
+ "sap/uiext/inbox/InboxSecondaryFilterPathEnum": undefined;
4068
+
4069
+ "sap/uiext/inbox/InboxSecondaryFilters": undefined;
4070
+
4071
+ "sap/uiext/inbox/InboxSecondaryFilterValuesEnum": undefined;
4072
+
4073
+ "sap/uiext/inbox/InboxSplitApp": undefined;
4074
+
4075
+ "sap/uiext/inbox/library": undefined;
4076
+
4077
+ "sap/uiext/inbox/SubstitutionRulesManager": undefined;
4078
+ }
4079
+ }