@sapui5/types 1.120.9 → 1.121.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/types/index.d.ts +1 -0
- package/types/sap.apf.d.ts +50 -18
- package/types/sap.ca.ui.d.ts +1112 -544
- package/types/sap.chart.d.ts +17 -1
- package/types/sap.collaboration.d.ts +185 -64
- package/types/sap.esh.search.ui.d.ts +2 -1886
- package/types/sap.f.d.ts +124 -45
- package/types/sap.fe.core.d.ts +75 -79
- package/types/sap.fe.macros.d.ts +427 -554
- package/types/sap.fe.navigation.d.ts +4 -6
- package/types/sap.fe.placeholder.d.ts +1 -1
- package/types/sap.fe.plugins.managecache.d.ts +9 -0
- package/types/sap.fe.templates.d.ts +1 -7
- package/types/sap.fe.test.d.ts +105 -27
- package/types/sap.fe.tools.d.ts +1 -1
- package/types/sap.feedback.ui.d.ts +1 -1
- package/types/sap.gantt.d.ts +222 -63
- package/types/sap.insights.d.ts +115 -1
- package/types/sap.m.d.ts +2105 -303
- package/types/sap.makit.d.ts +11 -1
- package/types/sap.me.d.ts +7 -1
- package/types/sap.ndc.d.ts +1 -1
- package/types/sap.ovp.d.ts +1 -1
- package/types/sap.rules.ui.d.ts +134 -75
- package/types/sap.sac.df.d.ts +270 -47
- package/types/sap.suite.ui.commons.d.ts +1318 -19
- package/types/sap.suite.ui.generic.template.d.ts +38 -48
- package/types/sap.suite.ui.microchart.d.ts +63 -1
- package/types/sap.tnt.d.ts +628 -113
- package/types/sap.ui.codeeditor.d.ts +10 -6
- package/types/sap.ui.commons.d.ts +92 -8
- package/types/sap.ui.comp.d.ts +260 -111
- package/types/sap.ui.core.d.ts +500 -186
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.export.d.ts +16 -3
- package/types/sap.ui.fl.d.ts +91 -68
- package/types/sap.ui.generic.app.d.ts +250 -193
- package/types/sap.ui.generic.template.d.ts +1 -1
- package/types/sap.ui.integration.d.ts +51 -4
- package/types/sap.ui.layout.d.ts +214 -27
- package/types/sap.ui.mdc.d.ts +1544 -811
- package/types/sap.ui.richtexteditor.d.ts +4 -1
- package/types/sap.ui.rta.d.ts +1 -1
- package/types/sap.ui.suite.d.ts +3 -1
- package/types/sap.ui.support.d.ts +28 -4
- package/types/sap.ui.table.d.ts +65 -11
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +157 -54
- package/types/sap.ui.ux3.d.ts +30 -12
- package/types/sap.ui.vbm.d.ts +6081 -3279
- package/types/sap.ui.vk.d.ts +93 -105
- package/types/sap.ui.vtm.d.ts +681 -211
- package/types/sap.ui.webc.common.d.ts +1 -1
- package/types/sap.ui.webc.fiori.d.ts +49 -1
- package/types/sap.ui.webc.main.d.ts +144 -9
- package/types/sap.uiext.inbox.d.ts +1 -1
- package/types/sap.ushell.d.ts +4394 -3926
- package/types/sap.ushell_abap.d.ts +1 -1
- package/types/sap.uxap.d.ts +52 -5
- package/types/sap.viz.d.ts +89 -1
- package/types/sap.webanalytics.core.d.ts +1 -1
- package/types/sap.zen.commons.d.ts +79 -18
- package/types/sap.zen.crosstab.d.ts +81 -13
- package/types/sap.zen.dsh.d.ts +194 -143
|
@@ -1,18 +1,21 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.121.0
|
|
2
2
|
|
|
3
3
|
declare module "sap/ui/generic/app/library" {
|
|
4
4
|
export namespace navigation {
|
|
5
5
|
namespace service {
|
|
6
6
|
/**
|
|
7
|
-
* @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.NavType} instead.
|
|
8
|
-
*
|
|
9
7
|
* A static enumeration type which indicates the type of inbound navigation
|
|
8
|
+
*
|
|
9
|
+
* This enum is part of the 'sap/ui/generic/app/library' module export and must be accessed by the property
|
|
10
|
+
* 'navigation.service.NavType'.
|
|
11
|
+
*
|
|
12
|
+
* @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.NavType} instead.
|
|
10
13
|
*/
|
|
11
14
|
enum NavType {
|
|
12
15
|
/**
|
|
13
|
-
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
14
|
-
*
|
|
15
16
|
* Passing iapp-state data within xapp state in addition to existing values
|
|
17
|
+
*
|
|
18
|
+
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
16
19
|
*/
|
|
17
20
|
hybrid = "undefined",
|
|
18
21
|
/**
|
|
@@ -35,10 +38,13 @@ declare module "sap/ui/generic/app/library" {
|
|
|
35
38
|
xAppState = "undefined",
|
|
36
39
|
}
|
|
37
40
|
/**
|
|
38
|
-
* @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.ParamHandlingMode} instead.
|
|
39
|
-
*
|
|
40
41
|
* A static enumeration type which indicates the conflict resolution method when merging URL parameters
|
|
41
42
|
* into select options
|
|
43
|
+
*
|
|
44
|
+
* This enum is part of the 'sap/ui/generic/app/library' module export and must be accessed by the property
|
|
45
|
+
* 'navigation.service.ParamHandlingMode'.
|
|
46
|
+
*
|
|
47
|
+
* @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.ParamHandlingMode} instead.
|
|
42
48
|
*/
|
|
43
49
|
enum ParamHandlingMode {
|
|
44
50
|
/**
|
|
@@ -57,12 +63,15 @@ declare module "sap/ui/generic/app/library" {
|
|
|
57
63
|
URLParamWins = "undefined",
|
|
58
64
|
}
|
|
59
65
|
/**
|
|
60
|
-
* @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.SuppressionBehavior} instead.
|
|
61
|
-
*
|
|
62
66
|
* A static enumeration type which indicates whether semantic attributes with values `null`, `undefined`
|
|
63
67
|
* or `""` (empty string) shall be suppressed, before they are mixed in to the selection variant in the
|
|
64
68
|
* method {@link sap.ui.generic.app.navigation.service.NavigationHandler.mixAttributesAndSelectionVariant mixAttributesAndSelectionVariant }
|
|
65
69
|
* of the {@link sap.ui.generic.app.navigation.service.NavigationHandler NavigationHandler}
|
|
70
|
+
*
|
|
71
|
+
* This enum is part of the 'sap/ui/generic/app/library' module export and must be accessed by the property
|
|
72
|
+
* 'navigation.service.SuppressionBehavior'.
|
|
73
|
+
*
|
|
74
|
+
* @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.SuppressionBehavior} instead.
|
|
66
75
|
*/
|
|
67
76
|
enum SuppressionBehavior {
|
|
68
77
|
/**
|
|
@@ -104,10 +113,10 @@ declare module "sap/ui/generic/app/ApplicationController" {
|
|
|
104
113
|
import TransactionController from "sap/ui/generic/app/transaction/TransactionController";
|
|
105
114
|
|
|
106
115
|
/**
|
|
116
|
+
* Application Controller.
|
|
117
|
+
*
|
|
107
118
|
* @since 1.32.0
|
|
108
119
|
* @experimental (since 1.32.0)
|
|
109
|
-
*
|
|
110
|
-
* Application Controller.
|
|
111
120
|
*/
|
|
112
121
|
export default class ApplicationController extends BaseController {
|
|
113
122
|
/**
|
|
@@ -130,6 +139,7 @@ declare module "sap/ui/generic/app/ApplicationController" {
|
|
|
130
139
|
*
|
|
131
140
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.generic.app.transaction.BaseController.extend}.
|
|
132
141
|
*
|
|
142
|
+
*
|
|
133
143
|
* @returns Created class / constructor function
|
|
134
144
|
*/
|
|
135
145
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -150,13 +160,14 @@ declare module "sap/ui/generic/app/ApplicationController" {
|
|
|
150
160
|
/**
|
|
151
161
|
* Returns a metadata object for class sap.ui.generic.app.ApplicationController.
|
|
152
162
|
*
|
|
163
|
+
*
|
|
153
164
|
* @returns Metadata object describing this class
|
|
154
165
|
*/
|
|
155
166
|
static getMetadata(): Metadata;
|
|
156
167
|
/**
|
|
157
|
-
* @experimental (since 1.32.0)
|
|
158
|
-
*
|
|
159
168
|
* Frees all resources claimed during the life-time of this instance.
|
|
169
|
+
*
|
|
170
|
+
* @experimental (since 1.32.0)
|
|
160
171
|
*/
|
|
161
172
|
destroy(): void;
|
|
162
173
|
/**
|
|
@@ -165,6 +176,7 @@ declare module "sap/ui/generic/app/ApplicationController" {
|
|
|
165
176
|
* will be executed. PreparationAction will be called if there is no global side effect annotation available
|
|
166
177
|
* or if no trigger action is configured in the global side effect.
|
|
167
178
|
*
|
|
179
|
+
*
|
|
168
180
|
* @returns A `Promise` for asynchronous execution of the action. The promise is either already resolved
|
|
169
181
|
* (when nothing needs to be processed) or resolves when the `triggerSubmitChanges()` has been executed.
|
|
170
182
|
*/
|
|
@@ -192,11 +204,11 @@ declare module "sap/ui/generic/app/ApplicationController" {
|
|
|
192
204
|
mAdditionalParameters: Record<string, any>
|
|
193
205
|
): Promise<any>;
|
|
194
206
|
/**
|
|
207
|
+
* Creates a context for an action call (OData function import)
|
|
208
|
+
*
|
|
195
209
|
* @since 1.38
|
|
196
210
|
* @experimental
|
|
197
211
|
*
|
|
198
|
-
* Creates a context for an action call (OData function import)
|
|
199
|
-
*
|
|
200
212
|
* @returns A `map` that contains two Promises: `context` which provides the action-specific model context
|
|
201
213
|
* to the resolve function `result` which resolves when the success handler is called and rejects when the
|
|
202
214
|
* error handler is called; The result of the promises is normalized in both cases, error and success.
|
|
@@ -218,6 +230,7 @@ declare module "sap/ui/generic/app/ApplicationController" {
|
|
|
218
230
|
/**
|
|
219
231
|
* Returns the current transaction controller instance.
|
|
220
232
|
*
|
|
233
|
+
*
|
|
221
234
|
* @returns The transaction controller instance
|
|
222
235
|
*/
|
|
223
236
|
getTransactionController(): TransactionController;
|
|
@@ -225,6 +238,7 @@ declare module "sap/ui/generic/app/ApplicationController" {
|
|
|
225
238
|
* Invokes an action for every provided context where the properties are taken as input from. The changes
|
|
226
239
|
* are submitted directly to the back-end.
|
|
227
240
|
*
|
|
241
|
+
*
|
|
228
242
|
* @returns A `Promise` for asynchronous execution of the action
|
|
229
243
|
*/
|
|
230
244
|
invokeActions(
|
|
@@ -249,11 +263,11 @@ declare module "sap/ui/generic/app/ApplicationController" {
|
|
|
249
263
|
}
|
|
250
264
|
): Promise<any>;
|
|
251
265
|
/**
|
|
252
|
-
* @experimental (since 1.32.0)
|
|
253
|
-
*
|
|
254
266
|
* Notifies the application controller of a change of a property. Please note that the method is not meant
|
|
255
267
|
* for productive use currently. It is experimental.
|
|
256
268
|
*
|
|
269
|
+
* @experimental (since 1.32.0)
|
|
270
|
+
*
|
|
257
271
|
* @returns A `Promise` for asynchronous execution of the action
|
|
258
272
|
*/
|
|
259
273
|
propertyChanged(
|
|
@@ -267,9 +281,9 @@ declare module "sap/ui/generic/app/ApplicationController" {
|
|
|
267
281
|
oContext: object
|
|
268
282
|
): Promise<any>;
|
|
269
283
|
/**
|
|
270
|
-
* @experimental (since 1.32.0)
|
|
271
|
-
*
|
|
272
284
|
* Registers a change for the given group id.
|
|
285
|
+
*
|
|
286
|
+
* @experimental (since 1.32.0)
|
|
273
287
|
*/
|
|
274
288
|
registerGroupChange(
|
|
275
289
|
/**
|
|
@@ -278,9 +292,9 @@ declare module "sap/ui/generic/app/ApplicationController" {
|
|
|
278
292
|
sGroupId: string
|
|
279
293
|
): void;
|
|
280
294
|
/**
|
|
281
|
-
* @experimental (since 1.32.0)
|
|
282
|
-
*
|
|
283
295
|
* Registers the given view with the Application Controller.
|
|
296
|
+
*
|
|
297
|
+
* @experimental (since 1.32.0)
|
|
284
298
|
*/
|
|
285
299
|
registerView(
|
|
286
300
|
/**
|
|
@@ -297,9 +311,9 @@ declare module "sap/ui/generic/app/navigation/service/NavError" {
|
|
|
297
311
|
import Metadata from "sap/ui/base/Metadata";
|
|
298
312
|
|
|
299
313
|
/**
|
|
300
|
-
* @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.NavError} instead.
|
|
301
|
-
*
|
|
302
314
|
* An object that provides error handling information during runtime.
|
|
315
|
+
*
|
|
316
|
+
* @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.NavError} instead.
|
|
303
317
|
*/
|
|
304
318
|
export default class NavError extends NavError1 {
|
|
305
319
|
/**
|
|
@@ -323,6 +337,7 @@ declare module "sap/ui/generic/app/navigation/service/NavError" {
|
|
|
323
337
|
*
|
|
324
338
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.fe.navigation.NavError.extend}.
|
|
325
339
|
*
|
|
340
|
+
*
|
|
326
341
|
* @returns Created class / constructor function
|
|
327
342
|
*/
|
|
328
343
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -343,14 +358,15 @@ declare module "sap/ui/generic/app/navigation/service/NavError" {
|
|
|
343
358
|
/**
|
|
344
359
|
* Returns a metadata object for class sap.ui.generic.app.navigation.service.NavError.
|
|
345
360
|
*
|
|
361
|
+
*
|
|
346
362
|
* @returns Metadata object describing this class
|
|
347
363
|
*/
|
|
348
364
|
static getMetadata(): Metadata;
|
|
349
365
|
/**
|
|
350
|
-
* @deprecated (since 1.83.0)
|
|
351
|
-
*
|
|
352
366
|
* Returns the error code with which the instance has been created.
|
|
353
367
|
*
|
|
368
|
+
* @deprecated (since 1.83.0)
|
|
369
|
+
*
|
|
354
370
|
* @returns The error code of the error
|
|
355
371
|
*/
|
|
356
372
|
getErrorCode(): string;
|
|
@@ -365,8 +381,6 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
365
381
|
import Metadata from "sap/ui/base/Metadata";
|
|
366
382
|
|
|
367
383
|
/**
|
|
368
|
-
* @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.NavigationHandler} instead.
|
|
369
|
-
*
|
|
370
384
|
* Creates a new NavigationHandler class by providing the required environment.
|
|
371
385
|
* The `NavigationHandler` supports the verification of sensitive information. All properties that are
|
|
372
386
|
* part of `selectionVariant` and `valueTexts` will be verified if they are annotated as `com.sap.vocabularies.PersonalData.v1.IsPotentiallySensitive`
|
|
@@ -381,6 +395,8 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
381
395
|
* context.
|
|
382
396
|
* **Note:** This class requires that the UShell {@link sap.ushell.services.CrossApplicationNavigation }
|
|
383
397
|
* is available and initialized.
|
|
398
|
+
*
|
|
399
|
+
* @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.NavigationHandler} instead.
|
|
384
400
|
*/
|
|
385
401
|
export default class NavigationHandler extends NavigationHandler1 {
|
|
386
402
|
constructor(
|
|
@@ -397,13 +413,13 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
397
413
|
);
|
|
398
414
|
|
|
399
415
|
/**
|
|
416
|
+
* The method creates a context url based on provided data. This context url can either be used as {@link sap.ui.generic.app.navigation.service.NavigationHandler#setParameterContextUrl ParameterContextUrl }
|
|
417
|
+
* or {@link sap.ui.generic.app.navigation.service.NavigationHandler#setFilterContextUrl FilterContextUrl}
|
|
418
|
+
*
|
|
400
419
|
* @since 1.60.2
|
|
401
420
|
* @deprecated (since 1.83.0)
|
|
402
421
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
403
422
|
*
|
|
404
|
-
* The method creates a context url based on provided data. This context url can either be used as {@link sap.ui.generic.app.navigation.service.NavigationHandler#setParameterContextUrl ParameterContextUrl }
|
|
405
|
-
* or {@link sap.ui.generic.app.navigation.service.NavigationHandler#setFilterContextUrl FilterContextUrl}
|
|
406
|
-
*
|
|
407
423
|
* @returns context url for the given entities
|
|
408
424
|
*/
|
|
409
425
|
static constructContextUrl(
|
|
@@ -422,6 +438,7 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
422
438
|
*
|
|
423
439
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.fe.navigation.NavigationHandler.extend}.
|
|
424
440
|
*
|
|
441
|
+
*
|
|
425
442
|
* @returns Created class / constructor function
|
|
426
443
|
*/
|
|
427
444
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -442,12 +459,11 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
442
459
|
/**
|
|
443
460
|
* Returns a metadata object for class sap.ui.generic.app.navigation.service.NavigationHandler.
|
|
444
461
|
*
|
|
462
|
+
*
|
|
445
463
|
* @returns Metadata object describing this class
|
|
446
464
|
*/
|
|
447
465
|
static getMetadata(): Metadata;
|
|
448
466
|
/**
|
|
449
|
-
* @deprecated (since 1.83.0)
|
|
450
|
-
*
|
|
451
467
|
* Gets the application specific technical parameters. Technical parameters will not be added to the selection
|
|
452
468
|
* variant passed to the application. As a default the following values are considered as technical parameters:
|
|
453
469
|
*
|
|
@@ -455,18 +471,20 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
455
471
|
* - `sap-ushell-defaultedParameterNames`
|
|
456
472
|
* - `"hcpApplicationId"`
|
|
457
473
|
*
|
|
474
|
+
* @deprecated (since 1.83.0)
|
|
475
|
+
*
|
|
458
476
|
* @returns Containing the technical parameters.
|
|
459
477
|
*/
|
|
460
478
|
static getTechnicalParameters(): any[];
|
|
461
479
|
/**
|
|
462
|
-
* @deprecated (since 1.83.0)
|
|
463
|
-
*
|
|
464
480
|
* Combines the given parameters and selection variant into a new selection variant containing properties
|
|
465
481
|
* from both, with the parameters overriding existing properties in the selection variant. The new selection
|
|
466
482
|
* variant does not contain any parameters. All parameters are merged into select options. The output of
|
|
467
483
|
* this function, converted to a JSON string, can be used for the {@link #.navigate NavigationHandler.navigate }
|
|
468
484
|
* method.
|
|
469
485
|
*
|
|
486
|
+
* @deprecated (since 1.83.0)
|
|
487
|
+
*
|
|
470
488
|
* @returns Instance of {@link sap.ui.generic.app.navigation.service.SelectionVariant}
|
|
471
489
|
*/
|
|
472
490
|
static mixAttributesAndSelectionVariant(
|
|
@@ -486,6 +504,11 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
486
504
|
iSuppressionBehavior?: int
|
|
487
505
|
): object;
|
|
488
506
|
/**
|
|
507
|
+
* Triggers a cross-app navigation after saving the inner and the cross-app states. Since 1.52.0 the navigation
|
|
508
|
+
* mode based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state
|
|
509
|
+
* will not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad
|
|
510
|
+
* default navigation for opening a URL in-place or ex-place.
|
|
511
|
+
*
|
|
489
512
|
* @deprecated (since 1.83.0) -
|
|
490
513
|
* **Node:** If the `oExternalAppData` parameter is not supplied, the external app data will be calculated
|
|
491
514
|
* based on the `oInnerAppData` data.
|
|
@@ -496,11 +519,6 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
496
519
|
* of the error (info/warning/error) {array} **oError.params**
|
|
497
520
|
* An array of objects (typically strings) that describe additional value parameters required for generating
|
|
498
521
|
* the message
|
|
499
|
-
*
|
|
500
|
-
* Triggers a cross-app navigation after saving the inner and the cross-app states. Since 1.52.0 the navigation
|
|
501
|
-
* mode based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state
|
|
502
|
-
* will not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad
|
|
503
|
-
* default navigation for opening a URL in-place or ex-place.
|
|
504
522
|
*/
|
|
505
523
|
static navigate(
|
|
506
524
|
/**
|
|
@@ -575,6 +593,11 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
575
593
|
sNavMode?: string
|
|
576
594
|
): void;
|
|
577
595
|
/**
|
|
596
|
+
* Triggers a cross-app navigation after saving the inner and the cross-app states. Since 1.52.0 the navigation
|
|
597
|
+
* mode based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state
|
|
598
|
+
* will not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad
|
|
599
|
+
* default navigation for opening a URL in-place or ex-place.
|
|
600
|
+
*
|
|
578
601
|
* @deprecated (since 1.83.0) -
|
|
579
602
|
* **Node:** If the `oExternalAppData` parameter is not supplied, the external app data will be calculated
|
|
580
603
|
* based on the `oInnerAppData` data.
|
|
@@ -585,11 +608,6 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
585
608
|
* of the error (info/warning/error) {array} **oError.params**
|
|
586
609
|
* An array of objects (typically strings) that describe additional value parameters required for generating
|
|
587
610
|
* the message
|
|
588
|
-
*
|
|
589
|
-
* Triggers a cross-app navigation after saving the inner and the cross-app states. Since 1.52.0 the navigation
|
|
590
|
-
* mode based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state
|
|
591
|
-
* will not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad
|
|
592
|
-
* default navigation for opening a URL in-place or ex-place.
|
|
593
611
|
*/
|
|
594
612
|
static navigate(
|
|
595
613
|
/**
|
|
@@ -660,6 +678,11 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
660
678
|
sNavMode?: string
|
|
661
679
|
): void;
|
|
662
680
|
/**
|
|
681
|
+
* Triggers a cross-app navigation after saving the inner and the cross-app states. Since 1.52.0 the navigation
|
|
682
|
+
* mode based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state
|
|
683
|
+
* will not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad
|
|
684
|
+
* default navigation for opening a URL in-place or ex-place.
|
|
685
|
+
*
|
|
663
686
|
* @deprecated (since 1.83.0) -
|
|
664
687
|
* **Node:** If the `oExternalAppData` parameter is not supplied, the external app data will be calculated
|
|
665
688
|
* based on the `oInnerAppData` data.
|
|
@@ -670,11 +693,6 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
670
693
|
* of the error (info/warning/error) {array} **oError.params**
|
|
671
694
|
* An array of objects (typically strings) that describe additional value parameters required for generating
|
|
672
695
|
* the message
|
|
673
|
-
*
|
|
674
|
-
* Triggers a cross-app navigation after saving the inner and the cross-app states. Since 1.52.0 the navigation
|
|
675
|
-
* mode based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state
|
|
676
|
-
* will not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad
|
|
677
|
-
* default navigation for opening a URL in-place or ex-place.
|
|
678
696
|
*/
|
|
679
697
|
static navigate(
|
|
680
698
|
/**
|
|
@@ -720,6 +738,11 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
720
738
|
sNavMode?: string
|
|
721
739
|
): void;
|
|
722
740
|
/**
|
|
741
|
+
* Triggers a cross-app navigation after saving the inner and the cross-app states. Since 1.52.0 the navigation
|
|
742
|
+
* mode based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state
|
|
743
|
+
* will not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad
|
|
744
|
+
* default navigation for opening a URL in-place or ex-place.
|
|
745
|
+
*
|
|
723
746
|
* @deprecated (since 1.83.0) -
|
|
724
747
|
* **Node:** If the `oExternalAppData` parameter is not supplied, the external app data will be calculated
|
|
725
748
|
* based on the `oInnerAppData` data.
|
|
@@ -730,11 +753,6 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
730
753
|
* of the error (info/warning/error) {array} **oError.params**
|
|
731
754
|
* An array of objects (typically strings) that describe additional value parameters required for generating
|
|
732
755
|
* the message
|
|
733
|
-
*
|
|
734
|
-
* Triggers a cross-app navigation after saving the inner and the cross-app states. Since 1.52.0 the navigation
|
|
735
|
-
* mode based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state
|
|
736
|
-
* will not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad
|
|
737
|
-
* default navigation for opening a URL in-place or ex-place.
|
|
738
756
|
*/
|
|
739
757
|
static navigate(
|
|
740
758
|
/**
|
|
@@ -803,6 +821,11 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
803
821
|
sNavMode?: string
|
|
804
822
|
): void;
|
|
805
823
|
/**
|
|
824
|
+
* Triggers a cross-app navigation after saving the inner and the cross-app states. Since 1.52.0 the navigation
|
|
825
|
+
* mode based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state
|
|
826
|
+
* will not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad
|
|
827
|
+
* default navigation for opening a URL in-place or ex-place.
|
|
828
|
+
*
|
|
806
829
|
* @deprecated (since 1.83.0) -
|
|
807
830
|
* **Node:** If the `oExternalAppData` parameter is not supplied, the external app data will be calculated
|
|
808
831
|
* based on the `oInnerAppData` data.
|
|
@@ -813,11 +836,6 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
813
836
|
* of the error (info/warning/error) {array} **oError.params**
|
|
814
837
|
* An array of objects (typically strings) that describe additional value parameters required for generating
|
|
815
838
|
* the message
|
|
816
|
-
*
|
|
817
|
-
* Triggers a cross-app navigation after saving the inner and the cross-app states. Since 1.52.0 the navigation
|
|
818
|
-
* mode based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state
|
|
819
|
-
* will not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad
|
|
820
|
-
* default navigation for opening a URL in-place or ex-place.
|
|
821
839
|
*/
|
|
822
840
|
static navigate(
|
|
823
841
|
/**
|
|
@@ -859,6 +877,11 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
859
877
|
sNavMode?: string
|
|
860
878
|
): void;
|
|
861
879
|
/**
|
|
880
|
+
* Triggers a cross-app navigation after saving the inner and the cross-app states. Since 1.52.0 the navigation
|
|
881
|
+
* mode based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state
|
|
882
|
+
* will not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad
|
|
883
|
+
* default navigation for opening a URL in-place or ex-place.
|
|
884
|
+
*
|
|
862
885
|
* @deprecated (since 1.83.0) -
|
|
863
886
|
* **Node:** If the `oExternalAppData` parameter is not supplied, the external app data will be calculated
|
|
864
887
|
* based on the `oInnerAppData` data.
|
|
@@ -869,11 +892,6 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
869
892
|
* of the error (info/warning/error) {array} **oError.params**
|
|
870
893
|
* An array of objects (typically strings) that describe additional value parameters required for generating
|
|
871
894
|
* the message
|
|
872
|
-
*
|
|
873
|
-
* Triggers a cross-app navigation after saving the inner and the cross-app states. Since 1.52.0 the navigation
|
|
874
|
-
* mode based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state
|
|
875
|
-
* will not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad
|
|
876
|
-
* default navigation for opening a URL in-place or ex-place.
|
|
877
895
|
*/
|
|
878
896
|
static navigate(
|
|
879
897
|
/**
|
|
@@ -938,6 +956,11 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
938
956
|
sNavMode?: string
|
|
939
957
|
): void;
|
|
940
958
|
/**
|
|
959
|
+
* Triggers a cross-app navigation after saving the inner and the cross-app states. Since 1.52.0 the navigation
|
|
960
|
+
* mode based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state
|
|
961
|
+
* will not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad
|
|
962
|
+
* default navigation for opening a URL in-place or ex-place.
|
|
963
|
+
*
|
|
941
964
|
* @deprecated (since 1.83.0) -
|
|
942
965
|
* **Node:** If the `oExternalAppData` parameter is not supplied, the external app data will be calculated
|
|
943
966
|
* based on the `oInnerAppData` data.
|
|
@@ -948,11 +971,6 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
948
971
|
* of the error (info/warning/error) {array} **oError.params**
|
|
949
972
|
* An array of objects (typically strings) that describe additional value parameters required for generating
|
|
950
973
|
* the message
|
|
951
|
-
*
|
|
952
|
-
* Triggers a cross-app navigation after saving the inner and the cross-app states. Since 1.52.0 the navigation
|
|
953
|
-
* mode based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state
|
|
954
|
-
* will not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad
|
|
955
|
-
* default navigation for opening a URL in-place or ex-place.
|
|
956
974
|
*/
|
|
957
975
|
static navigate(
|
|
958
976
|
/**
|
|
@@ -992,6 +1010,11 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
992
1010
|
sNavMode?: string
|
|
993
1011
|
): void;
|
|
994
1012
|
/**
|
|
1013
|
+
* Triggers a cross-app navigation after saving the inner and the cross-app states. Since 1.52.0 the navigation
|
|
1014
|
+
* mode based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state
|
|
1015
|
+
* will not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad
|
|
1016
|
+
* default navigation for opening a URL in-place or ex-place.
|
|
1017
|
+
*
|
|
995
1018
|
* @deprecated (since 1.83.0) -
|
|
996
1019
|
* **Node:** If the `oExternalAppData` parameter is not supplied, the external app data will be calculated
|
|
997
1020
|
* based on the `oInnerAppData` data.
|
|
@@ -1002,11 +1025,6 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
1002
1025
|
* of the error (info/warning/error) {array} **oError.params**
|
|
1003
1026
|
* An array of objects (typically strings) that describe additional value parameters required for generating
|
|
1004
1027
|
* the message
|
|
1005
|
-
*
|
|
1006
|
-
* Triggers a cross-app navigation after saving the inner and the cross-app states. Since 1.52.0 the navigation
|
|
1007
|
-
* mode based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state
|
|
1008
|
-
* will not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad
|
|
1009
|
-
* default navigation for opening a URL in-place or ex-place.
|
|
1010
1028
|
*/
|
|
1011
1029
|
static navigate(
|
|
1012
1030
|
/**
|
|
@@ -1042,13 +1060,13 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
1042
1060
|
sNavMode?: string
|
|
1043
1061
|
): void;
|
|
1044
1062
|
/**
|
|
1045
|
-
* @deprecated (since 1.83.0)
|
|
1046
|
-
*
|
|
1047
1063
|
* Parses the incoming URL and returns a Promise. If this method detects a back navigation, the inner app
|
|
1048
1064
|
* state is returned in the resolved Promise. Otherwise startup parameters will be merged into the app state
|
|
1049
1065
|
* provided by cross app navigation, and a combined app state will be returned. The conflict resolution
|
|
1050
1066
|
* can be influenced with sParamHandlingMode defined in the constructor.
|
|
1051
1067
|
*
|
|
1068
|
+
* @deprecated (since 1.83.0)
|
|
1069
|
+
*
|
|
1052
1070
|
* @returns A Promise object to monitor when all the actions of the function have been executed. If the
|
|
1053
1071
|
* execution is successful, the extracted app state, the startup parameters, and the type of navigation
|
|
1054
1072
|
* are returned, see also the example above. The app state is an object that contains the following information:
|
|
@@ -1079,11 +1097,6 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
1079
1097
|
*/
|
|
1080
1098
|
static parseNavigation(): object;
|
|
1081
1099
|
/**
|
|
1082
|
-
* @deprecated (since 1.83.0) -
|
|
1083
|
-
* **Node:** If the `oExternalAppData` parameter is not supplied, the external app data will be calculated
|
|
1084
|
-
* based on the `mInnerAppData` data.
|
|
1085
|
-
*
|
|
1086
|
-
*
|
|
1087
1100
|
* Processes navigation-related tasks related to beforePopoverOpens event handling for the SmartLink control
|
|
1088
1101
|
* and returns a Promise object. In particular, the following tasks are performed before the SmartLink popover
|
|
1089
1102
|
* can be opened:
|
|
@@ -1098,6 +1111,11 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
1098
1111
|
* - The method `oTableEventParameters.open()` is called. Note that this does not really open the popover,
|
|
1099
1112
|
* but the SmartLink control proceeds with firing the event `navigationTargetsObtained`.
|
|
1100
1113
|
*
|
|
1114
|
+
* @deprecated (since 1.83.0) -
|
|
1115
|
+
* **Node:** If the `oExternalAppData` parameter is not supplied, the external app data will be calculated
|
|
1116
|
+
* based on the `mInnerAppData` data.
|
|
1117
|
+
*
|
|
1118
|
+
*
|
|
1101
1119
|
* @returns A Promise object to monitor when all actions of the function have been executed; if the execution
|
|
1102
1120
|
* is successful, the modified oTableEventParameters is returned; if an error occurs, an error object of
|
|
1103
1121
|
* type {@link sap.ui.generic.app.navigation.service.NavError} is returned
|
|
@@ -1163,9 +1181,9 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
1163
1181
|
}
|
|
1164
1182
|
): object;
|
|
1165
1183
|
/**
|
|
1166
|
-
* @deprecated (since 1.83.0)
|
|
1167
|
-
*
|
|
1168
1184
|
* Changes the URL according to the current sAppStateKey. As an reaction route change event will be triggered.
|
|
1185
|
+
*
|
|
1186
|
+
* @deprecated (since 1.83.0)
|
|
1169
1187
|
*/
|
|
1170
1188
|
static replaceHash(
|
|
1171
1189
|
/**
|
|
@@ -1174,11 +1192,11 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
1174
1192
|
sAppStateKey: string
|
|
1175
1193
|
): void;
|
|
1176
1194
|
/**
|
|
1177
|
-
* @since 1.60.0
|
|
1178
|
-
* @deprecated (since 1.83.0)
|
|
1179
|
-
*
|
|
1180
1195
|
* Sets the model that is used for verification of sensitive information. If the model is not set, the unnamed
|
|
1181
1196
|
* component model is used for the verification of sensitive information.
|
|
1197
|
+
*
|
|
1198
|
+
* @since 1.60.0
|
|
1199
|
+
* @deprecated (since 1.83.0)
|
|
1182
1200
|
*/
|
|
1183
1201
|
static setModel(
|
|
1184
1202
|
/**
|
|
@@ -1187,14 +1205,14 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
1187
1205
|
oModel: ODataModel
|
|
1188
1206
|
): void;
|
|
1189
1207
|
/**
|
|
1190
|
-
* @deprecated (since 1.83.0)
|
|
1191
|
-
*
|
|
1192
1208
|
* Sets the application specific technical parameters. Technical parameters will not be added to the selection
|
|
1193
1209
|
* variant passed to the application. As a default the following values are considered as technical parameters:
|
|
1194
1210
|
*
|
|
1195
1211
|
* - `sap-system`
|
|
1196
1212
|
* - `sap-ushell-defaultedParameterNames`
|
|
1197
1213
|
* - `"hcpApplicationId"`
|
|
1214
|
+
*
|
|
1215
|
+
* @deprecated (since 1.83.0)
|
|
1198
1216
|
*/
|
|
1199
1217
|
static setTechnicalParameters(
|
|
1200
1218
|
/**
|
|
@@ -1204,10 +1222,10 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
1204
1222
|
aTechnicalParameters: any[]
|
|
1205
1223
|
): void;
|
|
1206
1224
|
/**
|
|
1207
|
-
* @deprecated (since 1.83.0)
|
|
1208
|
-
*
|
|
1209
1225
|
* Changes the URL according to the current app state and stores the app state for later retrieval.
|
|
1210
1226
|
*
|
|
1227
|
+
* @deprecated (since 1.83.0)
|
|
1228
|
+
*
|
|
1211
1229
|
* @returns A Promise object to monitor when all the actions of the function have been executed; if the
|
|
1212
1230
|
* execution is successful, the app state key is returned; if an error occurs, an object of type {@link sap.ui.generic.app.navigation.service.NavError }
|
|
1213
1231
|
* is returned
|
|
@@ -1250,10 +1268,10 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
1250
1268
|
bImmediateHashReplace?: boolean
|
|
1251
1269
|
): object;
|
|
1252
1270
|
/**
|
|
1253
|
-
* @deprecated (since 1.83.0)
|
|
1254
|
-
*
|
|
1255
1271
|
* Changes the URL according to the current app state and stores the app state for later retrieval.
|
|
1256
1272
|
*
|
|
1273
|
+
* @deprecated (since 1.83.0)
|
|
1274
|
+
*
|
|
1257
1275
|
* @returns An object containing the appStateId and a promise object to monitor when all the actions of
|
|
1258
1276
|
* the function have been executed; Please note that the appStateKey may be undefined or empty.
|
|
1259
1277
|
*/
|
|
@@ -1304,11 +1322,11 @@ declare module "sap/ui/generic/app/navigation/service/PresentationVariant" {
|
|
|
1304
1322
|
import Metadata from "sap/ui/base/Metadata";
|
|
1305
1323
|
|
|
1306
1324
|
/**
|
|
1307
|
-
* @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.PresentationVariant} instead.
|
|
1308
|
-
*
|
|
1309
1325
|
* Creates a new instance of a PresentationVariant class. If no parameter is passed, an new empty instance
|
|
1310
1326
|
* is created whose ID has been set to `""`. Passing a JSON-serialized string complying to the Selection
|
|
1311
1327
|
* Variant Specification will parse it, and the newly created instance will contain the same information.
|
|
1328
|
+
*
|
|
1329
|
+
* @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.PresentationVariant} instead.
|
|
1312
1330
|
*/
|
|
1313
1331
|
export default class PresentationVariant extends PresentationVariant1 {
|
|
1314
1332
|
constructor(
|
|
@@ -1325,6 +1343,7 @@ declare module "sap/ui/generic/app/navigation/service/PresentationVariant" {
|
|
|
1325
1343
|
*
|
|
1326
1344
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.fe.navigation.PresentationVariant.extend}.
|
|
1327
1345
|
*
|
|
1346
|
+
*
|
|
1328
1347
|
* @returns Created class / constructor function
|
|
1329
1348
|
*/
|
|
1330
1349
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -1343,71 +1362,72 @@ declare module "sap/ui/generic/app/navigation/service/PresentationVariant" {
|
|
|
1343
1362
|
FNMetaImpl?: Function
|
|
1344
1363
|
): Function;
|
|
1345
1364
|
/**
|
|
1346
|
-
* @deprecated (since 1.83.0)
|
|
1347
|
-
*
|
|
1348
1365
|
* Gets the chart visualization property.
|
|
1349
1366
|
*
|
|
1367
|
+
* @deprecated (since 1.83.0)
|
|
1368
|
+
*
|
|
1350
1369
|
* @returns mProperties to be used for the chart visualization.
|
|
1351
1370
|
*/
|
|
1352
1371
|
static getChartVisualization(): Record<string, any>;
|
|
1353
1372
|
/**
|
|
1354
|
-
* @deprecated (since 1.83.0)
|
|
1355
|
-
*
|
|
1356
1373
|
* Gets the current context URL intended for the query.
|
|
1357
1374
|
*
|
|
1375
|
+
* @deprecated (since 1.83.0)
|
|
1376
|
+
*
|
|
1358
1377
|
* @returns The current context URL for the query
|
|
1359
1378
|
*/
|
|
1360
1379
|
static getContextUrl(): string;
|
|
1361
1380
|
/**
|
|
1362
|
-
* @deprecated (since 1.83.0)
|
|
1363
|
-
*
|
|
1364
1381
|
* Returns the identification of the selection variant.
|
|
1365
1382
|
*
|
|
1383
|
+
* @deprecated (since 1.83.0)
|
|
1384
|
+
*
|
|
1366
1385
|
* @returns The identification of the selection variant as made available during construction
|
|
1367
1386
|
*/
|
|
1368
1387
|
static getID(): string;
|
|
1369
1388
|
/**
|
|
1370
1389
|
* Returns a metadata object for class sap.ui.generic.app.navigation.service.PresentationVariant.
|
|
1371
1390
|
*
|
|
1391
|
+
*
|
|
1372
1392
|
* @returns Metadata object describing this class
|
|
1373
1393
|
*/
|
|
1374
1394
|
static getMetadata(): Metadata;
|
|
1375
1395
|
/**
|
|
1376
|
-
* @deprecated (since 1.83.0)
|
|
1377
|
-
*
|
|
1378
1396
|
* Gets the more trivial properties. Basically all properties with the exception of the Visualization.
|
|
1379
1397
|
*
|
|
1398
|
+
* @deprecated (since 1.83.0)
|
|
1399
|
+
*
|
|
1380
1400
|
* @returns The current properties.
|
|
1381
1401
|
*/
|
|
1382
1402
|
static getProperties(): Record<string, any>;
|
|
1383
1403
|
/**
|
|
1384
|
-
* @deprecated (since 1.83.0)
|
|
1385
|
-
*
|
|
1386
1404
|
* Gets the table visualization property.
|
|
1387
1405
|
*
|
|
1406
|
+
* @deprecated (since 1.83.0)
|
|
1407
|
+
*
|
|
1388
1408
|
* @returns mProperties to be used for the table visualization.
|
|
1389
1409
|
*/
|
|
1390
1410
|
static getTableVisualization(): Record<string, any>;
|
|
1391
1411
|
/**
|
|
1392
|
-
* @deprecated (since 1.83.0)
|
|
1393
|
-
*
|
|
1394
1412
|
* Returns the current text / description of this selection variant.
|
|
1395
1413
|
*
|
|
1414
|
+
* @deprecated (since 1.83.0)
|
|
1415
|
+
*
|
|
1396
1416
|
* @returns the current description of this selection variant.
|
|
1397
1417
|
*/
|
|
1398
1418
|
static getText(): string;
|
|
1399
1419
|
/**
|
|
1400
|
-
* @deprecated (since 1.83.0)
|
|
1401
|
-
*
|
|
1402
1420
|
* Returns `true` if the presentation variant does not contain any properties. nor ranges.
|
|
1403
1421
|
*
|
|
1422
|
+
* @deprecated (since 1.83.0)
|
|
1423
|
+
*
|
|
1404
1424
|
* @returns If set to `true` there are no current properties set; `false` otherwise.
|
|
1405
1425
|
*/
|
|
1406
1426
|
static isEmpty(): boolean;
|
|
1407
1427
|
/**
|
|
1408
|
-
* @deprecated (since 1.83.0)
|
|
1409
|
-
*
|
|
1410
1428
|
* Sets the chart visualization property.
|
|
1429
|
+
*
|
|
1430
|
+
* @deprecated (since 1.83.0)
|
|
1411
1431
|
*/
|
|
1412
1432
|
static setChartVisualization(
|
|
1413
1433
|
/**
|
|
@@ -1416,9 +1436,9 @@ declare module "sap/ui/generic/app/navigation/service/PresentationVariant" {
|
|
|
1416
1436
|
mProperties: Record<string, any>
|
|
1417
1437
|
): void;
|
|
1418
1438
|
/**
|
|
1419
|
-
* @deprecated (since 1.83.0)
|
|
1420
|
-
*
|
|
1421
1439
|
* Sets the context URL.
|
|
1440
|
+
*
|
|
1441
|
+
* @deprecated (since 1.83.0)
|
|
1422
1442
|
*/
|
|
1423
1443
|
static setContextUrl(
|
|
1424
1444
|
/**
|
|
@@ -1427,9 +1447,9 @@ declare module "sap/ui/generic/app/navigation/service/PresentationVariant" {
|
|
|
1427
1447
|
sURL: string
|
|
1428
1448
|
): void;
|
|
1429
1449
|
/**
|
|
1430
|
-
* @deprecated (since 1.83.0)
|
|
1431
|
-
*
|
|
1432
1450
|
* Sets the identification of the selection variant.
|
|
1451
|
+
*
|
|
1452
|
+
* @deprecated (since 1.83.0)
|
|
1433
1453
|
*/
|
|
1434
1454
|
static setID(
|
|
1435
1455
|
/**
|
|
@@ -1438,9 +1458,9 @@ declare module "sap/ui/generic/app/navigation/service/PresentationVariant" {
|
|
|
1438
1458
|
sId: string
|
|
1439
1459
|
): void;
|
|
1440
1460
|
/**
|
|
1441
|
-
* @deprecated (since 1.83.0)
|
|
1442
|
-
*
|
|
1443
1461
|
* Sets the more trivial properties. Basically all properties with the exception of the Visualization.
|
|
1462
|
+
*
|
|
1463
|
+
* @deprecated (since 1.83.0)
|
|
1444
1464
|
*/
|
|
1445
1465
|
static setProperties(
|
|
1446
1466
|
/**
|
|
@@ -1449,9 +1469,9 @@ declare module "sap/ui/generic/app/navigation/service/PresentationVariant" {
|
|
|
1449
1469
|
mProperties: Record<string, any>
|
|
1450
1470
|
): void;
|
|
1451
1471
|
/**
|
|
1452
|
-
* @deprecated (since 1.83.0)
|
|
1453
|
-
*
|
|
1454
1472
|
* Sets the table visualization property.
|
|
1473
|
+
*
|
|
1474
|
+
* @deprecated (since 1.83.0)
|
|
1455
1475
|
*/
|
|
1456
1476
|
static setTableVisualization(
|
|
1457
1477
|
/**
|
|
@@ -1460,9 +1480,9 @@ declare module "sap/ui/generic/app/navigation/service/PresentationVariant" {
|
|
|
1460
1480
|
mProperties: Record<string, any>
|
|
1461
1481
|
): void;
|
|
1462
1482
|
/**
|
|
1463
|
-
* @deprecated (since 1.83.0)
|
|
1464
|
-
*
|
|
1465
1483
|
* Sets the text / description of the selection variant.
|
|
1484
|
+
*
|
|
1485
|
+
* @deprecated (since 1.83.0)
|
|
1466
1486
|
*/
|
|
1467
1487
|
static setText(
|
|
1468
1488
|
/**
|
|
@@ -1471,18 +1491,18 @@ declare module "sap/ui/generic/app/navigation/service/PresentationVariant" {
|
|
|
1471
1491
|
sNewText: string
|
|
1472
1492
|
): void;
|
|
1473
1493
|
/**
|
|
1474
|
-
* @deprecated (since 1.83.0)
|
|
1475
|
-
*
|
|
1476
1494
|
* Returns the external representation of the selection variant as JSON object.
|
|
1477
1495
|
*
|
|
1496
|
+
* @deprecated (since 1.83.0)
|
|
1497
|
+
*
|
|
1478
1498
|
* @returns The external representation of this instance as a JSON object
|
|
1479
1499
|
*/
|
|
1480
1500
|
static toJSONObject(): object;
|
|
1481
1501
|
/**
|
|
1482
|
-
* @deprecated (since 1.83.0)
|
|
1483
|
-
*
|
|
1484
1502
|
* Serializes this instance into a JSON-formatted string.
|
|
1485
1503
|
*
|
|
1504
|
+
* @deprecated (since 1.83.0)
|
|
1505
|
+
*
|
|
1486
1506
|
* @returns The JSON-formatted representation of this instance in stringified format
|
|
1487
1507
|
*/
|
|
1488
1508
|
static toJSONString(): string;
|
|
@@ -1495,11 +1515,11 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1495
1515
|
import Metadata from "sap/ui/base/Metadata";
|
|
1496
1516
|
|
|
1497
1517
|
/**
|
|
1498
|
-
* @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.SelectionVariant} instead.
|
|
1499
|
-
*
|
|
1500
1518
|
* Creates a new instance of a SelectionVariant class. If no parameter is passed, an new empty instance
|
|
1501
1519
|
* is created whose ID has been set to `""`. Passing a JSON-serialized string complying to the Selection
|
|
1502
1520
|
* Variant Specification will parse it, and the newly created instance will contain the same information.
|
|
1521
|
+
*
|
|
1522
|
+
* @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.SelectionVariant} instead.
|
|
1503
1523
|
*/
|
|
1504
1524
|
export default class SelectionVariant extends SelectionVariant1 {
|
|
1505
1525
|
constructor(
|
|
@@ -1511,11 +1531,11 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1511
1531
|
);
|
|
1512
1532
|
|
|
1513
1533
|
/**
|
|
1514
|
-
* @deprecated (since 1.83.0)
|
|
1515
|
-
*
|
|
1516
1534
|
* Sets the value of a parameter called `sName` to the new value `sValue`. If the parameter has already
|
|
1517
1535
|
* been set before, its value is overwritten.
|
|
1518
1536
|
*
|
|
1537
|
+
* @deprecated (since 1.83.0)
|
|
1538
|
+
*
|
|
1519
1539
|
* @returns This instance to allow method chaining
|
|
1520
1540
|
*/
|
|
1521
1541
|
static addParameter(
|
|
@@ -1529,10 +1549,10 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1529
1549
|
sValue: string
|
|
1530
1550
|
): object;
|
|
1531
1551
|
/**
|
|
1532
|
-
* @deprecated (since 1.83.0)
|
|
1533
|
-
*
|
|
1534
1552
|
* Adds a new range to the list of select options for a given parameter.
|
|
1535
1553
|
*
|
|
1554
|
+
* @deprecated (since 1.83.0)
|
|
1555
|
+
*
|
|
1536
1556
|
* @returns This instance to allow method chaining.
|
|
1537
1557
|
*/
|
|
1538
1558
|
static addSelectOption(
|
|
@@ -1567,6 +1587,7 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1567
1587
|
*
|
|
1568
1588
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.fe.navigation.SelectionVariant.extend}.
|
|
1569
1589
|
*
|
|
1590
|
+
*
|
|
1570
1591
|
* @returns Created class / constructor function
|
|
1571
1592
|
*/
|
|
1572
1593
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -1585,33 +1606,34 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1585
1606
|
FNMetaImpl?: Function
|
|
1586
1607
|
): Function;
|
|
1587
1608
|
/**
|
|
1588
|
-
* @deprecated (since 1.83.0)
|
|
1589
|
-
*
|
|
1590
1609
|
* Gets the current context URL intended for the filters.
|
|
1591
1610
|
*
|
|
1611
|
+
* @deprecated (since 1.83.0)
|
|
1612
|
+
*
|
|
1592
1613
|
* @returns The current context URL for the filters
|
|
1593
1614
|
*/
|
|
1594
1615
|
static getFilterContextUrl(): string;
|
|
1595
1616
|
/**
|
|
1596
|
-
* @deprecated (since 1.83.0)
|
|
1597
|
-
*
|
|
1598
1617
|
* Returns the identification of the selection variant.
|
|
1599
1618
|
*
|
|
1619
|
+
* @deprecated (since 1.83.0)
|
|
1620
|
+
*
|
|
1600
1621
|
* @returns The identification of the selection variant as made available during construction
|
|
1601
1622
|
*/
|
|
1602
1623
|
static getID(): string;
|
|
1603
1624
|
/**
|
|
1604
1625
|
* Returns a metadata object for class sap.ui.generic.app.navigation.service.SelectionVariant.
|
|
1605
1626
|
*
|
|
1627
|
+
*
|
|
1606
1628
|
* @returns Metadata object describing this class
|
|
1607
1629
|
*/
|
|
1608
1630
|
static getMetadata(): Metadata;
|
|
1609
1631
|
/**
|
|
1610
|
-
* @deprecated (since 1.83.0)
|
|
1611
|
-
*
|
|
1612
1632
|
* Returns the value of the parameter called `sName` if it has been set. If the parameter has never been
|
|
1613
1633
|
* set or has been removed, `undefined` is returned.
|
|
1614
1634
|
*
|
|
1635
|
+
* @deprecated (since 1.83.0)
|
|
1636
|
+
*
|
|
1615
1637
|
* @returns The value of parameter `sName`; returning the value `null` not possible
|
|
1616
1638
|
*/
|
|
1617
1639
|
static getParameter(
|
|
@@ -1621,34 +1643,34 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1621
1643
|
sName: string
|
|
1622
1644
|
): string;
|
|
1623
1645
|
/**
|
|
1624
|
-
* @deprecated (since 1.83.0)
|
|
1625
|
-
*
|
|
1626
1646
|
* Gets the current context URL intended for the parameters.
|
|
1627
1647
|
*
|
|
1648
|
+
* @deprecated (since 1.83.0)
|
|
1649
|
+
*
|
|
1628
1650
|
* @returns The current context URL for the parameters
|
|
1629
1651
|
*/
|
|
1630
1652
|
static getParameterContextUrl(): string;
|
|
1631
1653
|
/**
|
|
1632
|
-
* @deprecated (since 1.83.0)
|
|
1633
|
-
*
|
|
1634
1654
|
* Returns the set of parameter names available in this selection variant
|
|
1635
1655
|
*
|
|
1656
|
+
* @deprecated (since 1.83.0)
|
|
1657
|
+
*
|
|
1636
1658
|
* @returns the list of parameter names which are valid
|
|
1637
1659
|
*/
|
|
1638
1660
|
static getParameterNames(): any[];
|
|
1639
1661
|
/**
|
|
1640
|
-
* @deprecated (since 1.83.0)
|
|
1641
|
-
*
|
|
1642
1662
|
* Returns the names of the parameter and select option properties available for this instance.
|
|
1643
1663
|
*
|
|
1664
|
+
* @deprecated (since 1.83.0)
|
|
1665
|
+
*
|
|
1644
1666
|
* @returns The list of parameter and select option property names available for this instance
|
|
1645
1667
|
*/
|
|
1646
1668
|
static getPropertyNames(): any[];
|
|
1647
1669
|
/**
|
|
1648
|
-
* @deprecated (since 1.83.0)
|
|
1649
|
-
*
|
|
1650
1670
|
* Returns the set of select options/ranges available for a given property name.
|
|
1651
1671
|
*
|
|
1672
|
+
* @deprecated (since 1.83.0)
|
|
1673
|
+
*
|
|
1652
1674
|
* @returns If `sPropertyName` is an invalid name of a property or no range exists, `undefined` is returned;
|
|
1653
1675
|
* otherwise, an immutable array of ranges is returned. Each entry of the array is an object with the following
|
|
1654
1676
|
* properties:
|
|
@@ -1665,30 +1687,30 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1665
1687
|
sPropertyName: string
|
|
1666
1688
|
): any[];
|
|
1667
1689
|
/**
|
|
1668
|
-
* @deprecated (since 1.83.0)
|
|
1669
|
-
*
|
|
1670
1690
|
* Returns the names of the properties available for this instance.
|
|
1671
1691
|
*
|
|
1692
|
+
* @deprecated (since 1.83.0)
|
|
1693
|
+
*
|
|
1672
1694
|
* @returns The list of property names available for this instance
|
|
1673
1695
|
*/
|
|
1674
1696
|
static getSelectOptionsPropertyNames(): any[];
|
|
1675
1697
|
/**
|
|
1676
|
-
* @deprecated (since 1.83.0)
|
|
1677
|
-
*
|
|
1678
1698
|
* Returns the current text / description of this selection variant.
|
|
1679
1699
|
*
|
|
1700
|
+
* @deprecated (since 1.83.0)
|
|
1701
|
+
*
|
|
1680
1702
|
* @returns the current description of this selection variant.
|
|
1681
1703
|
*/
|
|
1682
1704
|
static getText(): string;
|
|
1683
1705
|
/**
|
|
1684
|
-
* @deprecated (since 1.83.0)
|
|
1685
|
-
*
|
|
1686
1706
|
* First tries to retrieve the set of select options/ranges available for `sName` as property name. If successful,
|
|
1687
1707
|
* this array of selections is being returned. If it fails, an attempt to find a parameter, whose name is
|
|
1688
1708
|
* `sName`, is made. If the latter succeeds, the single value is converted to fit into an array of selections
|
|
1689
1709
|
* to make it type compatible with ranges. This array is then returned. If neither a select option
|
|
1690
1710
|
* nor a parameter could be found, `undefined` is returned.
|
|
1691
1711
|
*
|
|
1712
|
+
* @deprecated (since 1.83.0)
|
|
1713
|
+
*
|
|
1692
1714
|
* @returns The ranges in the select options for the specified property or a range-converted representation
|
|
1693
1715
|
* of a parameter is returned. If both lookups fail, `undefined` is returned. The returned ranges
|
|
1694
1716
|
* have the format:
|
|
@@ -1705,19 +1727,19 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1705
1727
|
sName: string
|
|
1706
1728
|
): any[];
|
|
1707
1729
|
/**
|
|
1708
|
-
* @deprecated (since 1.83.0)
|
|
1709
|
-
*
|
|
1710
1730
|
* Returns `true` if the selection variant does neither contain parameters nor ranges.
|
|
1711
1731
|
*
|
|
1732
|
+
* @deprecated (since 1.83.0)
|
|
1733
|
+
*
|
|
1712
1734
|
* @returns If set to `true` there are no parameters and no select options available in the selection variant;
|
|
1713
1735
|
* `false` otherwise.
|
|
1714
1736
|
*/
|
|
1715
1737
|
static isEmpty(): boolean;
|
|
1716
1738
|
/**
|
|
1717
|
-
* @deprecated (since 1.83.0)
|
|
1718
|
-
*
|
|
1719
1739
|
* Adds a set of select options to the list of select options for a given parameter.
|
|
1720
1740
|
*
|
|
1741
|
+
* @deprecated (since 1.83.0)
|
|
1742
|
+
*
|
|
1721
1743
|
* @returns This instance to allow method chaining
|
|
1722
1744
|
*/
|
|
1723
1745
|
static massAddSelectOption(
|
|
@@ -1731,10 +1753,10 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1731
1753
|
aSelectOptions: any[]
|
|
1732
1754
|
): object;
|
|
1733
1755
|
/**
|
|
1734
|
-
* @deprecated (since 1.83.0)
|
|
1735
|
-
*
|
|
1736
1756
|
* Removes a parameter called `sName` from the selection variant.
|
|
1737
1757
|
*
|
|
1758
|
+
* @deprecated (since 1.83.0)
|
|
1759
|
+
*
|
|
1738
1760
|
* @returns This instance to allow method chaining
|
|
1739
1761
|
*/
|
|
1740
1762
|
static removeParameter(
|
|
@@ -1744,10 +1766,10 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1744
1766
|
sName: string
|
|
1745
1767
|
): object;
|
|
1746
1768
|
/**
|
|
1747
|
-
* @deprecated (since 1.83.0)
|
|
1748
|
-
*
|
|
1749
1769
|
* Removes a select option called `sName` from the selection variant.
|
|
1750
1770
|
*
|
|
1771
|
+
* @deprecated (since 1.83.0)
|
|
1772
|
+
*
|
|
1751
1773
|
* @returns This instance to allow method chaining.
|
|
1752
1774
|
*/
|
|
1753
1775
|
static removeSelectOption(
|
|
@@ -1757,12 +1779,12 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1757
1779
|
sName: string
|
|
1758
1780
|
): object;
|
|
1759
1781
|
/**
|
|
1760
|
-
* @deprecated (since 1.83.0)
|
|
1761
|
-
*
|
|
1762
1782
|
* Renames a parameter called `sNameOld` to `sNameNew`. If a parameter or a select option with the name
|
|
1763
1783
|
* `sNameNew` already exist, an error is thrown. If a parameter with the name `sNameOld` does not exist,
|
|
1764
1784
|
* nothing is changed.
|
|
1765
1785
|
*
|
|
1786
|
+
* @deprecated (since 1.83.0)
|
|
1787
|
+
*
|
|
1766
1788
|
* @returns This instance to allow method chaining
|
|
1767
1789
|
*/
|
|
1768
1790
|
static renameParameter(
|
|
@@ -1776,12 +1798,12 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1776
1798
|
sNameNew: string
|
|
1777
1799
|
): object;
|
|
1778
1800
|
/**
|
|
1779
|
-
* @deprecated (since 1.83.0)
|
|
1780
|
-
*
|
|
1781
1801
|
* Renames a select option called `sNameOld` to `sNameNew`. If a select option or a parameter with the name
|
|
1782
1802
|
* `sNameNew` already exist, an error is thrown. If a select option with the name `sNameOld` does not exist,
|
|
1783
1803
|
* nothing is changed.
|
|
1784
1804
|
*
|
|
1805
|
+
* @deprecated (since 1.83.0)
|
|
1806
|
+
*
|
|
1785
1807
|
* @returns This instance to allow method chaining
|
|
1786
1808
|
*/
|
|
1787
1809
|
static renameSelectOption(
|
|
@@ -1795,9 +1817,9 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1795
1817
|
sNameNew: string
|
|
1796
1818
|
): object;
|
|
1797
1819
|
/**
|
|
1798
|
-
* @deprecated (since 1.83.0)
|
|
1799
|
-
*
|
|
1800
1820
|
* Sets the context URL intended for the filters.
|
|
1821
|
+
*
|
|
1822
|
+
* @deprecated (since 1.83.0)
|
|
1801
1823
|
*/
|
|
1802
1824
|
static setFilterContextUrl(
|
|
1803
1825
|
/**
|
|
@@ -1806,9 +1828,9 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1806
1828
|
sURL: string
|
|
1807
1829
|
): void;
|
|
1808
1830
|
/**
|
|
1809
|
-
* @deprecated (since 1.83.0)
|
|
1810
|
-
*
|
|
1811
1831
|
* Sets the identification of the selection variant.
|
|
1832
|
+
*
|
|
1833
|
+
* @deprecated (since 1.83.0)
|
|
1812
1834
|
*/
|
|
1813
1835
|
static setID(
|
|
1814
1836
|
/**
|
|
@@ -1817,9 +1839,9 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1817
1839
|
sId: string
|
|
1818
1840
|
): void;
|
|
1819
1841
|
/**
|
|
1820
|
-
* @deprecated (since 1.83.0)
|
|
1821
|
-
*
|
|
1822
1842
|
* Sets the context URL intended for the parameters.
|
|
1843
|
+
*
|
|
1844
|
+
* @deprecated (since 1.83.0)
|
|
1823
1845
|
*/
|
|
1824
1846
|
static setParameterContextUrl(
|
|
1825
1847
|
/**
|
|
@@ -1828,9 +1850,9 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1828
1850
|
sURL: string
|
|
1829
1851
|
): void;
|
|
1830
1852
|
/**
|
|
1831
|
-
* @deprecated (since 1.83.0)
|
|
1832
|
-
*
|
|
1833
1853
|
* Sets the text / description of the selection variant.
|
|
1854
|
+
*
|
|
1855
|
+
* @deprecated (since 1.83.0)
|
|
1834
1856
|
*/
|
|
1835
1857
|
static setText(
|
|
1836
1858
|
/**
|
|
@@ -1839,18 +1861,18 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1839
1861
|
sNewText: string
|
|
1840
1862
|
): void;
|
|
1841
1863
|
/**
|
|
1842
|
-
* @deprecated (since 1.83.0)
|
|
1843
|
-
*
|
|
1844
1864
|
* Returns the external representation of the selection variant as JSON object.
|
|
1845
1865
|
*
|
|
1866
|
+
* @deprecated (since 1.83.0)
|
|
1867
|
+
*
|
|
1846
1868
|
* @returns The external representation of this instance as a JSON object
|
|
1847
1869
|
*/
|
|
1848
1870
|
static toJSONObject(): object;
|
|
1849
1871
|
/**
|
|
1850
|
-
* @deprecated (since 1.83.0)
|
|
1851
|
-
*
|
|
1852
1872
|
* Serializes this instance into a JSON-formatted string
|
|
1853
1873
|
*
|
|
1874
|
+
* @deprecated (since 1.83.0)
|
|
1875
|
+
*
|
|
1854
1876
|
* @returns The JSON-formatted representation of this instance in stringified format
|
|
1855
1877
|
*/
|
|
1856
1878
|
static toJSONString(): string;
|
|
@@ -1865,11 +1887,11 @@ declare module "sap/ui/generic/app/transaction/BaseController" {
|
|
|
1865
1887
|
import Metadata from "sap/ui/base/Metadata";
|
|
1866
1888
|
|
|
1867
1889
|
/**
|
|
1868
|
-
* @since 1.30.0
|
|
1869
|
-
*
|
|
1870
1890
|
* Common base class for `sap.ui.generic.app.transaction.TransactionController` and `sap.ui.generic.app.transaction.DraftController`,
|
|
1871
1891
|
* which offers basic functionality to invoke OData functions and actions as well as OData CRUD functions
|
|
1872
1892
|
* in general.
|
|
1893
|
+
*
|
|
1894
|
+
* @since 1.30.0
|
|
1873
1895
|
*/
|
|
1874
1896
|
export default class BaseController extends EventProvider {
|
|
1875
1897
|
/**
|
|
@@ -1896,6 +1918,7 @@ declare module "sap/ui/generic/app/transaction/BaseController" {
|
|
|
1896
1918
|
*
|
|
1897
1919
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.EventProvider.extend}.
|
|
1898
1920
|
*
|
|
1921
|
+
*
|
|
1899
1922
|
* @returns Created class / constructor function
|
|
1900
1923
|
*/
|
|
1901
1924
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -1916,6 +1939,7 @@ declare module "sap/ui/generic/app/transaction/BaseController" {
|
|
|
1916
1939
|
/**
|
|
1917
1940
|
* Returns a metadata object for class sap.ui.generic.app.transaction.BaseController.
|
|
1918
1941
|
*
|
|
1942
|
+
*
|
|
1919
1943
|
* @returns Metadata object describing this class
|
|
1920
1944
|
*/
|
|
1921
1945
|
static getMetadata(): Metadata;
|
|
@@ -1952,12 +1976,14 @@ declare module "sap/ui/generic/app/transaction/BaseController" {
|
|
|
1952
1976
|
/**
|
|
1953
1977
|
* Checks for client messages.
|
|
1954
1978
|
*
|
|
1979
|
+
*
|
|
1955
1980
|
* @returns If client-side messages exist a rejected promise is returned, `null` otherwise
|
|
1956
1981
|
*/
|
|
1957
1982
|
hasClientMessages(): Promise<any>;
|
|
1958
1983
|
/**
|
|
1959
1984
|
* Triggers submitting the currently tracked changes to the back-end.
|
|
1960
1985
|
*
|
|
1986
|
+
*
|
|
1961
1987
|
* @returns A `Promise` for asynchronous execution of the submit
|
|
1962
1988
|
*/
|
|
1963
1989
|
triggerSubmitChanges(
|
|
@@ -2000,10 +2026,10 @@ declare module "sap/ui/generic/app/transaction/DraftContext" {
|
|
|
2000
2026
|
import Context from "sap/ui/model/Context";
|
|
2001
2027
|
|
|
2002
2028
|
/**
|
|
2003
|
-
* @since 1.30.0
|
|
2004
|
-
*
|
|
2005
2029
|
* The class provides access to information on draft handling that is available in the OData service's metadata
|
|
2006
2030
|
* as it interprets draft-specific annotations.
|
|
2031
|
+
*
|
|
2032
|
+
* @since 1.30.0
|
|
2007
2033
|
*/
|
|
2008
2034
|
export default class DraftContext extends BaseObject {
|
|
2009
2035
|
/**
|
|
@@ -2022,6 +2048,7 @@ declare module "sap/ui/generic/app/transaction/DraftContext" {
|
|
|
2022
2048
|
*
|
|
2023
2049
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
|
|
2024
2050
|
*
|
|
2051
|
+
*
|
|
2025
2052
|
* @returns Created class / constructor function
|
|
2026
2053
|
*/
|
|
2027
2054
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -2042,15 +2069,16 @@ declare module "sap/ui/generic/app/transaction/DraftContext" {
|
|
|
2042
2069
|
/**
|
|
2043
2070
|
* Returns a metadata object for class sap.ui.generic.app.transaction.DraftContext.
|
|
2044
2071
|
*
|
|
2072
|
+
*
|
|
2045
2073
|
* @returns Metadata object describing this class
|
|
2046
2074
|
*/
|
|
2047
2075
|
static getMetadata(): Metadata;
|
|
2048
2076
|
/**
|
|
2049
|
-
* @deprecated (since 1.32.0)
|
|
2050
|
-
*
|
|
2051
2077
|
* Checks whether an OData property is annotated with UpdateOnChange. The method is used in context of a
|
|
2052
2078
|
* validation success event.
|
|
2053
2079
|
*
|
|
2080
|
+
* @deprecated (since 1.32.0)
|
|
2081
|
+
*
|
|
2054
2082
|
* @returns `true`, if the property is annotated with UpdateOnChange, `false` otherwise
|
|
2055
2083
|
*/
|
|
2056
2084
|
checkUpdateOnChange(
|
|
@@ -2070,6 +2098,7 @@ declare module "sap/ui/generic/app/transaction/DraftContext" {
|
|
|
2070
2098
|
/**
|
|
2071
2099
|
* Returns the name of the function import to be used.
|
|
2072
2100
|
*
|
|
2101
|
+
*
|
|
2073
2102
|
* @returns The name of the function import to be used
|
|
2074
2103
|
*/
|
|
2075
2104
|
getODataDraftFunctionImportName(
|
|
@@ -2085,6 +2114,7 @@ declare module "sap/ui/generic/app/transaction/DraftContext" {
|
|
|
2085
2114
|
/**
|
|
2086
2115
|
* Returns the semantic keys for a given entity set.
|
|
2087
2116
|
*
|
|
2117
|
+
*
|
|
2088
2118
|
* @returns The semantic keys
|
|
2089
2119
|
*/
|
|
2090
2120
|
getSemanticKey(
|
|
@@ -2097,6 +2127,7 @@ declare module "sap/ui/generic/app/transaction/DraftContext" {
|
|
|
2097
2127
|
* Checks whether an entity set is draft-enabled. The entity set name is derived from the given binding
|
|
2098
2128
|
* context
|
|
2099
2129
|
*
|
|
2130
|
+
*
|
|
2100
2131
|
* @returns `true`, if a given entity set is draft-enabled, `false` otherwise
|
|
2101
2132
|
*/
|
|
2102
2133
|
hasDraft(
|
|
@@ -2108,6 +2139,7 @@ declare module "sap/ui/generic/app/transaction/DraftContext" {
|
|
|
2108
2139
|
/**
|
|
2109
2140
|
* Checks whether administrative data for a given draft is available.
|
|
2110
2141
|
*
|
|
2142
|
+
*
|
|
2111
2143
|
* @returns `true`, if administrative data is available, `false` otherwise
|
|
2112
2144
|
*/
|
|
2113
2145
|
hasDraftAdministrativeData(
|
|
@@ -2120,6 +2152,7 @@ declare module "sap/ui/generic/app/transaction/DraftContext" {
|
|
|
2120
2152
|
* Checks whether an entity set has a draft preparation action. The entity set name is derived from the
|
|
2121
2153
|
* given binding context.
|
|
2122
2154
|
*
|
|
2155
|
+
*
|
|
2123
2156
|
* @returns `true`, if a given entity set has a draft preparation action, `false` otherwise
|
|
2124
2157
|
*/
|
|
2125
2158
|
hasDraftPreparationAction(
|
|
@@ -2131,6 +2164,7 @@ declare module "sap/ui/generic/app/transaction/DraftContext" {
|
|
|
2131
2164
|
/**
|
|
2132
2165
|
* Checks whether an entity set is draft root. The entity set name is derived from the given binding context.
|
|
2133
2166
|
*
|
|
2167
|
+
*
|
|
2134
2168
|
* @returns `true`, if a given entity set is draft root, `false` otherwise
|
|
2135
2169
|
*/
|
|
2136
2170
|
hasDraftRoot(
|
|
@@ -2143,6 +2177,7 @@ declare module "sap/ui/generic/app/transaction/DraftContext" {
|
|
|
2143
2177
|
* Checks whether an entity set has a draft validation function. The entity set name is derived from the
|
|
2144
2178
|
* given binding context.
|
|
2145
2179
|
*
|
|
2180
|
+
*
|
|
2146
2181
|
* @returns `true`, if a given entity set has a draft validation function, `false` otherwise
|
|
2147
2182
|
*/
|
|
2148
2183
|
hasDraftValidationFunction(
|
|
@@ -2152,18 +2187,19 @@ declare module "sap/ui/generic/app/transaction/DraftContext" {
|
|
|
2152
2187
|
oContext: Context
|
|
2153
2188
|
): boolean;
|
|
2154
2189
|
/**
|
|
2155
|
-
* @since 1.38
|
|
2156
|
-
*
|
|
2157
2190
|
* Checks if the parameter "PreserveChanges" is supported by the edit function. If the edit action is triggered
|
|
2158
2191
|
* with the parameter set to `true` the ABAP application infrastructure will respond with HTTP response
|
|
2159
2192
|
* code 409 if unsaved changes (from another user) exist.
|
|
2160
2193
|
*
|
|
2194
|
+
* @since 1.38
|
|
2195
|
+
*
|
|
2161
2196
|
* @returns `true`, if "PreserveChanges" is supported
|
|
2162
2197
|
*/
|
|
2163
2198
|
hasPreserveChanges(): boolean;
|
|
2164
2199
|
/**
|
|
2165
2200
|
* Checks whether a sibling entity for a given entity set is available.
|
|
2166
2201
|
*
|
|
2202
|
+
*
|
|
2167
2203
|
* @returns `true`, if sibling entity is available, `false` otherwise
|
|
2168
2204
|
*/
|
|
2169
2205
|
hasSiblingEntity(
|
|
@@ -2175,6 +2211,7 @@ declare module "sap/ui/generic/app/transaction/DraftContext" {
|
|
|
2175
2211
|
/**
|
|
2176
2212
|
* Checks whether a given entity set is draft-enabled.
|
|
2177
2213
|
*
|
|
2214
|
+
*
|
|
2178
2215
|
* @returns `true`, if a given entity set is draft-enabled, `false` otherwise
|
|
2179
2216
|
*/
|
|
2180
2217
|
isDraftEnabled(
|
|
@@ -2186,6 +2223,7 @@ declare module "sap/ui/generic/app/transaction/DraftContext" {
|
|
|
2186
2223
|
/**
|
|
2187
2224
|
* Checks whether a given entity set is a draft root.
|
|
2188
2225
|
*
|
|
2226
|
+
*
|
|
2189
2227
|
* @returns `true`, if a given entity set is draft root, `false` otherwise
|
|
2190
2228
|
*/
|
|
2191
2229
|
isDraftRoot(
|
|
@@ -2197,6 +2235,7 @@ declare module "sap/ui/generic/app/transaction/DraftContext" {
|
|
|
2197
2235
|
/**
|
|
2198
2236
|
* Checks whether a given key is a semantic key.
|
|
2199
2237
|
*
|
|
2238
|
+
*
|
|
2200
2239
|
* @returns `true`, if a given key is a semantic key, `false` otherwise
|
|
2201
2240
|
*/
|
|
2202
2241
|
isSemanticKey(
|
|
@@ -2212,6 +2251,7 @@ declare module "sap/ui/generic/app/transaction/DraftContext" {
|
|
|
2212
2251
|
/**
|
|
2213
2252
|
* Checks whether a given key is a technical key.
|
|
2214
2253
|
*
|
|
2254
|
+
*
|
|
2215
2255
|
* @returns `true`, if a given key is a technical key, `false` otherwise
|
|
2216
2256
|
*/
|
|
2217
2257
|
isTechnicalKey(
|
|
@@ -2239,8 +2279,6 @@ declare module "sap/ui/generic/app/transaction/DraftController" {
|
|
|
2239
2279
|
import Metadata from "sap/ui/base/Metadata";
|
|
2240
2280
|
|
|
2241
2281
|
/**
|
|
2242
|
-
* @since 1.30.0
|
|
2243
|
-
*
|
|
2244
2282
|
* Gives access to runtime draft handling for applications. Assuming state-less communication, each single
|
|
2245
2283
|
* data modification request (or change set in an OData $batch request) is a "mini-transaction", which saves
|
|
2246
2284
|
* data to the database. The class implements the transactional interaction patterns specified for OData
|
|
@@ -2252,6 +2290,8 @@ declare module "sap/ui/generic/app/transaction/DraftController" {
|
|
|
2252
2290
|
* to the draft specification. These can be combined as required by client applications. Additionally, error
|
|
2253
2291
|
* handling is provided to notify client implementations of error situations. The event `fatalError` is
|
|
2254
2292
|
* thrown, if fatal errors occur during execution of OData requests.
|
|
2293
|
+
*
|
|
2294
|
+
* @since 1.30.0
|
|
2255
2295
|
*/
|
|
2256
2296
|
export default class DraftController extends BaseController {
|
|
2257
2297
|
/**
|
|
@@ -2278,6 +2318,7 @@ declare module "sap/ui/generic/app/transaction/DraftController" {
|
|
|
2278
2318
|
*
|
|
2279
2319
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.generic.app.transaction.BaseController.extend}.
|
|
2280
2320
|
*
|
|
2321
|
+
*
|
|
2281
2322
|
* @returns Created class / constructor function
|
|
2282
2323
|
*/
|
|
2283
2324
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -2298,12 +2339,14 @@ declare module "sap/ui/generic/app/transaction/DraftController" {
|
|
|
2298
2339
|
/**
|
|
2299
2340
|
* Returns a metadata object for class sap.ui.generic.app.transaction.DraftController.
|
|
2300
2341
|
*
|
|
2342
|
+
*
|
|
2301
2343
|
* @returns Metadata object describing this class
|
|
2302
2344
|
*/
|
|
2303
2345
|
static getMetadata(): Metadata;
|
|
2304
2346
|
/**
|
|
2305
2347
|
* Submits changes to the back-end and activates a draft entity in the back-end.
|
|
2306
2348
|
*
|
|
2349
|
+
*
|
|
2307
2350
|
* @returns A `Promise` for asynchronous execution
|
|
2308
2351
|
*/
|
|
2309
2352
|
activateDraftEntity(
|
|
@@ -2324,6 +2367,7 @@ declare module "sap/ui/generic/app/transaction/DraftController" {
|
|
|
2324
2367
|
/**
|
|
2325
2368
|
* Submits changes to the back-end and activates a draft entity in the back-end.
|
|
2326
2369
|
*
|
|
2370
|
+
*
|
|
2327
2371
|
* @returns A `Promise` for asynchronous execution
|
|
2328
2372
|
*/
|
|
2329
2373
|
activateDraftEntity(
|
|
@@ -2341,6 +2385,7 @@ declare module "sap/ui/generic/app/transaction/DraftController" {
|
|
|
2341
2385
|
* Creates an edit draft in the back-end. Additionally, possible changes that have been collected on the
|
|
2342
2386
|
* client are sent to the back-end.
|
|
2343
2387
|
*
|
|
2388
|
+
*
|
|
2344
2389
|
* @returns A `Promise` for asynchronous execution
|
|
2345
2390
|
*/
|
|
2346
2391
|
createEditDraftEntity(
|
|
@@ -2361,6 +2406,7 @@ declare module "sap/ui/generic/app/transaction/DraftController" {
|
|
|
2361
2406
|
* Creates a new edit draft on the client and sends it to the back-end. Additionally, possible changes that
|
|
2362
2407
|
* have been collected on the client are sent to the back-end.
|
|
2363
2408
|
*
|
|
2409
|
+
*
|
|
2364
2410
|
* @returns A `Promise` for asynchronous execution of the request
|
|
2365
2411
|
*/
|
|
2366
2412
|
createNewDraftEntity(
|
|
@@ -2413,15 +2459,16 @@ declare module "sap/ui/generic/app/transaction/DraftController" {
|
|
|
2413
2459
|
/**
|
|
2414
2460
|
* Returns the current draft context instance. If no instance exists, it is created lazily.
|
|
2415
2461
|
*
|
|
2462
|
+
*
|
|
2416
2463
|
* @returns The current draft context instance
|
|
2417
2464
|
*/
|
|
2418
2465
|
getDraftContext(): DraftContext;
|
|
2419
2466
|
/**
|
|
2420
|
-
* @since 1.32.0
|
|
2421
|
-
*
|
|
2422
2467
|
* Retrieves a possibly existing draft entity for the given active entity using the binding context of the
|
|
2423
2468
|
* active entity from the back-end.
|
|
2424
2469
|
*
|
|
2470
|
+
* @since 1.32.0
|
|
2471
|
+
*
|
|
2425
2472
|
* @returns A `Promise` for asynchronous execution
|
|
2426
2473
|
*/
|
|
2427
2474
|
getDraftForActiveEntity(
|
|
@@ -2431,10 +2478,10 @@ declare module "sap/ui/generic/app/transaction/DraftController" {
|
|
|
2431
2478
|
oContext: Context
|
|
2432
2479
|
): Promise<any>;
|
|
2433
2480
|
/**
|
|
2434
|
-
* @since 1.32.0
|
|
2435
|
-
*
|
|
2436
2481
|
* Checks whether an entity has an active entity associated.
|
|
2437
2482
|
*
|
|
2483
|
+
* @since 1.32.0
|
|
2484
|
+
*
|
|
2438
2485
|
* @returns `true`, if an active entity exists, `false` otherwise
|
|
2439
2486
|
*/
|
|
2440
2487
|
hasActiveEntity(
|
|
@@ -2446,6 +2493,7 @@ declare module "sap/ui/generic/app/transaction/DraftController" {
|
|
|
2446
2493
|
/**
|
|
2447
2494
|
* Checks whether an entity set is active. The entity set name is derived from the given binding context
|
|
2448
2495
|
*
|
|
2496
|
+
*
|
|
2449
2497
|
* @returns `true`, if a given entity set is active, `false` otherwise
|
|
2450
2498
|
*/
|
|
2451
2499
|
isActiveEntity(
|
|
@@ -2458,6 +2506,7 @@ declare module "sap/ui/generic/app/transaction/DraftController" {
|
|
|
2458
2506
|
* Submits changes to the back-end and prepares an existing draft entity in the back-end for later activation
|
|
2459
2507
|
* by invoking the preparation action.
|
|
2460
2508
|
*
|
|
2509
|
+
*
|
|
2461
2510
|
* @returns A `Promise` for asynchronous execution
|
|
2462
2511
|
*/
|
|
2463
2512
|
prepareDraftEntity(
|
|
@@ -2470,6 +2519,7 @@ declare module "sap/ui/generic/app/transaction/DraftController" {
|
|
|
2470
2519
|
* Submits changes to the back-end and prepares a draft entity in the back-end for later activation by invoking
|
|
2471
2520
|
* the preparation action.
|
|
2472
2521
|
*
|
|
2522
|
+
*
|
|
2473
2523
|
* @returns A `Promise` for asynchronous execution
|
|
2474
2524
|
*/
|
|
2475
2525
|
saveAndPrepareDraftEntity(
|
|
@@ -2486,6 +2536,7 @@ declare module "sap/ui/generic/app/transaction/DraftController" {
|
|
|
2486
2536
|
* Submits changes to the back-end and prepares an existing draft entity in the back-end for later activation
|
|
2487
2537
|
* by invoking the validation action.
|
|
2488
2538
|
*
|
|
2539
|
+
*
|
|
2489
2540
|
* @returns A `Promise` for asynchronous execution
|
|
2490
2541
|
*/
|
|
2491
2542
|
validateDraftEntity(
|
|
@@ -2509,8 +2560,6 @@ declare module "sap/ui/generic/app/transaction/TransactionController" {
|
|
|
2509
2560
|
import Metadata from "sap/ui/base/Metadata";
|
|
2510
2561
|
|
|
2511
2562
|
/**
|
|
2512
|
-
* @since 1.30.0
|
|
2513
|
-
*
|
|
2514
2563
|
* Assuming state-less communication, each single data modification request (or change set in an OData $batch
|
|
2515
2564
|
* request) is a "mini-transaction", which saves data to the database. The class allows you to submit changes,
|
|
2516
2565
|
* invoke actions, OData CRUD operations in general, and trigger client-side validations. It ensures concurrency
|
|
@@ -2519,6 +2568,8 @@ declare module "sap/ui/generic/app/transaction/TransactionController" {
|
|
|
2519
2568
|
* The class gives access to runtime draft handling for applications. Additionally error handling capabilities
|
|
2520
2569
|
* are provided to notify client implementations of error situations. The event `fatalError` is thrown,
|
|
2521
2570
|
* if fatal errors occur during execution of OData requests.
|
|
2571
|
+
*
|
|
2572
|
+
* @since 1.30.0
|
|
2522
2573
|
*/
|
|
2523
2574
|
export default class TransactionController extends BaseController {
|
|
2524
2575
|
/**
|
|
@@ -2554,6 +2605,7 @@ declare module "sap/ui/generic/app/transaction/TransactionController" {
|
|
|
2554
2605
|
*
|
|
2555
2606
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.generic.app.transaction.BaseController.extend}.
|
|
2556
2607
|
*
|
|
2608
|
+
*
|
|
2557
2609
|
* @returns Created class / constructor function
|
|
2558
2610
|
*/
|
|
2559
2611
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -2574,16 +2626,17 @@ declare module "sap/ui/generic/app/transaction/TransactionController" {
|
|
|
2574
2626
|
/**
|
|
2575
2627
|
* Returns a metadata object for class sap.ui.generic.app.transaction.TransactionController.
|
|
2576
2628
|
*
|
|
2629
|
+
*
|
|
2577
2630
|
* @returns Metadata object describing this class
|
|
2578
2631
|
*/
|
|
2579
2632
|
static getMetadata(): Metadata;
|
|
2580
2633
|
/**
|
|
2581
|
-
* @since 1.38
|
|
2582
|
-
* @experimental
|
|
2583
|
-
*
|
|
2584
2634
|
* Submits changes to the backend system and deletes a group of entities in the backend system. These entities
|
|
2585
2635
|
* can be both draft or active entities.
|
|
2586
2636
|
*
|
|
2637
|
+
* @since 1.38
|
|
2638
|
+
* @experimental
|
|
2639
|
+
*
|
|
2587
2640
|
* @returns A `Promise` that receives an array with the responses of the delete requests. The `Promise`
|
|
2588
2641
|
* resolves when at least one request was successful and rejects when all delete requests have been rejected/aborted.
|
|
2589
2642
|
*/
|
|
@@ -2601,6 +2654,7 @@ declare module "sap/ui/generic/app/transaction/TransactionController" {
|
|
|
2601
2654
|
* Submits changes to the backend system and deletes an entity in the backend system. This entity can be
|
|
2602
2655
|
* either a draft or an active entity.
|
|
2603
2656
|
*
|
|
2657
|
+
*
|
|
2604
2658
|
* @returns A `Promise` for asynchronous execution
|
|
2605
2659
|
*/
|
|
2606
2660
|
deleteEntity(
|
|
@@ -2621,6 +2675,7 @@ declare module "sap/ui/generic/app/transaction/TransactionController" {
|
|
|
2621
2675
|
* Prepares an entity for editing. If the entity is active and draft enabled, a new draft document is created.
|
|
2622
2676
|
* If not, the control is automatically returned to the caller of the method by returning a resolved promise.
|
|
2623
2677
|
*
|
|
2678
|
+
*
|
|
2624
2679
|
* @returns A `Promise` for asynchronous execution
|
|
2625
2680
|
*/
|
|
2626
2681
|
editEntity(
|
|
@@ -2640,6 +2695,7 @@ declare module "sap/ui/generic/app/transaction/TransactionController" {
|
|
|
2640
2695
|
/**
|
|
2641
2696
|
* Returns the current draft controller instance.
|
|
2642
2697
|
*
|
|
2698
|
+
*
|
|
2643
2699
|
* @returns The draft controller instance
|
|
2644
2700
|
*/
|
|
2645
2701
|
getDraftController(): DraftController;
|
|
@@ -2651,6 +2707,7 @@ declare module "sap/ui/generic/app/transaction/TransactionController" {
|
|
|
2651
2707
|
/**
|
|
2652
2708
|
* Multi edit handling.
|
|
2653
2709
|
*
|
|
2710
|
+
*
|
|
2654
2711
|
* @returns A `Promise` which resolves if the given promises have been executed with at least one successfully.
|
|
2655
2712
|
* It rejects if all given promises were rejected.
|
|
2656
2713
|
*/
|