@sapui5/ts-types 1.101.1 → 1.103.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +1 -0
  3. package/types/sap.apf.d.ts +89 -1
  4. package/types/sap.ca.ui.d.ts +1757 -134
  5. package/types/sap.chart.d.ts +376 -30
  6. package/types/sap.collaboration.d.ts +320 -40
  7. package/types/sap.esh.search.ui.d.ts +1 -669
  8. package/types/sap.f.d.ts +1948 -123
  9. package/types/sap.fe.common.d.ts +1 -1
  10. package/types/sap.fe.core.d.ts +29 -1091
  11. package/types/sap.fe.macros.d.ts +58 -589
  12. package/types/sap.fe.navigation.d.ts +7 -1175
  13. package/types/sap.fe.templates.d.ts +2 -140
  14. package/types/sap.fe.test.d.ts +476 -213
  15. package/types/sap.feedback.ui.d.ts +1 -1
  16. package/types/sap.gantt.d.ts +7540 -559
  17. package/types/sap.insights.d.ts +21 -0
  18. package/types/sap.landvisz.d.ts +1029 -80
  19. package/types/sap.m.d.ts +17162 -1399
  20. package/types/sap.makit.d.ts +579 -58
  21. package/types/sap.me.d.ts +579 -52
  22. package/types/sap.ndc.d.ts +137 -7
  23. package/types/sap.ovp.d.ts +5 -1
  24. package/types/sap.rules.ui.d.ts +171 -15
  25. package/types/sap.sac.df.d.ts +1629 -252
  26. package/types/sap.sac.grid.d.ts +91 -8
  27. package/types/sap.suite.ui.commons.d.ts +5573 -454
  28. package/types/sap.suite.ui.generic.template.d.ts +228 -54
  29. package/types/sap.suite.ui.microchart.d.ts +1814 -173
  30. package/types/sap.tnt.d.ts +282 -22
  31. package/types/sap.ui.codeeditor.d.ts +89 -8
  32. package/types/sap.ui.commons.d.ts +3818 -347
  33. package/types/sap.ui.comp.d.ts +3965 -303
  34. package/types/sap.ui.core.d.ts +6395 -258
  35. package/types/sap.ui.dt.d.ts +1 -1
  36. package/types/sap.ui.export.d.ts +61 -6
  37. package/types/sap.ui.fl.d.ts +3 -1
  38. package/types/sap.ui.generic.app.d.ts +245 -64
  39. package/types/sap.ui.generic.template.d.ts +1 -1
  40. package/types/sap.ui.integration.d.ts +318 -25
  41. package/types/sap.ui.layout.d.ts +1883 -239
  42. package/types/sap.ui.mdc.d.ts +1 -1
  43. package/types/sap.ui.richtexteditor.d.ts +341 -50
  44. package/types/sap.ui.rta.d.ts +5 -1
  45. package/types/sap.ui.suite.d.ts +87 -6
  46. package/types/sap.ui.support.d.ts +30 -1
  47. package/types/sap.ui.table.d.ts +1057 -87
  48. package/types/sap.ui.testrecorder.d.ts +1 -1
  49. package/types/sap.ui.unified.d.ts +2738 -236
  50. package/types/sap.ui.ux3.d.ts +2421 -223
  51. package/types/sap.ui.vbm.d.ts +2006 -126
  52. package/types/sap.ui.vk.d.ts +5369 -326
  53. package/types/sap.ui.vtm.d.ts +1144 -52
  54. package/types/sap.uiext.inbox.d.ts +425 -24
  55. package/types/sap.ushell.d.ts +1500 -59
  56. package/types/sap.ushell_abap.d.ts +4 -1
  57. package/types/sap.uxap.d.ts +914 -99
  58. package/types/sap.viz.d.ts +5521 -387
  59. package/types/sap.webanalytics.core.d.ts +1 -1
  60. package/types/sap.zen.commons.d.ts +168 -23
  61. package/types/sap.zen.crosstab.d.ts +217 -21
  62. package/types/sap.zen.dsh.d.ts +227 -14
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.101.1
1
+ // For Library Version: 1.103.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace fe {
@@ -35,6 +35,8 @@ declare namespace sap {
35
35
  * the information contained in `oClassInfo`.
36
36
  *
37
37
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
38
+ *
39
+ * @returns Created class / constructor function
38
40
  */
39
41
  static extend<T extends Record<string, unknown>>(
40
42
  /**
@@ -53,1180 +55,16 @@ declare namespace sap {
53
55
  ): Function;
54
56
  /**
55
57
  * Returns a metadata object for class sap.fe.navigation.NavError.
56
- */
57
- static getMetadata(): sap.ui.base.Metadata;
58
- /**
59
- * Returns the error code with which the instance has been created.
60
- */
61
- getErrorCode(): string;
62
- }
63
- /**
64
- * @SINCE 1.83.0
65
- *
66
- * This is the successor of {@link sap.ui.generic.app.navigation.service.NavigationHandler}.
67
- * Creates a new NavigationHandler class by providing the required environment.
68
- * The `NavigationHandler` supports the verification of sensitive information. All properties that are
69
- * part of `selectionVariant` and `valueTexts` will be verified if they are annotated as `com.sap.vocabularies.PersonalData.v1.IsPotentiallySensitive`
70
- * or `com.sap.vocabularies.UI.v1.ExcludeFromNavigationContext` and will be removed before the data is persisted
71
- * as the app state.
72
- * Also, all properties annotated as `com.sap.vocabularies.Analytics.v1.Measure` will be removed from the
73
- * data stored as the xapp state.
74
- * To verify the information to be removed, the `NavigationHandler` requires an unnamed model of type {@link
75
- * sap.ui.model.odata.v2.ODataModel} on component level. It is possible to set such a model using the `setModel`
76
- * method.
77
- * **Note:** The check for excluded data requires that the OData metadata has already been loaded completely.
78
- * If the OData metadata model has not been loaded completely, all properties are removed from the application
79
- * context.
80
- * **Note:** This class requires that the UShell {@link sap.ushell.services.CrossApplicationNavigation}
81
- * is available and initialized.
82
- */
83
- class NavigationHandler extends sap.ui.base.Object {
84
- constructor(
85
- /**
86
- * UI5 controller that contains a router and a component; typically the main controller of your application,
87
- * for example, a subclass of the sap.ca.scfld.md.controller.BaseFullscreenController if scaffolding is
88
- * used
89
- */
90
- oController: object,
91
- /**
92
- * Mode to be used to indicates the Odata version used for runnning the Navigation Handler, see {@link sap.fe.navigation.Mode}.
93
- * Note: Mode has to be sap.fe.navigation.Mode.ODataV2 whenever this constructor is used to initialize
94
- * a OData V2 based service.
95
- */
96
- sMode?: string,
97
- /**
98
- * Mode to be used to handle conflicts when merging URL parameters and the SelectionVariant class, see {@link
99
- * sap.fe.navigation.ParamHandlingMode}
100
- */
101
- sParamHandlingMode?: string
102
- );
103
-
104
- /**
105
- * The method creates a context url based on provided data. This context url can either be used as {@link
106
- * sap.fe.navigation.NavigationHandler#setParameterContextUrl ParameterContextUrl} or {@link sap.fe.navigation.NavigationHandler#setFilterContextUrl
107
- * FilterContextUrl}.
108
- */
109
- static constructContextUrl(
110
- /**
111
- * Used for url determination
112
- */
113
- sEntitySetName: string,
114
- /**
115
- * Used for url determination. If omitted, the NavigationHandler model is used.
116
- */
117
- oModel?: sap.ui.model.odata.v2.ODataModel
118
- ): string;
119
- /**
120
- * Creates a new subclass of class sap.fe.navigation.NavigationHandler with name `sClassName` and enriches
121
- * it with the information contained in `oClassInfo`.
122
- *
123
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
124
- */
125
- static extend<T extends Record<string, unknown>>(
126
- /**
127
- * Name of the class being created
128
- */
129
- sClassName: string,
130
- /**
131
- * Object literal with information about the class
132
- */
133
- oClassInfo?: sap.ClassInfo<T, sap.fe.navigation.NavigationHandler>,
134
- /**
135
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
136
- * used by this class
137
- */
138
- FNMetaImpl?: Function
139
- ): Function;
140
- /**
141
- * Returns a metadata object for class sap.fe.navigation.NavigationHandler.
142
- */
143
- static getMetadata(): sap.ui.base.Metadata;
144
- /**
145
- * Gets the application specific technical parameters. Technical parameters will not be added to the selection
146
- * variant passed to the application. As a default the following values are considered as technical parameters:
147
- *
148
- * - `sap-system`
149
- * - `sap-ushell-defaultedParameterNames`
150
- * - `"hcpApplicationId"` .
151
- */
152
- static getTechnicalParameters(): any[];
153
- /**
154
- * Combines the given parameters and selection variant into a new selection variant containing properties
155
- * from both, with the parameters overriding existing properties in the selection variant. The new selection
156
- * variant does not contain any parameters. All parameters are merged into select options. The output of
157
- * this function, converted to a JSON string, can be used for the {@link #.navigate NavigationHandler.navigate}
158
- * method.
159
- */
160
- static mixAttributesAndSelectionVariant(
161
- /**
162
- * Object/(Array of Objects) containing key/value pairs
163
- */
164
- vSemanticAttributes: object | any[],
165
- /**
166
- * The selection variant in string format as provided by the SmartFilterBar control
167
- */
168
- sSelectionVariant: string,
169
- /**
170
- * Indicates whether semantic attributes with special values (see {@link sap.fe.navigation.SuppressionBehavior
171
- * suppression behavior}) must be suppressed before they are combined with the selection variant; several
172
- * {@link sap.fe.navigation.SuppressionBehavior suppression behaviors} can be combined with the bitwise
173
- * OR operator (|)
174
- */
175
- iSuppressionBehavior?: int
176
- ): object;
177
- /**
178
- * Triggers a cross-app navigation after saving the inner and the cross-app states. The navigation mode
179
- * based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state will
180
- * not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad default
181
- * navigation for opening a URL in-place or ex-place.
182
- */
183
- static navigate(
184
- /**
185
- * Name of the semantic object of the target app
186
- */
187
- sSemanticObject: string,
188
- /**
189
- * Name of the action of the target app
190
- */
191
- sActionName: string,
192
- /**
193
- * Navigation parameters as an object with key/value pairs or as a string representation of such an object.
194
- * If passed as an object, the properties are not checked against the `IsPotentialSensitive` or `Measure`
195
- * type.
196
- */
197
- vNavigationParameters: object | string,
198
- /**
199
- * Object for storing current state of the app
200
- */
201
- oInnerAppData: {
202
- /**
203
- * Stringified JSON object as returned, for example, from getDataSuiteFormat() of the SmartFilterBar control
204
- */
205
- selectionVariant?: string;
206
- /**
207
- * ID of the SmartTable variant
208
- */
209
- tableVariantId?: string;
210
- /**
211
- * Object that can be used to store arbitrary data
212
- */
213
- customData?: object;
214
- /**
215
- * Object containing the current ui state of the app
216
- */
217
- presentationVariant?: object;
218
- /**
219
- * Object containing value descriptions
220
- */
221
- valueTexts?: object;
222
- /**
223
- * Object containing semanticDates filter information
224
- */
225
- semanticDates?: object;
226
- },
227
- /**
228
- * Callback that is called if an error occurs during navigation
229
- */
230
- fnOnError: Function,
231
- /**
232
- * Object for storing the state which will be forwarded to the target component.
233
- */
234
- oExternalAppData: {
235
- /**
236
- * Object containing the current ui state of the app which will be forwarded to the target component.
237
- */
238
- presentationVariant?: object;
239
- /**
240
- * Object containing value descriptions which will be forwarded to the target component.
241
- */
242
- valueTexts?: object;
243
- /**
244
- * Stringified JSON object, which will be forwarded to the target component. If not provided the selectionVariant
245
- * will be constructed based on the vNavigationParameters.
246
- */
247
- selectionVariant?: object;
248
- },
249
- /**
250
- * Argument is used to overwrite the FLP-configured target for opening a URL. If used, only the `explace`
251
- * or `inplace` values are allowed. Any other value will lead to an exception `NavigationHandler.INVALID_NAV_MODE`.
252
- */
253
- sNavMode?: string
254
- ): void;
255
- /**
256
- * Triggers a cross-app navigation after saving the inner and the cross-app states. The navigation mode
257
- * based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state will
258
- * not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad default
259
- * navigation for opening a URL in-place or ex-place.
260
- */
261
- static navigate(
262
- /**
263
- * Name of the semantic object of the target app
264
- */
265
- sSemanticObject: string,
266
- /**
267
- * Name of the action of the target app
268
- */
269
- sActionName: string,
270
- /**
271
- * Navigation parameters as an object with key/value pairs or as a string representation of such an object.
272
- * If passed as an object, the properties are not checked against the `IsPotentialSensitive` or `Measure`
273
- * type.
274
- */
275
- vNavigationParameters: object | string,
276
- /**
277
- * Object for storing current state of the app
278
- */
279
- oInnerAppData: {
280
- /**
281
- * Stringified JSON object as returned, for example, from getDataSuiteFormat() of the SmartFilterBar control
282
- */
283
- selectionVariant?: string;
284
- /**
285
- * ID of the SmartTable variant
286
- */
287
- tableVariantId?: string;
288
- /**
289
- * Object that can be used to store arbitrary data
290
- */
291
- customData?: object;
292
- /**
293
- * Object containing the current ui state of the app
294
- */
295
- presentationVariant?: object;
296
- /**
297
- * Object containing value descriptions
298
- */
299
- valueTexts?: object;
300
- /**
301
- * Object containing semanticDates filter information
302
- */
303
- semanticDates?: object;
304
- },
305
- /**
306
- * Object for storing the state which will be forwarded to the target component.
307
- */
308
- oExternalAppData: {
309
- /**
310
- * Object containing the current ui state of the app which will be forwarded to the target component.
311
- */
312
- presentationVariant?: object;
313
- /**
314
- * Object containing value descriptions which will be forwarded to the target component.
315
- */
316
- valueTexts?: object;
317
- /**
318
- * Stringified JSON object, which will be forwarded to the target component. If not provided the selectionVariant
319
- * will be constructed based on the vNavigationParameters.
320
- */
321
- selectionVariant?: object;
322
- },
323
- /**
324
- * Argument is used to overwrite the FLP-configured target for opening a URL. If used, only the `explace`
325
- * or `inplace` values are allowed. Any other value will lead to an exception `NavigationHandler.INVALID_NAV_MODE`.
326
- */
327
- sNavMode?: string
328
- ): void;
329
- /**
330
- * Triggers a cross-app navigation after saving the inner and the cross-app states. The navigation mode
331
- * based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state will
332
- * not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad default
333
- * navigation for opening a URL in-place or ex-place.
334
- */
335
- static navigate(
336
- /**
337
- * Name of the semantic object of the target app
338
- */
339
- sSemanticObject: string,
340
- /**
341
- * Name of the action of the target app
342
- */
343
- sActionName: string,
344
- /**
345
- * Navigation parameters as an object with key/value pairs or as a string representation of such an object.
346
- * If passed as an object, the properties are not checked against the `IsPotentialSensitive` or `Measure`
347
- * type.
348
- */
349
- vNavigationParameters: object | string,
350
- /**
351
- * Callback that is called if an error occurs during navigation
352
- */
353
- fnOnError: Function,
354
- /**
355
- * Object for storing the state which will be forwarded to the target component.
356
- */
357
- oExternalAppData: {
358
- /**
359
- * Object containing the current ui state of the app which will be forwarded to the target component.
360
- */
361
- presentationVariant?: object;
362
- /**
363
- * Object containing value descriptions which will be forwarded to the target component.
364
- */
365
- valueTexts?: object;
366
- /**
367
- * Stringified JSON object, which will be forwarded to the target component. If not provided the selectionVariant
368
- * will be constructed based on the vNavigationParameters.
369
- */
370
- selectionVariant?: object;
371
- },
372
- /**
373
- * Argument is used to overwrite the FLP-configured target for opening a URL. If used, only the `explace`
374
- * or `inplace` values are allowed. Any other value will lead to an exception `NavigationHandler.INVALID_NAV_MODE`.
375
- */
376
- sNavMode?: string
377
- ): void;
378
- /**
379
- * Triggers a cross-app navigation after saving the inner and the cross-app states. The navigation mode
380
- * based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state will
381
- * not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad default
382
- * navigation for opening a URL in-place or ex-place.
383
- */
384
- static navigate(
385
- /**
386
- * Name of the semantic object of the target app
387
- */
388
- sSemanticObject: string,
389
- /**
390
- * Name of the action of the target app
391
- */
392
- sActionName: string,
393
- /**
394
- * Object for storing current state of the app
395
- */
396
- oInnerAppData: {
397
- /**
398
- * Stringified JSON object as returned, for example, from getDataSuiteFormat() of the SmartFilterBar control
399
- */
400
- selectionVariant?: string;
401
- /**
402
- * ID of the SmartTable variant
403
- */
404
- tableVariantId?: string;
405
- /**
406
- * Object that can be used to store arbitrary data
407
- */
408
- customData?: object;
409
- /**
410
- * Object containing the current ui state of the app
411
- */
412
- presentationVariant?: object;
413
- /**
414
- * Object containing value descriptions
415
- */
416
- valueTexts?: object;
417
- /**
418
- * Object containing semanticDates filter information
419
- */
420
- semanticDates?: object;
421
- },
422
- /**
423
- * Callback that is called if an error occurs during navigation
424
- */
425
- fnOnError: Function,
426
- /**
427
- * Object for storing the state which will be forwarded to the target component.
428
- */
429
- oExternalAppData: {
430
- /**
431
- * Object containing the current ui state of the app which will be forwarded to the target component.
432
- */
433
- presentationVariant?: object;
434
- /**
435
- * Object containing value descriptions which will be forwarded to the target component.
436
- */
437
- valueTexts?: object;
438
- /**
439
- * Stringified JSON object, which will be forwarded to the target component. If not provided the selectionVariant
440
- * will be constructed based on the vNavigationParameters.
441
- */
442
- selectionVariant?: object;
443
- },
444
- /**
445
- * Argument is used to overwrite the FLP-configured target for opening a URL. If used, only the `explace`
446
- * or `inplace` values are allowed. Any other value will lead to an exception `NavigationHandler.INVALID_NAV_MODE`.
447
- */
448
- sNavMode?: string
449
- ): void;
450
- /**
451
- * Triggers a cross-app navigation after saving the inner and the cross-app states. The navigation mode
452
- * based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state will
453
- * not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad default
454
- * navigation for opening a URL in-place or ex-place.
455
- */
456
- static navigate(
457
- /**
458
- * Name of the semantic object of the target app
459
- */
460
- sSemanticObject: string,
461
- /**
462
- * Name of the action of the target app
463
- */
464
- sActionName: string,
465
- /**
466
- * Navigation parameters as an object with key/value pairs or as a string representation of such an object.
467
- * If passed as an object, the properties are not checked against the `IsPotentialSensitive` or `Measure`
468
- * type.
469
- */
470
- vNavigationParameters: object | string,
471
- /**
472
- * Object for storing the state which will be forwarded to the target component.
473
- */
474
- oExternalAppData: {
475
- /**
476
- * Object containing the current ui state of the app which will be forwarded to the target component.
477
- */
478
- presentationVariant?: object;
479
- /**
480
- * Object containing value descriptions which will be forwarded to the target component.
481
- */
482
- valueTexts?: object;
483
- /**
484
- * Stringified JSON object, which will be forwarded to the target component. If not provided the selectionVariant
485
- * will be constructed based on the vNavigationParameters.
486
- */
487
- selectionVariant?: object;
488
- },
489
- /**
490
- * Argument is used to overwrite the FLP-configured target for opening a URL. If used, only the `explace`
491
- * or `inplace` values are allowed. Any other value will lead to an exception `NavigationHandler.INVALID_NAV_MODE`.
492
- */
493
- sNavMode?: string
494
- ): void;
495
- /**
496
- * Triggers a cross-app navigation after saving the inner and the cross-app states. The navigation mode
497
- * based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state will
498
- * not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad default
499
- * navigation for opening a URL in-place or ex-place.
500
- */
501
- static navigate(
502
- /**
503
- * Name of the semantic object of the target app
504
- */
505
- sSemanticObject: string,
506
- /**
507
- * Name of the action of the target app
508
- */
509
- sActionName: string,
510
- /**
511
- * Object for storing current state of the app
512
- */
513
- oInnerAppData: {
514
- /**
515
- * Stringified JSON object as returned, for example, from getDataSuiteFormat() of the SmartFilterBar control
516
- */
517
- selectionVariant?: string;
518
- /**
519
- * ID of the SmartTable variant
520
- */
521
- tableVariantId?: string;
522
- /**
523
- * Object that can be used to store arbitrary data
524
- */
525
- customData?: object;
526
- /**
527
- * Object containing the current ui state of the app
528
- */
529
- presentationVariant?: object;
530
- /**
531
- * Object containing value descriptions
532
- */
533
- valueTexts?: object;
534
- /**
535
- * Object containing semanticDates filter information
536
- */
537
- semanticDates?: object;
538
- },
539
- /**
540
- * Object for storing the state which will be forwarded to the target component.
541
- */
542
- oExternalAppData: {
543
- /**
544
- * Object containing the current ui state of the app which will be forwarded to the target component.
545
- */
546
- presentationVariant?: object;
547
- /**
548
- * Object containing value descriptions which will be forwarded to the target component.
549
- */
550
- valueTexts?: object;
551
- /**
552
- * Stringified JSON object, which will be forwarded to the target component. If not provided the selectionVariant
553
- * will be constructed based on the vNavigationParameters.
554
- */
555
- selectionVariant?: object;
556
- },
557
- /**
558
- * Argument is used to overwrite the FLP-configured target for opening a URL. If used, only the `explace`
559
- * or `inplace` values are allowed. Any other value will lead to an exception `NavigationHandler.INVALID_NAV_MODE`.
560
- */
561
- sNavMode?: string
562
- ): void;
563
- /**
564
- * Triggers a cross-app navigation after saving the inner and the cross-app states. The navigation mode
565
- * based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state will
566
- * not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad default
567
- * navigation for opening a URL in-place or ex-place.
568
- */
569
- static navigate(
570
- /**
571
- * Name of the semantic object of the target app
572
- */
573
- sSemanticObject: string,
574
- /**
575
- * Name of the action of the target app
576
- */
577
- sActionName: string,
578
- /**
579
- * Callback that is called if an error occurs during navigation
580
- */
581
- fnOnError: Function,
582
- /**
583
- * Object for storing the state which will be forwarded to the target component.
584
- */
585
- oExternalAppData: {
586
- /**
587
- * Object containing the current ui state of the app which will be forwarded to the target component.
588
- */
589
- presentationVariant?: object;
590
- /**
591
- * Object containing value descriptions which will be forwarded to the target component.
592
- */
593
- valueTexts?: object;
594
- /**
595
- * Stringified JSON object, which will be forwarded to the target component. If not provided the selectionVariant
596
- * will be constructed based on the vNavigationParameters.
597
- */
598
- selectionVariant?: object;
599
- },
600
- /**
601
- * Argument is used to overwrite the FLP-configured target for opening a URL. If used, only the `explace`
602
- * or `inplace` values are allowed. Any other value will lead to an exception `NavigationHandler.INVALID_NAV_MODE`.
603
- */
604
- sNavMode?: string
605
- ): void;
606
- /**
607
- * Triggers a cross-app navigation after saving the inner and the cross-app states. The navigation mode
608
- * based on `sap-ushell-next-navmode` is taken into account. If set to `explace` the inner app state will
609
- * not be changed. **Note:** The `sNavMode` argument can be used to overwrite the SAP Fiori launchpad default
610
- * navigation for opening a URL in-place or ex-place.
611
- */
612
- static navigate(
613
- /**
614
- * Name of the semantic object of the target app
615
- */
616
- sSemanticObject: string,
617
- /**
618
- * Name of the action of the target app
619
- */
620
- sActionName: string,
621
- /**
622
- * Object for storing the state which will be forwarded to the target component.
623
- */
624
- oExternalAppData: {
625
- /**
626
- * Object containing the current ui state of the app which will be forwarded to the target component.
627
- */
628
- presentationVariant?: object;
629
- /**
630
- * Object containing value descriptions which will be forwarded to the target component.
631
- */
632
- valueTexts?: object;
633
- /**
634
- * Stringified JSON object, which will be forwarded to the target component. If not provided the selectionVariant
635
- * will be constructed based on the vNavigationParameters.
636
- */
637
- selectionVariant?: object;
638
- },
639
- /**
640
- * Argument is used to overwrite the FLP-configured target for opening a URL. If used, only the `explace`
641
- * or `inplace` values are allowed. Any other value will lead to an exception `NavigationHandler.INVALID_NAV_MODE`.
642
- */
643
- sNavMode?: string
644
- ): void;
645
- /**
646
- * Parses the incoming URL and returns a Promise. If this method detects a back navigation, the inner app
647
- * state is returned in the resolved Promise. Otherwise startup parameters will be merged into the app state
648
- * provided by cross app navigation, and a combined app state will be returned. The conflict resolution
649
- * can be influenced with sParamHandlingMode defined in the constructor.
650
- */
651
- static parseNavigation(): object;
652
- /**
653
- * Processes navigation-related tasks related to beforePopoverOpens event handling for the SmartLink control
654
- * and returns a Promise object. In particular, the following tasks are performed before the SmartLink popover
655
- * can be opened:
656
- * - If `mInnerAppData` is provided, this inner app state is saved for back navigation at a later time.
657
- *
658
- * - The table event parameters (semantic attributes) and the selection variant data are combined by calling
659
- * the method {@link #.mixAttributesAndSelectionVariant mixAttributesAndSelectionVariant}.
660
- * - The combined data is saved as the cross app state to be handed over to the target app, and the corresponding
661
- * sap-xapp-state key is set in the URL.
662
- * - All single selections ("including equal") of the combined selection data are passed to the SmartLink
663
- * popover as semantic attributes.
664
- * - The method `oTableEventParameters.open()` is called. Note that this does not really open the popover,
665
- * but the SmartLink control proceeds with firing the event `navigationTargetsObtained`. .
666
- */
667
- static processBeforeSmartLinkPopoverOpens(
668
- /**
669
- * The parameters made available by the SmartTable control when the SmartLink control has been clicked,
670
- * an instance of a PopOver object
671
- */
672
- oTableEventParameters: object,
673
- /**
674
- * Stringified JSON object as returned, for example, from getDataSuiteFormat() of the SmartFilterBar control
675
- */
676
- sSelectionVariant: string,
677
- /**
678
- * Object containing the current state of the app. If provided, opening the Popover is deferred until the
679
- * inner app data is saved in a consistent way.
680
- */
681
- mInnerAppData?: {
682
- /**
683
- * Stringified JSON object as returned, for example, from getDataSuiteFormat() of the the SmartFilterBar
684
- * control; if provided, the selection is merged into the semantic attributes
685
- */
686
- selectionVariant?: string;
687
- /**
688
- * ID of the SmartTable variant
689
- */
690
- tableVariantId?: string;
691
- /**
692
- * Object that can be used to store additional app-specific data
693
- */
694
- customData?: object;
695
- /**
696
- * Object containing the current ui presentationVariantof the app
697
- */
698
- presentationVariant?: object;
699
- /**
700
- * Object containing value descriptions
701
- */
702
- valueTexts?: object;
703
- /**
704
- * Object containing semanticDates filter information
705
- */
706
- semanticDates?: object;
707
- },
708
- /**
709
- * Object containing the state which will be passed to the target screen.
710
- */
711
- oExternalAppData?: {
712
- /**
713
- * Object containing selectionVariant, which will be passed to the target screen. If not set the sSelectionVariant
714
- * will be used.
715
- */
716
- selectionVariant?: object;
717
- /**
718
- * Object containing the current ui presentationVariant of the app, which will be passed to the target screen
719
- */
720
- presentationVariant?: object;
721
- /**
722
- * Object containing value descriptions, which will be passed to the target screen
723
- */
724
- valueTexts?: object;
725
- }
726
- ): object;
727
- /**
728
- * Changes the URL according to the current sAppStateKey. As an reaction route change event will be triggered.
729
- */
730
- static replaceHash(
731
- /**
732
- * The new app state key.
733
- */
734
- sAppStateKey: string
735
- ): void;
736
- /**
737
- * Sets the model that is used for verification of sensitive information. If the model is not set, the unnamed
738
- * component model is used for the verification of sensitive information.
739
- */
740
- static setModel(
741
- /**
742
- * For checking sensitive information
743
- */
744
- oModel: sap.ui.model.odata.v2.ODataModel
745
- ): void;
746
- /**
747
- * Sets the application specific technical parameters. Technical parameters will not be added to the selection
748
- * variant passed to the application. As a default the following values are considered as technical parameters:
749
- *
750
- * - `sap-system`
751
- * - `sap-ushell-defaultedParameterNames`
752
- * - `"hcpApplicationId"` .
753
- */
754
- static setTechnicalParameters(
755
- /**
756
- * List of parameter names to be considered as technical parameters. `null` or `undefined` may be used to
757
- * reset the complete list.
758
- */
759
- aTechnicalParameters: any[]
760
- ): void;
761
- /**
762
- * Changes the URL according to the current app state and stores the app state for later retrieval.
763
- */
764
- static storeInnerAppState(
765
- /**
766
- * Object containing the current state of the app
767
- */
768
- mInnerAppData: {
769
- /**
770
- * Stringified JSON object as returned, for example, from getDataSuiteFormat() of the SmartFilterBar control
771
- */
772
- selectionVariant: string;
773
- /**
774
- * ID of the SmartTable variant
775
- */
776
- tableVariantId?: string;
777
- /**
778
- * Object that can be used to store additional app-specific data
779
- */
780
- customData?: object;
781
- /**
782
- * Object containing the current ui state of the app
783
- */
784
- presentationVariant?: object;
785
- /**
786
- * Object containing value descriptions
787
- */
788
- valueTexts?: object;
789
- /**
790
- * Object containing semanticDates filter information
791
- */
792
- semanticDates?: object;
793
- },
794
- /**
795
- * If set to false, the inner app hash will not be replaced until storing is successful; do not set to false
796
- * if you cannot react to the resolution of the Promise, for example, when calling the beforeLinkPressed
797
- * event
798
- */
799
- bImmediateHashReplace?: boolean
800
- ): object;
801
- /**
802
- * Changes the URL according to the current app state and stores the app state for later retrieval.
803
- */
804
- static storeInnerAppStateWithImmediateReturn(
805
- /**
806
- * Object containing the current state of the app
807
- */
808
- mInnerAppData: {
809
- /**
810
- * Stringified JSON object as returned, for example, from getDataSuiteFormat() of the SmartFilterBar control
811
- */
812
- selectionVariant: string;
813
- /**
814
- * ID of the SmartTable variant
815
- */
816
- tableVariantId?: string;
817
- /**
818
- * Object that can be used to store additional app-specific data
819
- */
820
- customData?: object;
821
- /**
822
- * Object containing the current ui state of the app
823
- */
824
- presentationVariant?: object;
825
- /**
826
- * Object containing value descriptions
827
- */
828
- valueTexts?: object;
829
- /**
830
- * Object containing semanticDates filter information
831
- */
832
- semanticDates?: object;
833
- },
834
- /**
835
- * If set to false, the inner app hash will not be replaced until storing is successful; do not set to false
836
- * if you cannot react to the resolution of the Promise, for example, when calling the beforeLinkPressed
837
- * event. **Note:**If not provided it will be treated as set to false. **Note:**If set to true, the calling
838
- * instance has to ensure that a follow-on call to `replaceHash` will take place!
839
- */
840
- bImmediateHashReplace?: boolean
841
- ): object;
842
- }
843
- /**
844
- * @SINCE 1.83.0
845
- *
846
- * This is the successor of {@link sap.ui.generic.app.navigation.service.PresentationVariant}.
847
- * Creates a new instance of a PresentationVariant class. If no parameter is passed, an new empty instance
848
- * is created whose ID has been set to `""`. Passing a JSON-serialized string complying to the Selection
849
- * Variant Specification will parse it, and the newly created instance will contain the same information.
850
- */
851
- class PresentationVariant extends sap.ui.base.Object {
852
- constructor(
853
- /**
854
- * If of type `string`, the selection variant is JSON-formatted; if of type `object`, the object represents
855
- * a selection variant
856
- */
857
- vPresentationVariant?: string | object
858
- );
859
-
860
- /**
861
- * Creates a new subclass of class sap.fe.navigation.PresentationVariant with name `sClassName` and enriches
862
- * it with the information contained in `oClassInfo`.
863
58
  *
864
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
865
- */
866
- static extend<T extends Record<string, unknown>>(
867
- /**
868
- * Name of the class being created
869
- */
870
- sClassName: string,
871
- /**
872
- * Object literal with information about the class
873
- */
874
- oClassInfo?: sap.ClassInfo<T, sap.fe.navigation.PresentationVariant>,
875
- /**
876
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
877
- * used by this class
878
- */
879
- FNMetaImpl?: Function
880
- ): Function;
881
- /**
882
- * Gets the chart visualization property.
883
- */
884
- static getChartVisualization(): Record<string, any>;
885
- /**
886
- * Gets the current context URL intended for the query.
887
- */
888
- static getContextUrl(): string;
889
- /**
890
- * Returns the identification of the selection variant.
891
- */
892
- static getID(): string;
893
- /**
894
- * Returns a metadata object for class sap.fe.navigation.PresentationVariant.
59
+ * @returns Metadata object describing this class
895
60
  */
896
61
  static getMetadata(): sap.ui.base.Metadata;
897
62
  /**
898
- * Gets the more trivial properties. Basically all properties with the exception of the Visualization.
899
- */
900
- static getProperties(): Record<string, any>;
901
- /**
902
- * Gets the table visualization property.
903
- */
904
- static getTableVisualization(): Record<string, any>;
905
- /**
906
- * Returns the current text / description of this selection variant.
907
- */
908
- static getText(): string;
909
- /**
910
- * Returns `true` if the presentation variant does not contain any properties. nor ranges.
911
- */
912
- static isEmpty(): boolean;
913
- /**
914
- * Sets the chart visualization property.
915
- */
916
- static setChartVisualization(
917
- /**
918
- * An object containing the properties to be used for the chart visualization.
919
- */
920
- mProperties: Record<string, any>
921
- ): void;
922
- /**
923
- * Sets the context URL.
924
- */
925
- static setContextUrl(
926
- /**
927
- * The URL of the context
928
- */
929
- sURL: string
930
- ): void;
931
- /**
932
- * Sets the identification of the selection variant.
933
- */
934
- static setID(
935
- /**
936
- * The new identification of the selection variant
937
- */
938
- sId: string
939
- ): void;
940
- /**
941
- * Sets the more trivial properties. Basically all properties with the exception of the Visualization.
942
- */
943
- static setProperties(
944
- /**
945
- * The properties to be used.
946
- */
947
- mProperties: Record<string, any>
948
- ): void;
949
- /**
950
- * Sets the table visualization property.
951
- */
952
- static setTableVisualization(
953
- /**
954
- * An object containing the properties to be used for the table visualization.
955
- */
956
- mProperties: Record<string, any>
957
- ): void;
958
- /**
959
- * Sets the text / description of the selection variant.
960
- */
961
- static setText(
962
- /**
963
- * The new description to be used
964
- */
965
- sNewText: string
966
- ): void;
967
- /**
968
- * Returns the external representation of the selection variant as JSON object.
969
- */
970
- static toJSONObject(): object;
971
- /**
972
- * Serializes this instance into a JSON-formatted string.
973
- */
974
- static toJSONString(): string;
975
- }
976
- /**
977
- * @SINCE 1.83.0
978
- *
979
- * This is the successor of {@link sap.ui.generic.app.navigation.service.SelectionVariant}.
980
- * Creates a new instance of a SelectionVariant class. If no parameter is passed, an new empty instance
981
- * is created whose ID has been set to `""`. Passing a JSON-serialized string complying to the Selection
982
- * Variant Specification will parse it, and the newly created instance will contain the same information.
983
- */
984
- class SelectionVariant extends sap.ui.base.Object {
985
- constructor(
986
- /**
987
- * If of type `string`, the selection variant is JSON-formatted; if of type `object`, the object represents
988
- * a selection variant
989
- */
990
- vSelectionVariant?: string | object
991
- );
992
-
993
- /**
994
- * Sets the value of a parameter called `sName` to the new value `sValue`. If the parameter has already
995
- * been set before, its value is overwritten.
996
- */
997
- static addParameter(
998
- /**
999
- * The name of the parameter to be set; the `null` value is not allowed
1000
- */
1001
- sName: string,
1002
- /**
1003
- * The value of the parameter to be set
1004
- */
1005
- sValue: string
1006
- ): object;
1007
- /**
1008
- * Adds a new range to the list of select options for a given parameter.
1009
- */
1010
- static addSelectOption(
1011
- /**
1012
- * The name of the property for which the selection range is added
1013
- */
1014
- sPropertyName: string,
1015
- /**
1016
- * The sign of the range (**I**nclude or **E**xclude)
1017
- */
1018
- sSign: string,
1019
- /**
1020
- * The option of the range (**EQ** for "equals", **NE** for "not equals", **LE** for "less or equals", **GE**
1021
- * for "greater or equals", **LT** for "less than" (and not equals), **GT** for "greater than" (and not
1022
- * equals), **BT** for "between", or **CP** for "contains pattern" (ABAP-styled pattern matching with the
1023
- * asterisk as wildcard)
1024
- */
1025
- sOption: string,
1026
- /**
1027
- * The single value or the lower boundary of the interval; the `null` value is not allowed
1028
- */
1029
- sLow: string,
1030
- /**
1031
- * Set only if sOption is **BT**: the upper boundary of the interval; must be `undefined` or `null` in all
1032
- * other cases
1033
- */
1034
- sHigh?: string
1035
- ): object;
1036
- /**
1037
- * Creates a new subclass of class sap.fe.navigation.SelectionVariant with name `sClassName` and enriches
1038
- * it with the information contained in `oClassInfo`.
63
+ * Returns the error code with which the instance has been created.
1039
64
  *
1040
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
1041
- */
1042
- static extend<T extends Record<string, unknown>>(
1043
- /**
1044
- * Name of the class being created
1045
- */
1046
- sClassName: string,
1047
- /**
1048
- * Object literal with information about the class
1049
- */
1050
- oClassInfo?: sap.ClassInfo<T, sap.fe.navigation.SelectionVariant>,
1051
- /**
1052
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1053
- * used by this class
1054
- */
1055
- FNMetaImpl?: Function
1056
- ): Function;
1057
- /**
1058
- * Gets the current context URL intended for the filters.
1059
- */
1060
- static getFilterContextUrl(): string;
1061
- /**
1062
- * Returns the identification of the selection variant.
1063
- */
1064
- static getID(): string;
1065
- /**
1066
- * Returns a metadata object for class sap.fe.navigation.SelectionVariant.
1067
- */
1068
- static getMetadata(): sap.ui.base.Metadata;
1069
- /**
1070
- * Returns the value of the parameter called `sName` if it has been set. If the parameter has never been
1071
- * set or has been removed, `undefined` is returned.
65
+ * @returns The error code of the error
1072
66
  */
1073
- static getParameter(
1074
- /**
1075
- * The name of the parameter to be returned
1076
- */
1077
- sName: string
1078
- ): string;
1079
- /**
1080
- * Gets the current context URL intended for the parameters.
1081
- */
1082
- static getParameterContextUrl(): string;
1083
- /**
1084
- * Returns the set of parameter names available in this selection variant.
1085
- */
1086
- static getParameterNames(): any[];
1087
- /**
1088
- * Returns the names of the parameter and select option properties available for this instance.
1089
- */
1090
- static getPropertyNames(): any[];
1091
- /**
1092
- * Returns the set of select options/ranges available for a given property name.
1093
- */
1094
- static getSelectOption(
1095
- /**
1096
- * The name of the property for which the set of select options/ranges is returned
1097
- */
1098
- sPropertyName: string
1099
- ): any[];
1100
- /**
1101
- * Returns the names of the properties available for this instance.
1102
- */
1103
- static getSelectOptionsPropertyNames(): any[];
1104
- /**
1105
- * Returns the current text / description of this selection variant.
1106
- */
1107
- static getText(): string;
1108
- /**
1109
- * First tries to retrieve the set of select options/ranges available for `sName` as property name. If successful,
1110
- * this array of selections is being returned. If it fails, an attempt to find a parameter, whose name is
1111
- * `sName`, is made. If the latter succeeds, the single value is converted to fit into an array of selections
1112
- * to make it type compatible with ranges. This array is then returned. If neither a select option
1113
- * nor a parameter could be found, `undefined` is returned.
1114
- */
1115
- static getValue(
1116
- /**
1117
- * The name of the attribute for which the value is retrieved
1118
- */
1119
- sName: string
1120
- ): any[];
1121
- /**
1122
- * Returns `true` if the selection variant does neither contain parameters nor ranges.
1123
- */
1124
- static isEmpty(): boolean;
1125
- /**
1126
- * Adds a set of select options to the list of select options for a given parameter.
1127
- */
1128
- static massAddSelectOption(
1129
- /**
1130
- * The name of the property for which the set of select options is added
1131
- */
1132
- sPropertyName: string,
1133
- /**
1134
- * Set of select options to be added
1135
- */
1136
- aSelectOptions: any[]
1137
- ): object;
1138
- /**
1139
- * Removes a parameter called `sName` from the selection variant.
1140
- */
1141
- static removeParameter(
1142
- /**
1143
- * The name of the parameter to be removed
1144
- */
1145
- sName: string
1146
- ): object;
1147
- /**
1148
- * Removes a select option called `sName` from the selection variant.
1149
- */
1150
- static removeSelectOption(
1151
- /**
1152
- * The name of the select option to be removed
1153
- */
1154
- sName: string
1155
- ): object;
1156
- /**
1157
- * Renames a parameter called `sNameOld` to `sNameNew`. If a parameter or a select option with the name
1158
- * `sNameNew` already exist, an error is thrown. If a parameter with the name `sNameOld` does not exist,
1159
- * nothing is changed.
1160
- */
1161
- static renameParameter(
1162
- /**
1163
- * The current name of the parameter to be renamed
1164
- */
1165
- sNameOld: string,
1166
- /**
1167
- * The new name of the parameter
1168
- */
1169
- sNameNew: string
1170
- ): object;
1171
- /**
1172
- * Renames a select option called `sNameOld` to `sNameNew`. If a select option or a parameter with the name
1173
- * `sNameNew` already exist, an error is thrown. If a select option with the name `sNameOld` does not exist,
1174
- * nothing is changed.
1175
- */
1176
- static renameSelectOption(
1177
- /**
1178
- * The current name of the select option property to be renamed
1179
- */
1180
- sNameOld: string,
1181
- /**
1182
- * The new name of the select option property
1183
- */
1184
- sNameNew: string
1185
- ): object;
1186
- /**
1187
- * Sets the context URL intended for the filters.
1188
- */
1189
- static setFilterContextUrl(
1190
- /**
1191
- * The URL of the filters
1192
- */
1193
- sURL: string
1194
- ): void;
1195
- /**
1196
- * Sets the identification of the selection variant.
1197
- */
1198
- static setID(
1199
- /**
1200
- * The new identification of the selection variant
1201
- */
1202
- sId: string
1203
- ): void;
1204
- /**
1205
- * Sets the context URL intended for the parameters.
1206
- */
1207
- static setParameterContextUrl(
1208
- /**
1209
- * The URL of the parameter context
1210
- */
1211
- sURL: string
1212
- ): void;
1213
- /**
1214
- * Sets the text / description of the selection variant.
1215
- */
1216
- static setText(
1217
- /**
1218
- * The new description to be used
1219
- */
1220
- sNewText: string
1221
- ): void;
1222
- /**
1223
- * Returns the external representation of the selection variant as JSON object.
1224
- */
1225
- static toJSONObject(): object;
1226
- /**
1227
- * Serializes this instance into a JSON-formatted string.
1228
- */
1229
- static toJSONString(): string;
67
+ getErrorCode(): string;
1230
68
  }
1231
69
  /**
1232
70
  * @SINCE 1.83.0
@@ -1266,11 +104,5 @@ declare namespace sap {
1266
104
  "sap/fe/navigation/library": undefined;
1267
105
 
1268
106
  "sap/fe/navigation/NavError": undefined;
1269
-
1270
- "sap/fe/navigation/NavigationHandler": undefined;
1271
-
1272
- "sap/fe/navigation/PresentationVariant": undefined;
1273
-
1274
- "sap/fe/navigation/SelectionVariant": undefined;
1275
107
  }
1276
108
  }