@sapui5/ts-types 1.119.2 → 1.120.1
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/package.json +1 -1
- package/types/index.d.ts +0 -1
- package/types/sap.apf.d.ts +1 -1
- package/types/sap.ca.ui.d.ts +58 -58
- package/types/sap.chart.d.ts +1 -1
- package/types/sap.collaboration.d.ts +1 -1
- package/types/sap.esh.search.ui.d.ts +111 -1
- package/types/sap.f.d.ts +2 -2
- package/types/sap.fe.core.d.ts +10 -1
- package/types/sap.fe.macros.d.ts +78 -74
- package/types/sap.fe.navigation.d.ts +1 -1
- package/types/sap.fe.placeholder.d.ts +1 -1
- package/types/sap.fe.templates.d.ts +11 -2
- package/types/sap.fe.test.d.ts +5 -5
- package/types/sap.fe.tools.d.ts +1 -1
- package/types/sap.feedback.ui.d.ts +1 -1
- package/types/sap.gantt.d.ts +933 -15
- package/types/sap.insights.d.ts +93 -12
- package/types/sap.m.d.ts +6447 -913
- package/types/sap.makit.d.ts +1 -1
- package/types/sap.me.d.ts +1 -1
- package/types/sap.ndc.d.ts +1 -1
- package/types/sap.ovp.d.ts +4 -3
- package/types/sap.rules.ui.d.ts +1 -1
- package/types/sap.sac.df.d.ts +848 -975
- package/types/sap.suite.ui.commons.d.ts +34 -2
- package/types/sap.suite.ui.generic.template.d.ts +29 -1
- package/types/sap.suite.ui.microchart.d.ts +1 -1
- package/types/sap.tnt.d.ts +47 -1
- package/types/sap.ui.codeeditor.d.ts +1 -1
- package/types/sap.ui.commons.d.ts +1 -1
- package/types/sap.ui.comp.d.ts +572 -35
- package/types/sap.ui.core.d.ts +1866 -242
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.export.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +3 -1
- package/types/sap.ui.generic.app.d.ts +1 -1
- package/types/sap.ui.generic.template.d.ts +1 -1
- package/types/sap.ui.integration.d.ts +1 -1
- package/types/sap.ui.layout.d.ts +125 -102
- package/types/sap.ui.mdc.d.ts +1869 -1151
- package/types/sap.ui.richtexteditor.d.ts +4 -12
- package/types/sap.ui.rta.d.ts +1 -1
- package/types/sap.ui.suite.d.ts +1 -1
- package/types/sap.ui.support.d.ts +7 -1
- package/types/sap.ui.table.d.ts +117 -47
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +1 -1
- package/types/sap.ui.ux3.d.ts +1 -1
- package/types/sap.ui.vbm.d.ts +1 -1
- package/types/sap.ui.vk.d.ts +5 -11
- package/types/sap.ui.vtm.d.ts +1 -1
- package/types/sap.ui.webc.common.d.ts +1 -1
- package/types/sap.ui.webc.fiori.d.ts +470 -136
- package/types/sap.ui.webc.main.d.ts +3623 -1052
- package/types/sap.uiext.inbox.d.ts +1 -1
- package/types/sap.ushell.d.ts +1971 -832
- package/types/sap.ushell_abap.d.ts +1 -1
- package/types/sap.uxap.d.ts +1 -1
- package/types/sap.viz.d.ts +1 -1
- package/types/sap.webanalytics.core.d.ts +1 -1
- package/types/sap.zen.commons.d.ts +1 -1
- package/types/sap.zen.crosstab.d.ts +1 -1
- package/types/sap.zen.dsh.d.ts +1 -1
- package/types/sap.landvisz.d.ts +0 -7875
package/types/sap.ushell.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.120.1
|
|
2
2
|
|
|
3
3
|
declare namespace sap {
|
|
4
4
|
/**
|
|
@@ -107,14 +107,258 @@ declare namespace sap {
|
|
|
107
107
|
};
|
|
108
108
|
}
|
|
109
109
|
|
|
110
|
+
namespace BookmarkV2 {
|
|
111
|
+
/**
|
|
112
|
+
* A content node may be: - a classic home page group - an unselectable node (space) or a selectable node
|
|
113
|
+
* (page) in spaces mode - or any other containers in the future
|
|
114
|
+
*/
|
|
115
|
+
type ContentNode = {
|
|
116
|
+
/**
|
|
117
|
+
* ID of the content node
|
|
118
|
+
*/
|
|
119
|
+
id: string;
|
|
120
|
+
/**
|
|
121
|
+
* Human-readable representation of a content node which can be displayed in a control
|
|
122
|
+
*/
|
|
123
|
+
label: string;
|
|
124
|
+
/**
|
|
125
|
+
* Specifies the content node type. E.g: space, page, group, etc. See {@link sap.ushell.sap.ushell.services.BookmarkV2.ContentNodeType}
|
|
126
|
+
*/
|
|
127
|
+
type: sap.ushell.ContentNodeType;
|
|
128
|
+
/**
|
|
129
|
+
* Specifies if a bookmark can be added
|
|
130
|
+
*/
|
|
131
|
+
isContainer: boolean;
|
|
132
|
+
/**
|
|
133
|
+
* Specifies sub-nodes
|
|
134
|
+
*/
|
|
135
|
+
children?: sap.ushell.services.BookmarkV2.ContentNode[];
|
|
136
|
+
};
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
namespace Extension {
|
|
140
|
+
/**
|
|
141
|
+
* @since 1.120.0
|
|
142
|
+
* @experimental (since 1.120.0)
|
|
143
|
+
*
|
|
144
|
+
* The footer extension point is positioned below the launchpad content. To be instantiated by {@link sap.ushell.services.Extension}.
|
|
145
|
+
* **Restriction:** Might be ignored for apps running in an iframe
|
|
146
|
+
*/
|
|
147
|
+
class Footer {
|
|
148
|
+
constructor();
|
|
149
|
+
|
|
150
|
+
/**
|
|
151
|
+
* @since 1.120.0
|
|
152
|
+
*
|
|
153
|
+
* Destroys the footer.
|
|
154
|
+
*
|
|
155
|
+
* @returns Resolves once the footer was destroyed.
|
|
156
|
+
*/
|
|
157
|
+
destroy(): Promise<any>;
|
|
158
|
+
}
|
|
159
|
+
/**
|
|
160
|
+
* @since 1.120.0
|
|
161
|
+
* @experimental (since 1.120.0)
|
|
162
|
+
*
|
|
163
|
+
* Item wrapping an item positioned in an extension point. To be instantiated by {@link sap.ushell.services.Extension}.
|
|
164
|
+
*/
|
|
165
|
+
class Item {
|
|
166
|
+
constructor();
|
|
167
|
+
|
|
168
|
+
/**
|
|
169
|
+
* @since 1.120.0
|
|
170
|
+
*
|
|
171
|
+
* Destroys the item and it's related content.
|
|
172
|
+
*
|
|
173
|
+
* @returns Resolves once the item was destroyed.
|
|
174
|
+
*/
|
|
175
|
+
destroy(): Promise<any>;
|
|
176
|
+
/**
|
|
177
|
+
* @since 1.120.0
|
|
178
|
+
*
|
|
179
|
+
* Shows the item for all applications. Does not change the visibility of the item for the launchpad "home".
|
|
180
|
+
*
|
|
181
|
+
* @returns this to allow method chaining.
|
|
182
|
+
*/
|
|
183
|
+
hideForAllApps(): sap.ushell.services.Extension.Item;
|
|
184
|
+
/**
|
|
185
|
+
* @since 1.120.0
|
|
186
|
+
*
|
|
187
|
+
* Hides the item for the current application. Note: The item will not be hidden if it was set visible for
|
|
188
|
+
* all apps {@link #showForAllApps}
|
|
189
|
+
*
|
|
190
|
+
* @returns this to allow method chaining.
|
|
191
|
+
*/
|
|
192
|
+
hideForCurrentApp(): sap.ushell.services.Extension.Item;
|
|
193
|
+
/**
|
|
194
|
+
* @since 1.120.0
|
|
195
|
+
*
|
|
196
|
+
* Hides the item for launchpad "home". Does not change the visibility of the item within applications.
|
|
197
|
+
*
|
|
198
|
+
* @returns this to allow method chaining.
|
|
199
|
+
*/
|
|
200
|
+
hideOnHome(): sap.ushell.services.Extension.Item;
|
|
201
|
+
/**
|
|
202
|
+
* @since 1.120.0
|
|
203
|
+
*
|
|
204
|
+
* Shows the item for all applications. Does not change the visibility of the item for the launchpad "home".
|
|
205
|
+
*
|
|
206
|
+
* @returns this to allow method chaining.
|
|
207
|
+
*/
|
|
208
|
+
showForAllApps(): sap.ushell.services.Extension.Item;
|
|
209
|
+
/**
|
|
210
|
+
* @since 1.120.0
|
|
211
|
+
*
|
|
212
|
+
* Shows the item for the current application. The item will be hidden after the user navigates away from
|
|
213
|
+
* this application. The item will not be added again if the user navigates back to the application.
|
|
214
|
+
*
|
|
215
|
+
* @returns this to allow method chaining.
|
|
216
|
+
*/
|
|
217
|
+
showForCurrentApp(): sap.ushell.services.Extension.Item;
|
|
218
|
+
/**
|
|
219
|
+
* @since 1.120.0
|
|
220
|
+
*
|
|
221
|
+
* Shows the item for launchpad "home". Does not change the visibility of the item within applications.
|
|
222
|
+
*
|
|
223
|
+
* @returns this to allow method chaining.
|
|
224
|
+
*/
|
|
225
|
+
showOnHome(): sap.ushell.services.Extension.Item;
|
|
226
|
+
}
|
|
227
|
+
/**
|
|
228
|
+
* @since 1.120.0
|
|
229
|
+
* @experimental (since 1.120.0)
|
|
230
|
+
*
|
|
231
|
+
* The side pane extension point is positioned next the launchpad content. To be instantiated by {@link sap.ushell.services.Extension}.
|
|
232
|
+
* **Restriction:** Might be ignored for apps running in an iframe
|
|
233
|
+
*/
|
|
234
|
+
class SidePane {
|
|
235
|
+
constructor();
|
|
236
|
+
|
|
237
|
+
/**
|
|
238
|
+
* @since 1.120.0
|
|
239
|
+
*
|
|
240
|
+
* Creates an item in the side pane.
|
|
241
|
+
*
|
|
242
|
+
* @returns The newly created item.
|
|
243
|
+
*/
|
|
244
|
+
createItem(
|
|
245
|
+
/**
|
|
246
|
+
* The properties that will be passed to the created control.
|
|
247
|
+
*/
|
|
248
|
+
controlProperties: object,
|
|
249
|
+
/**
|
|
250
|
+
* Additional parameters.
|
|
251
|
+
*/
|
|
252
|
+
parameters?: {
|
|
253
|
+
/**
|
|
254
|
+
* Defines the `controlType`.
|
|
255
|
+
*/
|
|
256
|
+
controlType?: string;
|
|
257
|
+
}
|
|
258
|
+
): Promise<sap.ushell.services.Extension.Item>;
|
|
259
|
+
/**
|
|
260
|
+
* @since 1.120.0
|
|
261
|
+
*
|
|
262
|
+
* Shows the side pane for all applications. Does not change the visibility of the side pane for the launchpad
|
|
263
|
+
* "home".
|
|
264
|
+
*
|
|
265
|
+
* @returns this to allow method chaining.
|
|
266
|
+
*/
|
|
267
|
+
hideForAllApps(): sap.ushell.services.Extension.SidePane;
|
|
268
|
+
/**
|
|
269
|
+
* @since 1.120.0
|
|
270
|
+
*
|
|
271
|
+
* Hides the area for launchpad "home". Does not change the visibility of the area within applications.
|
|
272
|
+
*
|
|
273
|
+
* @returns this to allow method chaining.
|
|
274
|
+
*/
|
|
275
|
+
hideOnHome(): sap.ushell.services.Extension.SidePane;
|
|
276
|
+
/**
|
|
277
|
+
* @since 1.120.0
|
|
278
|
+
*
|
|
279
|
+
* Shows the side pane for all applications. Does not change the visibility of the side pane for the launchpad
|
|
280
|
+
* "home".
|
|
281
|
+
*
|
|
282
|
+
* @returns this to allow method chaining.
|
|
283
|
+
*/
|
|
284
|
+
showForAllApps(): sap.ushell.services.Extension.SidePane;
|
|
285
|
+
/**
|
|
286
|
+
* @since 1.120.0
|
|
287
|
+
*
|
|
288
|
+
* Shows the side pane for launchpad "home". Does not change the visibility of the side pane within applications.
|
|
289
|
+
*
|
|
290
|
+
* @returns this to allow method chaining.
|
|
291
|
+
*/
|
|
292
|
+
showOnHome(): sap.ushell.services.Extension.SidePane;
|
|
293
|
+
}
|
|
294
|
+
/**
|
|
295
|
+
* @since 1.120.0
|
|
296
|
+
* @experimental (since 1.120.0)
|
|
297
|
+
*
|
|
298
|
+
* The tool area extension point is positioned next the launchpad content. To be instantiated by {@link sap.ushell.services.Extension}.
|
|
299
|
+
* **Restriction:** Might be ignored for apps running in an iframe
|
|
300
|
+
*/
|
|
301
|
+
class ToolArea {
|
|
302
|
+
constructor();
|
|
303
|
+
|
|
304
|
+
/**
|
|
305
|
+
* @since 1.120.0
|
|
306
|
+
*
|
|
307
|
+
* Creates an item in the tool area.
|
|
308
|
+
*
|
|
309
|
+
* @returns The newly created item.
|
|
310
|
+
*/
|
|
311
|
+
createItem(
|
|
312
|
+
/**
|
|
313
|
+
* The properties that will be passed to the created control.
|
|
314
|
+
*/
|
|
315
|
+
controlProperties: object
|
|
316
|
+
): Promise<sap.ushell.services.Extension.Item>;
|
|
317
|
+
/**
|
|
318
|
+
* @since 1.120.0
|
|
319
|
+
*
|
|
320
|
+
* Shows the tool area for all applications. Does not change the visibility of the tool area for the launchpad
|
|
321
|
+
* "home".
|
|
322
|
+
*
|
|
323
|
+
* @returns this to allow method chaining.
|
|
324
|
+
*/
|
|
325
|
+
hideForAllApps(): sap.ushell.services.Extension.ToolArea;
|
|
326
|
+
/**
|
|
327
|
+
* @since 1.120.0
|
|
328
|
+
*
|
|
329
|
+
* Hides the tool area for launchpad "home". Does not change the visibility of the tool area within applications.
|
|
330
|
+
*
|
|
331
|
+
* @returns this to allow method chaining.
|
|
332
|
+
*/
|
|
333
|
+
hideOnHome(): sap.ushell.services.Extension.ToolArea;
|
|
334
|
+
/**
|
|
335
|
+
* @since 1.120.0
|
|
336
|
+
*
|
|
337
|
+
* Shows the tool area for all applications. Does not change the visibility of the tool area for the launchpad
|
|
338
|
+
* "home".
|
|
339
|
+
*
|
|
340
|
+
* @returns this to allow method chaining.
|
|
341
|
+
*/
|
|
342
|
+
showForAllApps(): sap.ushell.services.Extension.ToolArea;
|
|
343
|
+
/**
|
|
344
|
+
* @since 1.120.0
|
|
345
|
+
*
|
|
346
|
+
* Shows the tool area for launchpad "home". Does not change the visibility of the tool area within applications.
|
|
347
|
+
*
|
|
348
|
+
* @returns this to allow method chaining.
|
|
349
|
+
*/
|
|
350
|
+
showOnHome(): sap.ushell.services.Extension.ToolArea;
|
|
351
|
+
}
|
|
352
|
+
}
|
|
353
|
+
|
|
110
354
|
namespace Navigation {
|
|
111
355
|
/**
|
|
112
356
|
* Optional properties may not be present in the link.
|
|
113
357
|
*/
|
|
114
358
|
type Link = {
|
|
115
359
|
/**
|
|
116
|
-
* The intent: for example "#AnObject-Action?A=B&C=e&C=j"
|
|
117
|
-
* and cannot be directly put into a link tag.
|
|
360
|
+
* The intent: for example "#AnObject-Action?A=B&C=e&C=j"
|
|
361
|
+
* **Note:** The intent is in a **internal** format and cannot be directly put into a link tag.
|
|
118
362
|
*/
|
|
119
363
|
intent: string;
|
|
120
364
|
/**
|
|
@@ -149,25 +393,34 @@ declare namespace sap {
|
|
|
149
393
|
*/
|
|
150
394
|
action?: string;
|
|
151
395
|
/**
|
|
152
|
-
* Matches the parameters of a link.
|
|
396
|
+
* Matches the parameters of a link.
|
|
397
|
+
* **Simple format:**
|
|
398
|
+
*
|
|
399
|
+
*
|
|
153
400
|
* ```javascript
|
|
154
401
|
*
|
|
155
|
-
*
|
|
156
|
-
*
|
|
157
|
-
*
|
|
158
|
-
*
|
|
159
|
-
*
|
|
160
|
-
*
|
|
402
|
+
* {
|
|
403
|
+
* P1: "B",
|
|
404
|
+
* P2: ["e", "j"]
|
|
405
|
+
* }
|
|
406
|
+
* ```
|
|
407
|
+
*
|
|
408
|
+
*
|
|
409
|
+
* **Extended format:**
|
|
410
|
+
*
|
|
411
|
+
*
|
|
161
412
|
* ```javascript
|
|
162
413
|
*
|
|
163
|
-
*
|
|
164
|
-
*
|
|
165
|
-
*
|
|
166
|
-
*
|
|
167
|
-
*
|
|
168
|
-
*
|
|
169
|
-
*
|
|
170
|
-
*
|
|
414
|
+
* {
|
|
415
|
+
* P1: { value: "v1" },
|
|
416
|
+
* P2: { value: ["v2", "v3"] },
|
|
417
|
+
* P3: { value: "v4", required: true }
|
|
418
|
+
* }
|
|
419
|
+
* ```
|
|
420
|
+
*
|
|
421
|
+
*
|
|
422
|
+
* `required`: Whether the parameter is be required (`true`) or not (`false`) in the signature of the matching
|
|
423
|
+
* target. Note that this option is only effective on platforms using the `sap.ushell.services.ClientSideTargetResolution`
|
|
171
424
|
*/
|
|
172
425
|
params?: object;
|
|
173
426
|
/**
|
|
@@ -210,8 +463,8 @@ declare namespace sap {
|
|
|
210
463
|
*/
|
|
211
464
|
type Target = {
|
|
212
465
|
/**
|
|
213
|
-
* Defaults to current hash.
|
|
214
|
-
*
|
|
466
|
+
* Defaults to current hash. Note that the only the `appSpecificRoute` will be considered when target is
|
|
467
|
+
* omitted.
|
|
215
468
|
*/
|
|
216
469
|
target?: {
|
|
217
470
|
/**
|
|
@@ -227,31 +480,44 @@ declare namespace sap {
|
|
|
227
480
|
*/
|
|
228
481
|
contextRaw?: string;
|
|
229
482
|
/**
|
|
230
|
-
* The entire intent including parameters and appSpecificRoute.
|
|
231
|
-
*
|
|
232
|
-
*
|
|
483
|
+
* The entire intent including parameters and appSpecificRoute.
|
|
484
|
+
* **Note:** If set all other parameters are ignored.
|
|
485
|
+
* **Note:** While parameters need to be url-encoded once when used in the `shellHash` the app specific
|
|
486
|
+
* route must not be encoded.
|
|
233
487
|
*/
|
|
234
488
|
shellHash?: string;
|
|
235
489
|
};
|
|
236
490
|
/**
|
|
237
|
-
* The parameters of the target
|
|
491
|
+
* The parameters of the target
|
|
492
|
+
* **Simple format:**
|
|
493
|
+
*
|
|
494
|
+
*
|
|
238
495
|
* ```javascript
|
|
239
496
|
*
|
|
240
|
-
*
|
|
241
|
-
*
|
|
242
|
-
*
|
|
243
|
-
*
|
|
244
|
-
*
|
|
245
|
-
*
|
|
497
|
+
* {
|
|
498
|
+
* P1: "B",
|
|
499
|
+
* P2: ["e", "j"]
|
|
500
|
+
* }
|
|
501
|
+
* ```
|
|
502
|
+
*
|
|
503
|
+
*
|
|
504
|
+
* **Extended format:**
|
|
505
|
+
*
|
|
506
|
+
*
|
|
246
507
|
* ```javascript
|
|
247
508
|
*
|
|
248
|
-
*
|
|
249
|
-
*
|
|
250
|
-
*
|
|
251
|
-
*
|
|
252
|
-
*
|
|
253
|
-
*
|
|
254
|
-
*
|
|
509
|
+
* {
|
|
510
|
+
* P1: { value: "v1" },
|
|
511
|
+
* P2: { value: ["v2", "v3"] }
|
|
512
|
+
* }
|
|
513
|
+
* ```
|
|
514
|
+
*
|
|
515
|
+
*
|
|
516
|
+
*
|
|
517
|
+
*
|
|
518
|
+
*
|
|
519
|
+
* **Note:** Parameter values can contain special characters and must be provided unencoded. The APIs takes
|
|
520
|
+
* care of the necessary encodings.
|
|
255
521
|
*/
|
|
256
522
|
params?: object;
|
|
257
523
|
/**
|
|
@@ -269,6 +535,8 @@ declare namespace sap {
|
|
|
269
535
|
namespace Personalization {
|
|
270
536
|
/**
|
|
271
537
|
* @since 1.22.0
|
|
538
|
+
* @deprecated (since 1.120) - Please use {@link sap.ushell.services.PersonalizationV2.ContextContainer }
|
|
539
|
+
* instead
|
|
272
540
|
*
|
|
273
541
|
* The container is the anchor object of the unified shell personalization in container mode.
|
|
274
542
|
*/
|
|
@@ -280,6 +548,7 @@ declare namespace sap {
|
|
|
280
548
|
|
|
281
549
|
/**
|
|
282
550
|
* @since 1.22.0
|
|
551
|
+
* @deprecated (since 1.120.0)
|
|
283
552
|
*
|
|
284
553
|
* Returns an array with all internal keys of direct items in the container.
|
|
285
554
|
*
|
|
@@ -386,6 +655,8 @@ declare namespace sap {
|
|
|
386
655
|
load(): object;
|
|
387
656
|
/**
|
|
388
657
|
* @since 1.22.0
|
|
658
|
+
* @deprecated (since 1.120.0) - Use {@link sap.ushell.services.Personalization.ContextContainer#saveDeferred }
|
|
659
|
+
* instead
|
|
389
660
|
*
|
|
390
661
|
* Attempts to save the current container data at the underlying storage asynchronously. The current state
|
|
391
662
|
* is serialized.
|
|
@@ -425,14 +696,28 @@ declare namespace sap {
|
|
|
425
696
|
): void;
|
|
426
697
|
}
|
|
427
698
|
/**
|
|
428
|
-
* @since 1.
|
|
699
|
+
* @since 1.18.0
|
|
700
|
+
* @deprecated (since 1.120) - Please use {@link sap.ushell.services.Personalization#getContainer} instead
|
|
701
|
+
*
|
|
702
|
+
* The personalization container is the anchor object of the unified shell personalization in container
|
|
703
|
+
* mode.
|
|
704
|
+
*/
|
|
705
|
+
class PersonalizationContainer {
|
|
706
|
+
/**
|
|
707
|
+
* To be called by the personalization service getPersonalizationContainer method.
|
|
708
|
+
*/
|
|
709
|
+
constructor();
|
|
710
|
+
}
|
|
711
|
+
/**
|
|
712
|
+
* @since 1.18.0
|
|
713
|
+
* @deprecated (since 1.120) - Please use {@link sap.ushell.services.Personalization#getContainer} instead
|
|
429
714
|
*
|
|
430
715
|
* The personalization variant contains personalization data. It is used in the personalization container
|
|
431
716
|
* mode.
|
|
432
717
|
*/
|
|
433
|
-
class
|
|
718
|
+
class PersonalizationContainerVariant {
|
|
434
719
|
/**
|
|
435
|
-
* To be
|
|
720
|
+
* To be called by the personalization variant set.
|
|
436
721
|
*/
|
|
437
722
|
constructor();
|
|
438
723
|
|
|
@@ -450,7 +735,7 @@ declare namespace sap {
|
|
|
450
735
|
sItemKey: string
|
|
451
736
|
): boolean;
|
|
452
737
|
/**
|
|
453
|
-
* @since 1.
|
|
738
|
+
* @since 1.18.0
|
|
454
739
|
*
|
|
455
740
|
* Deletes an item from this variant. In case the item does not exist, nothing happens.
|
|
456
741
|
*/
|
|
@@ -461,7 +746,7 @@ declare namespace sap {
|
|
|
461
746
|
sItemKey: string
|
|
462
747
|
): void;
|
|
463
748
|
/**
|
|
464
|
-
* @since 1.
|
|
749
|
+
* @since 1.18.0
|
|
465
750
|
*
|
|
466
751
|
* Returns an array with the keys of all items in this variant.
|
|
467
752
|
*
|
|
@@ -483,7 +768,7 @@ declare namespace sap {
|
|
|
483
768
|
sItemKey: string
|
|
484
769
|
): object;
|
|
485
770
|
/**
|
|
486
|
-
* @since 1.
|
|
771
|
+
* @since 1.18.0
|
|
487
772
|
*
|
|
488
773
|
* Returns the key of this variant.
|
|
489
774
|
*
|
|
@@ -491,7 +776,7 @@ declare namespace sap {
|
|
|
491
776
|
*/
|
|
492
777
|
getVariantKey(): string;
|
|
493
778
|
/**
|
|
494
|
-
* @since 1.
|
|
779
|
+
* @since 1.18.0
|
|
495
780
|
*
|
|
496
781
|
* Returns the name of this variant.
|
|
497
782
|
*
|
|
@@ -513,54 +798,28 @@ declare namespace sap {
|
|
|
513
798
|
*/
|
|
514
799
|
item: object
|
|
515
800
|
): void;
|
|
516
|
-
/**
|
|
517
|
-
* @since 1.24.0
|
|
518
|
-
*
|
|
519
|
-
* Sets the name of the variant.
|
|
520
|
-
*
|
|
521
|
-
* In case a variant with `sVariantName` is already existing in the corresponding variant set an exception
|
|
522
|
-
* is thrown.
|
|
523
|
-
*/
|
|
524
|
-
setVariantName(
|
|
525
|
-
/**
|
|
526
|
-
* variant name
|
|
527
|
-
*/
|
|
528
|
-
sVariantName: string
|
|
529
|
-
): void;
|
|
530
801
|
}
|
|
531
802
|
/**
|
|
532
|
-
* @since 1.
|
|
803
|
+
* @since 1.18.0
|
|
804
|
+
* @deprecated (since 1.120) - Please use {@link sap.ushell.services.Personalization#getContainer} instead
|
|
533
805
|
*
|
|
534
806
|
* The personalization variant set contains variants of personalization data. It is used in the personalization
|
|
535
807
|
* container mode.
|
|
536
808
|
*/
|
|
537
|
-
class
|
|
809
|
+
class PersonalizationContainerVariantSet {
|
|
538
810
|
/**
|
|
539
|
-
* A VariantSet is a class representing a collection of Variants (identified by a key and name) and a member
|
|
540
|
-
* variable indicating the "current variable"
|
|
541
|
-
*
|
|
542
|
-
* When manipulating the underlying data, additional constraints are enforced.
|
|
543
|
-
*
|
|
544
811
|
* To be called by the personalization container.
|
|
545
812
|
*/
|
|
546
813
|
constructor();
|
|
547
|
-
|
|
548
814
|
/**
|
|
549
|
-
* @since 1.
|
|
550
|
-
*
|
|
551
|
-
* Creates a new variant in the variant set. In case a variant with this name is already existing an exception
|
|
552
|
-
* is thrown.
|
|
815
|
+
* @since 1.18.0
|
|
553
816
|
*
|
|
554
|
-
*
|
|
817
|
+
* Deletes a variant from the variant set. In case the variant does not exist nothing happens.
|
|
555
818
|
*/
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
* variant set name
|
|
559
|
-
*/
|
|
560
|
-
sVariantSetName: string
|
|
561
|
-
): object;
|
|
819
|
+
delVariant: undefined;
|
|
820
|
+
|
|
562
821
|
/**
|
|
563
|
-
* @since 1.
|
|
822
|
+
* @since 1.18.0
|
|
564
823
|
*
|
|
565
824
|
* Checks if a specific variant is contained in the variant set.
|
|
566
825
|
*
|
|
@@ -573,18 +832,7 @@ declare namespace sap {
|
|
|
573
832
|
sVariantKey: string
|
|
574
833
|
): boolean;
|
|
575
834
|
/**
|
|
576
|
-
* @since 1.
|
|
577
|
-
*
|
|
578
|
-
* Deletes a variant from the variant set. In case the variant does not exist nothing happens.
|
|
579
|
-
*/
|
|
580
|
-
delVariant(
|
|
581
|
-
/**
|
|
582
|
-
* variant key
|
|
583
|
-
*/
|
|
584
|
-
sVariantKey: string
|
|
585
|
-
): void;
|
|
586
|
-
/**
|
|
587
|
-
* @since 1.22.0
|
|
835
|
+
* @since 1.18.0
|
|
588
836
|
*
|
|
589
837
|
* Returns the current variant key.
|
|
590
838
|
*
|
|
@@ -592,12 +840,12 @@ declare namespace sap {
|
|
|
592
840
|
*/
|
|
593
841
|
getCurrentVariantKey(): string;
|
|
594
842
|
/**
|
|
595
|
-
* @since 1.
|
|
843
|
+
* @since 1.18.0
|
|
596
844
|
*
|
|
597
845
|
* Returns a variant object.
|
|
598
846
|
*
|
|
599
|
-
* @returns {@link sap.ushell.services.PersonalizationContainerVariant}. In case the variant
|
|
600
|
-
* contain a variant with this key `undefined` is returned.
|
|
847
|
+
* @returns {@link sap.ushell.services.Personalization.PersonalizationContainerVariant}. In case the variant
|
|
848
|
+
* set does not contain a variant with this key `undefined` is returned.
|
|
601
849
|
*/
|
|
602
850
|
getVariant(
|
|
603
851
|
/**
|
|
@@ -606,7 +854,7 @@ declare namespace sap {
|
|
|
606
854
|
sVariantKey: string
|
|
607
855
|
): object;
|
|
608
856
|
/**
|
|
609
|
-
* @since 1.
|
|
857
|
+
* @since 1.18.0
|
|
610
858
|
*
|
|
611
859
|
* Returns the variant key corresponding to a variant name.
|
|
612
860
|
*
|
|
@@ -618,9 +866,9 @@ declare namespace sap {
|
|
|
618
866
|
* variant name
|
|
619
867
|
*/
|
|
620
868
|
sVariantName: string
|
|
621
|
-
):
|
|
869
|
+
): object;
|
|
622
870
|
/**
|
|
623
|
-
* @since 1.
|
|
871
|
+
* @since 1.18.0
|
|
624
872
|
*
|
|
625
873
|
* Returns an array with the keys of the variants in the variant set.
|
|
626
874
|
*
|
|
@@ -628,7 +876,7 @@ declare namespace sap {
|
|
|
628
876
|
*/
|
|
629
877
|
getVariantKeys(): any[];
|
|
630
878
|
/**
|
|
631
|
-
* @since 1.
|
|
879
|
+
* @since 1.18.0
|
|
632
880
|
*
|
|
633
881
|
* Sets the current variant key.
|
|
634
882
|
*/
|
|
@@ -639,18 +887,395 @@ declare namespace sap {
|
|
|
639
887
|
sVariantKey: string
|
|
640
888
|
): void;
|
|
641
889
|
}
|
|
642
|
-
}
|
|
643
|
-
|
|
644
|
-
namespace personalization {
|
|
645
890
|
/**
|
|
646
|
-
* @since 1.
|
|
647
|
-
*
|
|
648
|
-
*
|
|
649
|
-
*
|
|
650
|
-
*
|
|
891
|
+
* @since 1.15.0
|
|
892
|
+
* @deprecated (since 1.120) - Please use {@link sap.ushell.services.PersonalizationV2.Personalizer} instead
|
|
893
|
+
*
|
|
894
|
+
* The Unified Shell personalizer providing set get delete methods to access the persisted personalization
|
|
895
|
+
* data in direct mode.
|
|
896
|
+
*/
|
|
897
|
+
class Personalizer {
|
|
898
|
+
/**
|
|
899
|
+
* To be called by the personalization service getPersonalizer method.
|
|
900
|
+
*/
|
|
901
|
+
constructor();
|
|
902
|
+
}
|
|
903
|
+
/**
|
|
904
|
+
* @since 1.18.0
|
|
905
|
+
* @deprecated (since 1.120) - Please use {@link sap.ushell.services.PersonalizationV2.TransientPersonalizer }
|
|
906
|
+
* instead
|
|
907
|
+
*
|
|
908
|
+
* The transient personalizer shall be used in container mode for table personalization. To be called by
|
|
909
|
+
* the personalization service getTransientPersonalizer method.
|
|
910
|
+
*/
|
|
911
|
+
class TransientPersonalizer {
|
|
912
|
+
constructor();
|
|
913
|
+
}
|
|
914
|
+
/**
|
|
915
|
+
* @since 1.22.0
|
|
916
|
+
* @deprecated (since 1.120) - Please use {@link sap.ushell.services.PersonalizationV2.Variant} instead
|
|
917
|
+
*
|
|
918
|
+
* The personalization variant contains personalization data. It is used in the personalization container
|
|
919
|
+
* mode.
|
|
920
|
+
*/
|
|
921
|
+
class Variant {
|
|
922
|
+
/**
|
|
923
|
+
* To be instantiated via Personalization.VariantSet add / get Variant only
|
|
924
|
+
*/
|
|
925
|
+
constructor();
|
|
926
|
+
|
|
927
|
+
/**
|
|
928
|
+
* @since 1.18.0
|
|
929
|
+
*
|
|
930
|
+
* Checks if a specific item is contained in this variant.
|
|
931
|
+
*
|
|
932
|
+
* @returns true if the variant contains an item with the key
|
|
933
|
+
*/
|
|
934
|
+
containsItem(
|
|
935
|
+
/**
|
|
936
|
+
* item key
|
|
937
|
+
*/
|
|
938
|
+
sItemKey: string
|
|
939
|
+
): boolean;
|
|
940
|
+
/**
|
|
941
|
+
* @since 1.22.0
|
|
942
|
+
*
|
|
943
|
+
* Deletes an item from this variant. In case the item does not exist, nothing happens.
|
|
944
|
+
*/
|
|
945
|
+
delItem(
|
|
946
|
+
/**
|
|
947
|
+
* item key
|
|
948
|
+
*/
|
|
949
|
+
sItemKey: string
|
|
950
|
+
): void;
|
|
951
|
+
/**
|
|
952
|
+
* @since 1.22.0
|
|
953
|
+
*
|
|
954
|
+
* Returns an array with the keys of all items in this variant.
|
|
955
|
+
*
|
|
956
|
+
* @returns item keys
|
|
957
|
+
*/
|
|
958
|
+
getItemKeys(): any[];
|
|
959
|
+
/**
|
|
960
|
+
* @since 1.18.0
|
|
961
|
+
*
|
|
962
|
+
* Returns the value for an item in this variant.
|
|
963
|
+
*
|
|
964
|
+
* @returns item value (JSON object). In case the variant does not contain an item with this key `undefined`
|
|
965
|
+
* is returned.
|
|
966
|
+
*/
|
|
967
|
+
getItemValue(
|
|
968
|
+
/**
|
|
969
|
+
* item key
|
|
970
|
+
*/
|
|
971
|
+
sItemKey: string
|
|
972
|
+
): object;
|
|
973
|
+
/**
|
|
974
|
+
* @since 1.22.0
|
|
975
|
+
*
|
|
976
|
+
* Returns the key of this variant.
|
|
977
|
+
*
|
|
978
|
+
* @returns variant key.
|
|
979
|
+
*/
|
|
980
|
+
getVariantKey(): string;
|
|
981
|
+
/**
|
|
982
|
+
* @since 1.22.0
|
|
983
|
+
*
|
|
984
|
+
* Returns the name of this variant.
|
|
985
|
+
*
|
|
986
|
+
* @returns variant name.
|
|
987
|
+
*/
|
|
988
|
+
getVariantName(): string;
|
|
989
|
+
/**
|
|
990
|
+
* @since 1.18.0
|
|
991
|
+
*
|
|
992
|
+
* Sets the value for an item in this variant.
|
|
993
|
+
*/
|
|
994
|
+
setItemValue(
|
|
995
|
+
/**
|
|
996
|
+
* item key
|
|
997
|
+
*/
|
|
998
|
+
sItemKey: string,
|
|
999
|
+
/**
|
|
1000
|
+
* value (JSON object)
|
|
1001
|
+
*/
|
|
1002
|
+
item: object
|
|
1003
|
+
): void;
|
|
1004
|
+
/**
|
|
1005
|
+
* @since 1.24.0
|
|
1006
|
+
*
|
|
1007
|
+
* Sets the name of the variant.
|
|
1008
|
+
*
|
|
1009
|
+
* In case a variant with `sVariantName` is already existing in the corresponding variant set an exception
|
|
1010
|
+
* is thrown.
|
|
1011
|
+
*/
|
|
1012
|
+
setVariantName(
|
|
1013
|
+
/**
|
|
1014
|
+
* variant name
|
|
1015
|
+
*/
|
|
1016
|
+
sVariantName: string
|
|
1017
|
+
): void;
|
|
1018
|
+
}
|
|
1019
|
+
/**
|
|
1020
|
+
* @since 1.22.0
|
|
1021
|
+
* @deprecated (since 1.120) - Please use {@link sap.ushell.services.PersonalizationV2.VariantSet} instead
|
|
1022
|
+
*
|
|
1023
|
+
* The personalization variant set contains variants of personalization data. It is used in the personalization
|
|
1024
|
+
* container mode.
|
|
1025
|
+
*/
|
|
1026
|
+
class VariantSet {
|
|
1027
|
+
/**
|
|
1028
|
+
* A VariantSet is a class representing a collection of Variants (identified by a key and name) and a member
|
|
1029
|
+
* variable indicating the "current variable"
|
|
1030
|
+
*
|
|
1031
|
+
* When manipulating the underlying data, additional constraints are enforced.
|
|
1032
|
+
*
|
|
1033
|
+
* To be called by the personalization container.
|
|
1034
|
+
*/
|
|
1035
|
+
constructor();
|
|
1036
|
+
|
|
1037
|
+
/**
|
|
1038
|
+
* @since 1.22.0
|
|
1039
|
+
*
|
|
1040
|
+
* Creates a new variant in the variant set. In case a variant with this name is already existing an exception
|
|
1041
|
+
* is thrown.
|
|
1042
|
+
*
|
|
1043
|
+
* @returns {@link sap.ushell.services.PersonalizationContainerVariant}
|
|
1044
|
+
*/
|
|
1045
|
+
addVariant(
|
|
1046
|
+
/**
|
|
1047
|
+
* variant set name
|
|
1048
|
+
*/
|
|
1049
|
+
sVariantSetName: string
|
|
1050
|
+
): object;
|
|
1051
|
+
/**
|
|
1052
|
+
* @since 1.22.0
|
|
1053
|
+
*
|
|
1054
|
+
* Checks if a specific variant is contained in the variant set.
|
|
1055
|
+
*
|
|
1056
|
+
* @returns true if the variant set contains a variant with the key
|
|
1057
|
+
*/
|
|
1058
|
+
containsVariant(
|
|
1059
|
+
/**
|
|
1060
|
+
* variant key
|
|
1061
|
+
*/
|
|
1062
|
+
sVariantKey: string
|
|
1063
|
+
): boolean;
|
|
1064
|
+
/**
|
|
1065
|
+
* @since 1.22.0
|
|
1066
|
+
*
|
|
1067
|
+
* Deletes a variant from the variant set. In case the variant does not exist nothing happens.
|
|
1068
|
+
*/
|
|
1069
|
+
delVariant(
|
|
1070
|
+
/**
|
|
1071
|
+
* variant key
|
|
1072
|
+
*/
|
|
1073
|
+
sVariantKey: string
|
|
1074
|
+
): void;
|
|
1075
|
+
/**
|
|
1076
|
+
* @since 1.22.0
|
|
1077
|
+
*
|
|
1078
|
+
* Returns the current variant key.
|
|
1079
|
+
*
|
|
1080
|
+
* @returns current variant key. In case the current variant was never set `null` is returned.
|
|
1081
|
+
*/
|
|
1082
|
+
getCurrentVariantKey(): string;
|
|
1083
|
+
/**
|
|
1084
|
+
* @since 1.22.0
|
|
1085
|
+
*
|
|
1086
|
+
* Returns a variant object.
|
|
1087
|
+
*
|
|
1088
|
+
* @returns {@link sap.ushell.services.PersonalizationContainerVariant}. In case the variant set does not
|
|
1089
|
+
* contain a variant with this key `undefined` is returned.
|
|
1090
|
+
*/
|
|
1091
|
+
getVariant(
|
|
1092
|
+
/**
|
|
1093
|
+
* variant key
|
|
1094
|
+
*/
|
|
1095
|
+
sVariantKey: string
|
|
1096
|
+
): object;
|
|
1097
|
+
/**
|
|
1098
|
+
* @since 1.22.0
|
|
1099
|
+
*
|
|
1100
|
+
* Returns the variant key corresponding to a variant name.
|
|
1101
|
+
*
|
|
1102
|
+
* @returns variant key. In case the variant set does not contain a variant with this name `undefined` is
|
|
1103
|
+
* returned.
|
|
1104
|
+
*/
|
|
1105
|
+
getVariantKeyByName(
|
|
1106
|
+
/**
|
|
1107
|
+
* variant name
|
|
1108
|
+
*/
|
|
1109
|
+
sVariantName: string
|
|
1110
|
+
): string;
|
|
1111
|
+
/**
|
|
1112
|
+
* @since 1.22.0
|
|
1113
|
+
*
|
|
1114
|
+
* Returns an array with the keys of the variants in the variant set.
|
|
1115
|
+
*
|
|
1116
|
+
* @returns variant keys
|
|
1117
|
+
*/
|
|
1118
|
+
getVariantKeys(): any[];
|
|
1119
|
+
/**
|
|
1120
|
+
* @since 1.22.0
|
|
1121
|
+
*
|
|
1122
|
+
* Sets the current variant key.
|
|
1123
|
+
*/
|
|
1124
|
+
setCurrentVariantKey(
|
|
1125
|
+
/**
|
|
1126
|
+
* There is no validity check for the variant key.
|
|
1127
|
+
*/
|
|
1128
|
+
sVariantKey: string
|
|
1129
|
+
): void;
|
|
1130
|
+
}
|
|
1131
|
+
/**
|
|
1132
|
+
* @since 1.18.0
|
|
1133
|
+
* @deprecated (since 1.120) - Please use {@link sap.ushell.services.PersonalizationV2.VariantSetAdapter }
|
|
1134
|
+
* instead
|
|
1135
|
+
*
|
|
1136
|
+
* Wrapper object to expose a variant interface on a ContextContainer object obtained from the Personalization
|
|
1137
|
+
* service:
|
|
1138
|
+
* ```javascript
|
|
651
1139
|
*
|
|
652
1140
|
* getContainer(...).done( function(oContainer) {
|
|
653
|
-
* that.oVariantSetContainer = new
|
|
1141
|
+
* that.oVariantSetContainer = new VariantSetAdapter(oContainer);
|
|
1142
|
+
* });
|
|
1143
|
+
* ```
|
|
1144
|
+
*/
|
|
1145
|
+
class VariantSetAdapter {
|
|
1146
|
+
/**
|
|
1147
|
+
* VariantSetAdapter amends ContextContainer with functionality to
|
|
1148
|
+
*
|
|
1149
|
+
* Example: An application has two types of variants. Variant type 1 contains filter values for a query,
|
|
1150
|
+
* which are stored in item 1 of the variant, and personalization data for a table, which are stored in
|
|
1151
|
+
* item 2 of the variant. Variant type 2 contains a setting (item 3) that is independent of the filtering
|
|
1152
|
+
* and the table settings. It might be used for a different screen than the variants of type 1. In this
|
|
1153
|
+
* example you would have 2 variant sets, one for each variant type.
|
|
1154
|
+
*/
|
|
1155
|
+
constructor(
|
|
1156
|
+
/**
|
|
1157
|
+
* Context
|
|
1158
|
+
*/
|
|
1159
|
+
oContextContainer: object
|
|
1160
|
+
);
|
|
1161
|
+
|
|
1162
|
+
/**
|
|
1163
|
+
* @since 1.22.0
|
|
1164
|
+
*
|
|
1165
|
+
* Creates a new variant set in the container. In case a variant set with this key is already existing an
|
|
1166
|
+
* exception is thrown.
|
|
1167
|
+
*
|
|
1168
|
+
* @returns {@link ontainerVariantSet}
|
|
1169
|
+
*/
|
|
1170
|
+
addVariantSet(
|
|
1171
|
+
/**
|
|
1172
|
+
* variant set key
|
|
1173
|
+
*/
|
|
1174
|
+
sVariantSetKey: string
|
|
1175
|
+
): object;
|
|
1176
|
+
/**
|
|
1177
|
+
* @since 1.18.0
|
|
1178
|
+
*
|
|
1179
|
+
* Checks if a specific variant set is contained in the container.
|
|
1180
|
+
*
|
|
1181
|
+
* @returns true if the container contains a variant set with the key
|
|
1182
|
+
*/
|
|
1183
|
+
containsVariantSet(
|
|
1184
|
+
/**
|
|
1185
|
+
* variant set key
|
|
1186
|
+
*/
|
|
1187
|
+
sVariantSetKey: string
|
|
1188
|
+
): boolean;
|
|
1189
|
+
/**
|
|
1190
|
+
* @since 1.22.0
|
|
1191
|
+
*
|
|
1192
|
+
* Deletes a variant set from the container. In case the variant set does not exist nothing happens.
|
|
1193
|
+
*/
|
|
1194
|
+
delVariantSet(
|
|
1195
|
+
/**
|
|
1196
|
+
* variant set key
|
|
1197
|
+
*/
|
|
1198
|
+
sVariantSetKey: string
|
|
1199
|
+
): void;
|
|
1200
|
+
/**
|
|
1201
|
+
* @since 1.22.0
|
|
1202
|
+
*
|
|
1203
|
+
* Returns the variant set object from the container.
|
|
1204
|
+
*
|
|
1205
|
+
* @returns {@link ontainerVariantSet}. In case the container does not contain a variant set with this key
|
|
1206
|
+
* `undefined` is returned.
|
|
1207
|
+
*/
|
|
1208
|
+
getVariantSet(
|
|
1209
|
+
/**
|
|
1210
|
+
* variant set key The string length is restricted to 40 characters
|
|
1211
|
+
*/
|
|
1212
|
+
sVariantSetKey: string
|
|
1213
|
+
): object;
|
|
1214
|
+
/**
|
|
1215
|
+
* @since 1.18.0
|
|
1216
|
+
*
|
|
1217
|
+
* Returns an array with the keys of the variant sets in the container.
|
|
1218
|
+
*
|
|
1219
|
+
* @returns variant set keys
|
|
1220
|
+
*/
|
|
1221
|
+
getVariantSetKeys(): any[];
|
|
1222
|
+
}
|
|
1223
|
+
}
|
|
1224
|
+
|
|
1225
|
+
namespace PersonalizationV2 {
|
|
1226
|
+
/**
|
|
1227
|
+
* @since 1.120.0
|
|
1228
|
+
*
|
|
1229
|
+
* The container is the anchor object of the unified shell personalization in container mode.
|
|
1230
|
+
*/
|
|
1231
|
+
class ContextContainer {
|
|
1232
|
+
/**
|
|
1233
|
+
* To be called by the personalization service getContainer method.
|
|
1234
|
+
*/
|
|
1235
|
+
constructor();
|
|
1236
|
+
}
|
|
1237
|
+
/**
|
|
1238
|
+
* @since 1.120.0
|
|
1239
|
+
*
|
|
1240
|
+
* The Unified Shell personalizer providing set get delete methods to access the persisted personalization
|
|
1241
|
+
* data in direct mode.
|
|
1242
|
+
*/
|
|
1243
|
+
class Personalizer {
|
|
1244
|
+
/**
|
|
1245
|
+
* To be called by the personalization service getPersonalizer method.
|
|
1246
|
+
*/
|
|
1247
|
+
constructor();
|
|
1248
|
+
}
|
|
1249
|
+
/**
|
|
1250
|
+
* @since 1.120.0
|
|
1251
|
+
*
|
|
1252
|
+
* The transient personalizer shall be used in container mode for table personalization. To be called by
|
|
1253
|
+
* the personalization service getTransientPersonalizer method.
|
|
1254
|
+
*/
|
|
1255
|
+
class TransientPersonalizer {
|
|
1256
|
+
constructor();
|
|
1257
|
+
}
|
|
1258
|
+
/**
|
|
1259
|
+
* @since 1.120.0
|
|
1260
|
+
*
|
|
1261
|
+
* The personalization variant contains personalization data. It is used in the personalization container
|
|
1262
|
+
* mode.
|
|
1263
|
+
*/
|
|
1264
|
+
class Variant {
|
|
1265
|
+
/**
|
|
1266
|
+
* To be instantiated via Personalization.VariantSet add / get Variant only
|
|
1267
|
+
*/
|
|
1268
|
+
constructor();
|
|
1269
|
+
}
|
|
1270
|
+
/**
|
|
1271
|
+
* @since 1.120.0
|
|
1272
|
+
*
|
|
1273
|
+
* Wrapper object to expose a variant interface on a ContextContainer object obtained from the PersonalizationV2
|
|
1274
|
+
* service:
|
|
1275
|
+
* ```javascript
|
|
1276
|
+
*
|
|
1277
|
+
* oPersonalizationV2Service.getContainer(...).then(function(oContainer) {
|
|
1278
|
+
* that.oVariantSetContainer = new VariantSetAdapter(oContainer);
|
|
654
1279
|
* });
|
|
655
1280
|
* ```
|
|
656
1281
|
*/
|
|
@@ -671,6 +1296,49 @@ declare namespace sap {
|
|
|
671
1296
|
oContextContainer: object
|
|
672
1297
|
);
|
|
673
1298
|
}
|
|
1299
|
+
|
|
1300
|
+
/**
|
|
1301
|
+
* currently the validity property of the scope object is relevant:
|
|
1302
|
+
*/
|
|
1303
|
+
type PersId = {
|
|
1304
|
+
/**
|
|
1305
|
+
* Identifies the set of personalization data that is loaded/saved as one bundle from the front-end server.
|
|
1306
|
+
*/
|
|
1307
|
+
container: string;
|
|
1308
|
+
/**
|
|
1309
|
+
* The name of the object the personalization is applied to.
|
|
1310
|
+
*/
|
|
1311
|
+
item: string;
|
|
1312
|
+
};
|
|
1313
|
+
|
|
1314
|
+
/**
|
|
1315
|
+
* currently the validity property of the scope object is relevant:
|
|
1316
|
+
*/
|
|
1317
|
+
type Scope = {
|
|
1318
|
+
/**
|
|
1319
|
+
* validity of the container persistence in minutes
|
|
1320
|
+
* 0 ( per FLP Window),
|
|
1321
|
+
* Infinity, undefined (front-end server persistence per user )
|
|
1322
|
+
* x Minutes (front-end server persistence per user, ignored if older than x minutes)
|
|
1323
|
+
*/
|
|
1324
|
+
validity?: int;
|
|
1325
|
+
/**
|
|
1326
|
+
* Type or category of key
|
|
1327
|
+
*/
|
|
1328
|
+
keyCategory?: /* was: sap.ushell.services.PersonalizationV2.constants.keyCategory */ any;
|
|
1329
|
+
/**
|
|
1330
|
+
* Expected frequency how often users will use this container to store data inside
|
|
1331
|
+
*/
|
|
1332
|
+
writeFrequency?: /* was: sap.ushell.services.PersonalizationV2.constants.writeFrequency */ any;
|
|
1333
|
+
/**
|
|
1334
|
+
* Defines if storage on client side should be allowed or not
|
|
1335
|
+
*/
|
|
1336
|
+
clientStorageAllowed?: boolean;
|
|
1337
|
+
/**
|
|
1338
|
+
* Indicates the container is intended to be shared across multiple applications
|
|
1339
|
+
*/
|
|
1340
|
+
shared?: boolean;
|
|
1341
|
+
};
|
|
674
1342
|
}
|
|
675
1343
|
|
|
676
1344
|
/**
|
|
@@ -685,6 +1353,9 @@ declare namespace sap {
|
|
|
685
1353
|
constructor();
|
|
686
1354
|
|
|
687
1355
|
/**
|
|
1356
|
+
* @deprecated (since 1.120.0) - Use the "sap.ui/fullWidth" property in the application's manifest.json
|
|
1357
|
+
* instead.
|
|
1358
|
+
*
|
|
688
1359
|
* Sets the application screen size to full width
|
|
689
1360
|
*/
|
|
690
1361
|
setApplicationFullWidth(
|
|
@@ -699,8 +1370,8 @@ declare namespace sap {
|
|
|
699
1370
|
*
|
|
700
1371
|
* The Unified Shell's AppLifeCycle service.
|
|
701
1372
|
*
|
|
702
|
-
* **
|
|
703
|
-
* For details see {@link sap.ushell.services.Container#getServiceAsync}.
|
|
1373
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("AppLifeCycle")`.
|
|
1374
|
+
* For details, see {@link sap.ushell.services.Container#getServiceAsync}.
|
|
704
1375
|
*/
|
|
705
1376
|
class AppLifeCycle {
|
|
706
1377
|
constructor();
|
|
@@ -775,33 +1446,348 @@ declare namespace sap {
|
|
|
775
1446
|
* resolves with an `Object` with properties corresponding to the elements of the `Array` passed as input.
|
|
776
1447
|
* Each of these properties holds its value or undefined if not configured.
|
|
777
1448
|
*
|
|
778
|
-
* **Note:** Return value is only valid after app is loaded. See {@link #attachAppLoaded} for details. Before
|
|
779
|
-
* an app is loaded, `undefined` is returned.
|
|
1449
|
+
* **Note:** Return value is only valid after app is loaded. See {@link #attachAppLoaded} for details. Before
|
|
1450
|
+
* an app is loaded, `undefined` is returned.
|
|
1451
|
+
*
|
|
1452
|
+
* @returns Information object about currently running application or `undefined` if no application is running.
|
|
1453
|
+
*/
|
|
1454
|
+
getCurrentApplication(): object | undefined;
|
|
1455
|
+
}
|
|
1456
|
+
/**
|
|
1457
|
+
* @since 1.15.0
|
|
1458
|
+
* @deprecated (since 1.119) - Please use {@link sap.ushell.services.BookmarkV2} instead.
|
|
1459
|
+
*
|
|
1460
|
+
* The Unified Shell's bookmark service. Allows creating shortcuts on the user's home page.
|
|
1461
|
+
*
|
|
1462
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("Bookmark")`.
|
|
1463
|
+
* For details, see {@link sap.ushell.services.Container#getServiceAsync}.
|
|
1464
|
+
*/
|
|
1465
|
+
class Bookmark {
|
|
1466
|
+
constructor();
|
|
1467
|
+
|
|
1468
|
+
/**
|
|
1469
|
+
* @since 1.15.0
|
|
1470
|
+
* @deprecated (since 1.119) - Please use {@link sap.ushell.services.BookmarkV2#addBookmark} instead.
|
|
1471
|
+
*
|
|
1472
|
+
* Adds a bookmark tile to one of the user's classic home page groups or to multiple provided content nodes.
|
|
1473
|
+
* See:
|
|
1474
|
+
* sap.ushell.services.URLParsing#getShellHash
|
|
1475
|
+
*
|
|
1476
|
+
* @returns A `jQuery.Promise` which resolves on success, but rejects with a reason-message on failure to
|
|
1477
|
+
* add the bookmark to the specified or implied group. The promise gets resolved if personalization is disabled.
|
|
1478
|
+
*/
|
|
1479
|
+
addBookmark(
|
|
1480
|
+
/**
|
|
1481
|
+
* Bookmark parameters. In addition to title and URL, a bookmark might allow further settings, such as an
|
|
1482
|
+
* icon or a subtitle. Which settings are supported depends on the environment in which the application
|
|
1483
|
+
* is running. Unsupported parameters will be ignored.
|
|
1484
|
+
*/
|
|
1485
|
+
oParameters: {
|
|
1486
|
+
/**
|
|
1487
|
+
* The title of the bookmark.
|
|
1488
|
+
*/
|
|
1489
|
+
title: string;
|
|
1490
|
+
/**
|
|
1491
|
+
* The target intent or URL of the bookmark. If the target app runs in the current shell, the URL has to
|
|
1492
|
+
* be a valid intent, i.e. in the format `"#SO-Action?P1=a&P2=x&/route?RPV=1"`.
|
|
1493
|
+
*/
|
|
1494
|
+
url: string;
|
|
1495
|
+
/**
|
|
1496
|
+
* The optional icon URL of the bookmark (e.g. `"sap-icon://home"`).
|
|
1497
|
+
*/
|
|
1498
|
+
icon?: string;
|
|
1499
|
+
/**
|
|
1500
|
+
* The information text of the bookmark.
|
|
1501
|
+
*/
|
|
1502
|
+
info?: string;
|
|
1503
|
+
/**
|
|
1504
|
+
* The subtitle of the bookmark.
|
|
1505
|
+
*/
|
|
1506
|
+
subtitle?: string;
|
|
1507
|
+
/**
|
|
1508
|
+
* The URL to a REST or OData service that provides some dynamic information for the bookmark.
|
|
1509
|
+
*
|
|
1510
|
+
* **Semantic Date Ranges:**
|
|
1511
|
+
*
|
|
1512
|
+
* You can use placeholders for dynamic dates in the query parameters of the service URL. This can be used
|
|
1513
|
+
* to create KPI tiles based on user entries in control {@link sap.m.DynamicDateRange}, where it is possible
|
|
1514
|
+
* to specify dynamic dates like YESTERDAY or THISYEAR.
|
|
1515
|
+
*
|
|
1516
|
+
* The placeholder format looks like this: {Edm.<type>%%DynamicDate.<operator>.<value1>.<value2>.<position>%%}
|
|
1517
|
+
*
|
|
1518
|
+
*
|
|
1519
|
+
* - <type>: The Edm Type of the parameter. Supported types are String, DateTime and DateTimeOffset
|
|
1520
|
+
* for OData V2 and Date and DateTimeOffset for OData V4.
|
|
1521
|
+
* - <operator>, <value1>, <value2>: Possible values are the ones that can be used in
|
|
1522
|
+
* {@link sap.m.DynamicDateRange#toDates} to create a date range.
|
|
1523
|
+
* - <position>: Possible values are 'start' and 'end' which mark the start or end of the interval
|
|
1524
|
+
* specified by the operator.
|
|
1525
|
+
*
|
|
1526
|
+
* Examples:
|
|
1527
|
+
* - /a/url/$count?$filter=(testDate ge {Edm.DateTimeOffset%DynamicDate.YESTERDAY.start%} and testDate
|
|
1528
|
+
* le {Edm.DateTimeOffset%DynamicDate.YESTERDAY.end%})
|
|
1529
|
+
* - /a/url/$count?$filter=(testDate ge {Edm.DateTime%DynamicDate.THISYEAR.start%} and testDate le {Edm.DateTime%DynamicDate.THISYEAR.end%})
|
|
1530
|
+
*
|
|
1531
|
+
* - /a/url/$count?$filter=(testDate ge {Edm.Date%DynamicDate.TODAYFROMTO.1.5.start%} and testDate le
|
|
1532
|
+
* {Edm.Date%DynamicDate.TODAYFROMTO.1.5.end%})
|
|
1533
|
+
*
|
|
1534
|
+
* Hint: Check the debug log when displaying the resulting KPI tiles to get more information about the resolution
|
|
1535
|
+
* of the placeholders.
|
|
1536
|
+
*/
|
|
1537
|
+
serviceUrl?: string;
|
|
1538
|
+
/**
|
|
1539
|
+
* Metadata for parameter serviceUrl. Mandatory to specify if parameter serviceURL contains semantic date
|
|
1540
|
+
* ranges. This does not influence the data source of the app itself.
|
|
1541
|
+
*
|
|
1542
|
+
* Specify the data source as follows:
|
|
1543
|
+
* ```javascript
|
|
1544
|
+
*
|
|
1545
|
+
* {
|
|
1546
|
+
* type: "OData",
|
|
1547
|
+
* settings: {
|
|
1548
|
+
* odataVersion: "4.0"
|
|
1549
|
+
* }
|
|
1550
|
+
* }
|
|
1551
|
+
* ```
|
|
1552
|
+
*
|
|
1553
|
+
*
|
|
1554
|
+
*
|
|
1555
|
+
* type: The type of the serviceURL's service. Only "OData" is supported. odataVersion: The OData version
|
|
1556
|
+
* of parameter serviceURL. Valid values are "2.0" and "4.0".
|
|
1557
|
+
*/
|
|
1558
|
+
dataSource?: object;
|
|
1559
|
+
/**
|
|
1560
|
+
* The refresh interval for the `serviceUrl` in seconds.
|
|
1561
|
+
*/
|
|
1562
|
+
serviceRefreshInterval?: string;
|
|
1563
|
+
/**
|
|
1564
|
+
* The unit for the number retrieved from `serviceUrl`.
|
|
1565
|
+
*/
|
|
1566
|
+
numberUnit?: string;
|
|
1567
|
+
},
|
|
1568
|
+
/**
|
|
1569
|
+
* Either a legacy launchpad home page group, one content node or an array of content nodes (see {@link #getContentNodes}).
|
|
1570
|
+
* If not provided, the bookmark will be added to the default group if spaces mode is not active or to the
|
|
1571
|
+
* default page if spaces mode is active.
|
|
1572
|
+
*/
|
|
1573
|
+
vContainer?:
|
|
1574
|
+
| object
|
|
1575
|
+
| sap.ushell.services.Bookmark.ContentNode
|
|
1576
|
+
| sap.ushell.services.Bookmark.ContentNode[],
|
|
1577
|
+
/**
|
|
1578
|
+
* The contentProviderId or undefined outside the cFLP
|
|
1579
|
+
*/
|
|
1580
|
+
sContentProviderId?: string
|
|
1581
|
+
): jQuery.Promise;
|
|
1582
|
+
/**
|
|
1583
|
+
* @since 1.21.2
|
|
1584
|
+
* @deprecated (since 1.112) - Please use {@link sap.ushell.services.BookmarkV2#addBookmark} instead.
|
|
1585
|
+
*
|
|
1586
|
+
* Adds the catalog tile with the given ID to given group. The catalog tile is looked up in the legacy SAP
|
|
1587
|
+
* HANA catalog unless data to look up a remote catalog is provided.
|
|
1588
|
+
*
|
|
1589
|
+
* @returns A `jQuery.Promise` which informs about success or failure of this asynchronous operation. In
|
|
1590
|
+
* case of success, no further details are passed. In case of failure, an error message is passed. In launchpad
|
|
1591
|
+
* spaces mode the promise gets rejected.
|
|
1592
|
+
*/
|
|
1593
|
+
addCatalogTileToGroup(
|
|
1594
|
+
/**
|
|
1595
|
+
* The ID of the tile within the catalog
|
|
1596
|
+
*/
|
|
1597
|
+
sCatalogTileId: string,
|
|
1598
|
+
/**
|
|
1599
|
+
* The id of the group. If not given, the tile is added to the default group
|
|
1600
|
+
*/
|
|
1601
|
+
sGroupId?: string,
|
|
1602
|
+
/**
|
|
1603
|
+
* The data to identify the catalog containing the tile with the given ID
|
|
1604
|
+
*/
|
|
1605
|
+
oCatalogData?: {
|
|
1606
|
+
/**
|
|
1607
|
+
* The remote catalog's base URL such as "/sap/hba/apps/kpi/s/odata/hana_chip_catalog.xsodata/"
|
|
1608
|
+
*/
|
|
1609
|
+
baseUrl: string;
|
|
1610
|
+
/**
|
|
1611
|
+
* The remote catalog's id on the remote system such as "HANA_CATALOG"
|
|
1612
|
+
*/
|
|
1613
|
+
remoteId: string;
|
|
1614
|
+
}
|
|
1615
|
+
): jQuery.Promise;
|
|
1616
|
+
/**
|
|
1617
|
+
* @since 1.17.1
|
|
1618
|
+
* @deprecated (since 1.119) - Please use {@link sap.ushell.services.BookmarkV2#countBookmarks} instead.
|
|
1619
|
+
*
|
|
1620
|
+
* Counts **all** bookmarks pointing to the given URL from all of the user's pages. You can use this method
|
|
1621
|
+
* to check if a bookmark already exists. This is a potentially asynchronous operation in case the user's
|
|
1622
|
+
* pages have not yet been loaded completely!
|
|
1623
|
+
* See:
|
|
1624
|
+
* #addBookmark
|
|
1625
|
+
*
|
|
1626
|
+
* @returns A `jQuery.Promise` which informs about success or failure of this asynchronous operation. In
|
|
1627
|
+
* case of success, the count of existing bookmarks is provided (which might be zero). In case of failure,
|
|
1628
|
+
* an error message is passed.
|
|
1629
|
+
*/
|
|
1630
|
+
countBookmarks(
|
|
1631
|
+
/**
|
|
1632
|
+
* The URL of the bookmarks to be counted, exactly as specified to {@link #addBookmark}.
|
|
1633
|
+
*/
|
|
1634
|
+
sUrl: string,
|
|
1635
|
+
/**
|
|
1636
|
+
* The Content Provider ID.
|
|
1637
|
+
*/
|
|
1638
|
+
sContentProviderId: string
|
|
1639
|
+
): jQuery.Promise;
|
|
1640
|
+
/**
|
|
1641
|
+
* @since 1.17.1
|
|
1642
|
+
* @deprecated (since 1.119) - Please use {@link sap.ushell.services.BookmarkV2#deleteBookmarks} instead.
|
|
1643
|
+
*
|
|
1644
|
+
* Deletes **all** bookmarks pointing to the given URL from all of the user's pages.
|
|
1645
|
+
* See:
|
|
1646
|
+
* #addBookmark
|
|
1647
|
+
* #countBookmarks
|
|
1648
|
+
*
|
|
1649
|
+
* @returns A `jQuery.Promise` which informs about success or failure of this asynchronous operation. In
|
|
1650
|
+
* case of success, the number of deleted bookmarks is provided (which might be zero). In case of failure,
|
|
1651
|
+
* an error message is passed.
|
|
1652
|
+
*/
|
|
1653
|
+
deleteBookmarks(
|
|
1654
|
+
/**
|
|
1655
|
+
* The URL of the bookmarks to be deleted, exactly as specified to {@link #addBookmark}.
|
|
1656
|
+
*/
|
|
1657
|
+
sUrl: string,
|
|
1658
|
+
/**
|
|
1659
|
+
* The contentProviderId or undefined outside the cFLP
|
|
1660
|
+
*/
|
|
1661
|
+
sContentProviderId?: string
|
|
1662
|
+
): jQuery.Promise;
|
|
1663
|
+
/**
|
|
1664
|
+
* @since 1.81
|
|
1665
|
+
* @deprecated (since 1.119) - Please use {@link sap.ushell.services.BookmarkV2#getContentNodes} instead.
|
|
1666
|
+
*
|
|
1667
|
+
* Returns available content nodes based on the current launchpad context. (Classic home page, spaces mode)
|
|
1668
|
+
*
|
|
1669
|
+
* A content node may be:
|
|
1670
|
+
* - a classic home page group
|
|
1671
|
+
* - an unselectable node (space) or a selectable node (page) in spaces mode
|
|
1672
|
+
* - or any other containers in the future
|
|
1673
|
+
*
|
|
1674
|
+
* It has the following properties:
|
|
1675
|
+
* - id: ID of the content node
|
|
1676
|
+
* - label: Human-readable representation of a content node which can be displayed in a control
|
|
1677
|
+
* - type: Specifies the content node type. E.g: space, page, group, etc. See {@link sap.ushell.ContentNodeType }
|
|
1678
|
+
*
|
|
1679
|
+
* - isContainer: Specifies if a bookmark can be added
|
|
1680
|
+
* - children: Specifies sub-nodes
|
|
1681
|
+
*
|
|
1682
|
+
* @returns Promise resolving the currently available content nodes.
|
|
1683
|
+
*/
|
|
1684
|
+
getContentNodes(): Promise<sap.ushell.services.Bookmark.ContentNode[]>;
|
|
1685
|
+
/**
|
|
1686
|
+
* @since 1.17.1
|
|
1687
|
+
* @deprecated (since 1.119) - Please use {@link sap.ushell.services.BookmarkV2#updateBookmarks} instead.
|
|
780
1688
|
*
|
|
781
|
-
*
|
|
1689
|
+
* Updates **all** bookmarks pointing to the given URL on all of the user's pages with the given new parameters.
|
|
1690
|
+
* Parameters which are omitted are not changed in the existing bookmarks.
|
|
1691
|
+
* See:
|
|
1692
|
+
* #addBookmark
|
|
1693
|
+
* #countBookmarks
|
|
1694
|
+
* #deleteBookmarks
|
|
1695
|
+
*
|
|
1696
|
+
* @returns A `jQuery.Promise` which informs about success or failure of this asynchronous operation. In
|
|
1697
|
+
* case of success, the number of updated bookmarks is provided (which might be zero). In case of failure,
|
|
1698
|
+
* an error message is passed.
|
|
782
1699
|
*/
|
|
783
|
-
|
|
1700
|
+
updateBookmarks(
|
|
1701
|
+
/**
|
|
1702
|
+
* The URL of the bookmarks to be updated, exactly as specified to {@link #addBookmark}. In case you need
|
|
1703
|
+
* to update the URL itself, pass the old one here and the new one as `oParameters.url`!
|
|
1704
|
+
*/
|
|
1705
|
+
sUrl: string,
|
|
1706
|
+
/**
|
|
1707
|
+
* Bookmark parameters. In addition to title and URL, a bookmark might allow additional settings, such as
|
|
1708
|
+
* an icon or a subtitle. Which settings are supported depends on the environment in which the application
|
|
1709
|
+
* is running. Unsupported parameters will be ignored.
|
|
1710
|
+
*/
|
|
1711
|
+
oParameters: {
|
|
1712
|
+
/**
|
|
1713
|
+
* The title of the bookmark.
|
|
1714
|
+
*/
|
|
1715
|
+
title: string;
|
|
1716
|
+
/**
|
|
1717
|
+
* The target URL or intent of the bookmark. If the target application shall run in the current shell, the
|
|
1718
|
+
* URL has to be a valid intent, i.e. in the format like `"#SO-Action?P1=a&P2=x&/route?RPV=1"`.
|
|
1719
|
+
*/
|
|
1720
|
+
url: string;
|
|
1721
|
+
/**
|
|
1722
|
+
* The optional icon URL of the bookmark (e.g. `"sap-icon://home"`).
|
|
1723
|
+
*/
|
|
1724
|
+
icon?: string;
|
|
1725
|
+
/**
|
|
1726
|
+
* The information text of the bookmark.
|
|
1727
|
+
*/
|
|
1728
|
+
info?: string;
|
|
1729
|
+
/**
|
|
1730
|
+
* The subtitle of the bookmark.
|
|
1731
|
+
*/
|
|
1732
|
+
subtitle?: string;
|
|
1733
|
+
/**
|
|
1734
|
+
* The URL to a REST or OData service that provides some dynamic information for the bookmark.
|
|
1735
|
+
*/
|
|
1736
|
+
serviceUrl?: string;
|
|
1737
|
+
/**
|
|
1738
|
+
* Metadata for parameter serviceUrl. Mandatory to specify if parameter serviceURL contains semantic date
|
|
1739
|
+
* ranges. This does not influence the data source of the app itself.
|
|
1740
|
+
*/
|
|
1741
|
+
dataSource?: {
|
|
1742
|
+
/**
|
|
1743
|
+
* The type of the serviceURL's service. Only "OData" is supported.
|
|
1744
|
+
*/
|
|
1745
|
+
type?: string;
|
|
1746
|
+
/**
|
|
1747
|
+
* Additional settings for the data source.
|
|
1748
|
+
*/
|
|
1749
|
+
settings?: {
|
|
1750
|
+
/**
|
|
1751
|
+
* The OData version of parameter serviceURL. Valid values are "2.0" and "4.0".
|
|
1752
|
+
*/
|
|
1753
|
+
odataVersion?: object;
|
|
1754
|
+
};
|
|
1755
|
+
};
|
|
1756
|
+
/**
|
|
1757
|
+
* The refresh interval for the `serviceUrl` in seconds.
|
|
1758
|
+
*/
|
|
1759
|
+
serviceRefreshInterval?: string;
|
|
1760
|
+
/**
|
|
1761
|
+
* The unit for the number retrieved from `serviceUrl`.
|
|
1762
|
+
*/
|
|
1763
|
+
numberUnit?: string;
|
|
1764
|
+
},
|
|
1765
|
+
/**
|
|
1766
|
+
* The contentProviderId or undefined outside the cFLP
|
|
1767
|
+
*/
|
|
1768
|
+
sContentProviderId?: string
|
|
1769
|
+
): jQuery.Promise;
|
|
784
1770
|
}
|
|
785
1771
|
/**
|
|
786
|
-
* @since 1.
|
|
1772
|
+
* @since 1.119.0
|
|
787
1773
|
*
|
|
788
|
-
* The Unified Shell's bookmark service
|
|
1774
|
+
* The Unified Shell's bookmark service. Allows creating shortcuts on the user's home page.
|
|
789
1775
|
*
|
|
790
|
-
* **
|
|
791
|
-
* For details see {@link sap.ushell.services.Container#getServiceAsync}.
|
|
1776
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("BookmarkV2")`.
|
|
1777
|
+
* For details, see {@link sap.ushell.services.Container#getServiceAsync}.
|
|
792
1778
|
*/
|
|
793
|
-
class
|
|
1779
|
+
class BookmarkV2 {
|
|
794
1780
|
constructor();
|
|
795
1781
|
|
|
796
1782
|
/**
|
|
797
|
-
* @since 1.
|
|
1783
|
+
* @since 1.119.0
|
|
798
1784
|
*
|
|
799
1785
|
* Adds a bookmark tile to one of the user's classic home page groups or to multiple provided content nodes.
|
|
800
1786
|
* See:
|
|
801
1787
|
* sap.ushell.services.URLParsing#getShellHash
|
|
802
1788
|
*
|
|
803
|
-
* @returns A `
|
|
804
|
-
*
|
|
1789
|
+
* @returns A `Promise` which resolves on success, but rejects with a reason-message on failure to add the
|
|
1790
|
+
* bookmark to the specified or implied group. The promise gets resolved if personalization is disabled.
|
|
805
1791
|
*/
|
|
806
1792
|
addBookmark(
|
|
807
1793
|
/**
|
|
@@ -899,49 +1885,15 @@ declare namespace sap {
|
|
|
899
1885
|
*/
|
|
900
1886
|
vContainer?:
|
|
901
1887
|
| object
|
|
902
|
-
| sap.ushell.services.
|
|
903
|
-
| sap.ushell.services.
|
|
1888
|
+
| sap.ushell.services.BookmarkV2.ContentNode
|
|
1889
|
+
| sap.ushell.services.BookmarkV2.ContentNode[],
|
|
904
1890
|
/**
|
|
905
1891
|
* The contentProviderId or undefined outside the cFLP
|
|
906
1892
|
*/
|
|
907
1893
|
sContentProviderId?: string
|
|
908
|
-
):
|
|
909
|
-
/**
|
|
910
|
-
* @since 1.21.2
|
|
911
|
-
* @deprecated (since 1.112) - Please use {@link #addBookmark} instead.
|
|
912
|
-
*
|
|
913
|
-
* Adds the catalog tile with the given ID to given group. The catalog tile is looked up in the legacy SAP
|
|
914
|
-
* HANA catalog unless data to look up a remote catalog is provided.
|
|
915
|
-
*
|
|
916
|
-
* @returns A `jQuery.Promise` which informs about success or failure of this asynchronous operation. In
|
|
917
|
-
* case of success, no further details are passed. In case of failure, an error message is passed. In launchpad
|
|
918
|
-
* spaces mode the promise gets rejected.
|
|
919
|
-
*/
|
|
920
|
-
addCatalogTileToGroup(
|
|
921
|
-
/**
|
|
922
|
-
* The ID of the tile within the catalog
|
|
923
|
-
*/
|
|
924
|
-
sCatalogTileId: string,
|
|
925
|
-
/**
|
|
926
|
-
* The id of the group. If not given, the tile is added to the default group
|
|
927
|
-
*/
|
|
928
|
-
sGroupId?: string,
|
|
929
|
-
/**
|
|
930
|
-
* The data to identify the catalog containing the tile with the given ID
|
|
931
|
-
*/
|
|
932
|
-
oCatalogData?: {
|
|
933
|
-
/**
|
|
934
|
-
* The remote catalog's base URL such as "/sap/hba/apps/kpi/s/odata/hana_chip_catalog.xsodata/"
|
|
935
|
-
*/
|
|
936
|
-
baseUrl: string;
|
|
937
|
-
/**
|
|
938
|
-
* The remote catalog's id on the remote system such as "HANA_CATALOG"
|
|
939
|
-
*/
|
|
940
|
-
remoteId: string;
|
|
941
|
-
}
|
|
942
|
-
): jQuery.Promise;
|
|
1894
|
+
): Promise<any>;
|
|
943
1895
|
/**
|
|
944
|
-
* @since 1.
|
|
1896
|
+
* @since 1.119.0
|
|
945
1897
|
*
|
|
946
1898
|
* Counts **all** bookmarks pointing to the given URL from all of the user's pages. You can use this method
|
|
947
1899
|
* to check if a bookmark already exists. This is a potentially asynchronous operation in case the user's
|
|
@@ -949,9 +1901,9 @@ declare namespace sap {
|
|
|
949
1901
|
* See:
|
|
950
1902
|
* #addBookmark
|
|
951
1903
|
*
|
|
952
|
-
* @returns A `
|
|
953
|
-
*
|
|
954
|
-
*
|
|
1904
|
+
* @returns A `Promise` which informs about success or failure of this asynchronous operation. In case of
|
|
1905
|
+
* success, the count of existing bookmarks is provided (which might be zero). In case of failure, an error
|
|
1906
|
+
* message is passed.
|
|
955
1907
|
*/
|
|
956
1908
|
countBookmarks(
|
|
957
1909
|
/**
|
|
@@ -962,18 +1914,18 @@ declare namespace sap {
|
|
|
962
1914
|
* The Content Provider ID.
|
|
963
1915
|
*/
|
|
964
1916
|
sContentProviderId: string
|
|
965
|
-
):
|
|
1917
|
+
): Promise<any>;
|
|
966
1918
|
/**
|
|
967
|
-
* @since 1.
|
|
1919
|
+
* @since 1.119.0
|
|
968
1920
|
*
|
|
969
1921
|
* Deletes **all** bookmarks pointing to the given URL from all of the user's pages.
|
|
970
1922
|
* See:
|
|
971
1923
|
* #addBookmark
|
|
972
1924
|
* #countBookmarks
|
|
973
1925
|
*
|
|
974
|
-
* @returns A `
|
|
975
|
-
*
|
|
976
|
-
*
|
|
1926
|
+
* @returns A `Promise` which informs about success or failure of this asynchronous operation. In case of
|
|
1927
|
+
* success, the number of deleted bookmarks is provided (which might be zero). In case of failure, an error
|
|
1928
|
+
* message is passed.
|
|
977
1929
|
*/
|
|
978
1930
|
deleteBookmarks(
|
|
979
1931
|
/**
|
|
@@ -984,9 +1936,9 @@ declare namespace sap {
|
|
|
984
1936
|
* The contentProviderId or undefined outside the cFLP
|
|
985
1937
|
*/
|
|
986
1938
|
sContentProviderId?: string
|
|
987
|
-
):
|
|
1939
|
+
): Promise<any>;
|
|
988
1940
|
/**
|
|
989
|
-
* @since 1.
|
|
1941
|
+
* @since 1.119.0
|
|
990
1942
|
*
|
|
991
1943
|
* Returns available content nodes based on the current launchpad context. (Classic home page, spaces mode)
|
|
992
1944
|
*
|
|
@@ -1005,9 +1957,11 @@ declare namespace sap {
|
|
|
1005
1957
|
*
|
|
1006
1958
|
* @returns Promise resolving the currently available content nodes.
|
|
1007
1959
|
*/
|
|
1008
|
-
getContentNodes(): Promise<
|
|
1960
|
+
getContentNodes(): Promise<
|
|
1961
|
+
sap.ushell.services.BookmarkV2.ContentNode[]
|
|
1962
|
+
>;
|
|
1009
1963
|
/**
|
|
1010
|
-
* @since 1.
|
|
1964
|
+
* @since 1.119.0
|
|
1011
1965
|
*
|
|
1012
1966
|
* Updates **all** bookmarks pointing to the given URL on all of the user's pages with the given new parameters.
|
|
1013
1967
|
* Parameters which are omitted are not changed in the existing bookmarks.
|
|
@@ -1016,9 +1970,9 @@ declare namespace sap {
|
|
|
1016
1970
|
* #countBookmarks
|
|
1017
1971
|
* #deleteBookmarks
|
|
1018
1972
|
*
|
|
1019
|
-
* @returns A `
|
|
1020
|
-
*
|
|
1021
|
-
*
|
|
1973
|
+
* @returns A `Promise` which informs about success or failure of this asynchronous operation. In case of
|
|
1974
|
+
* success, the number of updated bookmarks is provided (which might be zero). In case of failure, an error
|
|
1975
|
+
* message is passed.
|
|
1022
1976
|
*/
|
|
1023
1977
|
updateBookmarks(
|
|
1024
1978
|
/**
|
|
@@ -1089,29 +2043,27 @@ declare namespace sap {
|
|
|
1089
2043
|
* The contentProviderId or undefined outside the cFLP
|
|
1090
2044
|
*/
|
|
1091
2045
|
sContentProviderId?: string
|
|
1092
|
-
):
|
|
2046
|
+
): Promise<any>;
|
|
1093
2047
|
}
|
|
1094
2048
|
/**
|
|
1095
2049
|
* @since 1.64.0
|
|
1096
2050
|
*
|
|
1097
|
-
* The unified shell's Configuration service
|
|
1098
|
-
*
|
|
2051
|
+
* The unified shell's Configuration service. Allows attaching to **selected** launchpad configuration settings
|
|
2052
|
+
* and their value changes.
|
|
2053
|
+
*
|
|
2054
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("Configuration")`.
|
|
2055
|
+
* For details, see {@link sap.ushell.services.Container#getServiceAsync}.
|
|
1099
2056
|
*/
|
|
1100
2057
|
class Configuration {
|
|
1101
|
-
/**
|
|
1102
|
-
* This method MUST be called by the Unified Shell's container only, others MUST call `sap.ushell.Container.getServiceAsync("Configuration").then(function
|
|
1103
|
-
* (Configuration) {});`. Constructs a new Configuration service.
|
|
1104
|
-
* See:
|
|
1105
|
-
* sap.ushell.services.Container#getServiceAsync
|
|
1106
|
-
*/
|
|
1107
2058
|
constructor();
|
|
1108
2059
|
}
|
|
1109
2060
|
/**
|
|
1110
2061
|
* @since 1.15.0
|
|
2062
|
+
* @deprecated (since 1.120) - Please use {@link sap.ushell.services.Navigation} instead
|
|
1111
2063
|
*
|
|
1112
|
-
* The Unified Shell's CrossApplicationNavigation service
|
|
1113
|
-
* of the currently running app (but still in scope of the current Fiori launchpad) or create links to
|
|
1114
|
-
* external targets.
|
|
2064
|
+
* The Unified Shell's CrossApplicationNavigation service. Allows navigating to "external" targets outside
|
|
2065
|
+
* of the currently running app (but still in scope of the current Fiori launchpad) or to create links to
|
|
2066
|
+
* such external targets.
|
|
1115
2067
|
*
|
|
1116
2068
|
* To use the CrossApplicationNavigation service you can retrieve an instance via ushell's Container:
|
|
1117
2069
|
* ```javascript
|
|
@@ -1178,9 +2130,9 @@ declare namespace sap {
|
|
|
1178
2130
|
* A navigation to the Fiori launchpad Home is performed when this method is called on a first navigation.
|
|
1179
2131
|
* In all other cases, this function simply performs a browser back navigation.
|
|
1180
2132
|
*
|
|
1181
|
-
*
|
|
1182
|
-
*
|
|
1183
|
-
*
|
|
2133
|
+
* Note that the behavior of this method is subject to change and therefore it may not yield to the expected
|
|
2134
|
+
* results especially on mobile devices where "back" is the previous inner-app state if these are put into
|
|
2135
|
+
* the history!
|
|
1184
2136
|
*
|
|
1185
2137
|
* @returns A promise which resolves once the back navigation was triggered
|
|
1186
2138
|
*/
|
|
@@ -1319,8 +2271,8 @@ declare namespace sap {
|
|
|
1319
2271
|
*
|
|
1320
2272
|
* Besides 'value', supported search options for the extended format are:
|
|
1321
2273
|
* **required**: whether the parameter must be required (true) or not required (false) in the signature
|
|
1322
|
-
* of the matching target (once the navigation occurs to the returned link).
|
|
1323
|
-
*
|
|
2274
|
+
* of the matching target (once the navigation occurs to the returned link). Note that this option will
|
|
2275
|
+
* be effective if the Fiori Launchpad is configured to resolve navigation targets via `sap.ushell.services.ClientSideTargetResolution`
|
|
1324
2276
|
* and therefore may not be supported in all platforms.
|
|
1325
2277
|
*
|
|
1326
2278
|
* Example:
|
|
@@ -2172,7 +3124,7 @@ declare namespace sap {
|
|
|
2172
3124
|
* @deprecated (since 1.93)
|
|
2173
3125
|
*
|
|
2174
3126
|
* The Unified Shell's end user feedback service. This service is deprecated and does nothing. End user
|
|
2175
|
-
* feedback functionality
|
|
3127
|
+
* feedback functionality is not part of the ushell library.
|
|
2176
3128
|
*/
|
|
2177
3129
|
class EndUserFeedback {
|
|
2178
3130
|
/**
|
|
@@ -2188,27 +3140,204 @@ declare namespace sap {
|
|
|
2188
3140
|
* @deprecated (since 1.93)
|
|
2189
3141
|
*
|
|
2190
3142
|
*
|
|
2191
|
-
* @returns Empty string
|
|
3143
|
+
* @returns Empty string
|
|
3144
|
+
*/
|
|
3145
|
+
getLegalText(): string;
|
|
3146
|
+
/**
|
|
3147
|
+
* @since 1.25.1
|
|
3148
|
+
* @deprecated (since 1.93)
|
|
3149
|
+
*
|
|
3150
|
+
* The service is deprecated. The function always returns a negative answer.
|
|
3151
|
+
*
|
|
3152
|
+
* @returns Rejected promise
|
|
3153
|
+
*/
|
|
3154
|
+
isEnabled(): object;
|
|
3155
|
+
/**
|
|
3156
|
+
* @since 1.25.1
|
|
3157
|
+
* @deprecated (since 1.93)
|
|
3158
|
+
*
|
|
3159
|
+
* Sends a feedback.
|
|
3160
|
+
*
|
|
3161
|
+
* @returns Empty promise
|
|
3162
|
+
*/
|
|
3163
|
+
sendFeedback(): Promise<any>;
|
|
3164
|
+
}
|
|
3165
|
+
/**
|
|
3166
|
+
* @since 1.120.0
|
|
3167
|
+
* @experimental (since 1.120.0) - Restriction: API calls might be ignored for apps running in an iframe
|
|
3168
|
+
*
|
|
3169
|
+
* The Unified Shell's Extension service. Allows adding extensions on the user's home page.
|
|
3170
|
+
*
|
|
3171
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("Extension")`.
|
|
3172
|
+
* For details, see {@link sap.ushell.services.Container#getServiceAsync}.
|
|
3173
|
+
*
|
|
3174
|
+
*
|
|
3175
|
+
* All extension items and extension areas are instantiated as invisible. You have to call .show<...> to
|
|
3176
|
+
* make them visible.
|
|
3177
|
+
*/
|
|
3178
|
+
class Extension {
|
|
3179
|
+
constructor();
|
|
3180
|
+
|
|
3181
|
+
/**
|
|
3182
|
+
* @since 1.120.0
|
|
3183
|
+
*
|
|
3184
|
+
* Adds an entry to the user settings dialog box including the UI control that appears when the user clicks
|
|
3185
|
+
* the new entry, and handling of user settings actions such as SAVE and CANCEL. **Restriction:** Might
|
|
3186
|
+
* be ignored for apps running in an iframe
|
|
3187
|
+
*
|
|
3188
|
+
* @returns Resolves once the settings entry was added.
|
|
3189
|
+
*/
|
|
3190
|
+
addUserSettingsEntry(
|
|
3191
|
+
/**
|
|
3192
|
+
* The data of the new added user settings entry.
|
|
3193
|
+
*/
|
|
3194
|
+
properties: {
|
|
3195
|
+
/**
|
|
3196
|
+
* The ID of the object.
|
|
3197
|
+
*/
|
|
3198
|
+
entryHelpID?: string;
|
|
3199
|
+
/**
|
|
3200
|
+
* The title of the entry to be presented in the list in the user settings dialog box. We recommend using
|
|
3201
|
+
* a string from the translation bundle.
|
|
3202
|
+
*/
|
|
3203
|
+
title: string;
|
|
3204
|
+
/**
|
|
3205
|
+
* A string to be presented as the sub title of the entry OR a function which resolves the sub title.
|
|
3206
|
+
*/
|
|
3207
|
+
value: string | Function;
|
|
3208
|
+
/**
|
|
3209
|
+
* A function that resolves the content which has to be a {@link sap.ui.core.Control}. A SAPUI5 view instance
|
|
3210
|
+
* can also be returned. The result will be displayed in the settings as content for this entry.
|
|
3211
|
+
*/
|
|
3212
|
+
content: Function;
|
|
3213
|
+
/**
|
|
3214
|
+
* A callback which is called when the user clicks "save" in the user settings dialog. The function has
|
|
3215
|
+
* to return a native promise. If an error occurs, pass the error message via rejected promise. Errors are
|
|
3216
|
+
* displayed in the common log.
|
|
3217
|
+
*/
|
|
3218
|
+
onSave: Function;
|
|
3219
|
+
/**
|
|
3220
|
+
* A callback which is called when the user closes the user settings dialog without saving any changes.
|
|
3221
|
+
*/
|
|
3222
|
+
onCancel: Function;
|
|
3223
|
+
/**
|
|
3224
|
+
* Set this value to `true` if you want that your content is displayed without the standard header.
|
|
3225
|
+
*/
|
|
3226
|
+
provideEmptyWrapper?: boolean;
|
|
3227
|
+
}
|
|
3228
|
+
): Promise<any>;
|
|
3229
|
+
/**
|
|
3230
|
+
* @since 1.120.0
|
|
3231
|
+
*
|
|
3232
|
+
* Creates a new footer which is positioned below the launchpad content.
|
|
3233
|
+
*
|
|
3234
|
+
* **Note:** Only one footer is displayed at once. Any new footer will replace the previous one **Restriction:**
|
|
3235
|
+
* Might be ignored for apps running in an iframe
|
|
3236
|
+
*
|
|
3237
|
+
* @returns The newly created footer.
|
|
3238
|
+
*/
|
|
3239
|
+
createFooter(
|
|
3240
|
+
/**
|
|
3241
|
+
* The properties that will be passed to the created control.
|
|
3242
|
+
*/
|
|
3243
|
+
controlProperties: object,
|
|
3244
|
+
/**
|
|
3245
|
+
* Additional parameters.
|
|
3246
|
+
*/
|
|
3247
|
+
parameters?: {
|
|
3248
|
+
/**
|
|
3249
|
+
* Defines the `controlType`.
|
|
3250
|
+
*/
|
|
3251
|
+
controlType?: string;
|
|
3252
|
+
}
|
|
3253
|
+
): Promise<sap.ushell.services.Extension.Footer>;
|
|
3254
|
+
/**
|
|
3255
|
+
* @since 1.120.0
|
|
3256
|
+
*
|
|
3257
|
+
* Creates a header item in the shell header.
|
|
3258
|
+
*
|
|
3259
|
+
* @returns The newly created header item.
|
|
3260
|
+
*/
|
|
3261
|
+
createHeaderItem(
|
|
3262
|
+
/**
|
|
3263
|
+
* The properties that will be passed to the created control.
|
|
3264
|
+
*/
|
|
3265
|
+
controlProperties: object,
|
|
3266
|
+
/**
|
|
3267
|
+
* Additional parameters.
|
|
3268
|
+
*/
|
|
3269
|
+
parameters?: {
|
|
3270
|
+
/**
|
|
3271
|
+
* Possible values are `begin` and `end`.
|
|
3272
|
+
*/
|
|
3273
|
+
position?: string;
|
|
3274
|
+
}
|
|
3275
|
+
): Promise<sap.ushell.services.Extension.Item>;
|
|
3276
|
+
/**
|
|
3277
|
+
* @since 1.120.0
|
|
3278
|
+
*
|
|
3279
|
+
* Creates a new sub header which is positioned below the header.
|
|
3280
|
+
*
|
|
3281
|
+
* **Note:** Only one sub header is displayed at once **Restriction:** Might be ignored for apps
|
|
3282
|
+
* running in an iframe
|
|
3283
|
+
*
|
|
3284
|
+
* @returns The newly created sub header.
|
|
3285
|
+
*/
|
|
3286
|
+
createSubHeader(
|
|
3287
|
+
/**
|
|
3288
|
+
* The properties that will be passed to the created control.
|
|
3289
|
+
*/
|
|
3290
|
+
controlProperties: object,
|
|
3291
|
+
/**
|
|
3292
|
+
* Additional parameters.
|
|
3293
|
+
*/
|
|
3294
|
+
parameters?: {
|
|
3295
|
+
/**
|
|
3296
|
+
* Defines the `controlType`.
|
|
3297
|
+
*/
|
|
3298
|
+
controlType?: string;
|
|
3299
|
+
}
|
|
3300
|
+
): Promise<sap.ushell.services.Extension.Item>;
|
|
3301
|
+
/**
|
|
3302
|
+
* @since 1.120.0
|
|
3303
|
+
*
|
|
3304
|
+
* Creates a user action in the user action menu.
|
|
3305
|
+
*
|
|
3306
|
+
* @returns The newly created user action.
|
|
2192
3307
|
*/
|
|
2193
|
-
|
|
3308
|
+
createUserAction(
|
|
3309
|
+
/**
|
|
3310
|
+
* The properties that will be passed to the created control.
|
|
3311
|
+
*/
|
|
3312
|
+
controlProperties: object,
|
|
3313
|
+
/**
|
|
3314
|
+
* Additional parameters.
|
|
3315
|
+
*/
|
|
3316
|
+
parameters?: {
|
|
3317
|
+
/**
|
|
3318
|
+
* Defines the `controlType`.
|
|
3319
|
+
*/
|
|
3320
|
+
controlType?: string;
|
|
3321
|
+
}
|
|
3322
|
+
): Promise<sap.ushell.services.Extension.Item>;
|
|
2194
3323
|
/**
|
|
2195
|
-
* @since 1.
|
|
2196
|
-
* @deprecated (since 1.93)
|
|
3324
|
+
* @since 1.120.0
|
|
2197
3325
|
*
|
|
2198
|
-
*
|
|
3326
|
+
* Returns the API for the SidePane which is located next to the launchpad content. **Restriction:**
|
|
3327
|
+
* Might be ignored for apps running in an iframe
|
|
2199
3328
|
*
|
|
2200
|
-
* @returns
|
|
3329
|
+
* @returns The SidePane.
|
|
2201
3330
|
*/
|
|
2202
|
-
|
|
3331
|
+
getSidePane(): Promise<sap.ushell.services.Extension.SidePane>;
|
|
2203
3332
|
/**
|
|
2204
|
-
* @since 1.
|
|
2205
|
-
* @deprecated (since 1.93)
|
|
3333
|
+
* @since 1.120.0
|
|
2206
3334
|
*
|
|
2207
|
-
*
|
|
3335
|
+
* Returns the API for the ToolArea which is located next to the launchpad content. **Restriction:**
|
|
3336
|
+
* Might be ignored for apps running in an iframe
|
|
2208
3337
|
*
|
|
2209
|
-
* @returns
|
|
3338
|
+
* @returns The ToolArea.
|
|
2210
3339
|
*/
|
|
2211
|
-
|
|
3340
|
+
getToolArea(): Promise<sap.ushell.services.Extension.ToolArea>;
|
|
2212
3341
|
}
|
|
2213
3342
|
/**
|
|
2214
3343
|
* @since 1.15.0
|
|
@@ -2939,16 +4068,13 @@ declare namespace sap {
|
|
|
2939
4068
|
}
|
|
2940
4069
|
/**
|
|
2941
4070
|
* @since 1.16.0
|
|
4071
|
+
*
|
|
4072
|
+
* Message service.
|
|
4073
|
+
*
|
|
4074
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("Message")`.
|
|
4075
|
+
* For details, see {@link sap.ushell.services.Container#getServiceAsync}.
|
|
2942
4076
|
*/
|
|
2943
4077
|
class Message {
|
|
2944
|
-
/**
|
|
2945
|
-
* This method MUST be called by the Unified Shell's container only, others MUST call `sap.ushell.Container.getServiceAsync("Message")`.
|
|
2946
|
-
* Constructs a new instance of the page builder service.
|
|
2947
|
-
*
|
|
2948
|
-
* Message service.
|
|
2949
|
-
* See:
|
|
2950
|
-
* sap.ushell.services.Container#getServiceAsync
|
|
2951
|
-
*/
|
|
2952
4078
|
constructor();
|
|
2953
4079
|
|
|
2954
4080
|
/**
|
|
@@ -3049,19 +4175,13 @@ declare namespace sap {
|
|
|
3049
4175
|
): void;
|
|
3050
4176
|
}
|
|
3051
4177
|
/**
|
|
3052
|
-
* @since 1.
|
|
3053
|
-
*
|
|
3054
|
-
* The Unified Shell's Navigation service allows to navigate to "external" targets outside of the currently
|
|
3055
|
-
* running app (but still in scope of the current Fiori launchpad) or create links to such external targets.
|
|
4178
|
+
* @since 1.120.0
|
|
3056
4179
|
*
|
|
3057
|
-
*
|
|
3058
|
-
*
|
|
3059
|
-
*
|
|
3060
|
-
* sap.ui.require(["sap/ushell/Container"], async () => {
|
|
3061
|
-
* const oNavigationService = await Container.getServiceAsync("Navigation");
|
|
3062
|
-
* // Use the Navigation service
|
|
3063
|
-
* ```
|
|
4180
|
+
* The Unified Shell's Navigation service. Allows navigating to "external" targets outside of the currently
|
|
4181
|
+
* running app (but still in scope of the current Fiori launchpad) or to create links to such external targets.
|
|
3064
4182
|
*
|
|
4183
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("Navigation")`.
|
|
4184
|
+
* For details, see {@link sap.ushell.services.Container#getServiceAsync}.
|
|
3065
4185
|
*
|
|
3066
4186
|
* The Navigation service currently provides platform independent functionality.
|
|
3067
4187
|
*
|
|
@@ -3070,7 +4190,7 @@ declare namespace sap {
|
|
|
3070
4190
|
* Usage:
|
|
3071
4191
|
* ```javascript
|
|
3072
4192
|
*
|
|
3073
|
-
* sap.ui.require(["sap/ushell/Container"], async () => {
|
|
4193
|
+
* sap.ui.require(["sap/ushell/Container"], async (Container) => {
|
|
3074
4194
|
* const oNavigationService = await Container.getServiceAsync("Navigation");
|
|
3075
4195
|
* const sHref = await oNavigationService.getHref({
|
|
3076
4196
|
* target : {
|
|
@@ -3083,7 +4203,7 @@ declare namespace sap {
|
|
|
3083
4203
|
* }, oComponent);
|
|
3084
4204
|
* // do something with the resolved sHref.
|
|
3085
4205
|
* });
|
|
3086
|
-
*
|
|
4206
|
+
* ```
|
|
3087
4207
|
*
|
|
3088
4208
|
*
|
|
3089
4209
|
* Parameter names and values are case sensitive.
|
|
@@ -3113,22 +4233,22 @@ declare namespace sap {
|
|
|
3113
4233
|
constructor();
|
|
3114
4234
|
|
|
3115
4235
|
/**
|
|
3116
|
-
* @since 1.
|
|
4236
|
+
* @since 1.120.0
|
|
3117
4237
|
*
|
|
3118
4238
|
* Attempts to use the browser history to navigate to the previous app.
|
|
3119
4239
|
*
|
|
3120
4240
|
* A navigation to the Fiori launchpad Home is performed when this method is called on a first navigation.
|
|
3121
4241
|
* In all other cases, this function simply performs a browser back navigation.
|
|
3122
4242
|
*
|
|
3123
|
-
*
|
|
3124
|
-
*
|
|
3125
|
-
*
|
|
4243
|
+
* Note that the behavior of this method is subject to change and therefore it may not yield to the expected
|
|
4244
|
+
* results especially on mobile devices where "back" is the previous inner-app state if these are put into
|
|
4245
|
+
* the history!
|
|
3126
4246
|
*
|
|
3127
4247
|
* @returns A promise which resolves once the back navigation was triggered
|
|
3128
4248
|
*/
|
|
3129
4249
|
backToPreviousApp(): Promise<any>;
|
|
3130
4250
|
/**
|
|
3131
|
-
* @since 1.
|
|
4251
|
+
* @since 1.120.0
|
|
3132
4252
|
*
|
|
3133
4253
|
* Returns a promise resolving to a URL that launches an app with certain parameters. This API can be used
|
|
3134
4254
|
* to convert the internal shell hash format into the URL format for use in link tags. The resulting href
|
|
@@ -3137,7 +4257,7 @@ declare namespace sap {
|
|
|
3137
4257
|
*
|
|
3138
4258
|
* ```javascript
|
|
3139
4259
|
*
|
|
3140
|
-
* sap.ui.require(["sap/ushell/Container"], async () => {
|
|
4260
|
+
* sap.ui.require(["sap/ushell/Container"], async (Container) => {
|
|
3141
4261
|
* const oNavigationService = await Container.getServiceAsync("Navigation");
|
|
3142
4262
|
* const sHref = await oNavigationService.getHref({
|
|
3143
4263
|
* target: { shellHash: oLink.intent }
|
|
@@ -3159,23 +4279,25 @@ declare namespace sap {
|
|
|
3159
4279
|
* Using the arguments as in the example above, a link with a sap-xapp-state parameter that encodes the
|
|
3160
4280
|
* provided data is returned. The sap-xapp-state-data parameter does not appear in the generated link.
|
|
3161
4281
|
*
|
|
3162
|
-
* Do **not** use "#Shell-home" to navigate to a specific homepage!
|
|
3163
|
-
* a link to return to the home page of the Fiori launchpad
|
|
4282
|
+
* Do **not** use "#Shell-home" to navigate to a specific homepage!
|
|
4283
|
+
* A proper way for an application to generate a link to return to the home page of the Fiori launchpad
|
|
4284
|
+
* is:
|
|
4285
|
+
* `getHref( { target : { shellHash : "#" }})`
|
|
3164
4286
|
*
|
|
3165
4287
|
* @returns A Promise resolving the encoded href.
|
|
3166
4288
|
*/
|
|
3167
4289
|
getHref(
|
|
3168
4290
|
/**
|
|
3169
|
-
* The navigation target to transform.
|
|
4291
|
+
* The navigation target to transform. When omitted the current hash is used as basis for the calculation.
|
|
3170
4292
|
*/
|
|
3171
|
-
oTarget
|
|
4293
|
+
oTarget?: sap.ushell.services.Navigation.Target,
|
|
3172
4294
|
/**
|
|
3173
4295
|
* A UI5 component, used to logically attach any related app state.
|
|
3174
4296
|
*/
|
|
3175
4297
|
oComponent?: sap.ui.core.Component
|
|
3176
4298
|
): Promise<string>;
|
|
3177
4299
|
/**
|
|
3178
|
-
* @since 1.
|
|
4300
|
+
* @since 1.120.0
|
|
3179
4301
|
*
|
|
3180
4302
|
* Resolves the given filters to a list of links available to the user.
|
|
3181
4303
|
*
|
|
@@ -3184,8 +4306,8 @@ declare namespace sap {
|
|
|
3184
4306
|
* to use it directly you have to transform it first into a href.
|
|
3185
4307
|
* ```javascript
|
|
3186
4308
|
*
|
|
3187
|
-
*
|
|
3188
|
-
*
|
|
4309
|
+
* const sHref = await NavigationService.getHref({ target: { shellHash: oLink.intent} }, oComponent);
|
|
4310
|
+
* ```
|
|
3189
4311
|
*/
|
|
3190
4312
|
getLinks(
|
|
3191
4313
|
/**
|
|
@@ -3194,15 +4316,16 @@ declare namespace sap {
|
|
|
3194
4316
|
aLinkFilter?: sap.ushell.services.Navigation.LinkFilter[]
|
|
3195
4317
|
): Promise<sap.ushell.services.Navigation.Link[][]>;
|
|
3196
4318
|
/**
|
|
3197
|
-
* @since 1.
|
|
4319
|
+
* @since 1.120.0
|
|
3198
4320
|
*
|
|
3199
4321
|
* For a given semantic object, this method considers all actions associated with the semantic object and
|
|
3200
|
-
* returns the one tagged as a "primaryAction".
|
|
3201
|
-
* intent of the first inbound (after sorting has
|
|
4322
|
+
* returns the one tagged as a "primaryAction".
|
|
4323
|
+
* If no inbound tagged as "primaryAction" exists, then the intent of the first inbound (after sorting has
|
|
4324
|
+
* been applied) matching the action "displayFactSheet".
|
|
3202
4325
|
*
|
|
3203
4326
|
* The primary intent is determined by querying {@link sap.ushell.services.Navigation#getLinks} with the
|
|
3204
|
-
* given semantic object and optional parameter.
|
|
3205
|
-
* a single item remains.
|
|
4327
|
+
* given semantic object and optional parameter.
|
|
4328
|
+
* Then the resulting list is filtered to the outcome that a single item remains.
|
|
3206
4329
|
*
|
|
3207
4330
|
* @returns A promise resolving a link matching the 'primaryAction' tag.
|
|
3208
4331
|
*/
|
|
@@ -3217,18 +4340,19 @@ declare namespace sap {
|
|
|
3217
4340
|
oLinkFilter?: sap.ushell.services.Navigation.LinkFilter
|
|
3218
4341
|
): Promise<sap.ushell.services.Navigation.Link>;
|
|
3219
4342
|
/**
|
|
3220
|
-
* @since 1.
|
|
4343
|
+
* @since 1.120.0
|
|
3221
4344
|
*
|
|
3222
4345
|
* Returns a list of semantic objects of the intents the current user can navigate to.
|
|
3223
4346
|
*
|
|
3224
4347
|
* @returns A promise that resolves with an array of strings representing the semantic objects of the intents
|
|
3225
4348
|
* the current user can navigate to, or rejects with an error message. The returned array will not contain
|
|
3226
|
-
* duplicates.
|
|
3227
|
-
* in the returned
|
|
4349
|
+
* duplicates.
|
|
4350
|
+
* **Note:** the caller should not rely on the specific order the semantic objects appear in the returned
|
|
4351
|
+
* array.
|
|
3228
4352
|
*/
|
|
3229
4353
|
getSemanticObjects(): Promise<string[]>;
|
|
3230
4354
|
/**
|
|
3231
|
-
* @since 1.
|
|
4355
|
+
* @since 1.120.0
|
|
3232
4356
|
*
|
|
3233
4357
|
* Navigates back in history the number of given steps if this is supported by the underlying platform.
|
|
3234
4358
|
* If no argument is provided it will navigate back 1 step.
|
|
@@ -3240,7 +4364,7 @@ declare namespace sap {
|
|
|
3240
4364
|
iSteps: int
|
|
3241
4365
|
): void;
|
|
3242
4366
|
/**
|
|
3243
|
-
* @since 1.
|
|
4367
|
+
* @since 1.120.0
|
|
3244
4368
|
*
|
|
3245
4369
|
* Checks whether the FLP has performed the first navigation. This method can be used to detect whether
|
|
3246
4370
|
* the current app was started directly, that is, without a previous navigation to another app, to the FLP
|
|
@@ -3250,7 +4374,7 @@ declare namespace sap {
|
|
|
3250
4374
|
*/
|
|
3251
4375
|
isInitialNavigation(): Promise<boolean>;
|
|
3252
4376
|
/**
|
|
3253
|
-
* @since 1.
|
|
4377
|
+
* @since 1.120.0
|
|
3254
4378
|
*
|
|
3255
4379
|
* Calculates whether the given navigation targets are supported for the given parameters, form factor etc.
|
|
3256
4380
|
* . "Supported" means that a valid navigation target is configured for the user and for the given device.
|
|
@@ -3282,7 +4406,7 @@ declare namespace sap {
|
|
|
3282
4406
|
oComponent?: sap.ui.core.Component
|
|
3283
4407
|
): void;
|
|
3284
4408
|
/**
|
|
3285
|
-
* @since 1.
|
|
4409
|
+
* @since 1.120.0
|
|
3286
4410
|
*
|
|
3287
4411
|
* Triggers a navigation to a specified target outside of the currently running application (e.g. different
|
|
3288
4412
|
* launchpad application). Invocation will trigger a hash change and subsequent invocation of the target.
|
|
@@ -3301,9 +4425,10 @@ declare namespace sap {
|
|
|
3301
4425
|
* Using the arguments as in the example above, a link with a sap-xapp-state parameter that encodes the
|
|
3302
4426
|
* provided data is returned. The sap-xapp-state-data parameter does not appear in the generated link.
|
|
3303
4427
|
*
|
|
3304
|
-
* Do **not** use "#Shell-home" to navigate to a specific homepage!
|
|
3305
|
-
* a link to return to the home page of the Fiori launchpad
|
|
3306
|
-
*
|
|
4428
|
+
* Do **not** use "#Shell-home" to navigate to a specific homepage!
|
|
4429
|
+
* A proper way for an application to generate a link to return to the home page of the Fiori launchpad
|
|
4430
|
+
* is:
|
|
4431
|
+
* `navigate( { target : { shellHash : "#" }})`
|
|
3307
4432
|
*
|
|
3308
4433
|
* @returns A Promise resolving once the navigation was triggered. The Promise might never reject or resolve
|
|
3309
4434
|
* when an error occurs during the navigation.
|
|
@@ -3319,7 +4444,7 @@ declare namespace sap {
|
|
|
3319
4444
|
oComponent?: sap.ui.core.Component
|
|
3320
4445
|
): Promise<any>;
|
|
3321
4446
|
/**
|
|
3322
|
-
* @since 1.
|
|
4447
|
+
* @since 1.120.0
|
|
3323
4448
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
3324
4449
|
*
|
|
3325
4450
|
* Resolves the URL hash fragment. This function gets the hash part of the URL and returns the URL of the
|
|
@@ -3342,8 +4467,8 @@ declare namespace sap {
|
|
|
3342
4467
|
*
|
|
3343
4468
|
* The Unified Shell's internal navigation target resolution service.
|
|
3344
4469
|
*
|
|
3345
|
-
* **
|
|
3346
|
-
* For details see {@link sap.ushell.services.Container#getServiceAsync}.
|
|
4470
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("NavTargetResolution")`.
|
|
4471
|
+
* For details, see {@link sap.ushell.services.Container#getServiceAsync}.
|
|
3347
4472
|
*
|
|
3348
4473
|
* Methods in this class deal with *internal* representations of the shell hash.
|
|
3349
4474
|
*
|
|
@@ -3473,9 +4598,9 @@ declare namespace sap {
|
|
|
3473
4598
|
* ```javascript
|
|
3474
4599
|
*
|
|
3475
4600
|
* {
|
|
3476
|
-
* "additionalInformation": "SAPUI5.Component=sap.ushell.
|
|
4601
|
+
* "additionalInformation": "SAPUI5.Component=sap.ushell.renderer.search.container",
|
|
3477
4602
|
* "applicationType": "URL",
|
|
3478
|
-
* "url": "/sap/bc/ui5_ui5/ui2/ushell/resources/sap/ushell/
|
|
4603
|
+
* "url": "/sap/bc/ui5_ui5/ui2/ushell/resources/sap/ushell/renderer/search/container",
|
|
3479
4604
|
* "navigationMode": "embedded"
|
|
3480
4605
|
* }
|
|
3481
4606
|
* ```
|
|
@@ -3502,58 +4627,240 @@ declare namespace sap {
|
|
|
3502
4627
|
*/
|
|
3503
4628
|
resolveHashFragment(
|
|
3504
4629
|
/**
|
|
3505
|
-
* The formatted URL hash fragment in internal format (as obtained by the SAPUI5 hasher service) not as
|
|
3506
|
-
* given in `location.hash`)! Example: `#SemanticObject-action?P1=V1&P2=A%20B%20C`
|
|
4630
|
+
* The formatted URL hash fragment in internal format (as obtained by the SAPUI5 hasher service) not as
|
|
4631
|
+
* given in `location.hash`)! Example: `#SemanticObject-action?P1=V1&P2=A%20B%20C`
|
|
4632
|
+
*/
|
|
4633
|
+
sHashFragment: string
|
|
4634
|
+
): object;
|
|
4635
|
+
/**
|
|
4636
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
4637
|
+
*
|
|
4638
|
+
* Resolves a navigation target taking into account the sap-system
|
|
4639
|
+
*
|
|
4640
|
+
* This function should be used by the NWBC browser in order to get a resolved target corresponding to a
|
|
4641
|
+
* certain configuration object describing the target. Do not use this function for developing Fiori applications.
|
|
4642
|
+
*
|
|
4643
|
+
* @returns A jQuery.Promise. Its `done()` function gets an object. Typically it contains the following
|
|
4644
|
+
* information:
|
|
4645
|
+
* ```javascript
|
|
4646
|
+
*
|
|
4647
|
+
* {
|
|
4648
|
+
* "url": "/sap/bc/",
|
|
4649
|
+
* "text": "My targetmapping description",
|
|
4650
|
+
* "externalNavigationMode": boolean
|
|
4651
|
+
* }
|
|
4652
|
+
* ```
|
|
4653
|
+
*/
|
|
4654
|
+
resolveTarget(
|
|
4655
|
+
/**
|
|
4656
|
+
*
|
|
4657
|
+
* ```javascript
|
|
4658
|
+
*
|
|
4659
|
+
* {
|
|
4660
|
+
* target : {
|
|
4661
|
+
* semanticObject : "semantic object",
|
|
4662
|
+
* action : "action",
|
|
4663
|
+
* },
|
|
4664
|
+
* params : {
|
|
4665
|
+
* "sap-system-src": "e.g. sid(UR5.120)",
|
|
4666
|
+
* "sap-system": {
|
|
4667
|
+
* ... data related to the sap-system
|
|
4668
|
+
* }
|
|
4669
|
+
* }
|
|
4670
|
+
* }
|
|
4671
|
+
* ```
|
|
4672
|
+
*/
|
|
4673
|
+
oArgs: object
|
|
4674
|
+
): jQuery.Promise;
|
|
4675
|
+
}
|
|
4676
|
+
/**
|
|
4677
|
+
* @since 1.32.0
|
|
4678
|
+
* @deprecated (since 1.119) - Please use {@link sap.ushell.services.NotificationsV2} instead.
|
|
4679
|
+
*
|
|
4680
|
+
* UShell service for fetching user notification data from the Notification center/service
|
|
4681
|
+
* and exposing them to the Unified Shell and Fiori applications UI controls.
|
|
4682
|
+
*
|
|
4683
|
+
* In order to get user notifications, Unified Shell notification service issues OData requests
|
|
4684
|
+
* to the service defined by the configuration property `serviceUrl`,
|
|
4685
|
+
* for example: "/sap/opu/odata4/iwngw/notification/default/iwngw/notification_srv/0001"
|
|
4686
|
+
* .
|
|
4687
|
+
*
|
|
4688
|
+
* Unified Shell Notification service has several working modes, depending on the environment and the available
|
|
4689
|
+
* resources:
|
|
4690
|
+
* PackagedApp mode: Fiori launchpad runs in the context of PackagedApp
|
|
4691
|
+
* FioriClient mode: Fiori launchpad runs in the context of FioriLaunchpad
|
|
4692
|
+
* WebSocket mode: Fiori launchpad runs in a browser, and WebSocket connection to the notifications provider
|
|
4693
|
+
* is available
|
|
4694
|
+
* Polling mode: Fiori launchpad in runs in a browser, and WebSocket connection to the notifications provider
|
|
4695
|
+
* is not available
|
|
4696
|
+
*
|
|
4697
|
+
*
|
|
4698
|
+
* The notification service exposes an API that includes: - Service enabling and initialization
|
|
4699
|
+
* - Registration of callback functions (by Shell/FLP controls) that will be called for every data update
|
|
4700
|
+
* . - Retrieval of notification data (e.g. notifications, number of unseen notifications) - Execution of
|
|
4701
|
+
* a notification actions - Marking user notifications as seen
|
|
4702
|
+
*/
|
|
4703
|
+
class Notifications {
|
|
4704
|
+
constructor();
|
|
4705
|
+
|
|
4706
|
+
/**
|
|
4707
|
+
* @since 1.34
|
|
4708
|
+
*
|
|
4709
|
+
* Launches dismiss notification call.
|
|
4710
|
+
*
|
|
4711
|
+
*
|
|
4712
|
+
* @returns Promise object that on success resolves to undefined or it is rejected with a message object
|
|
4713
|
+
*/
|
|
4714
|
+
dismissNotification(
|
|
4715
|
+
/**
|
|
4716
|
+
* The ID of the notification whose action is being executed
|
|
4717
|
+
*/
|
|
4718
|
+
sNotificationId: string
|
|
4719
|
+
): jQuery.Promise;
|
|
4720
|
+
/**
|
|
4721
|
+
* @since 1.32
|
|
4722
|
+
*
|
|
4723
|
+
* Launches a notification action oData call.
|
|
4724
|
+
* After launching the action, the function gets updated notification data in order to push the updated
|
|
4725
|
+
* data to the consumers.
|
|
4726
|
+
*
|
|
4727
|
+
* @returns Promise object that on success resolves to undefined or it is rejected with failed notifications
|
|
4728
|
+
*/
|
|
4729
|
+
executeBulkAction(
|
|
4730
|
+
/**
|
|
4731
|
+
* The ID of the notification header/group whose action is being executed
|
|
4732
|
+
*/
|
|
4733
|
+
sNotificationGroupId: string,
|
|
4734
|
+
/**
|
|
4735
|
+
* The ID of the action that is being executed
|
|
4736
|
+
*/
|
|
4737
|
+
sActionId: string
|
|
4738
|
+
): Promise<undefined>;
|
|
4739
|
+
/**
|
|
4740
|
+
* @since 1.38
|
|
4741
|
+
*
|
|
4742
|
+
* Returns the notifications of the user sorted by type include the group headers and the notifications
|
|
4743
|
+
*
|
|
4744
|
+
* @returns Promise object that - on success - returns all notification items
|
|
4745
|
+
*/
|
|
4746
|
+
getNotificationsByTypeWithGroupHeaders(): jQuery.Promise;
|
|
4747
|
+
/**
|
|
4748
|
+
* @since 1.44
|
|
4749
|
+
*
|
|
4750
|
+
* Returns the number of notifications
|
|
4751
|
+
* e.g. Notifications for user.
|
|
4752
|
+
*
|
|
4753
|
+
* @returns Returns the number of notifications of the user
|
|
4754
|
+
*/
|
|
4755
|
+
getNotificationsCount(): int;
|
|
4756
|
+
/**
|
|
4757
|
+
* @since 1.44
|
|
4758
|
+
*
|
|
4759
|
+
* Returns the group headers of the user notifications
|
|
4760
|
+
*
|
|
4761
|
+
* @returns Promise object that - on success - returns all group headers
|
|
4762
|
+
*/
|
|
4763
|
+
getNotificationsGroupHeaders(): jQuery.Promise;
|
|
4764
|
+
/**
|
|
4765
|
+
* @since 1.32
|
|
4766
|
+
*
|
|
4767
|
+
* Returns the number of unseen notifications
|
|
4768
|
+
* e.g. Notifications that the user hasn't seen yet.
|
|
4769
|
+
*
|
|
4770
|
+
* @returns Promise object that on success - returns the number of unread notifications of the user
|
|
4771
|
+
*/
|
|
4772
|
+
getUnseenNotificationsCount(): jQuery.Promise;
|
|
4773
|
+
/**
|
|
4774
|
+
* @since 1.32
|
|
4775
|
+
*
|
|
4776
|
+
* Initializes the notification service
|
|
4777
|
+
*
|
|
4778
|
+
* Initialization is performed only if the following two conditions are fulfilled:
|
|
4779
|
+
* 1. Notification service is enabled
|
|
4780
|
+
* 2. Notification service hasn't been initialized yet
|
|
4781
|
+
*
|
|
4782
|
+
*
|
|
4783
|
+
* The main initialization functionality is determining and setting the mode in which notifications are
|
|
4784
|
+
* consumed.
|
|
4785
|
+
* The possible modes are:
|
|
4786
|
+
* PACKAGED_APP - Notifications are fetched when a callback is called by PackagedApp environment
|
|
4787
|
+
* FIORI_CLIENT - Notifications are fetched when a callback is called by FioriClient environment
|
|
4788
|
+
* WEB_SOCKET - Notifications are fetched on WebSocket "ping"
|
|
4789
|
+
* POLLING - Notifications are fetched using periodic polling mechanism
|
|
4790
|
+
*/
|
|
4791
|
+
init(): void;
|
|
4792
|
+
/**
|
|
4793
|
+
* @since 1.32.0
|
|
4794
|
+
*
|
|
4795
|
+
* Indicates whether notification service is enabled.
|
|
4796
|
+
* Enabling is based on the `enable` service configuration flag.
|
|
4797
|
+
* The service configuration must also include serviceUrl attribute.
|
|
4798
|
+
*
|
|
4799
|
+
*
|
|
4800
|
+
* @returns A boolean value indicating whether the notifications service is enabled
|
|
4801
|
+
*/
|
|
4802
|
+
isEnabled(): boolean;
|
|
4803
|
+
/**
|
|
4804
|
+
* @since 1.38
|
|
4805
|
+
*
|
|
4806
|
+
*
|
|
4807
|
+
* @returns boolean value whether first request was already performed and data was returned.
|
|
4808
|
+
*/
|
|
4809
|
+
isFirstDataLoaded(): boolean;
|
|
4810
|
+
/**
|
|
4811
|
+
* @since 1.34
|
|
4812
|
+
*
|
|
4813
|
+
* Launches mark as read notification call.
|
|
4814
|
+
* After launching the action, the function gets updated notification data in order to push the updated
|
|
4815
|
+
* data to the consumers.
|
|
4816
|
+
*
|
|
4817
|
+
* @returns Promise object that on success resolves to undefined or it is rejected with a message object
|
|
4818
|
+
*/
|
|
4819
|
+
markRead(
|
|
4820
|
+
/**
|
|
4821
|
+
* The ID of the notification whose action is being executed
|
|
4822
|
+
*/
|
|
4823
|
+
sNotificationId: string
|
|
4824
|
+
): jQuery.Promise;
|
|
4825
|
+
/**
|
|
4826
|
+
* @since 1.32
|
|
4827
|
+
*
|
|
4828
|
+
* Mark all notifications as seen.
|
|
4829
|
+
* the main use-case is when the user navigated to the notification center and sees all the pending notifications.
|
|
4830
|
+
*/
|
|
4831
|
+
notificationsSeen(): void;
|
|
4832
|
+
/**
|
|
4833
|
+
* @since 1.32
|
|
4834
|
+
*
|
|
4835
|
+
* Gets a callback function that will be called when updated unseen notifications count is available.
|
|
4836
|
+
*/
|
|
4837
|
+
registerNotificationCountUpdateCallback(
|
|
4838
|
+
/**
|
|
4839
|
+
* The callback function that is registered and called on data update.
|
|
3507
4840
|
*/
|
|
3508
|
-
|
|
3509
|
-
):
|
|
4841
|
+
callback: Function
|
|
4842
|
+
): void;
|
|
3510
4843
|
/**
|
|
3511
|
-
* @
|
|
3512
|
-
*
|
|
3513
|
-
* Resolves a navigation target taking into account the sap-system
|
|
3514
|
-
*
|
|
3515
|
-
* This function should be used by the NWBC browser in order to get a resolved target corresponding to a
|
|
3516
|
-
* certain configuration object describing the target. Do not use this function for developing Fiori applications.
|
|
3517
|
-
*
|
|
3518
|
-
* @returns A jQuery.Promise. Its `done()` function gets an object. Typically it contains the following
|
|
3519
|
-
* information:
|
|
3520
|
-
* ```javascript
|
|
4844
|
+
* @since 1.32
|
|
3521
4845
|
*
|
|
3522
|
-
*
|
|
3523
|
-
* "url": "/sap/bc/",
|
|
3524
|
-
* "text": "My targetmapping description",
|
|
3525
|
-
* "externalNavigationMode": boolean
|
|
3526
|
-
* }
|
|
3527
|
-
* ```
|
|
4846
|
+
* Gets a callback function that will be called when updated notifications data is available.
|
|
3528
4847
|
*/
|
|
3529
|
-
|
|
4848
|
+
registerNotificationsUpdateCallback(
|
|
3530
4849
|
/**
|
|
3531
|
-
*
|
|
3532
|
-
* ```javascript
|
|
3533
|
-
*
|
|
3534
|
-
* {
|
|
3535
|
-
* target : {
|
|
3536
|
-
* semanticObject : "semantic object",
|
|
3537
|
-
* action : "action",
|
|
3538
|
-
* },
|
|
3539
|
-
* params : {
|
|
3540
|
-
* "sap-system-src": "e.g. sid(UR5.120)",
|
|
3541
|
-
* "sap-system": {
|
|
3542
|
-
* ... data related to the sap-system
|
|
3543
|
-
* }
|
|
3544
|
-
* }
|
|
3545
|
-
* }
|
|
3546
|
-
* ```
|
|
4850
|
+
* The callback function that is registered and called on data update.
|
|
3547
4851
|
*/
|
|
3548
|
-
|
|
3549
|
-
):
|
|
4852
|
+
callback: Function
|
|
4853
|
+
): void;
|
|
3550
4854
|
}
|
|
3551
4855
|
/**
|
|
3552
|
-
* @since 1.
|
|
4856
|
+
* @since 1.119
|
|
3553
4857
|
*
|
|
3554
4858
|
* UShell service for fetching user notification data from the Notification center/service
|
|
3555
4859
|
* and exposing them to the Unified Shell and Fiori applications UI controls.
|
|
3556
4860
|
*
|
|
4861
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("NotificationsV2")`.
|
|
4862
|
+
* For details, see {@link sap.ushell.services.Container#getServiceAsync}.
|
|
4863
|
+
*
|
|
3557
4864
|
* In order to get user notifications, Unified Shell notification service issues OData requests
|
|
3558
4865
|
* to the service defined by the configuration property `serviceUrl`,
|
|
3559
4866
|
* for example: "/sap/opu/odata4/iwngw/notification/default/iwngw/notification_srv/0001"
|
|
@@ -3574,12 +4881,10 @@ declare namespace sap {
|
|
|
3574
4881
|
* . - Retrieval of notification data (e.g. notifications, number of unseen notifications) - Execution of
|
|
3575
4882
|
* a notification actions - Marking user notifications as seen
|
|
3576
4883
|
*/
|
|
3577
|
-
class
|
|
4884
|
+
class NotificationsV2 {
|
|
3578
4885
|
constructor();
|
|
3579
4886
|
|
|
3580
4887
|
/**
|
|
3581
|
-
* @since 1.34
|
|
3582
|
-
*
|
|
3583
4888
|
* Launches dismiss notification call.
|
|
3584
4889
|
*
|
|
3585
4890
|
*
|
|
@@ -3592,8 +4897,6 @@ declare namespace sap {
|
|
|
3592
4897
|
sNotificationId: string
|
|
3593
4898
|
): Promise<undefined>;
|
|
3594
4899
|
/**
|
|
3595
|
-
* @since 1.32
|
|
3596
|
-
*
|
|
3597
4900
|
* Launches a notification action oData call.
|
|
3598
4901
|
* After launching the action, the function gets updated notification data in order to push the updated
|
|
3599
4902
|
* data to the consumers.
|
|
@@ -3609,18 +4912,14 @@ declare namespace sap {
|
|
|
3609
4912
|
* The ID of the action that is being executed
|
|
3610
4913
|
*/
|
|
3611
4914
|
sActionId: string
|
|
3612
|
-
): Promise<
|
|
4915
|
+
): Promise<any>;
|
|
3613
4916
|
/**
|
|
3614
|
-
* @since 1.38
|
|
3615
|
-
*
|
|
3616
4917
|
* Returns the notifications of the user sorted by type include the group headers and the notifications
|
|
3617
4918
|
*
|
|
3618
|
-
* @returns Promise
|
|
4919
|
+
* @returns Promise for all notification items
|
|
3619
4920
|
*/
|
|
3620
|
-
getNotificationsByTypeWithGroupHeaders():
|
|
4921
|
+
getNotificationsByTypeWithGroupHeaders(): Promise<any>;
|
|
3621
4922
|
/**
|
|
3622
|
-
* @since 1.44
|
|
3623
|
-
*
|
|
3624
4923
|
* Returns the number of notifications
|
|
3625
4924
|
* e.g. Notifications for user.
|
|
3626
4925
|
*
|
|
@@ -3628,25 +4927,19 @@ declare namespace sap {
|
|
|
3628
4927
|
*/
|
|
3629
4928
|
getNotificationsCount(): int;
|
|
3630
4929
|
/**
|
|
3631
|
-
* @since 1.44
|
|
3632
|
-
*
|
|
3633
4930
|
* Returns the group headers of the user notifications
|
|
3634
4931
|
*
|
|
3635
|
-
* @returns Promise
|
|
4932
|
+
* @returns Promise for all group headers
|
|
3636
4933
|
*/
|
|
3637
|
-
getNotificationsGroupHeaders():
|
|
4934
|
+
getNotificationsGroupHeaders(): Promise<any>;
|
|
3638
4935
|
/**
|
|
3639
|
-
* @since 1.32
|
|
3640
|
-
*
|
|
3641
4936
|
* Returns the number of unseen notifications
|
|
3642
4937
|
* e.g. Notifications that the user hasn't seen yet.
|
|
3643
4938
|
*
|
|
3644
|
-
* @returns Promise
|
|
4939
|
+
* @returns Promise resolves with the number of unread notifications of the user
|
|
3645
4940
|
*/
|
|
3646
|
-
getUnseenNotificationsCount():
|
|
4941
|
+
getUnseenNotificationsCount(): Promise<any>;
|
|
3647
4942
|
/**
|
|
3648
|
-
* @since 1.32
|
|
3649
|
-
*
|
|
3650
4943
|
* Initializes the notification service
|
|
3651
4944
|
*
|
|
3652
4945
|
* Initialization is performed only if the following two conditions are fulfilled:
|
|
@@ -3664,8 +4957,6 @@ declare namespace sap {
|
|
|
3664
4957
|
*/
|
|
3665
4958
|
init(): void;
|
|
3666
4959
|
/**
|
|
3667
|
-
* @since 1.32.0
|
|
3668
|
-
*
|
|
3669
4960
|
* Indicates whether notification service is enabled.
|
|
3670
4961
|
* Enabling is based on the `enable` service configuration flag.
|
|
3671
4962
|
* The service configuration must also include serviceUrl attribute.
|
|
@@ -3675,15 +4966,11 @@ declare namespace sap {
|
|
|
3675
4966
|
*/
|
|
3676
4967
|
isEnabled(): boolean;
|
|
3677
4968
|
/**
|
|
3678
|
-
* @since 1.38
|
|
3679
|
-
*
|
|
3680
4969
|
*
|
|
3681
4970
|
* @returns boolean value whether first request was already performed and data was returned.
|
|
3682
4971
|
*/
|
|
3683
4972
|
isFirstDataLoaded(): boolean;
|
|
3684
4973
|
/**
|
|
3685
|
-
* @since 1.34
|
|
3686
|
-
*
|
|
3687
4974
|
* Launches mark as read notification call.
|
|
3688
4975
|
* After launching the action, the function gets updated notification data in order to push the updated
|
|
3689
4976
|
* data to the consumers.
|
|
@@ -3695,17 +4982,15 @@ declare namespace sap {
|
|
|
3695
4982
|
* The ID of the notification whose action is being executed
|
|
3696
4983
|
*/
|
|
3697
4984
|
sNotificationId: string
|
|
3698
|
-
):
|
|
4985
|
+
): Promise<undefined>;
|
|
3699
4986
|
/**
|
|
3700
|
-
* @since 1.32
|
|
3701
|
-
*
|
|
3702
4987
|
* Mark all notifications as seen.
|
|
3703
4988
|
* the main use-case is when the user navigated to the notification center and sees all the pending notifications.
|
|
4989
|
+
*
|
|
4990
|
+
* @returns Promise taht resolves when operation is finished
|
|
3704
4991
|
*/
|
|
3705
|
-
notificationsSeen():
|
|
4992
|
+
notificationsSeen(): Promise<any>;
|
|
3706
4993
|
/**
|
|
3707
|
-
* @since 1.32
|
|
3708
|
-
*
|
|
3709
4994
|
* Gets a callback function that will be called when updated unseen notifications count is available.
|
|
3710
4995
|
*/
|
|
3711
4996
|
registerNotificationCountUpdateCallback(
|
|
@@ -3715,8 +5000,6 @@ declare namespace sap {
|
|
|
3715
5000
|
callback: Function
|
|
3716
5001
|
): void;
|
|
3717
5002
|
/**
|
|
3718
|
-
* @since 1.32
|
|
3719
|
-
*
|
|
3720
5003
|
* Gets a callback function that will be called when updated notifications data is available.
|
|
3721
5004
|
*/
|
|
3722
5005
|
registerNotificationsUpdateCallback(
|
|
@@ -3728,6 +5011,7 @@ declare namespace sap {
|
|
|
3728
5011
|
}
|
|
3729
5012
|
/**
|
|
3730
5013
|
* @since 1.15.0
|
|
5014
|
+
* @deprecated (since 1.120) - Please use {@link sap.ushell.services.PersonalizationV2} instead
|
|
3731
5015
|
*
|
|
3732
5016
|
* This method MUST be called by the Unified Shell's container only, others MUST call `sap.ushell.Container.getServiceAsync("Personalization").then(function
|
|
3733
5017
|
* (Personalization) {});`. Constructs a new instance of the personalization service.
|
|
@@ -4031,394 +5315,312 @@ declare namespace sap {
|
|
|
4031
5315
|
getTransientPersonalizer(): object;
|
|
4032
5316
|
}
|
|
4033
5317
|
/**
|
|
4034
|
-
* @since 1.
|
|
5318
|
+
* @since 1.120.0
|
|
5319
|
+
*
|
|
5320
|
+
* The Unified Shell's personalization service. Provides a personalizer object that handles all personalization
|
|
5321
|
+
* operations.
|
|
4035
5322
|
*
|
|
4036
|
-
*
|
|
4037
|
-
*
|
|
5323
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("PersonalizationV2")`.
|
|
5324
|
+
* For details, see {@link sap.ushell.services.Container#getServiceAsync}.
|
|
4038
5325
|
*/
|
|
4039
|
-
class
|
|
5326
|
+
class PersonalizationV2 {
|
|
5327
|
+
constructor();
|
|
4040
5328
|
/**
|
|
4041
|
-
*
|
|
5329
|
+
* @since 1.120.0
|
|
4042
5330
|
*/
|
|
4043
|
-
|
|
5331
|
+
static constants: undefined;
|
|
4044
5332
|
|
|
4045
5333
|
/**
|
|
4046
|
-
* @since 1.
|
|
5334
|
+
* @since 1.120.0
|
|
4047
5335
|
*
|
|
4048
|
-
*
|
|
4049
|
-
*
|
|
4050
|
-
*
|
|
4051
|
-
* @returns {@link sap.ushell.services.PersonalizationContainerVariantSet}
|
|
4052
|
-
*/
|
|
4053
|
-
addVariantSet(
|
|
4054
|
-
/**
|
|
4055
|
-
* variant set key
|
|
4056
|
-
*/
|
|
4057
|
-
sVariantSetKey: string
|
|
4058
|
-
): object;
|
|
4059
|
-
/**
|
|
4060
|
-
* @since 1.18.0
|
|
5336
|
+
* Factory method to obtain an empty Data Context object. When data present in a prior context is not relevant
|
|
5337
|
+
* (e.g. when using a "uniquely" generated key and planning to overwrite any colliding front-end server
|
|
5338
|
+
* data).
|
|
4061
5339
|
*
|
|
4062
|
-
*
|
|
5340
|
+
* The call always returns an cleared container().
|
|
4063
5341
|
*
|
|
4064
|
-
*
|
|
4065
|
-
|
|
4066
|
-
containsItem(
|
|
4067
|
-
/**
|
|
4068
|
-
* item key
|
|
4069
|
-
*/
|
|
4070
|
-
sItemKey: string
|
|
4071
|
-
): boolean;
|
|
4072
|
-
/**
|
|
4073
|
-
* @since 1.18.0
|
|
5342
|
+
* Note that an existing container at the front-end server is not actually deleted or overwritten unless
|
|
5343
|
+
* a save operation is executed.
|
|
4074
5344
|
*
|
|
4075
|
-
*
|
|
5345
|
+
* An initial object is returned.
|
|
4076
5346
|
*
|
|
4077
|
-
* @returns
|
|
5347
|
+
* @returns Resolves a ContextContainer as parameter. object as parameter. The personalization container
|
|
5348
|
+
* provides two different interfaces to synchronously operate on personalization data. In the item mode
|
|
5349
|
+
* the container contains items as name value pairs for personalization data. In the variant mode the container
|
|
5350
|
+
* contains variant sets which contain variants containing items.
|
|
4078
5351
|
*/
|
|
4079
|
-
|
|
5352
|
+
createEmptyContainer(
|
|
4080
5353
|
/**
|
|
4081
|
-
*
|
|
5354
|
+
* Identifies the container. The string length is restricted to 40 characters
|
|
4082
5355
|
*/
|
|
4083
|
-
|
|
4084
|
-
): boolean;
|
|
4085
|
-
/**
|
|
4086
|
-
* @since 1.18.0
|
|
4087
|
-
*
|
|
4088
|
-
* Deletes a direct item from the container. In case the item does not exist, nothing happens.
|
|
4089
|
-
*/
|
|
4090
|
-
delItem(
|
|
5356
|
+
sContainerKey: string,
|
|
4091
5357
|
/**
|
|
4092
|
-
*
|
|
5358
|
+
* Currently the validity property of the scope object is relevant.
|
|
5359
|
+
* E.g. ` { validity : 30}` indicates a validity of the data for 30 minutes.
|
|
4093
5360
|
*/
|
|
4094
|
-
|
|
4095
|
-
): void;
|
|
4096
|
-
/**
|
|
4097
|
-
* @since 1.18.0
|
|
4098
|
-
*
|
|
4099
|
-
* Deletes a variant set from the container. In case the variant set does not exist nothing happens.
|
|
4100
|
-
*/
|
|
4101
|
-
delVariantSet(
|
|
5361
|
+
oScope: sap.ushell.services.PersonalizationV2.Scope,
|
|
4102
5362
|
/**
|
|
4103
|
-
*
|
|
5363
|
+
* Component which uses the container. This allows to associate the stored data with the application.
|
|
4104
5364
|
*/
|
|
4105
|
-
|
|
4106
|
-
):
|
|
5365
|
+
oComponent: sap.ui.core.Component
|
|
5366
|
+
): Promise<sap.ushell.services.PersonalizationV2.ContextContainer>;
|
|
4107
5367
|
/**
|
|
4108
|
-
* @since 1.
|
|
5368
|
+
* @since 1.120.0
|
|
4109
5369
|
*
|
|
4110
|
-
*
|
|
5370
|
+
* Asynchronously starts a deletion request for the given container identified by sContainerKey. Can be
|
|
5371
|
+
* called without having ever called getContainer with the corresponding key
|
|
4111
5372
|
*
|
|
4112
|
-
*
|
|
4113
|
-
|
|
4114
|
-
|
|
4115
|
-
/**
|
|
4116
|
-
* @since 1.18.0
|
|
5373
|
+
* Note: After invoking this operation, the state of other containers obtained for the same key is undefined!
|
|
5374
|
+
* If you want to use the container after deletion, it is strongly recommended to obtain a new instance
|
|
5375
|
+
* of a container for the given key *after* the promise has returned.
|
|
4117
5376
|
*
|
|
4118
|
-
*
|
|
5377
|
+
* Note: Invoking this operation while another save or load operation is under way may result in failure.
|
|
4119
5378
|
*
|
|
4120
|
-
* @returns
|
|
4121
|
-
* `undefined` is returned.
|
|
5379
|
+
* @returns promise for the deletion operation
|
|
4122
5380
|
*/
|
|
4123
|
-
|
|
5381
|
+
deleteContainer(
|
|
4124
5382
|
/**
|
|
4125
|
-
*
|
|
5383
|
+
* identifies the container
|
|
4126
5384
|
*/
|
|
4127
|
-
|
|
4128
|
-
|
|
4129
|
-
|
|
4130
|
-
|
|
4131
|
-
|
|
4132
|
-
|
|
4133
|
-
*
|
|
4134
|
-
* @returns variant set keys
|
|
4135
|
-
*/
|
|
4136
|
-
getVariantSetKeys(): any[];
|
|
4137
|
-
/**
|
|
4138
|
-
* @since 1.18.0
|
|
4139
|
-
*
|
|
4140
|
-
* (Re)loads the current container data from the underlying storage asynchronously. The current local data
|
|
4141
|
-
* is discarded.
|
|
4142
|
-
*
|
|
4143
|
-
* Returns a promise for the load operation. If another save/load/delete operation is not completed, the
|
|
4144
|
-
* operation may fail! (wait for the other promise).
|
|
4145
|
-
*
|
|
4146
|
-
* Synchronous read and write operations before the load is done have undefined effects.
|
|
4147
|
-
*
|
|
4148
|
-
* @returns Promise object
|
|
4149
|
-
*/
|
|
4150
|
-
load(): object;
|
|
5385
|
+
sContainerKey: string,
|
|
5386
|
+
/**
|
|
5387
|
+
* The scope
|
|
5388
|
+
*/
|
|
5389
|
+
oScope: sap.ushell.services.PersonalizationV2.Scope
|
|
5390
|
+
): Promise<any>;
|
|
4151
5391
|
/**
|
|
4152
|
-
* @since 1.
|
|
5392
|
+
* @since 1.120.0
|
|
4153
5393
|
*
|
|
4154
|
-
*
|
|
4155
|
-
* is
|
|
4156
|
-
*
|
|
4157
|
-
*
|
|
5394
|
+
* Factory method to obtain a Data Context object, which is a local copy of the persistence layer data.
|
|
5395
|
+
* The Container data is asynchronously read on creation if present, otherwise an initial object is created.
|
|
5396
|
+
* The Container data can then be *synchronously* modified (getItemValue, setItemValue). Only on invoking
|
|
5397
|
+
* the save() method the data is transferred to the persistence. This allows the application to perform
|
|
5398
|
+
* multiple local modifications and delay the save operation.
|
|
4158
5399
|
*
|
|
4159
|
-
*
|
|
4160
|
-
*/
|
|
4161
|
-
save(): object;
|
|
4162
|
-
/**
|
|
4163
|
-
* @since 1.18.0
|
|
5400
|
+
* Every getContainer operation returns a new local copy, containing the full data at the point of creation.
|
|
4164
5401
|
*
|
|
4165
|
-
*
|
|
4166
|
-
* In case it is not existing a new item with this key and value is created.
|
|
4167
|
-
*/
|
|
4168
|
-
setItemValue(
|
|
4169
|
-
/**
|
|
4170
|
-
* item key
|
|
4171
|
-
*/
|
|
4172
|
-
sItemKey: string,
|
|
4173
|
-
/**
|
|
4174
|
-
* item value (JSON object)
|
|
4175
|
-
*/
|
|
4176
|
-
oItemValue: object
|
|
4177
|
-
): void;
|
|
4178
|
-
}
|
|
4179
|
-
/**
|
|
4180
|
-
* @since 1.18.0
|
|
4181
|
-
*
|
|
4182
|
-
* The personalization variant contains personalization data. It is used in the personalization container
|
|
4183
|
-
* mode.
|
|
4184
|
-
*/
|
|
4185
|
-
class PersonalizationContainerVariant {
|
|
4186
|
-
/**
|
|
4187
|
-
* To be called by the personalization variant set.
|
|
4188
|
-
*/
|
|
4189
|
-
constructor();
|
|
4190
|
-
|
|
4191
|
-
/**
|
|
4192
|
-
* @since 1.18.0
|
|
5402
|
+
* Executing load() on the container reloads the data from the persistence, discarding local changes.
|
|
4193
5403
|
*
|
|
4194
|
-
*
|
|
5404
|
+
* Note that the container allows the application to control the round trips to the front-end server persistence.
|
|
5405
|
+
* The factory method getContainer is asynchronous and loads the container via the connected adapter from
|
|
5406
|
+
* the front-end server. All operations (but for the save operation) are executed synchronously, operating
|
|
5407
|
+
* on the local data. This allows the application to control the round trips to the front-end server persistence.
|
|
4195
5408
|
*
|
|
4196
|
-
*
|
|
4197
|
-
*/
|
|
4198
|
-
containsItem(
|
|
4199
|
-
/**
|
|
4200
|
-
* item key
|
|
4201
|
-
*/
|
|
4202
|
-
sItemKey: string
|
|
4203
|
-
): boolean;
|
|
4204
|
-
/**
|
|
4205
|
-
* @since 1.18.0
|
|
5409
|
+
* A container can contain a set of items, identified by a key.
|
|
4206
5410
|
*
|
|
4207
|
-
*
|
|
4208
|
-
|
|
4209
|
-
delItem(
|
|
4210
|
-
/**
|
|
4211
|
-
* item key
|
|
4212
|
-
*/
|
|
4213
|
-
sItemKey: string
|
|
4214
|
-
): void;
|
|
4215
|
-
/**
|
|
4216
|
-
* @since 1.18.0
|
|
5411
|
+
* You can wrap a container in a VariantSetAdapter to read and write a more complex structure (with multiple
|
|
5412
|
+
* keys (variantSet,variant,item)).
|
|
4217
5413
|
*
|
|
4218
|
-
*
|
|
5414
|
+
* Do not mix up the usage of a personalizer and a container for one containerKey. Do not use a PersonalizationContainer
|
|
5415
|
+
* and a Container for the same key except for migration scenarios.
|
|
4219
5416
|
*
|
|
4220
|
-
*
|
|
4221
|
-
|
|
4222
|
-
|
|
4223
|
-
|
|
4224
|
-
* @since 1.18.0
|
|
5417
|
+
* scope / validity parameter: An unspecified (undefined validity) or infinite (Infinity) validity indicates
|
|
5418
|
+
* that data is persisted in the Personalization data of the front-end server. A round trip is executed
|
|
5419
|
+
* on an initial get and at least every save operation. Data is stored per user and retained indefinitely
|
|
5420
|
+
* at the front-end server.
|
|
4225
5421
|
*
|
|
4226
|
-
*
|
|
5422
|
+
* The validity parameter allows a designated storage validity for the created container. A 0 validity indicates
|
|
5423
|
+
* the data is only persisted within the Fiori launchpad window. No round trips to the front-end server
|
|
5424
|
+
* are executed. Data is lost if the Fiori launchpad window state is lost (e.g. by navigating to a different
|
|
5425
|
+
* page, pressing F5 (reload page) or duplicating the window).
|
|
4227
5426
|
*
|
|
4228
|
-
*
|
|
4229
|
-
*
|
|
4230
|
-
|
|
4231
|
-
|
|
4232
|
-
/**
|
|
4233
|
-
* item key
|
|
4234
|
-
*/
|
|
4235
|
-
sItemKey: string
|
|
4236
|
-
): object;
|
|
4237
|
-
/**
|
|
4238
|
-
* @since 1.18.0
|
|
5427
|
+
* For versions > 1.24 it may happen that for cross-app navigation a reload of the Fiori launchpad is triggered.
|
|
5428
|
+
* In this case a storage of the personalization data in the Fiori launchpad window would lead to data loss.
|
|
5429
|
+
* To overcome this a validity 0 is automatically changed to a validity 1440 (24h; storage on the front-end
|
|
5430
|
+
* server). This is only done if a reload of the Fiori launchpad is triggered for a cross-app navigation.
|
|
4239
5431
|
*
|
|
4240
|
-
*
|
|
5432
|
+
* Security: It is the responsibility of the application to not persist information relevant to auditing
|
|
5433
|
+
* or security using the PersonalizationService with inappropriate validity models. No mechanisms exist
|
|
5434
|
+
* to destroy or selectively destroy application-specific data in the front-end server persistence (especially
|
|
5435
|
+
* for validity Infinity).
|
|
4241
5436
|
*
|
|
4242
|
-
*
|
|
4243
|
-
*/
|
|
4244
|
-
getVariantKey(): string;
|
|
4245
|
-
/**
|
|
4246
|
-
* @since 1.18.0
|
|
5437
|
+
* For non-zero validity scopes, data will be transmitted and persisted in the front-end server system.
|
|
4247
5438
|
*
|
|
4248
|
-
*
|
|
5439
|
+
* For limited validity, actual deletion of data on the front-end server is subject to explicit cleanup
|
|
5440
|
+
* execution of front-end server jobs and not guaranteed. The data may still be persisted and retrievable.
|
|
5441
|
+
* The interface only assures that expired data is no longer exposed to the application code in the Fiori
|
|
5442
|
+
* launchpad.
|
|
4249
5443
|
*
|
|
4250
|
-
*
|
|
4251
|
-
|
|
4252
|
-
getVariantName(): string;
|
|
4253
|
-
/**
|
|
4254
|
-
* @since 1.18.0
|
|
5444
|
+
* The ContainerKey uniquely defines the Container, validity is not part of the key (there are no separate
|
|
5445
|
+
* namespaces per validity).
|
|
4255
5446
|
*
|
|
4256
|
-
*
|
|
4257
|
-
|
|
4258
|
-
|
|
4259
|
-
/**
|
|
4260
|
-
* item key
|
|
4261
|
-
*/
|
|
4262
|
-
sItemKey: string,
|
|
4263
|
-
/**
|
|
4264
|
-
* value (JSON object)
|
|
4265
|
-
*/
|
|
4266
|
-
item: object
|
|
4267
|
-
): void;
|
|
4268
|
-
}
|
|
4269
|
-
/**
|
|
4270
|
-
* @since 1.18.0
|
|
4271
|
-
*
|
|
4272
|
-
* The personalization variant set contains variants of personalization data. It is used in the personalization
|
|
4273
|
-
* container mode.
|
|
4274
|
-
*/
|
|
4275
|
-
class PersonalizationContainerVariantSet {
|
|
4276
|
-
/**
|
|
4277
|
-
* To be called by the personalization container.
|
|
4278
|
-
*/
|
|
4279
|
-
constructor();
|
|
4280
|
-
/**
|
|
4281
|
-
* @since 1.18.0
|
|
5447
|
+
* In general, mixing different validity models for a given container key is not supported. Fast chaining
|
|
5448
|
+
* of different methods may source arbitrary persistence layers. The validity of the resulting object in
|
|
5449
|
+
* the done function of a promise is the last get validity.
|
|
4282
5450
|
*
|
|
4283
|
-
*
|
|
4284
|
-
|
|
4285
|
-
delVariant: undefined;
|
|
4286
|
-
|
|
4287
|
-
/**
|
|
4288
|
-
* @since 1.18.0
|
|
5451
|
+
* The validity associated with the last getContainer or createEmptyContainer determines the current validity
|
|
5452
|
+
* of the container and the validity used during the next save operation.
|
|
4289
5453
|
*
|
|
4290
|
-
*
|
|
5454
|
+
* Naturally, if a delete or get with validity 0 is issued, it will *not* delete or retrieve a front-end
|
|
5455
|
+
* server persistent storage. Thus a sequence delete( [validity 0])/wait for promise, getContainer(sKey,{
|
|
5456
|
+
* validity : Infinity}) may return a valid dataset.
|
|
4291
5457
|
*
|
|
4292
|
-
* @returns
|
|
5458
|
+
* @returns Resolves a ContextContainer as parameter. The container provides setItemValue / getItemValue
|
|
5459
|
+
* methods to synchronously operate on personalization data. By wrapping it in a VariantSetAdapter, an alternate
|
|
5460
|
+
* interface to maintain variants can be obtained.
|
|
4293
5461
|
*/
|
|
4294
|
-
|
|
5462
|
+
getContainer(
|
|
4295
5463
|
/**
|
|
4296
|
-
*
|
|
5464
|
+
* Identifies the container. The string length is restricted to 40 characters
|
|
4297
5465
|
*/
|
|
4298
|
-
|
|
4299
|
-
|
|
5466
|
+
sContainerKey: string,
|
|
5467
|
+
/**
|
|
5468
|
+
* Currently the validity property of the scope object is relevant: E.g. ` { validity : 30}` indicates a
|
|
5469
|
+
* validity of the data for 30 minutes.
|
|
5470
|
+
*/
|
|
5471
|
+
oScope: sap.ushell.services.PersonalizationV2.Scope,
|
|
5472
|
+
/**
|
|
5473
|
+
* Component which uses the container. This allows to associate the stored data with the application.
|
|
5474
|
+
*/
|
|
5475
|
+
oComponent: sap.ui.core.Component
|
|
5476
|
+
): Promise<sap.ushell.services.PersonalizationV2.ContextContainer>;
|
|
4300
5477
|
/**
|
|
4301
|
-
* @since 1.
|
|
5478
|
+
* @since 1.120.0
|
|
4302
5479
|
*
|
|
4303
|
-
* Returns
|
|
5480
|
+
* Returns a generated key. This key is suitably random, but it is susceptible to brute force attacks. Storages
|
|
5481
|
+
* based on the generated key must not be used for sensitive data.
|
|
4304
5482
|
*
|
|
4305
|
-
* @returns
|
|
5483
|
+
* @returns 40 character string consisting of A-Z and 0-9 which can be used as a generated key for personalization
|
|
5484
|
+
* container. Every invocation returns a new key. Seed of random function is OS Random Seed.
|
|
4306
5485
|
*/
|
|
4307
|
-
|
|
5486
|
+
getGeneratedKey(): Promise<string>;
|
|
4308
5487
|
/**
|
|
4309
|
-
* @since 1.
|
|
5488
|
+
* @since 1.120.0
|
|
4310
5489
|
*
|
|
4311
|
-
* Returns a
|
|
5490
|
+
* Returns a personalizer object which handles personalization by asynchronous operations storing the personalization
|
|
5491
|
+
* data immediately via the connected adapter. For each operation a round trip is executed.
|
|
4312
5492
|
*
|
|
4313
|
-
*
|
|
4314
|
-
* contain a variant with this key `undefined` is returned.
|
|
4315
|
-
*/
|
|
4316
|
-
getVariant(
|
|
4317
|
-
/**
|
|
4318
|
-
* variant key
|
|
4319
|
-
*/
|
|
4320
|
-
sVariantKey: string
|
|
4321
|
-
): object;
|
|
4322
|
-
/**
|
|
4323
|
-
* @since 1.18.0
|
|
5493
|
+
* Do not mix the usage of a personalizer and a personalization container for one containerKey.
|
|
4324
5494
|
*
|
|
4325
|
-
*
|
|
5495
|
+
* Fetching multiple Personalizer for the same container, but different items is not supported. Use {@link sap.ushell.services.Personalizer#getContainer }
|
|
5496
|
+
* instead for this scenario.
|
|
4326
5497
|
*
|
|
4327
|
-
* @returns
|
|
4328
|
-
*
|
|
5498
|
+
* @returns which provides generic read and write access to the currently logged on user's personalization
|
|
5499
|
+
* settings.
|
|
4329
5500
|
*/
|
|
4330
|
-
|
|
5501
|
+
getPersonalizer(
|
|
4331
5502
|
/**
|
|
4332
|
-
*
|
|
5503
|
+
* object for identifying the data
|
|
4333
5504
|
*/
|
|
4334
|
-
|
|
4335
|
-
|
|
5505
|
+
oPersId: sap.ushell.services.PersonalizationV2.PersId,
|
|
5506
|
+
/**
|
|
5507
|
+
* scope object
|
|
5508
|
+
* E.g. ` { validity: 30}` indicates a validity of the data for 30 minutes.
|
|
5509
|
+
*/
|
|
5510
|
+
oScope: sap.ushell.services.PersonalizationV2.Scope,
|
|
5511
|
+
/**
|
|
5512
|
+
* Component which uses the personalizer. This allows to associate the stored data with the application.
|
|
5513
|
+
*/
|
|
5514
|
+
oComponent?: sap.ui.core.Component
|
|
5515
|
+
): Promise<sap.ushell.services.PersonalizationV2.Personalizer>;
|
|
4336
5516
|
/**
|
|
4337
|
-
* @since 1.
|
|
5517
|
+
* @since 1.120.0
|
|
4338
5518
|
*
|
|
4339
|
-
* Returns
|
|
4340
|
-
*
|
|
4341
|
-
*
|
|
4342
|
-
|
|
4343
|
-
getVariantKeys(): any[];
|
|
4344
|
-
/**
|
|
4345
|
-
* @since 1.18.0
|
|
5519
|
+
* Returns a transient personalizer object which handles personalization by asynchronous operations storing
|
|
5520
|
+
* the personalization data transiently as an object property. Primary usage of the transient personalizer
|
|
5521
|
+
* is a personalization scenario with variants where the transient personalizer is used as a buffer for
|
|
5522
|
+
* table personalization data.
|
|
4346
5523
|
*
|
|
4347
|
-
*
|
|
5524
|
+
* @returns which provides asynchronous read and write access to a transient personalization data storage.
|
|
4348
5525
|
*/
|
|
4349
|
-
|
|
4350
|
-
/**
|
|
4351
|
-
* There is no validity check for the variant key.
|
|
4352
|
-
*/
|
|
4353
|
-
sVariantKey: string
|
|
4354
|
-
): void;
|
|
5526
|
+
getTransientPersonalizer(): Promise<sap.ushell.services.PersonalizationV2.TransientPersonalizer>;
|
|
4355
5527
|
}
|
|
4356
5528
|
/**
|
|
4357
5529
|
* @since 1.15.0
|
|
5530
|
+
*
|
|
5531
|
+
* The Unified Shell's internal navigation service (platform independent).
|
|
5532
|
+
*
|
|
5533
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("ShellNavigation")`.
|
|
5534
|
+
* For details, see {@link sap.ushell.services.Container#getServiceAsync}.
|
|
5535
|
+
*
|
|
5536
|
+
* This interface is for consumption by shell renderers/containers only
|
|
5537
|
+
*
|
|
5538
|
+
* It is not for direct usage by applications, see inner app navigation : UI5 interfaces (hashChanger, Router)
|
|
5539
|
+
* cross app navigation : @see CrossApplicationNavigation
|
|
5540
|
+
*
|
|
5541
|
+
* Usage:
|
|
5542
|
+
*
|
|
5543
|
+
* Example: see renders/fiorisandbox/Shell.controller.js
|
|
5544
|
+
*
|
|
5545
|
+
*
|
|
5546
|
+
* ```javascript
|
|
5547
|
+
*
|
|
5548
|
+
* sap.ui.define([
|
|
5549
|
+
* "sap/ushell/services/ShellNavigation"
|
|
5550
|
+
* ], function (ShellNavigation) {
|
|
5551
|
+
* Shell.onHashChange(shellHash,appHash) { / *resolve url, load app and exchange root view* / }
|
|
5552
|
+
* Shell.init() {
|
|
5553
|
+
* this.privShellNavigator = new ShellNavigation();
|
|
5554
|
+
* this.privShellNavigator.init(jQuery.proxy(this.doHashChange, this));
|
|
5555
|
+
* }
|
|
5556
|
+
* });
|
|
5557
|
+
* ```
|
|
5558
|
+
*
|
|
5559
|
+
*
|
|
5560
|
+
* Note: further app specific integration via the reference app reuse code (setting of app specific handler)
|
|
5561
|
+
*
|
|
5562
|
+
* Note: the ShellNavigation service replaces the UI5 core HashChanger which abstracts from the browser
|
|
5563
|
+
* url modification.
|
|
5564
|
+
*
|
|
5565
|
+
* It performs the following services: - encoding of the actual browser url hash ( via hasher.js). - expansion
|
|
5566
|
+
* of "shortened" urls ( AppParameterParts) via invocation. - splitting of shellHash and AppSpecific hash
|
|
5567
|
+
* and abstraction w.r.t. Eventing
|
|
5568
|
+
*
|
|
5569
|
+
* Thus it is crucial to use appropriate interfaces and not directly invoke window.location.hash.
|
|
5570
|
+
*
|
|
5571
|
+
* - internal construction methods for a "current" App specific and non-app specific hash (invoked by CrossApplicationNavigation),
|
|
5572
|
+
* not to be invoked directly!
|
|
4358
5573
|
*/
|
|
4359
5574
|
class ShellNavigation {
|
|
5575
|
+
constructor();
|
|
5576
|
+
|
|
4360
5577
|
/**
|
|
4361
|
-
*
|
|
4362
|
-
* the Unified Shell's container only, others MUST call `sap.ushell.Container.getServiceAsync("ShellNavigation").then(function
|
|
4363
|
-
* (ShellNavigation) {});`. Constructs a new instance of the shell navigation service.
|
|
4364
|
-
*
|
|
4365
|
-
* Note that the shell instantiation mechanism has to assure exactly one instance is created (!)
|
|
4366
|
-
*
|
|
4367
|
-
* This interface is for consumption by shell renderers/containers only
|
|
4368
|
-
*
|
|
4369
|
-
* It is not for direct usage by applications, see inner app navigation : UI5 interfaces (hashChanger, Router)
|
|
4370
|
-
* cross app navigation : @see CrossApplicationNavigation
|
|
5578
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
4371
5579
|
*
|
|
4372
|
-
*
|
|
5580
|
+
* compact the parameter object, if required a number of parameters will be removed, instead a corresponding
|
|
5581
|
+
* "sap-intent-param" containing a key of an appstate representing the removed parameters will be inserted
|
|
4373
5582
|
*
|
|
4374
|
-
*
|
|
5583
|
+
* @returns a promise, whose first argument of resolve is
|
|
5584
|
+
*/
|
|
5585
|
+
compactParams(
|
|
5586
|
+
/**
|
|
5587
|
+
* A parameter object
|
|
5588
|
+
*/
|
|
5589
|
+
oParams: object,
|
|
5590
|
+
/**
|
|
5591
|
+
* An array of string value of parameters which shall not be compacted The array may contains a *-terminated
|
|
5592
|
+
* string, which will match and strings with the same prefix ( e.g. "sap-*" will match "sap-ushell", "sap-wd",
|
|
5593
|
+
* "sap-" etc. )
|
|
5594
|
+
*/
|
|
5595
|
+
aRetainedParameters?: any[],
|
|
5596
|
+
/**
|
|
5597
|
+
* optional, a SAP UI5 Component
|
|
5598
|
+
*/
|
|
5599
|
+
oComponent?: object,
|
|
5600
|
+
/**
|
|
5601
|
+
* whether an transient appstate is sufficient
|
|
5602
|
+
*/
|
|
5603
|
+
bTransient?: boolean
|
|
5604
|
+
): Promise<any>;
|
|
5605
|
+
/**
|
|
5606
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
4375
5607
|
*
|
|
5608
|
+
* Returns the current navigation context.
|
|
4376
5609
|
*
|
|
5610
|
+
* @returns An object like:
|
|
4377
5611
|
* ```javascript
|
|
4378
5612
|
*
|
|
4379
|
-
*
|
|
4380
|
-
* "sap
|
|
4381
|
-
*
|
|
4382
|
-
*
|
|
4383
|
-
*
|
|
4384
|
-
* this.privShellNavigator = new ShellNavigation();
|
|
4385
|
-
* this.privShellNavigator.init(jQuery.proxy(this.doHashChange, this));
|
|
4386
|
-
* }
|
|
4387
|
-
* });
|
|
5613
|
+
* {
|
|
5614
|
+
* "status": sap.ushell.NavigationState.Navigating,
|
|
5615
|
+
* "isCrossAppNavigation": true,
|
|
5616
|
+
* "innerAppRoute": "employee/overview"
|
|
5617
|
+
* }
|
|
4388
5618
|
* ```
|
|
4389
5619
|
*
|
|
4390
5620
|
*
|
|
4391
|
-
*
|
|
4392
|
-
*
|
|
4393
|
-
* Note: the ShellNavigation service replaces the UI5 core HashChanger which abstracts from the browser
|
|
4394
|
-
* url modification.
|
|
4395
|
-
*
|
|
4396
|
-
* It performs the following services: - encoding of the actual browser url hash ( via hasher.js). - expansion
|
|
4397
|
-
* of "shortened" urls ( AppParameterParts) via invocation. - splitting of shellHash and AppSpecific hash
|
|
4398
|
-
* and abstraction w.r.t. Eventing
|
|
4399
|
-
*
|
|
4400
|
-
* Thus it is crucial to use appropriate interfaces and not directly invoke window.location.hash.
|
|
4401
|
-
*
|
|
4402
|
-
* - internal construction methods for a "current" App specific and non-app specific hash (invoked by CrossApplicationNavigation),
|
|
4403
|
-
* not to be invoked directly!
|
|
4404
|
-
* See:
|
|
4405
|
-
* sap.ushell.services.Container#getServiceAsync
|
|
5621
|
+
* This object can be used inside dirty flag providers to take corresponding actions.
|
|
4406
5622
|
*/
|
|
4407
|
-
|
|
4408
|
-
/**
|
|
4409
|
-
* interface
|
|
4410
|
-
*/
|
|
4411
|
-
oContainerInterface: object,
|
|
4412
|
-
/**
|
|
4413
|
-
* parameters
|
|
4414
|
-
*/
|
|
4415
|
-
sParameters: string,
|
|
4416
|
-
/**
|
|
4417
|
-
* configuration
|
|
4418
|
-
*/
|
|
4419
|
-
oServiceConfiguration: object
|
|
4420
|
-
);
|
|
4421
|
-
|
|
5623
|
+
getNavigationContext(): object;
|
|
4422
5624
|
/**
|
|
4423
5625
|
* Initializes ShellNavigation
|
|
4424
5626
|
*
|
|
@@ -4440,6 +5642,42 @@ declare namespace sap {
|
|
|
4440
5642
|
*/
|
|
4441
5643
|
fnShellCallback: Function
|
|
4442
5644
|
): object;
|
|
5645
|
+
/**
|
|
5646
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
5647
|
+
*
|
|
5648
|
+
* Rewrite the hash fragment identifier without triggering any navigation at
|
|
5649
|
+
*/
|
|
5650
|
+
replaceHashWithoutNavigation(
|
|
5651
|
+
/**
|
|
5652
|
+
* new hash fragment
|
|
5653
|
+
*/
|
|
5654
|
+
sNewHash: string
|
|
5655
|
+
): void;
|
|
5656
|
+
/**
|
|
5657
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
5658
|
+
*
|
|
5659
|
+
* Resets the internal flag used to track whether the last navigation is made via hasher#setHash or hasher#replaceHash.
|
|
5660
|
+
* This method should be called after a navigation is successfully made to a target application to avoid
|
|
5661
|
+
* returning an inconsistent answer when calling `#wasHistoryEntryReplaced`. An inconsistent answer might
|
|
5662
|
+
* occur when a navigation is made via forward/back button without passing via `hasher#replaceHash` or `hasher#setHash`.
|
|
5663
|
+
*
|
|
5664
|
+
* This method should not be used externally. It's reserved uniquely for internal shell consumption and
|
|
5665
|
+
* its signature or result might change at any time.
|
|
5666
|
+
*/
|
|
5667
|
+
resetHistoryEntryReplaced(): void;
|
|
5668
|
+
/**
|
|
5669
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
5670
|
+
*
|
|
5671
|
+
* Returns true if the history entry was replaced immediately after the last navigation. To be useful, this
|
|
5672
|
+
* method should be called immediately after the hash enters the URL but before the target application is
|
|
5673
|
+
* finally navigated to.
|
|
5674
|
+
*
|
|
5675
|
+
* This method should not be used externally. It's reserved uniquely for internal shell consumption and
|
|
5676
|
+
* its signature or result might change at any time.
|
|
5677
|
+
*
|
|
5678
|
+
* @returns Whether `hasher#replaceHash` was called after the last navigation.
|
|
5679
|
+
*/
|
|
5680
|
+
wasHistoryEntryReplaced(): boolean;
|
|
4443
5681
|
}
|
|
4444
5682
|
/**
|
|
4445
5683
|
* @since 1.44.0
|
|
@@ -4467,49 +5705,13 @@ declare namespace sap {
|
|
|
4467
5705
|
/**
|
|
4468
5706
|
* @since 1.19.1
|
|
4469
5707
|
*
|
|
4470
|
-
*
|
|
4471
|
-
*
|
|
5708
|
+
* The Unified Shell's SupportTicket service.
|
|
5709
|
+
*
|
|
5710
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("SupportTicket")`.
|
|
5711
|
+
* For details, see {@link sap.ushell.services.Container#getServiceAsync}.
|
|
4472
5712
|
*/
|
|
4473
5713
|
class SupportTicket {
|
|
4474
|
-
|
|
4475
|
-
* See:
|
|
4476
|
-
* sap.ushell.services.Container#getServiceAsync
|
|
4477
|
-
*/
|
|
4478
|
-
constructor(
|
|
4479
|
-
/**
|
|
4480
|
-
* the service adapter for the support ticket service, as already provided by the container
|
|
4481
|
-
*/
|
|
4482
|
-
oAdapter: object,
|
|
4483
|
-
/**
|
|
4484
|
-
* the interface provided by the container
|
|
4485
|
-
*/
|
|
4486
|
-
oContainerInterface: object,
|
|
4487
|
-
/**
|
|
4488
|
-
* the runtime configuration specified in the `sap.ushell.Container.getServiceAsync()` call (not evaluated
|
|
4489
|
-
* yet)
|
|
4490
|
-
*/
|
|
4491
|
-
sParameters: string,
|
|
4492
|
-
/**
|
|
4493
|
-
* the service configuration defined in the bootstrap configuration; the boolean property `enabled` controls
|
|
4494
|
-
* the service enablement
|
|
4495
|
-
*
|
|
4496
|
-
* This service is disabled by default. It can be enabled explicitly in the bootstrap configuration of the
|
|
4497
|
-
* start page:
|
|
4498
|
-
* window["sap-ushell-config"] = {
|
|
4499
|
-
* services: {
|
|
4500
|
-
* SupportTicket: {
|
|
4501
|
-
* config: {
|
|
4502
|
-
* enabled: true
|
|
4503
|
-
* }
|
|
4504
|
-
* }
|
|
4505
|
-
* }
|
|
4506
|
-
* }
|
|
4507
|
-
*
|
|
4508
|
-
* Platform implementations can also enable it dynamically by modification of the
|
|
4509
|
-
* bootstrap configuration during boot time.
|
|
4510
|
-
*/
|
|
4511
|
-
oServiceConfiguration: object
|
|
4512
|
-
);
|
|
5714
|
+
constructor();
|
|
4513
5715
|
|
|
4514
5716
|
/**
|
|
4515
5717
|
* @since 1.20.0
|
|
@@ -4547,74 +5749,13 @@ declare namespace sap {
|
|
|
4547
5749
|
*/
|
|
4548
5750
|
isEnabled(): boolean;
|
|
4549
5751
|
}
|
|
4550
|
-
/**
|
|
4551
|
-
* @since 1.18.0
|
|
4552
|
-
*
|
|
4553
|
-
* The transient personalizer shall be used in container mode for table personalization. To be called by
|
|
4554
|
-
* the personalization service getTransientPersonalizer method.
|
|
4555
|
-
*/
|
|
4556
|
-
class TransientPersonalizer {
|
|
4557
|
-
constructor();
|
|
4558
|
-
|
|
4559
|
-
/**
|
|
4560
|
-
* @since 1.18.0
|
|
4561
|
-
*
|
|
4562
|
-
* Deletes a personalization data value.
|
|
4563
|
-
*
|
|
4564
|
-
* @returns Promise object which returns if the deletion was successful or erroneous. Promise object done
|
|
4565
|
-
* function: no params. Promise object fail function ins never triggered.
|
|
4566
|
-
*/
|
|
4567
|
-
delPersData(): jQuery.Promise;
|
|
4568
|
-
/**
|
|
4569
|
-
* @since 1.18.0
|
|
4570
|
-
*
|
|
4571
|
-
* Gets a personalization data value.
|
|
4572
|
-
*
|
|
4573
|
-
* @returns Promise object which provides the personalization value. Promise object done function: param
|
|
4574
|
-
* {object} oValue JSON object containing the personalization value. If there is no personalization data
|
|
4575
|
-
* for the item, undefined is returned. Promise object fail function ins never triggered.
|
|
4576
|
-
*/
|
|
4577
|
-
getPersData(): jQuery.Promise;
|
|
4578
|
-
/**
|
|
4579
|
-
* @since 1.18.0
|
|
4580
|
-
*
|
|
4581
|
-
* Synchronously gets a personalization data value.
|
|
4582
|
-
*
|
|
4583
|
-
* @returns JSON object containing the personalization value.
|
|
4584
|
-
*/
|
|
4585
|
-
getValue(): object;
|
|
4586
|
-
/**
|
|
4587
|
-
* @since 1.18.0
|
|
4588
|
-
*
|
|
4589
|
-
* Sets a personalization data value.
|
|
4590
|
-
*
|
|
4591
|
-
* @returns Promise object which returns if the saving was successful or erroneous. Promise object done
|
|
4592
|
-
* function: no params. Promise fail function ins never triggered.
|
|
4593
|
-
*/
|
|
4594
|
-
setPersData(
|
|
4595
|
-
/**
|
|
4596
|
-
* JSON object containing the personalization value.
|
|
4597
|
-
*/
|
|
4598
|
-
oValue: object
|
|
4599
|
-
): jQuery.Promise;
|
|
4600
|
-
/**
|
|
4601
|
-
* @since 1.18.0
|
|
4602
|
-
*
|
|
4603
|
-
* Synchronously sets a personalization data value.
|
|
4604
|
-
*/
|
|
4605
|
-
setValue(
|
|
4606
|
-
/**
|
|
4607
|
-
* JSON object containing the personalization value.
|
|
4608
|
-
*/
|
|
4609
|
-
oValue: object
|
|
4610
|
-
): void;
|
|
4611
|
-
}
|
|
4612
5752
|
/**
|
|
4613
5753
|
* @since 1.15.0
|
|
4614
5754
|
*
|
|
4615
|
-
* The Unified Shell's internal URL parsing service (platform independent)
|
|
4616
|
-
*
|
|
4617
|
-
*
|
|
5755
|
+
* The Unified Shell's internal URL parsing service (platform independent).
|
|
5756
|
+
*
|
|
5757
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("URLParsing")`.
|
|
5758
|
+
* For details, see {@link sap.ushell.services.Container#getServiceAsync}.
|
|
4618
5759
|
*
|
|
4619
5760
|
* Methods in this class allow to break down a shell compliant hash into it's respective parts (SemanticObject,Action,Context,
|
|
4620
5761
|
* Parameters, appSpecificHash) or (ShellPart,appSpecificHash) respectively or construct a hash from its
|
|
@@ -4885,6 +6026,8 @@ declare namespace sap {
|
|
|
4885
6026
|
}
|
|
4886
6027
|
/**
|
|
4887
6028
|
* @since 1.32.0
|
|
6029
|
+
* @deprecated (since 1.120.0) - The corresponding cloud service "SAP Web Analytics" has been retired, therefore
|
|
6030
|
+
* this client-side service API cannot be used any longer.
|
|
4888
6031
|
*
|
|
4889
6032
|
* A UShell service for tracking business flows and user actions. The UsageAnalytics service exposes API
|
|
4890
6033
|
* for logging custom events and setting custom field values in the logged events.
|
|
@@ -4974,11 +6117,10 @@ declare namespace sap {
|
|
|
4974
6117
|
/**
|
|
4975
6118
|
* @since 1.16.3
|
|
4976
6119
|
*
|
|
4977
|
-
*
|
|
4978
|
-
* (UserInfo) {});`. Constructs a new instance of the user information service.
|
|
6120
|
+
* The Unified Shell's user information service. Allows retrieving information about the logged-in user.
|
|
4979
6121
|
*
|
|
4980
|
-
*
|
|
4981
|
-
*
|
|
6122
|
+
* **Note:** To retrieve a valid instance of this service, it is necessary to call `sap.ushell.Container.getServiceAsync("UserInfo")`.
|
|
6123
|
+
* For details, see {@link sap.ushell.services.Container#getServiceAsync}.
|
|
4982
6124
|
*/
|
|
4983
6125
|
class UserInfo {
|
|
4984
6126
|
constructor();
|
|
@@ -5023,15 +6165,6 @@ declare namespace sap {
|
|
|
5023
6165
|
* @returns The user's last name.
|
|
5024
6166
|
*/
|
|
5025
6167
|
getLastName(): string;
|
|
5026
|
-
/**
|
|
5027
|
-
* @since 1.71.0
|
|
5028
|
-
*
|
|
5029
|
-
* Returns an object representing data about the user: ID, first name, last name, full name, e-mail address.
|
|
5030
|
-
*
|
|
5031
|
-
* @returns object providing information about the logged-in user: ID, first name, last name, full name,
|
|
5032
|
-
* e-mail address
|
|
5033
|
-
*/
|
|
5034
|
-
getShellUserInfo(): Promise<any>;
|
|
5035
6168
|
}
|
|
5036
6169
|
}
|
|
5037
6170
|
|
|
@@ -5770,13 +6903,11 @@ declare namespace sap {
|
|
|
5770
6903
|
|
|
5771
6904
|
/**
|
|
5772
6905
|
* @since 1.15.0
|
|
6906
|
+
* @deprecated (since 1.120.0) - Please use {@link sap.ushell.services.Extension} instead.
|
|
5773
6907
|
*
|
|
5774
6908
|
* The SAPUI5 component of SAP Fiori Launchpad renderer for the Unified Shell.
|
|
5775
6909
|
*/
|
|
5776
|
-
class Renderer
|
|
5777
|
-
extends sap.ui.core.UIComponent
|
|
5778
|
-
implements sap.ui.core.IAsyncContentCreation {
|
|
5779
|
-
__implements__sap_ui_core_IAsyncContentCreation: boolean;
|
|
6910
|
+
class Renderer extends sap.ui.core.UIComponent {
|
|
5780
6911
|
/**
|
|
5781
6912
|
* This method MUST be called by the Unified Shell's container only, others MUST call `sap.ushell.Container.createRenderer("fiori2",
|
|
5782
6913
|
* true)`.
|
|
@@ -5793,35 +6924,6 @@ declare namespace sap {
|
|
|
5793
6924
|
*/
|
|
5794
6925
|
LaunchpadState: undefined;
|
|
5795
6926
|
|
|
5796
|
-
/**
|
|
5797
|
-
* Creates a new subclass of class sap.ushell.renderers.fiori2.Renderer with name `sClassName` and enriches
|
|
5798
|
-
* it with the information contained in `oClassInfo`.
|
|
5799
|
-
*
|
|
5800
|
-
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.UIComponent.extend}.
|
|
5801
|
-
*
|
|
5802
|
-
* @returns Created class / constructor function
|
|
5803
|
-
*/
|
|
5804
|
-
static extend<T extends Record<string, unknown>>(
|
|
5805
|
-
/**
|
|
5806
|
-
* Name of the class being created
|
|
5807
|
-
*/
|
|
5808
|
-
sClassName: string,
|
|
5809
|
-
/**
|
|
5810
|
-
* Object literal with information about the class
|
|
5811
|
-
*/
|
|
5812
|
-
oClassInfo?: sap.ClassInfo<T, sap.ushell.renderers.fiori2.Renderer>,
|
|
5813
|
-
/**
|
|
5814
|
-
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
5815
|
-
* used by this class
|
|
5816
|
-
*/
|
|
5817
|
-
FNMetaImpl?: Function
|
|
5818
|
-
): Function;
|
|
5819
|
-
/**
|
|
5820
|
-
* Returns a metadata object for class sap.ushell.renderers.fiori2.Renderer.
|
|
5821
|
-
*
|
|
5822
|
-
* @returns Metadata object describing this class
|
|
5823
|
-
*/
|
|
5824
|
-
static getMetadata(): sap.ui.core.ComponentMetadata;
|
|
5825
6927
|
/**
|
|
5826
6928
|
* @since 1.30
|
|
5827
6929
|
* @deprecated (since 1.48) - Please use {@link #addUserAction} instead.
|
|
@@ -5842,7 +6944,7 @@ declare namespace sap {
|
|
|
5842
6944
|
* 1. The control instance is already created and its ID is included in the input parameter oControlProperties
|
|
5843
6945
|
* 2. The control type resource is already loaded
|
|
5844
6946
|
* See:
|
|
5845
|
-
* sap.ushell.renderers.fiori2.
|
|
6947
|
+
* sap.ushell.renderers.fiori2.Renderer.LaunchpadState
|
|
5846
6948
|
* If no launchpad state is provided, the content is added in all states.
|
|
5847
6949
|
*
|
|
5848
6950
|
* @returns oItem - the created control
|
|
@@ -6428,7 +7530,7 @@ declare namespace sap {
|
|
|
6428
7530
|
*
|
|
6429
7531
|
* See:
|
|
6430
7532
|
* sap.ushell.ui.shell.ToolAreaItem
|
|
6431
|
-
* sap.ushell.renderers.fiori2.
|
|
7533
|
+
* sap.ushell.renderers.fiori2.Renderer.LaunchpadState.
|
|
6432
7534
|
*
|
|
6433
7535
|
* @returns the added control
|
|
6434
7536
|
*/
|
|
@@ -6580,6 +7682,7 @@ declare namespace sap {
|
|
|
6580
7682
|
): void;
|
|
6581
7683
|
/**
|
|
6582
7684
|
* @since 1.37
|
|
7685
|
+
* @deprecated (since 1.120.0) - This functionality was discontinued
|
|
6583
7686
|
*
|
|
6584
7687
|
* This method returns the current state of the Viewport Container control.
|
|
6585
7688
|
*
|
|
@@ -6595,7 +7698,7 @@ declare namespace sap {
|
|
|
6595
7698
|
* This API is meant to be used for custom elements in the SAP Fiori launchpad. We do not recommend using
|
|
6596
7699
|
* it on standard launchpad elements, as this may interfere with the standard launchpad functionality.
|
|
6597
7700
|
* See:
|
|
6598
|
-
* sap.ushell.renderers.fiori2.
|
|
7701
|
+
* sap.ushell.renderers.fiori2.Renderer.LaunchpadState.
|
|
6599
7702
|
* If no launchpad state is provided, the content is hidden in all states.
|
|
6600
7703
|
*/
|
|
6601
7704
|
hideActionButton(
|
|
@@ -6770,7 +7873,7 @@ declare namespace sap {
|
|
|
6770
7873
|
* to be used for implementing custom elements in the SAP Fiori launchpad. We do not recommend using it
|
|
6771
7874
|
* on a standard launchpad element, as this may interfere with the standard launchpad functionality.
|
|
6772
7875
|
* See:
|
|
6773
|
-
* sap.ushell.renderers.fiori2.
|
|
7876
|
+
* sap.ushell.renderers.fiori2.Renderer.LaunchpadState.
|
|
6774
7877
|
*/
|
|
6775
7878
|
removeToolAreaItem(
|
|
6776
7879
|
/**
|
|
@@ -6791,6 +7894,7 @@ declare namespace sap {
|
|
|
6791
7894
|
): void;
|
|
6792
7895
|
/**
|
|
6793
7896
|
* @since 1.30
|
|
7897
|
+
* @deprecated (since 1.120.0) - Please use {@link #setShellFooter} instead.
|
|
6794
7898
|
*
|
|
6795
7899
|
* Displays the given sap.m.Bar as the footer of the Fiori launchpad shell.
|
|
6796
7900
|
* The footer will be displayed in all states.
|
|
@@ -6856,6 +7960,7 @@ declare namespace sap {
|
|
|
6856
7960
|
): sap.ui.core.Control;
|
|
6857
7961
|
/**
|
|
6858
7962
|
* @since 1.30
|
|
7963
|
+
* @deprecated (since 1.120.0) - Please use {@link sap.ushell.ui5service.ShellUIService#getTitle} instead.
|
|
6859
7964
|
*
|
|
6860
7965
|
* Sets the title in the Fiori Launchpad shell header.
|
|
6861
7966
|
*/
|
|
@@ -6867,8 +7972,9 @@ declare namespace sap {
|
|
|
6867
7972
|
): void;
|
|
6868
7973
|
/**
|
|
6869
7974
|
* @since 1.38
|
|
7975
|
+
* @deprecated (since 1.120.0) - This functionality was discontinued
|
|
6870
7976
|
*
|
|
6871
|
-
* Sets the header visibility according to the given value and shell states. (see sap.ushell.renderers.fiori2.
|
|
7977
|
+
* Sets the header visibility according to the given value and shell states. (see sap.ushell.renderers.fiori2.Renderer.LaunchpadState).
|
|
6872
7978
|
*
|
|
6873
7979
|
* **Example:**
|
|
6874
7980
|
* ```javascript
|
|
@@ -6965,7 +8071,7 @@ declare namespace sap {
|
|
|
6965
8071
|
* @since 1.30
|
|
6966
8072
|
*
|
|
6967
8073
|
* Displays action buttons in the User Actions Menu in the SAP Fiori launchpad, in the given launchpad states
|
|
6968
|
-
* (LaunchpadState). (see sap.ushell.renderers.fiori2.
|
|
8074
|
+
* (LaunchpadState). (see sap.ushell.renderers.fiori2.Renderer.LaunchpadState).
|
|
6969
8075
|
* If no launchpad state is provided the content is displayed in all states.
|
|
6970
8076
|
* The user actions menu is opened via the button on the right hand side of the shell header.
|
|
6971
8077
|
*
|
|
@@ -6979,7 +8085,7 @@ declare namespace sap {
|
|
|
6979
8085
|
* ```
|
|
6980
8086
|
*
|
|
6981
8087
|
* See:
|
|
6982
|
-
* sap.ushell.renderers.fiori2.
|
|
8088
|
+
* sap.ushell.renderers.fiori2.Renderer.LaunchpadState.
|
|
6983
8089
|
* If no launchpad state is provided, the content is added in all states.
|
|
6984
8090
|
*/
|
|
6985
8091
|
showActionButton(
|
|
@@ -7005,7 +8111,7 @@ declare namespace sap {
|
|
|
7005
8111
|
*
|
|
7006
8112
|
* Displays FloatingActionButton on the bottom right corner of the Fiori launchpad, in the given launchpad
|
|
7007
8113
|
* states. The FloatingActionButton is rendered in the bottom right corner of the shell.
|
|
7008
|
-
* (see sap.ushell.renderers.fiori2.
|
|
8114
|
+
* (see sap.ushell.renderers.fiori2.Renderer.LaunchpadState).
|
|
7009
8115
|
* If no launchpad state is provided the content is displayed in all states.
|
|
7010
8116
|
*
|
|
7011
8117
|
*
|
|
@@ -7028,7 +8134,7 @@ declare namespace sap {
|
|
|
7028
8134
|
*/
|
|
7029
8135
|
bCurrentState: boolean,
|
|
7030
8136
|
/**
|
|
7031
|
-
* (only valid if bCurrentState is set to false) - list of the sap.ushell.renderers.fiori2.
|
|
8137
|
+
* (only valid if bCurrentState is set to false) - list of the sap.ushell.renderers.fiori2.Renderer.LaunchpadState
|
|
7032
8138
|
* in which to add the aIds.
|
|
7033
8139
|
*/
|
|
7034
8140
|
aStates: string[]
|
|
@@ -7037,7 +8143,7 @@ declare namespace sap {
|
|
|
7037
8143
|
* @since 1.30
|
|
7038
8144
|
*
|
|
7039
8145
|
* Displays HeaderItems on the right side of the Fiori launchpad shell header, in the given launchpad states
|
|
7040
|
-
* (see sap.ushell.renderers.fiori2.
|
|
8146
|
+
* (see sap.ushell.renderers.fiori2.Renderer.LaunchpadState).
|
|
7041
8147
|
* If no launchpad state is provided the content is displayed in all states.
|
|
7042
8148
|
* The shell header can display the user HeaderItem, and just one more HeaderItem.
|
|
7043
8149
|
* If this method is called when the right side of the header is full, this method will not do anything.
|
|
@@ -7062,7 +8168,7 @@ declare namespace sap {
|
|
|
7062
8168
|
*/
|
|
7063
8169
|
bCurrentState: boolean,
|
|
7064
8170
|
/**
|
|
7065
|
-
* (only valid if bCurrentState is set to false) - list of the sap.ushell.renderers.fiori2.
|
|
8171
|
+
* (only valid if bCurrentState is set to false) - list of the sap.ushell.renderers.fiori2.Renderer.LaunchpadState
|
|
7066
8172
|
* in which to add the aIds.
|
|
7067
8173
|
*/
|
|
7068
8174
|
aStates: string[]
|
|
@@ -7071,7 +8177,7 @@ declare namespace sap {
|
|
|
7071
8177
|
* @since 1.30
|
|
7072
8178
|
*
|
|
7073
8179
|
* Creates and displays one or more HeaderItem controls according to the given control IDs and Shell states
|
|
7074
|
-
* (see sap.ushell.renderers.fiori2.
|
|
8180
|
+
* (see sap.ushell.renderers.fiori2.Renderer.LaunchpadState).
|
|
7075
8181
|
*
|
|
7076
8182
|
* The HeaderItem controls will be displayed on the left side of the Fiori Launchpad shell header according
|
|
7077
8183
|
* to the given display parameters.
|
|
@@ -7089,7 +8195,7 @@ declare namespace sap {
|
|
|
7089
8195
|
* ```
|
|
7090
8196
|
*
|
|
7091
8197
|
* See:
|
|
7092
|
-
* sap.ushell.renderers.fiori2.
|
|
8198
|
+
* sap.ushell.renderers.fiori2.Renderer.LaunchpadState.
|
|
7093
8199
|
*/
|
|
7094
8200
|
showHeaderItem(
|
|
7095
8201
|
/**
|
|
@@ -7112,7 +8218,7 @@ declare namespace sap {
|
|
|
7112
8218
|
* @since 1.30
|
|
7113
8219
|
*
|
|
7114
8220
|
* Displays one or more sub header controls according to the given control IDs and shell states.
|
|
7115
|
-
* (see sap.ushell.renderers.fiori2.
|
|
8221
|
+
* (see sap.ushell.renderers.fiori2.Renderer.LaunchpadState).
|
|
7116
8222
|
*
|
|
7117
8223
|
* A sub header is placed in a container, located directly below the main Fiori launchpad shell header.
|
|
7118
8224
|
*
|
|
@@ -7180,7 +8286,7 @@ declare namespace sap {
|
|
|
7180
8286
|
* ```
|
|
7181
8287
|
*
|
|
7182
8288
|
* See:
|
|
7183
|
-
* sap.ushell.renderers.fiori2.
|
|
8289
|
+
* sap.ushell.renderers.fiori2.Renderer.LaunchpadState.
|
|
7184
8290
|
*/
|
|
7185
8291
|
showToolAreaItem(
|
|
7186
8292
|
/**
|
|
@@ -7730,9 +8836,8 @@ declare namespace sap {
|
|
|
7730
8836
|
}
|
|
7731
8837
|
|
|
7732
8838
|
/**
|
|
7733
|
-
* Enables
|
|
7734
|
-
*
|
|
7735
|
-
* the launchpad.
|
|
8839
|
+
* Enables users to save bookmark tiles in the Fiori launchpad. Clicking the button opens a dialog box for
|
|
8840
|
+
* saving the app state, so that the app can be launched directly in that state from the launchpad.
|
|
7736
8841
|
*/
|
|
7737
8842
|
class AddBookmarkButton extends sap.m.Button {
|
|
7738
8843
|
/**
|
|
@@ -10182,7 +11287,8 @@ declare namespace sap {
|
|
|
10182
11287
|
/**
|
|
10183
11288
|
* @deprecated (since 1.70) - Support for this service has been discontinued.
|
|
10184
11289
|
*/
|
|
10185
|
-
interface UserStatus
|
|
11290
|
+
interface UserStatus
|
|
11291
|
+
extends /* was: sap.ui.core.service.Service */ Object {
|
|
10186
11292
|
/**
|
|
10187
11293
|
* Creates a new subclass of class sap.ushell.ui5service.UserStatus with name `sClassName` and enriches
|
|
10188
11294
|
* it with the information contained in `oClassInfo`.
|
|
@@ -10219,11 +11325,9 @@ declare namespace sap {
|
|
|
10219
11325
|
*
|
|
10220
11326
|
* The Unified Shell's ShellUIService service.
|
|
10221
11327
|
*
|
|
10222
|
-
*
|
|
10223
|
-
*
|
|
10224
|
-
*
|
|
10225
|
-
*
|
|
10226
|
-
*
|
|
11328
|
+
* Allows apps to interact with the Fiori Launchpad UI. The service is injected in the app components by
|
|
11329
|
+
* the FLP renderer before the corresponding apps start. To consume the service, app components should declare
|
|
11330
|
+
* it in their "manifest.json" as follows:
|
|
10227
11331
|
* ```javascript
|
|
10228
11332
|
*
|
|
10229
11333
|
* {
|
|
@@ -10283,8 +11387,8 @@ declare namespace sap {
|
|
|
10283
11387
|
* ```
|
|
10284
11388
|
*
|
|
10285
11389
|
*
|
|
10286
|
-
*
|
|
10287
|
-
*
|
|
11390
|
+
* Note that the `setHierarchy` or `setTitle` methods should not be actively called by the application when
|
|
11391
|
+
* title and hierarchy are set automatically.
|
|
10288
11392
|
*
|
|
10289
11393
|
* **Note:** Please be aware that the sapFiori2Adaptation configuration of the application may cause the
|
|
10290
11394
|
* ShellUIService service to work incorrectly. We recommend to disable the sapFiori2Adaptation configuration
|
|
@@ -10442,8 +11546,8 @@ declare namespace sap {
|
|
|
10442
11546
|
/**
|
|
10443
11547
|
* @since 1.15.0
|
|
10444
11548
|
*
|
|
10445
|
-
* The Unified Shell's container
|
|
10446
|
-
*
|
|
11549
|
+
* The Unified Shell's container. Manages renderers, services, and adapters. The container is designed to
|
|
11550
|
+
* be a singleton, therefore instead of creating an instance, access the central one via `sap.ushell.Container`.
|
|
10447
11551
|
*/
|
|
10448
11552
|
class Container {
|
|
10449
11553
|
constructor();
|
|
@@ -10454,15 +11558,6 @@ declare namespace sap {
|
|
|
10454
11558
|
*/
|
|
10455
11559
|
DirtyState: sap.ushell.Container.DirtyState;
|
|
10456
11560
|
|
|
10457
|
-
/**
|
|
10458
|
-
* @since 1.15.0
|
|
10459
|
-
*
|
|
10460
|
-
* Logs out the current user from all relevant back-end systems, including the logon system itself. This
|
|
10461
|
-
* member represents the default native implementation of logout. If SessionHandler was created, we register
|
|
10462
|
-
* the alternate logout function using registerLogout function.
|
|
10463
|
-
*/
|
|
10464
|
-
logout: undefined;
|
|
10465
|
-
|
|
10466
11561
|
/**
|
|
10467
11562
|
* @since 1.15.0
|
|
10468
11563
|
*
|
|
@@ -10518,6 +11613,7 @@ declare namespace sap {
|
|
|
10518
11613
|
cancelLogon(): void;
|
|
10519
11614
|
/**
|
|
10520
11615
|
* @since 1.15.0
|
|
11616
|
+
* @deprecated (since 1.120.0)
|
|
10521
11617
|
*
|
|
10522
11618
|
* Creates a new renderer instance for the given renderer name.
|
|
10523
11619
|
*
|
|
@@ -10611,6 +11707,7 @@ declare namespace sap {
|
|
|
10611
11707
|
getGlobalDirty(): jQuery.Deferred;
|
|
10612
11708
|
/**
|
|
10613
11709
|
* @since 1.30.0
|
|
11710
|
+
* @deprecated (since 1.120.0)
|
|
10614
11711
|
*
|
|
10615
11712
|
* Gets a renderer instance for the given renderer name, that was created by the createRenderer method.
|
|
10616
11713
|
*
|
|
@@ -10680,8 +11777,8 @@ declare namespace sap {
|
|
|
10680
11777
|
* the fourth parameter `{config: {header: "hidden"}}`. Its adapter is an instance of `my.own.FooAdapter`
|
|
10681
11778
|
* constructed with the parameters logon system, "runtimeConfig" and `{config: {foo: "bar"}}`.
|
|
10682
11779
|
*
|
|
10683
|
-
*
|
|
10684
|
-
*
|
|
11780
|
+
* Note that the api will throw a runtime error (or reject for async mode) if the service name does not
|
|
11781
|
+
* reflect a service available.
|
|
10685
11782
|
* See:
|
|
10686
11783
|
* sap.ushell.services.ContainerInterface
|
|
10687
11784
|
*
|
|
@@ -10769,6 +11866,16 @@ declare namespace sap {
|
|
|
10769
11866
|
*/
|
|
10770
11867
|
sParameter?: string
|
|
10771
11868
|
): Promise<object>;
|
|
11869
|
+
/**
|
|
11870
|
+
* @since 1.15.0
|
|
11871
|
+
*
|
|
11872
|
+
* Logs out the current user from all relevant back-end systems, including the logon system itself. This
|
|
11873
|
+
* member represents the default native implementation of logout. If SessionHandler was created, we register
|
|
11874
|
+
* the alternate logout function using registerLogout function.
|
|
11875
|
+
*
|
|
11876
|
+
* @returns A `jQuery.promise` to be resolved when logout is finished, even when it fails.
|
|
11877
|
+
*/
|
|
11878
|
+
logout(): jQuery.Deferred;
|
|
10772
11879
|
/**
|
|
10773
11880
|
* @since 1.31.0
|
|
10774
11881
|
*
|
|
@@ -10888,6 +11995,8 @@ declare namespace sap {
|
|
|
10888
11995
|
|
|
10889
11996
|
"sap/ushell/services/_Personalization/PersonalizationContainerVariantSet": undefined;
|
|
10890
11997
|
|
|
11998
|
+
"sap/ushell/services/_Personalization/Personalizer": undefined;
|
|
11999
|
+
|
|
10891
12000
|
"sap/ushell/services/_Personalization/TransientPersonalizer": undefined;
|
|
10892
12001
|
|
|
10893
12002
|
"sap/ushell/services/_Personalization/Variant": undefined;
|
|
@@ -10900,12 +12009,28 @@ declare namespace sap {
|
|
|
10900
12009
|
|
|
10901
12010
|
"sap/ushell/services/Bookmark": undefined;
|
|
10902
12011
|
|
|
12012
|
+
"sap/ushell/services/BookmarkV2": undefined;
|
|
12013
|
+
|
|
10903
12014
|
"sap/ushell/services/Configuration": undefined;
|
|
10904
12015
|
|
|
10905
12016
|
"sap/ushell/services/CrossApplicationNavigation": undefined;
|
|
10906
12017
|
|
|
10907
12018
|
"sap/ushell/services/EndUserFeedback": undefined;
|
|
10908
12019
|
|
|
12020
|
+
"sap/ushell/services/Extension": undefined;
|
|
12021
|
+
|
|
12022
|
+
"sap/ushell/services/Extension/FloatingContainer": undefined;
|
|
12023
|
+
|
|
12024
|
+
"sap/ushell/services/Extension/Footer": undefined;
|
|
12025
|
+
|
|
12026
|
+
"sap/ushell/services/Extension/Header": undefined;
|
|
12027
|
+
|
|
12028
|
+
"sap/ushell/services/Extension/Item": undefined;
|
|
12029
|
+
|
|
12030
|
+
"sap/ushell/services/Extension/SidePane": undefined;
|
|
12031
|
+
|
|
12032
|
+
"sap/ushell/services/Extension/ToolArea": undefined;
|
|
12033
|
+
|
|
10909
12034
|
"sap/ushell/services/LaunchPage": undefined;
|
|
10910
12035
|
|
|
10911
12036
|
"sap/ushell/services/Message": undefined;
|
|
@@ -10916,10 +12041,24 @@ declare namespace sap {
|
|
|
10916
12041
|
|
|
10917
12042
|
"sap/ushell/services/Notifications": undefined;
|
|
10918
12043
|
|
|
12044
|
+
"sap/ushell/services/NotificationsV2": undefined;
|
|
12045
|
+
|
|
10919
12046
|
"sap/ushell/services/Personalization": undefined;
|
|
10920
12047
|
|
|
10921
12048
|
"sap/ushell/services/personalization/VariantSetAdapter": undefined;
|
|
10922
12049
|
|
|
12050
|
+
"sap/ushell/services/PersonalizationV2": undefined;
|
|
12051
|
+
|
|
12052
|
+
"sap/ushell/services/PersonalizationV2/ContextContainer": undefined;
|
|
12053
|
+
|
|
12054
|
+
"sap/ushell/services/PersonalizationV2/Personalizer": undefined;
|
|
12055
|
+
|
|
12056
|
+
"sap/ushell/services/PersonalizationV2/TransientPersonalizer": undefined;
|
|
12057
|
+
|
|
12058
|
+
"sap/ushell/services/PersonalizationV2/Variant": undefined;
|
|
12059
|
+
|
|
12060
|
+
"sap/ushell/services/PersonalizationV2/VariantSetAdapter": undefined;
|
|
12061
|
+
|
|
10923
12062
|
"sap/ushell/services/SearchableContent": undefined;
|
|
10924
12063
|
|
|
10925
12064
|
"sap/ushell/services/ShellNavigation": undefined;
|