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