@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,2704 @@
1
+ // For Library Version: 1.113.0
2
+
3
+ declare module "sap/collaboration/library" {
4
+ /**
5
+ * Application Type (Mode)
6
+ */
7
+ export enum AppType {
8
+ /**
9
+ * Fiori Split App
10
+ */
11
+ split = "split",
12
+ /**
13
+ * SAP Jam Feed Widget Wrapper
14
+ */
15
+ widget = "widget",
16
+ }
17
+ /**
18
+ * Feed Types to be displayed by the Social Timeline
19
+ */
20
+ export enum DisplayFeedType {
21
+ /**
22
+ * The main feed for the Business Record Feed
23
+ */
24
+ BusinessRecordFeed = "BusinessRecordFeed",
25
+ /**
26
+ * Group feeds where the business record is primary or featured
27
+ */
28
+ GroupFeedsWhereBusinessRecordIsLinked = "GroupFeedsWhereBusinessRecordIsLinked",
29
+ }
30
+ /**
31
+ * Feed Types
32
+ */
33
+ export enum FeedType {
34
+ /**
35
+ * The mode type that accepts the OData details of a business object. Users will be able to select groups
36
+ * where the business object is featured or primary.
37
+ */
38
+ BusinessObjectGroups = "BusinessObjectGroups",
39
+ /**
40
+ * @deprecated (since 1.30.0) - The feed type was deprecated because the original feed dialog component
41
+ * does not use it anymore. It also does not conform to naming conventions.
42
+ *
43
+ * Company feed type
44
+ */
45
+ company = "company",
46
+ /**
47
+ * @deprecated (since 1.30.0) - The feed type was deprecated because the original feed dialog component
48
+ * does not use it anymore. It also does not conform to naming conventions.
49
+ *
50
+ * Follows feed type
51
+ */
52
+ follows = "follows",
53
+ /**
54
+ * @deprecated (since 1.30.0) - The feed type was deprecated because the original feed dialog component
55
+ * does not use it anymore. It also does not conform to naming conventions.
56
+ *
57
+ * Group feed type
58
+ */
59
+ group = "group",
60
+ /**
61
+ * The mode type that accepts an array of group IDs. Users will be able to select these groups from a selector.
62
+ * The list will have the groups' names.
63
+ */
64
+ GroupIds = "GroupIds",
65
+ /**
66
+ * @deprecated (since 1.30.0) - The feed type was deprecated because the original feed dialog component
67
+ * does not use it anymore. It also does not conform to naming conventions.
68
+ *
69
+ * Oject feed type
70
+ */
71
+ object = "object",
72
+ /**
73
+ * @deprecated (since 1.30.0) - The feed type was deprecated because the original feed dialog component
74
+ * does not use it anymore. It also does not conform to naming conventions.
75
+ *
76
+ * Object group feed type
77
+ */
78
+ objectGroup = "objectGroup",
79
+ /**
80
+ * Users of this mode type will be able to select from groups where they are members. This mode is used
81
+ * by the feed component. In the feed component, the list of groups displayed in the pop up will be the
82
+ * current user's personal groups.
83
+ */
84
+ UserGroups = "UserGroups",
85
+ }
86
+ }
87
+
88
+ declare module "sap/collaboration/components/feed/Component" {
89
+ import {
90
+ default as UIComponent,
91
+ $UIComponentSettings,
92
+ } from "sap/ui/core/UIComponent";
93
+
94
+ import { ID } from "sap/ui/core/library";
95
+
96
+ import { TimelineAxisOrientation } from "sap/suite/ui/commons/library";
97
+
98
+ import ComponentMetadata from "sap/ui/core/ComponentMetadata";
99
+
100
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
101
+
102
+ /**
103
+ * @SINCE 1.30
104
+ *
105
+ * The Feed Component is an SAPUI5 component that allows you to display SAP Jam feeds. It includes the option
106
+ * to add new posts and reply to entries and view other users' social profiles from SAP Jam.
107
+ */
108
+ export default class Component extends UIComponent {
109
+ /**
110
+ * Constructor for the Feed Component.
111
+ *
112
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
113
+ * objects as well as event handlers.
114
+ *
115
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
116
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
117
+ * of the syntax of the settings object.
118
+ */
119
+ constructor(
120
+ /**
121
+ * initial settings for the new component. See the documentation of the component's properties for the structure
122
+ * of the expected data.
123
+ */
124
+ mSettings?: $ComponentSettings
125
+ );
126
+ /**
127
+ * Constructor for the Feed Component.
128
+ *
129
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
130
+ * objects as well as event handlers.
131
+ *
132
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
133
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
134
+ * of the syntax of the settings object.
135
+ */
136
+ constructor(
137
+ /**
138
+ * id for the new component, generated automatically if no id is given
139
+ */
140
+ sId?: ID,
141
+ /**
142
+ * initial settings for the new component. See the documentation of the component's properties for the structure
143
+ * of the expected data.
144
+ */
145
+ mSettings?: $ComponentSettings
146
+ );
147
+
148
+ /**
149
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
150
+ *
151
+ * The method to create the Content (UI Control Tree) of the Component.
152
+ */
153
+ static createContent(): void;
154
+ /**
155
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
156
+ *
157
+ * Cleans up the component instance before destruction.
158
+ */
159
+ static exit(): void;
160
+ /**
161
+ * Creates a new subclass of class sap.collaboration.components.feed.Component with name `sClassName` and
162
+ * enriches it with the information contained in `oClassInfo`.
163
+ *
164
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.UIComponent.extend}.
165
+ *
166
+ * @returns Created class / constructor function
167
+ */
168
+ static extend<T extends Record<string, unknown>>(
169
+ /**
170
+ * Name of the class being created
171
+ */
172
+ sClassName: string,
173
+ /**
174
+ * Object literal with information about the class
175
+ */
176
+ oClassInfo?: sap.ClassInfo<T, Component>,
177
+ /**
178
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
179
+ * used by this class
180
+ */
181
+ FNMetaImpl?: Function
182
+ ): Function;
183
+ /**
184
+ * Returns a metadata object for class sap.collaboration.components.feed.Component.
185
+ *
186
+ * @returns Metadata object describing this class
187
+ */
188
+ static getMetadata(): ComponentMetadata;
189
+ /**
190
+ * Returns the selected Group.
191
+ *
192
+ * @returns a map containing information about the selected Group (e.g. Id, Name, etc...)
193
+ */
194
+ static getSelectedGroup(): Record<string, any>;
195
+ /**
196
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
197
+ *
198
+ * Initializes the Component instance after creation.
199
+ */
200
+ static init(): void;
201
+ /**
202
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
203
+ *
204
+ * Function is called when the rendering of the Component Container is completed.
205
+ */
206
+ static onAfterRendering(): void;
207
+ /**
208
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
209
+ *
210
+ * Function is called when the rendering of the Component Container is started.
211
+ */
212
+ static onBeforeRendering(): void;
213
+ /**
214
+ * Set the axis orientation for the Timeline.
215
+ */
216
+ static setAxisOrientation(
217
+ axisOrientation:
218
+ | TimelineAxisOrientation
219
+ | keyof typeof TimelineAxisOrientation
220
+ ): void;
221
+ /**
222
+ * Sets the enableScroll property for the Timeline.
223
+ */
224
+ static setEnableScroll(enableScroll: boolean): void;
225
+ /**
226
+ * Sets the sources for the feed. Array of strings representing the Jam group IDs (e.g. ["groupid1", "groupid2"]).
227
+ */
228
+ static setFeedSources(feedSources: object): void;
229
+ /**
230
+ * Sets all the properties passed in oSettings.
231
+ */
232
+ static setSettings(
233
+ /**
234
+ * key/value map for settings
235
+ */
236
+ settings: Record<string, any>
237
+ ): void;
238
+ /**
239
+ * Getter for property `axisOrientation`.
240
+ *
241
+ * Default value is `Vertical`
242
+ *
243
+ * @returns the value of property `axisOrientation`
244
+ */
245
+ getAxisOrientation():
246
+ | TimelineAxisOrientation
247
+ | keyof typeof TimelineAxisOrientation;
248
+ /**
249
+ * Getter for property `enableScroll`.
250
+ *
251
+ * @returns the value of property `enableScroll`
252
+ */
253
+ getEnableScroll(): boolean;
254
+ /**
255
+ * Getter for property `feedSources`.
256
+ *
257
+ * @returns the value of property `feedSources`
258
+ */
259
+ getFeedSources(): Record<string, any> | string[];
260
+ /**
261
+ * Setter for property `axisOrientation`.
262
+ *
263
+ * Default value is `Vertical`
264
+ *
265
+ * @returns `this` to allow method chaining
266
+ */
267
+ setAxisOrientation(
268
+ /**
269
+ * new value for property `axisOrientation`
270
+ */
271
+ oAxisOrientation:
272
+ | TimelineAxisOrientation
273
+ | keyof typeof TimelineAxisOrientation
274
+ ): this;
275
+ /**
276
+ * Setter for property `enableScroll`.
277
+ *
278
+ * Sets the property enableScroll on the Timeline.
279
+ *
280
+ * Setting this property to false will remove the scrollbar on the Timeline.
281
+ *
282
+ *
283
+ * Default value is `true`
284
+ *
285
+ * @returns `this` to allow method chaining
286
+ */
287
+ setEnableScroll(
288
+ /**
289
+ * new value for property `enableScroll`
290
+ */
291
+ bEnableScroll: boolean
292
+ ): this;
293
+ /**
294
+ * Setter for property `feedSources`.
295
+ *
296
+ * The feedSources is either an array of strings (SAP Jam Group IDs) or a map in the following structure:
297
+ * { mode : sap.collaboration.FeedType, data : any }
298
+ * Based on the mode, the data is either required or not.
299
+ *
300
+ * @returns `this` to allow method chaining
301
+ */
302
+ setFeedSources(
303
+ /**
304
+ * new value for property `feedSources`
305
+ */
306
+ oFeedSources: Record<string, any> | string[]
307
+ ): this;
308
+ }
309
+
310
+ export interface $ComponentSettings extends $UIComponentSettings {
311
+ axisOrientation?:
312
+ | (TimelineAxisOrientation | keyof typeof TimelineAxisOrientation)
313
+ | PropertyBindingInfo
314
+ | `{${string}}`;
315
+
316
+ feedSources?: object | string[] | PropertyBindingInfo | `{${string}}`;
317
+
318
+ enableScroll?: boolean | PropertyBindingInfo | `{${string}}`;
319
+ }
320
+ }
321
+
322
+ declare module "sap/collaboration/components/fiori/feed/Component" {
323
+ import {
324
+ default as UIComponent,
325
+ $UIComponentSettings,
326
+ } from "sap/ui/core/UIComponent";
327
+
328
+ import { CSSSize, URI } from "sap/ui/core/library";
329
+
330
+ import ComponentMetadata from "sap/ui/core/ComponentMetadata";
331
+
332
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
333
+
334
+ /**
335
+ * @deprecated (since 1.26.0) - Please use sap.collaboration.components.fiori.feed.dialog.Component instead.
336
+ *
337
+ * Feed Component
338
+ *
339
+ *
340
+ * A Feed Component is a ui5 component that applications can use to render a sap.m.App that embeds
341
+ * the JAM Feed Widget.
342
+ * The Component class extends the base UI5 UIComponent class.
343
+ * This class defines the Reusable UI5 Component structure, i.e properties, aggregations and events, if
344
+ * any, and creates the UI5 controls to be displayed.
345
+ */
346
+ export default class Component extends UIComponent {
347
+ /**
348
+ * Constructor for the Feed Component.
349
+ *
350
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
351
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
352
+ * of the syntax of the settings object.
353
+ */
354
+ constructor(
355
+ /**
356
+ * Initial settings for the new component instance
357
+ */
358
+ mSettings?: $ComponentSettings
359
+ );
360
+ /**
361
+ * Constructor for the Feed Component.
362
+ *
363
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
364
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
365
+ * of the syntax of the settings object.
366
+ */
367
+ constructor(
368
+ /**
369
+ * ID for the new component
370
+ */
371
+ sId?: string,
372
+ /**
373
+ * Initial settings for the new component instance
374
+ */
375
+ mSettings?: $ComponentSettings
376
+ );
377
+
378
+ /**
379
+ * Creates a new subclass of class sap.collaboration.components.fiori.feed.Component with name `sClassName`
380
+ * and enriches it with the information contained in `oClassInfo`.
381
+ *
382
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.UIComponent.extend}.
383
+ *
384
+ * @returns Created class / constructor function
385
+ */
386
+ static extend<T extends Record<string, unknown>>(
387
+ /**
388
+ * Name of the class being created
389
+ */
390
+ sClassName: string,
391
+ /**
392
+ * Object literal with information about the class
393
+ */
394
+ oClassInfo?: sap.ClassInfo<T, Component>,
395
+ /**
396
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
397
+ * used by this class
398
+ */
399
+ FNMetaImpl?: Function
400
+ ): Function;
401
+ /**
402
+ * Returns a metadata object for class sap.collaboration.components.fiori.feed.Component.
403
+ *
404
+ * @returns Metadata object describing this class
405
+ */
406
+ static getMetadata(): ComponentMetadata;
407
+ /**
408
+ * Gets current value of property {@link #getFeedType feedType}.
409
+ *
410
+ * The type of feed to be displayed. The available types are in @link sap.collaboration.FeedType.
411
+ *
412
+ * @returns Value of property `feedType`
413
+ */
414
+ getFeedType(): string;
415
+ /**
416
+ * Gets current value of property {@link #getGroupIds groupIds}.
417
+ *
418
+ * A comma separated list of the IDs of the groups to display in the widget.
419
+ *
420
+ * @returns Value of property `groupIds`
421
+ */
422
+ getGroupIds(): string;
423
+ /**
424
+ * Gets current value of property {@link #getHeight height}.
425
+ *
426
+ * The height of the component.
427
+ *
428
+ * Default value is `empty string`.
429
+ *
430
+ * @returns Value of property `height`
431
+ */
432
+ getHeight(): CSSSize;
433
+ /**
434
+ * Gets current value of property {@link #getObject object}.
435
+ *
436
+ * A JSON object passed to the Feed component.
437
+ *
438
+ * It is required when the value of feedType is sap.collaboration.FeedType.object or sap.collaboration.FeedType.objectGroup.
439
+ * This object represents business related information, such as a sales order, an opportunity, etc. It contains
440
+ * the following properties:
441
+ * - **id**: The Business Object ID to be posted in the SAP Jam Feed. It needs to be an OData
442
+ * URL containing the relative path to the object in the back-end.
443
+ * - **type**: The type of the Business Object. It needs to be the OData meta data URL to the
444
+ * corresponding Entity Collection.
445
+ * - **name?** (optional): The description of the Business Object to be displayed in SAP Jam,
446
+ * i.e. "SO 57746", "Opportunity 123", etc.
447
+ * - **ui_url?** (optional): The URL to navigate to the same Business Object in the application.
448
+ *
449
+ *
450
+ * @returns Value of property `object`
451
+ */
452
+ getObject(): object;
453
+ /**
454
+ * Gets current value of property {@link #getODataServiceUrl oDataServiceUrl}.
455
+ *
456
+ * The OData service URL needed for the Feed Component.
457
+ *
458
+ * Default value is `"/sap/opu/odata/sap/SM_INTEGRATION_SRV"`.
459
+ *
460
+ * @returns Value of property `oDataServiceUrl`
461
+ */
462
+ getODataServiceUrl(): URI;
463
+ /**
464
+ * Gets current value of property {@link #getWidth width}.
465
+ *
466
+ * The width of the component.
467
+ *
468
+ * Default value is `empty string`.
469
+ *
470
+ * @returns Value of property `width`
471
+ */
472
+ getWidth(): CSSSize;
473
+ /**
474
+ * Sets a new value for property {@link #getFeedType feedType}.
475
+ *
476
+ * The type of feed to be displayed. The available types are in @link sap.collaboration.FeedType.
477
+ *
478
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
479
+ *
480
+ * @returns Reference to `this` in order to allow method chaining
481
+ */
482
+ setFeedType(
483
+ /**
484
+ * New value for property `feedType`
485
+ */
486
+ sFeedType: string
487
+ ): this;
488
+ /**
489
+ * Sets a new value for property {@link #getGroupIds groupIds}.
490
+ *
491
+ * A comma separated list of the IDs of the groups to display in the widget.
492
+ *
493
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
494
+ *
495
+ * @returns Reference to `this` in order to allow method chaining
496
+ */
497
+ setGroupIds(
498
+ /**
499
+ * New value for property `groupIds`
500
+ */
501
+ sGroupIds: string
502
+ ): this;
503
+ /**
504
+ * Sets a new value for property {@link #getHeight height}.
505
+ *
506
+ * The height of the component.
507
+ *
508
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
509
+ *
510
+ * Default value is `empty string`.
511
+ *
512
+ * @returns Reference to `this` in order to allow method chaining
513
+ */
514
+ setHeight(
515
+ /**
516
+ * New value for property `height`
517
+ */
518
+ sHeight?: CSSSize
519
+ ): this;
520
+ /**
521
+ * Sets a new value for property {@link #getObject object}.
522
+ *
523
+ * A JSON object passed to the Feed component.
524
+ *
525
+ * It is required when the value of feedType is sap.collaboration.FeedType.object or sap.collaboration.FeedType.objectGroup.
526
+ * This object represents business related information, such as a sales order, an opportunity, etc. It contains
527
+ * the following properties:
528
+ * - **id**: The Business Object ID to be posted in the SAP Jam Feed. It needs to be an OData
529
+ * URL containing the relative path to the object in the back-end.
530
+ * - **type**: The type of the Business Object. It needs to be the OData meta data URL to the
531
+ * corresponding Entity Collection.
532
+ * - **name?** (optional): The description of the Business Object to be displayed in SAP Jam,
533
+ * i.e. "SO 57746", "Opportunity 123", etc.
534
+ * - **ui_url?** (optional): The URL to navigate to the same Business Object in the application.
535
+ *
536
+ *
537
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
538
+ *
539
+ * @returns Reference to `this` in order to allow method chaining
540
+ */
541
+ setObject(
542
+ /**
543
+ * New value for property `object`
544
+ */
545
+ oObject: object
546
+ ): this;
547
+ /**
548
+ * Sets a new value for property {@link #getODataServiceUrl oDataServiceUrl}.
549
+ *
550
+ * The OData service URL needed for the Feed Component.
551
+ *
552
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
553
+ *
554
+ * Default value is `"/sap/opu/odata/sap/SM_INTEGRATION_SRV"`.
555
+ *
556
+ * @returns Reference to `this` in order to allow method chaining
557
+ */
558
+ setODataServiceUrl(
559
+ /**
560
+ * New value for property `oDataServiceUrl`
561
+ */
562
+ sODataServiceUrl?: URI
563
+ ): this;
564
+ /**
565
+ * Contract for passing the settings to the Component.
566
+ */
567
+ setSettings(
568
+ /**
569
+ * A JSON object containing the following attributes:
570
+ * - {sap.ui.core.URI} oDataServiceUrl: The URL of the OData Service needed for the Feed Component.
571
+ *
572
+ * - {sap.collaboration.FeedType} feedType: The type of feed to be displayed.
573
+ * - {string} [groupIds?]: A comma separated list of Group IDs.
574
+ * - {object} object: The representation of a Business Object.
575
+ */
576
+ oSettings: object
577
+ ): void;
578
+ /**
579
+ * Sets a new value for property {@link #getWidth width}.
580
+ *
581
+ * The width of the component.
582
+ *
583
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
584
+ *
585
+ * Default value is `empty string`.
586
+ *
587
+ * @returns Reference to `this` in order to allow method chaining
588
+ */
589
+ setWidth(
590
+ /**
591
+ * New value for property `width`
592
+ */
593
+ sWidth?: CSSSize
594
+ ): this;
595
+ }
596
+
597
+ export interface $ComponentSettings extends $UIComponentSettings {
598
+ /**
599
+ * The width of the component.
600
+ */
601
+ width?: CSSSize | PropertyBindingInfo | `{${string}}`;
602
+
603
+ /**
604
+ * The height of the component.
605
+ */
606
+ height?: CSSSize | PropertyBindingInfo | `{${string}}`;
607
+
608
+ /**
609
+ * The OData service URL needed for the Feed Component.
610
+ */
611
+ oDataServiceUrl?: URI | PropertyBindingInfo | `{${string}}`;
612
+
613
+ /**
614
+ * The type of feed to be displayed. The available types are in @link sap.collaboration.FeedType.
615
+ */
616
+ feedType?: string | PropertyBindingInfo;
617
+
618
+ /**
619
+ * A comma separated list of the IDs of the groups to display in the widget.
620
+ */
621
+ groupIds?: string | PropertyBindingInfo;
622
+
623
+ /**
624
+ * A JSON object passed to the Feed component.
625
+ *
626
+ * It is required when the value of feedType is sap.collaboration.FeedType.object or sap.collaboration.FeedType.objectGroup.
627
+ * This object represents business related information, such as a sales order, an opportunity, etc. It contains
628
+ * the following properties:
629
+ * - **id**: The Business Object ID to be posted in the SAP Jam Feed. It needs to be an OData
630
+ * URL containing the relative path to the object in the back-end.
631
+ * - **type**: The type of the Business Object. It needs to be the OData meta data URL to the
632
+ * corresponding Entity Collection.
633
+ * - **name?** (optional): The description of the Business Object to be displayed in SAP Jam,
634
+ * i.e. "SO 57746", "Opportunity 123", etc.
635
+ * - **ui_url?** (optional): The URL to navigate to the same Business Object in the application.
636
+ */
637
+ object?: object | PropertyBindingInfo | `{${string}}`;
638
+ }
639
+ }
640
+
641
+ declare module "sap/collaboration/components/fiori/feed/dialog/Component" {
642
+ import {
643
+ default as UIComponent,
644
+ $UIComponentSettings,
645
+ } from "sap/ui/core/UIComponent";
646
+
647
+ import { CSSSize } from "sap/ui/core/library";
648
+
649
+ import ComponentMetadata from "sap/ui/core/ComponentMetadata";
650
+
651
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
652
+
653
+ /**
654
+ * @deprecated (since 1.34.0) - For new integrations and existing implementations running on release 1.32
655
+ * or later, use the Group Feed component (sap.collaboration.components.feed.Component), Business Object
656
+ * mode(sap.collaboration.FeedType.BusinessObjectGroups). Note that the Group Feed component does not display
657
+ * the full public feed for the object in SAP Jam (object wall), but rather is restricted to the feed for
658
+ * the object within a specific group (group object wall).
659
+ *
660
+ * Feed Dialog Component
661
+ *
662
+ * A Feed Dialog Component is a ui5 component that applications can use to render the feed widget view in
663
+ * a dialog in order to discuss information in SAP JAM by adding and replying to feed posts related to a
664
+ * specific Business Object.
665
+ */
666
+ export default class Component extends UIComponent {
667
+ /**
668
+ * Constructor for the Feed Dialog Component.
669
+ *
670
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
671
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
672
+ * of the syntax of the settings object.
673
+ */
674
+ constructor(
675
+ /**
676
+ * initial settings for the new control
677
+ */
678
+ mSettings?: $ComponentSettings
679
+ );
680
+ /**
681
+ * Constructor for the Feed Dialog Component.
682
+ *
683
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
684
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
685
+ * of the syntax of the settings object.
686
+ */
687
+ constructor(
688
+ /**
689
+ * id for the new control, generated automatically if no id is given
690
+ */
691
+ sId?: string,
692
+ /**
693
+ * initial settings for the new control
694
+ */
695
+ mSettings?: $ComponentSettings
696
+ );
697
+
698
+ /**
699
+ * Creates a new subclass of class sap.collaboration.components.fiori.feed.dialog.Component with name `sClassName`
700
+ * and enriches it with the information contained in `oClassInfo`.
701
+ *
702
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.UIComponent.extend}.
703
+ *
704
+ * @returns Created class / constructor function
705
+ */
706
+ static extend<T extends Record<string, unknown>>(
707
+ /**
708
+ * Name of the class being created
709
+ */
710
+ sClassName: string,
711
+ /**
712
+ * Object literal with information about the class
713
+ */
714
+ oClassInfo?: sap.ClassInfo<T, Component>,
715
+ /**
716
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
717
+ * used by this class
718
+ */
719
+ FNMetaImpl?: Function
720
+ ): Function;
721
+ /**
722
+ * Returns a metadata object for class sap.collaboration.components.fiori.feed.dialog.Component.
723
+ *
724
+ * @returns Metadata object describing this class
725
+ */
726
+ static getMetadata(): ComponentMetadata;
727
+ /**
728
+ * Gets current value of property {@link #getBusinessObject businessObject}.
729
+ *
730
+ * A JSON object passed to the Feed Dialog Component. This object represents business related information,
731
+ * such as a sales order, an opportunity, etc. It contains the following properties:
732
+ * - {string} appContext: The application context. Example: "CRM", "CB", "SD", etc.
733
+ * - {string} odataServicePath: The path to the OData Service and the Service name. Example:
734
+ * "/sap/opu/odata/sap/APPLICATION_SRV".
735
+ * - {string} collection: The name of the OData Collection. Example: "Account", "Opportunity",
736
+ * etc.
737
+ * - {string} key: The key to identify a particular instance of the Business Object. It can be
738
+ * a simple ID or a compound key. Example: "123", "ObjectID='123'", "ObjectID='123',ObjectType='BUS000123'",
739
+ * etc.
740
+ * - {string} name: The short name of the Business Object. Example: "Sales Order 123", "Opportunity
741
+ * 123", "Account 123", etc.
742
+ * - {string} ui_url: The URL to navigate to the same business object in the application.
743
+ *
744
+ * @returns Value of property `businessObject`
745
+ */
746
+ getBusinessObject(): object;
747
+ /**
748
+ * Gets current value of property {@link #getFeedType feedType}.
749
+ *
750
+ * **[DEPRECATED]** The type of feed to be displayed.
751
+ *
752
+ * The available types are in @link sap.collaboration.FeedType.
753
+ *
754
+ * Default value is `FeedType.object`.
755
+ *
756
+ * @returns Value of property `feedType`
757
+ */
758
+ getFeedType(): string;
759
+ /**
760
+ * Gets current value of property {@link #getGroupIds groupIds}.
761
+ *
762
+ * **[DEPRECATED]** The IDs of the group to display in the widget.
763
+ *
764
+ * @returns Value of property `groupIds`
765
+ */
766
+ getGroupIds(): string;
767
+ /**
768
+ * Gets current value of property {@link #getHeight height}.
769
+ *
770
+ * The height of the component.
771
+ *
772
+ * We need to pass a value in pixels, otherwise the dialog won't render correctly
773
+ *
774
+ * Default value is `"605px"`.
775
+ *
776
+ * @returns Value of property `height`
777
+ */
778
+ getHeight(): CSSSize;
779
+ /**
780
+ * Gets current value of property {@link #getObject object}.
781
+ *
782
+ * **[DEPRECATED]** A JSON object passed to the Feed Dialog Component. Use **businessObject** instead.
783
+ * This object represents business related information, such as a sales order, an opportunity, etc. It contains
784
+ * the following properties:
785
+ * - id: The Business Object ID to be posted in the SAP Jam Feed. It needs to be an OData URL
786
+ * containing the relative path to the object in the back-end.
787
+ * - type: the type of the business object. It can be any text or it can be the OData meta data
788
+ * URL to the object Entity Type.
789
+ * - name (optional): the description of the business object to be displayed in SAP Jam, i.e.
790
+ * "SO 57746", "Opportunity 123", etc.
791
+ * - ui_url (optional): the URL to navigate to the same business object in the application.
792
+ * Note: The object is passed by reference, which means that the attributes will be modified in the original
793
+ * object, for example, when the URLs contained in the id and type attributes are mapped (via OData call).
794
+ *
795
+ * @returns Value of property `object`
796
+ */
797
+ getObject(): object;
798
+ /**
799
+ * Gets current value of property {@link #getWidth width}.
800
+ *
801
+ * The width of the component.
802
+ *
803
+ * Default value is `"575px"`.
804
+ *
805
+ * @returns Value of property `width`
806
+ */
807
+ getWidth(): CSSSize;
808
+ /**
809
+ * Open the Feed Dialog.
810
+ */
811
+ open(): void;
812
+ /**
813
+ * Sets a new value for property {@link #getBusinessObject businessObject}.
814
+ *
815
+ * A JSON object passed to the Feed Dialog Component. This object represents business related information,
816
+ * such as a sales order, an opportunity, etc. It contains the following properties:
817
+ * - {string} appContext: The application context. Example: "CRM", "CB", "SD", etc.
818
+ * - {string} odataServicePath: The path to the OData Service and the Service name. Example:
819
+ * "/sap/opu/odata/sap/APPLICATION_SRV".
820
+ * - {string} collection: The name of the OData Collection. Example: "Account", "Opportunity",
821
+ * etc.
822
+ * - {string} key: The key to identify a particular instance of the Business Object. It can be
823
+ * a simple ID or a compound key. Example: "123", "ObjectID='123'", "ObjectID='123',ObjectType='BUS000123'",
824
+ * etc.
825
+ * - {string} name: The short name of the Business Object. Example: "Sales Order 123", "Opportunity
826
+ * 123", "Account 123", etc.
827
+ * - {string} ui_url: The URL to navigate to the same business object in the application.
828
+ *
829
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
830
+ *
831
+ * @returns Reference to `this` in order to allow method chaining
832
+ */
833
+ setBusinessObject(
834
+ /**
835
+ * New value for property `businessObject`
836
+ */
837
+ oBusinessObject: object
838
+ ): this;
839
+ /**
840
+ * Sets a new value for property {@link #getFeedType feedType}.
841
+ *
842
+ * **[DEPRECATED]** The type of feed to be displayed.
843
+ *
844
+ * The available types are in @link sap.collaboration.FeedType.
845
+ *
846
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
847
+ *
848
+ * Default value is `FeedType.object`.
849
+ *
850
+ * @returns Reference to `this` in order to allow method chaining
851
+ */
852
+ setFeedType(
853
+ /**
854
+ * New value for property `feedType`
855
+ */
856
+ sFeedType?: string
857
+ ): this;
858
+ /**
859
+ * Sets a new value for property {@link #getGroupIds groupIds}.
860
+ *
861
+ * **[DEPRECATED]** The IDs of the group to display in the widget.
862
+ *
863
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
864
+ *
865
+ * @returns Reference to `this` in order to allow method chaining
866
+ */
867
+ setGroupIds(
868
+ /**
869
+ * New value for property `groupIds`
870
+ */
871
+ sGroupIds: string
872
+ ): this;
873
+ /**
874
+ * Sets a new value for property {@link #getHeight height}.
875
+ *
876
+ * The height of the component.
877
+ *
878
+ * We need to pass a value in pixels, otherwise the dialog won't render correctly
879
+ *
880
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
881
+ *
882
+ * Default value is `"605px"`.
883
+ *
884
+ * @returns Reference to `this` in order to allow method chaining
885
+ */
886
+ setHeight(
887
+ /**
888
+ * New value for property `height`
889
+ */
890
+ sHeight?: CSSSize
891
+ ): this;
892
+ /**
893
+ * Sets a new value for property {@link #getObject object}.
894
+ *
895
+ * **[DEPRECATED]** A JSON object passed to the Feed Dialog Component. Use **businessObject** instead.
896
+ * This object represents business related information, such as a sales order, an opportunity, etc. It contains
897
+ * the following properties:
898
+ * - id: The Business Object ID to be posted in the SAP Jam Feed. It needs to be an OData URL
899
+ * containing the relative path to the object in the back-end.
900
+ * - type: the type of the business object. It can be any text or it can be the OData meta data
901
+ * URL to the object Entity Type.
902
+ * - name (optional): the description of the business object to be displayed in SAP Jam, i.e.
903
+ * "SO 57746", "Opportunity 123", etc.
904
+ * - ui_url (optional): the URL to navigate to the same business object in the application.
905
+ * Note: The object is passed by reference, which means that the attributes will be modified in the original
906
+ * object, for example, when the URLs contained in the id and type attributes are mapped (via OData call).
907
+ *
908
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
909
+ *
910
+ * @returns Reference to `this` in order to allow method chaining
911
+ */
912
+ setObject(
913
+ /**
914
+ * New value for property `object`
915
+ */
916
+ oObject: object
917
+ ): this;
918
+ /**
919
+ * Contract for passing the settings to the Component.
920
+ */
921
+ setSettings(
922
+ /**
923
+ * A JSON object containing the following attributes:
924
+ * - {object} businessObject: the representation of a business object.
925
+ * - {sap.collaboration.FeedType} **[DEPRECATED]** feedType: the type of feed to be displayed.
926
+ *
927
+ * - {string} **[DEPRECATED]** [groupIds?]: a comma separated list of group IDs.
928
+ * - {object} **[DEPRECATED]** object: the representation of a business object. Use businessObject
929
+ * instead
930
+ */
931
+ oSettings: object
932
+ ): void;
933
+ /**
934
+ * Sets a new value for property {@link #getWidth width}.
935
+ *
936
+ * The width of the component.
937
+ *
938
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
939
+ *
940
+ * Default value is `"575px"`.
941
+ *
942
+ * @returns Reference to `this` in order to allow method chaining
943
+ */
944
+ setWidth(
945
+ /**
946
+ * New value for property `width`
947
+ */
948
+ sWidth?: CSSSize
949
+ ): this;
950
+ }
951
+
952
+ export interface $ComponentSettings extends $UIComponentSettings {
953
+ /**
954
+ * The width of the component.
955
+ */
956
+ width?: CSSSize | PropertyBindingInfo | `{${string}}`;
957
+
958
+ /**
959
+ * The height of the component.
960
+ *
961
+ * We need to pass a value in pixels, otherwise the dialog won't render correctly
962
+ */
963
+ height?: CSSSize | PropertyBindingInfo | `{${string}}`;
964
+
965
+ /**
966
+ * **[DEPRECATED]** The type of feed to be displayed.
967
+ *
968
+ * The available types are in @link sap.collaboration.FeedType.
969
+ */
970
+ feedType?: string | PropertyBindingInfo;
971
+
972
+ /**
973
+ * **[DEPRECATED]** The IDs of the group to display in the widget.
974
+ */
975
+ groupIds?: string | PropertyBindingInfo;
976
+
977
+ /**
978
+ * **[DEPRECATED]** A JSON object passed to the Feed Dialog Component. Use **businessObject** instead.
979
+ * This object represents business related information, such as a sales order, an opportunity, etc. It contains
980
+ * the following properties:
981
+ * - id: The Business Object ID to be posted in the SAP Jam Feed. It needs to be an OData URL
982
+ * containing the relative path to the object in the back-end.
983
+ * - type: the type of the business object. It can be any text or it can be the OData meta data
984
+ * URL to the object Entity Type.
985
+ * - name (optional): the description of the business object to be displayed in SAP Jam, i.e.
986
+ * "SO 57746", "Opportunity 123", etc.
987
+ * - ui_url (optional): the URL to navigate to the same business object in the application.
988
+ * Note: The object is passed by reference, which means that the attributes will be modified in the original
989
+ * object, for example, when the URLs contained in the id and type attributes are mapped (via OData call).
990
+ */
991
+ object?: object | PropertyBindingInfo | `{${string}}`;
992
+
993
+ /**
994
+ * A JSON object passed to the Feed Dialog Component. This object represents business related information,
995
+ * such as a sales order, an opportunity, etc. It contains the following properties:
996
+ * - {string} appContext: The application context. Example: "CRM", "CB", "SD", etc.
997
+ * - {string} odataServicePath: The path to the OData Service and the Service name. Example:
998
+ * "/sap/opu/odata/sap/APPLICATION_SRV".
999
+ * - {string} collection: The name of the OData Collection. Example: "Account", "Opportunity",
1000
+ * etc.
1001
+ * - {string} key: The key to identify a particular instance of the Business Object. It can be
1002
+ * a simple ID or a compound key. Example: "123", "ObjectID='123'", "ObjectID='123',ObjectType='BUS000123'",
1003
+ * etc.
1004
+ * - {string} name: The short name of the Business Object. Example: "Sales Order 123", "Opportunity
1005
+ * 123", "Account 123", etc.
1006
+ * - {string} ui_url: The URL to navigate to the same business object in the application.
1007
+ */
1008
+ businessObject?: object | PropertyBindingInfo | `{${string}}`;
1009
+ }
1010
+ }
1011
+
1012
+ declare module "sap/collaboration/components/fiori/notification/Component" {
1013
+ import {
1014
+ default as UIComponent,
1015
+ $UIComponentSettings,
1016
+ } from "sap/ui/core/UIComponent";
1017
+
1018
+ import ComponentMetadata from "sap/ui/core/ComponentMetadata";
1019
+
1020
+ import { URI } from "sap/ui/core/library";
1021
+
1022
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1023
+
1024
+ /**
1025
+ * @deprecated (since 1.26.0) - There is no replacement for this control. The Fiori Launchpad now provides
1026
+ * its own implementation for this control. This control was never meant to be used directly by third parties.
1027
+ *
1028
+ * Notification Component
1029
+ *
1030
+ * A Notification Component is a UI5 component that displays a SAP Jam member's latest notifications.
1031
+ *
1032
+ * This component refreshes itself when the number of seconds specified in the refreshInterval
1033
+ * parameter elapses. When refreshing, the backend is called to obtain the latest notifications.
1034
+ */
1035
+ export default class Component extends UIComponent {
1036
+ /**
1037
+ * Constructor for the notification component.
1038
+ *
1039
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1040
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1041
+ * of the syntax of the settings object.
1042
+ */
1043
+ constructor(
1044
+ /**
1045
+ * Initial settings for the new component instance
1046
+ */
1047
+ mSettings?: $ComponentSettings
1048
+ );
1049
+ /**
1050
+ * Constructor for the notification component.
1051
+ *
1052
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1053
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1054
+ * of the syntax of the settings object.
1055
+ */
1056
+ constructor(
1057
+ /**
1058
+ * ID for the new component
1059
+ */
1060
+ sId?: string,
1061
+ /**
1062
+ * Initial settings for the new component instance
1063
+ */
1064
+ mSettings?: $ComponentSettings
1065
+ );
1066
+
1067
+ /**
1068
+ * Creates a new subclass of class sap.collaboration.components.fiori.notification.Component with name `sClassName`
1069
+ * and enriches it with the information contained in `oClassInfo`.
1070
+ *
1071
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.UIComponent.extend}.
1072
+ *
1073
+ * @returns Created class / constructor function
1074
+ */
1075
+ static extend<T extends Record<string, unknown>>(
1076
+ /**
1077
+ * Name of the class being created
1078
+ */
1079
+ sClassName: string,
1080
+ /**
1081
+ * Object literal with information about the class
1082
+ */
1083
+ oClassInfo?: sap.ClassInfo<T, Component>,
1084
+ /**
1085
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1086
+ * used by this class
1087
+ */
1088
+ FNMetaImpl?: Function
1089
+ ): Function;
1090
+ /**
1091
+ * Returns a metadata object for class sap.collaboration.components.fiori.notification.Component.
1092
+ *
1093
+ * @returns Metadata object describing this class
1094
+ */
1095
+ static getMetadata(): ComponentMetadata;
1096
+ /**
1097
+ * Gets current value of property {@link #getNotificationsTargetUrl notificationsTargetUrl}.
1098
+ *
1099
+ * When a user clicks on the component, a new browser tab will open at this URL.
1100
+ *
1101
+ * @returns Value of property `notificationsTargetUrl`
1102
+ */
1103
+ getNotificationsTargetUrl(): URI;
1104
+ /**
1105
+ * Gets current value of property {@link #getNumberOfNotifications numberOfNotifications}.
1106
+ *
1107
+ * The maximum number of notifications to be displayed.
1108
+ *
1109
+ * Default value is `10`.
1110
+ *
1111
+ * @returns Value of property `numberOfNotifications`
1112
+ */
1113
+ getNumberOfNotifications(): int;
1114
+ /**
1115
+ * Gets current value of property {@link #getODataServiceUrl oDataServiceUrl}.
1116
+ *
1117
+ * The OData service URL needed for the notification component.
1118
+ *
1119
+ * Default value is `"/sap/opu/odata/sap/SM_INTEGRATION_SRV"`.
1120
+ *
1121
+ * @returns Value of property `oDataServiceUrl`
1122
+ */
1123
+ getODataServiceUrl(): URI;
1124
+ /**
1125
+ * Gets current value of property {@link #getRefreshInterval refreshInterval}.
1126
+ *
1127
+ * The time in seconds before calling the backend to update the notifications.
1128
+ *
1129
+ * Default value is `300`.
1130
+ *
1131
+ * @returns Value of property `refreshInterval`
1132
+ */
1133
+ getRefreshInterval(): int;
1134
+ /**
1135
+ * Gets current value of property {@link #getTransitionInterval transitionInterval}.
1136
+ *
1137
+ * The time in seconds a notification is displayed before the next notification is displayed.
1138
+ *
1139
+ * Default value is `10`.
1140
+ *
1141
+ * @returns Value of property `transitionInterval`
1142
+ */
1143
+ getTransitionInterval(): int;
1144
+ /**
1145
+ * Sets a new value for property {@link #getNotificationsTargetUrl notificationsTargetUrl}.
1146
+ *
1147
+ * When a user clicks on the component, a new browser tab will open at this URL.
1148
+ *
1149
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1150
+ *
1151
+ * @returns Reference to `this` in order to allow method chaining
1152
+ */
1153
+ setNotificationsTargetUrl(
1154
+ /**
1155
+ * New value for property `notificationsTargetUrl`
1156
+ */
1157
+ sNotificationsTargetUrl: URI
1158
+ ): this;
1159
+ /**
1160
+ * Sets a new value for property {@link #getNumberOfNotifications numberOfNotifications}.
1161
+ *
1162
+ * The maximum number of notifications to be displayed.
1163
+ *
1164
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1165
+ *
1166
+ * Default value is `10`.
1167
+ *
1168
+ * @returns Reference to `this` in order to allow method chaining
1169
+ */
1170
+ setNumberOfNotifications(
1171
+ /**
1172
+ * New value for property `numberOfNotifications`
1173
+ */
1174
+ iNumberOfNotifications?: int
1175
+ ): this;
1176
+ /**
1177
+ * Sets a new value for property {@link #getODataServiceUrl oDataServiceUrl}.
1178
+ *
1179
+ * The OData service URL needed for the notification component.
1180
+ *
1181
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1182
+ *
1183
+ * Default value is `"/sap/opu/odata/sap/SM_INTEGRATION_SRV"`.
1184
+ *
1185
+ * @returns Reference to `this` in order to allow method chaining
1186
+ */
1187
+ setODataServiceUrl(
1188
+ /**
1189
+ * New value for property `oDataServiceUrl`
1190
+ */
1191
+ sODataServiceUrl?: URI
1192
+ ): this;
1193
+ /**
1194
+ * Sets a new value for property {@link #getRefreshInterval refreshInterval}.
1195
+ *
1196
+ * The time in seconds before calling the backend to update the notifications.
1197
+ *
1198
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1199
+ *
1200
+ * Default value is `300`.
1201
+ *
1202
+ * @returns Reference to `this` in order to allow method chaining
1203
+ */
1204
+ setRefreshInterval(
1205
+ /**
1206
+ * New value for property `refreshInterval`
1207
+ */
1208
+ iRefreshInterval?: int
1209
+ ): this;
1210
+ /**
1211
+ * Sets a new value for property {@link #getTransitionInterval transitionInterval}.
1212
+ *
1213
+ * The time in seconds a notification is displayed before the next notification is displayed.
1214
+ *
1215
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1216
+ *
1217
+ * Default value is `10`.
1218
+ *
1219
+ * @returns Reference to `this` in order to allow method chaining
1220
+ */
1221
+ setTransitionInterval(
1222
+ /**
1223
+ * New value for property `transitionInterval`
1224
+ */
1225
+ iTransitionInterval?: int
1226
+ ): this;
1227
+ }
1228
+
1229
+ export interface $ComponentSettings extends $UIComponentSettings {
1230
+ /**
1231
+ * The OData service URL needed for the notification component.
1232
+ */
1233
+ oDataServiceUrl?: URI | PropertyBindingInfo | `{${string}}`;
1234
+
1235
+ /**
1236
+ * The maximum number of notifications to be displayed.
1237
+ */
1238
+ numberOfNotifications?: int | PropertyBindingInfo | `{${string}}`;
1239
+
1240
+ /**
1241
+ * The time in seconds a notification is displayed before the next notification is displayed.
1242
+ */
1243
+ transitionInterval?: int | PropertyBindingInfo | `{${string}}`;
1244
+
1245
+ /**
1246
+ * The time in seconds before calling the backend to update the notifications.
1247
+ */
1248
+ refreshInterval?: int | PropertyBindingInfo | `{${string}}`;
1249
+
1250
+ /**
1251
+ * When a user clicks on the component, a new browser tab will open at this URL.
1252
+ */
1253
+ notificationsTargetUrl?: URI | PropertyBindingInfo | `{${string}}`;
1254
+ }
1255
+ }
1256
+
1257
+ declare module "sap/collaboration/components/fiori/sharing/attachment/Attachment" {
1258
+ import BaseObject from "sap/ui/base/Object";
1259
+
1260
+ import Metadata from "sap/ui/base/Metadata";
1261
+
1262
+ /**
1263
+ * Attachment
1264
+ *
1265
+ * Attachment objects represent files.
1266
+ */
1267
+ export default class Attachment extends BaseObject {
1268
+ /**
1269
+ * This constructor must be called in the following way: new Attachment("name", "mimeType", "url")
1270
+ * name, mimeType, and url are only place holders and can be any string.
1271
+ */
1272
+ constructor(
1273
+ /**
1274
+ * The file's name.
1275
+ */
1276
+ name: string,
1277
+ /**
1278
+ * The file's mime type.
1279
+ */
1280
+ mimeType: string,
1281
+ /**
1282
+ * A url that points to the file.
1283
+ */
1284
+ url: string
1285
+ );
1286
+
1287
+ /**
1288
+ * Creates a new subclass of class sap.collaboration.components.fiori.sharing.attachment.Attachment with
1289
+ * name `sClassName` and enriches it with the information contained in `oClassInfo`.
1290
+ *
1291
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
1292
+ *
1293
+ * @returns Created class / constructor function
1294
+ */
1295
+ static extend<T extends Record<string, unknown>>(
1296
+ /**
1297
+ * Name of the class being created
1298
+ */
1299
+ sClassName: string,
1300
+ /**
1301
+ * Object literal with information about the class
1302
+ */
1303
+ oClassInfo?: sap.ClassInfo<T, Attachment>,
1304
+ /**
1305
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1306
+ * used by this class
1307
+ */
1308
+ FNMetaImpl?: Function
1309
+ ): Function;
1310
+ /**
1311
+ * Returns a metadata object for class sap.collaboration.components.fiori.sharing.attachment.Attachment.
1312
+ *
1313
+ * @returns Metadata object describing this class
1314
+ */
1315
+ static getMetadata(): Metadata;
1316
+ }
1317
+ }
1318
+
1319
+ declare module "sap/collaboration/components/fiori/sharing/Component" {
1320
+ import {
1321
+ default as UIComponent,
1322
+ $UIComponentSettings,
1323
+ } from "sap/ui/core/UIComponent";
1324
+
1325
+ import { URI, CSSSize } from "sap/ui/core/library";
1326
+
1327
+ import ComponentMetadata from "sap/ui/core/ComponentMetadata";
1328
+
1329
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1330
+
1331
+ /**
1332
+ * @deprecated (since 1.26.0) - Please use sap.collaboration.components.fiori.sharing.dialog.Component instead.
1333
+ *
1334
+ * Share Component
1335
+ *
1336
+ * A Share Component is a ui5 component that applications can use to share information to SAP Jam
1337
+ */
1338
+ export default class Component extends UIComponent {
1339
+ /**
1340
+ * Constructor for the share component
1341
+ *
1342
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1343
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1344
+ * of the syntax of the settings object.
1345
+ */
1346
+ constructor(
1347
+ /**
1348
+ * initial settings for the new control
1349
+ */
1350
+ mSettings?: $ComponentSettings
1351
+ );
1352
+ /**
1353
+ * Constructor for the share component
1354
+ *
1355
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1356
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1357
+ * of the syntax of the settings object.
1358
+ */
1359
+ constructor(
1360
+ /**
1361
+ * id for the new control, generated automatically if no id is given
1362
+ */
1363
+ sId?: string,
1364
+ /**
1365
+ * initial settings for the new control
1366
+ */
1367
+ mSettings?: $ComponentSettings
1368
+ );
1369
+
1370
+ /**
1371
+ * Creates a new subclass of class sap.collaboration.components.fiori.sharing.Component with name `sClassName`
1372
+ * and enriches it with the information contained in `oClassInfo`.
1373
+ *
1374
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.UIComponent.extend}.
1375
+ *
1376
+ * @returns Created class / constructor function
1377
+ */
1378
+ static extend<T extends Record<string, unknown>>(
1379
+ /**
1380
+ * Name of the class being created
1381
+ */
1382
+ sClassName: string,
1383
+ /**
1384
+ * Object literal with information about the class
1385
+ */
1386
+ oClassInfo?: sap.ClassInfo<T, Component>,
1387
+ /**
1388
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1389
+ * used by this class
1390
+ */
1391
+ FNMetaImpl?: Function
1392
+ ): Function;
1393
+ /**
1394
+ * Returns a metadata object for class sap.collaboration.components.fiori.sharing.Component.
1395
+ *
1396
+ * @returns Metadata object describing this class
1397
+ */
1398
+ static getMetadata(): ComponentMetadata;
1399
+ /**
1400
+ * Gets current value of property {@link #getAttachments attachments}.
1401
+ *
1402
+ * @returns Value of property `attachments`
1403
+ */
1404
+ getAttachments(): object;
1405
+ /**
1406
+ * Gets current value of property {@link #getCollaborationHostODataServiceUrl collaborationHostODataServiceUrl}.
1407
+ *
1408
+ * Default value is `"/sap/bc/ui2/smi/rest_tunnel/Jam/api/v1/OData"`.
1409
+ *
1410
+ * @returns Value of property `collaborationHostODataServiceUrl`
1411
+ */
1412
+ getCollaborationHostODataServiceUrl(): URI;
1413
+ /**
1414
+ * Gets current value of property {@link #getExternalObject externalObject}.
1415
+ *
1416
+ * A Business Object such as an Opportunity, Sales Order, Account, etc. from the back-end that will be shared
1417
+ * as a Featured External Object in a Group in Jam.
1418
+ * - {string} appContext: The application context. Example: "CRM", "SD", etc.
1419
+ * - {string} odataServicePath: The relative path to the OData Service. Example: "/sap/opu/odata/sap/ODATA_SRV"
1420
+ *
1421
+ * - {string} collection: The name of the OData Collection. Example: "Account", "Opportunity", etc.
1422
+ * - {string} key: The key to identify a particular instance of the Business Object. It can be a simple
1423
+ * ID or a compound key. Example: "123", "ObjectID='123'", "ObjectID='123',ObjectType='BUS000123'", etc.
1424
+ *
1425
+ * - {string} name: The short name of the Business Object. Example: "Sales Order 123", "Opportunity 123",
1426
+ * "Account 123", etc. These attributes are not enforced by the UI (missing or incorrect values
1427
+ * are not validated), but they are required to make the integration work. These attributes also should
1428
+ * be mapped in the Back-end System and Jam in order to make the External Object work.
1429
+ * **Note:** the externalObject is dependent on object.id, therefore, the object.id must also be passed
1430
+ * to the Share Component. See the parameter "object" for more information.
1431
+ *
1432
+ * @returns Value of property `externalObject`
1433
+ */
1434
+ getExternalObject(): object;
1435
+ /**
1436
+ * Gets current value of property {@link #getHeight height}.
1437
+ *
1438
+ * Default value is `"100%"`.
1439
+ *
1440
+ * @returns Value of property `height`
1441
+ */
1442
+ getHeight(): CSSSize;
1443
+ /**
1444
+ * Gets current value of property {@link #getObject object}.
1445
+ *
1446
+ * A JSON object passed to the share component. This object contains the following properties:
1447
+ * - id (optional): is the object Id to be shared in SAP Jam, i.e a URL that navigates back to the same
1448
+ * object in the application
1449
+ * - display (optional): is a UI5 control to be displayed in the component UI
1450
+ * - share (optional): is a note that will be displayed in the component UI and shared to SAP Jam too
1451
+ *
1452
+ *
1453
+ * @returns Value of property `object`
1454
+ */
1455
+ getObject(): object;
1456
+ /**
1457
+ * Gets current value of property {@link #getODataServiceUrl oDataServiceUrl}.
1458
+ *
1459
+ * The OData service URL needed for the share component.
1460
+ *
1461
+ * Default value is `"/sap/opu/odata/sap/SM_INTEGRATION_V2_SRV"`.
1462
+ *
1463
+ * @returns Value of property `oDataServiceUrl`
1464
+ */
1465
+ getODataServiceUrl(): URI;
1466
+ /**
1467
+ * Gets current value of property {@link #getTunnelServiceUrl tunnelServiceUrl}.
1468
+ *
1469
+ * Default value is `"/sap/bc/z_sail_httproxy/Jam/api/v1/OData"`.
1470
+ *
1471
+ * @returns Value of property `tunnelServiceUrl`
1472
+ */
1473
+ getTunnelServiceUrl(): URI;
1474
+ /**
1475
+ * Gets current value of property {@link #getWidth width}.
1476
+ *
1477
+ * Default value is `"100%"`.
1478
+ *
1479
+ * @returns Value of property `width`
1480
+ */
1481
+ getWidth(): CSSSize;
1482
+ /**
1483
+ * Sets a new value for property {@link #getAttachments attachments}.
1484
+ *
1485
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1486
+ *
1487
+ * @returns Reference to `this` in order to allow method chaining
1488
+ */
1489
+ setAttachments(
1490
+ /**
1491
+ * New value for property `attachments`
1492
+ */
1493
+ oAttachments: object
1494
+ ): this;
1495
+ /**
1496
+ * Sets a new value for property {@link #getCollaborationHostODataServiceUrl collaborationHostODataServiceUrl}.
1497
+ *
1498
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1499
+ *
1500
+ * Default value is `"/sap/bc/ui2/smi/rest_tunnel/Jam/api/v1/OData"`.
1501
+ *
1502
+ * @returns Reference to `this` in order to allow method chaining
1503
+ */
1504
+ setCollaborationHostODataServiceUrl(
1505
+ /**
1506
+ * New value for property `collaborationHostODataServiceUrl`
1507
+ */
1508
+ sCollaborationHostODataServiceUrl?: URI
1509
+ ): this;
1510
+ /**
1511
+ * Sets a new value for property {@link #getExternalObject externalObject}.
1512
+ *
1513
+ * A Business Object such as an Opportunity, Sales Order, Account, etc. from the back-end that will be shared
1514
+ * as a Featured External Object in a Group in Jam.
1515
+ * - {string} appContext: The application context. Example: "CRM", "SD", etc.
1516
+ * - {string} odataServicePath: The relative path to the OData Service. Example: "/sap/opu/odata/sap/ODATA_SRV"
1517
+ *
1518
+ * - {string} collection: The name of the OData Collection. Example: "Account", "Opportunity", etc.
1519
+ * - {string} key: The key to identify a particular instance of the Business Object. It can be a simple
1520
+ * ID or a compound key. Example: "123", "ObjectID='123'", "ObjectID='123',ObjectType='BUS000123'", etc.
1521
+ *
1522
+ * - {string} name: The short name of the Business Object. Example: "Sales Order 123", "Opportunity 123",
1523
+ * "Account 123", etc. These attributes are not enforced by the UI (missing or incorrect values
1524
+ * are not validated), but they are required to make the integration work. These attributes also should
1525
+ * be mapped in the Back-end System and Jam in order to make the External Object work.
1526
+ * **Note:** the externalObject is dependent on object.id, therefore, the object.id must also be passed
1527
+ * to the Share Component. See the parameter "object" for more information.
1528
+ *
1529
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1530
+ *
1531
+ * @returns Reference to `this` in order to allow method chaining
1532
+ */
1533
+ setExternalObject(
1534
+ /**
1535
+ * New value for property `externalObject`
1536
+ */
1537
+ oExternalObject: object
1538
+ ): this;
1539
+ /**
1540
+ * Sets a new value for property {@link #getHeight height}.
1541
+ *
1542
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1543
+ *
1544
+ * Default value is `"100%"`.
1545
+ *
1546
+ * @returns Reference to `this` in order to allow method chaining
1547
+ */
1548
+ setHeight(
1549
+ /**
1550
+ * New value for property `height`
1551
+ */
1552
+ sHeight?: CSSSize
1553
+ ): this;
1554
+ /**
1555
+ * Sets a new value for property {@link #getObject object}.
1556
+ *
1557
+ * A JSON object passed to the share component. This object contains the following properties:
1558
+ * - id (optional): is the object Id to be shared in SAP Jam, i.e a URL that navigates back to the same
1559
+ * object in the application
1560
+ * - display (optional): is a UI5 control to be displayed in the component UI
1561
+ * - share (optional): is a note that will be displayed in the component UI and shared to SAP Jam too
1562
+ *
1563
+ *
1564
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1565
+ *
1566
+ * @returns Reference to `this` in order to allow method chaining
1567
+ */
1568
+ setObject(
1569
+ /**
1570
+ * New value for property `object`
1571
+ */
1572
+ oObject: object
1573
+ ): this;
1574
+ /**
1575
+ * Sets a new value for property {@link #getODataServiceUrl oDataServiceUrl}.
1576
+ *
1577
+ * The OData service URL needed for the share component.
1578
+ *
1579
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1580
+ *
1581
+ * Default value is `"/sap/opu/odata/sap/SM_INTEGRATION_V2_SRV"`.
1582
+ *
1583
+ * @returns Reference to `this` in order to allow method chaining
1584
+ */
1585
+ setODataServiceUrl(
1586
+ /**
1587
+ * New value for property `oDataServiceUrl`
1588
+ */
1589
+ sODataServiceUrl?: URI
1590
+ ): this;
1591
+ /**
1592
+ * Setter for the Component settings.
1593
+ */
1594
+ setSettings(
1595
+ /**
1596
+ * A JSON object used to set the component settings, this object should contains the same properties used
1597
+ * in the constructor.
1598
+ */
1599
+ oSettings: object
1600
+ ): void;
1601
+ /**
1602
+ * Sets a new value for property {@link #getTunnelServiceUrl tunnelServiceUrl}.
1603
+ *
1604
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1605
+ *
1606
+ * Default value is `"/sap/bc/z_sail_httproxy/Jam/api/v1/OData"`.
1607
+ *
1608
+ * @returns Reference to `this` in order to allow method chaining
1609
+ */
1610
+ setTunnelServiceUrl(
1611
+ /**
1612
+ * New value for property `tunnelServiceUrl`
1613
+ */
1614
+ sTunnelServiceUrl?: URI
1615
+ ): this;
1616
+ /**
1617
+ * Sets a new value for property {@link #getWidth width}.
1618
+ *
1619
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1620
+ *
1621
+ * Default value is `"100%"`.
1622
+ *
1623
+ * @returns Reference to `this` in order to allow method chaining
1624
+ */
1625
+ setWidth(
1626
+ /**
1627
+ * New value for property `width`
1628
+ */
1629
+ sWidth?: CSSSize
1630
+ ): this;
1631
+ /**
1632
+ * Shares the data to Jam group
1633
+ */
1634
+ shareToJam(): void;
1635
+ }
1636
+
1637
+ export interface $ComponentSettings extends $UIComponentSettings {
1638
+ width?: CSSSize | PropertyBindingInfo | `{${string}}`;
1639
+
1640
+ height?: CSSSize | PropertyBindingInfo | `{${string}}`;
1641
+
1642
+ /**
1643
+ * The OData service URL needed for the share component.
1644
+ */
1645
+ oDataServiceUrl?: URI | PropertyBindingInfo | `{${string}}`;
1646
+
1647
+ collaborationHostODataServiceUrl?:
1648
+ | URI
1649
+ | PropertyBindingInfo
1650
+ | `{${string}}`;
1651
+
1652
+ tunnelServiceUrl?: URI | PropertyBindingInfo | `{${string}}`;
1653
+
1654
+ /**
1655
+ * A JSON object passed to the share component. This object contains the following properties:
1656
+ * - id (optional): is the object Id to be shared in SAP Jam, i.e a URL that navigates back to the same
1657
+ * object in the application
1658
+ * - display (optional): is a UI5 control to be displayed in the component UI
1659
+ * - share (optional): is a note that will be displayed in the component UI and shared to SAP Jam too
1660
+ */
1661
+ object?: object | PropertyBindingInfo | `{${string}}`;
1662
+
1663
+ attachments?: object | PropertyBindingInfo | `{${string}}`;
1664
+
1665
+ /**
1666
+ * A Business Object such as an Opportunity, Sales Order, Account, etc. from the back-end that will be shared
1667
+ * as a Featured External Object in a Group in Jam.
1668
+ * - {string} appContext: The application context. Example: "CRM", "SD", etc.
1669
+ * - {string} odataServicePath: The relative path to the OData Service. Example: "/sap/opu/odata/sap/ODATA_SRV"
1670
+ *
1671
+ * - {string} collection: The name of the OData Collection. Example: "Account", "Opportunity", etc.
1672
+ * - {string} key: The key to identify a particular instance of the Business Object. It can be a simple
1673
+ * ID or a compound key. Example: "123", "ObjectID='123'", "ObjectID='123',ObjectType='BUS000123'", etc.
1674
+ *
1675
+ * - {string} name: The short name of the Business Object. Example: "Sales Order 123", "Opportunity 123",
1676
+ * "Account 123", etc. These attributes are not enforced by the UI (missing or incorrect values
1677
+ * are not validated), but they are required to make the integration work. These attributes also should
1678
+ * be mapped in the Back-end System and Jam in order to make the External Object work.
1679
+ * **Note:** the externalObject is dependent on object.id, therefore, the object.id must also be passed
1680
+ * to the Share Component. See the parameter "object" for more information.
1681
+ */
1682
+ externalObject?: object | PropertyBindingInfo | `{${string}}`;
1683
+ }
1684
+ }
1685
+
1686
+ declare module "sap/collaboration/components/fiori/sharing/dialog/Component" {
1687
+ import {
1688
+ default as UIComponent,
1689
+ $UIComponentSettings,
1690
+ } from "sap/ui/core/UIComponent";
1691
+
1692
+ import { ID } from "sap/ui/core/library";
1693
+
1694
+ import ComponentMetadata from "sap/ui/core/ComponentMetadata";
1695
+
1696
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1697
+
1698
+ /**
1699
+ * The Share Dialog component is an SAPUI5 component that you can use to create a dialog in your application
1700
+ * to enable you to enter or edit information shared to SAP Jam.
1701
+ */
1702
+ export default class Component extends UIComponent {
1703
+ /**
1704
+ * Constructor for the share dialog component
1705
+ *
1706
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1707
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1708
+ * of the syntax of the settings object.
1709
+ */
1710
+ constructor(
1711
+ /**
1712
+ * initial settings for the new component. See the documentation of the component's properties for the structure
1713
+ * of the expected data.
1714
+ */
1715
+ mSettings?: $ComponentSettings
1716
+ );
1717
+ /**
1718
+ * Constructor for the share dialog component
1719
+ *
1720
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1721
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1722
+ * of the syntax of the settings object.
1723
+ */
1724
+ constructor(
1725
+ /**
1726
+ * id for the new component, generated automatically if no id is given
1727
+ */
1728
+ sId?: ID,
1729
+ /**
1730
+ * initial settings for the new component. See the documentation of the component's properties for the structure
1731
+ * of the expected data.
1732
+ */
1733
+ mSettings?: $ComponentSettings
1734
+ );
1735
+
1736
+ /**
1737
+ * Creates a new subclass of class sap.collaboration.components.fiori.sharing.dialog.Component with name
1738
+ * `sClassName` and enriches it with the information contained in `oClassInfo`.
1739
+ *
1740
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.UIComponent.extend}.
1741
+ *
1742
+ * @returns Created class / constructor function
1743
+ */
1744
+ static extend<T extends Record<string, unknown>>(
1745
+ /**
1746
+ * Name of the class being created
1747
+ */
1748
+ sClassName: string,
1749
+ /**
1750
+ * Object literal with information about the class
1751
+ */
1752
+ oClassInfo?: sap.ClassInfo<T, Component>,
1753
+ /**
1754
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1755
+ * used by this class
1756
+ */
1757
+ FNMetaImpl?: Function
1758
+ ): Function;
1759
+ /**
1760
+ * Returns a metadata object for class sap.collaboration.components.fiori.sharing.dialog.Component.
1761
+ *
1762
+ * @returns Metadata object describing this class
1763
+ */
1764
+ static getMetadata(): ComponentMetadata;
1765
+ /**
1766
+ * Gets current value of property {@link #getAttachments attachments}.
1767
+ *
1768
+ * When you want to provide the user with the option to share file attachments, then the following properties
1769
+ * need to be specified:
1770
+ * - attachmentsArray: An array of {@link sap.collaboration.components.fiori.sharing.attachment.Attachment}
1771
+ * objects. This array offers users a list of files they can attach.
1772
+ *
1773
+ * @returns Value of property `attachments`
1774
+ */
1775
+ getAttachments(): object;
1776
+ /**
1777
+ * Gets current value of property {@link #getExternalObject externalObject}.
1778
+ *
1779
+ * A Business Object such as an Opportunity, Sales Order, Account, etc. from the back-end that will be shared
1780
+ * as a Featured External Object in a Group in Jam.
1781
+ * - {string} appContext: The application context. Example: "CRM", "SD", etc.
1782
+ * - {string} odataServicePath: The relative path to the OData Service. Example: "/sap/opu/odata/sap/ODATA_SRV"
1783
+ *
1784
+ * - {string} collection: The name of the OData Collection. Example: "Account", "Opportunity", etc.
1785
+ * - {string} key: The key to identify a particular instance of the Business Object. It can be a simple
1786
+ * ID or a compound key. Example: "123", "ObjectID='123'", "ObjectID='123',ObjectType='BUS000123'", etc.
1787
+ *
1788
+ * - {string} name: The short name of the Business Object. Example: "Sales Order 123", "Opportunity 123",
1789
+ * "Account 123", etc. These attributes are not enforced by the UI (missing or incorrect values
1790
+ * are not validated), but they are required to make the integration work. These attributes also should
1791
+ * be mapped in the Back-end System and Jam in order to make the External Object work.
1792
+ * **Note:** the externalObject is dependent on object.id, therefore, the object.id must also be passed
1793
+ * to the Share Component. See the parameter "object" for more information.
1794
+ *
1795
+ * @returns Value of property `externalObject`
1796
+ */
1797
+ getExternalObject(): object;
1798
+ /**
1799
+ * Gets current value of property {@link #getObject object}.
1800
+ *
1801
+ * A JSON object passed to the share component. This object contains the following properties:
1802
+ * - id (optional): is the object Id to be shared in SAP Jam, i.e a URL( or a callback function that returns
1803
+ * a URL) that navigates back to the same object in the application
1804
+ * - display (optional): is a UI5 control to be displayed in the component UI
1805
+ * **Note:** The preferred object to pass in the display parameter is `sap.m.ObjectListItem`. Using other
1806
+ * type of objects (for example: `ap.ui.commons.TextView`) may result in problems in the rendering of the
1807
+ * content which needs to be corrected by the application owners.
1808
+ * - share (optional): is a note that will be displayed in the component UI and shared to SAP Jam too
1809
+ *
1810
+ *
1811
+ * @returns Value of property `object`
1812
+ */
1813
+ getObject(): object;
1814
+ /**
1815
+ * Opens the share component dialog
1816
+ */
1817
+ open(): void;
1818
+ /**
1819
+ * Sets a new value for property {@link #getAttachments attachments}.
1820
+ *
1821
+ * When you want to provide the user with the option to share file attachments, then the following properties
1822
+ * need to be specified:
1823
+ * - attachmentsArray: An array of {@link sap.collaboration.components.fiori.sharing.attachment.Attachment}
1824
+ * objects. This array offers users a list of files they can attach.
1825
+ *
1826
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1827
+ *
1828
+ * @returns Reference to `this` in order to allow method chaining
1829
+ */
1830
+ setAttachments(
1831
+ /**
1832
+ * New value for property `attachments`
1833
+ */
1834
+ oAttachments: object
1835
+ ): this;
1836
+ /**
1837
+ * Sets a new value for property {@link #getExternalObject externalObject}.
1838
+ *
1839
+ * A Business Object such as an Opportunity, Sales Order, Account, etc. from the back-end that will be shared
1840
+ * as a Featured External Object in a Group in Jam.
1841
+ * - {string} appContext: The application context. Example: "CRM", "SD", etc.
1842
+ * - {string} odataServicePath: The relative path to the OData Service. Example: "/sap/opu/odata/sap/ODATA_SRV"
1843
+ *
1844
+ * - {string} collection: The name of the OData Collection. Example: "Account", "Opportunity", etc.
1845
+ * - {string} key: The key to identify a particular instance of the Business Object. It can be a simple
1846
+ * ID or a compound key. Example: "123", "ObjectID='123'", "ObjectID='123',ObjectType='BUS000123'", etc.
1847
+ *
1848
+ * - {string} name: The short name of the Business Object. Example: "Sales Order 123", "Opportunity 123",
1849
+ * "Account 123", etc. These attributes are not enforced by the UI (missing or incorrect values
1850
+ * are not validated), but they are required to make the integration work. These attributes also should
1851
+ * be mapped in the Back-end System and Jam in order to make the External Object work.
1852
+ * **Note:** the externalObject is dependent on object.id, therefore, the object.id must also be passed
1853
+ * to the Share Component. See the parameter "object" for more information.
1854
+ *
1855
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1856
+ *
1857
+ * @returns Reference to `this` in order to allow method chaining
1858
+ */
1859
+ setExternalObject(
1860
+ /**
1861
+ * New value for property `externalObject`
1862
+ */
1863
+ oExternalObject: object
1864
+ ): this;
1865
+ /**
1866
+ * Sets a new value for property {@link #getObject object}.
1867
+ *
1868
+ * A JSON object passed to the share component. This object contains the following properties:
1869
+ * - id (optional): is the object Id to be shared in SAP Jam, i.e a URL( or a callback function that returns
1870
+ * a URL) that navigates back to the same object in the application
1871
+ * - display (optional): is a UI5 control to be displayed in the component UI
1872
+ * **Note:** The preferred object to pass in the display parameter is `sap.m.ObjectListItem`. Using other
1873
+ * type of objects (for example: `ap.ui.commons.TextView`) may result in problems in the rendering of the
1874
+ * content which needs to be corrected by the application owners.
1875
+ * - share (optional): is a note that will be displayed in the component UI and shared to SAP Jam too
1876
+ *
1877
+ *
1878
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1879
+ *
1880
+ * @returns Reference to `this` in order to allow method chaining
1881
+ */
1882
+ setObject(
1883
+ /**
1884
+ * New value for property `object`
1885
+ */
1886
+ oObject: object
1887
+ ): this;
1888
+ /**
1889
+ * Setter for the Component settings.
1890
+ */
1891
+ setSettings(
1892
+ /**
1893
+ * A JSON object used to set the component settings, this object should contains the same properties used
1894
+ * in the constructor.
1895
+ */
1896
+ oSettings: object
1897
+ ): void;
1898
+ }
1899
+
1900
+ export interface $ComponentSettings extends $UIComponentSettings {
1901
+ /**
1902
+ * When you want to provide the user with the option to share file attachments, then the following properties
1903
+ * need to be specified:
1904
+ * - attachmentsArray: An array of {@link sap.collaboration.components.fiori.sharing.attachment.Attachment}
1905
+ * objects. This array offers users a list of files they can attach.
1906
+ */
1907
+ attachments?: object | PropertyBindingInfo | `{${string}}`;
1908
+
1909
+ /**
1910
+ * A JSON object passed to the share component. This object contains the following properties:
1911
+ * - id (optional): is the object Id to be shared in SAP Jam, i.e a URL( or a callback function that returns
1912
+ * a URL) that navigates back to the same object in the application
1913
+ * - display (optional): is a UI5 control to be displayed in the component UI
1914
+ * **Note:** The preferred object to pass in the display parameter is `sap.m.ObjectListItem`. Using other
1915
+ * type of objects (for example: `ap.ui.commons.TextView`) may result in problems in the rendering of the
1916
+ * content which needs to be corrected by the application owners.
1917
+ * - share (optional): is a note that will be displayed in the component UI and shared to SAP Jam too
1918
+ */
1919
+ object?: object | PropertyBindingInfo | `{${string}}`;
1920
+
1921
+ /**
1922
+ * A Business Object such as an Opportunity, Sales Order, Account, etc. from the back-end that will be shared
1923
+ * as a Featured External Object in a Group in Jam.
1924
+ * - {string} appContext: The application context. Example: "CRM", "SD", etc.
1925
+ * - {string} odataServicePath: The relative path to the OData Service. Example: "/sap/opu/odata/sap/ODATA_SRV"
1926
+ *
1927
+ * - {string} collection: The name of the OData Collection. Example: "Account", "Opportunity", etc.
1928
+ * - {string} key: The key to identify a particular instance of the Business Object. It can be a simple
1929
+ * ID or a compound key. Example: "123", "ObjectID='123'", "ObjectID='123',ObjectType='BUS000123'", etc.
1930
+ *
1931
+ * - {string} name: The short name of the Business Object. Example: "Sales Order 123", "Opportunity 123",
1932
+ * "Account 123", etc. These attributes are not enforced by the UI (missing or incorrect values
1933
+ * are not validated), but they are required to make the integration work. These attributes also should
1934
+ * be mapped in the Back-end System and Jam in order to make the External Object work.
1935
+ * **Note:** the externalObject is dependent on object.id, therefore, the object.id must also be passed
1936
+ * to the Share Component. See the parameter "object" for more information.
1937
+ */
1938
+ externalObject?: object | PropertyBindingInfo | `{${string}}`;
1939
+ }
1940
+ }
1941
+
1942
+ declare module "sap/collaboration/components/socialprofile/Component" {
1943
+ import {
1944
+ default as UIComponent,
1945
+ $UIComponentSettings,
1946
+ } from "sap/ui/core/UIComponent";
1947
+
1948
+ import { CSSSize } from "sap/ui/core/library";
1949
+
1950
+ import ComponentMetadata from "sap/ui/core/ComponentMetadata";
1951
+
1952
+ import { PlacementType } from "sap/m/library";
1953
+
1954
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1955
+
1956
+ /**
1957
+ * @EXPERIMENTAL - The API is not stable and the UI is not finalized. The implementation for this feature
1958
+ * is subject to change.
1959
+ *
1960
+ * Social Profile Component
1961
+ */
1962
+ export default class Component extends UIComponent {
1963
+ /**
1964
+ * Constructor for the Social Profile Component.
1965
+ *
1966
+ * !!! EXPERIMENTAL !!!
1967
+ *
1968
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1969
+ * objects as well as event handlers.
1970
+ *
1971
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1972
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1973
+ * of the syntax of the settings object.
1974
+ */
1975
+ constructor(
1976
+ /**
1977
+ * initial settings for the new control
1978
+ */
1979
+ mSettings?: $ComponentSettings
1980
+ );
1981
+ /**
1982
+ * Constructor for the Social Profile Component.
1983
+ *
1984
+ * !!! EXPERIMENTAL !!!
1985
+ *
1986
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1987
+ * objects as well as event handlers.
1988
+ *
1989
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1990
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1991
+ * of the syntax of the settings object.
1992
+ */
1993
+ constructor(
1994
+ /**
1995
+ * id for the new control, generated automatically if no id is given
1996
+ */
1997
+ sId?: string,
1998
+ /**
1999
+ * initial settings for the new control
2000
+ */
2001
+ mSettings?: $ComponentSettings
2002
+ );
2003
+
2004
+ /**
2005
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2006
+ *
2007
+ * Cleans up the component instance before destruction. [borrowed from sap.ui.core.Component]
2008
+ */
2009
+ static exit(): void;
2010
+ /**
2011
+ * Creates a new subclass of class sap.collaboration.components.socialprofile.Component with name `sClassName`
2012
+ * and enriches it with the information contained in `oClassInfo`.
2013
+ *
2014
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.UIComponent.extend}.
2015
+ *
2016
+ * @returns Created class / constructor function
2017
+ */
2018
+ static extend<T extends Record<string, unknown>>(
2019
+ /**
2020
+ * Name of the class being created
2021
+ */
2022
+ sClassName: string,
2023
+ /**
2024
+ * Object literal with information about the class
2025
+ */
2026
+ oClassInfo?: sap.ClassInfo<T, Component>,
2027
+ /**
2028
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2029
+ * used by this class
2030
+ */
2031
+ FNMetaImpl?: Function
2032
+ ): Function;
2033
+ /**
2034
+ * Returns a metadata object for class sap.collaboration.components.socialprofile.Component.
2035
+ *
2036
+ * @returns Metadata object describing this class
2037
+ */
2038
+ static getMetadata(): ComponentMetadata;
2039
+ /**
2040
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2041
+ *
2042
+ * Initializes the Component instance after creation. [borrowed from sap.ui.core.UIComponent]
2043
+ */
2044
+ static init(): void;
2045
+ /**
2046
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2047
+ *
2048
+ * Function is called when the rendering of the Component Container is completed. [borrowed from sap.ui.core.UIComponent]
2049
+ */
2050
+ static onAfterRendering(): void;
2051
+ /**
2052
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2053
+ *
2054
+ * Function is called when the rendering of the Component Container is started. [borrowed from sap.ui.core.UIComponent]
2055
+ */
2056
+ static onBeforeRendering(): void;
2057
+ /**
2058
+ * Opens the social profile component
2059
+ */
2060
+ static open(): void;
2061
+ /**
2062
+ * Setter for the Component settings
2063
+ */
2064
+ static setSettings(
2065
+ /**
2066
+ * A JSON object used to set the component settings, this object should contains the same properties used
2067
+ * in the constructor
2068
+ */
2069
+ oSettings: object
2070
+ ): void;
2071
+ /**
2072
+ * Getter for property `height`. Gets the height of the Social Profile
2073
+ *
2074
+ * Default value is `380px`
2075
+ *
2076
+ * @returns the value of property `height`
2077
+ */
2078
+ getHeight(): CSSSize;
2079
+ /**
2080
+ * Getter for property `memberId`. Gets the SAP Jam member id of the user
2081
+ *
2082
+ * @returns the value of property `memberId`
2083
+ */
2084
+ getMemberId(): string;
2085
+ /**
2086
+ * Getter for property `memberInfo`. Gets the SAP Jam member information
2087
+ *
2088
+ * @returns member information `memberInfo`
2089
+ */
2090
+ getMemberInfo(): object;
2091
+ /**
2092
+ * Getter for property `openingControl`. Gets the opening control for the Social Profile
2093
+ *
2094
+ * @returns the value of property `openingControl`
2095
+ */
2096
+ getOpeningControl(): object;
2097
+ /**
2098
+ * Getter for property `placement`. Gets the placement of the Social Profile
2099
+ *
2100
+ * Default value is `sap.m.PlacementType.Auto`
2101
+ *
2102
+ * @returns the value of property `placement`
2103
+ */
2104
+ getPlacement(): PlacementType | keyof typeof PlacementType;
2105
+ /**
2106
+ * Getter for property `width`. Gets the width of the Social Profile
2107
+ *
2108
+ * Default value is `300px`
2109
+ *
2110
+ * @returns the value of property `width`
2111
+ */
2112
+ getWidth(): CSSSize;
2113
+ /**
2114
+ * Setter for property `height`. Sets the height of the Social Profile
2115
+ *
2116
+ * Default value is `380px`
2117
+ *
2118
+ * @returns `this` to allow method chaining
2119
+ */
2120
+ setHeight(
2121
+ /**
2122
+ * new value for property `height`
2123
+ */
2124
+ sHeight: string
2125
+ ): this;
2126
+ /**
2127
+ * Setter for property `memberId`. Sets the memberId of the user
2128
+ *
2129
+ * @returns `this` to allow method chaining
2130
+ */
2131
+ setMemberId(
2132
+ /**
2133
+ * new value for property `memberId`
2134
+ */
2135
+ sMemberId: string
2136
+ ): this;
2137
+ /**
2138
+ * Setter for property `memberInfo`. Sets the memberInformation of the user
2139
+ *
2140
+ * @returns `this` to allow method chaining
2141
+ */
2142
+ setMemberInfo(
2143
+ /**
2144
+ * new value for property `memberInfo`
2145
+ */
2146
+ oMemberInfo: object
2147
+ ): this;
2148
+ /**
2149
+ * Setter for property `openingControl`. Sets the opening control for the Social Profile
2150
+ *
2151
+ * @returns `this` to allow method chaining
2152
+ */
2153
+ setOpeningControl(
2154
+ /**
2155
+ * new value for property `openingControl`
2156
+ */
2157
+ oOpeningControl: object
2158
+ ): this;
2159
+ /**
2160
+ * Setter for property `placement`. Sets the placement of the Social Profile
2161
+ *
2162
+ * Default value is `sap.m.PlacementType.Auto`
2163
+ *
2164
+ * @returns `this` to allow method chaining
2165
+ */
2166
+ setPlacement(
2167
+ /**
2168
+ * new value for property `placement`
2169
+ */
2170
+ sPlacement: PlacementType | keyof typeof PlacementType
2171
+ ): this;
2172
+ /**
2173
+ * Setter for property `width`. Sets the width of the Social Profile
2174
+ *
2175
+ * Default value is `300px`
2176
+ *
2177
+ * @returns `this` to allow method chaining
2178
+ */
2179
+ setWidth(
2180
+ /**
2181
+ * new value for property `width`
2182
+ */
2183
+ sWidth: string
2184
+ ): this;
2185
+ }
2186
+
2187
+ export interface $ComponentSettings extends $UIComponentSettings {
2188
+ placement?:
2189
+ | (PlacementType | keyof typeof PlacementType)
2190
+ | PropertyBindingInfo
2191
+ | `{${string}}`;
2192
+
2193
+ memberId?: string | PropertyBindingInfo;
2194
+
2195
+ memberInfo?: object | PropertyBindingInfo | `{${string}}`;
2196
+
2197
+ openingControl?: object | PropertyBindingInfo | `{${string}}`;
2198
+
2199
+ height?: CSSSize | PropertyBindingInfo | `{${string}}`;
2200
+
2201
+ width?: CSSSize | PropertyBindingInfo | `{${string}}`;
2202
+ }
2203
+ }
2204
+
2205
+ declare module "sap/collaboration/components/socialtimeline/Component" {
2206
+ import {
2207
+ default as UIComponent,
2208
+ $UIComponentSettings,
2209
+ } from "sap/ui/core/UIComponent";
2210
+
2211
+ import Event from "sap/ui/base/Event";
2212
+
2213
+ import {
2214
+ TimelineAlignment,
2215
+ TimelineAxisOrientation,
2216
+ } from "sap/suite/ui/commons/library";
2217
+
2218
+ import ComponentMetadata from "sap/ui/core/ComponentMetadata";
2219
+
2220
+ import { CSSSize } from "sap/ui/core/library";
2221
+
2222
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
2223
+
2224
+ /**
2225
+ * @deprecated (since 1.34.0) - For new integrations and existing implementations running on release 1.32
2226
+ * or later, use the Group Feed component (sap.collaboration.components.feed.Component), Business Object
2227
+ * mode(sap.collaboration.FeedType.BusinessObjectGroups). Note that the Group Feed component does not display
2228
+ * any updates related to the business object from the back-end system (system updates).
2229
+ *
2230
+ * Social Timeline
2231
+ */
2232
+ export default class Component extends UIComponent {
2233
+ /**
2234
+ * Constructor for the Social Timeline Component.
2235
+ *
2236
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2237
+ * objects as well as event handlers.
2238
+ *
2239
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2240
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
2241
+ * of the syntax of the settings object.
2242
+ */
2243
+ constructor(
2244
+ /**
2245
+ * initial settings for the new control
2246
+ */
2247
+ mSettings?: $ComponentSettings
2248
+ );
2249
+ /**
2250
+ * Constructor for the Social Timeline Component.
2251
+ *
2252
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2253
+ * objects as well as event handlers.
2254
+ *
2255
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2256
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
2257
+ * of the syntax of the settings object.
2258
+ */
2259
+ constructor(
2260
+ /**
2261
+ * id for the new control, generated automatically if no id is given
2262
+ */
2263
+ sId?: string,
2264
+ /**
2265
+ * initial settings for the new control
2266
+ */
2267
+ mSettings?: $ComponentSettings
2268
+ );
2269
+
2270
+ /**
2271
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2272
+ *
2273
+ * The method to create the Content (UI Control Tree) of the Component.
2274
+ */
2275
+ static createContent(): void;
2276
+ /**
2277
+ * Delete a Timeline Entry. This method should be called when a custom action requires a deletion of a Timeline
2278
+ * entry and should only be called if an a delete to the backend is performed successfully.
2279
+ */
2280
+ static deleteTimelineEntry(
2281
+ /**
2282
+ * the id of the timeline entry to delete
2283
+ */
2284
+ sId: string
2285
+ ): void;
2286
+ /**
2287
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2288
+ *
2289
+ * Cleans up the component instance before destruction.
2290
+ */
2291
+ static exit(): void;
2292
+ /**
2293
+ * Creates a new subclass of class sap.collaboration.components.socialtimeline.Component with name `sClassName`
2294
+ * and enriches it with the information contained in `oClassInfo`.
2295
+ *
2296
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.UIComponent.extend}.
2297
+ *
2298
+ * @returns Created class / constructor function
2299
+ */
2300
+ static extend<T extends Record<string, unknown>>(
2301
+ /**
2302
+ * Name of the class being created
2303
+ */
2304
+ sClassName: string,
2305
+ /**
2306
+ * Object literal with information about the class
2307
+ */
2308
+ oClassInfo?: sap.ClassInfo<T, Component>,
2309
+ /**
2310
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2311
+ * used by this class
2312
+ */
2313
+ FNMetaImpl?: Function
2314
+ ): Function;
2315
+ /**
2316
+ * Returns a metadata object for class sap.collaboration.components.socialtimeline.Component.
2317
+ *
2318
+ * @returns Metadata object describing this class
2319
+ */
2320
+ static getMetadata(): ComponentMetadata;
2321
+ /**
2322
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2323
+ *
2324
+ * Initializes the Component instance after creation.
2325
+ */
2326
+ static init(): void;
2327
+ /**
2328
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2329
+ *
2330
+ * Function is called when the rendering of the Component Container is completed.
2331
+ */
2332
+ static onAfterRendering(): void;
2333
+ /**
2334
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2335
+ *
2336
+ * Function is called when the rendering of the Component Container is started.
2337
+ */
2338
+ static onBeforeRendering(): void;
2339
+ /**
2340
+ * Set the current business object for the social timeline to display. Note: The function setBusinessObjectMap
2341
+ * must be called once before calling setBusinessObject for the first time.
2342
+ */
2343
+ static setBusinessObject(
2344
+ /**
2345
+ * an object that contains the key and name for the business object
2346
+ */
2347
+ oObject: object
2348
+ ): void;
2349
+ /**
2350
+ * @deprecated (since 1.28.5) - This method is deprecated, use method setBusinessObject instead.
2351
+ *
2352
+ * Set the current business object for the social timeline to display. Note: The function setBusinessObjectMap
2353
+ * must be called once before calling setBusinessObjectKey for the first time.
2354
+ */
2355
+ static setBusinessObjectKey(sKey: string): void;
2356
+ /**
2357
+ * Set the business object map. It is used to initialize the data needed to retrieve the timeline entries.
2358
+ * This function must be called once before calling setBusinessObjectKey for the first time.
2359
+ */
2360
+ static setBusinessObjectMap(
2361
+ /**
2362
+ * required - JSON object containing the following properties:
2363
+ * {sap.ui.model.odata.ODataModel} serviceModel required - OData model to retrieve timeline entries {string}
2364
+ * servicePath: The relative path to the OData service for the business object (example: "/sap/opu/odata/sap/ODATA_SRV")
2365
+ * {string} collection: Entity collection name of the business object {string} applicationContext:
2366
+ * The application context (example: "CRM", "SD", etc.) {function} customActionCallback: A callback
2367
+ * function to determine which timeline entries should receive the custom action. The function should return
2368
+ * an array of text/value objects.
2369
+ */
2370
+ businessObjectMap: object
2371
+ ): void;
2372
+ /**
2373
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2374
+ *
2375
+ * Set property of component
2376
+ */
2377
+ static setProperty(): void;
2378
+ /**
2379
+ * Setter for the Component settings.
2380
+ */
2381
+ static setSettings(
2382
+ /**
2383
+ * A JSON object used to set the component settings, this object should contains the same properties used
2384
+ * in the constructor.
2385
+ */
2386
+ settings: object
2387
+ ): void;
2388
+ /**
2389
+ * Update a Timeline Entry text. This method should be called when a custom action requires a content update
2390
+ * of a Timeline entry and should only be called if an an update to the backend is performed successfully.
2391
+ */
2392
+ static updateTimelineEntry(
2393
+ /**
2394
+ * the text that will be displayed in the content of the timeline entry
2395
+ */
2396
+ sText: string,
2397
+ /**
2398
+ * the id of the timeline entry to update
2399
+ */
2400
+ sId: string
2401
+ ): void;
2402
+ /**
2403
+ * Attaches event handler `fnFunction` to the {@link #event:customActionPress customActionPress} event of
2404
+ * this `sap.collaboration.components.socialtimeline.Component`.
2405
+ *
2406
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2407
+ * otherwise it will be bound to this `sap.collaboration.components.socialtimeline.Component` itself.
2408
+ *
2409
+ * @returns Reference to `this` in order to allow method chaining
2410
+ */
2411
+ attachCustomActionPress(
2412
+ /**
2413
+ * An application-specific payload object that will be passed to the event handler along with the event
2414
+ * object when firing the event
2415
+ */
2416
+ oData: object,
2417
+ /**
2418
+ * The function to be called when the event occurs
2419
+ */
2420
+ fnFunction: (p1: Event) => void,
2421
+ /**
2422
+ * Context object to call the event handler with. Defaults to this `sap.collaboration.components.socialtimeline.Component`
2423
+ * itself
2424
+ */
2425
+ oListener?: object
2426
+ ): this;
2427
+ /**
2428
+ * Attaches event handler `fnFunction` to the {@link #event:customActionPress customActionPress} event of
2429
+ * this `sap.collaboration.components.socialtimeline.Component`.
2430
+ *
2431
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2432
+ * otherwise it will be bound to this `sap.collaboration.components.socialtimeline.Component` itself.
2433
+ *
2434
+ * @returns Reference to `this` in order to allow method chaining
2435
+ */
2436
+ attachCustomActionPress(
2437
+ /**
2438
+ * The function to be called when the event occurs
2439
+ */
2440
+ fnFunction: (p1: Event) => void,
2441
+ /**
2442
+ * Context object to call the event handler with. Defaults to this `sap.collaboration.components.socialtimeline.Component`
2443
+ * itself
2444
+ */
2445
+ oListener?: object
2446
+ ): this;
2447
+ /**
2448
+ * Detaches event handler `fnFunction` from the {@link #event:customActionPress customActionPress} event
2449
+ * of this `sap.collaboration.components.socialtimeline.Component`.
2450
+ *
2451
+ * The passed function and listener object must match the ones used for event registration.
2452
+ *
2453
+ * @returns Reference to `this` in order to allow method chaining
2454
+ */
2455
+ detachCustomActionPress(
2456
+ /**
2457
+ * The function to be called, when the event occurs
2458
+ */
2459
+ fnFunction: (p1: Event) => void,
2460
+ /**
2461
+ * Context object on which the given function had to be called
2462
+ */
2463
+ oListener?: object
2464
+ ): this;
2465
+ /**
2466
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
2467
+ *
2468
+ * Fires event {@link #event:customActionPress customActionPress} to attached listeners.
2469
+ *
2470
+ * @returns Reference to `this` in order to allow method chaining
2471
+ */
2472
+ fireCustomActionPress(
2473
+ /**
2474
+ * Parameters to pass along with the event
2475
+ */
2476
+ mParameters?: object
2477
+ ): this;
2478
+ /**
2479
+ * Getter for property `alignment`. Timeline item alignment.
2480
+ *
2481
+ * Default value is `Right`
2482
+ *
2483
+ * @returns the value of property `alignment`
2484
+ */
2485
+ getAlignment(): TimelineAlignment | keyof typeof TimelineAlignment;
2486
+ /**
2487
+ * Getter for property `axisOrientation`. Timeline axis orientation.
2488
+ *
2489
+ * Default value is `Vertical`
2490
+ *
2491
+ * @returns the value of property `axisOrientation`
2492
+ */
2493
+ getAxisOrientation():
2494
+ | TimelineAxisOrientation
2495
+ | keyof typeof TimelineAxisOrientation;
2496
+ /**
2497
+ * Getter for property `customFilter`.
2498
+ *
2499
+ * Default value is `[]`. The customFilter is an array of objects, each object contains text and value.
2500
+ * Text is the name of the filter category and value is the filter value.
2501
+ *
2502
+ * @returns the value of property `customFilter`
2503
+ */
2504
+ getCustomFilter(): any[];
2505
+ /**
2506
+ * Gets current value of property {@link #getEnableSocial enableSocial}.
2507
+ *
2508
+ * Default value is `true`.
2509
+ *
2510
+ * @returns Value of property `enableSocial`
2511
+ */
2512
+ getEnableSocial(): boolean;
2513
+ /**
2514
+ * Getter for property `noDataText`. This text is displayed when the control has no data.
2515
+ *
2516
+ * Default value is empty/`undefined`
2517
+ *
2518
+ * @returns the value of property `noDataText`
2519
+ */
2520
+ getNoDataText(): string;
2521
+ /**
2522
+ * Getter for property `showIcons`. Show icon on each Timeline item.
2523
+ *
2524
+ * Default value is `true`
2525
+ *
2526
+ * @returns the value of property `showIcons`
2527
+ */
2528
+ getShowIcons(): boolean;
2529
+ /**
2530
+ * Getter for property `visible`. Set Timeline control visibility
2531
+ *
2532
+ * Default value is `true`
2533
+ *
2534
+ * @returns the value of property `visible`
2535
+ */
2536
+ getVisible(): boolean;
2537
+ /**
2538
+ * Getter for property `width`. Sets the width of the Timeline.
2539
+ *
2540
+ * Default value is `100%`
2541
+ *
2542
+ * @returns the value of property `width`
2543
+ */
2544
+ getWidth(): CSSSize;
2545
+ /**
2546
+ * Setter for property `alignment`.
2547
+ *
2548
+ * Default value is `Right`
2549
+ *
2550
+ * @returns `this` to allow method chaining
2551
+ */
2552
+ setAlignment(
2553
+ /**
2554
+ * new value for property `alignment`
2555
+ */
2556
+ oAlignment: TimelineAlignment | keyof typeof TimelineAlignment
2557
+ ): this;
2558
+ /**
2559
+ * Setter for property `axisOrientation`.
2560
+ *
2561
+ * Default value is `Vertical`
2562
+ *
2563
+ * @returns `this` to allow method chaining
2564
+ */
2565
+ setAxisOrientation(
2566
+ /**
2567
+ * new value for property `axisOrientation`
2568
+ */
2569
+ oAxisOrientation:
2570
+ | TimelineAxisOrientation
2571
+ | keyof typeof TimelineAxisOrientation
2572
+ ): this;
2573
+ /**
2574
+ * Sets a new value for property {@link #getCustomFilter customFilter}.
2575
+ *
2576
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2577
+ *
2578
+ * @returns Reference to `this` in order to allow method chaining
2579
+ */
2580
+ setCustomFilter(
2581
+ /**
2582
+ * New value for property `customFilter`
2583
+ */
2584
+ sCustomFilter: object[]
2585
+ ): this;
2586
+ /**
2587
+ * Sets a new value for property {@link #getEnableSocial enableSocial}.
2588
+ *
2589
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2590
+ *
2591
+ * Default value is `true`.
2592
+ *
2593
+ * @returns Reference to `this` in order to allow method chaining
2594
+ */
2595
+ setEnableSocial(
2596
+ /**
2597
+ * New value for property `enableSocial`
2598
+ */
2599
+ bEnableSocial?: boolean
2600
+ ): this;
2601
+ /**
2602
+ * Setter for property `noDataText`.
2603
+ *
2604
+ * Default value is empty/`undefined`
2605
+ *
2606
+ * @returns `this` to allow method chaining
2607
+ */
2608
+ setNoDataText(
2609
+ /**
2610
+ * new value for property `noDataText`
2611
+ */
2612
+ sNoDataText: string
2613
+ ): this;
2614
+ /**
2615
+ * Setter for property `showIcons`.
2616
+ *
2617
+ * Default value is `true`
2618
+ *
2619
+ * @returns `this` to allow method chaining
2620
+ */
2621
+ setShowIcons(
2622
+ /**
2623
+ * new value for property `showIcons`
2624
+ */
2625
+ bShowIcons: boolean
2626
+ ): this;
2627
+ /**
2628
+ * Setter for property `visible`.
2629
+ *
2630
+ * Default value is `true`
2631
+ *
2632
+ * @returns `this` to allow method chaining
2633
+ */
2634
+ setVisible(
2635
+ /**
2636
+ * new value for property `visible`
2637
+ */
2638
+ bVisible: boolean
2639
+ ): this;
2640
+ /**
2641
+ * Setter for property `width`.
2642
+ *
2643
+ * Default value is `100%`
2644
+ *
2645
+ * @returns `this` to allow method chaining
2646
+ */
2647
+ setWidth(
2648
+ /**
2649
+ * new value for property `width`
2650
+ */
2651
+ sWidth: CSSSize
2652
+ ): this;
2653
+ }
2654
+
2655
+ export interface $ComponentSettings extends $UIComponentSettings {
2656
+ enableSocial?: boolean | PropertyBindingInfo | `{${string}}`;
2657
+
2658
+ alignment?:
2659
+ | (TimelineAlignment | keyof typeof TimelineAlignment)
2660
+ | PropertyBindingInfo
2661
+ | `{${string}}`;
2662
+
2663
+ axisOrientation?:
2664
+ | (TimelineAxisOrientation | keyof typeof TimelineAxisOrientation)
2665
+ | PropertyBindingInfo
2666
+ | `{${string}}`;
2667
+
2668
+ noDataText?: string | PropertyBindingInfo;
2669
+
2670
+ showIcons?: boolean | PropertyBindingInfo | `{${string}}`;
2671
+
2672
+ visible?: boolean | PropertyBindingInfo | `{${string}}`;
2673
+
2674
+ width?: CSSSize | PropertyBindingInfo | `{${string}}`;
2675
+
2676
+ customFilter?: object[] | PropertyBindingInfo | `{${string}}`;
2677
+
2678
+ customActionPress?: (oEvent: Event) => void;
2679
+ }
2680
+ }
2681
+
2682
+ declare namespace sap {
2683
+ interface IUI5DefineDependencyNames {
2684
+ "sap/collaboration/components/feed/Component": undefined;
2685
+
2686
+ "sap/collaboration/components/fiori/feed/Component": undefined;
2687
+
2688
+ "sap/collaboration/components/fiori/feed/dialog/Component": undefined;
2689
+
2690
+ "sap/collaboration/components/fiori/notification/Component": undefined;
2691
+
2692
+ "sap/collaboration/components/fiori/sharing/attachment/Attachment": undefined;
2693
+
2694
+ "sap/collaboration/components/fiori/sharing/Component": undefined;
2695
+
2696
+ "sap/collaboration/components/fiori/sharing/dialog/Component": undefined;
2697
+
2698
+ "sap/collaboration/components/socialprofile/Component": undefined;
2699
+
2700
+ "sap/collaboration/components/socialtimeline/Component": undefined;
2701
+
2702
+ "sap/collaboration/library": undefined;
2703
+ }
2704
+ }