@sapui5/ts-types 1.115.0 → 1.116.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -14
- package/package.json +1 -1
- package/types/index.d.ts +11 -3
- package/types/sap.apf.d.ts +38 -30
- package/types/sap.ca.ui.d.ts +129 -87
- package/types/sap.chart.d.ts +51 -53
- package/types/sap.collaboration.d.ts +22 -20
- package/types/sap.esh.search.ui.d.ts +111 -107
- package/types/sap.f.d.ts +637 -726
- package/types/sap.fe.core.d.ts +187 -61
- package/types/sap.fe.macros.d.ts +46 -16
- package/types/sap.fe.navigation.d.ts +5 -5
- package/types/sap.fe.placeholder.d.ts +3 -0
- package/types/sap.fe.templates.d.ts +5 -6
- package/types/sap.fe.test.d.ts +4 -4
- package/types/sap.fe.tools.d.ts +3 -0
- package/types/sap.feedback.ui.d.ts +1 -1
- package/types/sap.gantt.d.ts +1074 -1207
- package/types/sap.insights.d.ts +3 -3
- package/types/sap.landvisz.d.ts +53 -27
- package/types/sap.m.d.ts +6012 -6875
- package/types/sap.makit.d.ts +42 -30
- package/types/sap.me.d.ts +61 -85
- package/types/sap.ndc.d.ts +43 -34
- package/types/sap.ovp.d.ts +19 -6
- package/types/sap.rules.ui.d.ts +29 -37
- package/types/sap.sac.df.d.ts +7 -5
- package/types/sap.suite.ui.commons.d.ts +1012 -1165
- package/types/sap.suite.ui.generic.template.d.ts +66 -64
- package/types/sap.suite.ui.microchart.d.ts +253 -225
- package/types/sap.tnt.d.ts +108 -87
- package/types/sap.ui.codeeditor.d.ts +26 -38
- package/types/sap.ui.commons.d.ts +541 -751
- package/types/sap.ui.comp.d.ts +2160 -2168
- package/types/sap.ui.core.d.ts +2094 -2062
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.export.d.ts +31 -27
- package/types/sap.ui.fl.d.ts +48 -100
- package/types/sap.ui.generic.app.d.ts +28 -30
- package/types/sap.ui.generic.template.d.ts +1 -1
- package/types/sap.ui.integration.d.ts +391 -319
- package/types/sap.ui.layout.d.ts +317 -341
- package/types/sap.ui.mdc.d.ts +1505 -1386
- package/types/sap.ui.richtexteditor.d.ts +39 -39
- package/types/sap.ui.rta.d.ts +7 -7
- package/types/sap.ui.suite.d.ts +12 -8
- package/types/sap.ui.support.d.ts +11 -11
- package/types/sap.ui.table.d.ts +344 -454
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +875 -953
- package/types/sap.ui.ux3.d.ts +598 -816
- package/types/sap.ui.vbm.d.ts +496 -764
- package/types/sap.ui.vk.d.ts +1332 -1844
- package/types/sap.ui.vtm.d.ts +312 -386
- package/types/sap.ui.webc.common.d.ts +9 -9
- package/types/sap.ui.webc.fiori.d.ts +1036 -480
- package/types/sap.ui.webc.main.d.ts +4920 -1500
- package/types/sap.uiext.inbox.d.ts +57 -31
- package/types/sap.ushell.d.ts +451 -981
- package/types/sap.ushell_abap.d.ts +1 -1
- package/types/sap.uxap.d.ts +220 -252
- package/types/sap.viz.d.ts +861 -605
- package/types/sap.webanalytics.core.d.ts +1 -1
- package/types/sap.zen.commons.d.ts +2 -2
- package/types/sap.zen.crosstab.d.ts +2 -2
- package/types/sap.zen.dsh.d.ts +127 -157
package/types/sap.ushell.d.ts
CHANGED
|
@@ -1,18 +1,18 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.116.0
|
|
2
2
|
|
|
3
3
|
declare namespace sap {
|
|
4
4
|
namespace ushell {
|
|
5
5
|
/**
|
|
6
|
-
* @
|
|
6
|
+
* @since 1.15.0
|
|
7
7
|
*
|
|
8
8
|
* See:
|
|
9
9
|
* sap.ushell.Container.getServiceAsync()
|
|
10
10
|
*/
|
|
11
11
|
namespace services {
|
|
12
12
|
/**
|
|
13
|
-
* @
|
|
13
|
+
* @since 1.62.0
|
|
14
14
|
* @deprecated
|
|
15
|
-
* @
|
|
15
|
+
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
16
16
|
*/
|
|
17
17
|
export const ContentExtensionAdapterFactory: undefined;
|
|
18
18
|
|
|
@@ -47,7 +47,7 @@ declare namespace sap {
|
|
|
47
47
|
|
|
48
48
|
namespace Personalization {
|
|
49
49
|
/**
|
|
50
|
-
* @
|
|
50
|
+
* @since 1.22.0
|
|
51
51
|
*
|
|
52
52
|
* The container is the anchor object of the unified shell personalization in container mode.
|
|
53
53
|
*/
|
|
@@ -58,7 +58,7 @@ declare namespace sap {
|
|
|
58
58
|
constructor();
|
|
59
59
|
|
|
60
60
|
/**
|
|
61
|
-
* @
|
|
61
|
+
* @since 1.22.0
|
|
62
62
|
*
|
|
63
63
|
* Returns an array with all internal keys of direct items in the container.
|
|
64
64
|
*
|
|
@@ -66,13 +66,13 @@ declare namespace sap {
|
|
|
66
66
|
*/
|
|
67
67
|
_getInternalKeys(): any[];
|
|
68
68
|
/**
|
|
69
|
-
* @
|
|
69
|
+
* @since 1.22.0
|
|
70
70
|
*
|
|
71
71
|
* clears the local copy data of this container
|
|
72
72
|
*/
|
|
73
73
|
clear(): void;
|
|
74
74
|
/**
|
|
75
|
-
* @
|
|
75
|
+
* @since 1.22.0
|
|
76
76
|
*
|
|
77
77
|
* Checks if a specific direct item is contained in the container.
|
|
78
78
|
*
|
|
@@ -85,7 +85,7 @@ declare namespace sap {
|
|
|
85
85
|
sItemKey: string
|
|
86
86
|
): boolean;
|
|
87
87
|
/**
|
|
88
|
-
* @
|
|
88
|
+
* @since 1.22.0
|
|
89
89
|
*
|
|
90
90
|
* Deletes a direct item from the container. In case the item does not exist, nothing happens.
|
|
91
91
|
*/
|
|
@@ -96,7 +96,7 @@ declare namespace sap {
|
|
|
96
96
|
sItemKey: string
|
|
97
97
|
): void;
|
|
98
98
|
/**
|
|
99
|
-
* @
|
|
99
|
+
* @since 1.22.0
|
|
100
100
|
*
|
|
101
101
|
* flush all pending request; The result of the promise may reflect the last pending operation in the queue
|
|
102
102
|
*
|
|
@@ -104,7 +104,7 @@ declare namespace sap {
|
|
|
104
104
|
*/
|
|
105
105
|
flush(): object;
|
|
106
106
|
/**
|
|
107
|
-
* @
|
|
107
|
+
* @since 1.22.0
|
|
108
108
|
*
|
|
109
109
|
* Returns an array with the keys of direct items in the container.
|
|
110
110
|
*
|
|
@@ -112,7 +112,7 @@ declare namespace sap {
|
|
|
112
112
|
*/
|
|
113
113
|
getItemKeys(): any[];
|
|
114
114
|
/**
|
|
115
|
-
* @
|
|
115
|
+
* @since 1.22.0
|
|
116
116
|
*
|
|
117
117
|
* Returns the value for a direct item from the container. (Value semantics, new copy is returned)
|
|
118
118
|
*
|
|
@@ -126,7 +126,7 @@ declare namespace sap {
|
|
|
126
126
|
sItemKey: string
|
|
127
127
|
): object;
|
|
128
128
|
/**
|
|
129
|
-
* @
|
|
129
|
+
* @since 1.28.0
|
|
130
130
|
*
|
|
131
131
|
* return the container key as a string variable
|
|
132
132
|
*
|
|
@@ -134,7 +134,7 @@ declare namespace sap {
|
|
|
134
134
|
*/
|
|
135
135
|
getKey(): string;
|
|
136
136
|
/**
|
|
137
|
-
* @
|
|
137
|
+
* @since 1.28.0
|
|
138
138
|
*
|
|
139
139
|
* Return an instance unmodifiable container instance. There is one instance of this wrapper per container.
|
|
140
140
|
* It will permit all read accesses to the container, but block all modifying accesses.
|
|
@@ -143,14 +143,14 @@ declare namespace sap {
|
|
|
143
143
|
*/
|
|
144
144
|
getUnmodifiableContainer(): object;
|
|
145
145
|
/**
|
|
146
|
-
* @
|
|
146
|
+
* @since 1.22.0
|
|
147
147
|
* @deprecated (since 1.31) - Support for this function has been discontinued.
|
|
148
148
|
*
|
|
149
149
|
* return the validity of this container only for testing!
|
|
150
150
|
*/
|
|
151
151
|
getValidity(): void;
|
|
152
152
|
/**
|
|
153
|
-
* @
|
|
153
|
+
* @since 1.22.0
|
|
154
154
|
*
|
|
155
155
|
* (Re)loads the current container data from the underlying storage asynchronously. The current local data
|
|
156
156
|
* is discarded.
|
|
@@ -164,7 +164,7 @@ declare namespace sap {
|
|
|
164
164
|
*/
|
|
165
165
|
load(): object;
|
|
166
166
|
/**
|
|
167
|
-
* @
|
|
167
|
+
* @since 1.22.0
|
|
168
168
|
*
|
|
169
169
|
* Attempts to save the current container data at the underlying storage asynchronously. The current state
|
|
170
170
|
* is serialized.
|
|
@@ -175,7 +175,7 @@ declare namespace sap {
|
|
|
175
175
|
*/
|
|
176
176
|
save(): object;
|
|
177
177
|
/**
|
|
178
|
-
* @
|
|
178
|
+
* @since 1.22.0
|
|
179
179
|
*
|
|
180
180
|
* Save the current container data at the underlying storage asynchronously at the earlies nDelayInMilliseconds
|
|
181
181
|
* seconds before. The current state is serialized.
|
|
@@ -186,7 +186,7 @@ declare namespace sap {
|
|
|
186
186
|
*/
|
|
187
187
|
saveDeferred(): object;
|
|
188
188
|
/**
|
|
189
|
-
* @
|
|
189
|
+
* @since 1.22.0
|
|
190
190
|
*
|
|
191
191
|
* Sets the value of a direct item in the container. In case the item is already existing its value is overwritten.
|
|
192
192
|
* In case it is not existing a new item with this key and value is created. The value is serialized during
|
|
@@ -204,7 +204,7 @@ declare namespace sap {
|
|
|
204
204
|
): void;
|
|
205
205
|
}
|
|
206
206
|
/**
|
|
207
|
-
* @
|
|
207
|
+
* @since 1.22.0
|
|
208
208
|
*
|
|
209
209
|
* The personalization variant contains personalization data. It is used in the personalization container
|
|
210
210
|
* mode.
|
|
@@ -216,7 +216,7 @@ declare namespace sap {
|
|
|
216
216
|
constructor();
|
|
217
217
|
|
|
218
218
|
/**
|
|
219
|
-
* @
|
|
219
|
+
* @since 1.18.0
|
|
220
220
|
*
|
|
221
221
|
* Checks if a specific item is contained in this variant.
|
|
222
222
|
*
|
|
@@ -229,7 +229,7 @@ declare namespace sap {
|
|
|
229
229
|
sItemKey: string
|
|
230
230
|
): boolean;
|
|
231
231
|
/**
|
|
232
|
-
* @
|
|
232
|
+
* @since 1.22.0
|
|
233
233
|
*
|
|
234
234
|
* Deletes an item from this variant. In case the item does not exist, nothing happens.
|
|
235
235
|
*/
|
|
@@ -240,7 +240,7 @@ declare namespace sap {
|
|
|
240
240
|
sItemKey: string
|
|
241
241
|
): void;
|
|
242
242
|
/**
|
|
243
|
-
* @
|
|
243
|
+
* @since 1.22.0
|
|
244
244
|
*
|
|
245
245
|
* Returns an array with the keys of all items in this variant.
|
|
246
246
|
*
|
|
@@ -248,7 +248,7 @@ declare namespace sap {
|
|
|
248
248
|
*/
|
|
249
249
|
getItemKeys(): any[];
|
|
250
250
|
/**
|
|
251
|
-
* @
|
|
251
|
+
* @since 1.18.0
|
|
252
252
|
*
|
|
253
253
|
* Returns the value for an item in this variant.
|
|
254
254
|
*
|
|
@@ -262,7 +262,7 @@ declare namespace sap {
|
|
|
262
262
|
sItemKey: string
|
|
263
263
|
): object;
|
|
264
264
|
/**
|
|
265
|
-
* @
|
|
265
|
+
* @since 1.22.0
|
|
266
266
|
*
|
|
267
267
|
* Returns the key of this variant.
|
|
268
268
|
*
|
|
@@ -270,7 +270,7 @@ declare namespace sap {
|
|
|
270
270
|
*/
|
|
271
271
|
getVariantKey(): string;
|
|
272
272
|
/**
|
|
273
|
-
* @
|
|
273
|
+
* @since 1.22.0
|
|
274
274
|
*
|
|
275
275
|
* Returns the name of this variant.
|
|
276
276
|
*
|
|
@@ -278,7 +278,7 @@ declare namespace sap {
|
|
|
278
278
|
*/
|
|
279
279
|
getVariantName(): string;
|
|
280
280
|
/**
|
|
281
|
-
* @
|
|
281
|
+
* @since 1.18.0
|
|
282
282
|
*
|
|
283
283
|
* Sets the value for an item in this variant.
|
|
284
284
|
*/
|
|
@@ -293,7 +293,7 @@ declare namespace sap {
|
|
|
293
293
|
item: object
|
|
294
294
|
): void;
|
|
295
295
|
/**
|
|
296
|
-
* @
|
|
296
|
+
* @since 1.24.0
|
|
297
297
|
*
|
|
298
298
|
* Sets the name of the variant.
|
|
299
299
|
*
|
|
@@ -308,7 +308,7 @@ declare namespace sap {
|
|
|
308
308
|
): void;
|
|
309
309
|
}
|
|
310
310
|
/**
|
|
311
|
-
* @
|
|
311
|
+
* @since 1.22.0
|
|
312
312
|
*
|
|
313
313
|
* The personalization variant set contains variants of personalization data. It is used in the personalization
|
|
314
314
|
* container mode.
|
|
@@ -325,7 +325,7 @@ declare namespace sap {
|
|
|
325
325
|
constructor();
|
|
326
326
|
|
|
327
327
|
/**
|
|
328
|
-
* @
|
|
328
|
+
* @since 1.22.0
|
|
329
329
|
*
|
|
330
330
|
* Creates a new variant in the variant set. In case a variant with this name is already existing an exception
|
|
331
331
|
* is thrown.
|
|
@@ -339,7 +339,7 @@ declare namespace sap {
|
|
|
339
339
|
sVariantSetName: string
|
|
340
340
|
): object;
|
|
341
341
|
/**
|
|
342
|
-
* @
|
|
342
|
+
* @since 1.22.0
|
|
343
343
|
*
|
|
344
344
|
* Checks if a specific variant is contained in the variant set.
|
|
345
345
|
*
|
|
@@ -352,7 +352,7 @@ declare namespace sap {
|
|
|
352
352
|
sVariantKey: string
|
|
353
353
|
): boolean;
|
|
354
354
|
/**
|
|
355
|
-
* @
|
|
355
|
+
* @since 1.22.0
|
|
356
356
|
*
|
|
357
357
|
* Deletes a variant from the variant set. In case the variant does not exist nothing happens.
|
|
358
358
|
*/
|
|
@@ -363,7 +363,7 @@ declare namespace sap {
|
|
|
363
363
|
sVariantKey: string
|
|
364
364
|
): void;
|
|
365
365
|
/**
|
|
366
|
-
* @
|
|
366
|
+
* @since 1.22.0
|
|
367
367
|
*
|
|
368
368
|
* Returns the current variant key.
|
|
369
369
|
*
|
|
@@ -371,7 +371,7 @@ declare namespace sap {
|
|
|
371
371
|
*/
|
|
372
372
|
getCurrentVariantKey(): string;
|
|
373
373
|
/**
|
|
374
|
-
* @
|
|
374
|
+
* @since 1.22.0
|
|
375
375
|
*
|
|
376
376
|
* Returns a variant object.
|
|
377
377
|
*
|
|
@@ -385,7 +385,7 @@ declare namespace sap {
|
|
|
385
385
|
sVariantKey: string
|
|
386
386
|
): object;
|
|
387
387
|
/**
|
|
388
|
-
* @
|
|
388
|
+
* @since 1.22.0
|
|
389
389
|
*
|
|
390
390
|
* Returns the variant key corresponding to a variant name.
|
|
391
391
|
*
|
|
@@ -399,7 +399,7 @@ declare namespace sap {
|
|
|
399
399
|
sVariantName: string
|
|
400
400
|
): string;
|
|
401
401
|
/**
|
|
402
|
-
* @
|
|
402
|
+
* @since 1.22.0
|
|
403
403
|
*
|
|
404
404
|
* Returns an array with the keys of the variants in the variant set.
|
|
405
405
|
*
|
|
@@ -407,7 +407,7 @@ declare namespace sap {
|
|
|
407
407
|
*/
|
|
408
408
|
getVariantKeys(): any[];
|
|
409
409
|
/**
|
|
410
|
-
* @
|
|
410
|
+
* @since 1.22.0
|
|
411
411
|
*
|
|
412
412
|
* Sets the current variant key.
|
|
413
413
|
*/
|
|
@@ -422,7 +422,7 @@ declare namespace sap {
|
|
|
422
422
|
|
|
423
423
|
namespace personalization {
|
|
424
424
|
/**
|
|
425
|
-
* @
|
|
425
|
+
* @since 1.18.0
|
|
426
426
|
*
|
|
427
427
|
* Wrapper object to expose a variant interface on a ContextContainer object obtained from the Peronalization
|
|
428
428
|
* service:
|
|
@@ -453,7 +453,7 @@ declare namespace sap {
|
|
|
453
453
|
}
|
|
454
454
|
|
|
455
455
|
/**
|
|
456
|
-
* @
|
|
456
|
+
* @since 1.15.0
|
|
457
457
|
*
|
|
458
458
|
* The unified shell's AppConfiguration service.
|
|
459
459
|
*/
|
|
@@ -474,7 +474,7 @@ declare namespace sap {
|
|
|
474
474
|
): void;
|
|
475
475
|
}
|
|
476
476
|
/**
|
|
477
|
-
* @
|
|
477
|
+
* @since 1.38
|
|
478
478
|
*
|
|
479
479
|
* The Unified Shell's AppLifeCycle service.
|
|
480
480
|
*
|
|
@@ -485,7 +485,7 @@ declare namespace sap {
|
|
|
485
485
|
constructor();
|
|
486
486
|
|
|
487
487
|
/**
|
|
488
|
-
* @
|
|
488
|
+
* @since 1.38
|
|
489
489
|
*
|
|
490
490
|
* Attaches an event handler for the appLoaded event. This event handler will be triggered each time an
|
|
491
491
|
* application has been loaded.
|
|
@@ -505,7 +505,7 @@ declare namespace sap {
|
|
|
505
505
|
oListener: object
|
|
506
506
|
): void;
|
|
507
507
|
/**
|
|
508
|
-
* @
|
|
508
|
+
* @since 1.38
|
|
509
509
|
*
|
|
510
510
|
* Detaches an event handler from the EventProvider.
|
|
511
511
|
*/
|
|
@@ -520,12 +520,15 @@ declare namespace sap {
|
|
|
520
520
|
oListener: object
|
|
521
521
|
): void;
|
|
522
522
|
/**
|
|
523
|
-
* @
|
|
523
|
+
* @since 1.38
|
|
524
524
|
*
|
|
525
525
|
* Returns information about the currently running application.
|
|
526
526
|
*
|
|
527
527
|
* The function returns an object with following parameters:
|
|
528
528
|
* - applicationType: “UI5|WDA|NWBC|URL|TR”
|
|
529
|
+
* - applicationFramework: when applicationType is "URL", this parameter indicates which application
|
|
530
|
+
* framework is running inside the iframe - “UI5|WDA|GUI|CRM”. This attribute is for SAP internal usage
|
|
531
|
+
* only.
|
|
529
532
|
* - componentInstance: reference to component (only for applicationType "UI5").
|
|
530
533
|
* - homePage: `true` when root intent (normally #Shell-home) or Appfinder (#Shell-appfinder) is currently
|
|
531
534
|
* displayed.
|
|
@@ -559,7 +562,7 @@ declare namespace sap {
|
|
|
559
562
|
getCurrentApplication(): object | undefined;
|
|
560
563
|
}
|
|
561
564
|
/**
|
|
562
|
-
* @
|
|
565
|
+
* @since 1.15.0
|
|
563
566
|
*
|
|
564
567
|
* The Unified Shell's bookmark service, which allows you to create shortcuts on the user's home page.
|
|
565
568
|
*
|
|
@@ -570,7 +573,7 @@ declare namespace sap {
|
|
|
570
573
|
constructor();
|
|
571
574
|
|
|
572
575
|
/**
|
|
573
|
-
* @
|
|
576
|
+
* @since 1.15.0
|
|
574
577
|
*
|
|
575
578
|
* Adds a bookmark tile to one of the user's classic homepage groups or to multiple provided content nodes.
|
|
576
579
|
* See:
|
|
@@ -654,7 +657,7 @@ declare namespace sap {
|
|
|
654
657
|
sContentProviderId?: string
|
|
655
658
|
): jQuery.Promise;
|
|
656
659
|
/**
|
|
657
|
-
* @
|
|
660
|
+
* @since 1.21.2
|
|
658
661
|
* @deprecated (since 1.112) - Please use {@link #addBookmark} instead.
|
|
659
662
|
*
|
|
660
663
|
* Adds the catalog tile with the given ID to given group. The catalog tile is looked up in the legacy SAP
|
|
@@ -688,7 +691,7 @@ declare namespace sap {
|
|
|
688
691
|
}
|
|
689
692
|
): jQuery.Promise;
|
|
690
693
|
/**
|
|
691
|
-
* @
|
|
694
|
+
* @since 1.17.1
|
|
692
695
|
*
|
|
693
696
|
* Counts **all** bookmarks pointing to the given URL from all of the user's pages. You can use this method
|
|
694
697
|
* to check if a bookmark already exists. This is a potentially asynchronous operation in case the user's
|
|
@@ -711,7 +714,7 @@ declare namespace sap {
|
|
|
711
714
|
sContentProviderId: string
|
|
712
715
|
): jQuery.Promise;
|
|
713
716
|
/**
|
|
714
|
-
* @
|
|
717
|
+
* @since 1.17.1
|
|
715
718
|
*
|
|
716
719
|
* Deletes **all** bookmarks pointing to the given URL from all of the user's pages.
|
|
717
720
|
* See:
|
|
@@ -733,7 +736,7 @@ declare namespace sap {
|
|
|
733
736
|
sContentProviderId?: string
|
|
734
737
|
): jQuery.Promise;
|
|
735
738
|
/**
|
|
736
|
-
* @
|
|
739
|
+
* @since 1.81
|
|
737
740
|
*
|
|
738
741
|
* Returns available content nodes based on the current launchpad context. (Classic homepage, spaces mode)
|
|
739
742
|
*
|
|
@@ -754,7 +757,7 @@ declare namespace sap {
|
|
|
754
757
|
*/
|
|
755
758
|
getContentNodes(): Promise<sap.ushell.services.Bookmark.ContentNode[]>;
|
|
756
759
|
/**
|
|
757
|
-
* @
|
|
760
|
+
* @since 1.17.1
|
|
758
761
|
*
|
|
759
762
|
* Updates **all** bookmarks pointing to the given URL on all of the user's pages with the given new parameters.
|
|
760
763
|
* Parameters which are omitted are not changed in the existing bookmarks.
|
|
@@ -839,7 +842,7 @@ declare namespace sap {
|
|
|
839
842
|
): jQuery.Promise;
|
|
840
843
|
}
|
|
841
844
|
/**
|
|
842
|
-
* @
|
|
845
|
+
* @since 1.64.0
|
|
843
846
|
*
|
|
844
847
|
* The unified shell's Configuration service, which allows to attach to **selected** launchpad configuration
|
|
845
848
|
* settings and their value changes.
|
|
@@ -854,7 +857,7 @@ declare namespace sap {
|
|
|
854
857
|
constructor();
|
|
855
858
|
}
|
|
856
859
|
/**
|
|
857
|
-
* @
|
|
860
|
+
* @since 1.15.0
|
|
858
861
|
*
|
|
859
862
|
* The Unified Shell's CrossApplicationNavigation service allows to navigate to "external" targets outside
|
|
860
863
|
* of the currently running app (but still in scope of the current Fiori launchpad) or create links to such
|
|
@@ -945,7 +948,7 @@ declare namespace sap {
|
|
|
945
948
|
sHashFragment: string
|
|
946
949
|
): jQuery.Promise;
|
|
947
950
|
/**
|
|
948
|
-
* @
|
|
951
|
+
* @since 1.38.0
|
|
949
952
|
*
|
|
950
953
|
* Returns a list of semantic objects of the intents the current user can navigate to.
|
|
951
954
|
*
|
|
@@ -956,7 +959,7 @@ declare namespace sap {
|
|
|
956
959
|
*/
|
|
957
960
|
getDistinctSemanticObjects(): jQuery.Promise;
|
|
958
961
|
/**
|
|
959
|
-
* @
|
|
962
|
+
* @since 1.38.0
|
|
960
963
|
*
|
|
961
964
|
* Resolves the given semantic object (and action) and business parameters to a list of links available
|
|
962
965
|
* to the user.
|
|
@@ -1194,7 +1197,7 @@ declare namespace sap {
|
|
|
1194
1197
|
}>
|
|
1195
1198
|
): jQuery.Promise;
|
|
1196
1199
|
/**
|
|
1197
|
-
* @
|
|
1200
|
+
* @since 1.48
|
|
1198
1201
|
*
|
|
1199
1202
|
* For a given semantic object, this method considers all actions associated with the semantic object and
|
|
1200
1203
|
* returns the one tagged as a "primaryAction". If no inbound tagged as "primaryAction" exists, then the
|
|
@@ -1229,7 +1232,7 @@ declare namespace sap {
|
|
|
1229
1232
|
mParameters?: object
|
|
1230
1233
|
): jQuery.Deferred;
|
|
1231
1234
|
/**
|
|
1232
|
-
* @
|
|
1235
|
+
* @since 1.19.0
|
|
1233
1236
|
* @deprecated (since 1.38) - Please use {@link #getLinks} instead.
|
|
1234
1237
|
*
|
|
1235
1238
|
* Resolves a given semantic object and business parameters to a list of links, taking into account the
|
|
@@ -1301,7 +1304,7 @@ declare namespace sap {
|
|
|
1301
1304
|
iSteps: number
|
|
1302
1305
|
): void;
|
|
1303
1306
|
/**
|
|
1304
|
-
* @
|
|
1307
|
+
* @since 1.15.0
|
|
1305
1308
|
* @deprecated (since 1.94) - Please use {@link #hrefForAppSpecificHashAsync} instead.
|
|
1306
1309
|
*
|
|
1307
1310
|
* Returns a string which can be put into the DOM (e.g. in a link tag) given an application specific hash
|
|
@@ -1322,7 +1325,7 @@ declare namespace sap {
|
|
|
1322
1325
|
sAppHash: string
|
|
1323
1326
|
): string;
|
|
1324
1327
|
/**
|
|
1325
|
-
* @
|
|
1328
|
+
* @since 1.94.0
|
|
1326
1329
|
*
|
|
1327
1330
|
* Returns a Promise which resolves a string that can be put into the DOM (e.g. in a link tag) given an
|
|
1328
1331
|
* application specific hash suffix
|
|
@@ -1342,7 +1345,7 @@ declare namespace sap {
|
|
|
1342
1345
|
sAppHash: string
|
|
1343
1346
|
): Promise<string>;
|
|
1344
1347
|
/**
|
|
1345
|
-
* @
|
|
1348
|
+
* @since 1.15.0
|
|
1346
1349
|
* @deprecated (since 1.98) - Please use {@link #hrefForExternalAsync} instead.
|
|
1347
1350
|
*
|
|
1348
1351
|
* Returns a string which can be put into the DOM (e.g. in a link tag). **Note:** The generated url / url
|
|
@@ -1427,7 +1430,7 @@ declare namespace sap {
|
|
|
1427
1430
|
bAsync: boolean
|
|
1428
1431
|
): string | Promise<string>;
|
|
1429
1432
|
/**
|
|
1430
|
-
* @
|
|
1433
|
+
* @since 1.15.0
|
|
1431
1434
|
* @deprecated (since 1.98) - Please use {@link #hrefForExternalAsync} instead.
|
|
1432
1435
|
*
|
|
1433
1436
|
* Returns a string which can be put into the DOM (e.g. in a link tag). **Note:** The generated url / url
|
|
@@ -1508,7 +1511,7 @@ declare namespace sap {
|
|
|
1508
1511
|
bAsync: boolean
|
|
1509
1512
|
): string | Promise<string>;
|
|
1510
1513
|
/**
|
|
1511
|
-
* @
|
|
1514
|
+
* @since 1.94.0
|
|
1512
1515
|
*
|
|
1513
1516
|
* Returns a promise resolving to a URL that launches an app with certain parameters. The URL can be used
|
|
1514
1517
|
* to define a link to a Fiori application, for example.
|
|
@@ -1599,7 +1602,7 @@ declare namespace sap {
|
|
|
1599
1602
|
oComponent?: object
|
|
1600
1603
|
): Promise<string>;
|
|
1601
1604
|
/**
|
|
1602
|
-
* @
|
|
1605
|
+
* @since 1.36.0
|
|
1603
1606
|
* @deprecated (since 1.94) - Please use {@link #isInitialNavigationAsync} instead.
|
|
1604
1607
|
*
|
|
1605
1608
|
* Checks wether the FLP currently shows the initially loaded navigation target (i.e. the intent it was
|
|
@@ -1610,7 +1613,7 @@ declare namespace sap {
|
|
|
1610
1613
|
*/
|
|
1611
1614
|
isInitialNavigation(): boolean;
|
|
1612
1615
|
/**
|
|
1613
|
-
* @
|
|
1616
|
+
* @since 1.94.0
|
|
1614
1617
|
*
|
|
1615
1618
|
* Checks whether the FLP has performed the first navigation. This method can be used to detect whether
|
|
1616
1619
|
* the current app was started directly, that is, without a previous navigation to another app, to the FLP
|
|
@@ -1620,7 +1623,7 @@ declare namespace sap {
|
|
|
1620
1623
|
*/
|
|
1621
1624
|
isInitialNavigationAsync(): Promise<boolean>;
|
|
1622
1625
|
/**
|
|
1623
|
-
* @
|
|
1626
|
+
* @since 1.19.1
|
|
1624
1627
|
* @deprecated (since 1.31) - Please use {@link #isNavigationSupported} instead. Note that this has a slightly
|
|
1625
1628
|
* different response format.
|
|
1626
1629
|
*
|
|
@@ -1669,7 +1672,7 @@ declare namespace sap {
|
|
|
1669
1672
|
oComponent?: object
|
|
1670
1673
|
): jQuery.Promise;
|
|
1671
1674
|
/**
|
|
1672
|
-
* @
|
|
1675
|
+
* @since 1.32
|
|
1673
1676
|
*
|
|
1674
1677
|
* Tells whether the given navigation intents are supported for the given parameters, form factor etc. .
|
|
1675
1678
|
* "Supported" means that a valid navigation target is configured for the user and for the given device.
|
|
@@ -1783,7 +1786,7 @@ declare namespace sap {
|
|
|
1783
1786
|
oComponent?: object
|
|
1784
1787
|
): jQuery.Promise;
|
|
1785
1788
|
/**
|
|
1786
|
-
* @
|
|
1789
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1787
1790
|
*
|
|
1788
1791
|
* Resolves the URL hash fragment.
|
|
1789
1792
|
*
|
|
@@ -1801,7 +1804,7 @@ declare namespace sap {
|
|
|
1801
1804
|
sHashFragment: string
|
|
1802
1805
|
): jQuery.Promise;
|
|
1803
1806
|
/**
|
|
1804
|
-
* @
|
|
1807
|
+
* @since 1.15.0
|
|
1805
1808
|
*
|
|
1806
1809
|
* Triggers a navigation to a specified target outside of the currently running application (e.g. different
|
|
1807
1810
|
* launchpad application). Invocation will trigger a hash change and subsequent invocation of the target.
|
|
@@ -1915,7 +1918,7 @@ declare namespace sap {
|
|
|
1915
1918
|
): Promise<void>;
|
|
1916
1919
|
}
|
|
1917
1920
|
/**
|
|
1918
|
-
* @
|
|
1921
|
+
* @since 1.25.1
|
|
1919
1922
|
* @deprecated (since 1.93)
|
|
1920
1923
|
*
|
|
1921
1924
|
* The Unified Shell's end user feedback service. This service is deprecated and does nothing. End user
|
|
@@ -1931,7 +1934,7 @@ declare namespace sap {
|
|
|
1931
1934
|
constructor();
|
|
1932
1935
|
|
|
1933
1936
|
/**
|
|
1934
|
-
* @
|
|
1937
|
+
* @since 1.25.1
|
|
1935
1938
|
* @deprecated (since 1.93)
|
|
1936
1939
|
*
|
|
1937
1940
|
*
|
|
@@ -1939,7 +1942,7 @@ declare namespace sap {
|
|
|
1939
1942
|
*/
|
|
1940
1943
|
getLegalText(): string;
|
|
1941
1944
|
/**
|
|
1942
|
-
* @
|
|
1945
|
+
* @since 1.25.1
|
|
1943
1946
|
* @deprecated (since 1.93)
|
|
1944
1947
|
*
|
|
1945
1948
|
* The service is deprecated. The function always returns a negative answer.
|
|
@@ -1948,7 +1951,7 @@ declare namespace sap {
|
|
|
1948
1951
|
*/
|
|
1949
1952
|
isEnabled(): Object;
|
|
1950
1953
|
/**
|
|
1951
|
-
* @
|
|
1954
|
+
* @since 1.25.1
|
|
1952
1955
|
* @deprecated (since 1.93)
|
|
1953
1956
|
*
|
|
1954
1957
|
* Sends a feedback.
|
|
@@ -1958,7 +1961,7 @@ declare namespace sap {
|
|
|
1958
1961
|
sendFeedback(): Promise<any>;
|
|
1959
1962
|
}
|
|
1960
1963
|
/**
|
|
1961
|
-
* @
|
|
1964
|
+
* @since 1.15.0
|
|
1962
1965
|
* @deprecated (since 1.99) - This service has been deprecated as it only works for the classic homepage.
|
|
1963
1966
|
*
|
|
1964
1967
|
* A service for handling groups, tiles and catalogs.
|
|
@@ -2060,7 +2063,7 @@ declare namespace sap {
|
|
|
2060
2063
|
oTile: object
|
|
2061
2064
|
): Function;
|
|
2062
2065
|
/**
|
|
2063
|
-
* @
|
|
2066
|
+
* @since 1.21.2
|
|
2064
2067
|
*
|
|
2065
2068
|
* Returns catalog's technical data.
|
|
2066
2069
|
*
|
|
@@ -2077,7 +2080,7 @@ declare namespace sap {
|
|
|
2077
2080
|
oCatalog: object
|
|
2078
2081
|
): object;
|
|
2079
2082
|
/**
|
|
2080
|
-
* @
|
|
2083
|
+
* @since 1.17.1
|
|
2081
2084
|
*
|
|
2082
2085
|
* Returns the catalog's technical error message in case it could not be loaded from the backend. **Beware:**
|
|
2083
2086
|
* The technical error message is not translated!
|
|
@@ -2140,7 +2143,7 @@ declare namespace sap {
|
|
|
2140
2143
|
oCatalogTile: object
|
|
2141
2144
|
): string[];
|
|
2142
2145
|
/**
|
|
2143
|
-
* @
|
|
2146
|
+
* @since 1.16.3
|
|
2144
2147
|
*
|
|
2145
2148
|
* Returns preview icon for a catalog tile.
|
|
2146
2149
|
*
|
|
@@ -2154,7 +2157,7 @@ declare namespace sap {
|
|
|
2154
2157
|
oCatalogTile: object
|
|
2155
2158
|
): string;
|
|
2156
2159
|
/**
|
|
2157
|
-
* @
|
|
2160
|
+
* @since 1.40
|
|
2158
2161
|
*
|
|
2159
2162
|
* Returns preview subtitle for a catalog tile.
|
|
2160
2163
|
*
|
|
@@ -2168,7 +2171,7 @@ declare namespace sap {
|
|
|
2168
2171
|
oCatalogTile: object
|
|
2169
2172
|
): string;
|
|
2170
2173
|
/**
|
|
2171
|
-
* @
|
|
2174
|
+
* @since 1.16.3
|
|
2172
2175
|
*
|
|
2173
2176
|
* Returns preview title for a catalog tile.
|
|
2174
2177
|
*
|
|
@@ -2226,7 +2229,21 @@ declare namespace sap {
|
|
|
2226
2229
|
oCatalogTile: object
|
|
2227
2230
|
): string;
|
|
2228
2231
|
/**
|
|
2229
|
-
*
|
|
2232
|
+
* Returns the technical attributes associated with a catalog tile which can be used define additional tags
|
|
2233
|
+
* for apps. Note: getCatalogTileViewControl **must** be called **before** this method. Otherwise the technical
|
|
2234
|
+
* attributes may be incomplete.
|
|
2235
|
+
*
|
|
2236
|
+
* @returns The technical attributes associated with this catalog tile if this is supported by the adapter
|
|
2237
|
+
* implementation
|
|
2238
|
+
*/
|
|
2239
|
+
getCatalogTileTechnicalAttributes(
|
|
2240
|
+
/**
|
|
2241
|
+
* The catalog tile
|
|
2242
|
+
*/
|
|
2243
|
+
oCatalogTile: object
|
|
2244
|
+
): string[];
|
|
2245
|
+
/**
|
|
2246
|
+
* @since 1.67.0
|
|
2230
2247
|
*
|
|
2231
2248
|
* Returns the catalog tile info
|
|
2232
2249
|
*
|
|
@@ -2406,7 +2423,7 @@ declare namespace sap {
|
|
|
2406
2423
|
oTile: object
|
|
2407
2424
|
): object;
|
|
2408
2425
|
/**
|
|
2409
|
-
* @
|
|
2426
|
+
* @since 1.16.4
|
|
2410
2427
|
*
|
|
2411
2428
|
* Returns whether the catalogs collection previously returned by `getCatalogs()` is still valid.
|
|
2412
2429
|
*
|
|
@@ -2663,7 +2680,7 @@ declare namespace sap {
|
|
|
2663
2680
|
): void;
|
|
2664
2681
|
}
|
|
2665
2682
|
/**
|
|
2666
|
-
* @
|
|
2683
|
+
* @since 1.16.0
|
|
2667
2684
|
*/
|
|
2668
2685
|
class Message {
|
|
2669
2686
|
/**
|
|
@@ -2677,17 +2694,17 @@ declare namespace sap {
|
|
|
2677
2694
|
constructor();
|
|
2678
2695
|
|
|
2679
2696
|
/**
|
|
2680
|
-
* @
|
|
2697
|
+
* @since 1.16.0
|
|
2681
2698
|
*
|
|
2682
2699
|
* Shows an confirmation dialog on the screen.
|
|
2683
2700
|
*
|
|
2684
|
-
* The callback is called with the following signature: `function(
|
|
2701
|
+
* The callback is called with the following signature: `function(Action)` where Action is the action type
|
|
2685
2702
|
* that the user has tapped. For example, when the user has pressed the close button, a sap.m.MessageBox.Action.Close
|
|
2686
2703
|
* is returned.
|
|
2687
2704
|
*
|
|
2688
|
-
* If no actions are provided, OK and Cancel will be shown. In this case
|
|
2689
|
-
* three values: 1. sap.m.MessageBox.Action.OK: OK (confirmed) button is tapped. 2. sap.m.MessageBox.Action.Cancel:
|
|
2690
|
-
* Cancel (unconfirmed) button is tapped. 3. null: Confirm dialog is closed by
|
|
2705
|
+
* If no actions are provided, "OK" and "Cancel" will be shown. In this case Action is set by one of the
|
|
2706
|
+
* following three values: 1. sap.m.MessageBox.Action.OK: "OK" (confirmed) button is tapped. 2. sap.m.MessageBox.Action.Cancel:
|
|
2707
|
+
* "Cancel" (unconfirmed) button is tapped. 3. null: Confirm dialog is closed by calling sap.m.InstanceManager.closeAllDialogs()
|
|
2691
2708
|
*/
|
|
2692
2709
|
confirm(
|
|
2693
2710
|
/**
|
|
@@ -2697,7 +2714,7 @@ declare namespace sap {
|
|
|
2697
2714
|
/**
|
|
2698
2715
|
* callback function
|
|
2699
2716
|
*/
|
|
2700
|
-
fnCallback:
|
|
2717
|
+
fnCallback: () => string,
|
|
2701
2718
|
/**
|
|
2702
2719
|
* the localized title as plain text
|
|
2703
2720
|
*/
|
|
@@ -2715,7 +2732,7 @@ declare namespace sap {
|
|
|
2715
2732
|
| string[]
|
|
2716
2733
|
): void;
|
|
2717
2734
|
/**
|
|
2718
|
-
* @
|
|
2735
|
+
* @since 1.16.0
|
|
2719
2736
|
*
|
|
2720
2737
|
* Shows an error message on the screen.
|
|
2721
2738
|
*/
|
|
@@ -2730,8 +2747,8 @@ declare namespace sap {
|
|
|
2730
2747
|
sTitle?: string
|
|
2731
2748
|
): void;
|
|
2732
2749
|
/**
|
|
2733
|
-
* @
|
|
2734
|
-
* @
|
|
2750
|
+
* @since 1.81.0
|
|
2751
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
2735
2752
|
*
|
|
2736
2753
|
* Shows an error message with details on the screen. If more than one control should be shown, an {sap.m.VBox }
|
|
2737
2754
|
* can be used. The default title is "error". If no custom buttons are given, an emphasized "close" button
|
|
@@ -2758,7 +2775,7 @@ declare namespace sap {
|
|
|
2758
2775
|
buttons?: sap.m.Button[]
|
|
2759
2776
|
): sap.m.Dialog;
|
|
2760
2777
|
/**
|
|
2761
|
-
* @
|
|
2778
|
+
* @since 1.16.0
|
|
2762
2779
|
*
|
|
2763
2780
|
* Shows a MessageToast on the screen.
|
|
2764
2781
|
*/
|
|
@@ -2774,7 +2791,7 @@ declare namespace sap {
|
|
|
2774
2791
|
): void;
|
|
2775
2792
|
}
|
|
2776
2793
|
/**
|
|
2777
|
-
* @
|
|
2794
|
+
* @since 1.15.0
|
|
2778
2795
|
*
|
|
2779
2796
|
* The Unified Shell's internal navigation target resolution service.
|
|
2780
2797
|
*
|
|
@@ -2807,7 +2824,7 @@ declare namespace sap {
|
|
|
2807
2824
|
sHashFragment: string
|
|
2808
2825
|
): string;
|
|
2809
2826
|
/**
|
|
2810
|
-
* @
|
|
2827
|
+
* @since 1.32
|
|
2811
2828
|
*
|
|
2812
2829
|
* Tells whether the given navigation intent(s) are supported for the given parameters Supported" means
|
|
2813
2830
|
* that a valid navigation target is configured for the user for the given device form factor.
|
|
@@ -2944,7 +2961,7 @@ declare namespace sap {
|
|
|
2944
2961
|
sHashFragment: string
|
|
2945
2962
|
): object;
|
|
2946
2963
|
/**
|
|
2947
|
-
* @
|
|
2964
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
2948
2965
|
*
|
|
2949
2966
|
* Resolves a navigation target taking into account the sap-system
|
|
2950
2967
|
*
|
|
@@ -2985,52 +3002,36 @@ declare namespace sap {
|
|
|
2985
3002
|
): jQuery.Promise;
|
|
2986
3003
|
}
|
|
2987
3004
|
/**
|
|
2988
|
-
* @
|
|
3005
|
+
* @since 1.32.0
|
|
3006
|
+
*
|
|
3007
|
+
* UShell service for fetching user notification data from the Notification center/service
|
|
3008
|
+
* and exposing them to the Unified Shell and Fiori applications UI controls.
|
|
3009
|
+
*
|
|
3010
|
+
* In order to get user notifications, Unified Shell notification service issues OData requests
|
|
3011
|
+
* to the service defined by the configuration property `serviceUrl`,
|
|
3012
|
+
* for example: "/sap/opu/odata4/iwngw/notification/default/iwngw/notification_srv/0001"
|
|
3013
|
+
* .
|
|
3014
|
+
*
|
|
3015
|
+
* Unified Shell Notification service has several working modes, depending on the environment and the available
|
|
3016
|
+
* resources:
|
|
3017
|
+
* PackagedApp mode: Fiori launchpad runs in the context of PackagedApp
|
|
3018
|
+
* FioriClient mode: Fiori launchpad runs in the context of FioriLaunchpad
|
|
3019
|
+
* WebSocket mode: Fiori launchpad runs in a browser, and WebSocket connection to the notifications provider
|
|
3020
|
+
* is available
|
|
3021
|
+
* Polling mode: Fiori launchpad in runs in a browser, and WebSocket connection to the notifications provider
|
|
3022
|
+
* is not available
|
|
3023
|
+
*
|
|
3024
|
+
*
|
|
3025
|
+
* The notification service exposes an API that includes: - Service enabling and initialization
|
|
3026
|
+
* - Registration of callback functions (by Shell/FLP controls) that will be called for every data update
|
|
3027
|
+
* . - Retrieval of notification data (e.g. notifications, number of unseen notifications) - Execution of
|
|
3028
|
+
* a notification actions - Marking user notifications as seen
|
|
2989
3029
|
*/
|
|
2990
3030
|
class Notifications {
|
|
2991
|
-
|
|
2992
|
-
* UShell service for fetching user notification data from the Notification center/service
|
|
2993
|
-
* and exposing them to the Unified Shell and Fiori applications UI controls.
|
|
2994
|
-
*
|
|
2995
|
-
* In order to get user notifications, Unified Shell notification service issues OData requests
|
|
2996
|
-
* to the service defined by the configuration property `serviceUrl`,
|
|
2997
|
-
* for example: "/sap/opu/odata4/iwngw/notification/default/iwngw/notification_srv/0001"
|
|
2998
|
-
* .
|
|
2999
|
-
*
|
|
3000
|
-
* Unified Shell Notification service has several working modes, depending on the environment and the available
|
|
3001
|
-
* resources:
|
|
3002
|
-
* PackagedApp mode: Fiori launchpad runs in the context of PackagedApp
|
|
3003
|
-
* FioriClient mode: Fiori launchpad runs in the context of FioriLaunchpad
|
|
3004
|
-
* WebSocket mode: Fiori launchpad runs in a browser, and WebSocket connection to the notifications provider
|
|
3005
|
-
* is available
|
|
3006
|
-
* Polling mode: Fiori launchpad in runs in a browser, and WebSocket connection to the notifications provider
|
|
3007
|
-
* is not available
|
|
3008
|
-
*
|
|
3009
|
-
*
|
|
3010
|
-
* The notification service exposes an API that includes: - Service enabling and initialization
|
|
3011
|
-
* - Registration of callback functions (by Shell/FLP controls) that will be called for every data update
|
|
3012
|
-
* . - Retrieval of notification data (e.g. notifications, number of unseen notifications) - Execution of
|
|
3013
|
-
* a notification actions - Marking user notifications as seen
|
|
3014
|
-
* See:
|
|
3015
|
-
* sap.ushell.services.Container#getServiceAsync
|
|
3016
|
-
*/
|
|
3017
|
-
constructor(
|
|
3018
|
-
/**
|
|
3019
|
-
* The interface provided by the container
|
|
3020
|
-
*/
|
|
3021
|
-
oContainerInterface: object,
|
|
3022
|
-
/**
|
|
3023
|
-
* Not used in this service
|
|
3024
|
-
*/
|
|
3025
|
-
sParameters: object,
|
|
3026
|
-
/**
|
|
3027
|
-
* configuration
|
|
3028
|
-
*/
|
|
3029
|
-
oServiceConfiguration: object
|
|
3030
|
-
);
|
|
3031
|
+
constructor();
|
|
3031
3032
|
|
|
3032
3033
|
/**
|
|
3033
|
-
* @
|
|
3034
|
+
* @since 1.34
|
|
3034
3035
|
*
|
|
3035
3036
|
* Launches dismiss notification call.
|
|
3036
3037
|
*
|
|
@@ -3041,10 +3042,10 @@ declare namespace sap {
|
|
|
3041
3042
|
/**
|
|
3042
3043
|
* The ID of the notification whose action is being executed
|
|
3043
3044
|
*/
|
|
3044
|
-
sNotificationId:
|
|
3045
|
-
): Promise<
|
|
3045
|
+
sNotificationId: string
|
|
3046
|
+
): Promise<undefined>;
|
|
3046
3047
|
/**
|
|
3047
|
-
* @
|
|
3048
|
+
* @since 1.32
|
|
3048
3049
|
*
|
|
3049
3050
|
* Launches a notification action oData call.
|
|
3050
3051
|
* After launching the action, the function gets updated notification data in order to push the updated
|
|
@@ -3056,22 +3057,22 @@ declare namespace sap {
|
|
|
3056
3057
|
/**
|
|
3057
3058
|
* The ID of the notification header/group whose action is being executed
|
|
3058
3059
|
*/
|
|
3059
|
-
sNotificationGroupId:
|
|
3060
|
+
sNotificationGroupId: string,
|
|
3060
3061
|
/**
|
|
3061
3062
|
* The ID of the action that is being executed
|
|
3062
3063
|
*/
|
|
3063
|
-
sActionId:
|
|
3064
|
-
): Promise<
|
|
3064
|
+
sActionId: string
|
|
3065
|
+
): Promise<undefined>;
|
|
3065
3066
|
/**
|
|
3066
|
-
* @
|
|
3067
|
+
* @since 1.38
|
|
3067
3068
|
*
|
|
3068
3069
|
* Returns the notifications of the user sorted by type include the group headers and the notifications
|
|
3069
3070
|
*
|
|
3070
|
-
* @returns Promise object that on success - returns all notification items
|
|
3071
|
+
* @returns Promise object that - on success - returns all notification items
|
|
3071
3072
|
*/
|
|
3072
|
-
getNotificationsByTypeWithGroupHeaders(): Promise
|
|
3073
|
+
getNotificationsByTypeWithGroupHeaders(): jQuery.Promise;
|
|
3073
3074
|
/**
|
|
3074
|
-
* @
|
|
3075
|
+
* @since 1.44
|
|
3075
3076
|
*
|
|
3076
3077
|
* Returns the number of notifications
|
|
3077
3078
|
* e.g. Notifications for user.
|
|
@@ -3080,24 +3081,24 @@ declare namespace sap {
|
|
|
3080
3081
|
*/
|
|
3081
3082
|
getNotificationsCount(): number;
|
|
3082
3083
|
/**
|
|
3083
|
-
* @
|
|
3084
|
+
* @since 1.44
|
|
3084
3085
|
*
|
|
3085
3086
|
* Returns the group headers of the user notifications
|
|
3086
3087
|
*
|
|
3087
|
-
* @returns Promise object that on success - returns all group headers
|
|
3088
|
+
* @returns Promise object that - on success - returns all group headers
|
|
3088
3089
|
*/
|
|
3089
|
-
getNotificationsGroupHeaders(): Promise
|
|
3090
|
+
getNotificationsGroupHeaders(): jQuery.Promise;
|
|
3090
3091
|
/**
|
|
3091
|
-
* @
|
|
3092
|
+
* @since 1.32
|
|
3092
3093
|
*
|
|
3093
3094
|
* Returns the number of unseen notifications
|
|
3094
3095
|
* e.g. Notifications that the user hasn't seen yet.
|
|
3095
3096
|
*
|
|
3096
3097
|
* @returns Promise object that on success - returns the number of unread notifications of the user
|
|
3097
3098
|
*/
|
|
3098
|
-
getUnseenNotificationsCount(): Promise
|
|
3099
|
+
getUnseenNotificationsCount(): jQuery.Promise;
|
|
3099
3100
|
/**
|
|
3100
|
-
* @
|
|
3101
|
+
* @since 1.32
|
|
3101
3102
|
*
|
|
3102
3103
|
* Initializes the notification service
|
|
3103
3104
|
*
|
|
@@ -3116,7 +3117,7 @@ declare namespace sap {
|
|
|
3116
3117
|
*/
|
|
3117
3118
|
init(): void;
|
|
3118
3119
|
/**
|
|
3119
|
-
* @
|
|
3120
|
+
* @since 1.32.0
|
|
3120
3121
|
*
|
|
3121
3122
|
* Indicates whether notification service is enabled.
|
|
3122
3123
|
* Enabling is based on the `enable` service configuration flag.
|
|
@@ -3127,14 +3128,14 @@ declare namespace sap {
|
|
|
3127
3128
|
*/
|
|
3128
3129
|
isEnabled(): boolean;
|
|
3129
3130
|
/**
|
|
3130
|
-
* @
|
|
3131
|
+
* @since 1.38
|
|
3131
3132
|
*
|
|
3132
3133
|
*
|
|
3133
3134
|
* @returns boolean value whether first request was already performed and data was returned.
|
|
3134
3135
|
*/
|
|
3135
3136
|
isFirstDataLoaded(): boolean;
|
|
3136
3137
|
/**
|
|
3137
|
-
* @
|
|
3138
|
+
* @since 1.34
|
|
3138
3139
|
*
|
|
3139
3140
|
* Launches mark as read notification call.
|
|
3140
3141
|
* After launching the action, the function gets updated notification data in order to push the updated
|
|
@@ -3146,17 +3147,17 @@ declare namespace sap {
|
|
|
3146
3147
|
/**
|
|
3147
3148
|
* The ID of the notification whose action is being executed
|
|
3148
3149
|
*/
|
|
3149
|
-
sNotificationId:
|
|
3150
|
-
): Promise
|
|
3150
|
+
sNotificationId: string
|
|
3151
|
+
): jQuery.Promise;
|
|
3151
3152
|
/**
|
|
3152
|
-
* @
|
|
3153
|
+
* @since 1.32
|
|
3153
3154
|
*
|
|
3154
3155
|
* Mark all notifications as seen.
|
|
3155
3156
|
* the main use-case is when the user navigated to the notification center and sees all the pending notifications.
|
|
3156
3157
|
*/
|
|
3157
3158
|
notificationsSeen(): void;
|
|
3158
3159
|
/**
|
|
3159
|
-
* @
|
|
3160
|
+
* @since 1.32
|
|
3160
3161
|
*
|
|
3161
3162
|
* Gets a callback function that will be called when updated unseen notifications count is available.
|
|
3162
3163
|
*/
|
|
@@ -3164,10 +3165,10 @@ declare namespace sap {
|
|
|
3164
3165
|
/**
|
|
3165
3166
|
* The callback function that is registered and called on data update.
|
|
3166
3167
|
*/
|
|
3167
|
-
callback:
|
|
3168
|
+
callback: Function
|
|
3168
3169
|
): void;
|
|
3169
3170
|
/**
|
|
3170
|
-
* @
|
|
3171
|
+
* @since 1.32
|
|
3171
3172
|
*
|
|
3172
3173
|
* Gets a callback function that will be called when updated notifications data is available.
|
|
3173
3174
|
*/
|
|
@@ -3175,37 +3176,23 @@ declare namespace sap {
|
|
|
3175
3176
|
/**
|
|
3176
3177
|
* The callback function that is registered and called on data update.
|
|
3177
3178
|
*/
|
|
3178
|
-
callback:
|
|
3179
|
+
callback: Function
|
|
3179
3180
|
): void;
|
|
3180
3181
|
}
|
|
3181
3182
|
/**
|
|
3182
|
-
* @
|
|
3183
|
+
* @since 1.15.0
|
|
3184
|
+
*
|
|
3185
|
+
* This method MUST be called by the Unified Shell's container only, others MUST call `sap.ushell.Container.getServiceAsync("Personalization").then(function
|
|
3186
|
+
* (Personalization) {});`. Constructs a new instance of the personalization service.
|
|
3187
|
+
*
|
|
3188
|
+
* The Unified Shell's personalization service, which provides a personalizer object that handles all personalization
|
|
3189
|
+
* operations.
|
|
3183
3190
|
*/
|
|
3184
3191
|
class Personalization {
|
|
3185
|
-
|
|
3186
|
-
* This method MUST be called by the Unified Shell's container only, others MUST call `sap.ushell.Container.getServiceAsync("Personalization").then(function
|
|
3187
|
-
* (Personalization) {});`. Constructs a new instance of the personalization service.
|
|
3188
|
-
*
|
|
3189
|
-
* The Unified Shell's personalization service, which provides a personalizer object that handles all personalization
|
|
3190
|
-
* operations.
|
|
3191
|
-
* See:
|
|
3192
|
-
* sap.ushell.services.Container#getServiceAsync
|
|
3193
|
-
*/
|
|
3194
|
-
constructor(
|
|
3195
|
-
/**
|
|
3196
|
-
* the service adapter for the personalization service, as already provided by the container
|
|
3197
|
-
*/
|
|
3198
|
-
oAdapter: object,
|
|
3199
|
-
|
|
3200
|
-
oContainerInterface: object,
|
|
3201
|
-
|
|
3202
|
-
sParameter: string,
|
|
3203
|
-
|
|
3204
|
-
oConfig: object
|
|
3205
|
-
);
|
|
3192
|
+
constructor();
|
|
3206
3193
|
|
|
3207
3194
|
/**
|
|
3208
|
-
* @
|
|
3195
|
+
* @since 1.22.0
|
|
3209
3196
|
*
|
|
3210
3197
|
* Factory method to obtain an empty Data Context object. When data present in a prior context is not relevant
|
|
3211
3198
|
* (e.g. when using a "uniquely" generated key and planning to overwrite any colliding front-end server
|
|
@@ -3244,7 +3231,7 @@ declare namespace sap {
|
|
|
3244
3231
|
oComponent: sap.ui.core.Component
|
|
3245
3232
|
): object;
|
|
3246
3233
|
/**
|
|
3247
|
-
* @
|
|
3234
|
+
* @since 1.22.0
|
|
3248
3235
|
*
|
|
3249
3236
|
* Asynchronously starts a deletion request for the given container identified by sContainerKey. Can be
|
|
3250
3237
|
* called without having ever called getContainer with the corresponding key
|
|
@@ -3268,7 +3255,7 @@ declare namespace sap {
|
|
|
3268
3255
|
oScope: object
|
|
3269
3256
|
): object;
|
|
3270
3257
|
/**
|
|
3271
|
-
* @
|
|
3258
|
+
* @since 1.18.0
|
|
3272
3259
|
* @deprecated (since 1.22) - Please use {@link #delContainer} instead.
|
|
3273
3260
|
*
|
|
3274
3261
|
* Asynchronously starts a deletion request for the given container identified by sContainerKey. Can be
|
|
@@ -3289,7 +3276,7 @@ declare namespace sap {
|
|
|
3289
3276
|
sContainerKey: string
|
|
3290
3277
|
): object;
|
|
3291
3278
|
/**
|
|
3292
|
-
* @
|
|
3279
|
+
* @since 1.22.0
|
|
3293
3280
|
*
|
|
3294
3281
|
* Factory method to obtain a Data Context object, which is a local copy of the persistence layer data.
|
|
3295
3282
|
* The Container data is asynchronously read on creation if present, otherwise an initial object is created.
|
|
@@ -3382,7 +3369,17 @@ declare namespace sap {
|
|
|
3382
3369
|
oComponent: sap.ui.core.Component
|
|
3383
3370
|
): object;
|
|
3384
3371
|
/**
|
|
3385
|
-
* @
|
|
3372
|
+
* @since 1.28.0
|
|
3373
|
+
*
|
|
3374
|
+
* Returns a generated key. This key is suitably random, but it is susceptible to brute force attacks. Storages
|
|
3375
|
+
* based on the generated key must not be used for sensitive data.
|
|
3376
|
+
*
|
|
3377
|
+
* @returns 40 character string consisting of A-Z and 0-9 which can be used as a generated key for personalization
|
|
3378
|
+
* container. Every invocation returns a new key. Seed of random function is OS Random Seed.
|
|
3379
|
+
*/
|
|
3380
|
+
getGeneratedKey(): string;
|
|
3381
|
+
/**
|
|
3382
|
+
* @since 1.18.0
|
|
3386
3383
|
* @deprecated (since 1.21) - Please use {@link #getContainer} instead.
|
|
3387
3384
|
*
|
|
3388
3385
|
* This interface is deprecated since 1.22, please use getContainer / delContainer.
|
|
@@ -3436,7 +3433,7 @@ declare namespace sap {
|
|
|
3436
3433
|
sContainerKey: string
|
|
3437
3434
|
): object;
|
|
3438
3435
|
/**
|
|
3439
|
-
* @
|
|
3436
|
+
* @since 1.15.0
|
|
3440
3437
|
*
|
|
3441
3438
|
* Returns a personalizer object which handles personalization by asynchronous operations storing the personalization
|
|
3442
3439
|
* data immediately via the connected adapter. For each operation a round trip is executed.
|
|
@@ -3474,7 +3471,7 @@ declare namespace sap {
|
|
|
3474
3471
|
oComponent?: sap.ui.core.Component
|
|
3475
3472
|
): object;
|
|
3476
3473
|
/**
|
|
3477
|
-
* @
|
|
3474
|
+
* @since 1.18.0
|
|
3478
3475
|
*
|
|
3479
3476
|
* Returns a transient personalizer object which handles personalization by asynchronous operations storing
|
|
3480
3477
|
* the personalization data transiently as an object property. Primary usage of the transient personalizer
|
|
@@ -3487,7 +3484,7 @@ declare namespace sap {
|
|
|
3487
3484
|
getTransientPersonalizer(): object;
|
|
3488
3485
|
}
|
|
3489
3486
|
/**
|
|
3490
|
-
* @
|
|
3487
|
+
* @since 1.18.0
|
|
3491
3488
|
*
|
|
3492
3489
|
* The personalization container is the anchor object of the unified shell personalization in container
|
|
3493
3490
|
* mode.
|
|
@@ -3499,7 +3496,7 @@ declare namespace sap {
|
|
|
3499
3496
|
constructor();
|
|
3500
3497
|
|
|
3501
3498
|
/**
|
|
3502
|
-
* @
|
|
3499
|
+
* @since 1.18.0
|
|
3503
3500
|
*
|
|
3504
3501
|
* Creates a new variant set in the container. In case a variant set with this key is already existing an
|
|
3505
3502
|
* exception is thrown.
|
|
@@ -3513,7 +3510,7 @@ declare namespace sap {
|
|
|
3513
3510
|
sVariantSetKey: string
|
|
3514
3511
|
): object;
|
|
3515
3512
|
/**
|
|
3516
|
-
* @
|
|
3513
|
+
* @since 1.18.0
|
|
3517
3514
|
*
|
|
3518
3515
|
* Checks if a specific direct item is contained in the container.
|
|
3519
3516
|
*
|
|
@@ -3526,7 +3523,7 @@ declare namespace sap {
|
|
|
3526
3523
|
sItemKey: string
|
|
3527
3524
|
): boolean;
|
|
3528
3525
|
/**
|
|
3529
|
-
* @
|
|
3526
|
+
* @since 1.18.0
|
|
3530
3527
|
*
|
|
3531
3528
|
* Checks if a specific variant set is contained in the container.
|
|
3532
3529
|
*
|
|
@@ -3539,7 +3536,7 @@ declare namespace sap {
|
|
|
3539
3536
|
sVariantSetKey: string
|
|
3540
3537
|
): boolean;
|
|
3541
3538
|
/**
|
|
3542
|
-
* @
|
|
3539
|
+
* @since 1.18.0
|
|
3543
3540
|
*
|
|
3544
3541
|
* Deletes a direct item from the container. In case the item does not exist, nothing happens.
|
|
3545
3542
|
*/
|
|
@@ -3550,7 +3547,7 @@ declare namespace sap {
|
|
|
3550
3547
|
sItemKey: string
|
|
3551
3548
|
): void;
|
|
3552
3549
|
/**
|
|
3553
|
-
* @
|
|
3550
|
+
* @since 1.18.0
|
|
3554
3551
|
*
|
|
3555
3552
|
* Deletes a variant set from the container. In case the variant set does not exist nothing happens.
|
|
3556
3553
|
*/
|
|
@@ -3561,7 +3558,7 @@ declare namespace sap {
|
|
|
3561
3558
|
sVariantSetKey: string
|
|
3562
3559
|
): void;
|
|
3563
3560
|
/**
|
|
3564
|
-
* @
|
|
3561
|
+
* @since 1.18.0
|
|
3565
3562
|
*
|
|
3566
3563
|
* Returns an array with the keys of direct items in the container.
|
|
3567
3564
|
*
|
|
@@ -3569,7 +3566,7 @@ declare namespace sap {
|
|
|
3569
3566
|
*/
|
|
3570
3567
|
getItemKeys(): any[];
|
|
3571
3568
|
/**
|
|
3572
|
-
* @
|
|
3569
|
+
* @since 1.18.0
|
|
3573
3570
|
*
|
|
3574
3571
|
* Returns the value for a direct item from the container.
|
|
3575
3572
|
*
|
|
@@ -3583,7 +3580,7 @@ declare namespace sap {
|
|
|
3583
3580
|
sItemKey: string
|
|
3584
3581
|
): object;
|
|
3585
3582
|
/**
|
|
3586
|
-
* @
|
|
3583
|
+
* @since 1.18.0
|
|
3587
3584
|
*
|
|
3588
3585
|
* Returns an array with the keys of the variant sets in the container.
|
|
3589
3586
|
*
|
|
@@ -3591,7 +3588,7 @@ declare namespace sap {
|
|
|
3591
3588
|
*/
|
|
3592
3589
|
getVariantSetKeys(): any[];
|
|
3593
3590
|
/**
|
|
3594
|
-
* @
|
|
3591
|
+
* @since 1.18.0
|
|
3595
3592
|
*
|
|
3596
3593
|
* (Re)loads the current container data from the underlying storage asynchronously. The current local data
|
|
3597
3594
|
* is discarded.
|
|
@@ -3605,7 +3602,7 @@ declare namespace sap {
|
|
|
3605
3602
|
*/
|
|
3606
3603
|
load(): object;
|
|
3607
3604
|
/**
|
|
3608
|
-
* @
|
|
3605
|
+
* @since 1.18.0
|
|
3609
3606
|
*
|
|
3610
3607
|
* Attempts to save the current container data at the underlying storage asynchronously. The current state
|
|
3611
3608
|
* is serialized.
|
|
@@ -3616,7 +3613,7 @@ declare namespace sap {
|
|
|
3616
3613
|
*/
|
|
3617
3614
|
save(): object;
|
|
3618
3615
|
/**
|
|
3619
|
-
* @
|
|
3616
|
+
* @since 1.18.0
|
|
3620
3617
|
*
|
|
3621
3618
|
* Sets the value of a direct item in the container. In case the item is already existing its value is overwritten.
|
|
3622
3619
|
* In case it is not existing a new item with this key and value is created.
|
|
@@ -3633,7 +3630,7 @@ declare namespace sap {
|
|
|
3633
3630
|
): void;
|
|
3634
3631
|
}
|
|
3635
3632
|
/**
|
|
3636
|
-
* @
|
|
3633
|
+
* @since 1.18.0
|
|
3637
3634
|
*
|
|
3638
3635
|
* The personalization variant contains personalization data. It is used in the personalization container
|
|
3639
3636
|
* mode.
|
|
@@ -3645,7 +3642,7 @@ declare namespace sap {
|
|
|
3645
3642
|
constructor();
|
|
3646
3643
|
|
|
3647
3644
|
/**
|
|
3648
|
-
* @
|
|
3645
|
+
* @since 1.18.0
|
|
3649
3646
|
*
|
|
3650
3647
|
* Checks if a specific item is contained in this variant.
|
|
3651
3648
|
*
|
|
@@ -3658,7 +3655,7 @@ declare namespace sap {
|
|
|
3658
3655
|
sItemKey: string
|
|
3659
3656
|
): boolean;
|
|
3660
3657
|
/**
|
|
3661
|
-
* @
|
|
3658
|
+
* @since 1.18.0
|
|
3662
3659
|
*
|
|
3663
3660
|
* Deletes an item from this variant. In case the item does not exist, nothing happens.
|
|
3664
3661
|
*/
|
|
@@ -3669,7 +3666,7 @@ declare namespace sap {
|
|
|
3669
3666
|
sItemKey: string
|
|
3670
3667
|
): void;
|
|
3671
3668
|
/**
|
|
3672
|
-
* @
|
|
3669
|
+
* @since 1.18.0
|
|
3673
3670
|
*
|
|
3674
3671
|
* Returns an array with the keys of all items in this variant.
|
|
3675
3672
|
*
|
|
@@ -3677,7 +3674,7 @@ declare namespace sap {
|
|
|
3677
3674
|
*/
|
|
3678
3675
|
getItemKeys(): any[];
|
|
3679
3676
|
/**
|
|
3680
|
-
* @
|
|
3677
|
+
* @since 1.18.0
|
|
3681
3678
|
*
|
|
3682
3679
|
* Returns the value for an item in this variant.
|
|
3683
3680
|
*
|
|
@@ -3691,7 +3688,7 @@ declare namespace sap {
|
|
|
3691
3688
|
sItemKey: string
|
|
3692
3689
|
): object;
|
|
3693
3690
|
/**
|
|
3694
|
-
* @
|
|
3691
|
+
* @since 1.18.0
|
|
3695
3692
|
*
|
|
3696
3693
|
* Returns the key of this variant.
|
|
3697
3694
|
*
|
|
@@ -3699,7 +3696,7 @@ declare namespace sap {
|
|
|
3699
3696
|
*/
|
|
3700
3697
|
getVariantKey(): string;
|
|
3701
3698
|
/**
|
|
3702
|
-
* @
|
|
3699
|
+
* @since 1.18.0
|
|
3703
3700
|
*
|
|
3704
3701
|
* Returns the name of this variant.
|
|
3705
3702
|
*
|
|
@@ -3707,7 +3704,7 @@ declare namespace sap {
|
|
|
3707
3704
|
*/
|
|
3708
3705
|
getVariantName(): string;
|
|
3709
3706
|
/**
|
|
3710
|
-
* @
|
|
3707
|
+
* @since 1.18.0
|
|
3711
3708
|
*
|
|
3712
3709
|
* Sets the value for an item in this variant.
|
|
3713
3710
|
*/
|
|
@@ -3723,7 +3720,7 @@ declare namespace sap {
|
|
|
3723
3720
|
): void;
|
|
3724
3721
|
}
|
|
3725
3722
|
/**
|
|
3726
|
-
* @
|
|
3723
|
+
* @since 1.18.0
|
|
3727
3724
|
*
|
|
3728
3725
|
* The personalization variant set contains variants of personalization data. It is used in the personalization
|
|
3729
3726
|
* container mode.
|
|
@@ -3734,14 +3731,14 @@ declare namespace sap {
|
|
|
3734
3731
|
*/
|
|
3735
3732
|
constructor();
|
|
3736
3733
|
/**
|
|
3737
|
-
* @
|
|
3734
|
+
* @since 1.18.0
|
|
3738
3735
|
*
|
|
3739
3736
|
* Deletes a variant from the variant set. In case the variant does not exist nothing happens.
|
|
3740
3737
|
*/
|
|
3741
3738
|
delVariant: undefined;
|
|
3742
3739
|
|
|
3743
3740
|
/**
|
|
3744
|
-
* @
|
|
3741
|
+
* @since 1.18.0
|
|
3745
3742
|
*
|
|
3746
3743
|
* Checks if a specific variant is contained in the variant set.
|
|
3747
3744
|
*
|
|
@@ -3754,7 +3751,7 @@ declare namespace sap {
|
|
|
3754
3751
|
sVariantKey: string
|
|
3755
3752
|
): boolean;
|
|
3756
3753
|
/**
|
|
3757
|
-
* @
|
|
3754
|
+
* @since 1.18.0
|
|
3758
3755
|
*
|
|
3759
3756
|
* Returns the current variant key.
|
|
3760
3757
|
*
|
|
@@ -3762,7 +3759,7 @@ declare namespace sap {
|
|
|
3762
3759
|
*/
|
|
3763
3760
|
getCurrentVariantKey(): string;
|
|
3764
3761
|
/**
|
|
3765
|
-
* @
|
|
3762
|
+
* @since 1.18.0
|
|
3766
3763
|
*
|
|
3767
3764
|
* Returns a variant object.
|
|
3768
3765
|
*
|
|
@@ -3776,7 +3773,7 @@ declare namespace sap {
|
|
|
3776
3773
|
sVariantKey: string
|
|
3777
3774
|
): object;
|
|
3778
3775
|
/**
|
|
3779
|
-
* @
|
|
3776
|
+
* @since 1.18.0
|
|
3780
3777
|
*
|
|
3781
3778
|
* Returns the variant key corresponding to a variant name.
|
|
3782
3779
|
*
|
|
@@ -3790,7 +3787,7 @@ declare namespace sap {
|
|
|
3790
3787
|
sVariantName: string
|
|
3791
3788
|
): object;
|
|
3792
3789
|
/**
|
|
3793
|
-
* @
|
|
3790
|
+
* @since 1.18.0
|
|
3794
3791
|
*
|
|
3795
3792
|
* Returns an array with the keys of the variants in the variant set.
|
|
3796
3793
|
*
|
|
@@ -3798,7 +3795,7 @@ declare namespace sap {
|
|
|
3798
3795
|
*/
|
|
3799
3796
|
getVariantKeys(): any[];
|
|
3800
3797
|
/**
|
|
3801
|
-
* @
|
|
3798
|
+
* @since 1.18.0
|
|
3802
3799
|
*
|
|
3803
3800
|
* Sets the current variant key.
|
|
3804
3801
|
*/
|
|
@@ -3810,7 +3807,7 @@ declare namespace sap {
|
|
|
3810
3807
|
): void;
|
|
3811
3808
|
}
|
|
3812
3809
|
/**
|
|
3813
|
-
* @
|
|
3810
|
+
* @since 1.15.0
|
|
3814
3811
|
*/
|
|
3815
3812
|
class ShellNavigation {
|
|
3816
3813
|
/**
|
|
@@ -3898,7 +3895,7 @@ declare namespace sap {
|
|
|
3898
3895
|
): object;
|
|
3899
3896
|
}
|
|
3900
3897
|
/**
|
|
3901
|
-
* @
|
|
3898
|
+
* @since 1.44.0
|
|
3902
3899
|
* @deprecated (since 1.112) - This service has been deprecated. Please use the CrossApplicationNavigation
|
|
3903
3900
|
* service instead.
|
|
3904
3901
|
*/
|
|
@@ -3921,14 +3918,13 @@ declare namespace sap {
|
|
|
3921
3918
|
constructor();
|
|
3922
3919
|
}
|
|
3923
3920
|
/**
|
|
3924
|
-
* @
|
|
3921
|
+
* @since 1.19.1
|
|
3925
3922
|
*
|
|
3926
|
-
*
|
|
3923
|
+
* This method MUST be called by the Unified Shell's container only, others MUST call `sap.ushell.Container.getServiceAsync("SupportTicket").then(function
|
|
3924
|
+
* (SupportTicket) {});`. Constructs a new instance of the support ticket service.
|
|
3927
3925
|
*/
|
|
3928
3926
|
class SupportTicket {
|
|
3929
3927
|
/**
|
|
3930
|
-
* This method MUST be called by the Unified Shell's container only, others MUST call `sap.ushell.Container.getServiceAsync("SupportTicket").then(function
|
|
3931
|
-
* (SupportTicket) {});`. Constructs a new instance of the support ticket service.
|
|
3932
3928
|
* See:
|
|
3933
3929
|
* sap.ushell.services.Container#getServiceAsync
|
|
3934
3930
|
*/
|
|
@@ -3969,20 +3965,33 @@ declare namespace sap {
|
|
|
3969
3965
|
);
|
|
3970
3966
|
|
|
3971
3967
|
/**
|
|
3972
|
-
* @
|
|
3968
|
+
* @since 1.20.0
|
|
3973
3969
|
*
|
|
3974
3970
|
* Creates a Support Ticket. Forwards the given data (JSON object) to the associated adapter.
|
|
3975
3971
|
*
|
|
3976
|
-
* @returns
|
|
3972
|
+
* @returns Promise, that returns the ID of the generated message
|
|
3977
3973
|
*/
|
|
3978
3974
|
createTicket(
|
|
3979
3975
|
/**
|
|
3980
3976
|
* JSON object containing the input fields required for the support ticket.
|
|
3981
3977
|
*/
|
|
3982
|
-
oSupportTicketData:
|
|
3983
|
-
|
|
3978
|
+
oSupportTicketData: {
|
|
3979
|
+
/**
|
|
3980
|
+
* Subject line of the ticket.
|
|
3981
|
+
*/
|
|
3982
|
+
subject: string;
|
|
3983
|
+
/**
|
|
3984
|
+
* Long text or description of the support ticket.
|
|
3985
|
+
*/
|
|
3986
|
+
text: string;
|
|
3987
|
+
/**
|
|
3988
|
+
* JSON object containing client-related information.
|
|
3989
|
+
*/
|
|
3990
|
+
clientContext: object;
|
|
3991
|
+
}
|
|
3992
|
+
): Promise<string>;
|
|
3984
3993
|
/**
|
|
3985
|
-
* @
|
|
3994
|
+
* @since 1.20.0
|
|
3986
3995
|
*
|
|
3987
3996
|
* Checks if the service is enabled. The service enablement depends on the configuration in the back-end
|
|
3988
3997
|
* system and the bootstrap configuration.
|
|
@@ -3992,27 +4001,25 @@ declare namespace sap {
|
|
|
3992
4001
|
isEnabled(): boolean;
|
|
3993
4002
|
}
|
|
3994
4003
|
/**
|
|
3995
|
-
* @
|
|
4004
|
+
* @since 1.18.0
|
|
3996
4005
|
*
|
|
3997
|
-
* The transient personalizer shall be used in container mode for table personalization.
|
|
4006
|
+
* The transient personalizer shall be used in container mode for table personalization. To be called by
|
|
4007
|
+
* the personalization service getTransientPersonalizer method.
|
|
3998
4008
|
*/
|
|
3999
4009
|
class TransientPersonalizer {
|
|
4000
|
-
/**
|
|
4001
|
-
* To be called by the personalization service getTransientPersonalizer method.
|
|
4002
|
-
*/
|
|
4003
4010
|
constructor();
|
|
4004
4011
|
|
|
4005
4012
|
/**
|
|
4006
|
-
* @
|
|
4013
|
+
* @since 1.18.0
|
|
4007
4014
|
*
|
|
4008
4015
|
* Deletes a personalization data value.
|
|
4009
4016
|
*
|
|
4010
4017
|
* @returns Promise object which returns if the deletion was successful or erroneous. Promise object done
|
|
4011
4018
|
* function: no params. Promise object fail function ins never triggered.
|
|
4012
4019
|
*/
|
|
4013
|
-
delPersData():
|
|
4020
|
+
delPersData(): jQuery.Promise;
|
|
4014
4021
|
/**
|
|
4015
|
-
* @
|
|
4022
|
+
* @since 1.18.0
|
|
4016
4023
|
*
|
|
4017
4024
|
* Gets a personalization data value.
|
|
4018
4025
|
*
|
|
@@ -4020,9 +4027,9 @@ declare namespace sap {
|
|
|
4020
4027
|
* {object} oValue JSON object containing the personalization value. If there is no personalization data
|
|
4021
4028
|
* for the item, undefined is returned. Promise object fail function ins never triggered.
|
|
4022
4029
|
*/
|
|
4023
|
-
getPersData():
|
|
4030
|
+
getPersData(): jQuery.Promise;
|
|
4024
4031
|
/**
|
|
4025
|
-
* @
|
|
4032
|
+
* @since 1.18.0
|
|
4026
4033
|
*
|
|
4027
4034
|
* Synchronously gets a personalization data value.
|
|
4028
4035
|
*
|
|
@@ -4030,7 +4037,7 @@ declare namespace sap {
|
|
|
4030
4037
|
*/
|
|
4031
4038
|
getValue(): object;
|
|
4032
4039
|
/**
|
|
4033
|
-
* @
|
|
4040
|
+
* @since 1.18.0
|
|
4034
4041
|
*
|
|
4035
4042
|
* Sets a personalization data value.
|
|
4036
4043
|
*
|
|
@@ -4042,9 +4049,9 @@ declare namespace sap {
|
|
|
4042
4049
|
* JSON object containing the personalization value.
|
|
4043
4050
|
*/
|
|
4044
4051
|
oValue: object
|
|
4045
|
-
):
|
|
4052
|
+
): jQuery.Promise;
|
|
4046
4053
|
/**
|
|
4047
|
-
* @
|
|
4054
|
+
* @since 1.18.0
|
|
4048
4055
|
*
|
|
4049
4056
|
* Synchronously sets a personalization data value.
|
|
4050
4057
|
*/
|
|
@@ -4056,35 +4063,32 @@ declare namespace sap {
|
|
|
4056
4063
|
): void;
|
|
4057
4064
|
}
|
|
4058
4065
|
/**
|
|
4059
|
-
* @
|
|
4066
|
+
* @since 1.15.0
|
|
4067
|
+
*
|
|
4068
|
+
* The Unified Shell's internal URL parsing service (platform independent) This method MUST be called by
|
|
4069
|
+
* the Unified Shell's container only, others MUST call `sap.ushell.Container.getServiceAsync("URLParsing").then(function
|
|
4070
|
+
* (URLParsing) {});`. Constructs a new instance of the URL parsing service.
|
|
4071
|
+
*
|
|
4072
|
+
* Methods in this class allow to break down a shell compliant hash into it's respective parts (SemanticObject,Action,Context,
|
|
4073
|
+
* Parameters, appSpecificHash) or (ShellPart,appSpecificHash) respectively or construct a hash from its
|
|
4074
|
+
* constituents.
|
|
4075
|
+
*
|
|
4076
|
+
* All methods deal with the *internal* shellHash format.
|
|
4077
|
+
*
|
|
4078
|
+
* Most of the parse methods are robust w.r.t. a leading "#".
|
|
4079
|
+
*
|
|
4080
|
+
* Note: The functions were designed with a "truthy" behavior for not present values, Thus a client should
|
|
4081
|
+
* not rely on the difference between null, "undefined", "" when testing for the result of a parse action.
|
|
4082
|
+
*
|
|
4083
|
+
* The parsing functions are deliberately restrictive and fragile, only shell compliant hashes are parsed
|
|
4084
|
+
* correctly, behavior for non-compliant hashes is undefined and subject to change, notably we do not aim
|
|
4085
|
+
* do "degrade" nicely or support partial parsing of corrupted urls.
|
|
4060
4086
|
*/
|
|
4061
4087
|
class URLParsing {
|
|
4062
|
-
/**
|
|
4063
|
-
* The Unified Shell's internal URL parsing service (platform independent) This method MUST be called by
|
|
4064
|
-
* the Unified Shell's container only, others MUST call `sap.ushell.Container.getServiceAsync("URLParsing").then(function
|
|
4065
|
-
* (URLParsing) {});`. Constructs a new instance of the URL parsing service.
|
|
4066
|
-
*
|
|
4067
|
-
* Methods in this class allow to break down a shell compliant hash into it's respective parts (SemanticObject,Action,Context,
|
|
4068
|
-
* Parameters, appSpecificHash) or (ShellPart,appSpecificHash) respectively or construct a hash from its
|
|
4069
|
-
* constituents.
|
|
4070
|
-
*
|
|
4071
|
-
* All methods deal with the *internal* shellHash format.
|
|
4072
|
-
*
|
|
4073
|
-
* Most of the parse methods are robust w.r.t. a leading "#".
|
|
4074
|
-
*
|
|
4075
|
-
* Note: The functions were designed with a "truthy" behavior for not present values, Thus a client should
|
|
4076
|
-
* not rely on the difference between null, "undefined", "" when testing for the result of a parse action.
|
|
4077
|
-
*
|
|
4078
|
-
* The parsing functions are deliberately restrictive and fragile, only shell compliant hashes are parsed
|
|
4079
|
-
* correctly, behavior for non-compliant hashes is undefined and subject to change, notably we do not aim
|
|
4080
|
-
* do "degrade" nicely or support partial parsing of corrupted urls.
|
|
4081
|
-
* See:
|
|
4082
|
-
* sap.ushell.services.Container#getServiceAsync
|
|
4083
|
-
*/
|
|
4084
4088
|
constructor();
|
|
4085
4089
|
|
|
4086
4090
|
/**
|
|
4087
|
-
* @
|
|
4091
|
+
* @since 1.19.1
|
|
4088
4092
|
* @deprecated (since 1.31) - Please use {@link sap.ui.model.odata.ODataUtils#setOrigin} instead.
|
|
4089
4093
|
*
|
|
4090
4094
|
* Note: deprecated, please use `sap.ui.model.odata.ODataUtils.setOrigin(sServiceUrl, { alias : sSystem
|
|
@@ -4137,9 +4141,9 @@ declare namespace sap {
|
|
|
4137
4141
|
vComponentOrSystem?: string | sap.ui.core.Component
|
|
4138
4142
|
): string;
|
|
4139
4143
|
/**
|
|
4140
|
-
* @
|
|
4144
|
+
* @since 1.16.0
|
|
4141
4145
|
*
|
|
4142
|
-
* compose a shell Hash from it's respective parts Note that it also may append an app specific route
|
|
4146
|
+
* compose a shell Hash from it's respective parts Note that it also may append an app specific route!
|
|
4143
4147
|
*
|
|
4144
4148
|
* @returns the hash part of an URL, e.g. `"Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH` returns
|
|
4145
4149
|
* "" for an undefined object
|
|
@@ -4167,7 +4171,7 @@ declare namespace sap {
|
|
|
4167
4171
|
oShellHash: object
|
|
4168
4172
|
): string;
|
|
4169
4173
|
/**
|
|
4170
|
-
* @
|
|
4174
|
+
* @since 1.16.0
|
|
4171
4175
|
*
|
|
4172
4176
|
* Extract a hash part from an URL, including an app-specific part
|
|
4173
4177
|
*
|
|
@@ -4180,7 +4184,7 @@ declare namespace sap {
|
|
|
4180
4184
|
sURL: string
|
|
4181
4185
|
): string;
|
|
4182
4186
|
/**
|
|
4183
|
-
* @
|
|
4187
|
+
* @since 1.16.0
|
|
4184
4188
|
*
|
|
4185
4189
|
* Extract the Shell hash# part from an URL The application specific route part is removed See {@link #getHash }
|
|
4186
4190
|
* for a function which retains the app specific route.
|
|
@@ -4205,7 +4209,7 @@ declare namespace sap {
|
|
|
4205
4209
|
sShellHashString: string
|
|
4206
4210
|
): Object;
|
|
4207
4211
|
/**
|
|
4208
|
-
* @
|
|
4212
|
+
* @since 1.30.0
|
|
4209
4213
|
* @deprecated (since 1.96) - Please use {@link #isIntentUrlAsync} instead.
|
|
4210
4214
|
*
|
|
4211
4215
|
* Check if a URL has an intent based navigation part which can be parsed into a semantic object and action
|
|
@@ -4227,7 +4231,7 @@ declare namespace sap {
|
|
|
4227
4231
|
sUrl: string
|
|
4228
4232
|
): boolean;
|
|
4229
4233
|
/**
|
|
4230
|
-
* @
|
|
4234
|
+
* @since 1.96.0
|
|
4231
4235
|
*
|
|
4232
4236
|
* Check if a URL has an intent based navigation part which can be parsed into a semantic object and action
|
|
4233
4237
|
* part. Accepts only a relative URL (must contain #) or fully qualified Urls for which origin and filename
|
|
@@ -4248,7 +4252,7 @@ declare namespace sap {
|
|
|
4248
4252
|
sUrl: string
|
|
4249
4253
|
): Promise<boolean>;
|
|
4250
4254
|
/**
|
|
4251
|
-
* @
|
|
4255
|
+
* @since 1.20.0
|
|
4252
4256
|
*
|
|
4253
4257
|
* combine members of a javascript object into a parameter string, note that parameters are ordered in an
|
|
4254
4258
|
* arbitrary manner which is subject to change
|
|
@@ -4263,7 +4267,7 @@ declare namespace sap {
|
|
|
4263
4267
|
oParams: object
|
|
4264
4268
|
): string;
|
|
4265
4269
|
/**
|
|
4266
|
-
* @
|
|
4270
|
+
* @since 1.20.0
|
|
4267
4271
|
*
|
|
4268
4272
|
* parse parameters from a URI query string (starting with ?) into a parameter object
|
|
4269
4273
|
*
|
|
@@ -4276,7 +4280,7 @@ declare namespace sap {
|
|
|
4276
4280
|
sParams: string
|
|
4277
4281
|
): object;
|
|
4278
4282
|
/**
|
|
4279
|
-
* @
|
|
4283
|
+
* @since 1.16.0
|
|
4280
4284
|
*
|
|
4281
4285
|
* Decompose a shell hash into the respective parts
|
|
4282
4286
|
*
|
|
@@ -4308,7 +4312,7 @@ declare namespace sap {
|
|
|
4308
4312
|
sHash: string
|
|
4309
4313
|
): object;
|
|
4310
4314
|
/**
|
|
4311
|
-
* @
|
|
4315
|
+
* @since 1.16.0
|
|
4312
4316
|
*
|
|
4313
4317
|
* split a Unified Shell compliant hash into an Object containing a shell specific part and an app specific
|
|
4314
4318
|
* parts
|
|
@@ -4333,52 +4337,33 @@ declare namespace sap {
|
|
|
4333
4337
|
): object;
|
|
4334
4338
|
}
|
|
4335
4339
|
/**
|
|
4336
|
-
* @
|
|
4340
|
+
* @since 1.32.0
|
|
4341
|
+
*
|
|
4342
|
+
* A UShell service for tracking business flows and user actions. The UsageAnalytics service exposes API
|
|
4343
|
+
* for logging custom events and setting custom field values in the logged events.
|
|
4344
|
+
* The data is sent via http and recorded on a server, whose URL is defined by the `baseUrl` service configuration
|
|
4345
|
+
* property.
|
|
4346
|
+
* The service configuration must also include the site ID from the `pubToken` attribute.
|
|
4347
|
+
* You can find the pubToken in the code snippet provided in the WARP when creating a new site.
|
|
4348
|
+
*
|
|
4349
|
+
* Each tracked event is represented by a table entry on the server database.
|
|
4350
|
+
* The administrator can produce reports based on the the recorded data.
|
|
4351
|
+
*
|
|
4352
|
+
* Two types of events can be logged:
|
|
4353
|
+
* - Automatic events: Click or pageLoad are predefined events, logged by the base tracking library.
|
|
4354
|
+
* You can disable these events in the service configuration.
|
|
4355
|
+
* - Custom events: You can use the service API to log an event with custom data using the function logCustomEvent
|
|
4356
|
+
*
|
|
4337
4357
|
*
|
|
4338
|
-
*
|
|
4358
|
+
* Each tracked event (either automatic or custom) is represented by a database row, that includes 10 custom
|
|
4359
|
+
* attributes named custom1...custom10.
|
|
4360
|
+
* Some of these values can be set using UsageAnalytics service API.
|
|
4339
4361
|
*/
|
|
4340
4362
|
class UsageAnalytics {
|
|
4341
|
-
|
|
4342
|
-
* The UsageAnalytics service exposes API for logging custom events and setting custom field values in the
|
|
4343
|
-
* logged events.
|
|
4344
|
-
* The data is sent via http and recorded on a server, whose URL is defined by the `baseUrl` service configuration
|
|
4345
|
-
* property.
|
|
4346
|
-
* The service configuration must also include the site ID from the `pubToken` attribute.
|
|
4347
|
-
* You can find the pubToken in the code snippet provided in the WARP when creating a new site.
|
|
4348
|
-
*
|
|
4349
|
-
* Each tracked event is represented by a table entry on the server database.
|
|
4350
|
-
* The administrator can produce reports based on the the recorded data.
|
|
4351
|
-
*
|
|
4352
|
-
* Two types of events can be logged:
|
|
4353
|
-
* - Automatic events: Click or pageLoad are predefined events, logged by the base tracking library.
|
|
4354
|
-
* You can disable these events in the service configuration.
|
|
4355
|
-
* - Custom events: You can use the service API to log an event with custom data using the function logCustomEvent
|
|
4356
|
-
*
|
|
4357
|
-
*
|
|
4358
|
-
* Each tracked event (either automatic or custom) is represented by a database row, that includes 10 custom
|
|
4359
|
-
* attributes named custom1...custom10.
|
|
4360
|
-
* Some of these values can be set using UsageAnalytics service API.
|
|
4361
|
-
*
|
|
4362
|
-
* See:
|
|
4363
|
-
* sap.ushell.services.Container#getServiceAsync
|
|
4364
|
-
*/
|
|
4365
|
-
constructor(
|
|
4366
|
-
/**
|
|
4367
|
-
* The interface provided by the container
|
|
4368
|
-
*/
|
|
4369
|
-
oContainerInterface: object,
|
|
4370
|
-
/**
|
|
4371
|
-
* Not used in this service
|
|
4372
|
-
*/
|
|
4373
|
-
sParameter: object,
|
|
4374
|
-
/**
|
|
4375
|
-
* Service configuration
|
|
4376
|
-
*/
|
|
4377
|
-
oServiceProperties: object
|
|
4378
|
-
);
|
|
4363
|
+
constructor();
|
|
4379
4364
|
|
|
4380
4365
|
/**
|
|
4381
|
-
* @
|
|
4366
|
+
* @since 1.32.0
|
|
4382
4367
|
*
|
|
4383
4368
|
* Sets up to 6 customer attributes of logged events according to the given object attributes.
|
|
4384
4369
|
* A customer attribute can be set only once during a session.
|
|
@@ -4402,13 +4387,13 @@ declare namespace sap {
|
|
|
4402
4387
|
oCustomFieldValues: object
|
|
4403
4388
|
): void;
|
|
4404
4389
|
/**
|
|
4405
|
-
* @
|
|
4390
|
+
* @since 1.32.0
|
|
4406
4391
|
*
|
|
4407
4392
|
* Enables the renderer to set the content of the legal message..
|
|
4408
4393
|
*/
|
|
4409
4394
|
setLegalText(): void;
|
|
4410
4395
|
/**
|
|
4411
|
-
* @
|
|
4396
|
+
* @since 1.32.0
|
|
4412
4397
|
*
|
|
4413
4398
|
* Indicates whether the service is available.
|
|
4414
4399
|
*
|
|
@@ -4424,7 +4409,7 @@ declare namespace sap {
|
|
|
4424
4409
|
*/
|
|
4425
4410
|
systemEnabled(): boolean;
|
|
4426
4411
|
/**
|
|
4427
|
-
* @
|
|
4412
|
+
* @since 1.32.0
|
|
4428
4413
|
*
|
|
4429
4414
|
* Indicates whether the user has specified to track activities.
|
|
4430
4415
|
*
|
|
@@ -4440,31 +4425,19 @@ declare namespace sap {
|
|
|
4440
4425
|
userEnabled(): boolean;
|
|
4441
4426
|
}
|
|
4442
4427
|
/**
|
|
4443
|
-
* @
|
|
4428
|
+
* @since 1.16.3
|
|
4429
|
+
*
|
|
4430
|
+
* This method MUST be called by the Unified Shell's container only, others MUST call `sap.ushell.Container.getServiceAsync("UserInfo").then(function
|
|
4431
|
+
* (UserInfo) {});`. Constructs a new instance of the user information service.
|
|
4432
|
+
*
|
|
4433
|
+
* The Unified Shell's user information service, which allows you to retrieve information about the logged-in
|
|
4434
|
+
* user.
|
|
4444
4435
|
*/
|
|
4445
4436
|
class UserInfo {
|
|
4446
|
-
|
|
4447
|
-
* This method MUST be called by the Unified Shell's container only, others MUST call `sap.ushell.Container.getServiceAsync("UserInfo").then(function
|
|
4448
|
-
* (UserInfo) {});`. Constructs a new instance of the user information service.
|
|
4449
|
-
*
|
|
4450
|
-
* The Unified Shell's user information service, which allows you to retrieve information about the logged-in
|
|
4451
|
-
* user.
|
|
4452
|
-
* See:
|
|
4453
|
-
* sap.ushell.services.Container#getServiceAsync
|
|
4454
|
-
*/
|
|
4455
|
-
constructor(
|
|
4456
|
-
/**
|
|
4457
|
-
* Adapter
|
|
4458
|
-
*/
|
|
4459
|
-
oAdapter: object,
|
|
4460
|
-
/**
|
|
4461
|
-
* interface
|
|
4462
|
-
*/
|
|
4463
|
-
oContainerInterface: object
|
|
4464
|
-
);
|
|
4437
|
+
constructor();
|
|
4465
4438
|
|
|
4466
4439
|
/**
|
|
4467
|
-
* @
|
|
4440
|
+
* @since 1.86.0
|
|
4468
4441
|
*
|
|
4469
4442
|
* Returns the email address of the user.
|
|
4470
4443
|
*
|
|
@@ -4472,7 +4445,7 @@ declare namespace sap {
|
|
|
4472
4445
|
*/
|
|
4473
4446
|
getEmail(): string;
|
|
4474
4447
|
/**
|
|
4475
|
-
* @
|
|
4448
|
+
* @since 1.86.0
|
|
4476
4449
|
*
|
|
4477
4450
|
* Returns the first name of the user.
|
|
4478
4451
|
*
|
|
@@ -4480,7 +4453,7 @@ declare namespace sap {
|
|
|
4480
4453
|
*/
|
|
4481
4454
|
getFirstName(): string;
|
|
4482
4455
|
/**
|
|
4483
|
-
* @
|
|
4456
|
+
* @since 1.86.0
|
|
4484
4457
|
*
|
|
4485
4458
|
* Returns the full name of the user.
|
|
4486
4459
|
*
|
|
@@ -4488,7 +4461,7 @@ declare namespace sap {
|
|
|
4488
4461
|
*/
|
|
4489
4462
|
getFullName(): string;
|
|
4490
4463
|
/**
|
|
4491
|
-
* @
|
|
4464
|
+
* @since 1.16.3
|
|
4492
4465
|
*
|
|
4493
4466
|
* Returns the id of the user.
|
|
4494
4467
|
*
|
|
@@ -4496,13 +4469,22 @@ declare namespace sap {
|
|
|
4496
4469
|
*/
|
|
4497
4470
|
getId(): string;
|
|
4498
4471
|
/**
|
|
4499
|
-
* @
|
|
4472
|
+
* @since 1.86.0
|
|
4500
4473
|
*
|
|
4501
4474
|
* Returns the last name of the user.
|
|
4502
4475
|
*
|
|
4503
4476
|
* @returns The user's last name.
|
|
4504
4477
|
*/
|
|
4505
4478
|
getLastName(): string;
|
|
4479
|
+
/**
|
|
4480
|
+
* @since 1.71.0
|
|
4481
|
+
*
|
|
4482
|
+
* Returns an object representing data about the user: ID, first name, last name, full name, e-mail address.
|
|
4483
|
+
*
|
|
4484
|
+
* @returns object providing information about the logged-in user: ID, first name, last name, full name,
|
|
4485
|
+
* e-mail address
|
|
4486
|
+
*/
|
|
4487
|
+
getShellUserInfo(): Promise<any>;
|
|
4506
4488
|
}
|
|
4507
4489
|
}
|
|
4508
4490
|
|
|
@@ -4559,9 +4541,9 @@ declare namespace sap {
|
|
|
4559
4541
|
image?: sap.m.Image;
|
|
4560
4542
|
}
|
|
4561
4543
|
|
|
4562
|
-
interface $
|
|
4544
|
+
interface PictureTile$PictureDeleteEventParameters {}
|
|
4563
4545
|
|
|
4564
|
-
interface $
|
|
4546
|
+
interface PictureViewer$PictureDeletedEventParameters {}
|
|
4565
4547
|
|
|
4566
4548
|
/**
|
|
4567
4549
|
* @deprecated (since 1.22) - Please use {@link sap.m.Carousel} instead.
|
|
@@ -4699,7 +4681,7 @@ declare namespace sap {
|
|
|
4699
4681
|
oListener?: object
|
|
4700
4682
|
): this;
|
|
4701
4683
|
/**
|
|
4702
|
-
* @
|
|
4684
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
4703
4685
|
*
|
|
4704
4686
|
* Fires event {@link #event:pictureDelete pictureDelete} to attached listeners.
|
|
4705
4687
|
*
|
|
@@ -4943,7 +4925,7 @@ declare namespace sap {
|
|
|
4943
4925
|
oListener?: object
|
|
4944
4926
|
): this;
|
|
4945
4927
|
/**
|
|
4946
|
-
* @
|
|
4928
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
4947
4929
|
*
|
|
4948
4930
|
* Fires event {@link #event:pictureDeleted pictureDeleted} to attached listeners.
|
|
4949
4931
|
*
|
|
@@ -5199,13 +5181,17 @@ declare namespace sap {
|
|
|
5199
5181
|
sSrc: string
|
|
5200
5182
|
): sap.ushell.components.factsheet.controls.PictureViewerItem;
|
|
5201
5183
|
}
|
|
5184
|
+
|
|
5185
|
+
type PictureTile$PictureDeleteEvent = sap.ui.base.Event<PictureTile$PictureDeleteEventParameters>;
|
|
5186
|
+
|
|
5187
|
+
type PictureViewer$PictureDeletedEvent = sap.ui.base.Event<PictureViewer$PictureDeletedEventParameters>;
|
|
5202
5188
|
}
|
|
5203
5189
|
}
|
|
5204
5190
|
}
|
|
5205
5191
|
|
|
5206
5192
|
namespace Container {
|
|
5207
5193
|
/**
|
|
5208
|
-
* @
|
|
5194
|
+
* @since 1.90.0
|
|
5209
5195
|
*
|
|
5210
5196
|
* An enumeration for the application work protect mode state.
|
|
5211
5197
|
*/
|
|
@@ -5230,7 +5216,7 @@ declare namespace sap {
|
|
|
5230
5216
|
interface $RendererSettings extends sap.ui.core.$UIComponentSettings {}
|
|
5231
5217
|
|
|
5232
5218
|
/**
|
|
5233
|
-
* @
|
|
5219
|
+
* @since 1.15.0
|
|
5234
5220
|
*
|
|
5235
5221
|
* The SAPUI5 component of SAP Fiori Launchpad renderer for the Unified Shell.
|
|
5236
5222
|
*/
|
|
@@ -5244,7 +5230,7 @@ declare namespace sap {
|
|
|
5244
5230
|
*/
|
|
5245
5231
|
constructor();
|
|
5246
5232
|
/**
|
|
5247
|
-
* @
|
|
5233
|
+
* @since 1.30
|
|
5248
5234
|
*
|
|
5249
5235
|
* The launchpad states that can be passed as a parameter.
|
|
5250
5236
|
*
|
|
@@ -5284,7 +5270,7 @@ declare namespace sap {
|
|
|
5284
5270
|
*/
|
|
5285
5271
|
static getMetadata(): sap.ui.core.ComponentMetadata;
|
|
5286
5272
|
/**
|
|
5287
|
-
* @
|
|
5273
|
+
* @since 1.30
|
|
5288
5274
|
* @deprecated (since 1.48) - Please use {@link #addUserAction} instead.
|
|
5289
5275
|
*
|
|
5290
5276
|
* Creates an action button in the User Actions Menu in the SAP Fiori launchpad, in the given launchpad
|
|
@@ -5335,7 +5321,7 @@ declare namespace sap {
|
|
|
5335
5321
|
aStates: string[]
|
|
5336
5322
|
): sap.ui.core.Control;
|
|
5337
5323
|
/**
|
|
5338
|
-
* @
|
|
5324
|
+
* @since 1.30
|
|
5339
5325
|
* @deprecated (since 1.93)
|
|
5340
5326
|
*
|
|
5341
5327
|
* Adds the given sap.ui.core.Control to the EndUserFeedback dialog.
|
|
@@ -5352,7 +5338,7 @@ declare namespace sap {
|
|
|
5352
5338
|
bShowCustomUIContent: boolean
|
|
5353
5339
|
): void;
|
|
5354
5340
|
/**
|
|
5355
|
-
* @
|
|
5341
|
+
* @since 1.30
|
|
5356
5342
|
* @deprecated (since 1.48) - Please use {@link #addFloatingButton} instead.
|
|
5357
5343
|
*
|
|
5358
5344
|
* Creates a FloatingActionButton in Fiori launchpad, in the given launchpad states.
|
|
@@ -5401,7 +5387,7 @@ declare namespace sap {
|
|
|
5401
5387
|
aStates: string[]
|
|
5402
5388
|
): object;
|
|
5403
5389
|
/**
|
|
5404
|
-
* @
|
|
5390
|
+
* @since 1.48
|
|
5405
5391
|
* @deprecated (since 1.52)
|
|
5406
5392
|
*
|
|
5407
5393
|
* Creates a FloatingActionButton in Fiori launchpad, in the given launchpad states.
|
|
@@ -5440,7 +5426,7 @@ declare namespace sap {
|
|
|
5440
5426
|
oParameters: object
|
|
5441
5427
|
): object;
|
|
5442
5428
|
/**
|
|
5443
|
-
* @
|
|
5429
|
+
* @since 1.30
|
|
5444
5430
|
*
|
|
5445
5431
|
* Creates and displays a shell header icon in Fiori launchpad, in the given launchpad states.
|
|
5446
5432
|
* The icon is displayed in the right side of the Fiori Launchpad shell header or in an overflow menu.
|
|
@@ -5517,7 +5503,7 @@ declare namespace sap {
|
|
|
5517
5503
|
aStates: string[]
|
|
5518
5504
|
): sap.ui.core.Control;
|
|
5519
5505
|
/**
|
|
5520
|
-
* @
|
|
5506
|
+
* @since 1.30
|
|
5521
5507
|
*
|
|
5522
5508
|
* Creates and displays an item in the header of Fiori launchpad, in the given launchpad states.
|
|
5523
5509
|
* The new header item will be displayed on the left-hand side of the Fiori Launchpad shell header, according
|
|
@@ -5579,7 +5565,7 @@ declare namespace sap {
|
|
|
5579
5565
|
aStates: string[]
|
|
5580
5566
|
): sap.ui.core.Control;
|
|
5581
5567
|
/**
|
|
5582
|
-
* @
|
|
5568
|
+
* @since 1.30
|
|
5583
5569
|
*
|
|
5584
5570
|
* Creates and displays an item in the header of Fiori launchpad, in the given launchpad states.
|
|
5585
5571
|
* The new header item will be displayed on the left-hand side of the Fiori Launchpad shell header, according
|
|
@@ -5636,7 +5622,7 @@ declare namespace sap {
|
|
|
5636
5622
|
aStates: string[]
|
|
5637
5623
|
): sap.ui.core.Control;
|
|
5638
5624
|
/**
|
|
5639
|
-
* @
|
|
5625
|
+
* @since 1.30
|
|
5640
5626
|
* @deprecated (since 1.48) - Please use {@link #addSidePaneContent} instead.
|
|
5641
5627
|
*
|
|
5642
5628
|
* Creates the Left Pane content in Fiori launchpad, in the given launchpad states.
|
|
@@ -5684,7 +5670,7 @@ declare namespace sap {
|
|
|
5684
5670
|
aStates: string[]
|
|
5685
5671
|
): object;
|
|
5686
5672
|
/**
|
|
5687
|
-
* @
|
|
5673
|
+
* @since 1.48
|
|
5688
5674
|
*
|
|
5689
5675
|
* Creates and displays a sub header control in Fiori launchpad, in the given launchpad states.
|
|
5690
5676
|
* The new control is displayed in FLP UI according to the given display parameters.
|
|
@@ -5745,7 +5731,7 @@ declare namespace sap {
|
|
|
5745
5731
|
}
|
|
5746
5732
|
): jQuery.Promise;
|
|
5747
5733
|
/**
|
|
5748
|
-
* @
|
|
5734
|
+
* @since 1.48
|
|
5749
5735
|
*
|
|
5750
5736
|
* Creates the Left Pane content in Fiori launchpad, in the given launchpad states.
|
|
5751
5737
|
*
|
|
@@ -5803,7 +5789,7 @@ declare namespace sap {
|
|
|
5803
5789
|
}
|
|
5804
5790
|
): jQuery.Promise;
|
|
5805
5791
|
/**
|
|
5806
|
-
* @
|
|
5792
|
+
* @since 1.30
|
|
5807
5793
|
* @deprecated (since 1.48) - Please use {@link #addShellSubHeader} instead.
|
|
5808
5794
|
*
|
|
5809
5795
|
* Creates and displays a sub header control in Fiori launchpad, in the given launchpad states.
|
|
@@ -5865,7 +5851,7 @@ declare namespace sap {
|
|
|
5865
5851
|
aStates: string[]
|
|
5866
5852
|
): object;
|
|
5867
5853
|
/**
|
|
5868
|
-
* @
|
|
5854
|
+
* @since 1.30
|
|
5869
5855
|
*
|
|
5870
5856
|
* Creates a ToolAreaItem in Fiori Launchpad and adds it to the Tool Area, in the given launchpad states.
|
|
5871
5857
|
* Once the item is added, the Tool Area is rendered on the left side on the Fiori Launchpad shell.
|
|
@@ -5914,7 +5900,7 @@ declare namespace sap {
|
|
|
5914
5900
|
aStates: string[]
|
|
5915
5901
|
): sap.ui.core.Control;
|
|
5916
5902
|
/**
|
|
5917
|
-
* @
|
|
5903
|
+
* @since 1.48
|
|
5918
5904
|
*
|
|
5919
5905
|
* Creates an Action Button in Fiori launchpad, in the given launchpad states.
|
|
5920
5906
|
* The button will be displayed in the user actions menu, that is opened from the user button in the shell
|
|
@@ -5973,7 +5959,7 @@ declare namespace sap {
|
|
|
5973
5959
|
}
|
|
5974
5960
|
): jQuery.Promise;
|
|
5975
5961
|
/**
|
|
5976
|
-
* @
|
|
5962
|
+
* @since 1.30
|
|
5977
5963
|
*
|
|
5978
5964
|
* Adds an entry to the User Preferences dialog box including the UI control that appears when the user
|
|
5979
5965
|
* clicks the new entry, and handling of User Preferences actions such as SAVE and CANCEL.
|
|
@@ -6040,7 +6026,7 @@ declare namespace sap {
|
|
|
6040
6026
|
value: string | Function
|
|
6041
6027
|
): void;
|
|
6042
6028
|
/**
|
|
6043
|
-
* @
|
|
6029
|
+
* @since 1.37
|
|
6044
6030
|
*
|
|
6045
6031
|
* This method returns the current state of the Viewport Container control.
|
|
6046
6032
|
*
|
|
@@ -6048,7 +6034,7 @@ declare namespace sap {
|
|
|
6048
6034
|
*/
|
|
6049
6035
|
getCurrentViewportState(): string;
|
|
6050
6036
|
/**
|
|
6051
|
-
* @
|
|
6037
|
+
* @since 1.30
|
|
6052
6038
|
*
|
|
6053
6039
|
* Hides an action button from the User Actions Menu in the SAP Fiori launchpad, in the given launchpad
|
|
6054
6040
|
* states (LaunchpadState). The removed button will not be destroyed.
|
|
@@ -6074,7 +6060,7 @@ declare namespace sap {
|
|
|
6074
6060
|
aStates: string[]
|
|
6075
6061
|
): void;
|
|
6076
6062
|
/**
|
|
6077
|
-
* @
|
|
6063
|
+
* @since 1.30
|
|
6078
6064
|
* @deprecated (since 1.52)
|
|
6079
6065
|
*
|
|
6080
6066
|
* Hide the given sap.ushell.ui.shell.ShellFloatingAction from Fiori Launchpad, in the given launchpad states.
|
|
@@ -6103,7 +6089,7 @@ declare namespace sap {
|
|
|
6103
6089
|
aStates: string[]
|
|
6104
6090
|
): void;
|
|
6105
6091
|
/**
|
|
6106
|
-
* @
|
|
6092
|
+
* @since 1.30
|
|
6107
6093
|
*
|
|
6108
6094
|
* Hide the given sap.ushell.ui.shell.ShellHeadItem from Fiori Launchpad, in the given launchpad states.
|
|
6109
6095
|
* The removed control will not be destroyed.
|
|
@@ -6131,7 +6117,7 @@ declare namespace sap {
|
|
|
6131
6117
|
aStates: string[]
|
|
6132
6118
|
): void;
|
|
6133
6119
|
/**
|
|
6134
|
-
* @
|
|
6120
|
+
* @since 1.30
|
|
6135
6121
|
*
|
|
6136
6122
|
* Hide the given sap.ushell.ui.shell.ShellHeadItem from Fiori Launchpad, in the given launchpad states.
|
|
6137
6123
|
* The removed control will not be destroyed.
|
|
@@ -6159,7 +6145,7 @@ declare namespace sap {
|
|
|
6159
6145
|
aStates: string[]
|
|
6160
6146
|
): void;
|
|
6161
6147
|
/**
|
|
6162
|
-
* @
|
|
6148
|
+
* @since 1.30
|
|
6163
6149
|
*
|
|
6164
6150
|
* Hide the given control from Fiori Launchpad, in the given launchpad states. The removed control will
|
|
6165
6151
|
* not be destroyed.
|
|
@@ -6187,7 +6173,7 @@ declare namespace sap {
|
|
|
6187
6173
|
aStates: string[]
|
|
6188
6174
|
): void;
|
|
6189
6175
|
/**
|
|
6190
|
-
* @
|
|
6176
|
+
* @since 1.30
|
|
6191
6177
|
*
|
|
6192
6178
|
* Hide the given control from the Fiori Launchpad sub header, in the given launchpad states. The removed
|
|
6193
6179
|
* control will not be destroyed.
|
|
@@ -6215,7 +6201,7 @@ declare namespace sap {
|
|
|
6215
6201
|
aStates: string[]
|
|
6216
6202
|
): void;
|
|
6217
6203
|
/**
|
|
6218
|
-
* @
|
|
6204
|
+
* @since 1.30
|
|
6219
6205
|
*
|
|
6220
6206
|
* If exists, this method will remove the footer from the Fiori Launchpad.
|
|
6221
6207
|
*
|
|
@@ -6225,7 +6211,7 @@ declare namespace sap {
|
|
|
6225
6211
|
*/
|
|
6226
6212
|
removeFooter(): void;
|
|
6227
6213
|
/**
|
|
6228
|
-
* @
|
|
6214
|
+
* @since 1.30
|
|
6229
6215
|
*
|
|
6230
6216
|
* Remove the given Tool Area Item from Fiori Launchpad, in the given launchpad states. This API is meant
|
|
6231
6217
|
* to be used for implementing custom elements in the SAP Fiori launchpad. We do not recommend using it
|
|
@@ -6251,7 +6237,7 @@ declare namespace sap {
|
|
|
6251
6237
|
aStates: string[]
|
|
6252
6238
|
): void;
|
|
6253
6239
|
/**
|
|
6254
|
-
* @
|
|
6240
|
+
* @since 1.30
|
|
6255
6241
|
*
|
|
6256
6242
|
* Displays the given sap.m.Bar as the footer of the Fiori launchpad shell.
|
|
6257
6243
|
* The footer will be displayed in all states.
|
|
@@ -6276,7 +6262,7 @@ declare namespace sap {
|
|
|
6276
6262
|
oFooter: sap.m.Bar
|
|
6277
6263
|
): void;
|
|
6278
6264
|
/**
|
|
6279
|
-
* @
|
|
6265
|
+
* @since 1.42
|
|
6280
6266
|
* @deprecated (since 1.48) - Please use {@link #setShellFooter} instead.
|
|
6281
6267
|
*
|
|
6282
6268
|
* Creates and displays an SAPUI5 control as the footer of the Fiori launchpad shell.
|
|
@@ -6316,7 +6302,7 @@ declare namespace sap {
|
|
|
6316
6302
|
oControlProperties: object
|
|
6317
6303
|
): sap.ui.core.Control;
|
|
6318
6304
|
/**
|
|
6319
|
-
* @
|
|
6305
|
+
* @since 1.30
|
|
6320
6306
|
*
|
|
6321
6307
|
* Sets the title in the Fiori Launchpad shell header.
|
|
6322
6308
|
*/
|
|
@@ -6327,7 +6313,7 @@ declare namespace sap {
|
|
|
6327
6313
|
sTitle: string
|
|
6328
6314
|
): void;
|
|
6329
6315
|
/**
|
|
6330
|
-
* @
|
|
6316
|
+
* @since 1.38
|
|
6331
6317
|
*
|
|
6332
6318
|
* Sets the header visibility according to the given value and shell states. (see sap.ushell.renderers.fiori2.renderer.LaunchpadState).
|
|
6333
6319
|
*
|
|
@@ -6362,7 +6348,7 @@ declare namespace sap {
|
|
|
6362
6348
|
aStates: string[]
|
|
6363
6349
|
): void;
|
|
6364
6350
|
/**
|
|
6365
|
-
* @
|
|
6351
|
+
* @since 1.30
|
|
6366
6352
|
*
|
|
6367
6353
|
* Sets the visibility of the left pane in the Fiori Launchpad shell, in the given launchpad state @see
|
|
6368
6354
|
* LaunchpadState
|
|
@@ -6378,7 +6364,7 @@ declare namespace sap {
|
|
|
6378
6364
|
bVisible: boolean
|
|
6379
6365
|
): void;
|
|
6380
6366
|
/**
|
|
6381
|
-
* @
|
|
6367
|
+
* @since 1.48
|
|
6382
6368
|
*
|
|
6383
6369
|
* Creates and displays an SAPUI5 control as the footer of the Fiori launchpad shell.
|
|
6384
6370
|
* The footer will be displayed in all states.
|
|
@@ -6423,7 +6409,7 @@ declare namespace sap {
|
|
|
6423
6409
|
}
|
|
6424
6410
|
): jQuery.Promise;
|
|
6425
6411
|
/**
|
|
6426
|
-
* @
|
|
6412
|
+
* @since 1.30
|
|
6427
6413
|
*
|
|
6428
6414
|
* Displays action buttons in the User Actions Menu in the SAP Fiori launchpad, in the given launchpad states
|
|
6429
6415
|
* (LaunchpadState). (see sap.ushell.renderers.fiori2.renderer.LaunchpadState).
|
|
@@ -6461,7 +6447,7 @@ declare namespace sap {
|
|
|
6461
6447
|
aStates: string[]
|
|
6462
6448
|
): void;
|
|
6463
6449
|
/**
|
|
6464
|
-
* @
|
|
6450
|
+
* @since 1.30
|
|
6465
6451
|
* @deprecated (since 1.52) - Support for the FloatingActionButton has been discontinued.
|
|
6466
6452
|
*
|
|
6467
6453
|
* Displays FloatingActionButton on the bottom right corner of the Fiori launchpad, in the given launchpad
|
|
@@ -6495,7 +6481,7 @@ declare namespace sap {
|
|
|
6495
6481
|
aStates: string[]
|
|
6496
6482
|
): void;
|
|
6497
6483
|
/**
|
|
6498
|
-
* @
|
|
6484
|
+
* @since 1.30
|
|
6499
6485
|
*
|
|
6500
6486
|
* Displays HeaderItems on the right side of the Fiori launchpad shell header, in the given launchpad states
|
|
6501
6487
|
* (see sap.ushell.renderers.fiori2.renderer.LaunchpadState).
|
|
@@ -6529,7 +6515,7 @@ declare namespace sap {
|
|
|
6529
6515
|
aStates: string[]
|
|
6530
6516
|
): void;
|
|
6531
6517
|
/**
|
|
6532
|
-
* @
|
|
6518
|
+
* @since 1.30
|
|
6533
6519
|
*
|
|
6534
6520
|
* Creates and displays one or more HeaderItem controls according to the given control IDs and Shell states
|
|
6535
6521
|
* (see sap.ushell.renderers.fiori2.renderer.LaunchpadState).
|
|
@@ -6570,7 +6556,7 @@ declare namespace sap {
|
|
|
6570
6556
|
aStates: string[]
|
|
6571
6557
|
): void;
|
|
6572
6558
|
/**
|
|
6573
|
-
* @
|
|
6559
|
+
* @since 1.30
|
|
6574
6560
|
*
|
|
6575
6561
|
* Displays one or more sub header controls according to the given control IDs and shell states.
|
|
6576
6562
|
* (see sap.ushell.renderers.fiori2.renderer.LaunchpadState).
|
|
@@ -6626,7 +6612,7 @@ declare namespace sap {
|
|
|
6626
6612
|
bVisible?: boolean
|
|
6627
6613
|
): void;
|
|
6628
6614
|
/**
|
|
6629
|
-
* @
|
|
6615
|
+
* @since 1.30
|
|
6630
6616
|
*
|
|
6631
6617
|
* Displays ToolAreaItems on the left side of the Fiori Launchpad shell, in the given launchpad states.
|
|
6632
6618
|
*
|
|
@@ -6709,9 +6695,9 @@ declare namespace sap {
|
|
|
6709
6695
|
afterRendering?: (oEvent: sap.ui.base.Event) => void;
|
|
6710
6696
|
}
|
|
6711
6697
|
|
|
6712
|
-
interface $
|
|
6698
|
+
interface AppBox$AfterRenderingEventParameters {}
|
|
6713
6699
|
|
|
6714
|
-
interface $
|
|
6700
|
+
interface AppBox$PressEventParameters {}
|
|
6715
6701
|
|
|
6716
6702
|
/**
|
|
6717
6703
|
* Add your documentation for the new ui/appfinder/AppBox
|
|
@@ -6911,7 +6897,7 @@ declare namespace sap {
|
|
|
6911
6897
|
oListener?: object
|
|
6912
6898
|
): this;
|
|
6913
6899
|
/**
|
|
6914
|
-
* @
|
|
6900
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
6915
6901
|
*
|
|
6916
6902
|
* Fires event {@link #event:afterRendering afterRendering} to attached listeners.
|
|
6917
6903
|
*
|
|
@@ -6924,7 +6910,7 @@ declare namespace sap {
|
|
|
6924
6910
|
mParameters?: object
|
|
6925
6911
|
): this;
|
|
6926
6912
|
/**
|
|
6927
|
-
* @
|
|
6913
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
6928
6914
|
*
|
|
6929
6915
|
* Fires event {@link #event:press press} to attached listeners.
|
|
6930
6916
|
*
|
|
@@ -7069,546 +7055,10 @@ declare namespace sap {
|
|
|
7069
7055
|
sUrl?: string
|
|
7070
7056
|
): this;
|
|
7071
7057
|
}
|
|
7072
|
-
}
|
|
7073
|
-
|
|
7074
|
-
namespace footerbar {
|
|
7075
|
-
interface $AddBookmarkButtonSettings extends sap.m.$ButtonSettings {
|
|
7076
|
-
/**
|
|
7077
|
-
* A callback function that is called before the save-as-tile dialog is opened.
|
|
7078
|
-
*/
|
|
7079
|
-
beforePressHandler?:
|
|
7080
|
-
| Function
|
|
7081
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
7082
|
-
| `{${string}}`;
|
|
7083
|
-
|
|
7084
|
-
/**
|
|
7085
|
-
* A callback function that is called after the save-as-tile dialog is closed.
|
|
7086
|
-
*/
|
|
7087
|
-
afterPressHandler?:
|
|
7088
|
-
| Function
|
|
7089
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
7090
|
-
| `{${string}}`;
|
|
7091
|
-
|
|
7092
|
-
/**
|
|
7093
|
-
* Title to be displayed on the tile.
|
|
7094
|
-
*/
|
|
7095
|
-
title?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
7096
|
-
|
|
7097
|
-
/**
|
|
7098
|
-
* Subtitle to be displayed below the tile title.
|
|
7099
|
-
*/
|
|
7100
|
-
subtitle?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
7101
|
-
|
|
7102
|
-
/**
|
|
7103
|
-
* Text to be displayed at the bottom of the tile.
|
|
7104
|
-
*/
|
|
7105
|
-
info?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
7106
|
-
|
|
7107
|
-
/**
|
|
7108
|
-
* Icon to be displayed in the Tile.
|
|
7109
|
-
*/
|
|
7110
|
-
tileIcon?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
7111
|
-
|
|
7112
|
-
/**
|
|
7113
|
-
* For dynamic tile, the unit to be displayed below the number, for example, USD.
|
|
7114
|
-
*/
|
|
7115
|
-
numberUnit?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
7116
|
-
|
|
7117
|
-
/**
|
|
7118
|
-
* The keywords based on which the future tile should be indexed and filtered.
|
|
7119
|
-
*/
|
|
7120
|
-
keywords?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
7121
|
-
|
|
7122
|
-
/**
|
|
7123
|
-
* A customized target URL for the tile.
|
|
7124
|
-
*/
|
|
7125
|
-
customUrl?:
|
|
7126
|
-
| any
|
|
7127
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
7128
|
-
| `{${string}}`;
|
|
7129
|
-
|
|
7130
|
-
/**
|
|
7131
|
-
* URL of an OData service from which data for a dynamic tile should be read.
|
|
7132
|
-
*/
|
|
7133
|
-
serviceUrl?:
|
|
7134
|
-
| any
|
|
7135
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
7136
|
-
| `{${string}}`;
|
|
7137
|
-
|
|
7138
|
-
/**
|
|
7139
|
-
* Data source of the OData service. See same parameter of {@link sap.ushell.services.Bookmark#addBookmark }
|
|
7140
|
-
* for details
|
|
7141
|
-
*/
|
|
7142
|
-
dataSource?:
|
|
7143
|
-
| any
|
|
7144
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
7145
|
-
| `{${string}}`;
|
|
7146
|
-
|
|
7147
|
-
/**
|
|
7148
|
-
* Number of seconds after which dynamic content is read from the data source and the display is refreshed.
|
|
7149
|
-
*/
|
|
7150
|
-
serviceRefreshInterval?:
|
|
7151
|
-
| string
|
|
7152
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
7153
|
-
|
|
7154
|
-
/**
|
|
7155
|
-
* Whether to display the control for group selection in the save-as-tile dialog in launchpad homepage mode.
|
|
7156
|
-
*/
|
|
7157
|
-
showGroupSelection?:
|
|
7158
|
-
| boolean
|
|
7159
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
7160
|
-
| `{${string}}`;
|
|
7161
|
-
|
|
7162
|
-
/**
|
|
7163
|
-
* Whether to display the control for page selection in the save-bookmark dialog in launchpad spaces mode.
|
|
7164
|
-
*/
|
|
7165
|
-
showPageSelection?:
|
|
7166
|
-
| boolean
|
|
7167
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
7168
|
-
| `{${string}}`;
|
|
7169
|
-
|
|
7170
|
-
/**
|
|
7171
|
-
* @deprecated (since 1.31) - Use dedicated properties like afterPressHandler, beforePresshandler, customUrl,
|
|
7172
|
-
* ... of the AddBookmarkButton instead.
|
|
7173
|
-
*
|
|
7174
|
-
* An object containing properties with information about the app, e.g. serviceUrl, numberUnit, ... .
|
|
7175
|
-
*/
|
|
7176
|
-
appData?:
|
|
7177
|
-
| object
|
|
7178
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
7179
|
-
| `{${string}}`;
|
|
7180
|
-
}
|
|
7181
7058
|
|
|
7182
|
-
|
|
7183
|
-
* Clicking the button opens a dialog box allowing the user to save the app state, so that the app can be
|
|
7184
|
-
* launched in this state directly from the launchpad.
|
|
7185
|
-
*/
|
|
7186
|
-
class AddBookmarkButton extends sap.m.Button {
|
|
7187
|
-
/**
|
|
7188
|
-
* Constructor for a new ui/footerbar/AddBookmarkButton.
|
|
7189
|
-
*
|
|
7190
|
-
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
7191
|
-
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
7192
|
-
* of the syntax of the settings object.
|
|
7193
|
-
*/
|
|
7194
|
-
constructor(
|
|
7195
|
-
/**
|
|
7196
|
-
* Initial settings for the new control
|
|
7197
|
-
*/
|
|
7198
|
-
mSettings?: sap.ushell.ui.footerbar.$AddBookmarkButtonSettings
|
|
7199
|
-
);
|
|
7200
|
-
/**
|
|
7201
|
-
* Constructor for a new ui/footerbar/AddBookmarkButton.
|
|
7202
|
-
*
|
|
7203
|
-
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
7204
|
-
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
7205
|
-
* of the syntax of the settings object.
|
|
7206
|
-
*/
|
|
7207
|
-
constructor(
|
|
7208
|
-
/**
|
|
7209
|
-
* ID for the new control, generated automatically if no id is given
|
|
7210
|
-
*/
|
|
7211
|
-
sId?: string,
|
|
7212
|
-
/**
|
|
7213
|
-
* Initial settings for the new control
|
|
7214
|
-
*/
|
|
7215
|
-
mSettings?: sap.ushell.ui.footerbar.$AddBookmarkButtonSettings
|
|
7216
|
-
);
|
|
7059
|
+
type AppBox$AfterRenderingEvent = sap.ui.base.Event<AppBox$AfterRenderingEventParameters>;
|
|
7217
7060
|
|
|
7218
|
-
|
|
7219
|
-
* Creates a new subclass of class sap.ushell.ui.footerbar.AddBookmarkButton with name `sClassName` and
|
|
7220
|
-
* enriches it with the information contained in `oClassInfo`.
|
|
7221
|
-
*
|
|
7222
|
-
* `oClassInfo` might contain the same kind of information as described in {@link sap.m.Button.extend}.
|
|
7223
|
-
*
|
|
7224
|
-
* @returns Created class / constructor function
|
|
7225
|
-
*/
|
|
7226
|
-
static extend<T extends Record<string, unknown>>(
|
|
7227
|
-
/**
|
|
7228
|
-
* Name of the class being created
|
|
7229
|
-
*/
|
|
7230
|
-
sClassName: string,
|
|
7231
|
-
/**
|
|
7232
|
-
* Object literal with information about the class
|
|
7233
|
-
*/
|
|
7234
|
-
oClassInfo?: sap.ClassInfo<
|
|
7235
|
-
T,
|
|
7236
|
-
sap.ushell.ui.footerbar.AddBookmarkButton
|
|
7237
|
-
>,
|
|
7238
|
-
/**
|
|
7239
|
-
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
7240
|
-
* used by this class
|
|
7241
|
-
*/
|
|
7242
|
-
FNMetaImpl?: Function
|
|
7243
|
-
): Function;
|
|
7244
|
-
/**
|
|
7245
|
-
* Returns a metadata object for class sap.ushell.ui.footerbar.AddBookmarkButton.
|
|
7246
|
-
*
|
|
7247
|
-
* @returns Metadata object describing this class
|
|
7248
|
-
*/
|
|
7249
|
-
static getMetadata(): sap.ui.core.ElementMetadata;
|
|
7250
|
-
/**
|
|
7251
|
-
* Gets current value of property {@link #getAfterPressHandler afterPressHandler}.
|
|
7252
|
-
*
|
|
7253
|
-
* A callback function that is called after the save-as-tile dialog is closed.
|
|
7254
|
-
*
|
|
7255
|
-
* @returns Value of property `afterPressHandler`
|
|
7256
|
-
*/
|
|
7257
|
-
getAfterPressHandler(): Function;
|
|
7258
|
-
/**
|
|
7259
|
-
* @deprecated (since 1.31) - Use dedicated properties like afterPressHandler, beforePresshandler, customUrl,
|
|
7260
|
-
* ... of the AddBookmarkButton instead.
|
|
7261
|
-
*
|
|
7262
|
-
* Gets current value of property {@link #getAppData appData}.
|
|
7263
|
-
*
|
|
7264
|
-
* An object containing properties with information about the app, e.g. serviceUrl, numberUnit, ... .
|
|
7265
|
-
*
|
|
7266
|
-
* @returns Value of property `appData`
|
|
7267
|
-
*/
|
|
7268
|
-
getAppData(): object;
|
|
7269
|
-
/**
|
|
7270
|
-
* Gets current value of property {@link #getBeforePressHandler beforePressHandler}.
|
|
7271
|
-
*
|
|
7272
|
-
* A callback function that is called before the save-as-tile dialog is opened.
|
|
7273
|
-
*
|
|
7274
|
-
* @returns Value of property `beforePressHandler`
|
|
7275
|
-
*/
|
|
7276
|
-
getBeforePressHandler(): Function;
|
|
7277
|
-
/**
|
|
7278
|
-
* Gets current value of property {@link #getCustomUrl customUrl}.
|
|
7279
|
-
*
|
|
7280
|
-
* A customized target URL for the tile.
|
|
7281
|
-
*
|
|
7282
|
-
* @returns Value of property `customUrl`
|
|
7283
|
-
*/
|
|
7284
|
-
getCustomUrl(): any;
|
|
7285
|
-
/**
|
|
7286
|
-
* Gets current value of property {@link #getDataSource dataSource}.
|
|
7287
|
-
*
|
|
7288
|
-
* Data source of the OData service. See same parameter of {@link sap.ushell.services.Bookmark#addBookmark }
|
|
7289
|
-
* for details
|
|
7290
|
-
*
|
|
7291
|
-
* @returns Value of property `dataSource`
|
|
7292
|
-
*/
|
|
7293
|
-
getDataSource(): any;
|
|
7294
|
-
/**
|
|
7295
|
-
* Gets current value of property {@link #getInfo info}.
|
|
7296
|
-
*
|
|
7297
|
-
* Text to be displayed at the bottom of the tile.
|
|
7298
|
-
*
|
|
7299
|
-
* @returns Value of property `info`
|
|
7300
|
-
*/
|
|
7301
|
-
getInfo(): string;
|
|
7302
|
-
/**
|
|
7303
|
-
* Gets current value of property {@link #getKeywords keywords}.
|
|
7304
|
-
*
|
|
7305
|
-
* The keywords based on which the future tile should be indexed and filtered.
|
|
7306
|
-
*
|
|
7307
|
-
* @returns Value of property `keywords`
|
|
7308
|
-
*/
|
|
7309
|
-
getKeywords(): string;
|
|
7310
|
-
/**
|
|
7311
|
-
* Gets current value of property {@link #getNumberUnit numberUnit}.
|
|
7312
|
-
*
|
|
7313
|
-
* For dynamic tile, the unit to be displayed below the number, for example, USD.
|
|
7314
|
-
*
|
|
7315
|
-
* @returns Value of property `numberUnit`
|
|
7316
|
-
*/
|
|
7317
|
-
getNumberUnit(): string;
|
|
7318
|
-
/**
|
|
7319
|
-
* Gets current value of property {@link #getServiceRefreshInterval serviceRefreshInterval}.
|
|
7320
|
-
*
|
|
7321
|
-
* Number of seconds after which dynamic content is read from the data source and the display is refreshed.
|
|
7322
|
-
*
|
|
7323
|
-
* @returns Value of property `serviceRefreshInterval`
|
|
7324
|
-
*/
|
|
7325
|
-
getServiceRefreshInterval(): string;
|
|
7326
|
-
/**
|
|
7327
|
-
* Gets current value of property {@link #getServiceUrl serviceUrl}.
|
|
7328
|
-
*
|
|
7329
|
-
* URL of an OData service from which data for a dynamic tile should be read.
|
|
7330
|
-
*
|
|
7331
|
-
* @returns Value of property `serviceUrl`
|
|
7332
|
-
*/
|
|
7333
|
-
getServiceUrl(): any;
|
|
7334
|
-
/**
|
|
7335
|
-
* Gets current value of property {@link #getShowGroupSelection showGroupSelection}.
|
|
7336
|
-
*
|
|
7337
|
-
* Whether to display the control for group selection in the save-as-tile dialog in launchpad homepage mode.
|
|
7338
|
-
*
|
|
7339
|
-
* Default value is `true`.
|
|
7340
|
-
*
|
|
7341
|
-
* @returns Value of property `showGroupSelection`
|
|
7342
|
-
*/
|
|
7343
|
-
getShowGroupSelection(): boolean;
|
|
7344
|
-
/**
|
|
7345
|
-
* Gets current value of property {@link #getShowPageSelection showPageSelection}.
|
|
7346
|
-
*
|
|
7347
|
-
* Whether to display the control for page selection in the save-bookmark dialog in launchpad spaces mode.
|
|
7348
|
-
*
|
|
7349
|
-
* Default value is `true`.
|
|
7350
|
-
*
|
|
7351
|
-
* @returns Value of property `showPageSelection`
|
|
7352
|
-
*/
|
|
7353
|
-
getShowPageSelection(): boolean;
|
|
7354
|
-
/**
|
|
7355
|
-
* Gets current value of property {@link #getSubtitle subtitle}.
|
|
7356
|
-
*
|
|
7357
|
-
* Subtitle to be displayed below the tile title.
|
|
7358
|
-
*
|
|
7359
|
-
* @returns Value of property `subtitle`
|
|
7360
|
-
*/
|
|
7361
|
-
getSubtitle(): string;
|
|
7362
|
-
/**
|
|
7363
|
-
* Gets current value of property {@link #getTileIcon tileIcon}.
|
|
7364
|
-
*
|
|
7365
|
-
* Icon to be displayed in the Tile.
|
|
7366
|
-
*
|
|
7367
|
-
* @returns Value of property `tileIcon`
|
|
7368
|
-
*/
|
|
7369
|
-
getTileIcon(): string;
|
|
7370
|
-
/**
|
|
7371
|
-
* Gets current value of property {@link #getTitle title}.
|
|
7372
|
-
*
|
|
7373
|
-
* Title to be displayed on the tile.
|
|
7374
|
-
*
|
|
7375
|
-
* @returns Value of property `title`
|
|
7376
|
-
*/
|
|
7377
|
-
getTitle(): string;
|
|
7378
|
-
/**
|
|
7379
|
-
* Sets a new value for property {@link #getAfterPressHandler afterPressHandler}.
|
|
7380
|
-
*
|
|
7381
|
-
* A callback function that is called after the save-as-tile dialog is closed.
|
|
7382
|
-
*
|
|
7383
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
7384
|
-
*
|
|
7385
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
7386
|
-
*/
|
|
7387
|
-
setAfterPressHandler(
|
|
7388
|
-
/**
|
|
7389
|
-
* New value for property `afterPressHandler`
|
|
7390
|
-
*/
|
|
7391
|
-
fnAfterPressHandler?: Function
|
|
7392
|
-
): this;
|
|
7393
|
-
/**
|
|
7394
|
-
* @deprecated (since 1.31) - Use dedicated properties like afterPressHandler, beforePresshandler, customUrl,
|
|
7395
|
-
* ... of the AddBookmarkButton instead.
|
|
7396
|
-
*
|
|
7397
|
-
* Sets a new value for property {@link #getAppData appData}.
|
|
7398
|
-
*
|
|
7399
|
-
* An object containing properties with information about the app, e.g. serviceUrl, numberUnit, ... .
|
|
7400
|
-
*
|
|
7401
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
7402
|
-
*
|
|
7403
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
7404
|
-
*/
|
|
7405
|
-
setAppData(
|
|
7406
|
-
/**
|
|
7407
|
-
* New value for property `appData`
|
|
7408
|
-
*/
|
|
7409
|
-
oAppData?: object
|
|
7410
|
-
): this;
|
|
7411
|
-
/**
|
|
7412
|
-
* Sets a new value for property {@link #getBeforePressHandler beforePressHandler}.
|
|
7413
|
-
*
|
|
7414
|
-
* A callback function that is called before the save-as-tile dialog is opened.
|
|
7415
|
-
*
|
|
7416
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
7417
|
-
*
|
|
7418
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
7419
|
-
*/
|
|
7420
|
-
setBeforePressHandler(
|
|
7421
|
-
/**
|
|
7422
|
-
* New value for property `beforePressHandler`
|
|
7423
|
-
*/
|
|
7424
|
-
fnBeforePressHandler?: Function
|
|
7425
|
-
): this;
|
|
7426
|
-
/**
|
|
7427
|
-
* Sets a new value for property {@link #getCustomUrl customUrl}.
|
|
7428
|
-
*
|
|
7429
|
-
* A customized target URL for the tile.
|
|
7430
|
-
*
|
|
7431
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
7432
|
-
*
|
|
7433
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
7434
|
-
*/
|
|
7435
|
-
setCustomUrl(
|
|
7436
|
-
/**
|
|
7437
|
-
* New value for property `customUrl`
|
|
7438
|
-
*/
|
|
7439
|
-
oCustomUrl?: any
|
|
7440
|
-
): this;
|
|
7441
|
-
/**
|
|
7442
|
-
* Sets a new value for property {@link #getDataSource dataSource}.
|
|
7443
|
-
*
|
|
7444
|
-
* Data source of the OData service. See same parameter of {@link sap.ushell.services.Bookmark#addBookmark }
|
|
7445
|
-
* for details
|
|
7446
|
-
*
|
|
7447
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
7448
|
-
*
|
|
7449
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
7450
|
-
*/
|
|
7451
|
-
setDataSource(
|
|
7452
|
-
/**
|
|
7453
|
-
* New value for property `dataSource`
|
|
7454
|
-
*/
|
|
7455
|
-
oDataSource?: any
|
|
7456
|
-
): this;
|
|
7457
|
-
/**
|
|
7458
|
-
* Sets a new value for property {@link #getInfo info}.
|
|
7459
|
-
*
|
|
7460
|
-
* Text to be displayed at the bottom of the tile.
|
|
7461
|
-
*
|
|
7462
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
7463
|
-
*
|
|
7464
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
7465
|
-
*/
|
|
7466
|
-
setInfo(
|
|
7467
|
-
/**
|
|
7468
|
-
* New value for property `info`
|
|
7469
|
-
*/
|
|
7470
|
-
sInfo?: string
|
|
7471
|
-
): this;
|
|
7472
|
-
/**
|
|
7473
|
-
* Sets a new value for property {@link #getKeywords keywords}.
|
|
7474
|
-
*
|
|
7475
|
-
* The keywords based on which the future tile should be indexed and filtered.
|
|
7476
|
-
*
|
|
7477
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
7478
|
-
*
|
|
7479
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
7480
|
-
*/
|
|
7481
|
-
setKeywords(
|
|
7482
|
-
/**
|
|
7483
|
-
* New value for property `keywords`
|
|
7484
|
-
*/
|
|
7485
|
-
sKeywords?: string
|
|
7486
|
-
): this;
|
|
7487
|
-
/**
|
|
7488
|
-
* Sets a new value for property {@link #getNumberUnit numberUnit}.
|
|
7489
|
-
*
|
|
7490
|
-
* For dynamic tile, the unit to be displayed below the number, for example, USD.
|
|
7491
|
-
*
|
|
7492
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
7493
|
-
*
|
|
7494
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
7495
|
-
*/
|
|
7496
|
-
setNumberUnit(
|
|
7497
|
-
/**
|
|
7498
|
-
* New value for property `numberUnit`
|
|
7499
|
-
*/
|
|
7500
|
-
sNumberUnit?: string
|
|
7501
|
-
): this;
|
|
7502
|
-
/**
|
|
7503
|
-
* Sets a new value for property {@link #getServiceRefreshInterval serviceRefreshInterval}.
|
|
7504
|
-
*
|
|
7505
|
-
* Number of seconds after which dynamic content is read from the data source and the display is refreshed.
|
|
7506
|
-
*
|
|
7507
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
7508
|
-
*
|
|
7509
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
7510
|
-
*/
|
|
7511
|
-
setServiceRefreshInterval(
|
|
7512
|
-
/**
|
|
7513
|
-
* New value for property `serviceRefreshInterval`
|
|
7514
|
-
*/
|
|
7515
|
-
sServiceRefreshInterval?: string
|
|
7516
|
-
): this;
|
|
7517
|
-
/**
|
|
7518
|
-
* Sets a new value for property {@link #getServiceUrl serviceUrl}.
|
|
7519
|
-
*
|
|
7520
|
-
* URL of an OData service from which data for a dynamic tile should be read.
|
|
7521
|
-
*
|
|
7522
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
7523
|
-
*
|
|
7524
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
7525
|
-
*/
|
|
7526
|
-
setServiceUrl(
|
|
7527
|
-
/**
|
|
7528
|
-
* New value for property `serviceUrl`
|
|
7529
|
-
*/
|
|
7530
|
-
oServiceUrl?: any
|
|
7531
|
-
): this;
|
|
7532
|
-
/**
|
|
7533
|
-
* Sets a new value for property {@link #getShowGroupSelection showGroupSelection}.
|
|
7534
|
-
*
|
|
7535
|
-
* Whether to display the control for group selection in the save-as-tile dialog in launchpad homepage mode.
|
|
7536
|
-
*
|
|
7537
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
7538
|
-
*
|
|
7539
|
-
* Default value is `true`.
|
|
7540
|
-
*
|
|
7541
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
7542
|
-
*/
|
|
7543
|
-
setShowGroupSelection(
|
|
7544
|
-
/**
|
|
7545
|
-
* New value for property `showGroupSelection`
|
|
7546
|
-
*/
|
|
7547
|
-
bShowGroupSelection?: boolean
|
|
7548
|
-
): this;
|
|
7549
|
-
/**
|
|
7550
|
-
* Sets a new value for property {@link #getShowPageSelection showPageSelection}.
|
|
7551
|
-
*
|
|
7552
|
-
* Whether to display the control for page selection in the save-bookmark dialog in launchpad spaces mode.
|
|
7553
|
-
*
|
|
7554
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
7555
|
-
*
|
|
7556
|
-
* Default value is `true`.
|
|
7557
|
-
*
|
|
7558
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
7559
|
-
*/
|
|
7560
|
-
setShowPageSelection(
|
|
7561
|
-
/**
|
|
7562
|
-
* New value for property `showPageSelection`
|
|
7563
|
-
*/
|
|
7564
|
-
bShowPageSelection?: boolean
|
|
7565
|
-
): this;
|
|
7566
|
-
/**
|
|
7567
|
-
* Sets a new value for property {@link #getSubtitle subtitle}.
|
|
7568
|
-
*
|
|
7569
|
-
* Subtitle to be displayed below the tile title.
|
|
7570
|
-
*
|
|
7571
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
7572
|
-
*
|
|
7573
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
7574
|
-
*/
|
|
7575
|
-
setSubtitle(
|
|
7576
|
-
/**
|
|
7577
|
-
* New value for property `subtitle`
|
|
7578
|
-
*/
|
|
7579
|
-
sSubtitle?: string
|
|
7580
|
-
): this;
|
|
7581
|
-
/**
|
|
7582
|
-
* Sets a new value for property {@link #getTileIcon tileIcon}.
|
|
7583
|
-
*
|
|
7584
|
-
* Icon to be displayed in the Tile.
|
|
7585
|
-
*
|
|
7586
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
7587
|
-
*
|
|
7588
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
7589
|
-
*/
|
|
7590
|
-
setTileIcon(
|
|
7591
|
-
/**
|
|
7592
|
-
* New value for property `tileIcon`
|
|
7593
|
-
*/
|
|
7594
|
-
sTileIcon?: string
|
|
7595
|
-
): this;
|
|
7596
|
-
/**
|
|
7597
|
-
* Sets a new value for property {@link #getTitle title}.
|
|
7598
|
-
*
|
|
7599
|
-
* Title to be displayed on the tile.
|
|
7600
|
-
*
|
|
7601
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
7602
|
-
*
|
|
7603
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
7604
|
-
*/
|
|
7605
|
-
setTitle(
|
|
7606
|
-
/**
|
|
7607
|
-
* New value for property `title`
|
|
7608
|
-
*/
|
|
7609
|
-
sTitle?: string
|
|
7610
|
-
): this;
|
|
7611
|
-
}
|
|
7061
|
+
type AppBox$PressEvent = sap.ui.base.Event<AppBox$PressEventParameters>;
|
|
7612
7062
|
}
|
|
7613
7063
|
|
|
7614
7064
|
namespace launchpad {
|
|
@@ -7708,22 +7158,22 @@ declare namespace sap {
|
|
|
7708
7158
|
press?: (oEvent: sap.ui.base.Event) => void;
|
|
7709
7159
|
}
|
|
7710
7160
|
|
|
7711
|
-
interface $
|
|
7161
|
+
interface ActionItem$AfterRenderingEventParameters {}
|
|
7712
7162
|
|
|
7713
|
-
interface $
|
|
7714
|
-
extends sap.m
|
|
7163
|
+
interface ActionItem$PressEventParameters
|
|
7164
|
+
extends sap.m.Button$PressEventParameters {}
|
|
7715
7165
|
|
|
7716
|
-
interface $
|
|
7166
|
+
interface DashboardGroupsContainer$AfterRenderingEventParameters {}
|
|
7717
7167
|
|
|
7718
|
-
interface $
|
|
7168
|
+
interface LinkTileWrapper$AfterRenderingEventParameters {}
|
|
7719
7169
|
|
|
7720
|
-
interface $
|
|
7170
|
+
interface LinkTileWrapper$CoverDivPressEventParameters {}
|
|
7721
7171
|
|
|
7722
|
-
interface $
|
|
7172
|
+
interface LinkTileWrapper$PressEventParameters {}
|
|
7723
7173
|
|
|
7724
|
-
interface $
|
|
7174
|
+
interface LinkTileWrapper$ShowActionsEventParameters {}
|
|
7725
7175
|
|
|
7726
|
-
interface $
|
|
7176
|
+
interface TileState$PressEventParameters {}
|
|
7727
7177
|
|
|
7728
7178
|
class ActionItem extends sap.m.Button {
|
|
7729
7179
|
/**
|
|
@@ -7910,7 +7360,7 @@ declare namespace sap {
|
|
|
7910
7360
|
oListener?: object
|
|
7911
7361
|
): this;
|
|
7912
7362
|
/**
|
|
7913
|
-
* @
|
|
7363
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
7914
7364
|
*
|
|
7915
7365
|
* Fires event {@link #event:afterRendering afterRendering} to attached listeners.
|
|
7916
7366
|
*
|
|
@@ -7923,7 +7373,7 @@ declare namespace sap {
|
|
|
7923
7373
|
mParameters?: object
|
|
7924
7374
|
): this;
|
|
7925
7375
|
/**
|
|
7926
|
-
* @
|
|
7376
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
7927
7377
|
*
|
|
7928
7378
|
* Fires event {@link #event:press press} to attached listeners.
|
|
7929
7379
|
*
|
|
@@ -8105,7 +7555,7 @@ declare namespace sap {
|
|
|
8105
7555
|
oListener?: object
|
|
8106
7556
|
): this;
|
|
8107
7557
|
/**
|
|
8108
|
-
* @
|
|
7558
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
8109
7559
|
*
|
|
8110
7560
|
* Fires event {@link #event:afterRendering afterRendering} to attached listeners.
|
|
8111
7561
|
*
|
|
@@ -8558,7 +8008,7 @@ declare namespace sap {
|
|
|
8558
8008
|
oListener?: object
|
|
8559
8009
|
): this;
|
|
8560
8010
|
/**
|
|
8561
|
-
* @
|
|
8011
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
8562
8012
|
*
|
|
8563
8013
|
* Fires event {@link #event:afterRendering afterRendering} to attached listeners.
|
|
8564
8014
|
*
|
|
@@ -8571,7 +8021,7 @@ declare namespace sap {
|
|
|
8571
8021
|
mParameters?: object
|
|
8572
8022
|
): this;
|
|
8573
8023
|
/**
|
|
8574
|
-
* @
|
|
8024
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
8575
8025
|
*
|
|
8576
8026
|
* Fires event {@link #event:coverDivPress coverDivPress} to attached listeners.
|
|
8577
8027
|
*
|
|
@@ -8584,7 +8034,7 @@ declare namespace sap {
|
|
|
8584
8034
|
mParameters?: object
|
|
8585
8035
|
): this;
|
|
8586
8036
|
/**
|
|
8587
|
-
* @
|
|
8037
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
8588
8038
|
*
|
|
8589
8039
|
* Fires event {@link #event:press press} to attached listeners.
|
|
8590
8040
|
*
|
|
@@ -8597,7 +8047,7 @@ declare namespace sap {
|
|
|
8597
8047
|
mParameters?: object
|
|
8598
8048
|
): this;
|
|
8599
8049
|
/**
|
|
8600
|
-
* @
|
|
8050
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
8601
8051
|
*
|
|
8602
8052
|
* Fires event {@link #event:showActions showActions} to attached listeners.
|
|
8603
8053
|
*
|
|
@@ -9047,7 +8497,7 @@ declare namespace sap {
|
|
|
9047
8497
|
oListener?: object
|
|
9048
8498
|
): this;
|
|
9049
8499
|
/**
|
|
9050
|
-
* @
|
|
8500
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
9051
8501
|
*
|
|
9052
8502
|
* Fires event {@link #event:press press} to attached listeners.
|
|
9053
8503
|
*
|
|
@@ -9083,6 +8533,22 @@ declare namespace sap {
|
|
|
9083
8533
|
sState?: string
|
|
9084
8534
|
): this;
|
|
9085
8535
|
}
|
|
8536
|
+
|
|
8537
|
+
type ActionItem$AfterRenderingEvent = sap.ui.base.Event<ActionItem$AfterRenderingEventParameters>;
|
|
8538
|
+
|
|
8539
|
+
type ActionItem$PressEvent = sap.ui.base.Event<ActionItem$PressEventParameters>;
|
|
8540
|
+
|
|
8541
|
+
type DashboardGroupsContainer$AfterRenderingEvent = sap.ui.base.Event<DashboardGroupsContainer$AfterRenderingEventParameters>;
|
|
8542
|
+
|
|
8543
|
+
type LinkTileWrapper$AfterRenderingEvent = sap.ui.base.Event<LinkTileWrapper$AfterRenderingEventParameters>;
|
|
8544
|
+
|
|
8545
|
+
type LinkTileWrapper$CoverDivPressEvent = sap.ui.base.Event<LinkTileWrapper$CoverDivPressEventParameters>;
|
|
8546
|
+
|
|
8547
|
+
type LinkTileWrapper$PressEvent = sap.ui.base.Event<LinkTileWrapper$PressEventParameters>;
|
|
8548
|
+
|
|
8549
|
+
type LinkTileWrapper$ShowActionsEvent = sap.ui.base.Event<LinkTileWrapper$ShowActionsEventParameters>;
|
|
8550
|
+
|
|
8551
|
+
type TileState$PressEvent = sap.ui.base.Event<TileState$PressEventParameters>;
|
|
9086
8552
|
}
|
|
9087
8553
|
|
|
9088
8554
|
namespace shell {
|
|
@@ -9106,7 +8572,7 @@ declare namespace sap {
|
|
|
9106
8572
|
text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
9107
8573
|
|
|
9108
8574
|
/**
|
|
9109
|
-
* @
|
|
8575
|
+
* @since 1.30
|
|
9110
8576
|
*
|
|
9111
8577
|
* Text which will be read by screenreader.
|
|
9112
8578
|
*/
|
|
@@ -9141,12 +8607,12 @@ declare namespace sap {
|
|
|
9141
8607
|
expand?: (oEvent: sap.ui.base.Event) => void;
|
|
9142
8608
|
}
|
|
9143
8609
|
|
|
9144
|
-
interface $
|
|
8610
|
+
interface ToolAreaItem$ExpandEventParameters {}
|
|
9145
8611
|
|
|
9146
|
-
interface $
|
|
8612
|
+
interface ToolAreaItem$PressEventParameters {}
|
|
9147
8613
|
|
|
9148
8614
|
/**
|
|
9149
|
-
* @
|
|
8615
|
+
* @since 1.30.5
|
|
9150
8616
|
*
|
|
9151
8617
|
* A control to be placed in the tool area
|
|
9152
8618
|
*/
|
|
@@ -9336,7 +8802,7 @@ declare namespace sap {
|
|
|
9336
8802
|
oListener?: object
|
|
9337
8803
|
): this;
|
|
9338
8804
|
/**
|
|
9339
|
-
* @
|
|
8805
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
9340
8806
|
*
|
|
9341
8807
|
* Fires event {@link #event:expand expand} to attached listeners.
|
|
9342
8808
|
*
|
|
@@ -9349,7 +8815,7 @@ declare namespace sap {
|
|
|
9349
8815
|
mParameters?: object
|
|
9350
8816
|
): this;
|
|
9351
8817
|
/**
|
|
9352
|
-
* @
|
|
8818
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
9353
8819
|
*
|
|
9354
8820
|
* Fires event {@link #event:press press} to attached listeners.
|
|
9355
8821
|
*
|
|
@@ -9362,7 +8828,7 @@ declare namespace sap {
|
|
|
9362
8828
|
mParameters?: object
|
|
9363
8829
|
): this;
|
|
9364
8830
|
/**
|
|
9365
|
-
* @
|
|
8831
|
+
* @since 1.30
|
|
9366
8832
|
*
|
|
9367
8833
|
* Gets current value of property {@link #getAriaLabel ariaLabel}.
|
|
9368
8834
|
*
|
|
@@ -9418,7 +8884,7 @@ declare namespace sap {
|
|
|
9418
8884
|
*/
|
|
9419
8885
|
getVisible(): boolean;
|
|
9420
8886
|
/**
|
|
9421
|
-
* @
|
|
8887
|
+
* @since 1.30
|
|
9422
8888
|
*
|
|
9423
8889
|
* Sets a new value for property {@link #getAriaLabel ariaLabel}.
|
|
9424
8890
|
*
|
|
@@ -9516,11 +8982,15 @@ declare namespace sap {
|
|
|
9516
8982
|
bVisible?: boolean
|
|
9517
8983
|
): this;
|
|
9518
8984
|
}
|
|
8985
|
+
|
|
8986
|
+
type ToolAreaItem$ExpandEvent = sap.ui.base.Event<ToolAreaItem$ExpandEventParameters>;
|
|
8987
|
+
|
|
8988
|
+
type ToolAreaItem$PressEvent = sap.ui.base.Event<ToolAreaItem$PressEventParameters>;
|
|
9519
8989
|
}
|
|
9520
8990
|
|
|
9521
8991
|
namespace tile {
|
|
9522
8992
|
/**
|
|
9523
|
-
* @
|
|
8993
|
+
* @since 1.15.0
|
|
9524
8994
|
*
|
|
9525
8995
|
* An applauncher tile for simple, static apps, displaying title, subtitle, an icon and additional information
|
|
9526
8996
|
*/
|
|
@@ -9616,7 +9086,7 @@ declare namespace sap {
|
|
|
9616
9086
|
}
|
|
9617
9087
|
|
|
9618
9088
|
/**
|
|
9619
|
-
* @
|
|
9089
|
+
* @since 1.38.0
|
|
9620
9090
|
*
|
|
9621
9091
|
* The Unified Shell's ShellUIService service.
|
|
9622
9092
|
*
|
|
@@ -9744,7 +9214,7 @@ declare namespace sap {
|
|
|
9744
9214
|
*/
|
|
9745
9215
|
static getMetadata(): sap.ui.base.Metadata;
|
|
9746
9216
|
/**
|
|
9747
|
-
* @
|
|
9217
|
+
* @since 1.38.0
|
|
9748
9218
|
*
|
|
9749
9219
|
* Returns the title that was last set via {@link setTitle}.
|
|
9750
9220
|
*
|
|
@@ -9752,7 +9222,7 @@ declare namespace sap {
|
|
|
9752
9222
|
*/
|
|
9753
9223
|
getTitle(): string;
|
|
9754
9224
|
/**
|
|
9755
|
-
* @
|
|
9225
|
+
* @since 1.38.0
|
|
9756
9226
|
*
|
|
9757
9227
|
* Displays the given hierarchy in the shell header.
|
|
9758
9228
|
*/
|
|
@@ -9789,7 +9259,7 @@ declare namespace sap {
|
|
|
9789
9259
|
aHierarchyLevels?: object[]
|
|
9790
9260
|
): void;
|
|
9791
9261
|
/**
|
|
9792
|
-
* @
|
|
9262
|
+
* @since 1.40.0
|
|
9793
9263
|
*
|
|
9794
9264
|
* Used by apps to set related apps. This setting is propagated towards the Shell Header via corresponding
|
|
9795
9265
|
* events.
|
|
@@ -9826,7 +9296,7 @@ declare namespace sap {
|
|
|
9826
9296
|
aRelatedApps?: object[]
|
|
9827
9297
|
): void;
|
|
9828
9298
|
/**
|
|
9829
|
-
* @
|
|
9299
|
+
* @since 1.38.0
|
|
9830
9300
|
*
|
|
9831
9301
|
* Displays the given title in the shell header. This method should not be called if the app calling the
|
|
9832
9302
|
* method is not currently displayed in the Fiori Launchpad.
|
|
@@ -9841,7 +9311,7 @@ declare namespace sap {
|
|
|
9841
9311
|
}
|
|
9842
9312
|
|
|
9843
9313
|
/**
|
|
9844
|
-
* @
|
|
9314
|
+
* @since 1.15.0
|
|
9845
9315
|
*
|
|
9846
9316
|
* The Unified Shell's container which manages renderers, services, and adapters. The container is designed
|
|
9847
9317
|
* to be a singleton. Instead of creating an instance please access the central instance via namespace `sap.ushell.Container`.
|
|
@@ -9849,14 +9319,14 @@ declare namespace sap {
|
|
|
9849
9319
|
class Container {
|
|
9850
9320
|
constructor();
|
|
9851
9321
|
/**
|
|
9852
|
-
* @
|
|
9322
|
+
* @since 1.21.1
|
|
9853
9323
|
*
|
|
9854
9324
|
* An enumeration for the application work protect mode state.
|
|
9855
9325
|
*/
|
|
9856
9326
|
DirtyState: sap.ushell.Container.DirtyState;
|
|
9857
9327
|
|
|
9858
9328
|
/**
|
|
9859
|
-
* @
|
|
9329
|
+
* @since 1.15.0
|
|
9860
9330
|
*
|
|
9861
9331
|
* Logs out the current user from all relevant back-end systems, including the logon system itself. This
|
|
9862
9332
|
* member represents the default native implementation of logout. If SessionHandler was created, we register
|
|
@@ -9865,7 +9335,7 @@ declare namespace sap {
|
|
|
9865
9335
|
logout: undefined;
|
|
9866
9336
|
|
|
9867
9337
|
/**
|
|
9868
|
-
* @
|
|
9338
|
+
* @since 1.15.0
|
|
9869
9339
|
*
|
|
9870
9340
|
* Adds a system to the list of remote systems currently in use. On logout this list is processed and performs
|
|
9871
9341
|
* a logout for each system via the ContainerAdapter specific for its platform.
|
|
@@ -9877,7 +9347,7 @@ declare namespace sap {
|
|
|
9877
9347
|
oRemoteSystem: sap.ushell.System
|
|
9878
9348
|
): void;
|
|
9879
9349
|
/**
|
|
9880
|
-
* @
|
|
9350
|
+
* @since 1.19.1
|
|
9881
9351
|
*
|
|
9882
9352
|
* Attaches a listener to the logout event. In case the bAsyncFunction parameter is true, the fnFunction
|
|
9883
9353
|
* must return a promise. FLP will wait for the promise to be resolved before doing the actual logout.
|
|
@@ -9893,7 +9363,7 @@ declare namespace sap {
|
|
|
9893
9363
|
bAsyncFunction: boolean
|
|
9894
9364
|
): void;
|
|
9895
9365
|
/**
|
|
9896
|
-
* @
|
|
9366
|
+
* @since 1.34.1
|
|
9897
9367
|
*
|
|
9898
9368
|
* Attaches a listener to the rendererCreated event.
|
|
9899
9369
|
*/
|
|
@@ -9907,7 +9377,7 @@ declare namespace sap {
|
|
|
9907
9377
|
fnFunction: Function
|
|
9908
9378
|
): void;
|
|
9909
9379
|
/**
|
|
9910
|
-
* @
|
|
9380
|
+
* @since 1.21.2
|
|
9911
9381
|
*
|
|
9912
9382
|
* Cancels the logon procedure in the current frame, if any. This MUST be used by the logon frame provider
|
|
9913
9383
|
* in case the user wants to close the logon frame for good. It will report "Authentication cancelled" and
|
|
@@ -9918,7 +9388,7 @@ declare namespace sap {
|
|
|
9918
9388
|
*/
|
|
9919
9389
|
cancelLogon(): void;
|
|
9920
9390
|
/**
|
|
9921
|
-
* @
|
|
9391
|
+
* @since 1.15.0
|
|
9922
9392
|
*
|
|
9923
9393
|
* Creates a new renderer instance for the given renderer name.
|
|
9924
9394
|
*
|
|
@@ -9955,7 +9425,7 @@ declare namespace sap {
|
|
|
9955
9425
|
| sap.ui.core.ComponentContainer
|
|
9956
9426
|
| Promise<sap.ui.core.ComponentContainer>;
|
|
9957
9427
|
/**
|
|
9958
|
-
* @
|
|
9428
|
+
* @since 1.67.0
|
|
9959
9429
|
*
|
|
9960
9430
|
* Deregister the work protection dirty callback function. See registerDirtyStateProvider for more information.
|
|
9961
9431
|
* Only the last registered function will be deregistered (in case it was registered multiple times).
|
|
@@ -9964,10 +9434,10 @@ declare namespace sap {
|
|
|
9964
9434
|
/**
|
|
9965
9435
|
* function for determining the state of the application
|
|
9966
9436
|
*/
|
|
9967
|
-
fnDirty:
|
|
9437
|
+
fnDirty: () => boolean
|
|
9968
9438
|
): void;
|
|
9969
9439
|
/**
|
|
9970
|
-
* @
|
|
9440
|
+
* @since 1.19.1
|
|
9971
9441
|
*
|
|
9972
9442
|
* Detaches a listener from the logout event.
|
|
9973
9443
|
*/
|
|
@@ -9978,7 +9448,7 @@ declare namespace sap {
|
|
|
9978
9448
|
fnFunction: Function
|
|
9979
9449
|
): void;
|
|
9980
9450
|
/**
|
|
9981
|
-
* @
|
|
9451
|
+
* @since 1.34.1
|
|
9982
9452
|
*
|
|
9983
9453
|
* Detaches a listener from the rendererCreated event.
|
|
9984
9454
|
*/
|
|
@@ -9989,7 +9459,7 @@ declare namespace sap {
|
|
|
9989
9459
|
fnFunction: Function
|
|
9990
9460
|
): void;
|
|
9991
9461
|
/**
|
|
9992
|
-
* @
|
|
9462
|
+
* @since 1.27.0
|
|
9993
9463
|
*
|
|
9994
9464
|
* If the dirty state was set to 'false' using 'setDirtyFlag' the registered dirty state provider methods
|
|
9995
9465
|
* get called to determine the actual dirty state. The determined dirty state is then returned.
|
|
@@ -10001,7 +9471,7 @@ declare namespace sap {
|
|
|
10001
9471
|
*/
|
|
10002
9472
|
getDirtyFlag(): boolean;
|
|
10003
9473
|
/**
|
|
10004
|
-
* @
|
|
9474
|
+
* @since 1.21.1
|
|
10005
9475
|
*
|
|
10006
9476
|
* Returns the global dirty state.
|
|
10007
9477
|
*
|
|
@@ -10011,7 +9481,7 @@ declare namespace sap {
|
|
|
10011
9481
|
*/
|
|
10012
9482
|
getGlobalDirty(): jQuery.Deferred;
|
|
10013
9483
|
/**
|
|
10014
|
-
* @
|
|
9484
|
+
* @since 1.30.0
|
|
10015
9485
|
*
|
|
10016
9486
|
* Gets a renderer instance for the given renderer name, that was created by the createRenderer method.
|
|
10017
9487
|
*
|
|
@@ -10028,7 +9498,7 @@ declare namespace sap {
|
|
|
10028
9498
|
sRendererName?: string
|
|
10029
9499
|
): sap.ui.core.Control | sap.ui.core.Component;
|
|
10030
9500
|
/**
|
|
10031
|
-
* @
|
|
9501
|
+
* @since 1.15.0
|
|
10032
9502
|
* @deprecated (since 1.77) - Please use {@link #getServiceAsync} instead.
|
|
10033
9503
|
*
|
|
10034
9504
|
* Returns a service with the given name, creating it if necessary. Services are singleton objects identified
|
|
@@ -10103,7 +9573,7 @@ declare namespace sap {
|
|
|
10103
9573
|
bAsync?: boolean
|
|
10104
9574
|
): object | Promise<object>;
|
|
10105
9575
|
/**
|
|
10106
|
-
* @
|
|
9576
|
+
* @since 1.55.0
|
|
10107
9577
|
*
|
|
10108
9578
|
* Returns a Promise that resolves a service with the given name, creating it if necessary. Services are
|
|
10109
9579
|
* singleton objects identified by their (resulting) name.
|
|
@@ -10171,7 +9641,7 @@ declare namespace sap {
|
|
|
10171
9641
|
sParameter?: string
|
|
10172
9642
|
): Promise<object>;
|
|
10173
9643
|
/**
|
|
10174
|
-
* @
|
|
9644
|
+
* @since 1.31.0
|
|
10175
9645
|
*
|
|
10176
9646
|
* Register the work protection dirty callback function. In the work protect mechanism, each platform can
|
|
10177
9647
|
* register their own method in order to check if data was changed during the session, and notify the container
|
|
@@ -10195,10 +9665,10 @@ declare namespace sap {
|
|
|
10195
9665
|
* }
|
|
10196
9666
|
* ```
|
|
10197
9667
|
*/
|
|
10198
|
-
fnDirty:
|
|
9668
|
+
fnDirty: () => boolean
|
|
10199
9669
|
): void;
|
|
10200
9670
|
/**
|
|
10201
|
-
* @
|
|
9671
|
+
* @since 1.27.0
|
|
10202
9672
|
*
|
|
10203
9673
|
* Setter for the isDirty flag value.
|
|
10204
9674
|
*
|
|
@@ -10212,7 +9682,7 @@ declare namespace sap {
|
|
|
10212
9682
|
): void;
|
|
10213
9683
|
}
|
|
10214
9684
|
/**
|
|
10215
|
-
* @
|
|
9685
|
+
* @since 1.15.0
|
|
10216
9686
|
*
|
|
10217
9687
|
* A representation of a system
|
|
10218
9688
|
*/
|