@sapui5/types 1.120.14 → 1.120.16
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/sap.chart.d.ts +1 -1
- package/types/sap.esh.search.ui.d.ts +1 -1
- package/types/sap.f.d.ts +1 -1
- package/types/sap.fe.core.d.ts +12 -2
- package/types/sap.fe.macros.d.ts +1 -1
- package/types/sap.fe.navigation.d.ts +1 -1
- package/types/sap.fe.placeholder.d.ts +1 -1
- package/types/sap.fe.templates.d.ts +1 -1
- package/types/sap.fe.test.d.ts +1 -1
- package/types/sap.fe.tools.d.ts +1 -1
- package/types/sap.gantt.d.ts +1 -1
- package/types/sap.insights.d.ts +1 -1
- package/types/sap.m.d.ts +1 -1
- package/types/sap.makit.d.ts +1 -1
- package/types/sap.me.d.ts +1 -1
- package/types/sap.ndc.d.ts +1 -1
- package/types/sap.ovp.d.ts +1 -1
- package/types/sap.suite.ui.commons.d.ts +1 -1
- package/types/sap.suite.ui.generic.template.d.ts +4 -1
- package/types/sap.suite.ui.microchart.d.ts +1 -1
- package/types/sap.tnt.d.ts +1 -1
- package/types/sap.ui.codeeditor.d.ts +1 -1
- package/types/sap.ui.commons.d.ts +1 -1
- package/types/sap.ui.comp.d.ts +1 -1
- package/types/sap.ui.core.d.ts +43 -30
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.export.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +1 -1
- package/types/sap.ui.generic.app.d.ts +241 -193
- package/types/sap.ui.generic.template.d.ts +1 -1
- package/types/sap.ui.integration.d.ts +1 -1
- package/types/sap.ui.layout.d.ts +1 -1
- package/types/sap.ui.mdc.d.ts +1 -1
- package/types/sap.ui.richtexteditor.d.ts +1 -1
- package/types/sap.ui.rta.d.ts +1 -1
- package/types/sap.ui.suite.d.ts +1 -1
- package/types/sap.ui.support.d.ts +1 -1
- package/types/sap.ui.table.d.ts +1 -1
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +1 -1
- package/types/sap.ui.ux3.d.ts +1 -1
- package/types/sap.ui.vk.d.ts +1251 -101
- package/types/sap.ui.webc.common.d.ts +1 -1
- package/types/sap.ui.webc.fiori.d.ts +169 -1
- package/types/sap.ui.webc.main.d.ts +493 -1
- package/types/sap.uiext.inbox.d.ts +1 -1
- package/types/sap.ushell.d.ts +1 -1
- package/types/sap.ushell_abap.d.ts +1 -1
- package/types/sap.uxap.d.ts +1 -1
- package/types/sap.viz.d.ts +1 -1
|
@@ -1,18 +1,18 @@
|
|
|
1
|
-
// For Library Version: 1.120.
|
|
1
|
+
// For Library Version: 1.120.1
|
|
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
|
+
* @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.NavType} instead.
|
|
10
10
|
*/
|
|
11
11
|
enum NavType {
|
|
12
12
|
/**
|
|
13
|
-
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
14
|
-
*
|
|
15
13
|
* Passing iapp-state data within xapp state in addition to existing values
|
|
14
|
+
*
|
|
15
|
+
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
16
16
|
*/
|
|
17
17
|
hybrid = "undefined",
|
|
18
18
|
/**
|
|
@@ -35,10 +35,10 @@ declare module "sap/ui/generic/app/library" {
|
|
|
35
35
|
xAppState = "undefined",
|
|
36
36
|
}
|
|
37
37
|
/**
|
|
38
|
-
* @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.ParamHandlingMode} instead.
|
|
39
|
-
*
|
|
40
38
|
* A static enumeration type which indicates the conflict resolution method when merging URL parameters
|
|
41
39
|
* into select options
|
|
40
|
+
*
|
|
41
|
+
* @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.ParamHandlingMode} instead.
|
|
42
42
|
*/
|
|
43
43
|
enum ParamHandlingMode {
|
|
44
44
|
/**
|
|
@@ -57,12 +57,12 @@ declare module "sap/ui/generic/app/library" {
|
|
|
57
57
|
URLParamWins = "undefined",
|
|
58
58
|
}
|
|
59
59
|
/**
|
|
60
|
-
* @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.SuppressionBehavior} instead.
|
|
61
|
-
*
|
|
62
60
|
* A static enumeration type which indicates whether semantic attributes with values `null`, `undefined`
|
|
63
61
|
* or `""` (empty string) shall be suppressed, before they are mixed in to the selection variant in the
|
|
64
62
|
* method {@link sap.ui.generic.app.navigation.service.NavigationHandler.mixAttributesAndSelectionVariant mixAttributesAndSelectionVariant }
|
|
65
63
|
* of the {@link sap.ui.generic.app.navigation.service.NavigationHandler NavigationHandler}
|
|
64
|
+
*
|
|
65
|
+
* @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.SuppressionBehavior} instead.
|
|
66
66
|
*/
|
|
67
67
|
enum SuppressionBehavior {
|
|
68
68
|
/**
|
|
@@ -104,10 +104,10 @@ declare module "sap/ui/generic/app/ApplicationController" {
|
|
|
104
104
|
import TransactionController from "sap/ui/generic/app/transaction/TransactionController";
|
|
105
105
|
|
|
106
106
|
/**
|
|
107
|
+
* Application Controller.
|
|
108
|
+
*
|
|
107
109
|
* @since 1.32.0
|
|
108
110
|
* @experimental (since 1.32.0)
|
|
109
|
-
*
|
|
110
|
-
* Application Controller.
|
|
111
111
|
*/
|
|
112
112
|
export default class ApplicationController extends BaseController {
|
|
113
113
|
/**
|
|
@@ -130,6 +130,7 @@ declare module "sap/ui/generic/app/ApplicationController" {
|
|
|
130
130
|
*
|
|
131
131
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.generic.app.transaction.BaseController.extend}.
|
|
132
132
|
*
|
|
133
|
+
*
|
|
133
134
|
* @returns Created class / constructor function
|
|
134
135
|
*/
|
|
135
136
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -150,13 +151,14 @@ declare module "sap/ui/generic/app/ApplicationController" {
|
|
|
150
151
|
/**
|
|
151
152
|
* Returns a metadata object for class sap.ui.generic.app.ApplicationController.
|
|
152
153
|
*
|
|
154
|
+
*
|
|
153
155
|
* @returns Metadata object describing this class
|
|
154
156
|
*/
|
|
155
157
|
static getMetadata(): Metadata;
|
|
156
158
|
/**
|
|
157
|
-
* @experimental (since 1.32.0)
|
|
158
|
-
*
|
|
159
159
|
* Frees all resources claimed during the life-time of this instance.
|
|
160
|
+
*
|
|
161
|
+
* @experimental (since 1.32.0)
|
|
160
162
|
*/
|
|
161
163
|
destroy(): void;
|
|
162
164
|
/**
|
|
@@ -165,6 +167,7 @@ declare module "sap/ui/generic/app/ApplicationController" {
|
|
|
165
167
|
* will be executed. PreparationAction will be called if there is no global side effect annotation available
|
|
166
168
|
* or if no trigger action is configured in the global side effect.
|
|
167
169
|
*
|
|
170
|
+
*
|
|
168
171
|
* @returns A `Promise` for asynchronous execution of the action. The promise is either already resolved
|
|
169
172
|
* (when nothing needs to be processed) or resolves when the `triggerSubmitChanges()` has been executed.
|
|
170
173
|
*/
|
|
@@ -192,11 +195,11 @@ declare module "sap/ui/generic/app/ApplicationController" {
|
|
|
192
195
|
mAdditionalParameters: Record<string, any>
|
|
193
196
|
): Promise<any>;
|
|
194
197
|
/**
|
|
198
|
+
* Creates a context for an action call (OData function import)
|
|
199
|
+
*
|
|
195
200
|
* @since 1.38
|
|
196
201
|
* @experimental
|
|
197
202
|
*
|
|
198
|
-
* Creates a context for an action call (OData function import)
|
|
199
|
-
*
|
|
200
203
|
* @returns A `map` that contains two Promises: `context` which provides the action-specific model context
|
|
201
204
|
* to the resolve function `result` which resolves when the success handler is called and rejects when the
|
|
202
205
|
* error handler is called; The result of the promises is normalized in both cases, error and success.
|
|
@@ -218,6 +221,7 @@ declare module "sap/ui/generic/app/ApplicationController" {
|
|
|
218
221
|
/**
|
|
219
222
|
* Returns the current transaction controller instance.
|
|
220
223
|
*
|
|
224
|
+
*
|
|
221
225
|
* @returns The transaction controller instance
|
|
222
226
|
*/
|
|
223
227
|
getTransactionController(): TransactionController;
|
|
@@ -225,6 +229,7 @@ declare module "sap/ui/generic/app/ApplicationController" {
|
|
|
225
229
|
* Invokes an action for every provided context where the properties are taken as input from. The changes
|
|
226
230
|
* are submitted directly to the back-end.
|
|
227
231
|
*
|
|
232
|
+
*
|
|
228
233
|
* @returns A `Promise` for asynchronous execution of the action
|
|
229
234
|
*/
|
|
230
235
|
invokeActions(
|
|
@@ -249,11 +254,11 @@ declare module "sap/ui/generic/app/ApplicationController" {
|
|
|
249
254
|
}
|
|
250
255
|
): Promise<any>;
|
|
251
256
|
/**
|
|
252
|
-
* @experimental (since 1.32.0)
|
|
253
|
-
*
|
|
254
257
|
* Notifies the application controller of a change of a property. Please note that the method is not meant
|
|
255
258
|
* for productive use currently. It is experimental.
|
|
256
259
|
*
|
|
260
|
+
* @experimental (since 1.32.0)
|
|
261
|
+
*
|
|
257
262
|
* @returns A `Promise` for asynchronous execution of the action
|
|
258
263
|
*/
|
|
259
264
|
propertyChanged(
|
|
@@ -267,9 +272,9 @@ declare module "sap/ui/generic/app/ApplicationController" {
|
|
|
267
272
|
oContext: object
|
|
268
273
|
): Promise<any>;
|
|
269
274
|
/**
|
|
270
|
-
* @experimental (since 1.32.0)
|
|
271
|
-
*
|
|
272
275
|
* Registers a change for the given group id.
|
|
276
|
+
*
|
|
277
|
+
* @experimental (since 1.32.0)
|
|
273
278
|
*/
|
|
274
279
|
registerGroupChange(
|
|
275
280
|
/**
|
|
@@ -278,9 +283,9 @@ declare module "sap/ui/generic/app/ApplicationController" {
|
|
|
278
283
|
sGroupId: string
|
|
279
284
|
): void;
|
|
280
285
|
/**
|
|
281
|
-
* @experimental (since 1.32.0)
|
|
282
|
-
*
|
|
283
286
|
* Registers the given view with the Application Controller.
|
|
287
|
+
*
|
|
288
|
+
* @experimental (since 1.32.0)
|
|
284
289
|
*/
|
|
285
290
|
registerView(
|
|
286
291
|
/**
|
|
@@ -297,9 +302,9 @@ declare module "sap/ui/generic/app/navigation/service/NavError" {
|
|
|
297
302
|
import Metadata from "sap/ui/base/Metadata";
|
|
298
303
|
|
|
299
304
|
/**
|
|
300
|
-
* @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.NavError} instead.
|
|
301
|
-
*
|
|
302
305
|
* An object that provides error handling information during runtime.
|
|
306
|
+
*
|
|
307
|
+
* @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.NavError} instead.
|
|
303
308
|
*/
|
|
304
309
|
export default class NavError extends NavError1 {
|
|
305
310
|
/**
|
|
@@ -323,6 +328,7 @@ declare module "sap/ui/generic/app/navigation/service/NavError" {
|
|
|
323
328
|
*
|
|
324
329
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.fe.navigation.NavError.extend}.
|
|
325
330
|
*
|
|
331
|
+
*
|
|
326
332
|
* @returns Created class / constructor function
|
|
327
333
|
*/
|
|
328
334
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -343,14 +349,15 @@ declare module "sap/ui/generic/app/navigation/service/NavError" {
|
|
|
343
349
|
/**
|
|
344
350
|
* Returns a metadata object for class sap.ui.generic.app.navigation.service.NavError.
|
|
345
351
|
*
|
|
352
|
+
*
|
|
346
353
|
* @returns Metadata object describing this class
|
|
347
354
|
*/
|
|
348
355
|
static getMetadata(): Metadata;
|
|
349
356
|
/**
|
|
350
|
-
* @deprecated (since 1.83.0)
|
|
351
|
-
*
|
|
352
357
|
* Returns the error code with which the instance has been created.
|
|
353
358
|
*
|
|
359
|
+
* @deprecated (since 1.83.0)
|
|
360
|
+
*
|
|
354
361
|
* @returns The error code of the error
|
|
355
362
|
*/
|
|
356
363
|
getErrorCode(): string;
|
|
@@ -365,8 +372,6 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
365
372
|
import Metadata from "sap/ui/base/Metadata";
|
|
366
373
|
|
|
367
374
|
/**
|
|
368
|
-
* @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.NavigationHandler} instead.
|
|
369
|
-
*
|
|
370
375
|
* Creates a new NavigationHandler class by providing the required environment.
|
|
371
376
|
* The `NavigationHandler` supports the verification of sensitive information. All properties that are
|
|
372
377
|
* part of `selectionVariant` and `valueTexts` will be verified if they are annotated as `com.sap.vocabularies.PersonalData.v1.IsPotentiallySensitive`
|
|
@@ -381,6 +386,8 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
381
386
|
* context.
|
|
382
387
|
* **Note:** This class requires that the UShell {@link sap.ushell.services.CrossApplicationNavigation }
|
|
383
388
|
* is available and initialized.
|
|
389
|
+
*
|
|
390
|
+
* @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.NavigationHandler} instead.
|
|
384
391
|
*/
|
|
385
392
|
export default class NavigationHandler extends NavigationHandler1 {
|
|
386
393
|
constructor(
|
|
@@ -397,13 +404,13 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
397
404
|
);
|
|
398
405
|
|
|
399
406
|
/**
|
|
407
|
+
* 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 }
|
|
408
|
+
* or {@link sap.ui.generic.app.navigation.service.NavigationHandler#setFilterContextUrl FilterContextUrl}
|
|
409
|
+
*
|
|
400
410
|
* @since 1.60.2
|
|
401
411
|
* @deprecated (since 1.83.0)
|
|
402
412
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
403
413
|
*
|
|
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
414
|
* @returns context url for the given entities
|
|
408
415
|
*/
|
|
409
416
|
static constructContextUrl(
|
|
@@ -422,6 +429,7 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
422
429
|
*
|
|
423
430
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.fe.navigation.NavigationHandler.extend}.
|
|
424
431
|
*
|
|
432
|
+
*
|
|
425
433
|
* @returns Created class / constructor function
|
|
426
434
|
*/
|
|
427
435
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -442,12 +450,11 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
442
450
|
/**
|
|
443
451
|
* Returns a metadata object for class sap.ui.generic.app.navigation.service.NavigationHandler.
|
|
444
452
|
*
|
|
453
|
+
*
|
|
445
454
|
* @returns Metadata object describing this class
|
|
446
455
|
*/
|
|
447
456
|
static getMetadata(): Metadata;
|
|
448
457
|
/**
|
|
449
|
-
* @deprecated (since 1.83.0)
|
|
450
|
-
*
|
|
451
458
|
* Gets the application specific technical parameters. Technical parameters will not be added to the selection
|
|
452
459
|
* variant passed to the application. As a default the following values are considered as technical parameters:
|
|
453
460
|
*
|
|
@@ -455,18 +462,20 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
455
462
|
* - `sap-ushell-defaultedParameterNames`
|
|
456
463
|
* - `"hcpApplicationId"`
|
|
457
464
|
*
|
|
465
|
+
* @deprecated (since 1.83.0)
|
|
466
|
+
*
|
|
458
467
|
* @returns Containing the technical parameters.
|
|
459
468
|
*/
|
|
460
469
|
static getTechnicalParameters(): any[];
|
|
461
470
|
/**
|
|
462
|
-
* @deprecated (since 1.83.0)
|
|
463
|
-
*
|
|
464
471
|
* Combines the given parameters and selection variant into a new selection variant containing properties
|
|
465
472
|
* from both, with the parameters overriding existing properties in the selection variant. The new selection
|
|
466
473
|
* variant does not contain any parameters. All parameters are merged into select options. The output of
|
|
467
474
|
* this function, converted to a JSON string, can be used for the {@link #.navigate NavigationHandler.navigate }
|
|
468
475
|
* method.
|
|
469
476
|
*
|
|
477
|
+
* @deprecated (since 1.83.0)
|
|
478
|
+
*
|
|
470
479
|
* @returns Instance of {@link sap.ui.generic.app.navigation.service.SelectionVariant}
|
|
471
480
|
*/
|
|
472
481
|
static mixAttributesAndSelectionVariant(
|
|
@@ -486,6 +495,11 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
486
495
|
iSuppressionBehavior?: int
|
|
487
496
|
): object;
|
|
488
497
|
/**
|
|
498
|
+
* Triggers a cross-app navigation after saving the inner and the cross-app states. Since 1.52.0 the navigation
|
|
499
|
+
* mode based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state
|
|
500
|
+
* will not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad
|
|
501
|
+
* default navigation for opening a URL in-place or ex-place.
|
|
502
|
+
*
|
|
489
503
|
* @deprecated (since 1.83.0) -
|
|
490
504
|
* **Node:** If the `oExternalAppData` parameter is not supplied, the external app data will be calculated
|
|
491
505
|
* based on the `oInnerAppData` data.
|
|
@@ -496,11 +510,6 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
496
510
|
* of the error (info/warning/error) {array} **oError.params**
|
|
497
511
|
* An array of objects (typically strings) that describe additional value parameters required for generating
|
|
498
512
|
* 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
513
|
*/
|
|
505
514
|
static navigate(
|
|
506
515
|
/**
|
|
@@ -575,6 +584,11 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
575
584
|
sNavMode?: string
|
|
576
585
|
): void;
|
|
577
586
|
/**
|
|
587
|
+
* Triggers a cross-app navigation after saving the inner and the cross-app states. Since 1.52.0 the navigation
|
|
588
|
+
* mode based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state
|
|
589
|
+
* will not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad
|
|
590
|
+
* default navigation for opening a URL in-place or ex-place.
|
|
591
|
+
*
|
|
578
592
|
* @deprecated (since 1.83.0) -
|
|
579
593
|
* **Node:** If the `oExternalAppData` parameter is not supplied, the external app data will be calculated
|
|
580
594
|
* based on the `oInnerAppData` data.
|
|
@@ -585,11 +599,6 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
585
599
|
* of the error (info/warning/error) {array} **oError.params**
|
|
586
600
|
* An array of objects (typically strings) that describe additional value parameters required for generating
|
|
587
601
|
* 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
602
|
*/
|
|
594
603
|
static navigate(
|
|
595
604
|
/**
|
|
@@ -660,6 +669,11 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
660
669
|
sNavMode?: string
|
|
661
670
|
): void;
|
|
662
671
|
/**
|
|
672
|
+
* Triggers a cross-app navigation after saving the inner and the cross-app states. Since 1.52.0 the navigation
|
|
673
|
+
* mode based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state
|
|
674
|
+
* will not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad
|
|
675
|
+
* default navigation for opening a URL in-place or ex-place.
|
|
676
|
+
*
|
|
663
677
|
* @deprecated (since 1.83.0) -
|
|
664
678
|
* **Node:** If the `oExternalAppData` parameter is not supplied, the external app data will be calculated
|
|
665
679
|
* based on the `oInnerAppData` data.
|
|
@@ -670,11 +684,6 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
670
684
|
* of the error (info/warning/error) {array} **oError.params**
|
|
671
685
|
* An array of objects (typically strings) that describe additional value parameters required for generating
|
|
672
686
|
* 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
687
|
*/
|
|
679
688
|
static navigate(
|
|
680
689
|
/**
|
|
@@ -720,6 +729,11 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
720
729
|
sNavMode?: string
|
|
721
730
|
): void;
|
|
722
731
|
/**
|
|
732
|
+
* Triggers a cross-app navigation after saving the inner and the cross-app states. Since 1.52.0 the navigation
|
|
733
|
+
* mode based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state
|
|
734
|
+
* will not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad
|
|
735
|
+
* default navigation for opening a URL in-place or ex-place.
|
|
736
|
+
*
|
|
723
737
|
* @deprecated (since 1.83.0) -
|
|
724
738
|
* **Node:** If the `oExternalAppData` parameter is not supplied, the external app data will be calculated
|
|
725
739
|
* based on the `oInnerAppData` data.
|
|
@@ -730,11 +744,6 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
730
744
|
* of the error (info/warning/error) {array} **oError.params**
|
|
731
745
|
* An array of objects (typically strings) that describe additional value parameters required for generating
|
|
732
746
|
* 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
747
|
*/
|
|
739
748
|
static navigate(
|
|
740
749
|
/**
|
|
@@ -803,6 +812,11 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
803
812
|
sNavMode?: string
|
|
804
813
|
): void;
|
|
805
814
|
/**
|
|
815
|
+
* Triggers a cross-app navigation after saving the inner and the cross-app states. Since 1.52.0 the navigation
|
|
816
|
+
* mode based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state
|
|
817
|
+
* will not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad
|
|
818
|
+
* default navigation for opening a URL in-place or ex-place.
|
|
819
|
+
*
|
|
806
820
|
* @deprecated (since 1.83.0) -
|
|
807
821
|
* **Node:** If the `oExternalAppData` parameter is not supplied, the external app data will be calculated
|
|
808
822
|
* based on the `oInnerAppData` data.
|
|
@@ -813,11 +827,6 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
813
827
|
* of the error (info/warning/error) {array} **oError.params**
|
|
814
828
|
* An array of objects (typically strings) that describe additional value parameters required for generating
|
|
815
829
|
* 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
830
|
*/
|
|
822
831
|
static navigate(
|
|
823
832
|
/**
|
|
@@ -859,6 +868,11 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
859
868
|
sNavMode?: string
|
|
860
869
|
): void;
|
|
861
870
|
/**
|
|
871
|
+
* Triggers a cross-app navigation after saving the inner and the cross-app states. Since 1.52.0 the navigation
|
|
872
|
+
* mode based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state
|
|
873
|
+
* will not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad
|
|
874
|
+
* default navigation for opening a URL in-place or ex-place.
|
|
875
|
+
*
|
|
862
876
|
* @deprecated (since 1.83.0) -
|
|
863
877
|
* **Node:** If the `oExternalAppData` parameter is not supplied, the external app data will be calculated
|
|
864
878
|
* based on the `oInnerAppData` data.
|
|
@@ -869,11 +883,6 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
869
883
|
* of the error (info/warning/error) {array} **oError.params**
|
|
870
884
|
* An array of objects (typically strings) that describe additional value parameters required for generating
|
|
871
885
|
* 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
886
|
*/
|
|
878
887
|
static navigate(
|
|
879
888
|
/**
|
|
@@ -938,6 +947,11 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
938
947
|
sNavMode?: string
|
|
939
948
|
): void;
|
|
940
949
|
/**
|
|
950
|
+
* Triggers a cross-app navigation after saving the inner and the cross-app states. Since 1.52.0 the navigation
|
|
951
|
+
* mode based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state
|
|
952
|
+
* will not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad
|
|
953
|
+
* default navigation for opening a URL in-place or ex-place.
|
|
954
|
+
*
|
|
941
955
|
* @deprecated (since 1.83.0) -
|
|
942
956
|
* **Node:** If the `oExternalAppData` parameter is not supplied, the external app data will be calculated
|
|
943
957
|
* based on the `oInnerAppData` data.
|
|
@@ -948,11 +962,6 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
948
962
|
* of the error (info/warning/error) {array} **oError.params**
|
|
949
963
|
* An array of objects (typically strings) that describe additional value parameters required for generating
|
|
950
964
|
* 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
965
|
*/
|
|
957
966
|
static navigate(
|
|
958
967
|
/**
|
|
@@ -992,6 +1001,11 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
992
1001
|
sNavMode?: string
|
|
993
1002
|
): void;
|
|
994
1003
|
/**
|
|
1004
|
+
* Triggers a cross-app navigation after saving the inner and the cross-app states. Since 1.52.0 the navigation
|
|
1005
|
+
* mode based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state
|
|
1006
|
+
* will not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad
|
|
1007
|
+
* default navigation for opening a URL in-place or ex-place.
|
|
1008
|
+
*
|
|
995
1009
|
* @deprecated (since 1.83.0) -
|
|
996
1010
|
* **Node:** If the `oExternalAppData` parameter is not supplied, the external app data will be calculated
|
|
997
1011
|
* based on the `oInnerAppData` data.
|
|
@@ -1002,11 +1016,6 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
1002
1016
|
* of the error (info/warning/error) {array} **oError.params**
|
|
1003
1017
|
* An array of objects (typically strings) that describe additional value parameters required for generating
|
|
1004
1018
|
* 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
1019
|
*/
|
|
1011
1020
|
static navigate(
|
|
1012
1021
|
/**
|
|
@@ -1042,13 +1051,13 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
1042
1051
|
sNavMode?: string
|
|
1043
1052
|
): void;
|
|
1044
1053
|
/**
|
|
1045
|
-
* @deprecated (since 1.83.0)
|
|
1046
|
-
*
|
|
1047
1054
|
* Parses the incoming URL and returns a Promise. If this method detects a back navigation, the inner app
|
|
1048
1055
|
* state is returned in the resolved Promise. Otherwise startup parameters will be merged into the app state
|
|
1049
1056
|
* provided by cross app navigation, and a combined app state will be returned. The conflict resolution
|
|
1050
1057
|
* can be influenced with sParamHandlingMode defined in the constructor.
|
|
1051
1058
|
*
|
|
1059
|
+
* @deprecated (since 1.83.0)
|
|
1060
|
+
*
|
|
1052
1061
|
* @returns A Promise object to monitor when all the actions of the function have been executed. If the
|
|
1053
1062
|
* execution is successful, the extracted app state, the startup parameters, and the type of navigation
|
|
1054
1063
|
* are returned, see also the example above. The app state is an object that contains the following information:
|
|
@@ -1079,11 +1088,6 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
1079
1088
|
*/
|
|
1080
1089
|
static parseNavigation(): object;
|
|
1081
1090
|
/**
|
|
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
1091
|
* Processes navigation-related tasks related to beforePopoverOpens event handling for the SmartLink control
|
|
1088
1092
|
* and returns a Promise object. In particular, the following tasks are performed before the SmartLink popover
|
|
1089
1093
|
* can be opened:
|
|
@@ -1098,6 +1102,11 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
1098
1102
|
* - The method `oTableEventParameters.open()` is called. Note that this does not really open the popover,
|
|
1099
1103
|
* but the SmartLink control proceeds with firing the event `navigationTargetsObtained`.
|
|
1100
1104
|
*
|
|
1105
|
+
* @deprecated (since 1.83.0) -
|
|
1106
|
+
* **Node:** If the `oExternalAppData` parameter is not supplied, the external app data will be calculated
|
|
1107
|
+
* based on the `mInnerAppData` data.
|
|
1108
|
+
*
|
|
1109
|
+
*
|
|
1101
1110
|
* @returns A Promise object to monitor when all actions of the function have been executed; if the execution
|
|
1102
1111
|
* is successful, the modified oTableEventParameters is returned; if an error occurs, an error object of
|
|
1103
1112
|
* type {@link sap.ui.generic.app.navigation.service.NavError} is returned
|
|
@@ -1163,9 +1172,9 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
1163
1172
|
}
|
|
1164
1173
|
): object;
|
|
1165
1174
|
/**
|
|
1166
|
-
* @deprecated (since 1.83.0)
|
|
1167
|
-
*
|
|
1168
1175
|
* Changes the URL according to the current sAppStateKey. As an reaction route change event will be triggered.
|
|
1176
|
+
*
|
|
1177
|
+
* @deprecated (since 1.83.0)
|
|
1169
1178
|
*/
|
|
1170
1179
|
static replaceHash(
|
|
1171
1180
|
/**
|
|
@@ -1174,11 +1183,11 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
1174
1183
|
sAppStateKey: string
|
|
1175
1184
|
): void;
|
|
1176
1185
|
/**
|
|
1177
|
-
* @since 1.60.0
|
|
1178
|
-
* @deprecated (since 1.83.0)
|
|
1179
|
-
*
|
|
1180
1186
|
* Sets the model that is used for verification of sensitive information. If the model is not set, the unnamed
|
|
1181
1187
|
* component model is used for the verification of sensitive information.
|
|
1188
|
+
*
|
|
1189
|
+
* @since 1.60.0
|
|
1190
|
+
* @deprecated (since 1.83.0)
|
|
1182
1191
|
*/
|
|
1183
1192
|
static setModel(
|
|
1184
1193
|
/**
|
|
@@ -1187,14 +1196,14 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
1187
1196
|
oModel: ODataModel
|
|
1188
1197
|
): void;
|
|
1189
1198
|
/**
|
|
1190
|
-
* @deprecated (since 1.83.0)
|
|
1191
|
-
*
|
|
1192
1199
|
* Sets the application specific technical parameters. Technical parameters will not be added to the selection
|
|
1193
1200
|
* variant passed to the application. As a default the following values are considered as technical parameters:
|
|
1194
1201
|
*
|
|
1195
1202
|
* - `sap-system`
|
|
1196
1203
|
* - `sap-ushell-defaultedParameterNames`
|
|
1197
1204
|
* - `"hcpApplicationId"`
|
|
1205
|
+
*
|
|
1206
|
+
* @deprecated (since 1.83.0)
|
|
1198
1207
|
*/
|
|
1199
1208
|
static setTechnicalParameters(
|
|
1200
1209
|
/**
|
|
@@ -1204,10 +1213,10 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
1204
1213
|
aTechnicalParameters: any[]
|
|
1205
1214
|
): void;
|
|
1206
1215
|
/**
|
|
1207
|
-
* @deprecated (since 1.83.0)
|
|
1208
|
-
*
|
|
1209
1216
|
* Changes the URL according to the current app state and stores the app state for later retrieval.
|
|
1210
1217
|
*
|
|
1218
|
+
* @deprecated (since 1.83.0)
|
|
1219
|
+
*
|
|
1211
1220
|
* @returns A Promise object to monitor when all the actions of the function have been executed; if the
|
|
1212
1221
|
* 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
1222
|
* is returned
|
|
@@ -1250,10 +1259,10 @@ declare module "sap/ui/generic/app/navigation/service/NavigationHandler" {
|
|
|
1250
1259
|
bImmediateHashReplace?: boolean
|
|
1251
1260
|
): object;
|
|
1252
1261
|
/**
|
|
1253
|
-
* @deprecated (since 1.83.0)
|
|
1254
|
-
*
|
|
1255
1262
|
* Changes the URL according to the current app state and stores the app state for later retrieval.
|
|
1256
1263
|
*
|
|
1264
|
+
* @deprecated (since 1.83.0)
|
|
1265
|
+
*
|
|
1257
1266
|
* @returns An object containing the appStateId and a promise object to monitor when all the actions of
|
|
1258
1267
|
* the function have been executed; Please note that the appStateKey may be undefined or empty.
|
|
1259
1268
|
*/
|
|
@@ -1304,11 +1313,11 @@ declare module "sap/ui/generic/app/navigation/service/PresentationVariant" {
|
|
|
1304
1313
|
import Metadata from "sap/ui/base/Metadata";
|
|
1305
1314
|
|
|
1306
1315
|
/**
|
|
1307
|
-
* @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.PresentationVariant} instead.
|
|
1308
|
-
*
|
|
1309
1316
|
* Creates a new instance of a PresentationVariant class. If no parameter is passed, an new empty instance
|
|
1310
1317
|
* is created whose ID has been set to `""`. Passing a JSON-serialized string complying to the Selection
|
|
1311
1318
|
* Variant Specification will parse it, and the newly created instance will contain the same information.
|
|
1319
|
+
*
|
|
1320
|
+
* @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.PresentationVariant} instead.
|
|
1312
1321
|
*/
|
|
1313
1322
|
export default class PresentationVariant extends PresentationVariant1 {
|
|
1314
1323
|
constructor(
|
|
@@ -1325,6 +1334,7 @@ declare module "sap/ui/generic/app/navigation/service/PresentationVariant" {
|
|
|
1325
1334
|
*
|
|
1326
1335
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.fe.navigation.PresentationVariant.extend}.
|
|
1327
1336
|
*
|
|
1337
|
+
*
|
|
1328
1338
|
* @returns Created class / constructor function
|
|
1329
1339
|
*/
|
|
1330
1340
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -1343,71 +1353,72 @@ declare module "sap/ui/generic/app/navigation/service/PresentationVariant" {
|
|
|
1343
1353
|
FNMetaImpl?: Function
|
|
1344
1354
|
): Function;
|
|
1345
1355
|
/**
|
|
1346
|
-
* @deprecated (since 1.83.0)
|
|
1347
|
-
*
|
|
1348
1356
|
* Gets the chart visualization property.
|
|
1349
1357
|
*
|
|
1358
|
+
* @deprecated (since 1.83.0)
|
|
1359
|
+
*
|
|
1350
1360
|
* @returns mProperties to be used for the chart visualization.
|
|
1351
1361
|
*/
|
|
1352
1362
|
static getChartVisualization(): Record<string, any>;
|
|
1353
1363
|
/**
|
|
1354
|
-
* @deprecated (since 1.83.0)
|
|
1355
|
-
*
|
|
1356
1364
|
* Gets the current context URL intended for the query.
|
|
1357
1365
|
*
|
|
1366
|
+
* @deprecated (since 1.83.0)
|
|
1367
|
+
*
|
|
1358
1368
|
* @returns The current context URL for the query
|
|
1359
1369
|
*/
|
|
1360
1370
|
static getContextUrl(): string;
|
|
1361
1371
|
/**
|
|
1362
|
-
* @deprecated (since 1.83.0)
|
|
1363
|
-
*
|
|
1364
1372
|
* Returns the identification of the selection variant.
|
|
1365
1373
|
*
|
|
1374
|
+
* @deprecated (since 1.83.0)
|
|
1375
|
+
*
|
|
1366
1376
|
* @returns The identification of the selection variant as made available during construction
|
|
1367
1377
|
*/
|
|
1368
1378
|
static getID(): string;
|
|
1369
1379
|
/**
|
|
1370
1380
|
* Returns a metadata object for class sap.ui.generic.app.navigation.service.PresentationVariant.
|
|
1371
1381
|
*
|
|
1382
|
+
*
|
|
1372
1383
|
* @returns Metadata object describing this class
|
|
1373
1384
|
*/
|
|
1374
1385
|
static getMetadata(): Metadata;
|
|
1375
1386
|
/**
|
|
1376
|
-
* @deprecated (since 1.83.0)
|
|
1377
|
-
*
|
|
1378
1387
|
* Gets the more trivial properties. Basically all properties with the exception of the Visualization.
|
|
1379
1388
|
*
|
|
1389
|
+
* @deprecated (since 1.83.0)
|
|
1390
|
+
*
|
|
1380
1391
|
* @returns The current properties.
|
|
1381
1392
|
*/
|
|
1382
1393
|
static getProperties(): Record<string, any>;
|
|
1383
1394
|
/**
|
|
1384
|
-
* @deprecated (since 1.83.0)
|
|
1385
|
-
*
|
|
1386
1395
|
* Gets the table visualization property.
|
|
1387
1396
|
*
|
|
1397
|
+
* @deprecated (since 1.83.0)
|
|
1398
|
+
*
|
|
1388
1399
|
* @returns mProperties to be used for the table visualization.
|
|
1389
1400
|
*/
|
|
1390
1401
|
static getTableVisualization(): Record<string, any>;
|
|
1391
1402
|
/**
|
|
1392
|
-
* @deprecated (since 1.83.0)
|
|
1393
|
-
*
|
|
1394
1403
|
* Returns the current text / description of this selection variant.
|
|
1395
1404
|
*
|
|
1405
|
+
* @deprecated (since 1.83.0)
|
|
1406
|
+
*
|
|
1396
1407
|
* @returns the current description of this selection variant.
|
|
1397
1408
|
*/
|
|
1398
1409
|
static getText(): string;
|
|
1399
1410
|
/**
|
|
1400
|
-
* @deprecated (since 1.83.0)
|
|
1401
|
-
*
|
|
1402
1411
|
* Returns `true` if the presentation variant does not contain any properties. nor ranges.
|
|
1403
1412
|
*
|
|
1413
|
+
* @deprecated (since 1.83.0)
|
|
1414
|
+
*
|
|
1404
1415
|
* @returns If set to `true` there are no current properties set; `false` otherwise.
|
|
1405
1416
|
*/
|
|
1406
1417
|
static isEmpty(): boolean;
|
|
1407
1418
|
/**
|
|
1408
|
-
* @deprecated (since 1.83.0)
|
|
1409
|
-
*
|
|
1410
1419
|
* Sets the chart visualization property.
|
|
1420
|
+
*
|
|
1421
|
+
* @deprecated (since 1.83.0)
|
|
1411
1422
|
*/
|
|
1412
1423
|
static setChartVisualization(
|
|
1413
1424
|
/**
|
|
@@ -1416,9 +1427,9 @@ declare module "sap/ui/generic/app/navigation/service/PresentationVariant" {
|
|
|
1416
1427
|
mProperties: Record<string, any>
|
|
1417
1428
|
): void;
|
|
1418
1429
|
/**
|
|
1419
|
-
* @deprecated (since 1.83.0)
|
|
1420
|
-
*
|
|
1421
1430
|
* Sets the context URL.
|
|
1431
|
+
*
|
|
1432
|
+
* @deprecated (since 1.83.0)
|
|
1422
1433
|
*/
|
|
1423
1434
|
static setContextUrl(
|
|
1424
1435
|
/**
|
|
@@ -1427,9 +1438,9 @@ declare module "sap/ui/generic/app/navigation/service/PresentationVariant" {
|
|
|
1427
1438
|
sURL: string
|
|
1428
1439
|
): void;
|
|
1429
1440
|
/**
|
|
1430
|
-
* @deprecated (since 1.83.0)
|
|
1431
|
-
*
|
|
1432
1441
|
* Sets the identification of the selection variant.
|
|
1442
|
+
*
|
|
1443
|
+
* @deprecated (since 1.83.0)
|
|
1433
1444
|
*/
|
|
1434
1445
|
static setID(
|
|
1435
1446
|
/**
|
|
@@ -1438,9 +1449,9 @@ declare module "sap/ui/generic/app/navigation/service/PresentationVariant" {
|
|
|
1438
1449
|
sId: string
|
|
1439
1450
|
): void;
|
|
1440
1451
|
/**
|
|
1441
|
-
* @deprecated (since 1.83.0)
|
|
1442
|
-
*
|
|
1443
1452
|
* Sets the more trivial properties. Basically all properties with the exception of the Visualization.
|
|
1453
|
+
*
|
|
1454
|
+
* @deprecated (since 1.83.0)
|
|
1444
1455
|
*/
|
|
1445
1456
|
static setProperties(
|
|
1446
1457
|
/**
|
|
@@ -1449,9 +1460,9 @@ declare module "sap/ui/generic/app/navigation/service/PresentationVariant" {
|
|
|
1449
1460
|
mProperties: Record<string, any>
|
|
1450
1461
|
): void;
|
|
1451
1462
|
/**
|
|
1452
|
-
* @deprecated (since 1.83.0)
|
|
1453
|
-
*
|
|
1454
1463
|
* Sets the table visualization property.
|
|
1464
|
+
*
|
|
1465
|
+
* @deprecated (since 1.83.0)
|
|
1455
1466
|
*/
|
|
1456
1467
|
static setTableVisualization(
|
|
1457
1468
|
/**
|
|
@@ -1460,9 +1471,9 @@ declare module "sap/ui/generic/app/navigation/service/PresentationVariant" {
|
|
|
1460
1471
|
mProperties: Record<string, any>
|
|
1461
1472
|
): void;
|
|
1462
1473
|
/**
|
|
1463
|
-
* @deprecated (since 1.83.0)
|
|
1464
|
-
*
|
|
1465
1474
|
* Sets the text / description of the selection variant.
|
|
1475
|
+
*
|
|
1476
|
+
* @deprecated (since 1.83.0)
|
|
1466
1477
|
*/
|
|
1467
1478
|
static setText(
|
|
1468
1479
|
/**
|
|
@@ -1471,18 +1482,18 @@ declare module "sap/ui/generic/app/navigation/service/PresentationVariant" {
|
|
|
1471
1482
|
sNewText: string
|
|
1472
1483
|
): void;
|
|
1473
1484
|
/**
|
|
1474
|
-
* @deprecated (since 1.83.0)
|
|
1475
|
-
*
|
|
1476
1485
|
* Returns the external representation of the selection variant as JSON object.
|
|
1477
1486
|
*
|
|
1487
|
+
* @deprecated (since 1.83.0)
|
|
1488
|
+
*
|
|
1478
1489
|
* @returns The external representation of this instance as a JSON object
|
|
1479
1490
|
*/
|
|
1480
1491
|
static toJSONObject(): object;
|
|
1481
1492
|
/**
|
|
1482
|
-
* @deprecated (since 1.83.0)
|
|
1483
|
-
*
|
|
1484
1493
|
* Serializes this instance into a JSON-formatted string.
|
|
1485
1494
|
*
|
|
1495
|
+
* @deprecated (since 1.83.0)
|
|
1496
|
+
*
|
|
1486
1497
|
* @returns The JSON-formatted representation of this instance in stringified format
|
|
1487
1498
|
*/
|
|
1488
1499
|
static toJSONString(): string;
|
|
@@ -1495,11 +1506,11 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1495
1506
|
import Metadata from "sap/ui/base/Metadata";
|
|
1496
1507
|
|
|
1497
1508
|
/**
|
|
1498
|
-
* @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.SelectionVariant} instead.
|
|
1499
|
-
*
|
|
1500
1509
|
* Creates a new instance of a SelectionVariant class. If no parameter is passed, an new empty instance
|
|
1501
1510
|
* is created whose ID has been set to `""`. Passing a JSON-serialized string complying to the Selection
|
|
1502
1511
|
* Variant Specification will parse it, and the newly created instance will contain the same information.
|
|
1512
|
+
*
|
|
1513
|
+
* @deprecated (since 1.83.0) - Please use {@link sap.fe.navigation.SelectionVariant} instead.
|
|
1503
1514
|
*/
|
|
1504
1515
|
export default class SelectionVariant extends SelectionVariant1 {
|
|
1505
1516
|
constructor(
|
|
@@ -1511,11 +1522,11 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1511
1522
|
);
|
|
1512
1523
|
|
|
1513
1524
|
/**
|
|
1514
|
-
* @deprecated (since 1.83.0)
|
|
1515
|
-
*
|
|
1516
1525
|
* Sets the value of a parameter called `sName` to the new value `sValue`. If the parameter has already
|
|
1517
1526
|
* been set before, its value is overwritten.
|
|
1518
1527
|
*
|
|
1528
|
+
* @deprecated (since 1.83.0)
|
|
1529
|
+
*
|
|
1519
1530
|
* @returns This instance to allow method chaining
|
|
1520
1531
|
*/
|
|
1521
1532
|
static addParameter(
|
|
@@ -1529,10 +1540,10 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1529
1540
|
sValue: string
|
|
1530
1541
|
): object;
|
|
1531
1542
|
/**
|
|
1532
|
-
* @deprecated (since 1.83.0)
|
|
1533
|
-
*
|
|
1534
1543
|
* Adds a new range to the list of select options for a given parameter.
|
|
1535
1544
|
*
|
|
1545
|
+
* @deprecated (since 1.83.0)
|
|
1546
|
+
*
|
|
1536
1547
|
* @returns This instance to allow method chaining.
|
|
1537
1548
|
*/
|
|
1538
1549
|
static addSelectOption(
|
|
@@ -1567,6 +1578,7 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1567
1578
|
*
|
|
1568
1579
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.fe.navigation.SelectionVariant.extend}.
|
|
1569
1580
|
*
|
|
1581
|
+
*
|
|
1570
1582
|
* @returns Created class / constructor function
|
|
1571
1583
|
*/
|
|
1572
1584
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -1585,33 +1597,34 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1585
1597
|
FNMetaImpl?: Function
|
|
1586
1598
|
): Function;
|
|
1587
1599
|
/**
|
|
1588
|
-
* @deprecated (since 1.83.0)
|
|
1589
|
-
*
|
|
1590
1600
|
* Gets the current context URL intended for the filters.
|
|
1591
1601
|
*
|
|
1602
|
+
* @deprecated (since 1.83.0)
|
|
1603
|
+
*
|
|
1592
1604
|
* @returns The current context URL for the filters
|
|
1593
1605
|
*/
|
|
1594
1606
|
static getFilterContextUrl(): string;
|
|
1595
1607
|
/**
|
|
1596
|
-
* @deprecated (since 1.83.0)
|
|
1597
|
-
*
|
|
1598
1608
|
* Returns the identification of the selection variant.
|
|
1599
1609
|
*
|
|
1610
|
+
* @deprecated (since 1.83.0)
|
|
1611
|
+
*
|
|
1600
1612
|
* @returns The identification of the selection variant as made available during construction
|
|
1601
1613
|
*/
|
|
1602
1614
|
static getID(): string;
|
|
1603
1615
|
/**
|
|
1604
1616
|
* Returns a metadata object for class sap.ui.generic.app.navigation.service.SelectionVariant.
|
|
1605
1617
|
*
|
|
1618
|
+
*
|
|
1606
1619
|
* @returns Metadata object describing this class
|
|
1607
1620
|
*/
|
|
1608
1621
|
static getMetadata(): Metadata;
|
|
1609
1622
|
/**
|
|
1610
|
-
* @deprecated (since 1.83.0)
|
|
1611
|
-
*
|
|
1612
1623
|
* Returns the value of the parameter called `sName` if it has been set. If the parameter has never been
|
|
1613
1624
|
* set or has been removed, `undefined` is returned.
|
|
1614
1625
|
*
|
|
1626
|
+
* @deprecated (since 1.83.0)
|
|
1627
|
+
*
|
|
1615
1628
|
* @returns The value of parameter `sName`; returning the value `null` not possible
|
|
1616
1629
|
*/
|
|
1617
1630
|
static getParameter(
|
|
@@ -1621,34 +1634,34 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1621
1634
|
sName: string
|
|
1622
1635
|
): string;
|
|
1623
1636
|
/**
|
|
1624
|
-
* @deprecated (since 1.83.0)
|
|
1625
|
-
*
|
|
1626
1637
|
* Gets the current context URL intended for the parameters.
|
|
1627
1638
|
*
|
|
1639
|
+
* @deprecated (since 1.83.0)
|
|
1640
|
+
*
|
|
1628
1641
|
* @returns The current context URL for the parameters
|
|
1629
1642
|
*/
|
|
1630
1643
|
static getParameterContextUrl(): string;
|
|
1631
1644
|
/**
|
|
1632
|
-
* @deprecated (since 1.83.0)
|
|
1633
|
-
*
|
|
1634
1645
|
* Returns the set of parameter names available in this selection variant
|
|
1635
1646
|
*
|
|
1647
|
+
* @deprecated (since 1.83.0)
|
|
1648
|
+
*
|
|
1636
1649
|
* @returns the list of parameter names which are valid
|
|
1637
1650
|
*/
|
|
1638
1651
|
static getParameterNames(): any[];
|
|
1639
1652
|
/**
|
|
1640
|
-
* @deprecated (since 1.83.0)
|
|
1641
|
-
*
|
|
1642
1653
|
* Returns the names of the parameter and select option properties available for this instance.
|
|
1643
1654
|
*
|
|
1655
|
+
* @deprecated (since 1.83.0)
|
|
1656
|
+
*
|
|
1644
1657
|
* @returns The list of parameter and select option property names available for this instance
|
|
1645
1658
|
*/
|
|
1646
1659
|
static getPropertyNames(): any[];
|
|
1647
1660
|
/**
|
|
1648
|
-
* @deprecated (since 1.83.0)
|
|
1649
|
-
*
|
|
1650
1661
|
* Returns the set of select options/ranges available for a given property name.
|
|
1651
1662
|
*
|
|
1663
|
+
* @deprecated (since 1.83.0)
|
|
1664
|
+
*
|
|
1652
1665
|
* @returns If `sPropertyName` is an invalid name of a property or no range exists, `undefined` is returned;
|
|
1653
1666
|
* otherwise, an immutable array of ranges is returned. Each entry of the array is an object with the following
|
|
1654
1667
|
* properties:
|
|
@@ -1665,30 +1678,30 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1665
1678
|
sPropertyName: string
|
|
1666
1679
|
): any[];
|
|
1667
1680
|
/**
|
|
1668
|
-
* @deprecated (since 1.83.0)
|
|
1669
|
-
*
|
|
1670
1681
|
* Returns the names of the properties available for this instance.
|
|
1671
1682
|
*
|
|
1683
|
+
* @deprecated (since 1.83.0)
|
|
1684
|
+
*
|
|
1672
1685
|
* @returns The list of property names available for this instance
|
|
1673
1686
|
*/
|
|
1674
1687
|
static getSelectOptionsPropertyNames(): any[];
|
|
1675
1688
|
/**
|
|
1676
|
-
* @deprecated (since 1.83.0)
|
|
1677
|
-
*
|
|
1678
1689
|
* Returns the current text / description of this selection variant.
|
|
1679
1690
|
*
|
|
1691
|
+
* @deprecated (since 1.83.0)
|
|
1692
|
+
*
|
|
1680
1693
|
* @returns the current description of this selection variant.
|
|
1681
1694
|
*/
|
|
1682
1695
|
static getText(): string;
|
|
1683
1696
|
/**
|
|
1684
|
-
* @deprecated (since 1.83.0)
|
|
1685
|
-
*
|
|
1686
1697
|
* First tries to retrieve the set of select options/ranges available for `sName` as property name. If successful,
|
|
1687
1698
|
* this array of selections is being returned. If it fails, an attempt to find a parameter, whose name is
|
|
1688
1699
|
* `sName`, is made. If the latter succeeds, the single value is converted to fit into an array of selections
|
|
1689
1700
|
* to make it type compatible with ranges. This array is then returned. If neither a select option
|
|
1690
1701
|
* nor a parameter could be found, `undefined` is returned.
|
|
1691
1702
|
*
|
|
1703
|
+
* @deprecated (since 1.83.0)
|
|
1704
|
+
*
|
|
1692
1705
|
* @returns The ranges in the select options for the specified property or a range-converted representation
|
|
1693
1706
|
* of a parameter is returned. If both lookups fail, `undefined` is returned. The returned ranges
|
|
1694
1707
|
* have the format:
|
|
@@ -1705,19 +1718,19 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1705
1718
|
sName: string
|
|
1706
1719
|
): any[];
|
|
1707
1720
|
/**
|
|
1708
|
-
* @deprecated (since 1.83.0)
|
|
1709
|
-
*
|
|
1710
1721
|
* Returns `true` if the selection variant does neither contain parameters nor ranges.
|
|
1711
1722
|
*
|
|
1723
|
+
* @deprecated (since 1.83.0)
|
|
1724
|
+
*
|
|
1712
1725
|
* @returns If set to `true` there are no parameters and no select options available in the selection variant;
|
|
1713
1726
|
* `false` otherwise.
|
|
1714
1727
|
*/
|
|
1715
1728
|
static isEmpty(): boolean;
|
|
1716
1729
|
/**
|
|
1717
|
-
* @deprecated (since 1.83.0)
|
|
1718
|
-
*
|
|
1719
1730
|
* Adds a set of select options to the list of select options for a given parameter.
|
|
1720
1731
|
*
|
|
1732
|
+
* @deprecated (since 1.83.0)
|
|
1733
|
+
*
|
|
1721
1734
|
* @returns This instance to allow method chaining
|
|
1722
1735
|
*/
|
|
1723
1736
|
static massAddSelectOption(
|
|
@@ -1731,10 +1744,10 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1731
1744
|
aSelectOptions: any[]
|
|
1732
1745
|
): object;
|
|
1733
1746
|
/**
|
|
1734
|
-
* @deprecated (since 1.83.0)
|
|
1735
|
-
*
|
|
1736
1747
|
* Removes a parameter called `sName` from the selection variant.
|
|
1737
1748
|
*
|
|
1749
|
+
* @deprecated (since 1.83.0)
|
|
1750
|
+
*
|
|
1738
1751
|
* @returns This instance to allow method chaining
|
|
1739
1752
|
*/
|
|
1740
1753
|
static removeParameter(
|
|
@@ -1744,10 +1757,10 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1744
1757
|
sName: string
|
|
1745
1758
|
): object;
|
|
1746
1759
|
/**
|
|
1747
|
-
* @deprecated (since 1.83.0)
|
|
1748
|
-
*
|
|
1749
1760
|
* Removes a select option called `sName` from the selection variant.
|
|
1750
1761
|
*
|
|
1762
|
+
* @deprecated (since 1.83.0)
|
|
1763
|
+
*
|
|
1751
1764
|
* @returns This instance to allow method chaining.
|
|
1752
1765
|
*/
|
|
1753
1766
|
static removeSelectOption(
|
|
@@ -1757,12 +1770,12 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1757
1770
|
sName: string
|
|
1758
1771
|
): object;
|
|
1759
1772
|
/**
|
|
1760
|
-
* @deprecated (since 1.83.0)
|
|
1761
|
-
*
|
|
1762
1773
|
* Renames a parameter called `sNameOld` to `sNameNew`. If a parameter or a select option with the name
|
|
1763
1774
|
* `sNameNew` already exist, an error is thrown. If a parameter with the name `sNameOld` does not exist,
|
|
1764
1775
|
* nothing is changed.
|
|
1765
1776
|
*
|
|
1777
|
+
* @deprecated (since 1.83.0)
|
|
1778
|
+
*
|
|
1766
1779
|
* @returns This instance to allow method chaining
|
|
1767
1780
|
*/
|
|
1768
1781
|
static renameParameter(
|
|
@@ -1776,12 +1789,12 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1776
1789
|
sNameNew: string
|
|
1777
1790
|
): object;
|
|
1778
1791
|
/**
|
|
1779
|
-
* @deprecated (since 1.83.0)
|
|
1780
|
-
*
|
|
1781
1792
|
* Renames a select option called `sNameOld` to `sNameNew`. If a select option or a parameter with the name
|
|
1782
1793
|
* `sNameNew` already exist, an error is thrown. If a select option with the name `sNameOld` does not exist,
|
|
1783
1794
|
* nothing is changed.
|
|
1784
1795
|
*
|
|
1796
|
+
* @deprecated (since 1.83.0)
|
|
1797
|
+
*
|
|
1785
1798
|
* @returns This instance to allow method chaining
|
|
1786
1799
|
*/
|
|
1787
1800
|
static renameSelectOption(
|
|
@@ -1795,9 +1808,9 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1795
1808
|
sNameNew: string
|
|
1796
1809
|
): object;
|
|
1797
1810
|
/**
|
|
1798
|
-
* @deprecated (since 1.83.0)
|
|
1799
|
-
*
|
|
1800
1811
|
* Sets the context URL intended for the filters.
|
|
1812
|
+
*
|
|
1813
|
+
* @deprecated (since 1.83.0)
|
|
1801
1814
|
*/
|
|
1802
1815
|
static setFilterContextUrl(
|
|
1803
1816
|
/**
|
|
@@ -1806,9 +1819,9 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1806
1819
|
sURL: string
|
|
1807
1820
|
): void;
|
|
1808
1821
|
/**
|
|
1809
|
-
* @deprecated (since 1.83.0)
|
|
1810
|
-
*
|
|
1811
1822
|
* Sets the identification of the selection variant.
|
|
1823
|
+
*
|
|
1824
|
+
* @deprecated (since 1.83.0)
|
|
1812
1825
|
*/
|
|
1813
1826
|
static setID(
|
|
1814
1827
|
/**
|
|
@@ -1817,9 +1830,9 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1817
1830
|
sId: string
|
|
1818
1831
|
): void;
|
|
1819
1832
|
/**
|
|
1820
|
-
* @deprecated (since 1.83.0)
|
|
1821
|
-
*
|
|
1822
1833
|
* Sets the context URL intended for the parameters.
|
|
1834
|
+
*
|
|
1835
|
+
* @deprecated (since 1.83.0)
|
|
1823
1836
|
*/
|
|
1824
1837
|
static setParameterContextUrl(
|
|
1825
1838
|
/**
|
|
@@ -1828,9 +1841,9 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1828
1841
|
sURL: string
|
|
1829
1842
|
): void;
|
|
1830
1843
|
/**
|
|
1831
|
-
* @deprecated (since 1.83.0)
|
|
1832
|
-
*
|
|
1833
1844
|
* Sets the text / description of the selection variant.
|
|
1845
|
+
*
|
|
1846
|
+
* @deprecated (since 1.83.0)
|
|
1834
1847
|
*/
|
|
1835
1848
|
static setText(
|
|
1836
1849
|
/**
|
|
@@ -1839,18 +1852,18 @@ declare module "sap/ui/generic/app/navigation/service/SelectionVariant" {
|
|
|
1839
1852
|
sNewText: string
|
|
1840
1853
|
): void;
|
|
1841
1854
|
/**
|
|
1842
|
-
* @deprecated (since 1.83.0)
|
|
1843
|
-
*
|
|
1844
1855
|
* Returns the external representation of the selection variant as JSON object.
|
|
1845
1856
|
*
|
|
1857
|
+
* @deprecated (since 1.83.0)
|
|
1858
|
+
*
|
|
1846
1859
|
* @returns The external representation of this instance as a JSON object
|
|
1847
1860
|
*/
|
|
1848
1861
|
static toJSONObject(): object;
|
|
1849
1862
|
/**
|
|
1850
|
-
* @deprecated (since 1.83.0)
|
|
1851
|
-
*
|
|
1852
1863
|
* Serializes this instance into a JSON-formatted string
|
|
1853
1864
|
*
|
|
1865
|
+
* @deprecated (since 1.83.0)
|
|
1866
|
+
*
|
|
1854
1867
|
* @returns The JSON-formatted representation of this instance in stringified format
|
|
1855
1868
|
*/
|
|
1856
1869
|
static toJSONString(): string;
|
|
@@ -1865,11 +1878,11 @@ declare module "sap/ui/generic/app/transaction/BaseController" {
|
|
|
1865
1878
|
import Metadata from "sap/ui/base/Metadata";
|
|
1866
1879
|
|
|
1867
1880
|
/**
|
|
1868
|
-
* @since 1.30.0
|
|
1869
|
-
*
|
|
1870
1881
|
* Common base class for `sap.ui.generic.app.transaction.TransactionController` and `sap.ui.generic.app.transaction.DraftController`,
|
|
1871
1882
|
* which offers basic functionality to invoke OData functions and actions as well as OData CRUD functions
|
|
1872
1883
|
* in general.
|
|
1884
|
+
*
|
|
1885
|
+
* @since 1.30.0
|
|
1873
1886
|
*/
|
|
1874
1887
|
export default class BaseController extends EventProvider {
|
|
1875
1888
|
/**
|
|
@@ -1896,6 +1909,7 @@ declare module "sap/ui/generic/app/transaction/BaseController" {
|
|
|
1896
1909
|
*
|
|
1897
1910
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.EventProvider.extend}.
|
|
1898
1911
|
*
|
|
1912
|
+
*
|
|
1899
1913
|
* @returns Created class / constructor function
|
|
1900
1914
|
*/
|
|
1901
1915
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -1916,6 +1930,7 @@ declare module "sap/ui/generic/app/transaction/BaseController" {
|
|
|
1916
1930
|
/**
|
|
1917
1931
|
* Returns a metadata object for class sap.ui.generic.app.transaction.BaseController.
|
|
1918
1932
|
*
|
|
1933
|
+
*
|
|
1919
1934
|
* @returns Metadata object describing this class
|
|
1920
1935
|
*/
|
|
1921
1936
|
static getMetadata(): Metadata;
|
|
@@ -1952,12 +1967,14 @@ declare module "sap/ui/generic/app/transaction/BaseController" {
|
|
|
1952
1967
|
/**
|
|
1953
1968
|
* Checks for client messages.
|
|
1954
1969
|
*
|
|
1970
|
+
*
|
|
1955
1971
|
* @returns If client-side messages exist a rejected promise is returned, `null` otherwise
|
|
1956
1972
|
*/
|
|
1957
1973
|
hasClientMessages(): Promise<any>;
|
|
1958
1974
|
/**
|
|
1959
1975
|
* Triggers submitting the currently tracked changes to the back-end.
|
|
1960
1976
|
*
|
|
1977
|
+
*
|
|
1961
1978
|
* @returns A `Promise` for asynchronous execution of the submit
|
|
1962
1979
|
*/
|
|
1963
1980
|
triggerSubmitChanges(
|
|
@@ -2000,10 +2017,10 @@ declare module "sap/ui/generic/app/transaction/DraftContext" {
|
|
|
2000
2017
|
import Context from "sap/ui/model/Context";
|
|
2001
2018
|
|
|
2002
2019
|
/**
|
|
2003
|
-
* @since 1.30.0
|
|
2004
|
-
*
|
|
2005
2020
|
* The class provides access to information on draft handling that is available in the OData service's metadata
|
|
2006
2021
|
* as it interprets draft-specific annotations.
|
|
2022
|
+
*
|
|
2023
|
+
* @since 1.30.0
|
|
2007
2024
|
*/
|
|
2008
2025
|
export default class DraftContext extends BaseObject {
|
|
2009
2026
|
/**
|
|
@@ -2022,6 +2039,7 @@ declare module "sap/ui/generic/app/transaction/DraftContext" {
|
|
|
2022
2039
|
*
|
|
2023
2040
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
|
|
2024
2041
|
*
|
|
2042
|
+
*
|
|
2025
2043
|
* @returns Created class / constructor function
|
|
2026
2044
|
*/
|
|
2027
2045
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -2042,15 +2060,16 @@ declare module "sap/ui/generic/app/transaction/DraftContext" {
|
|
|
2042
2060
|
/**
|
|
2043
2061
|
* Returns a metadata object for class sap.ui.generic.app.transaction.DraftContext.
|
|
2044
2062
|
*
|
|
2063
|
+
*
|
|
2045
2064
|
* @returns Metadata object describing this class
|
|
2046
2065
|
*/
|
|
2047
2066
|
static getMetadata(): Metadata;
|
|
2048
2067
|
/**
|
|
2049
|
-
* @deprecated (since 1.32.0)
|
|
2050
|
-
*
|
|
2051
2068
|
* Checks whether an OData property is annotated with UpdateOnChange. The method is used in context of a
|
|
2052
2069
|
* validation success event.
|
|
2053
2070
|
*
|
|
2071
|
+
* @deprecated (since 1.32.0)
|
|
2072
|
+
*
|
|
2054
2073
|
* @returns `true`, if the property is annotated with UpdateOnChange, `false` otherwise
|
|
2055
2074
|
*/
|
|
2056
2075
|
checkUpdateOnChange(
|
|
@@ -2070,6 +2089,7 @@ declare module "sap/ui/generic/app/transaction/DraftContext" {
|
|
|
2070
2089
|
/**
|
|
2071
2090
|
* Returns the name of the function import to be used.
|
|
2072
2091
|
*
|
|
2092
|
+
*
|
|
2073
2093
|
* @returns The name of the function import to be used
|
|
2074
2094
|
*/
|
|
2075
2095
|
getODataDraftFunctionImportName(
|
|
@@ -2085,6 +2105,7 @@ declare module "sap/ui/generic/app/transaction/DraftContext" {
|
|
|
2085
2105
|
/**
|
|
2086
2106
|
* Returns the semantic keys for a given entity set.
|
|
2087
2107
|
*
|
|
2108
|
+
*
|
|
2088
2109
|
* @returns The semantic keys
|
|
2089
2110
|
*/
|
|
2090
2111
|
getSemanticKey(
|
|
@@ -2097,6 +2118,7 @@ declare module "sap/ui/generic/app/transaction/DraftContext" {
|
|
|
2097
2118
|
* Checks whether an entity set is draft-enabled. The entity set name is derived from the given binding
|
|
2098
2119
|
* context
|
|
2099
2120
|
*
|
|
2121
|
+
*
|
|
2100
2122
|
* @returns `true`, if a given entity set is draft-enabled, `false` otherwise
|
|
2101
2123
|
*/
|
|
2102
2124
|
hasDraft(
|
|
@@ -2108,6 +2130,7 @@ declare module "sap/ui/generic/app/transaction/DraftContext" {
|
|
|
2108
2130
|
/**
|
|
2109
2131
|
* Checks whether administrative data for a given draft is available.
|
|
2110
2132
|
*
|
|
2133
|
+
*
|
|
2111
2134
|
* @returns `true`, if administrative data is available, `false` otherwise
|
|
2112
2135
|
*/
|
|
2113
2136
|
hasDraftAdministrativeData(
|
|
@@ -2120,6 +2143,7 @@ declare module "sap/ui/generic/app/transaction/DraftContext" {
|
|
|
2120
2143
|
* Checks whether an entity set has a draft preparation action. The entity set name is derived from the
|
|
2121
2144
|
* given binding context.
|
|
2122
2145
|
*
|
|
2146
|
+
*
|
|
2123
2147
|
* @returns `true`, if a given entity set has a draft preparation action, `false` otherwise
|
|
2124
2148
|
*/
|
|
2125
2149
|
hasDraftPreparationAction(
|
|
@@ -2131,6 +2155,7 @@ declare module "sap/ui/generic/app/transaction/DraftContext" {
|
|
|
2131
2155
|
/**
|
|
2132
2156
|
* Checks whether an entity set is draft root. The entity set name is derived from the given binding context.
|
|
2133
2157
|
*
|
|
2158
|
+
*
|
|
2134
2159
|
* @returns `true`, if a given entity set is draft root, `false` otherwise
|
|
2135
2160
|
*/
|
|
2136
2161
|
hasDraftRoot(
|
|
@@ -2143,6 +2168,7 @@ declare module "sap/ui/generic/app/transaction/DraftContext" {
|
|
|
2143
2168
|
* Checks whether an entity set has a draft validation function. The entity set name is derived from the
|
|
2144
2169
|
* given binding context.
|
|
2145
2170
|
*
|
|
2171
|
+
*
|
|
2146
2172
|
* @returns `true`, if a given entity set has a draft validation function, `false` otherwise
|
|
2147
2173
|
*/
|
|
2148
2174
|
hasDraftValidationFunction(
|
|
@@ -2152,18 +2178,19 @@ declare module "sap/ui/generic/app/transaction/DraftContext" {
|
|
|
2152
2178
|
oContext: Context
|
|
2153
2179
|
): boolean;
|
|
2154
2180
|
/**
|
|
2155
|
-
* @since 1.38
|
|
2156
|
-
*
|
|
2157
2181
|
* Checks if the parameter "PreserveChanges" is supported by the edit function. If the edit action is triggered
|
|
2158
2182
|
* with the parameter set to `true` the ABAP application infrastructure will respond with HTTP response
|
|
2159
2183
|
* code 409 if unsaved changes (from another user) exist.
|
|
2160
2184
|
*
|
|
2185
|
+
* @since 1.38
|
|
2186
|
+
*
|
|
2161
2187
|
* @returns `true`, if "PreserveChanges" is supported
|
|
2162
2188
|
*/
|
|
2163
2189
|
hasPreserveChanges(): boolean;
|
|
2164
2190
|
/**
|
|
2165
2191
|
* Checks whether a sibling entity for a given entity set is available.
|
|
2166
2192
|
*
|
|
2193
|
+
*
|
|
2167
2194
|
* @returns `true`, if sibling entity is available, `false` otherwise
|
|
2168
2195
|
*/
|
|
2169
2196
|
hasSiblingEntity(
|
|
@@ -2175,6 +2202,7 @@ declare module "sap/ui/generic/app/transaction/DraftContext" {
|
|
|
2175
2202
|
/**
|
|
2176
2203
|
* Checks whether a given entity set is draft-enabled.
|
|
2177
2204
|
*
|
|
2205
|
+
*
|
|
2178
2206
|
* @returns `true`, if a given entity set is draft-enabled, `false` otherwise
|
|
2179
2207
|
*/
|
|
2180
2208
|
isDraftEnabled(
|
|
@@ -2186,6 +2214,7 @@ declare module "sap/ui/generic/app/transaction/DraftContext" {
|
|
|
2186
2214
|
/**
|
|
2187
2215
|
* Checks whether a given entity set is a draft root.
|
|
2188
2216
|
*
|
|
2217
|
+
*
|
|
2189
2218
|
* @returns `true`, if a given entity set is draft root, `false` otherwise
|
|
2190
2219
|
*/
|
|
2191
2220
|
isDraftRoot(
|
|
@@ -2197,6 +2226,7 @@ declare module "sap/ui/generic/app/transaction/DraftContext" {
|
|
|
2197
2226
|
/**
|
|
2198
2227
|
* Checks whether a given key is a semantic key.
|
|
2199
2228
|
*
|
|
2229
|
+
*
|
|
2200
2230
|
* @returns `true`, if a given key is a semantic key, `false` otherwise
|
|
2201
2231
|
*/
|
|
2202
2232
|
isSemanticKey(
|
|
@@ -2212,6 +2242,7 @@ declare module "sap/ui/generic/app/transaction/DraftContext" {
|
|
|
2212
2242
|
/**
|
|
2213
2243
|
* Checks whether a given key is a technical key.
|
|
2214
2244
|
*
|
|
2245
|
+
*
|
|
2215
2246
|
* @returns `true`, if a given key is a technical key, `false` otherwise
|
|
2216
2247
|
*/
|
|
2217
2248
|
isTechnicalKey(
|
|
@@ -2239,8 +2270,6 @@ declare module "sap/ui/generic/app/transaction/DraftController" {
|
|
|
2239
2270
|
import Metadata from "sap/ui/base/Metadata";
|
|
2240
2271
|
|
|
2241
2272
|
/**
|
|
2242
|
-
* @since 1.30.0
|
|
2243
|
-
*
|
|
2244
2273
|
* Gives access to runtime draft handling for applications. Assuming state-less communication, each single
|
|
2245
2274
|
* data modification request (or change set in an OData $batch request) is a "mini-transaction", which saves
|
|
2246
2275
|
* data to the database. The class implements the transactional interaction patterns specified for OData
|
|
@@ -2252,6 +2281,8 @@ declare module "sap/ui/generic/app/transaction/DraftController" {
|
|
|
2252
2281
|
* to the draft specification. These can be combined as required by client applications. Additionally, error
|
|
2253
2282
|
* handling is provided to notify client implementations of error situations. The event `fatalError` is
|
|
2254
2283
|
* thrown, if fatal errors occur during execution of OData requests.
|
|
2284
|
+
*
|
|
2285
|
+
* @since 1.30.0
|
|
2255
2286
|
*/
|
|
2256
2287
|
export default class DraftController extends BaseController {
|
|
2257
2288
|
/**
|
|
@@ -2278,6 +2309,7 @@ declare module "sap/ui/generic/app/transaction/DraftController" {
|
|
|
2278
2309
|
*
|
|
2279
2310
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.generic.app.transaction.BaseController.extend}.
|
|
2280
2311
|
*
|
|
2312
|
+
*
|
|
2281
2313
|
* @returns Created class / constructor function
|
|
2282
2314
|
*/
|
|
2283
2315
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -2298,12 +2330,14 @@ declare module "sap/ui/generic/app/transaction/DraftController" {
|
|
|
2298
2330
|
/**
|
|
2299
2331
|
* Returns a metadata object for class sap.ui.generic.app.transaction.DraftController.
|
|
2300
2332
|
*
|
|
2333
|
+
*
|
|
2301
2334
|
* @returns Metadata object describing this class
|
|
2302
2335
|
*/
|
|
2303
2336
|
static getMetadata(): Metadata;
|
|
2304
2337
|
/**
|
|
2305
2338
|
* Submits changes to the back-end and activates a draft entity in the back-end.
|
|
2306
2339
|
*
|
|
2340
|
+
*
|
|
2307
2341
|
* @returns A `Promise` for asynchronous execution
|
|
2308
2342
|
*/
|
|
2309
2343
|
activateDraftEntity(
|
|
@@ -2324,6 +2358,7 @@ declare module "sap/ui/generic/app/transaction/DraftController" {
|
|
|
2324
2358
|
/**
|
|
2325
2359
|
* Submits changes to the back-end and activates a draft entity in the back-end.
|
|
2326
2360
|
*
|
|
2361
|
+
*
|
|
2327
2362
|
* @returns A `Promise` for asynchronous execution
|
|
2328
2363
|
*/
|
|
2329
2364
|
activateDraftEntity(
|
|
@@ -2341,6 +2376,7 @@ declare module "sap/ui/generic/app/transaction/DraftController" {
|
|
|
2341
2376
|
* Creates an edit draft in the back-end. Additionally, possible changes that have been collected on the
|
|
2342
2377
|
* client are sent to the back-end.
|
|
2343
2378
|
*
|
|
2379
|
+
*
|
|
2344
2380
|
* @returns A `Promise` for asynchronous execution
|
|
2345
2381
|
*/
|
|
2346
2382
|
createEditDraftEntity(
|
|
@@ -2361,6 +2397,7 @@ declare module "sap/ui/generic/app/transaction/DraftController" {
|
|
|
2361
2397
|
* Creates a new edit draft on the client and sends it to the back-end. Additionally, possible changes that
|
|
2362
2398
|
* have been collected on the client are sent to the back-end.
|
|
2363
2399
|
*
|
|
2400
|
+
*
|
|
2364
2401
|
* @returns A `Promise` for asynchronous execution of the request
|
|
2365
2402
|
*/
|
|
2366
2403
|
createNewDraftEntity(
|
|
@@ -2413,15 +2450,16 @@ declare module "sap/ui/generic/app/transaction/DraftController" {
|
|
|
2413
2450
|
/**
|
|
2414
2451
|
* Returns the current draft context instance. If no instance exists, it is created lazily.
|
|
2415
2452
|
*
|
|
2453
|
+
*
|
|
2416
2454
|
* @returns The current draft context instance
|
|
2417
2455
|
*/
|
|
2418
2456
|
getDraftContext(): DraftContext;
|
|
2419
2457
|
/**
|
|
2420
|
-
* @since 1.32.0
|
|
2421
|
-
*
|
|
2422
2458
|
* Retrieves a possibly existing draft entity for the given active entity using the binding context of the
|
|
2423
2459
|
* active entity from the back-end.
|
|
2424
2460
|
*
|
|
2461
|
+
* @since 1.32.0
|
|
2462
|
+
*
|
|
2425
2463
|
* @returns A `Promise` for asynchronous execution
|
|
2426
2464
|
*/
|
|
2427
2465
|
getDraftForActiveEntity(
|
|
@@ -2431,10 +2469,10 @@ declare module "sap/ui/generic/app/transaction/DraftController" {
|
|
|
2431
2469
|
oContext: Context
|
|
2432
2470
|
): Promise<any>;
|
|
2433
2471
|
/**
|
|
2434
|
-
* @since 1.32.0
|
|
2435
|
-
*
|
|
2436
2472
|
* Checks whether an entity has an active entity associated.
|
|
2437
2473
|
*
|
|
2474
|
+
* @since 1.32.0
|
|
2475
|
+
*
|
|
2438
2476
|
* @returns `true`, if an active entity exists, `false` otherwise
|
|
2439
2477
|
*/
|
|
2440
2478
|
hasActiveEntity(
|
|
@@ -2446,6 +2484,7 @@ declare module "sap/ui/generic/app/transaction/DraftController" {
|
|
|
2446
2484
|
/**
|
|
2447
2485
|
* Checks whether an entity set is active. The entity set name is derived from the given binding context
|
|
2448
2486
|
*
|
|
2487
|
+
*
|
|
2449
2488
|
* @returns `true`, if a given entity set is active, `false` otherwise
|
|
2450
2489
|
*/
|
|
2451
2490
|
isActiveEntity(
|
|
@@ -2458,6 +2497,7 @@ declare module "sap/ui/generic/app/transaction/DraftController" {
|
|
|
2458
2497
|
* Submits changes to the back-end and prepares an existing draft entity in the back-end for later activation
|
|
2459
2498
|
* by invoking the preparation action.
|
|
2460
2499
|
*
|
|
2500
|
+
*
|
|
2461
2501
|
* @returns A `Promise` for asynchronous execution
|
|
2462
2502
|
*/
|
|
2463
2503
|
prepareDraftEntity(
|
|
@@ -2470,6 +2510,7 @@ declare module "sap/ui/generic/app/transaction/DraftController" {
|
|
|
2470
2510
|
* Submits changes to the back-end and prepares a draft entity in the back-end for later activation by invoking
|
|
2471
2511
|
* the preparation action.
|
|
2472
2512
|
*
|
|
2513
|
+
*
|
|
2473
2514
|
* @returns A `Promise` for asynchronous execution
|
|
2474
2515
|
*/
|
|
2475
2516
|
saveAndPrepareDraftEntity(
|
|
@@ -2486,6 +2527,7 @@ declare module "sap/ui/generic/app/transaction/DraftController" {
|
|
|
2486
2527
|
* Submits changes to the back-end and prepares an existing draft entity in the back-end for later activation
|
|
2487
2528
|
* by invoking the validation action.
|
|
2488
2529
|
*
|
|
2530
|
+
*
|
|
2489
2531
|
* @returns A `Promise` for asynchronous execution
|
|
2490
2532
|
*/
|
|
2491
2533
|
validateDraftEntity(
|
|
@@ -2509,8 +2551,6 @@ declare module "sap/ui/generic/app/transaction/TransactionController" {
|
|
|
2509
2551
|
import Metadata from "sap/ui/base/Metadata";
|
|
2510
2552
|
|
|
2511
2553
|
/**
|
|
2512
|
-
* @since 1.30.0
|
|
2513
|
-
*
|
|
2514
2554
|
* Assuming state-less communication, each single data modification request (or change set in an OData $batch
|
|
2515
2555
|
* request) is a "mini-transaction", which saves data to the database. The class allows you to submit changes,
|
|
2516
2556
|
* invoke actions, OData CRUD operations in general, and trigger client-side validations. It ensures concurrency
|
|
@@ -2519,6 +2559,8 @@ declare module "sap/ui/generic/app/transaction/TransactionController" {
|
|
|
2519
2559
|
* The class gives access to runtime draft handling for applications. Additionally error handling capabilities
|
|
2520
2560
|
* are provided to notify client implementations of error situations. The event `fatalError` is thrown,
|
|
2521
2561
|
* if fatal errors occur during execution of OData requests.
|
|
2562
|
+
*
|
|
2563
|
+
* @since 1.30.0
|
|
2522
2564
|
*/
|
|
2523
2565
|
export default class TransactionController extends BaseController {
|
|
2524
2566
|
/**
|
|
@@ -2554,6 +2596,7 @@ declare module "sap/ui/generic/app/transaction/TransactionController" {
|
|
|
2554
2596
|
*
|
|
2555
2597
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.generic.app.transaction.BaseController.extend}.
|
|
2556
2598
|
*
|
|
2599
|
+
*
|
|
2557
2600
|
* @returns Created class / constructor function
|
|
2558
2601
|
*/
|
|
2559
2602
|
static extend<T extends Record<string, unknown>>(
|
|
@@ -2574,16 +2617,17 @@ declare module "sap/ui/generic/app/transaction/TransactionController" {
|
|
|
2574
2617
|
/**
|
|
2575
2618
|
* Returns a metadata object for class sap.ui.generic.app.transaction.TransactionController.
|
|
2576
2619
|
*
|
|
2620
|
+
*
|
|
2577
2621
|
* @returns Metadata object describing this class
|
|
2578
2622
|
*/
|
|
2579
2623
|
static getMetadata(): Metadata;
|
|
2580
2624
|
/**
|
|
2581
|
-
* @since 1.38
|
|
2582
|
-
* @experimental
|
|
2583
|
-
*
|
|
2584
2625
|
* Submits changes to the backend system and deletes a group of entities in the backend system. These entities
|
|
2585
2626
|
* can be both draft or active entities.
|
|
2586
2627
|
*
|
|
2628
|
+
* @since 1.38
|
|
2629
|
+
* @experimental
|
|
2630
|
+
*
|
|
2587
2631
|
* @returns A `Promise` that receives an array with the responses of the delete requests. The `Promise`
|
|
2588
2632
|
* resolves when at least one request was successful and rejects when all delete requests have been rejected/aborted.
|
|
2589
2633
|
*/
|
|
@@ -2601,6 +2645,7 @@ declare module "sap/ui/generic/app/transaction/TransactionController" {
|
|
|
2601
2645
|
* Submits changes to the backend system and deletes an entity in the backend system. This entity can be
|
|
2602
2646
|
* either a draft or an active entity.
|
|
2603
2647
|
*
|
|
2648
|
+
*
|
|
2604
2649
|
* @returns A `Promise` for asynchronous execution
|
|
2605
2650
|
*/
|
|
2606
2651
|
deleteEntity(
|
|
@@ -2621,6 +2666,7 @@ declare module "sap/ui/generic/app/transaction/TransactionController" {
|
|
|
2621
2666
|
* Prepares an entity for editing. If the entity is active and draft enabled, a new draft document is created.
|
|
2622
2667
|
* If not, the control is automatically returned to the caller of the method by returning a resolved promise.
|
|
2623
2668
|
*
|
|
2669
|
+
*
|
|
2624
2670
|
* @returns A `Promise` for asynchronous execution
|
|
2625
2671
|
*/
|
|
2626
2672
|
editEntity(
|
|
@@ -2640,6 +2686,7 @@ declare module "sap/ui/generic/app/transaction/TransactionController" {
|
|
|
2640
2686
|
/**
|
|
2641
2687
|
* Returns the current draft controller instance.
|
|
2642
2688
|
*
|
|
2689
|
+
*
|
|
2643
2690
|
* @returns The draft controller instance
|
|
2644
2691
|
*/
|
|
2645
2692
|
getDraftController(): DraftController;
|
|
@@ -2651,6 +2698,7 @@ declare module "sap/ui/generic/app/transaction/TransactionController" {
|
|
|
2651
2698
|
/**
|
|
2652
2699
|
* Multi edit handling.
|
|
2653
2700
|
*
|
|
2701
|
+
*
|
|
2654
2702
|
* @returns A `Promise` which resolves if the given promises have been executed with at least one successfully.
|
|
2655
2703
|
* It rejects if all given promises were rejected.
|
|
2656
2704
|
*/
|