@sapui5/ts-types 1.103.1 → 1.104.2

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