@sapui5/ts-types 1.92.2 → 1.93.3
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.
- package/README.md +3 -1
- package/package.json +1 -1
- package/types/index.d.ts +2 -1
- package/types/sap.apf.d.ts +1 -44
- package/types/sap.ca.ui.d.ts +649 -651
- package/types/sap.chart.d.ts +49 -49
- package/types/sap.collaboration.d.ts +756 -762
- package/types/sap.esh.search.ui.d.ts +241 -0
- package/types/sap.f.d.ts +623 -468
- package/types/sap.fe.common.d.ts +1 -1
- package/types/sap.fe.core.d.ts +101 -75
- package/types/sap.fe.macros.d.ts +55 -8
- package/types/sap.fe.navigation.d.ts +5 -14
- package/types/sap.fe.placeholder-1.93.1-d.ts +3 -0
- package/types/sap.fe.plugins.d.ts +2 -4
- package/types/sap.fe.templates.d.ts +1 -16
- package/types/sap.fe.test.d.ts +44 -115
- package/types/sap.fe.tools.d.ts +2 -4
- package/types/sap.feedback.ui.d.ts +1 -1
- package/types/sap.gantt.d.ts +1321 -1191
- package/types/sap.landvisz.d.ts +345 -345
- package/types/sap.m.d.ts +5498 -4814
- package/types/sap.makit.d.ts +123 -123
- package/types/sap.me.d.ts +137 -153
- package/types/sap.ndc.d.ts +29 -29
- package/types/sap.ovp.d.ts +1 -1
- package/types/sap.rules.ui.d.ts +170 -124
- package/types/sap.suite.ui.commons.d.ts +1593 -1612
- package/types/sap.suite.ui.generic.template.d.ts +285 -165
- package/types/sap.suite.ui.microchart.d.ts +742 -508
- package/types/sap.tnt.d.ts +149 -117
- package/types/sap.ui.codeeditor.d.ts +28 -28
- package/types/sap.ui.commons.d.ts +1387 -1387
- package/types/sap.ui.comp.d.ts +1013 -1013
- package/types/sap.ui.core.d.ts +3852 -3973
- package/types/sap.ui.dt.d.ts +2 -4
- package/types/sap.ui.export.d.ts +3 -3
- package/types/sap.ui.fl.d.ts +1 -1
- package/types/sap.ui.generic.app.d.ts +138 -147
- package/types/sap.ui.generic.template.d.ts +2 -4
- package/types/sap.ui.integration.d.ts +118 -112
- package/types/sap.ui.layout.d.ts +593 -586
- package/types/sap.ui.mdc.d.ts +7 -1
- package/types/sap.ui.richtexteditor.d.ts +30 -30
- package/types/sap.ui.rta.d.ts +1 -1
- package/types/sap.ui.suite.d.ts +53 -53
- package/types/sap.ui.support.d.ts +6 -12
- package/types/sap.ui.table.d.ts +248 -248
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +853 -713
- package/types/sap.ui.ux3.d.ts +785 -793
- package/types/sap.ui.vbm.d.ts +784 -784
- package/types/sap.ui.vk.d.ts +3130 -2251
- package/types/sap.ui.vtm.d.ts +240 -240
- package/types/sap.uiext.inbox.d.ts +222 -222
- package/types/sap.ushell.d.ts +340 -377
- package/types/sap.ushell_abap.d.ts +127 -129
- package/types/sap.uxap.d.ts +384 -220
- package/types/sap.viz.d.ts +1527 -1527
- package/types/sap.webanalytics.core.d.ts +1 -1
- package/types/sap.zen.commons.d.ts +188 -222
- package/types/sap.zen.crosstab.d.ts +15 -17
- package/types/sap.zen.dsh.d.ts +176 -211
- package/types/sap.fe.placeholder.d.ts +0 -5
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.93.1
|
|
2
2
|
|
|
3
3
|
declare namespace sap {
|
|
4
4
|
/**
|
|
@@ -7,7 +7,20 @@ declare namespace sap {
|
|
|
7
7
|
namespace collaboration {
|
|
8
8
|
namespace components {
|
|
9
9
|
namespace feed {
|
|
10
|
-
interface $ComponentSettings extends sap.ui.core.$UIComponentSettings {
|
|
10
|
+
interface $ComponentSettings extends sap.ui.core.$UIComponentSettings {
|
|
11
|
+
axisOrientation?:
|
|
12
|
+
| sap.suite.ui.commons.TimelineAxisOrientation
|
|
13
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
14
|
+
|
|
15
|
+
feedSources?:
|
|
16
|
+
| object
|
|
17
|
+
| string[]
|
|
18
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
19
|
+
|
|
20
|
+
enableScroll?:
|
|
21
|
+
| boolean
|
|
22
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
23
|
+
}
|
|
11
24
|
|
|
12
25
|
/**
|
|
13
26
|
* @SINCE 1.30
|
|
@@ -22,23 +35,37 @@ declare namespace sap {
|
|
|
22
35
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
23
36
|
* objects as well as event handlers.
|
|
24
37
|
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
38
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
39
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
40
|
+
* of the syntax of the settings object.
|
|
41
|
+
*/
|
|
42
|
+
constructor(
|
|
43
|
+
/**
|
|
44
|
+
* initial settings for the new component. See the documentation of the component's properties for the structure
|
|
45
|
+
* of the expected data.
|
|
46
|
+
*/
|
|
47
|
+
mSettings?: sap.collaboration.components.feed.$ComponentSettings
|
|
48
|
+
);
|
|
49
|
+
/**
|
|
50
|
+
* Constructor for the Feed Component.
|
|
51
|
+
*
|
|
52
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
53
|
+
* objects as well as event handlers.
|
|
54
|
+
*
|
|
55
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
56
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
57
|
+
* of the syntax of the settings object.
|
|
31
58
|
*/
|
|
32
59
|
constructor(
|
|
33
60
|
/**
|
|
34
61
|
* id for the new component, generated automatically if no id is given
|
|
35
62
|
*/
|
|
36
|
-
sId?:
|
|
63
|
+
sId?: sap.ui.core.ID,
|
|
37
64
|
/**
|
|
38
65
|
* initial settings for the new component. See the documentation of the component's properties for the structure
|
|
39
66
|
* of the expected data.
|
|
40
67
|
*/
|
|
41
|
-
mSettings?:
|
|
68
|
+
mSettings?: sap.collaboration.components.feed.$ComponentSettings
|
|
42
69
|
);
|
|
43
70
|
|
|
44
71
|
/**
|
|
@@ -50,19 +77,33 @@ declare namespace sap {
|
|
|
50
77
|
*/
|
|
51
78
|
static exit(): void;
|
|
52
79
|
/**
|
|
53
|
-
*
|
|
80
|
+
* Creates a new subclass of class sap.collaboration.components.feed.Component with name `sClassName` and
|
|
81
|
+
* enriches it with the information contained in `oClassInfo`.
|
|
54
82
|
*
|
|
55
|
-
*
|
|
56
|
-
*/
|
|
57
|
-
getAxisOrientation(): sap.suite.ui.commons.TimelineAxisOrientation;
|
|
58
|
-
/**
|
|
59
|
-
* Getter for property `enableScroll`.
|
|
83
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.UIComponent.extend}.
|
|
60
84
|
*/
|
|
61
|
-
|
|
85
|
+
static extend<T extends Record<string, unknown>>(
|
|
86
|
+
/**
|
|
87
|
+
* Name of the class being created
|
|
88
|
+
*/
|
|
89
|
+
sClassName: string,
|
|
90
|
+
/**
|
|
91
|
+
* Object literal with information about the class
|
|
92
|
+
*/
|
|
93
|
+
oClassInfo?: sap.ClassInfo<
|
|
94
|
+
T,
|
|
95
|
+
sap.collaboration.components.feed.Component
|
|
96
|
+
>,
|
|
97
|
+
/**
|
|
98
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
99
|
+
* used by this class
|
|
100
|
+
*/
|
|
101
|
+
FNMetaImpl?: Function
|
|
102
|
+
): Function;
|
|
62
103
|
/**
|
|
63
|
-
*
|
|
104
|
+
* Returns a metadata object for class sap.collaboration.components.feed.Component.
|
|
64
105
|
*/
|
|
65
|
-
|
|
106
|
+
static getMetadata(): sap.ui.core.ComponentMetadata;
|
|
66
107
|
/**
|
|
67
108
|
* Returns the selected Group.
|
|
68
109
|
*/
|
|
@@ -79,6 +120,43 @@ declare namespace sap {
|
|
|
79
120
|
* Function is called when the rendering of the Component Container is started.
|
|
80
121
|
*/
|
|
81
122
|
static onBeforeRendering(): void;
|
|
123
|
+
/**
|
|
124
|
+
* Set the axis orientation for the Timeline.
|
|
125
|
+
*/
|
|
126
|
+
static setAxisOrientation(
|
|
127
|
+
axisOrientation: sap.suite.ui.commons.TimelineAxisOrientation
|
|
128
|
+
): void;
|
|
129
|
+
/**
|
|
130
|
+
* Sets the enableScroll property for the Timeline.
|
|
131
|
+
*/
|
|
132
|
+
static setEnableScroll(enableScroll: boolean): void;
|
|
133
|
+
/**
|
|
134
|
+
* Sets the sources for the feed. Array of strings representing the Jam group IDs (e.g. ["groupid1", "groupid2"]).
|
|
135
|
+
*/
|
|
136
|
+
static setFeedSources(feedSources: object): void;
|
|
137
|
+
/**
|
|
138
|
+
* Sets all the properties passed in oSettings.
|
|
139
|
+
*/
|
|
140
|
+
static setSettings(
|
|
141
|
+
/**
|
|
142
|
+
* key/value map for settings
|
|
143
|
+
*/
|
|
144
|
+
settings: Record<string, any>
|
|
145
|
+
): void;
|
|
146
|
+
/**
|
|
147
|
+
* Getter for property `axisOrientation`.
|
|
148
|
+
*
|
|
149
|
+
* Default value is `Vertical`
|
|
150
|
+
*/
|
|
151
|
+
getAxisOrientation(): sap.suite.ui.commons.TimelineAxisOrientation;
|
|
152
|
+
/**
|
|
153
|
+
* Getter for property `enableScroll`.
|
|
154
|
+
*/
|
|
155
|
+
getEnableScroll(): boolean;
|
|
156
|
+
/**
|
|
157
|
+
* Getter for property `feedSources`.
|
|
158
|
+
*/
|
|
159
|
+
getFeedSources(): Record<string, any> | string[];
|
|
82
160
|
/**
|
|
83
161
|
* Setter for property `axisOrientation`.
|
|
84
162
|
*
|
|
@@ -90,12 +168,6 @@ declare namespace sap {
|
|
|
90
168
|
*/
|
|
91
169
|
oAxisOrientation: sap.suite.ui.commons.TimelineAxisOrientation
|
|
92
170
|
): sap.collaboration.components.feed.Component;
|
|
93
|
-
/**
|
|
94
|
-
* Set the axis orientation for the Timeline.
|
|
95
|
-
*/
|
|
96
|
-
static setAxisOrientation(
|
|
97
|
-
axisOrientation: sap.suite.ui.commons.TimelineAxisOrientation
|
|
98
|
-
): void;
|
|
99
171
|
/**
|
|
100
172
|
* Setter for property `enableScroll`.
|
|
101
173
|
*
|
|
@@ -112,10 +184,6 @@ declare namespace sap {
|
|
|
112
184
|
*/
|
|
113
185
|
bEnableScroll: boolean
|
|
114
186
|
): sap.collaboration.components.feed.Component;
|
|
115
|
-
/**
|
|
116
|
-
* Sets the enableScroll property for the Timeline.
|
|
117
|
-
*/
|
|
118
|
-
static setEnableScroll(enableScroll: boolean): void;
|
|
119
187
|
/**
|
|
120
188
|
* Setter for property `feedSources`.
|
|
121
189
|
*
|
|
@@ -129,19 +197,6 @@ declare namespace sap {
|
|
|
129
197
|
*/
|
|
130
198
|
oFeedSources: Record<string, any> | string[]
|
|
131
199
|
): void;
|
|
132
|
-
/**
|
|
133
|
-
* Sets the sources for the feed. Array of strings representing the Jam group IDs (e.g. ["groupid1", "groupid2"]).
|
|
134
|
-
*/
|
|
135
|
-
static setFeedSources(feedSources: object): void;
|
|
136
|
-
/**
|
|
137
|
-
* Sets all the properties passed in oSettings.
|
|
138
|
-
*/
|
|
139
|
-
static setSettings(
|
|
140
|
-
/**
|
|
141
|
-
* key/value map for settings
|
|
142
|
-
*/
|
|
143
|
-
settings: Record<string, any>
|
|
144
|
-
): void;
|
|
145
200
|
}
|
|
146
201
|
}
|
|
147
202
|
|
|
@@ -150,20 +205,65 @@ declare namespace sap {
|
|
|
150
205
|
namespace dialog {
|
|
151
206
|
interface $ComponentSettings
|
|
152
207
|
extends sap.ui.core.$UIComponentSettings {
|
|
208
|
+
/**
|
|
209
|
+
* The width of the component.
|
|
210
|
+
*/
|
|
153
211
|
width?:
|
|
154
212
|
| sap.ui.core.CSSSize
|
|
155
213
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
156
214
|
|
|
215
|
+
/**
|
|
216
|
+
* The height of the component.
|
|
217
|
+
*
|
|
218
|
+
* We need to pass a value in pixels, otherwise the dialog won't render correctly
|
|
219
|
+
*/
|
|
157
220
|
height?:
|
|
158
221
|
| sap.ui.core.CSSSize
|
|
159
222
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
160
223
|
|
|
224
|
+
/**
|
|
225
|
+
* **[DEPRECATED]** The type of feed to be displayed.
|
|
226
|
+
*
|
|
227
|
+
* The available types are in @link sap.collaboration.FeedType.
|
|
228
|
+
*/
|
|
161
229
|
feedType?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
162
230
|
|
|
231
|
+
/**
|
|
232
|
+
* **[DEPRECATED]** The IDs of the group to display in the widget.
|
|
233
|
+
*/
|
|
163
234
|
groupIds?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
164
235
|
|
|
236
|
+
/**
|
|
237
|
+
* **[DEPRECATED]** A JSON object passed to the Feed Dialog Component. Use **businessObject** instead.
|
|
238
|
+
* This object represents business related information, such as a sales order, an opportunity, etc. It contains
|
|
239
|
+
* the following properties:
|
|
240
|
+
* - id: The Business Object ID to be posted in the SAP Jam Feed. It needs to be an OData URL
|
|
241
|
+
* containing the relative path to the object in the back-end.
|
|
242
|
+
* - type: the type of the business object. It can be any text or it can be the OData meta data
|
|
243
|
+
* URL to the object Entity Type.
|
|
244
|
+
* - name (optional): the description of the business object to be displayed in SAP Jam, i.e.
|
|
245
|
+
* "SO 57746", "Opportunity 123", etc.
|
|
246
|
+
* - ui_url (optional): the URL to navigate to the same business object in the application.
|
|
247
|
+
* Note: The object is passed by reference, which means that the attributes will be modified in the original
|
|
248
|
+
* object, for example, when the URLs contained in the id and type attributes are mapped (via OData call).
|
|
249
|
+
*/
|
|
165
250
|
object?: object | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
166
251
|
|
|
252
|
+
/**
|
|
253
|
+
* A JSON object passed to the Feed Dialog Component. This object represents business related information,
|
|
254
|
+
* such as a sales order, an opportunity, etc. It contains the following properties:
|
|
255
|
+
* - {string} appContext: The application context. Example: "CRM", "CB", "SD", etc.
|
|
256
|
+
* - {string} odataServicePath: The path to the OData Service and the Service name. Example:
|
|
257
|
+
* "/sap/opu/odata/sap/APPLICATION_SRV".
|
|
258
|
+
* - {string} collection: The name of the OData Collection. Example: "Account", "Opportunity",
|
|
259
|
+
* etc.
|
|
260
|
+
* - {string} key: The key to identify a particular instance of the Business Object. It can be
|
|
261
|
+
* a simple ID or a compound key. Example: "123", "ObjectID='123'", "ObjectID='123',ObjectType='BUS000123'",
|
|
262
|
+
* etc.
|
|
263
|
+
* - {string} name: The short name of the Business Object. Example: "Sales Order 123", "Opportunity
|
|
264
|
+
* 123", "Account 123", etc.
|
|
265
|
+
* - {string} ui_url: The URL to navigate to the same business object in the application.
|
|
266
|
+
*/
|
|
167
267
|
businessObject?:
|
|
168
268
|
| object
|
|
169
269
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
@@ -192,48 +292,26 @@ declare namespace sap {
|
|
|
192
292
|
*/
|
|
193
293
|
constructor(
|
|
194
294
|
/**
|
|
195
|
-
*
|
|
196
|
-
* such as a sales order, an opportunity, etc. It contains the following properties:
|
|
197
|
-
* - {string} appContext: The application context. Example: "CRM", "CB", "SD", etc.
|
|
198
|
-
* - {string} odataServicePath: The path to the OData Service and the Service name. Example:
|
|
199
|
-
* "/sap/opu/odata/sap/APPLICATION_SRV".
|
|
200
|
-
* - {string} collection: The name of the OData Collection. Example: "Account", "Opportunity",
|
|
201
|
-
* etc.
|
|
202
|
-
* - {string} key: The key to identify a particular instance of the Business Object. It can be
|
|
203
|
-
* a simple ID or a compound key. Example: "123", "ObjectID='123'", "ObjectID='123',ObjectType='BUS000123'",
|
|
204
|
-
* etc.
|
|
205
|
-
* - {string} name: The short name of the Business Object. Example: "Sales Order 123", "Opportunity
|
|
206
|
-
* 123", "Account 123", etc.
|
|
207
|
-
* - {string} ui_url: The URL to navigate to the same business object in the application.
|
|
208
|
-
*/
|
|
209
|
-
businessObject: object,
|
|
210
|
-
/**
|
|
211
|
-
* **[DEPRECATED]** The OData service URL needed for the Feed Dialog Component, the default value is "/sap/opu/odata/sap/SM_INTEGRATION_SRV".
|
|
295
|
+
* initial settings for the new control
|
|
212
296
|
*/
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
297
|
+
mSettings?: sap.collaboration.components.fiori.feed.dialog.$ComponentSettings
|
|
298
|
+
);
|
|
299
|
+
/**
|
|
300
|
+
* Constructor for the Feed Dialog Component.
|
|
301
|
+
*
|
|
302
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
303
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
304
|
+
* of the syntax of the settings object.
|
|
305
|
+
*/
|
|
306
|
+
constructor(
|
|
218
307
|
/**
|
|
219
|
-
*
|
|
308
|
+
* id for the new control, generated automatically if no id is given
|
|
220
309
|
*/
|
|
221
|
-
|
|
310
|
+
sId?: string,
|
|
222
311
|
/**
|
|
223
|
-
*
|
|
224
|
-
* This object represents business related information, such as a sales order, an opportunity, etc. It contains
|
|
225
|
-
* the following properties:
|
|
226
|
-
* - id: The Business Object ID to be posted in the SAP Jam Feed. It needs to be an OData URL
|
|
227
|
-
* containing the relative path to the object in the back-end.
|
|
228
|
-
* - type: the type of the business object. It can be any text or it can be the OData meta data
|
|
229
|
-
* URL to the object Entity Type.
|
|
230
|
-
* - name (optional): the description of the business object to be displayed in SAP Jam, i.e.
|
|
231
|
-
* "SO 57746", "Opportunity 123", etc.
|
|
232
|
-
* - ui_url (optional): the URL to navigate to the same business object in the application.
|
|
233
|
-
* Note: The object is passed by reference, which means that the attributes will be modified in the original
|
|
234
|
-
* object, for example, when the URLs contained in the id and type attributes are mapped (via OData call).
|
|
312
|
+
* initial settings for the new control
|
|
235
313
|
*/
|
|
236
|
-
|
|
314
|
+
mSettings?: sap.collaboration.components.fiori.feed.dialog.$ComponentSettings
|
|
237
315
|
);
|
|
238
316
|
|
|
239
317
|
/**
|
|
@@ -260,37 +338,76 @@ declare namespace sap {
|
|
|
260
338
|
*/
|
|
261
339
|
FNMetaImpl?: Function
|
|
262
340
|
): Function;
|
|
341
|
+
/**
|
|
342
|
+
* Returns a metadata object for class sap.collaboration.components.fiori.feed.dialog.Component.
|
|
343
|
+
*/
|
|
344
|
+
static getMetadata(): sap.ui.core.ComponentMetadata;
|
|
263
345
|
/**
|
|
264
346
|
* Gets current value of property {@link #getBusinessObject businessObject}.
|
|
347
|
+
*
|
|
348
|
+
* A JSON object passed to the Feed Dialog Component. This object represents business related information,
|
|
349
|
+
* such as a sales order, an opportunity, etc. It contains the following properties:
|
|
350
|
+
* - {string} appContext: The application context. Example: "CRM", "CB", "SD", etc.
|
|
351
|
+
* - {string} odataServicePath: The path to the OData Service and the Service name. Example:
|
|
352
|
+
* "/sap/opu/odata/sap/APPLICATION_SRV".
|
|
353
|
+
* - {string} collection: The name of the OData Collection. Example: "Account", "Opportunity",
|
|
354
|
+
* etc.
|
|
355
|
+
* - {string} key: The key to identify a particular instance of the Business Object. It can be
|
|
356
|
+
* a simple ID or a compound key. Example: "123", "ObjectID='123'", "ObjectID='123',ObjectType='BUS000123'",
|
|
357
|
+
* etc.
|
|
358
|
+
* - {string} name: The short name of the Business Object. Example: "Sales Order 123", "Opportunity
|
|
359
|
+
* 123", "Account 123", etc.
|
|
360
|
+
* - {string} ui_url: The URL to navigate to the same business object in the application.
|
|
265
361
|
*/
|
|
266
362
|
getBusinessObject(): object;
|
|
267
363
|
/**
|
|
268
364
|
* Gets current value of property {@link #getFeedType feedType}.
|
|
269
365
|
*
|
|
366
|
+
* **[DEPRECATED]** The type of feed to be displayed.
|
|
367
|
+
*
|
|
368
|
+
* The available types are in @link sap.collaboration.FeedType.
|
|
369
|
+
*
|
|
270
370
|
* Default value is `FeedType.object`.
|
|
271
371
|
*/
|
|
272
372
|
getFeedType(): string;
|
|
273
373
|
/**
|
|
274
374
|
* Gets current value of property {@link #getGroupIds groupIds}.
|
|
375
|
+
*
|
|
376
|
+
* **[DEPRECATED]** The IDs of the group to display in the widget.
|
|
275
377
|
*/
|
|
276
378
|
getGroupIds(): string;
|
|
277
379
|
/**
|
|
278
380
|
* Gets current value of property {@link #getHeight height}.
|
|
279
381
|
*
|
|
382
|
+
* The height of the component.
|
|
383
|
+
*
|
|
384
|
+
* We need to pass a value in pixels, otherwise the dialog won't render correctly
|
|
385
|
+
*
|
|
280
386
|
* Default value is `"605px"`.
|
|
281
387
|
*/
|
|
282
388
|
getHeight(): sap.ui.core.CSSSize;
|
|
283
|
-
/**
|
|
284
|
-
* Returns a metadata object for class sap.collaboration.components.fiori.feed.dialog.Component.
|
|
285
|
-
*/
|
|
286
|
-
static getMetadata(): sap.ui.core.ComponentMetadata;
|
|
287
389
|
/**
|
|
288
390
|
* Gets current value of property {@link #getObject object}.
|
|
391
|
+
*
|
|
392
|
+
* **[DEPRECATED]** A JSON object passed to the Feed Dialog Component. Use **businessObject** instead.
|
|
393
|
+
* This object represents business related information, such as a sales order, an opportunity, etc. It contains
|
|
394
|
+
* the following properties:
|
|
395
|
+
* - id: The Business Object ID to be posted in the SAP Jam Feed. It needs to be an OData URL
|
|
396
|
+
* containing the relative path to the object in the back-end.
|
|
397
|
+
* - type: the type of the business object. It can be any text or it can be the OData meta data
|
|
398
|
+
* URL to the object Entity Type.
|
|
399
|
+
* - name (optional): the description of the business object to be displayed in SAP Jam, i.e.
|
|
400
|
+
* "SO 57746", "Opportunity 123", etc.
|
|
401
|
+
* - ui_url (optional): the URL to navigate to the same business object in the application.
|
|
402
|
+
* Note: The object is passed by reference, which means that the attributes will be modified in the original
|
|
403
|
+
* object, for example, when the URLs contained in the id and type attributes are mapped (via OData call).
|
|
289
404
|
*/
|
|
290
405
|
getObject(): object;
|
|
291
406
|
/**
|
|
292
407
|
* Gets current value of property {@link #getWidth width}.
|
|
293
408
|
*
|
|
409
|
+
* The width of the component.
|
|
410
|
+
*
|
|
294
411
|
* Default value is `"575px"`.
|
|
295
412
|
*/
|
|
296
413
|
getWidth(): sap.ui.core.CSSSize;
|
|
@@ -301,6 +418,20 @@ declare namespace sap {
|
|
|
301
418
|
/**
|
|
302
419
|
* Sets a new value for property {@link #getBusinessObject businessObject}.
|
|
303
420
|
*
|
|
421
|
+
* A JSON object passed to the Feed Dialog Component. This object represents business related information,
|
|
422
|
+
* such as a sales order, an opportunity, etc. It contains the following properties:
|
|
423
|
+
* - {string} appContext: The application context. Example: "CRM", "CB", "SD", etc.
|
|
424
|
+
* - {string} odataServicePath: The path to the OData Service and the Service name. Example:
|
|
425
|
+
* "/sap/opu/odata/sap/APPLICATION_SRV".
|
|
426
|
+
* - {string} collection: The name of the OData Collection. Example: "Account", "Opportunity",
|
|
427
|
+
* etc.
|
|
428
|
+
* - {string} key: The key to identify a particular instance of the Business Object. It can be
|
|
429
|
+
* a simple ID or a compound key. Example: "123", "ObjectID='123'", "ObjectID='123',ObjectType='BUS000123'",
|
|
430
|
+
* etc.
|
|
431
|
+
* - {string} name: The short name of the Business Object. Example: "Sales Order 123", "Opportunity
|
|
432
|
+
* 123", "Account 123", etc.
|
|
433
|
+
* - {string} ui_url: The URL to navigate to the same business object in the application.
|
|
434
|
+
*
|
|
304
435
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
305
436
|
*/
|
|
306
437
|
setBusinessObject(
|
|
@@ -312,6 +443,10 @@ declare namespace sap {
|
|
|
312
443
|
/**
|
|
313
444
|
* Sets a new value for property {@link #getFeedType feedType}.
|
|
314
445
|
*
|
|
446
|
+
* **[DEPRECATED]** The type of feed to be displayed.
|
|
447
|
+
*
|
|
448
|
+
* The available types are in @link sap.collaboration.FeedType.
|
|
449
|
+
*
|
|
315
450
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
316
451
|
*
|
|
317
452
|
* Default value is `FeedType.object`.
|
|
@@ -325,6 +460,8 @@ declare namespace sap {
|
|
|
325
460
|
/**
|
|
326
461
|
* Sets a new value for property {@link #getGroupIds groupIds}.
|
|
327
462
|
*
|
|
463
|
+
* **[DEPRECATED]** The IDs of the group to display in the widget.
|
|
464
|
+
*
|
|
328
465
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
329
466
|
*/
|
|
330
467
|
setGroupIds(
|
|
@@ -336,6 +473,10 @@ declare namespace sap {
|
|
|
336
473
|
/**
|
|
337
474
|
* Sets a new value for property {@link #getHeight height}.
|
|
338
475
|
*
|
|
476
|
+
* The height of the component.
|
|
477
|
+
*
|
|
478
|
+
* We need to pass a value in pixels, otherwise the dialog won't render correctly
|
|
479
|
+
*
|
|
339
480
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
340
481
|
*
|
|
341
482
|
* Default value is `"605px"`.
|
|
@@ -349,6 +490,19 @@ declare namespace sap {
|
|
|
349
490
|
/**
|
|
350
491
|
* Sets a new value for property {@link #getObject object}.
|
|
351
492
|
*
|
|
493
|
+
* **[DEPRECATED]** A JSON object passed to the Feed Dialog Component. Use **businessObject** instead.
|
|
494
|
+
* This object represents business related information, such as a sales order, an opportunity, etc. It contains
|
|
495
|
+
* the following properties:
|
|
496
|
+
* - id: The Business Object ID to be posted in the SAP Jam Feed. It needs to be an OData URL
|
|
497
|
+
* containing the relative path to the object in the back-end.
|
|
498
|
+
* - type: the type of the business object. It can be any text or it can be the OData meta data
|
|
499
|
+
* URL to the object Entity Type.
|
|
500
|
+
* - name (optional): the description of the business object to be displayed in SAP Jam, i.e.
|
|
501
|
+
* "SO 57746", "Opportunity 123", etc.
|
|
502
|
+
* - ui_url (optional): the URL to navigate to the same business object in the application.
|
|
503
|
+
* Note: The object is passed by reference, which means that the attributes will be modified in the original
|
|
504
|
+
* object, for example, when the URLs contained in the id and type attributes are mapped (via OData call).
|
|
505
|
+
*
|
|
352
506
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
353
507
|
*/
|
|
354
508
|
setObject(
|
|
@@ -375,6 +529,8 @@ declare namespace sap {
|
|
|
375
529
|
/**
|
|
376
530
|
* Sets a new value for property {@link #getWidth width}.
|
|
377
531
|
*
|
|
532
|
+
* The width of the component.
|
|
533
|
+
*
|
|
378
534
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
379
535
|
*
|
|
380
536
|
* Default value is `"575px"`.
|
|
@@ -390,22 +546,51 @@ declare namespace sap {
|
|
|
390
546
|
|
|
391
547
|
interface $ComponentSettings
|
|
392
548
|
extends sap.ui.core.$UIComponentSettings {
|
|
549
|
+
/**
|
|
550
|
+
* The width of the component.
|
|
551
|
+
*/
|
|
393
552
|
width?:
|
|
394
553
|
| sap.ui.core.CSSSize
|
|
395
554
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
396
555
|
|
|
556
|
+
/**
|
|
557
|
+
* The height of the component.
|
|
558
|
+
*/
|
|
397
559
|
height?:
|
|
398
560
|
| sap.ui.core.CSSSize
|
|
399
561
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
400
562
|
|
|
563
|
+
/**
|
|
564
|
+
* The OData service URL needed for the Feed Component.
|
|
565
|
+
*/
|
|
401
566
|
oDataServiceUrl?:
|
|
402
567
|
| sap.ui.core.URI
|
|
403
568
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
404
569
|
|
|
570
|
+
/**
|
|
571
|
+
* The type of feed to be displayed. The available types are in @link sap.collaboration.FeedType.
|
|
572
|
+
*/
|
|
405
573
|
feedType?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
406
574
|
|
|
575
|
+
/**
|
|
576
|
+
* A comma separated list of the IDs of the groups to display in the widget.
|
|
577
|
+
*/
|
|
407
578
|
groupIds?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
408
579
|
|
|
580
|
+
/**
|
|
581
|
+
* A JSON object passed to the Feed component.
|
|
582
|
+
*
|
|
583
|
+
* It is required when the value of feedType is sap.collaboration.FeedType.object or sap.collaboration.FeedType.objectGroup.
|
|
584
|
+
* This object represents business related information, such as a sales order, an opportunity, etc. It contains
|
|
585
|
+
* the following properties:
|
|
586
|
+
* - **id**: The Business Object ID to be posted in the SAP Jam Feed. It needs to be an OData
|
|
587
|
+
* URL containing the relative path to the object in the back-end.
|
|
588
|
+
* - **type**: The type of the Business Object. It needs to be the OData meta data URL to the
|
|
589
|
+
* corresponding Entity Collection.
|
|
590
|
+
* - **name?** (optional): The description of the Business Object to be displayed in SAP Jam,
|
|
591
|
+
* i.e. "SO 57746", "Opportunity 123", etc.
|
|
592
|
+
* - **ui_url?** (optional): The URL to navigate to the same Business Object in the application.
|
|
593
|
+
*/
|
|
409
594
|
object?: object | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
410
595
|
}
|
|
411
596
|
|
|
@@ -431,30 +616,9 @@ declare namespace sap {
|
|
|
431
616
|
*/
|
|
432
617
|
constructor(
|
|
433
618
|
/**
|
|
434
|
-
*
|
|
435
|
-
*/
|
|
436
|
-
oDataServiceUrl: sap.ui.core.URI,
|
|
437
|
-
/**
|
|
438
|
-
* The type of feed to be displayed.
|
|
619
|
+
* Initial settings for the new component instance
|
|
439
620
|
*/
|
|
440
|
-
|
|
441
|
-
/**
|
|
442
|
-
* A comma separated list of group IDs.
|
|
443
|
-
*/
|
|
444
|
-
groupIds?: string,
|
|
445
|
-
/**
|
|
446
|
-
* A JSON object passed to the Feed component. It is required when the value of feedType is sap.collaboration.FeedType.object
|
|
447
|
-
* or sap.collaboration.FeedType.objectGroup. This object represents business related information,
|
|
448
|
-
* such as a sales order, an opportunity, etc. It contains the following properties:
|
|
449
|
-
* - **id**: The Business Object ID to be posted in the SAP Jam Feed. It needs to be an OData
|
|
450
|
-
* URL containing the relative path to the object in the back-end.
|
|
451
|
-
* - **type**: The type of the Business Object. It needs to be the OData meta data URL to the
|
|
452
|
-
* corresponding Entity Collection.
|
|
453
|
-
* - **name?** (optional): The description of the Business Object to be displayed in SAP Jam,
|
|
454
|
-
* i.e. "SO 57746", "Opportunity 123", etc.
|
|
455
|
-
* - **ui_url?** (optional): The URL to navigate to the same Business Object in the application.
|
|
456
|
-
*/
|
|
457
|
-
object?: object
|
|
621
|
+
mSettings?: sap.collaboration.components.fiori.feed.$ComponentSettings
|
|
458
622
|
);
|
|
459
623
|
/**
|
|
460
624
|
* Constructor for the Feed Component.
|
|
@@ -465,26 +629,13 @@ declare namespace sap {
|
|
|
465
629
|
*/
|
|
466
630
|
constructor(
|
|
467
631
|
/**
|
|
468
|
-
*
|
|
632
|
+
* ID for the new component
|
|
469
633
|
*/
|
|
470
|
-
|
|
634
|
+
sId?: string,
|
|
471
635
|
/**
|
|
472
|
-
*
|
|
636
|
+
* Initial settings for the new component instance
|
|
473
637
|
*/
|
|
474
|
-
|
|
475
|
-
/**
|
|
476
|
-
* A JSON object passed to the Feed component. It is required when the value of feedType is sap.collaboration.FeedType.object
|
|
477
|
-
* or sap.collaboration.FeedType.objectGroup. This object represents business related information,
|
|
478
|
-
* such as a sales order, an opportunity, etc. It contains the following properties:
|
|
479
|
-
* - **id**: The Business Object ID to be posted in the SAP Jam Feed. It needs to be an OData
|
|
480
|
-
* URL containing the relative path to the object in the back-end.
|
|
481
|
-
* - **type**: The type of the Business Object. It needs to be the OData meta data URL to the
|
|
482
|
-
* corresponding Entity Collection.
|
|
483
|
-
* - **name?** (optional): The description of the Business Object to be displayed in SAP Jam,
|
|
484
|
-
* i.e. "SO 57746", "Opportunity 123", etc.
|
|
485
|
-
* - **ui_url?** (optional): The URL to navigate to the same Business Object in the application.
|
|
486
|
-
*/
|
|
487
|
-
object?: object
|
|
638
|
+
mSettings?: sap.collaboration.components.fiori.feed.$ComponentSettings
|
|
488
639
|
);
|
|
489
640
|
|
|
490
641
|
/**
|
|
@@ -511,43 +662,68 @@ declare namespace sap {
|
|
|
511
662
|
*/
|
|
512
663
|
FNMetaImpl?: Function
|
|
513
664
|
): Function;
|
|
665
|
+
/**
|
|
666
|
+
* Returns a metadata object for class sap.collaboration.components.fiori.feed.Component.
|
|
667
|
+
*/
|
|
668
|
+
static getMetadata(): sap.ui.core.ComponentMetadata;
|
|
514
669
|
/**
|
|
515
670
|
* Gets current value of property {@link #getFeedType feedType}.
|
|
671
|
+
*
|
|
672
|
+
* The type of feed to be displayed. The available types are in @link sap.collaboration.FeedType.
|
|
516
673
|
*/
|
|
517
674
|
getFeedType(): string;
|
|
518
675
|
/**
|
|
519
676
|
* Gets current value of property {@link #getGroupIds groupIds}.
|
|
677
|
+
*
|
|
678
|
+
* A comma separated list of the IDs of the groups to display in the widget.
|
|
520
679
|
*/
|
|
521
680
|
getGroupIds(): string;
|
|
522
681
|
/**
|
|
523
682
|
* Gets current value of property {@link #getHeight height}.
|
|
524
683
|
*
|
|
684
|
+
* The height of the component.
|
|
685
|
+
*
|
|
525
686
|
* Default value is `empty string`.
|
|
526
687
|
*/
|
|
527
688
|
getHeight(): sap.ui.core.CSSSize;
|
|
528
|
-
/**
|
|
529
|
-
* Returns a metadata object for class sap.collaboration.components.fiori.feed.Component.
|
|
530
|
-
*/
|
|
531
|
-
static getMetadata(): sap.ui.core.ComponentMetadata;
|
|
532
689
|
/**
|
|
533
690
|
* Gets current value of property {@link #getObject object}.
|
|
691
|
+
*
|
|
692
|
+
* A JSON object passed to the Feed component.
|
|
693
|
+
*
|
|
694
|
+
* It is required when the value of feedType is sap.collaboration.FeedType.object or sap.collaboration.FeedType.objectGroup.
|
|
695
|
+
* This object represents business related information, such as a sales order, an opportunity, etc. It contains
|
|
696
|
+
* the following properties:
|
|
697
|
+
* - **id**: The Business Object ID to be posted in the SAP Jam Feed. It needs to be an OData
|
|
698
|
+
* URL containing the relative path to the object in the back-end.
|
|
699
|
+
* - **type**: The type of the Business Object. It needs to be the OData meta data URL to the
|
|
700
|
+
* corresponding Entity Collection.
|
|
701
|
+
* - **name?** (optional): The description of the Business Object to be displayed in SAP Jam,
|
|
702
|
+
* i.e. "SO 57746", "Opportunity 123", etc.
|
|
703
|
+
* - **ui_url?** (optional): The URL to navigate to the same Business Object in the application.
|
|
534
704
|
*/
|
|
535
705
|
getObject(): object;
|
|
536
706
|
/**
|
|
537
707
|
* Gets current value of property {@link #getODataServiceUrl oDataServiceUrl}.
|
|
538
708
|
*
|
|
709
|
+
* The OData service URL needed for the Feed Component.
|
|
710
|
+
*
|
|
539
711
|
* Default value is `"/sap/opu/odata/sap/SM_INTEGRATION_SRV"`.
|
|
540
712
|
*/
|
|
541
713
|
getODataServiceUrl(): sap.ui.core.URI;
|
|
542
714
|
/**
|
|
543
715
|
* Gets current value of property {@link #getWidth width}.
|
|
544
716
|
*
|
|
717
|
+
* The width of the component.
|
|
718
|
+
*
|
|
545
719
|
* Default value is `empty string`.
|
|
546
720
|
*/
|
|
547
721
|
getWidth(): sap.ui.core.CSSSize;
|
|
548
722
|
/**
|
|
549
723
|
* Sets a new value for property {@link #getFeedType feedType}.
|
|
550
724
|
*
|
|
725
|
+
* The type of feed to be displayed. The available types are in @link sap.collaboration.FeedType.
|
|
726
|
+
*
|
|
551
727
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
552
728
|
*/
|
|
553
729
|
setFeedType(
|
|
@@ -559,6 +735,8 @@ declare namespace sap {
|
|
|
559
735
|
/**
|
|
560
736
|
* Sets a new value for property {@link #getGroupIds groupIds}.
|
|
561
737
|
*
|
|
738
|
+
* A comma separated list of the IDs of the groups to display in the widget.
|
|
739
|
+
*
|
|
562
740
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
563
741
|
*/
|
|
564
742
|
setGroupIds(
|
|
@@ -570,6 +748,8 @@ declare namespace sap {
|
|
|
570
748
|
/**
|
|
571
749
|
* Sets a new value for property {@link #getHeight height}.
|
|
572
750
|
*
|
|
751
|
+
* The height of the component.
|
|
752
|
+
*
|
|
573
753
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
574
754
|
*
|
|
575
755
|
* Default value is `empty string`.
|
|
@@ -583,6 +763,20 @@ declare namespace sap {
|
|
|
583
763
|
/**
|
|
584
764
|
* Sets a new value for property {@link #getObject object}.
|
|
585
765
|
*
|
|
766
|
+
* A JSON object passed to the Feed component.
|
|
767
|
+
*
|
|
768
|
+
* It is required when the value of feedType is sap.collaboration.FeedType.object or sap.collaboration.FeedType.objectGroup.
|
|
769
|
+
* This object represents business related information, such as a sales order, an opportunity, etc. It contains
|
|
770
|
+
* the following properties:
|
|
771
|
+
* - **id**: The Business Object ID to be posted in the SAP Jam Feed. It needs to be an OData
|
|
772
|
+
* URL containing the relative path to the object in the back-end.
|
|
773
|
+
* - **type**: The type of the Business Object. It needs to be the OData meta data URL to the
|
|
774
|
+
* corresponding Entity Collection.
|
|
775
|
+
* - **name?** (optional): The description of the Business Object to be displayed in SAP Jam,
|
|
776
|
+
* i.e. "SO 57746", "Opportunity 123", etc.
|
|
777
|
+
* - **ui_url?** (optional): The URL to navigate to the same Business Object in the application.
|
|
778
|
+
*
|
|
779
|
+
*
|
|
586
780
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
587
781
|
*/
|
|
588
782
|
setObject(
|
|
@@ -594,6 +788,8 @@ declare namespace sap {
|
|
|
594
788
|
/**
|
|
595
789
|
* Sets a new value for property {@link #getODataServiceUrl oDataServiceUrl}.
|
|
596
790
|
*
|
|
791
|
+
* The OData service URL needed for the Feed Component.
|
|
792
|
+
*
|
|
597
793
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
598
794
|
*
|
|
599
795
|
* Default value is `"/sap/opu/odata/sap/SM_INTEGRATION_SRV"`.
|
|
@@ -621,6 +817,8 @@ declare namespace sap {
|
|
|
621
817
|
/**
|
|
622
818
|
* Sets a new value for property {@link #getWidth width}.
|
|
623
819
|
*
|
|
820
|
+
* The width of the component.
|
|
821
|
+
*
|
|
624
822
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
625
823
|
*
|
|
626
824
|
* Default value is `empty string`.
|
|
@@ -637,22 +835,37 @@ declare namespace sap {
|
|
|
637
835
|
namespace notification {
|
|
638
836
|
interface $ComponentSettings
|
|
639
837
|
extends sap.ui.core.$UIComponentSettings {
|
|
838
|
+
/**
|
|
839
|
+
* The OData service URL needed for the notification component.
|
|
840
|
+
*/
|
|
640
841
|
oDataServiceUrl?:
|
|
641
842
|
| sap.ui.core.URI
|
|
642
843
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
643
844
|
|
|
845
|
+
/**
|
|
846
|
+
* The maximum number of notifications to be displayed.
|
|
847
|
+
*/
|
|
644
848
|
numberOfNotifications?:
|
|
645
849
|
| int
|
|
646
850
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
647
851
|
|
|
852
|
+
/**
|
|
853
|
+
* The time in seconds a notification is displayed before the next notification is displayed.
|
|
854
|
+
*/
|
|
648
855
|
transitionInterval?:
|
|
649
856
|
| int
|
|
650
857
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
651
858
|
|
|
859
|
+
/**
|
|
860
|
+
* The time in seconds before calling the backend to update the notifications.
|
|
861
|
+
*/
|
|
652
862
|
refreshInterval?:
|
|
653
863
|
| int
|
|
654
864
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
655
865
|
|
|
866
|
+
/**
|
|
867
|
+
* When a user clicks on the component, a new browser tab will open at this URL.
|
|
868
|
+
*/
|
|
656
869
|
notificationsTargetUrl?:
|
|
657
870
|
| sap.ui.core.URI
|
|
658
871
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
@@ -664,14 +877,14 @@ declare namespace sap {
|
|
|
664
877
|
*
|
|
665
878
|
* Notification Component
|
|
666
879
|
*
|
|
667
|
-
* A Notification Component is a
|
|
880
|
+
* A Notification Component is a UI5 component that displays a SAP Jam member's latest notifications.
|
|
668
881
|
*
|
|
669
882
|
* This component refreshes itself when the number of seconds specified in the refreshInterval
|
|
670
883
|
* parameter elapses. When refreshing, the backend is called to obtain the latest notifications.
|
|
671
884
|
*/
|
|
672
885
|
class Component extends sap.ui.core.UIComponent {
|
|
673
886
|
/**
|
|
674
|
-
* Constructor for the notification component
|
|
887
|
+
* Constructor for the notification component.
|
|
675
888
|
*
|
|
676
889
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
677
890
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -679,30 +892,12 @@ declare namespace sap {
|
|
|
679
892
|
*/
|
|
680
893
|
constructor(
|
|
681
894
|
/**
|
|
682
|
-
*
|
|
683
|
-
*/
|
|
684
|
-
oDataServiceUrl: sap.ui.core.URI,
|
|
685
|
-
/**
|
|
686
|
-
* This is the maximum number of notifications to be displayed. The default value is 10.
|
|
687
|
-
*/
|
|
688
|
-
numberOfNotifications: int,
|
|
689
|
-
/**
|
|
690
|
-
* This is the amount of time in seconds a notification is displayed before the next notification is displayed.
|
|
691
|
-
* The default value is 10.
|
|
692
|
-
*/
|
|
693
|
-
transitionInterval: int,
|
|
694
|
-
/**
|
|
695
|
-
* This is the amount of time in seconds before calling the backend to update the notifications. The default
|
|
696
|
-
* value is 300.
|
|
697
|
-
*/
|
|
698
|
-
refreshInterval: int,
|
|
699
|
-
/**
|
|
700
|
-
* When a user clicks on the component, a new browser tab will open at this URL.
|
|
895
|
+
* Initial settings for the new component instance
|
|
701
896
|
*/
|
|
702
|
-
|
|
897
|
+
mSettings?: sap.collaboration.components.fiori.notification.$ComponentSettings
|
|
703
898
|
);
|
|
704
899
|
/**
|
|
705
|
-
* Constructor for the notification component
|
|
900
|
+
* Constructor for the notification component.
|
|
706
901
|
*
|
|
707
902
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
708
903
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
@@ -710,340 +905,36 @@ declare namespace sap {
|
|
|
710
905
|
*/
|
|
711
906
|
constructor(
|
|
712
907
|
/**
|
|
713
|
-
*
|
|
714
|
-
*/
|
|
715
|
-
oDataServiceUrl: sap.ui.core.URI,
|
|
716
|
-
/**
|
|
717
|
-
* This is the maximum number of notifications to be displayed. The default value is 10.
|
|
718
|
-
*/
|
|
719
|
-
numberOfNotifications: int,
|
|
720
|
-
/**
|
|
721
|
-
* This is the amount of time in seconds a notification is displayed before the next notification is displayed.
|
|
722
|
-
* The default value is 10.
|
|
908
|
+
* ID for the new component
|
|
723
909
|
*/
|
|
724
|
-
|
|
910
|
+
sId?: string,
|
|
725
911
|
/**
|
|
726
|
-
*
|
|
912
|
+
* Initial settings for the new component instance
|
|
727
913
|
*/
|
|
728
|
-
|
|
914
|
+
mSettings?: sap.collaboration.components.fiori.notification.$ComponentSettings
|
|
729
915
|
);
|
|
916
|
+
|
|
730
917
|
/**
|
|
731
|
-
*
|
|
918
|
+
* Creates a new subclass of class sap.collaboration.components.fiori.notification.Component with name `sClassName`
|
|
919
|
+
* and enriches it with the information contained in `oClassInfo`.
|
|
732
920
|
*
|
|
733
|
-
*
|
|
734
|
-
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
735
|
-
* of the syntax of the settings object.
|
|
921
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.UIComponent.extend}.
|
|
736
922
|
*/
|
|
737
|
-
|
|
738
|
-
/**
|
|
739
|
-
* The OData service URL needed for the notification component, the default value is "/sap/opu/odata/sap/SM_INTEGRATION_SRV"
|
|
740
|
-
*/
|
|
741
|
-
oDataServiceUrl: sap.ui.core.URI,
|
|
923
|
+
static extend<T extends Record<string, unknown>>(
|
|
742
924
|
/**
|
|
743
|
-
*
|
|
925
|
+
* Name of the class being created
|
|
744
926
|
*/
|
|
745
|
-
|
|
927
|
+
sClassName: string,
|
|
746
928
|
/**
|
|
747
|
-
*
|
|
748
|
-
* value is 300.
|
|
929
|
+
* Object literal with information about the class
|
|
749
930
|
*/
|
|
750
|
-
|
|
931
|
+
oClassInfo?: sap.ClassInfo<
|
|
932
|
+
T,
|
|
933
|
+
sap.collaboration.components.fiori.notification.Component
|
|
934
|
+
>,
|
|
751
935
|
/**
|
|
752
|
-
*
|
|
753
|
-
|
|
754
|
-
notificationsTargetUrl: sap.ui.core.URI
|
|
755
|
-
);
|
|
756
|
-
/**
|
|
757
|
-
* Constructor for the notification component
|
|
758
|
-
*
|
|
759
|
-
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
760
|
-
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
761
|
-
* of the syntax of the settings object.
|
|
762
|
-
*/
|
|
763
|
-
constructor(
|
|
764
|
-
/**
|
|
765
|
-
* The OData service URL needed for the notification component, the default value is "/sap/opu/odata/sap/SM_INTEGRATION_SRV"
|
|
766
|
-
*/
|
|
767
|
-
oDataServiceUrl: sap.ui.core.URI,
|
|
768
|
-
/**
|
|
769
|
-
* This is the amount of time in seconds a notification is displayed before the next notification is displayed.
|
|
770
|
-
* The default value is 10.
|
|
771
|
-
*/
|
|
772
|
-
transitionInterval: int,
|
|
773
|
-
/**
|
|
774
|
-
* This is the amount of time in seconds before calling the backend to update the notifications. The default
|
|
775
|
-
* value is 300.
|
|
776
|
-
*/
|
|
777
|
-
refreshInterval: int,
|
|
778
|
-
/**
|
|
779
|
-
* When a user clicks on the component, a new browser tab will open at this URL.
|
|
780
|
-
*/
|
|
781
|
-
notificationsTargetUrl: sap.ui.core.URI
|
|
782
|
-
);
|
|
783
|
-
/**
|
|
784
|
-
* Constructor for the notification component
|
|
785
|
-
*
|
|
786
|
-
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
787
|
-
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
788
|
-
* of the syntax of the settings object.
|
|
789
|
-
*/
|
|
790
|
-
constructor(
|
|
791
|
-
/**
|
|
792
|
-
* This is the maximum number of notifications to be displayed. The default value is 10.
|
|
793
|
-
*/
|
|
794
|
-
numberOfNotifications: int,
|
|
795
|
-
/**
|
|
796
|
-
* This is the amount of time in seconds a notification is displayed before the next notification is displayed.
|
|
797
|
-
* The default value is 10.
|
|
798
|
-
*/
|
|
799
|
-
transitionInterval: int,
|
|
800
|
-
/**
|
|
801
|
-
* This is the amount of time in seconds before calling the backend to update the notifications. The default
|
|
802
|
-
* value is 300.
|
|
803
|
-
*/
|
|
804
|
-
refreshInterval: int,
|
|
805
|
-
/**
|
|
806
|
-
* When a user clicks on the component, a new browser tab will open at this URL.
|
|
807
|
-
*/
|
|
808
|
-
notificationsTargetUrl: sap.ui.core.URI
|
|
809
|
-
);
|
|
810
|
-
/**
|
|
811
|
-
* Constructor for the notification component
|
|
812
|
-
*
|
|
813
|
-
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
814
|
-
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
815
|
-
* of the syntax of the settings object.
|
|
816
|
-
*/
|
|
817
|
-
constructor(
|
|
818
|
-
/**
|
|
819
|
-
* The OData service URL needed for the notification component, the default value is "/sap/opu/odata/sap/SM_INTEGRATION_SRV"
|
|
820
|
-
*/
|
|
821
|
-
oDataServiceUrl: sap.ui.core.URI,
|
|
822
|
-
/**
|
|
823
|
-
* This is the maximum number of notifications to be displayed. The default value is 10.
|
|
824
|
-
*/
|
|
825
|
-
numberOfNotifications: int,
|
|
826
|
-
/**
|
|
827
|
-
* When a user clicks on the component, a new browser tab will open at this URL.
|
|
828
|
-
*/
|
|
829
|
-
notificationsTargetUrl: sap.ui.core.URI
|
|
830
|
-
);
|
|
831
|
-
/**
|
|
832
|
-
* Constructor for the notification component
|
|
833
|
-
*
|
|
834
|
-
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
835
|
-
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
836
|
-
* of the syntax of the settings object.
|
|
837
|
-
*/
|
|
838
|
-
constructor(
|
|
839
|
-
/**
|
|
840
|
-
* The OData service URL needed for the notification component, the default value is "/sap/opu/odata/sap/SM_INTEGRATION_SRV"
|
|
841
|
-
*/
|
|
842
|
-
oDataServiceUrl: sap.ui.core.URI,
|
|
843
|
-
/**
|
|
844
|
-
* This is the amount of time in seconds a notification is displayed before the next notification is displayed.
|
|
845
|
-
* The default value is 10.
|
|
846
|
-
*/
|
|
847
|
-
transitionInterval: int,
|
|
848
|
-
/**
|
|
849
|
-
* When a user clicks on the component, a new browser tab will open at this URL.
|
|
850
|
-
*/
|
|
851
|
-
notificationsTargetUrl: sap.ui.core.URI
|
|
852
|
-
);
|
|
853
|
-
/**
|
|
854
|
-
* Constructor for the notification component
|
|
855
|
-
*
|
|
856
|
-
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
857
|
-
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
858
|
-
* of the syntax of the settings object.
|
|
859
|
-
*/
|
|
860
|
-
constructor(
|
|
861
|
-
/**
|
|
862
|
-
* This is the maximum number of notifications to be displayed. The default value is 10.
|
|
863
|
-
*/
|
|
864
|
-
numberOfNotifications: int,
|
|
865
|
-
/**
|
|
866
|
-
* This is the amount of time in seconds a notification is displayed before the next notification is displayed.
|
|
867
|
-
* The default value is 10.
|
|
868
|
-
*/
|
|
869
|
-
transitionInterval: int,
|
|
870
|
-
/**
|
|
871
|
-
* When a user clicks on the component, a new browser tab will open at this URL.
|
|
872
|
-
*/
|
|
873
|
-
notificationsTargetUrl: sap.ui.core.URI
|
|
874
|
-
);
|
|
875
|
-
/**
|
|
876
|
-
* Constructor for the notification component
|
|
877
|
-
*
|
|
878
|
-
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
879
|
-
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
880
|
-
* of the syntax of the settings object.
|
|
881
|
-
*/
|
|
882
|
-
constructor(
|
|
883
|
-
/**
|
|
884
|
-
* The OData service URL needed for the notification component, the default value is "/sap/opu/odata/sap/SM_INTEGRATION_SRV"
|
|
885
|
-
*/
|
|
886
|
-
oDataServiceUrl: sap.ui.core.URI,
|
|
887
|
-
/**
|
|
888
|
-
* This is the amount of time in seconds before calling the backend to update the notifications. The default
|
|
889
|
-
* value is 300.
|
|
890
|
-
*/
|
|
891
|
-
refreshInterval: int,
|
|
892
|
-
/**
|
|
893
|
-
* When a user clicks on the component, a new browser tab will open at this URL.
|
|
894
|
-
*/
|
|
895
|
-
notificationsTargetUrl: sap.ui.core.URI
|
|
896
|
-
);
|
|
897
|
-
/**
|
|
898
|
-
* Constructor for the notification component
|
|
899
|
-
*
|
|
900
|
-
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
901
|
-
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
902
|
-
* of the syntax of the settings object.
|
|
903
|
-
*/
|
|
904
|
-
constructor(
|
|
905
|
-
/**
|
|
906
|
-
* This is the maximum number of notifications to be displayed. The default value is 10.
|
|
907
|
-
*/
|
|
908
|
-
numberOfNotifications: int,
|
|
909
|
-
/**
|
|
910
|
-
* This is the amount of time in seconds before calling the backend to update the notifications. The default
|
|
911
|
-
* value is 300.
|
|
912
|
-
*/
|
|
913
|
-
refreshInterval: int,
|
|
914
|
-
/**
|
|
915
|
-
* When a user clicks on the component, a new browser tab will open at this URL.
|
|
916
|
-
*/
|
|
917
|
-
notificationsTargetUrl: sap.ui.core.URI
|
|
918
|
-
);
|
|
919
|
-
/**
|
|
920
|
-
* Constructor for the notification component
|
|
921
|
-
*
|
|
922
|
-
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
923
|
-
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
924
|
-
* of the syntax of the settings object.
|
|
925
|
-
*/
|
|
926
|
-
constructor(
|
|
927
|
-
/**
|
|
928
|
-
* This is the amount of time in seconds a notification is displayed before the next notification is displayed.
|
|
929
|
-
* The default value is 10.
|
|
930
|
-
*/
|
|
931
|
-
transitionInterval: int,
|
|
932
|
-
/**
|
|
933
|
-
* This is the amount of time in seconds before calling the backend to update the notifications. The default
|
|
934
|
-
* value is 300.
|
|
935
|
-
*/
|
|
936
|
-
refreshInterval: int,
|
|
937
|
-
/**
|
|
938
|
-
* When a user clicks on the component, a new browser tab will open at this URL.
|
|
939
|
-
*/
|
|
940
|
-
notificationsTargetUrl: sap.ui.core.URI
|
|
941
|
-
);
|
|
942
|
-
/**
|
|
943
|
-
* Constructor for the notification component
|
|
944
|
-
*
|
|
945
|
-
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
946
|
-
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
947
|
-
* of the syntax of the settings object.
|
|
948
|
-
*/
|
|
949
|
-
constructor(
|
|
950
|
-
/**
|
|
951
|
-
* The OData service URL needed for the notification component, the default value is "/sap/opu/odata/sap/SM_INTEGRATION_SRV"
|
|
952
|
-
*/
|
|
953
|
-
oDataServiceUrl: sap.ui.core.URI,
|
|
954
|
-
/**
|
|
955
|
-
* When a user clicks on the component, a new browser tab will open at this URL.
|
|
956
|
-
*/
|
|
957
|
-
notificationsTargetUrl: sap.ui.core.URI
|
|
958
|
-
);
|
|
959
|
-
/**
|
|
960
|
-
* Constructor for the notification component
|
|
961
|
-
*
|
|
962
|
-
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
963
|
-
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
964
|
-
* of the syntax of the settings object.
|
|
965
|
-
*/
|
|
966
|
-
constructor(
|
|
967
|
-
/**
|
|
968
|
-
* This is the maximum number of notifications to be displayed. The default value is 10.
|
|
969
|
-
*/
|
|
970
|
-
numberOfNotifications: int,
|
|
971
|
-
/**
|
|
972
|
-
* When a user clicks on the component, a new browser tab will open at this URL.
|
|
973
|
-
*/
|
|
974
|
-
notificationsTargetUrl: sap.ui.core.URI
|
|
975
|
-
);
|
|
976
|
-
/**
|
|
977
|
-
* Constructor for the notification component
|
|
978
|
-
*
|
|
979
|
-
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
980
|
-
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
981
|
-
* of the syntax of the settings object.
|
|
982
|
-
*/
|
|
983
|
-
constructor(
|
|
984
|
-
/**
|
|
985
|
-
* This is the amount of time in seconds a notification is displayed before the next notification is displayed.
|
|
986
|
-
* The default value is 10.
|
|
987
|
-
*/
|
|
988
|
-
transitionInterval: int,
|
|
989
|
-
/**
|
|
990
|
-
* When a user clicks on the component, a new browser tab will open at this URL.
|
|
991
|
-
*/
|
|
992
|
-
notificationsTargetUrl: sap.ui.core.URI
|
|
993
|
-
);
|
|
994
|
-
/**
|
|
995
|
-
* Constructor for the notification component
|
|
996
|
-
*
|
|
997
|
-
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
998
|
-
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
999
|
-
* of the syntax of the settings object.
|
|
1000
|
-
*/
|
|
1001
|
-
constructor(
|
|
1002
|
-
/**
|
|
1003
|
-
* This is the amount of time in seconds before calling the backend to update the notifications. The default
|
|
1004
|
-
* value is 300.
|
|
1005
|
-
*/
|
|
1006
|
-
refreshInterval: int,
|
|
1007
|
-
/**
|
|
1008
|
-
* When a user clicks on the component, a new browser tab will open at this URL.
|
|
1009
|
-
*/
|
|
1010
|
-
notificationsTargetUrl: sap.ui.core.URI
|
|
1011
|
-
);
|
|
1012
|
-
/**
|
|
1013
|
-
* Constructor for the notification component
|
|
1014
|
-
*
|
|
1015
|
-
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1016
|
-
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1017
|
-
* of the syntax of the settings object.
|
|
1018
|
-
*/
|
|
1019
|
-
constructor(
|
|
1020
|
-
/**
|
|
1021
|
-
* When a user clicks on the component, a new browser tab will open at this URL.
|
|
1022
|
-
*/
|
|
1023
|
-
notificationsTargetUrl: sap.ui.core.URI
|
|
1024
|
-
);
|
|
1025
|
-
|
|
1026
|
-
/**
|
|
1027
|
-
* Creates a new subclass of class sap.collaboration.components.fiori.notification.Component with name `sClassName`
|
|
1028
|
-
* and enriches it with the information contained in `oClassInfo`.
|
|
1029
|
-
*
|
|
1030
|
-
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.UIComponent.extend}.
|
|
1031
|
-
*/
|
|
1032
|
-
static extend<T extends Record<string, unknown>>(
|
|
1033
|
-
/**
|
|
1034
|
-
* Name of the class being created
|
|
1035
|
-
*/
|
|
1036
|
-
sClassName: string,
|
|
1037
|
-
/**
|
|
1038
|
-
* Object literal with information about the class
|
|
1039
|
-
*/
|
|
1040
|
-
oClassInfo?: sap.ClassInfo<
|
|
1041
|
-
T,
|
|
1042
|
-
sap.collaboration.components.fiori.notification.Component
|
|
1043
|
-
>,
|
|
1044
|
-
/**
|
|
1045
|
-
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
1046
|
-
* used by this class
|
|
936
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
937
|
+
* used by this class
|
|
1047
938
|
*/
|
|
1048
939
|
FNMetaImpl?: Function
|
|
1049
940
|
): Function;
|
|
@@ -1053,35 +944,47 @@ declare namespace sap {
|
|
|
1053
944
|
static getMetadata(): sap.ui.core.ComponentMetadata;
|
|
1054
945
|
/**
|
|
1055
946
|
* Gets current value of property {@link #getNotificationsTargetUrl notificationsTargetUrl}.
|
|
947
|
+
*
|
|
948
|
+
* When a user clicks on the component, a new browser tab will open at this URL.
|
|
1056
949
|
*/
|
|
1057
950
|
getNotificationsTargetUrl(): sap.ui.core.URI;
|
|
1058
951
|
/**
|
|
1059
952
|
* Gets current value of property {@link #getNumberOfNotifications numberOfNotifications}.
|
|
1060
953
|
*
|
|
954
|
+
* The maximum number of notifications to be displayed.
|
|
955
|
+
*
|
|
1061
956
|
* Default value is `10`.
|
|
1062
957
|
*/
|
|
1063
958
|
getNumberOfNotifications(): int;
|
|
1064
959
|
/**
|
|
1065
960
|
* Gets current value of property {@link #getODataServiceUrl oDataServiceUrl}.
|
|
1066
961
|
*
|
|
962
|
+
* The OData service URL needed for the notification component.
|
|
963
|
+
*
|
|
1067
964
|
* Default value is `"/sap/opu/odata/sap/SM_INTEGRATION_SRV"`.
|
|
1068
965
|
*/
|
|
1069
966
|
getODataServiceUrl(): sap.ui.core.URI;
|
|
1070
967
|
/**
|
|
1071
968
|
* Gets current value of property {@link #getRefreshInterval refreshInterval}.
|
|
1072
969
|
*
|
|
970
|
+
* The time in seconds before calling the backend to update the notifications.
|
|
971
|
+
*
|
|
1073
972
|
* Default value is `300`.
|
|
1074
973
|
*/
|
|
1075
974
|
getRefreshInterval(): int;
|
|
1076
975
|
/**
|
|
1077
976
|
* Gets current value of property {@link #getTransitionInterval transitionInterval}.
|
|
1078
977
|
*
|
|
978
|
+
* The time in seconds a notification is displayed before the next notification is displayed.
|
|
979
|
+
*
|
|
1079
980
|
* Default value is `10`.
|
|
1080
981
|
*/
|
|
1081
982
|
getTransitionInterval(): int;
|
|
1082
983
|
/**
|
|
1083
984
|
* Sets a new value for property {@link #getNotificationsTargetUrl notificationsTargetUrl}.
|
|
1084
985
|
*
|
|
986
|
+
* When a user clicks on the component, a new browser tab will open at this URL.
|
|
987
|
+
*
|
|
1085
988
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1086
989
|
*/
|
|
1087
990
|
setNotificationsTargetUrl(
|
|
@@ -1093,6 +996,8 @@ declare namespace sap {
|
|
|
1093
996
|
/**
|
|
1094
997
|
* Sets a new value for property {@link #getNumberOfNotifications numberOfNotifications}.
|
|
1095
998
|
*
|
|
999
|
+
* The maximum number of notifications to be displayed.
|
|
1000
|
+
*
|
|
1096
1001
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1097
1002
|
*
|
|
1098
1003
|
* Default value is `10`.
|
|
@@ -1106,6 +1011,8 @@ declare namespace sap {
|
|
|
1106
1011
|
/**
|
|
1107
1012
|
* Sets a new value for property {@link #getODataServiceUrl oDataServiceUrl}.
|
|
1108
1013
|
*
|
|
1014
|
+
* The OData service URL needed for the notification component.
|
|
1015
|
+
*
|
|
1109
1016
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1110
1017
|
*
|
|
1111
1018
|
* Default value is `"/sap/opu/odata/sap/SM_INTEGRATION_SRV"`.
|
|
@@ -1119,6 +1026,8 @@ declare namespace sap {
|
|
|
1119
1026
|
/**
|
|
1120
1027
|
* Sets a new value for property {@link #getRefreshInterval refreshInterval}.
|
|
1121
1028
|
*
|
|
1029
|
+
* The time in seconds before calling the backend to update the notifications.
|
|
1030
|
+
*
|
|
1122
1031
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1123
1032
|
*
|
|
1124
1033
|
* Default value is `300`.
|
|
@@ -1132,6 +1041,8 @@ declare namespace sap {
|
|
|
1132
1041
|
/**
|
|
1133
1042
|
* Sets a new value for property {@link #getTransitionInterval transitionInterval}.
|
|
1134
1043
|
*
|
|
1044
|
+
* The time in seconds a notification is displayed before the next notification is displayed.
|
|
1045
|
+
*
|
|
1135
1046
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1136
1047
|
*
|
|
1137
1048
|
* Default value is `10`.
|
|
@@ -1206,12 +1117,45 @@ declare namespace sap {
|
|
|
1206
1117
|
namespace dialog {
|
|
1207
1118
|
interface $ComponentSettings
|
|
1208
1119
|
extends sap.ui.core.$UIComponentSettings {
|
|
1120
|
+
/**
|
|
1121
|
+
* When you want to provide the user with the option to share file attachments, then the following properties
|
|
1122
|
+
* need to be specified:
|
|
1123
|
+
* - attachmentsArray: An array of {@link sap.collaboration.components.fiori.sharing.attachment.Attachment}
|
|
1124
|
+
* objects. This array offers users a list of files they can attach.
|
|
1125
|
+
*/
|
|
1209
1126
|
attachments?:
|
|
1210
1127
|
| object
|
|
1211
1128
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1212
1129
|
|
|
1130
|
+
/**
|
|
1131
|
+
* A JSON object passed to the share component. This object contains the following properties:
|
|
1132
|
+
* - id (optional): is the object Id to be shared in SAP Jam, i.e a URL( or a callback function that returns
|
|
1133
|
+
* a URL) that navigates back to the same object in the application
|
|
1134
|
+
* - display (optional): is a UI5 control to be displayed in the component UI
|
|
1135
|
+
* **Note:** The preferred object to pass in the display parameter is `sap.m.ObjectListItem`. Using other
|
|
1136
|
+
* type of objects (for example: `ap.ui.commons.TextView`) may result in problems in the rendering of the
|
|
1137
|
+
* content which needs to be corrected by the application owners.
|
|
1138
|
+
* - share (optional): is a note that will be displayed in the component UI and shared to SAP Jam too
|
|
1139
|
+
*/
|
|
1213
1140
|
object?: object | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1214
1141
|
|
|
1142
|
+
/**
|
|
1143
|
+
* A Business Object such as an Opportunity, Sales Order, Account, etc. from the back-end that will be shared
|
|
1144
|
+
* as a Featured External Object in a Group in Jam.
|
|
1145
|
+
* - {string} appContext: The application context. Example: "CRM", "SD", etc.
|
|
1146
|
+
* - {string} odataServicePath: The relative path to the OData Service. Example: "/sap/opu/odata/sap/ODATA_SRV"
|
|
1147
|
+
*
|
|
1148
|
+
* - {string} collection: The name of the OData Collection. Example: "Account", "Opportunity", etc.
|
|
1149
|
+
* - {string} key: The key to identify a particular instance of the Business Object. It can be a simple
|
|
1150
|
+
* ID or a compound key. Example: "123", "ObjectID='123'", "ObjectID='123',ObjectType='BUS000123'", etc.
|
|
1151
|
+
*
|
|
1152
|
+
* - {string} name: The short name of the Business Object. Example: "Sales Order 123", "Opportunity 123",
|
|
1153
|
+
* "Account 123", etc. These attributes are not enforced by the UI (missing or incorrect values
|
|
1154
|
+
* are not validated), but they are required to make the integration work. These attributes also should
|
|
1155
|
+
* be mapped in the Back-end System and Jam in order to make the External Object work.
|
|
1156
|
+
* **Note:** the externalObject is dependent on object.id, therefore, the object.id must also be passed
|
|
1157
|
+
* to the Share Component. See the parameter "object" for more information.
|
|
1158
|
+
*/
|
|
1215
1159
|
externalObject?:
|
|
1216
1160
|
| object
|
|
1217
1161
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
@@ -1231,45 +1175,28 @@ declare namespace sap {
|
|
|
1231
1175
|
*/
|
|
1232
1176
|
constructor(
|
|
1233
1177
|
/**
|
|
1234
|
-
*
|
|
1235
|
-
|
|
1236
|
-
oDataServiceUrl?: sap.ui.core.URI,
|
|
1237
|
-
/**
|
|
1238
|
-
* A JSON object passed to the share component. This object contains the following properties:
|
|
1239
|
-
* - id (optional): is the object Id to be shared in SAP Jam, i.e a URL( or a callback function that returns
|
|
1240
|
-
* a URL) that navigates back to the same object in the application
|
|
1241
|
-
* - display (optional): is a UI5 control to be displayed in the component UI
|
|
1242
|
-
* **Note:** The preferred object to pass in the display parameter is `sap.m.ObjectListItem`. Using other
|
|
1243
|
-
* type of objects (for example: `ap.ui.commons.TextView`) may result in problems in the rendering of the
|
|
1244
|
-
* content which needs to be corrected by the application owners.
|
|
1245
|
-
* - share (optional): is a note that will be displayed in the component UI and shared to SAP Jam too
|
|
1178
|
+
* initial settings for the new component. See the documentation of the component's properties for the structure
|
|
1179
|
+
* of the expected data.
|
|
1246
1180
|
*/
|
|
1247
|
-
|
|
1181
|
+
mSettings?: sap.collaboration.components.fiori.sharing.dialog.$ComponentSettings
|
|
1182
|
+
);
|
|
1183
|
+
/**
|
|
1184
|
+
* Constructor for the share dialog component
|
|
1185
|
+
*
|
|
1186
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1187
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1188
|
+
* of the syntax of the settings object.
|
|
1189
|
+
*/
|
|
1190
|
+
constructor(
|
|
1248
1191
|
/**
|
|
1249
|
-
*
|
|
1250
|
-
* as a Featured External Object in a Group in Jam.
|
|
1251
|
-
* - {string} appContext: The application context. Example: "CRM", "SD", etc.
|
|
1252
|
-
* - {string} odataServicePath: The relative path to the OData Service. Example: "/sap/opu/odata/sap/ODATA_SRV"
|
|
1253
|
-
*
|
|
1254
|
-
* - {string} collection: The name of the OData Collection. Example: "Account", "Opportunity", etc.
|
|
1255
|
-
* - {string} key: The key to identify a particular instance of the Business Object. It can be a simple
|
|
1256
|
-
* ID or a compound key. Example: "123", "ObjectID='123'", "ObjectID='123',ObjectType='BUS000123'", etc.
|
|
1257
|
-
*
|
|
1258
|
-
* - {string} name: The short name of the Business Object. Example: "Sales Order 123", "Opportunity 123",
|
|
1259
|
-
* "Account 123", etc. These attributes are not enforced by the UI (missing or incorrect values
|
|
1260
|
-
* are not validated), but they are required to make the integration work. These attributes also should
|
|
1261
|
-
* be mapped in the Back-end System and Jam in order to make the External Object work.
|
|
1262
|
-
* **Note:** the externalObject is dependent on object.id, therefore, the object.id must also be passed
|
|
1263
|
-
* to the Share Component. See the parameter "object" for more information.
|
|
1192
|
+
* id for the new component, generated automatically if no id is given
|
|
1264
1193
|
*/
|
|
1265
|
-
|
|
1194
|
+
sId?: sap.ui.core.ID,
|
|
1266
1195
|
/**
|
|
1267
|
-
*
|
|
1268
|
-
*
|
|
1269
|
-
* - attachmentsArray: An array of {@link sap.collaboration.components.fiori.sharing.attachment.Attachment}
|
|
1270
|
-
* objects. This array offers users a list of files they can attach.
|
|
1196
|
+
* initial settings for the new component. See the documentation of the component's properties for the structure
|
|
1197
|
+
* of the expected data.
|
|
1271
1198
|
*/
|
|
1272
|
-
|
|
1199
|
+
mSettings?: sap.collaboration.components.fiori.sharing.dialog.$ComponentSettings
|
|
1273
1200
|
);
|
|
1274
1201
|
|
|
1275
1202
|
/**
|
|
@@ -1296,20 +1223,50 @@ declare namespace sap {
|
|
|
1296
1223
|
*/
|
|
1297
1224
|
FNMetaImpl?: Function
|
|
1298
1225
|
): Function;
|
|
1226
|
+
/**
|
|
1227
|
+
* Returns a metadata object for class sap.collaboration.components.fiori.sharing.dialog.Component.
|
|
1228
|
+
*/
|
|
1229
|
+
static getMetadata(): sap.ui.core.ComponentMetadata;
|
|
1299
1230
|
/**
|
|
1300
1231
|
* Gets current value of property {@link #getAttachments attachments}.
|
|
1232
|
+
*
|
|
1233
|
+
* When you want to provide the user with the option to share file attachments, then the following properties
|
|
1234
|
+
* need to be specified:
|
|
1235
|
+
* - attachmentsArray: An array of {@link sap.collaboration.components.fiori.sharing.attachment.Attachment}
|
|
1236
|
+
* objects. This array offers users a list of files they can attach.
|
|
1301
1237
|
*/
|
|
1302
1238
|
getAttachments(): object;
|
|
1303
1239
|
/**
|
|
1304
1240
|
* Gets current value of property {@link #getExternalObject externalObject}.
|
|
1241
|
+
*
|
|
1242
|
+
* A Business Object such as an Opportunity, Sales Order, Account, etc. from the back-end that will be shared
|
|
1243
|
+
* as a Featured External Object in a Group in Jam.
|
|
1244
|
+
* - {string} appContext: The application context. Example: "CRM", "SD", etc.
|
|
1245
|
+
* - {string} odataServicePath: The relative path to the OData Service. Example: "/sap/opu/odata/sap/ODATA_SRV"
|
|
1246
|
+
*
|
|
1247
|
+
* - {string} collection: The name of the OData Collection. Example: "Account", "Opportunity", etc.
|
|
1248
|
+
* - {string} key: The key to identify a particular instance of the Business Object. It can be a simple
|
|
1249
|
+
* ID or a compound key. Example: "123", "ObjectID='123'", "ObjectID='123',ObjectType='BUS000123'", etc.
|
|
1250
|
+
*
|
|
1251
|
+
* - {string} name: The short name of the Business Object. Example: "Sales Order 123", "Opportunity 123",
|
|
1252
|
+
* "Account 123", etc. These attributes are not enforced by the UI (missing or incorrect values
|
|
1253
|
+
* are not validated), but they are required to make the integration work. These attributes also should
|
|
1254
|
+
* be mapped in the Back-end System and Jam in order to make the External Object work.
|
|
1255
|
+
* **Note:** the externalObject is dependent on object.id, therefore, the object.id must also be passed
|
|
1256
|
+
* to the Share Component. See the parameter "object" for more information.
|
|
1305
1257
|
*/
|
|
1306
1258
|
getExternalObject(): object;
|
|
1307
|
-
/**
|
|
1308
|
-
* Returns a metadata object for class sap.collaboration.components.fiori.sharing.dialog.Component.
|
|
1309
|
-
*/
|
|
1310
|
-
static getMetadata(): sap.ui.core.ComponentMetadata;
|
|
1311
1259
|
/**
|
|
1312
1260
|
* Gets current value of property {@link #getObject object}.
|
|
1261
|
+
*
|
|
1262
|
+
* A JSON object passed to the share component. This object contains the following properties:
|
|
1263
|
+
* - id (optional): is the object Id to be shared in SAP Jam, i.e a URL( or a callback function that returns
|
|
1264
|
+
* a URL) that navigates back to the same object in the application
|
|
1265
|
+
* - display (optional): is a UI5 control to be displayed in the component UI
|
|
1266
|
+
* **Note:** The preferred object to pass in the display parameter is `sap.m.ObjectListItem`. Using other
|
|
1267
|
+
* type of objects (for example: `ap.ui.commons.TextView`) may result in problems in the rendering of the
|
|
1268
|
+
* content which needs to be corrected by the application owners.
|
|
1269
|
+
* - share (optional): is a note that will be displayed in the component UI and shared to SAP Jam too
|
|
1313
1270
|
*/
|
|
1314
1271
|
getObject(): object;
|
|
1315
1272
|
/**
|
|
@@ -1319,6 +1276,11 @@ declare namespace sap {
|
|
|
1319
1276
|
/**
|
|
1320
1277
|
* Sets a new value for property {@link #getAttachments attachments}.
|
|
1321
1278
|
*
|
|
1279
|
+
* When you want to provide the user with the option to share file attachments, then the following properties
|
|
1280
|
+
* need to be specified:
|
|
1281
|
+
* - attachmentsArray: An array of {@link sap.collaboration.components.fiori.sharing.attachment.Attachment}
|
|
1282
|
+
* objects. This array offers users a list of files they can attach.
|
|
1283
|
+
*
|
|
1322
1284
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1323
1285
|
*/
|
|
1324
1286
|
setAttachments(
|
|
@@ -1330,6 +1292,22 @@ declare namespace sap {
|
|
|
1330
1292
|
/**
|
|
1331
1293
|
* Sets a new value for property {@link #getExternalObject externalObject}.
|
|
1332
1294
|
*
|
|
1295
|
+
* A Business Object such as an Opportunity, Sales Order, Account, etc. from the back-end that will be shared
|
|
1296
|
+
* as a Featured External Object in a Group in Jam.
|
|
1297
|
+
* - {string} appContext: The application context. Example: "CRM", "SD", etc.
|
|
1298
|
+
* - {string} odataServicePath: The relative path to the OData Service. Example: "/sap/opu/odata/sap/ODATA_SRV"
|
|
1299
|
+
*
|
|
1300
|
+
* - {string} collection: The name of the OData Collection. Example: "Account", "Opportunity", etc.
|
|
1301
|
+
* - {string} key: The key to identify a particular instance of the Business Object. It can be a simple
|
|
1302
|
+
* ID or a compound key. Example: "123", "ObjectID='123'", "ObjectID='123',ObjectType='BUS000123'", etc.
|
|
1303
|
+
*
|
|
1304
|
+
* - {string} name: The short name of the Business Object. Example: "Sales Order 123", "Opportunity 123",
|
|
1305
|
+
* "Account 123", etc. These attributes are not enforced by the UI (missing or incorrect values
|
|
1306
|
+
* are not validated), but they are required to make the integration work. These attributes also should
|
|
1307
|
+
* be mapped in the Back-end System and Jam in order to make the External Object work.
|
|
1308
|
+
* **Note:** the externalObject is dependent on object.id, therefore, the object.id must also be passed
|
|
1309
|
+
* to the Share Component. See the parameter "object" for more information.
|
|
1310
|
+
*
|
|
1333
1311
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1334
1312
|
*/
|
|
1335
1313
|
setExternalObject(
|
|
@@ -1341,6 +1319,16 @@ declare namespace sap {
|
|
|
1341
1319
|
/**
|
|
1342
1320
|
* Sets a new value for property {@link #getObject object}.
|
|
1343
1321
|
*
|
|
1322
|
+
* A JSON object passed to the share component. This object contains the following properties:
|
|
1323
|
+
* - id (optional): is the object Id to be shared in SAP Jam, i.e a URL( or a callback function that returns
|
|
1324
|
+
* a URL) that navigates back to the same object in the application
|
|
1325
|
+
* - display (optional): is a UI5 control to be displayed in the component UI
|
|
1326
|
+
* **Note:** The preferred object to pass in the display parameter is `sap.m.ObjectListItem`. Using other
|
|
1327
|
+
* type of objects (for example: `ap.ui.commons.TextView`) may result in problems in the rendering of the
|
|
1328
|
+
* content which needs to be corrected by the application owners.
|
|
1329
|
+
* - share (optional): is a note that will be displayed in the component UI and shared to SAP Jam too
|
|
1330
|
+
*
|
|
1331
|
+
*
|
|
1344
1332
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1345
1333
|
*/
|
|
1346
1334
|
setObject(
|
|
@@ -1372,6 +1360,9 @@ declare namespace sap {
|
|
|
1372
1360
|
| sap.ui.core.CSSSize
|
|
1373
1361
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1374
1362
|
|
|
1363
|
+
/**
|
|
1364
|
+
* The OData service URL needed for the share component.
|
|
1365
|
+
*/
|
|
1375
1366
|
oDataServiceUrl?:
|
|
1376
1367
|
| sap.ui.core.URI
|
|
1377
1368
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
@@ -1384,12 +1375,36 @@ declare namespace sap {
|
|
|
1384
1375
|
| sap.ui.core.URI
|
|
1385
1376
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1386
1377
|
|
|
1378
|
+
/**
|
|
1379
|
+
* A JSON object passed to the share component. This object contains the following properties:
|
|
1380
|
+
* - id (optional): is the object Id to be shared in SAP Jam, i.e a URL that navigates back to the same
|
|
1381
|
+
* object in the application
|
|
1382
|
+
* - display (optional): is a UI5 control to be displayed in the component UI
|
|
1383
|
+
* - share (optional): is a note that will be displayed in the component UI and shared to SAP Jam too
|
|
1384
|
+
*/
|
|
1387
1385
|
object?: object | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1388
1386
|
|
|
1389
1387
|
attachments?:
|
|
1390
1388
|
| object
|
|
1391
1389
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1392
1390
|
|
|
1391
|
+
/**
|
|
1392
|
+
* A Business Object such as an Opportunity, Sales Order, Account, etc. from the back-end that will be shared
|
|
1393
|
+
* as a Featured External Object in a Group in Jam.
|
|
1394
|
+
* - {string} appContext: The application context. Example: "CRM", "SD", etc.
|
|
1395
|
+
* - {string} odataServicePath: The relative path to the OData Service. Example: "/sap/opu/odata/sap/ODATA_SRV"
|
|
1396
|
+
*
|
|
1397
|
+
* - {string} collection: The name of the OData Collection. Example: "Account", "Opportunity", etc.
|
|
1398
|
+
* - {string} key: The key to identify a particular instance of the Business Object. It can be a simple
|
|
1399
|
+
* ID or a compound key. Example: "123", "ObjectID='123'", "ObjectID='123',ObjectType='BUS000123'", etc.
|
|
1400
|
+
*
|
|
1401
|
+
* - {string} name: The short name of the Business Object. Example: "Sales Order 123", "Opportunity 123",
|
|
1402
|
+
* "Account 123", etc. These attributes are not enforced by the UI (missing or incorrect values
|
|
1403
|
+
* are not validated), but they are required to make the integration work. These attributes also should
|
|
1404
|
+
* be mapped in the Back-end System and Jam in order to make the External Object work.
|
|
1405
|
+
* **Note:** the externalObject is dependent on object.id, therefore, the object.id must also be passed
|
|
1406
|
+
* to the Share Component. See the parameter "object" for more information.
|
|
1407
|
+
*/
|
|
1393
1408
|
externalObject?:
|
|
1394
1409
|
| object
|
|
1395
1410
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
@@ -1412,42 +1427,26 @@ declare namespace sap {
|
|
|
1412
1427
|
*/
|
|
1413
1428
|
constructor(
|
|
1414
1429
|
/**
|
|
1415
|
-
*
|
|
1416
|
-
*/
|
|
1417
|
-
oDataServiceUrl?: sap.ui.core.URI,
|
|
1418
|
-
/**
|
|
1419
|
-
* A JSON object passed to the share component. This object contains the following properties:
|
|
1420
|
-
* - id (optional): is the object Id to be shared in SAP Jam, i.e a URL that navigates back to the same
|
|
1421
|
-
* object in the application
|
|
1422
|
-
* - display (optional): is a UI5 control to be displayed in the component UI
|
|
1423
|
-
* - share (optional): is a note that will be displayed in the component UI and shared to SAP Jam too
|
|
1430
|
+
* initial settings for the new control
|
|
1424
1431
|
*/
|
|
1425
|
-
|
|
1432
|
+
mSettings?: sap.collaboration.components.fiori.sharing.$ComponentSettings
|
|
1433
|
+
);
|
|
1434
|
+
/**
|
|
1435
|
+
* Constructor for the share component
|
|
1436
|
+
*
|
|
1437
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1438
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1439
|
+
* of the syntax of the settings object.
|
|
1440
|
+
*/
|
|
1441
|
+
constructor(
|
|
1426
1442
|
/**
|
|
1427
|
-
*
|
|
1428
|
-
* as a Featured External Object in a Group in Jam.
|
|
1429
|
-
* - {string} appContext: The application context. Example: "CRM", "SD", etc.
|
|
1430
|
-
* - {string} odataServicePath: The relative path to the OData Service. Example: "/sap/opu/odata/sap/ODATA_SRV"
|
|
1431
|
-
*
|
|
1432
|
-
* - {string} collection: The name of the OData Collection. Example: "Account", "Opportunity", etc.
|
|
1433
|
-
* - {string} key: The key to identify a particular instance of the Business Object. It can be a simple
|
|
1434
|
-
* ID or a compound key. Example: "123", "ObjectID='123'", "ObjectID='123',ObjectType='BUS000123'", etc.
|
|
1435
|
-
*
|
|
1436
|
-
* - {string} name: The short name of the Business Object. Example: "Sales Order 123", "Opportunity 123",
|
|
1437
|
-
* "Account 123", etc. These attributes are not enforced by the UI (missing or incorrect values
|
|
1438
|
-
* are not validated), but they are required to make the integration work. These attributes also should
|
|
1439
|
-
* be mapped in the Back-end System and Jam in order to make the External Object work.
|
|
1440
|
-
* **Note:** the externalObject is dependent on object.id, therefore, the object.id must also be passed
|
|
1441
|
-
* to the Share Component. See the parameter "object" for more information.
|
|
1443
|
+
* id for the new control, generated automatically if no id is given
|
|
1442
1444
|
*/
|
|
1443
|
-
|
|
1445
|
+
sId?: string,
|
|
1444
1446
|
/**
|
|
1445
|
-
*
|
|
1446
|
-
* need to be specified:
|
|
1447
|
-
* - attachmentsArray: An array of {@link sap.collaboration.components.fiori.sharing.attachment.Attachment}
|
|
1448
|
-
* objects. This array offers users a list of files they can attach.
|
|
1447
|
+
* initial settings for the new control
|
|
1449
1448
|
*/
|
|
1450
|
-
|
|
1449
|
+
mSettings?: sap.collaboration.components.fiori.sharing.$ComponentSettings
|
|
1451
1450
|
);
|
|
1452
1451
|
|
|
1453
1452
|
/**
|
|
@@ -1474,6 +1473,10 @@ declare namespace sap {
|
|
|
1474
1473
|
*/
|
|
1475
1474
|
FNMetaImpl?: Function
|
|
1476
1475
|
): Function;
|
|
1476
|
+
/**
|
|
1477
|
+
* Returns a metadata object for class sap.collaboration.components.fiori.sharing.Component.
|
|
1478
|
+
*/
|
|
1479
|
+
static getMetadata(): sap.ui.core.ComponentMetadata;
|
|
1477
1480
|
/**
|
|
1478
1481
|
* Gets current value of property {@link #getAttachments attachments}.
|
|
1479
1482
|
*/
|
|
@@ -1486,6 +1489,22 @@ declare namespace sap {
|
|
|
1486
1489
|
getCollaborationHostODataServiceUrl(): sap.ui.core.URI;
|
|
1487
1490
|
/**
|
|
1488
1491
|
* Gets current value of property {@link #getExternalObject externalObject}.
|
|
1492
|
+
*
|
|
1493
|
+
* A Business Object such as an Opportunity, Sales Order, Account, etc. from the back-end that will be shared
|
|
1494
|
+
* as a Featured External Object in a Group in Jam.
|
|
1495
|
+
* - {string} appContext: The application context. Example: "CRM", "SD", etc.
|
|
1496
|
+
* - {string} odataServicePath: The relative path to the OData Service. Example: "/sap/opu/odata/sap/ODATA_SRV"
|
|
1497
|
+
*
|
|
1498
|
+
* - {string} collection: The name of the OData Collection. Example: "Account", "Opportunity", etc.
|
|
1499
|
+
* - {string} key: The key to identify a particular instance of the Business Object. It can be a simple
|
|
1500
|
+
* ID or a compound key. Example: "123", "ObjectID='123'", "ObjectID='123',ObjectType='BUS000123'", etc.
|
|
1501
|
+
*
|
|
1502
|
+
* - {string} name: The short name of the Business Object. Example: "Sales Order 123", "Opportunity 123",
|
|
1503
|
+
* "Account 123", etc. These attributes are not enforced by the UI (missing or incorrect values
|
|
1504
|
+
* are not validated), but they are required to make the integration work. These attributes also should
|
|
1505
|
+
* be mapped in the Back-end System and Jam in order to make the External Object work.
|
|
1506
|
+
* **Note:** the externalObject is dependent on object.id, therefore, the object.id must also be passed
|
|
1507
|
+
* to the Share Component. See the parameter "object" for more information.
|
|
1489
1508
|
*/
|
|
1490
1509
|
getExternalObject(): object;
|
|
1491
1510
|
/**
|
|
@@ -1494,17 +1513,21 @@ declare namespace sap {
|
|
|
1494
1513
|
* Default value is `"100%"`.
|
|
1495
1514
|
*/
|
|
1496
1515
|
getHeight(): sap.ui.core.CSSSize;
|
|
1497
|
-
/**
|
|
1498
|
-
* Returns a metadata object for class sap.collaboration.components.fiori.sharing.Component.
|
|
1499
|
-
*/
|
|
1500
|
-
static getMetadata(): sap.ui.core.ComponentMetadata;
|
|
1501
1516
|
/**
|
|
1502
1517
|
* Gets current value of property {@link #getObject object}.
|
|
1518
|
+
*
|
|
1519
|
+
* A JSON object passed to the share component. This object contains the following properties:
|
|
1520
|
+
* - id (optional): is the object Id to be shared in SAP Jam, i.e a URL that navigates back to the same
|
|
1521
|
+
* object in the application
|
|
1522
|
+
* - display (optional): is a UI5 control to be displayed in the component UI
|
|
1523
|
+
* - share (optional): is a note that will be displayed in the component UI and shared to SAP Jam too
|
|
1503
1524
|
*/
|
|
1504
1525
|
getObject(): object;
|
|
1505
1526
|
/**
|
|
1506
1527
|
* Gets current value of property {@link #getODataServiceUrl oDataServiceUrl}.
|
|
1507
1528
|
*
|
|
1529
|
+
* The OData service URL needed for the share component.
|
|
1530
|
+
*
|
|
1508
1531
|
* Default value is `"/sap/opu/odata/sap/SM_INTEGRATION_V2_SRV"`.
|
|
1509
1532
|
*/
|
|
1510
1533
|
getODataServiceUrl(): sap.ui.core.URI;
|
|
@@ -1547,6 +1570,22 @@ declare namespace sap {
|
|
|
1547
1570
|
/**
|
|
1548
1571
|
* Sets a new value for property {@link #getExternalObject externalObject}.
|
|
1549
1572
|
*
|
|
1573
|
+
* A Business Object such as an Opportunity, Sales Order, Account, etc. from the back-end that will be shared
|
|
1574
|
+
* as a Featured External Object in a Group in Jam.
|
|
1575
|
+
* - {string} appContext: The application context. Example: "CRM", "SD", etc.
|
|
1576
|
+
* - {string} odataServicePath: The relative path to the OData Service. Example: "/sap/opu/odata/sap/ODATA_SRV"
|
|
1577
|
+
*
|
|
1578
|
+
* - {string} collection: The name of the OData Collection. Example: "Account", "Opportunity", etc.
|
|
1579
|
+
* - {string} key: The key to identify a particular instance of the Business Object. It can be a simple
|
|
1580
|
+
* ID or a compound key. Example: "123", "ObjectID='123'", "ObjectID='123',ObjectType='BUS000123'", etc.
|
|
1581
|
+
*
|
|
1582
|
+
* - {string} name: The short name of the Business Object. Example: "Sales Order 123", "Opportunity 123",
|
|
1583
|
+
* "Account 123", etc. These attributes are not enforced by the UI (missing or incorrect values
|
|
1584
|
+
* are not validated), but they are required to make the integration work. These attributes also should
|
|
1585
|
+
* be mapped in the Back-end System and Jam in order to make the External Object work.
|
|
1586
|
+
* **Note:** the externalObject is dependent on object.id, therefore, the object.id must also be passed
|
|
1587
|
+
* to the Share Component. See the parameter "object" for more information.
|
|
1588
|
+
*
|
|
1550
1589
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1551
1590
|
*/
|
|
1552
1591
|
setExternalObject(
|
|
@@ -1571,6 +1610,13 @@ declare namespace sap {
|
|
|
1571
1610
|
/**
|
|
1572
1611
|
* Sets a new value for property {@link #getObject object}.
|
|
1573
1612
|
*
|
|
1613
|
+
* A JSON object passed to the share component. This object contains the following properties:
|
|
1614
|
+
* - id (optional): is the object Id to be shared in SAP Jam, i.e a URL that navigates back to the same
|
|
1615
|
+
* object in the application
|
|
1616
|
+
* - display (optional): is a UI5 control to be displayed in the component UI
|
|
1617
|
+
* - share (optional): is a note that will be displayed in the component UI and shared to SAP Jam too
|
|
1618
|
+
*
|
|
1619
|
+
*
|
|
1574
1620
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1575
1621
|
*/
|
|
1576
1622
|
setObject(
|
|
@@ -1582,6 +1628,8 @@ declare namespace sap {
|
|
|
1582
1628
|
/**
|
|
1583
1629
|
* Sets a new value for property {@link #getODataServiceUrl oDataServiceUrl}.
|
|
1584
1630
|
*
|
|
1631
|
+
* The OData service URL needed for the share component.
|
|
1632
|
+
*
|
|
1585
1633
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1586
1634
|
*
|
|
1587
1635
|
* Default value is `"/sap/opu/odata/sap/SM_INTEGRATION_V2_SRV"`.
|
|
@@ -1673,19 +1721,9 @@ declare namespace sap {
|
|
|
1673
1721
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1674
1722
|
* objects as well as event handlers.
|
|
1675
1723
|
*
|
|
1676
|
-
*
|
|
1677
|
-
*
|
|
1678
|
-
*
|
|
1679
|
-
* (such a prefixed name must be enclosed in single or double quotes).
|
|
1680
|
-
*
|
|
1681
|
-
* The supported settings are:
|
|
1682
|
-
* - Properties
|
|
1683
|
-
* {@link #getPlacement placement} : sap.m.PlacementType (default: sap.m.PlacementType.Auto)
|
|
1684
|
-
* - {@link #getMemberId memberId} : string
|
|
1685
|
-
* - {@link #getMemberInfo memberInfo} : {object}
|
|
1686
|
-
* - {@link #getOpeningControl openingControl} : {object}
|
|
1687
|
-
* - {@link #getHeight height} : sap.ui.core.CSSSize (default: 380px)
|
|
1688
|
-
* - {@link #getWidth width} : sap.ui.core.CSSSize (default: 300px)
|
|
1724
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1725
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1726
|
+
* of the syntax of the settings object.
|
|
1689
1727
|
*/
|
|
1690
1728
|
constructor(
|
|
1691
1729
|
/**
|
|
@@ -1701,19 +1739,9 @@ declare namespace sap {
|
|
|
1701
1739
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1702
1740
|
* objects as well as event handlers.
|
|
1703
1741
|
*
|
|
1704
|
-
*
|
|
1705
|
-
*
|
|
1706
|
-
*
|
|
1707
|
-
* (such a prefixed name must be enclosed in single or double quotes).
|
|
1708
|
-
*
|
|
1709
|
-
* The supported settings are:
|
|
1710
|
-
* - Properties
|
|
1711
|
-
* {@link #getPlacement placement} : sap.m.PlacementType (default: sap.m.PlacementType.Auto)
|
|
1712
|
-
* - {@link #getMemberId memberId} : string
|
|
1713
|
-
* - {@link #getMemberInfo memberInfo} : {object}
|
|
1714
|
-
* - {@link #getOpeningControl openingControl} : {object}
|
|
1715
|
-
* - {@link #getHeight height} : sap.ui.core.CSSSize (default: 380px)
|
|
1716
|
-
* - {@link #getWidth width} : sap.ui.core.CSSSize (default: 300px)
|
|
1742
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1743
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1744
|
+
* of the syntax of the settings object.
|
|
1717
1745
|
*/
|
|
1718
1746
|
constructor(
|
|
1719
1747
|
/**
|
|
@@ -1754,6 +1782,36 @@ declare namespace sap {
|
|
|
1754
1782
|
*/
|
|
1755
1783
|
FNMetaImpl?: Function
|
|
1756
1784
|
): Function;
|
|
1785
|
+
/**
|
|
1786
|
+
* Returns a metadata object for class sap.collaboration.components.socialprofile.Component.
|
|
1787
|
+
*/
|
|
1788
|
+
static getMetadata(): sap.ui.core.ComponentMetadata;
|
|
1789
|
+
/**
|
|
1790
|
+
* Initializes the Component instance after creation. [borrowed from sap.ui.core.UIComponent]
|
|
1791
|
+
*/
|
|
1792
|
+
static init(): void;
|
|
1793
|
+
/**
|
|
1794
|
+
* Function is called when the rendering of the Component Container is completed. [borrowed from sap.ui.core.UIComponent]
|
|
1795
|
+
*/
|
|
1796
|
+
static onAfterRendering(): void;
|
|
1797
|
+
/**
|
|
1798
|
+
* Function is called when the rendering of the Component Container is started. [borrowed from sap.ui.core.UIComponent]
|
|
1799
|
+
*/
|
|
1800
|
+
static onBeforeRendering(): void;
|
|
1801
|
+
/**
|
|
1802
|
+
* Opens the social profile component
|
|
1803
|
+
*/
|
|
1804
|
+
static open(): void;
|
|
1805
|
+
/**
|
|
1806
|
+
* Setter for the Component settings
|
|
1807
|
+
*/
|
|
1808
|
+
static setSettings(
|
|
1809
|
+
/**
|
|
1810
|
+
* A JSON object used to set the component settings, this object should contains the same properties used
|
|
1811
|
+
* in the constructor
|
|
1812
|
+
*/
|
|
1813
|
+
oSettings: object
|
|
1814
|
+
): void;
|
|
1757
1815
|
/**
|
|
1758
1816
|
* Getter for property `height`. Gets the height of the Social Profile
|
|
1759
1817
|
*
|
|
@@ -1768,10 +1826,6 @@ declare namespace sap {
|
|
|
1768
1826
|
* Getter for property `memberInfo`. Gets the SAP Jam member information
|
|
1769
1827
|
*/
|
|
1770
1828
|
getMemberInfo(): object;
|
|
1771
|
-
/**
|
|
1772
|
-
* Returns a metadata object for class sap.collaboration.components.socialprofile.Component.
|
|
1773
|
-
*/
|
|
1774
|
-
static getMetadata(): sap.ui.core.ComponentMetadata;
|
|
1775
1829
|
/**
|
|
1776
1830
|
* Getter for property `openingControl`. Gets the opening control for the Social Profile
|
|
1777
1831
|
*/
|
|
@@ -1787,23 +1841,7 @@ declare namespace sap {
|
|
|
1787
1841
|
*
|
|
1788
1842
|
* Default value is `300px`
|
|
1789
1843
|
*/
|
|
1790
|
-
getWidth(): sap.ui.core.CSSSize;
|
|
1791
|
-
/**
|
|
1792
|
-
* Initializes the Component instance after creation. [borrowed from sap.ui.core.UIComponent]
|
|
1793
|
-
*/
|
|
1794
|
-
static init(): void;
|
|
1795
|
-
/**
|
|
1796
|
-
* Function is called when the rendering of the Component Container is completed. [borrowed from sap.ui.core.UIComponent]
|
|
1797
|
-
*/
|
|
1798
|
-
static onAfterRendering(): void;
|
|
1799
|
-
/**
|
|
1800
|
-
* Function is called when the rendering of the Component Container is started. [borrowed from sap.ui.core.UIComponent]
|
|
1801
|
-
*/
|
|
1802
|
-
static onBeforeRendering(): void;
|
|
1803
|
-
/**
|
|
1804
|
-
* Opens the social profile component
|
|
1805
|
-
*/
|
|
1806
|
-
static open(): void;
|
|
1844
|
+
getWidth(): sap.ui.core.CSSSize;
|
|
1807
1845
|
/**
|
|
1808
1846
|
* Setter for property `height`. Sets the height of the Social Profile
|
|
1809
1847
|
*
|
|
@@ -1853,16 +1891,6 @@ declare namespace sap {
|
|
|
1853
1891
|
*/
|
|
1854
1892
|
sPlacement: sap.m.PlacementType
|
|
1855
1893
|
): sap.collaboration.components.socialprofile.Component;
|
|
1856
|
-
/**
|
|
1857
|
-
* Setter for the Component settings
|
|
1858
|
-
*/
|
|
1859
|
-
static setSettings(
|
|
1860
|
-
/**
|
|
1861
|
-
* A JSON object used to set the component settings, this object should contains the same properties used
|
|
1862
|
-
* in the constructor
|
|
1863
|
-
*/
|
|
1864
|
-
oSettings: object
|
|
1865
|
-
): void;
|
|
1866
1894
|
/**
|
|
1867
1895
|
* Setter for property `width`. Sets the width of the Social Profile
|
|
1868
1896
|
*
|
|
@@ -1905,7 +1933,7 @@ declare namespace sap {
|
|
|
1905
1933
|
| object[]
|
|
1906
1934
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
1907
1935
|
|
|
1908
|
-
customActionPress?:
|
|
1936
|
+
customActionPress?: (oEvent: sap.ui.base.Event) => void;
|
|
1909
1937
|
}
|
|
1910
1938
|
|
|
1911
1939
|
/**
|
|
@@ -1923,26 +1951,9 @@ declare namespace sap {
|
|
|
1923
1951
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1924
1952
|
* objects as well as event handlers.
|
|
1925
1953
|
*
|
|
1926
|
-
*
|
|
1927
|
-
*
|
|
1928
|
-
*
|
|
1929
|
-
* (such a prefixed name must be enclosed in single or double quotes).
|
|
1930
|
-
*
|
|
1931
|
-
* The supported settings are:
|
|
1932
|
-
* - Properties
|
|
1933
|
-
* {@link #getEnableSocial enableSocial} : boolean (default: true)
|
|
1934
|
-
* - {@link #getAlignment alignment} : sap.suite.ui.commons.TimelineAlignment (default: sap.suite.ui.commons.TimelineAlignment.Right)
|
|
1935
|
-
*
|
|
1936
|
-
* - {@link #getAxisOrientation axisOrientation} : sap.suite.ui.commons.TimelineAxisOrientation (default:
|
|
1937
|
-
* sap.suite.ui.commons.TimelineAxisOrientation.Vertical)
|
|
1938
|
-
* - {@link #getNoDataText noDataText} : string
|
|
1939
|
-
* - {@link #getShowIcons showIcons} : boolean (default: true)
|
|
1940
|
-
* - {@link #getVisible visible} : boolean (default: true)
|
|
1941
|
-
* - {@link #getWidth width} : sap.ui.core.CSSSize (default: '100%')
|
|
1942
|
-
* - {@link #getCustomFilter customFilter} : {object}
|
|
1943
|
-
* - Events
|
|
1944
|
-
* {@link sap.collaboration.components.socialtimeline.Component:customActionPress customActionPress} :
|
|
1945
|
-
* fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
|
|
1954
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1955
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1956
|
+
* of the syntax of the settings object.
|
|
1946
1957
|
*/
|
|
1947
1958
|
constructor(
|
|
1948
1959
|
/**
|
|
@@ -1956,26 +1967,9 @@ declare namespace sap {
|
|
|
1956
1967
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1957
1968
|
* objects as well as event handlers.
|
|
1958
1969
|
*
|
|
1959
|
-
*
|
|
1960
|
-
*
|
|
1961
|
-
*
|
|
1962
|
-
* (such a prefixed name must be enclosed in single or double quotes).
|
|
1963
|
-
*
|
|
1964
|
-
* The supported settings are:
|
|
1965
|
-
* - Properties
|
|
1966
|
-
* {@link #getEnableSocial enableSocial} : boolean (default: true)
|
|
1967
|
-
* - {@link #getAlignment alignment} : sap.suite.ui.commons.TimelineAlignment (default: sap.suite.ui.commons.TimelineAlignment.Right)
|
|
1968
|
-
*
|
|
1969
|
-
* - {@link #getAxisOrientation axisOrientation} : sap.suite.ui.commons.TimelineAxisOrientation (default:
|
|
1970
|
-
* sap.suite.ui.commons.TimelineAxisOrientation.Vertical)
|
|
1971
|
-
* - {@link #getNoDataText noDataText} : string
|
|
1972
|
-
* - {@link #getShowIcons showIcons} : boolean (default: true)
|
|
1973
|
-
* - {@link #getVisible visible} : boolean (default: true)
|
|
1974
|
-
* - {@link #getWidth width} : sap.ui.core.CSSSize (default: '100%')
|
|
1975
|
-
* - {@link #getCustomFilter customFilter} : {object}
|
|
1976
|
-
* - Events
|
|
1977
|
-
* {@link sap.collaboration.components.socialtimeline.Component:customActionPress customActionPress} :
|
|
1978
|
-
* fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
|
|
1970
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1971
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1972
|
+
* of the syntax of the settings object.
|
|
1979
1973
|
*/
|
|
1980
1974
|
constructor(
|
|
1981
1975
|
/**
|
|
@@ -1988,6 +1982,125 @@ declare namespace sap {
|
|
|
1988
1982
|
mSettings?: sap.collaboration.components.socialtimeline.$ComponentSettings
|
|
1989
1983
|
);
|
|
1990
1984
|
|
|
1985
|
+
/**
|
|
1986
|
+
* The method to create the Content (UI Control Tree) of the Component.
|
|
1987
|
+
*/
|
|
1988
|
+
static createContent(): void;
|
|
1989
|
+
/**
|
|
1990
|
+
* Delete a Timeline Entry. This method should be called when a custom action requires a deletion of a Timeline
|
|
1991
|
+
* entry and should only be called if an a delete to the backend is performed successfully.
|
|
1992
|
+
*/
|
|
1993
|
+
static deleteTimelineEntry(
|
|
1994
|
+
/**
|
|
1995
|
+
* the id of the timeline entry to delete
|
|
1996
|
+
*/
|
|
1997
|
+
sId: string
|
|
1998
|
+
): void;
|
|
1999
|
+
/**
|
|
2000
|
+
* Cleans up the component instance before destruction.
|
|
2001
|
+
*/
|
|
2002
|
+
static exit(): void;
|
|
2003
|
+
/**
|
|
2004
|
+
* Creates a new subclass of class sap.collaboration.components.socialtimeline.Component with name `sClassName`
|
|
2005
|
+
* and enriches it with the information contained in `oClassInfo`.
|
|
2006
|
+
*
|
|
2007
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.UIComponent.extend}.
|
|
2008
|
+
*/
|
|
2009
|
+
static extend<T extends Record<string, unknown>>(
|
|
2010
|
+
/**
|
|
2011
|
+
* Name of the class being created
|
|
2012
|
+
*/
|
|
2013
|
+
sClassName: string,
|
|
2014
|
+
/**
|
|
2015
|
+
* Object literal with information about the class
|
|
2016
|
+
*/
|
|
2017
|
+
oClassInfo?: sap.ClassInfo<
|
|
2018
|
+
T,
|
|
2019
|
+
sap.collaboration.components.socialtimeline.Component
|
|
2020
|
+
>,
|
|
2021
|
+
/**
|
|
2022
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2023
|
+
* used by this class
|
|
2024
|
+
*/
|
|
2025
|
+
FNMetaImpl?: Function
|
|
2026
|
+
): Function;
|
|
2027
|
+
/**
|
|
2028
|
+
* Returns a metadata object for class sap.collaboration.components.socialtimeline.Component.
|
|
2029
|
+
*/
|
|
2030
|
+
static getMetadata(): sap.ui.core.ComponentMetadata;
|
|
2031
|
+
/**
|
|
2032
|
+
* Initializes the Component instance after creation.
|
|
2033
|
+
*/
|
|
2034
|
+
static init(): void;
|
|
2035
|
+
/**
|
|
2036
|
+
* Function is called when the rendering of the Component Container is completed.
|
|
2037
|
+
*/
|
|
2038
|
+
static onAfterRendering(): void;
|
|
2039
|
+
/**
|
|
2040
|
+
* Function is called when the rendering of the Component Container is started.
|
|
2041
|
+
*/
|
|
2042
|
+
static onBeforeRendering(): void;
|
|
2043
|
+
/**
|
|
2044
|
+
* Set the current business object for the social timeline to display. Note: The function setBusinessObjectMap
|
|
2045
|
+
* must be called once before calling setBusinessObject for the first time.
|
|
2046
|
+
*/
|
|
2047
|
+
static setBusinessObject(
|
|
2048
|
+
/**
|
|
2049
|
+
* an object that contains the key and name for the business object
|
|
2050
|
+
*/
|
|
2051
|
+
oObject: object
|
|
2052
|
+
): void;
|
|
2053
|
+
/**
|
|
2054
|
+
* @deprecated (since 1.28.5) - This method is deprecated, use method setBusinessObject instead.
|
|
2055
|
+
*
|
|
2056
|
+
* Set the current business object for the social timeline to display. Note: The function setBusinessObjectMap
|
|
2057
|
+
* must be called once before calling setBusinessObjectKey for the first time.
|
|
2058
|
+
*/
|
|
2059
|
+
static setBusinessObjectKey(sKey: string): void;
|
|
2060
|
+
/**
|
|
2061
|
+
* Set the business object map. It is used to initialize the data needed to retrieve the timeline entries.
|
|
2062
|
+
* This function must be called once before calling setBusinessObjectKey for the first time.
|
|
2063
|
+
*/
|
|
2064
|
+
static setBusinessObjectMap(
|
|
2065
|
+
/**
|
|
2066
|
+
* required - JSON object containing the following properties:
|
|
2067
|
+
* {sap.ui.model.odata.ODataModel} serviceModel required - OData model to retrieve timeline entries {string}
|
|
2068
|
+
* servicePath: The relative path to the OData service for the business object (example: "/sap/opu/odata/sap/ODATA_SRV")
|
|
2069
|
+
* {string} collection: Entity collection name of the business object {string} applicationContext:
|
|
2070
|
+
* The application context (example: "CRM", "SD", etc.) {function} customActionCallback: A callback
|
|
2071
|
+
* function to determine which timeline entries should receive the custom action. The function should return
|
|
2072
|
+
* an array of text/value objects.
|
|
2073
|
+
*/
|
|
2074
|
+
businessObjectMap: object
|
|
2075
|
+
): void;
|
|
2076
|
+
/**
|
|
2077
|
+
* Set property of component
|
|
2078
|
+
*/
|
|
2079
|
+
static setProperty(): void;
|
|
2080
|
+
/**
|
|
2081
|
+
* Setter for the Component settings.
|
|
2082
|
+
*/
|
|
2083
|
+
static setSettings(
|
|
2084
|
+
/**
|
|
2085
|
+
* A JSON object used to set the component settings, this object should contains the same properties used
|
|
2086
|
+
* in the constructor.
|
|
2087
|
+
*/
|
|
2088
|
+
settings: object
|
|
2089
|
+
): void;
|
|
2090
|
+
/**
|
|
2091
|
+
* Update a Timeline Entry text. This method should be called when a custom action requires a content update
|
|
2092
|
+
* of a Timeline entry and should only be called if an an update to the backend is performed successfully.
|
|
2093
|
+
*/
|
|
2094
|
+
static updateTimelineEntry(
|
|
2095
|
+
/**
|
|
2096
|
+
* the text that will be displayed in the content of the timeline entry
|
|
2097
|
+
*/
|
|
2098
|
+
sText: string,
|
|
2099
|
+
/**
|
|
2100
|
+
* the id of the timeline entry to update
|
|
2101
|
+
*/
|
|
2102
|
+
sId: string
|
|
2103
|
+
): void;
|
|
1991
2104
|
/**
|
|
1992
2105
|
* Attaches event handler `fnFunction` to the {@link #event:customActionPress customActionPress} event of
|
|
1993
2106
|
* this `sap.collaboration.components.socialtimeline.Component`.
|
|
@@ -2029,20 +2142,6 @@ declare namespace sap {
|
|
|
2029
2142
|
*/
|
|
2030
2143
|
oListener?: object
|
|
2031
2144
|
): this;
|
|
2032
|
-
/**
|
|
2033
|
-
* The method to create the Content (UI Control Tree) of the Component.
|
|
2034
|
-
*/
|
|
2035
|
-
static createContent(): void;
|
|
2036
|
-
/**
|
|
2037
|
-
* Delete a Timeline Entry. This method should be called when a custom action requires a deletion of a Timeline
|
|
2038
|
-
* entry and should only be called if an a delete to the backend is performed successfully.
|
|
2039
|
-
*/
|
|
2040
|
-
static deleteTimelineEntry(
|
|
2041
|
-
/**
|
|
2042
|
-
* the id of the timeline entry to delete
|
|
2043
|
-
*/
|
|
2044
|
-
sId: string
|
|
2045
|
-
): void;
|
|
2046
2145
|
/**
|
|
2047
2146
|
* Detaches event handler `fnFunction` from the {@link #event:customActionPress customActionPress} event
|
|
2048
2147
|
* of this `sap.collaboration.components.socialtimeline.Component`.
|
|
@@ -2059,34 +2158,6 @@ declare namespace sap {
|
|
|
2059
2158
|
*/
|
|
2060
2159
|
oListener?: object
|
|
2061
2160
|
): this;
|
|
2062
|
-
/**
|
|
2063
|
-
* Cleans up the component instance before destruction.
|
|
2064
|
-
*/
|
|
2065
|
-
static exit(): void;
|
|
2066
|
-
/**
|
|
2067
|
-
* Creates a new subclass of class sap.collaboration.components.socialtimeline.Component with name `sClassName`
|
|
2068
|
-
* and enriches it with the information contained in `oClassInfo`.
|
|
2069
|
-
*
|
|
2070
|
-
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.UIComponent.extend}.
|
|
2071
|
-
*/
|
|
2072
|
-
static extend<T extends Record<string, unknown>>(
|
|
2073
|
-
/**
|
|
2074
|
-
* Name of the class being created
|
|
2075
|
-
*/
|
|
2076
|
-
sClassName: string,
|
|
2077
|
-
/**
|
|
2078
|
-
* Object literal with information about the class
|
|
2079
|
-
*/
|
|
2080
|
-
oClassInfo?: sap.ClassInfo<
|
|
2081
|
-
T,
|
|
2082
|
-
sap.collaboration.components.socialtimeline.Component
|
|
2083
|
-
>,
|
|
2084
|
-
/**
|
|
2085
|
-
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2086
|
-
* used by this class
|
|
2087
|
-
*/
|
|
2088
|
-
FNMetaImpl?: Function
|
|
2089
|
-
): Function;
|
|
2090
2161
|
/**
|
|
2091
2162
|
* Fires event {@link #event:customActionPress customActionPress} to attached listeners.
|
|
2092
2163
|
*/
|
|
@@ -2121,10 +2192,6 @@ declare namespace sap {
|
|
|
2121
2192
|
* Default value is `true`.
|
|
2122
2193
|
*/
|
|
2123
2194
|
getEnableSocial(): boolean;
|
|
2124
|
-
/**
|
|
2125
|
-
* Returns a metadata object for class sap.collaboration.components.socialtimeline.Component.
|
|
2126
|
-
*/
|
|
2127
|
-
static getMetadata(): sap.ui.core.ComponentMetadata;
|
|
2128
2195
|
/**
|
|
2129
2196
|
* Getter for property `noDataText`. This text is displayed when the control has no data.
|
|
2130
2197
|
*
|
|
@@ -2149,18 +2216,6 @@ declare namespace sap {
|
|
|
2149
2216
|
* Default value is `100%`
|
|
2150
2217
|
*/
|
|
2151
2218
|
getWidth(): sap.ui.core.CSSSize;
|
|
2152
|
-
/**
|
|
2153
|
-
* Initializes the Component instance after creation.
|
|
2154
|
-
*/
|
|
2155
|
-
static init(): void;
|
|
2156
|
-
/**
|
|
2157
|
-
* Function is called when the rendering of the Component Container is completed.
|
|
2158
|
-
*/
|
|
2159
|
-
static onAfterRendering(): void;
|
|
2160
|
-
/**
|
|
2161
|
-
* Function is called when the rendering of the Component Container is started.
|
|
2162
|
-
*/
|
|
2163
|
-
static onBeforeRendering(): void;
|
|
2164
2219
|
/**
|
|
2165
2220
|
* Sets a new value for property {@link #getAlignment alignment}.
|
|
2166
2221
|
*
|
|
@@ -2185,39 +2240,6 @@ declare namespace sap {
|
|
|
2185
2240
|
*/
|
|
2186
2241
|
oAxisOrientation: sap.suite.ui.commons.TimelineAxisOrientation
|
|
2187
2242
|
): sap.collaboration.components.socialtimeline.Component;
|
|
2188
|
-
/**
|
|
2189
|
-
* Set the current business object for the social timeline to display. Note: The function setBusinessObjectMap
|
|
2190
|
-
* must be called once before calling setBusinessObject for the first time.
|
|
2191
|
-
*/
|
|
2192
|
-
static setBusinessObject(
|
|
2193
|
-
/**
|
|
2194
|
-
* an object that contains the key and name for the business object
|
|
2195
|
-
*/
|
|
2196
|
-
oObject: object
|
|
2197
|
-
): void;
|
|
2198
|
-
/**
|
|
2199
|
-
* @deprecated (since 1.28.5) - This method is deprecated, use method setBusinessObject instead.
|
|
2200
|
-
*
|
|
2201
|
-
* Set the current business object for the social timeline to display. Note: The function setBusinessObjectMap
|
|
2202
|
-
* must be called once before calling setBusinessObjectKey for the first time.
|
|
2203
|
-
*/
|
|
2204
|
-
static setBusinessObjectKey(sKey: string): void;
|
|
2205
|
-
/**
|
|
2206
|
-
* Set the business object map. It is used to initialize the data needed to retrieve the timeline entries.
|
|
2207
|
-
* This function must be called once before calling setBusinessObjectKey for the first time.
|
|
2208
|
-
*/
|
|
2209
|
-
static setBusinessObjectMap(
|
|
2210
|
-
/**
|
|
2211
|
-
* required - JSON object containing the following properties:
|
|
2212
|
-
* {sap.ui.model.odata.ODataModel} serviceModel required - OData model to retrieve timeline entries {string}
|
|
2213
|
-
* servicePath: The relative path to the OData service for the business object (example: "/sap/opu/odata/sap/ODATA_SRV")
|
|
2214
|
-
* {string} collection: Entity collection name of the business object {string} applicationContext:
|
|
2215
|
-
* The application context (example: "CRM", "SD", etc.) {function} customActionCallback: A callback
|
|
2216
|
-
* function to determine which timeline entries should receive the custom action. The function should return
|
|
2217
|
-
* an array of text/value objects.
|
|
2218
|
-
*/
|
|
2219
|
-
businessObjectMap: object
|
|
2220
|
-
): void;
|
|
2221
2243
|
/**
|
|
2222
2244
|
* Sets a new value for property {@link #getCustomFilter customFilter}.
|
|
2223
2245
|
*
|
|
@@ -2253,20 +2275,6 @@ declare namespace sap {
|
|
|
2253
2275
|
*/
|
|
2254
2276
|
sNoDataText: string
|
|
2255
2277
|
): sap.collaboration.components.socialtimeline.Component;
|
|
2256
|
-
/**
|
|
2257
|
-
* Set property of component
|
|
2258
|
-
*/
|
|
2259
|
-
static setProperty(): void;
|
|
2260
|
-
/**
|
|
2261
|
-
* Setter for the Component settings.
|
|
2262
|
-
*/
|
|
2263
|
-
static setSettings(
|
|
2264
|
-
/**
|
|
2265
|
-
* A JSON object used to set the component settings, this object should contains the same properties used
|
|
2266
|
-
* in the constructor.
|
|
2267
|
-
*/
|
|
2268
|
-
settings: object
|
|
2269
|
-
): void;
|
|
2270
2278
|
/**
|
|
2271
2279
|
* Setter for property `showIcons`.
|
|
2272
2280
|
*
|
|
@@ -2300,20 +2308,6 @@ declare namespace sap {
|
|
|
2300
2308
|
*/
|
|
2301
2309
|
sWidth: sap.ui.core.CSSSize
|
|
2302
2310
|
): sap.collaboration.components.socialtimeline.Component;
|
|
2303
|
-
/**
|
|
2304
|
-
* Update a Timeline Entry text. This method should be called when a custom action requires a content update
|
|
2305
|
-
* of a Timeline entry and should only be called if an an update to the backend is performed successfully.
|
|
2306
|
-
*/
|
|
2307
|
-
static updateTimelineEntry(
|
|
2308
|
-
/**
|
|
2309
|
-
* the text that will be displayed in the content of the timeline entry
|
|
2310
|
-
*/
|
|
2311
|
-
sText: string,
|
|
2312
|
-
/**
|
|
2313
|
-
* the id of the timeline entry to update
|
|
2314
|
-
*/
|
|
2315
|
-
sId: string
|
|
2316
|
-
): void;
|
|
2317
2311
|
}
|
|
2318
2312
|
}
|
|
2319
2313
|
}
|