@sapui5/types 1.141.4 → 1.142.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/types/index.d.ts +1 -0
- package/types/sap.apf.d.ts +1 -1
- package/types/sap.ca.ui.d.ts +1 -1
- package/types/sap.chart.d.ts +1 -1
- package/types/sap.collaboration.d.ts +1 -1
- package/types/sap.cux.base.d.ts +3 -0
- package/types/sap.esh.search.ui.d.ts +159 -4
- package/types/sap.f.d.ts +1 -1
- package/types/sap.fe.ariba.d.ts +1 -1
- package/types/sap.fe.base.d.ts +1 -1
- package/types/sap.fe.controls.d.ts +1 -1
- package/types/sap.fe.core.d.ts +471 -32
- package/types/sap.fe.ina.d.ts +1 -1
- package/types/sap.fe.macros.d.ts +2616 -95
- package/types/sap.fe.navigation.d.ts +2 -2
- package/types/sap.fe.placeholder.d.ts +1 -1
- package/types/sap.fe.plugins.managecache.d.ts +1 -1
- package/types/sap.fe.templates.d.ts +79 -11
- package/types/sap.fe.test.d.ts +8 -1
- package/types/sap.fe.tools.d.ts +1 -1
- package/types/sap.feedback.ui.d.ts +1 -1
- package/types/sap.gantt.d.ts +4 -1
- package/types/sap.insights.d.ts +1 -1
- package/types/sap.m.d.ts +401 -55
- package/types/sap.makit.d.ts +1 -1
- package/types/sap.me.d.ts +1 -1
- package/types/sap.ndc.d.ts +106 -2
- package/types/sap.ovp.d.ts +1 -1
- package/types/sap.rules.ui.d.ts +1 -1
- package/types/sap.sac.df.d.ts +13 -3735
- package/types/sap.suite.ui.commons.d.ts +1 -1
- package/types/sap.suite.ui.generic.template.d.ts +28 -1
- package/types/sap.suite.ui.microchart.d.ts +1 -1
- package/types/sap.tnt.d.ts +1 -1
- package/types/sap.ui.codeeditor.d.ts +1 -1
- package/types/sap.ui.commons.d.ts +1 -1
- package/types/sap.ui.comp.d.ts +77 -9
- package/types/sap.ui.core.d.ts +1160 -639
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.export.d.ts +63 -1
- package/types/sap.ui.fl.d.ts +1 -1
- package/types/sap.ui.generic.app.d.ts +1 -1
- package/types/sap.ui.generic.template.d.ts +1 -1
- package/types/sap.ui.integration.d.ts +1 -1
- package/types/sap.ui.layout.d.ts +100 -94
- package/types/sap.ui.mdc.d.ts +1505 -167
- package/types/sap.ui.richtexteditor.d.ts +1 -1
- package/types/sap.ui.rta.d.ts +1 -1
- package/types/sap.ui.suite.d.ts +1 -1
- package/types/sap.ui.support.d.ts +1 -1
- package/types/sap.ui.table.d.ts +13 -41
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +34 -78
- package/types/sap.ui.ux3.d.ts +1 -1
- package/types/sap.ui.vbm.d.ts +1 -1
- package/types/sap.ui.vk.d.ts +1 -1
- package/types/sap.ui.vtm.d.ts +1 -1
- package/types/sap.ui.webc.common.d.ts +1 -1
- package/types/sap.ui.webc.fiori.d.ts +1 -1
- package/types/sap.ui.webc.main.d.ts +1 -1
- package/types/sap.uiext.inbox.d.ts +1 -1
- package/types/sap.ushell.d.ts +13 -1
- package/types/sap.ushell_abap.d.ts +1 -1
- package/types/sap.uxap.d.ts +1 -1
- package/types/sap.viz.d.ts +1 -1
- package/types/sap.webanalytics.core.d.ts +1 -1
- package/types/sap.zen.commons.d.ts +335 -1
- package/types/sap.zen.crosstab.d.ts +1 -1
- package/types/sap.zen.dsh.d.ts +1 -1
package/types/sap.ui.core.d.ts
CHANGED
|
@@ -279,7 +279,7 @@ declare namespace sap {
|
|
|
279
279
|
"sap/ui/thirdparty/qunit-2": undefined;
|
|
280
280
|
}
|
|
281
281
|
}
|
|
282
|
-
// For Library Version: 1.
|
|
282
|
+
// For Library Version: 1.142.0
|
|
283
283
|
|
|
284
284
|
declare module "sap/base/assert" {
|
|
285
285
|
/**
|
|
@@ -6702,6 +6702,7 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
|
|
|
6702
6702
|
* provided via `treeAnnotationProperties.hierarchyNodeDescendantCountFor`
|
|
6703
6703
|
* - The `"hierarchy-preorder-rank-for"` annotation must be present in the service metadata or provided
|
|
6704
6704
|
* via `treeAnnotationProperties.hierarchyPreorderRankFor`
|
|
6705
|
+
* - The hierarchy maintenance is performed on the client side
|
|
6705
6706
|
*/
|
|
6706
6707
|
restoreTreeStateAfterChange?: boolean;
|
|
6707
6708
|
/**
|
|
@@ -8192,6 +8193,10 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
|
|
|
8192
8193
|
* If the `changeBatchGroup` for the changed entity type is set to {@link #setDeferredGroups deferred},
|
|
8193
8194
|
* changes could be submitted with {@link #submitChanges}. Otherwise the change will be submitted directly.
|
|
8194
8195
|
*
|
|
8196
|
+
* Consecutive calls of this method which update bindings ***synchronously*** may cause performance issues;
|
|
8197
|
+
* see {@link https://ui5.sap.com/#/topic/6c47b2b39db9404582994070ec3d57a2#loioadd47c3966dd40489e952bb4f5f74a7c Accessing Data from an OData Model }
|
|
8198
|
+
* for details.
|
|
8199
|
+
*
|
|
8195
8200
|
*
|
|
8196
8201
|
* @returns `true` if the value was set correctly and `false` if errors occurred like the entry was not
|
|
8197
8202
|
* found or another entry was already updated.
|
|
@@ -8210,7 +8215,7 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
|
|
|
8210
8215
|
*/
|
|
8211
8216
|
oContext?: Context,
|
|
8212
8217
|
/**
|
|
8213
|
-
* Whether to update
|
|
8218
|
+
* Whether to update bindings dependent on this property asynchronously
|
|
8214
8219
|
*/
|
|
8215
8220
|
bAsyncUpdate?: boolean
|
|
8216
8221
|
): boolean;
|
|
@@ -10176,6 +10181,508 @@ declare module "sap/ui/test/opaQunit" {
|
|
|
10176
10181
|
): void;
|
|
10177
10182
|
}
|
|
10178
10183
|
|
|
10184
|
+
declare module "sap/ui/test/starter/config" {
|
|
10185
|
+
import { URI } from "sap/ui/core/library";
|
|
10186
|
+
|
|
10187
|
+
/**
|
|
10188
|
+
* Code coverage options.
|
|
10189
|
+
*
|
|
10190
|
+
* The qunit-coverage/qunit-coverage-istanbul module is always loaded after QUnit has been loaded to enable
|
|
10191
|
+
* the coverage option. When the 'coverage' parameter is set in the URL (e.g. because the `coverage` checkbox
|
|
10192
|
+
* has been clicked), then "blanket" (if Istanbul is not used instead) is loaded before qunit-coverage to
|
|
10193
|
+
* avoid its synchronous loading. The `instrumenter` property identifies which tool for code coverage should
|
|
10194
|
+
* be used. If "auto" is chosen, a check determines whether Istanbul and its middleware are available, and
|
|
10195
|
+
* if so, they are loaded. Otherwise, "blanket" is used as a fallback.
|
|
10196
|
+
*
|
|
10197
|
+
* The following default coverage configuration is applied:
|
|
10198
|
+
*
|
|
10199
|
+
*
|
|
10200
|
+
* ```javascript
|
|
10201
|
+
*
|
|
10202
|
+
* {
|
|
10203
|
+
* only: null,
|
|
10204
|
+
* never: null,
|
|
10205
|
+
* branchTracking: false,
|
|
10206
|
+
* instrumenter: "auto"
|
|
10207
|
+
* }
|
|
10208
|
+
* ```
|
|
10209
|
+
*/
|
|
10210
|
+
export type CoverageConfiguration = {
|
|
10211
|
+
/**
|
|
10212
|
+
* List of modules or packages that should be instrumented. If not given, all modules are instrumented.
|
|
10213
|
+
* Default is null
|
|
10214
|
+
*/
|
|
10215
|
+
only?: string[];
|
|
10216
|
+
/**
|
|
10217
|
+
* List of modules or packages that never should be instrumented. Default is null
|
|
10218
|
+
*/
|
|
10219
|
+
never?: string[];
|
|
10220
|
+
|
|
10221
|
+
branchTracking?: boolean;
|
|
10222
|
+
/**
|
|
10223
|
+
* "auto" checks for istanbul middleware and loads istanbul instrumentation, otherwise blanket is used.
|
|
10224
|
+
* The other options set explicitly the desired instrumenter.
|
|
10225
|
+
*/
|
|
10226
|
+
instrumenter?: "auto" | "blanket" | "istanbul";
|
|
10227
|
+
};
|
|
10228
|
+
|
|
10229
|
+
/**
|
|
10230
|
+
* Describes what versions of QUnit are known to the test starter, which one to use for a test, and how
|
|
10231
|
+
* to configure it.
|
|
10232
|
+
*
|
|
10233
|
+
* Besides the documented properties, QUnit configuration options can be set as well. Currently supported
|
|
10234
|
+
* are `altertitle`, `collapse`, `filter`, `fixture`, `hidepassed`, `maxDepth`, `module`, `moduleId`, `notrycatch`,
|
|
10235
|
+
* `noglobals`, `seed`, `reorder`, `requireExpects`, `testId`, `testTimeout`, `scrolltop`.
|
|
10236
|
+
*
|
|
10237
|
+
* ## Default Configuration
|
|
10238
|
+
*
|
|
10239
|
+
* The following default QUnit configuration is applied:
|
|
10240
|
+
*
|
|
10241
|
+
*
|
|
10242
|
+
* ```javascript
|
|
10243
|
+
*
|
|
10244
|
+
* {
|
|
10245
|
+
* versions: {
|
|
10246
|
+
* 1: {
|
|
10247
|
+
* module: "sap/ui/thirdparty/qunit",
|
|
10248
|
+
* css: "sap/ui/thirdparty/qunit.css"
|
|
10249
|
+
* },
|
|
10250
|
+
* 2: {
|
|
10251
|
+
* module: "sap/ui/thirdparty/qunit-2",
|
|
10252
|
+
* css: "sap/ui/thirdparty/qunit-2.css"
|
|
10253
|
+
* },
|
|
10254
|
+
* edge: 2,
|
|
10255
|
+
* "true": "edge"
|
|
10256
|
+
* },
|
|
10257
|
+
* version: "edge"
|
|
10258
|
+
* }
|
|
10259
|
+
* ```
|
|
10260
|
+
*/
|
|
10261
|
+
export type QUnitConfiguration = {
|
|
10262
|
+
/**
|
|
10263
|
+
* Defines a set of available QUnit versions that the test starter can use.
|
|
10264
|
+
*
|
|
10265
|
+
* Allows for easier switch between different QUnit versions for tests by simply changing the `version`
|
|
10266
|
+
* property in the test configuration. The test starter then uses the versions map to find the correct files
|
|
10267
|
+
* for the requested version.
|
|
10268
|
+
*
|
|
10269
|
+
* The keys of this map can be used as values of the `version` property. The value can either be a `QUnitVersionInfo`
|
|
10270
|
+
* that names a JavaScript module and a CSS stylesheet resource for a QUnit version or it can be a reference
|
|
10271
|
+
* to another key (e.g. "edge" as an alias for a concrete version).
|
|
10272
|
+
*
|
|
10273
|
+
* By default, the map contains entries for the keys 1, 2, "edge" (same as 2) and "true" (same as "edge").
|
|
10274
|
+
* All predefined entries can be overridden in a testsuite or test.
|
|
10275
|
+
*/
|
|
10276
|
+
versions?: Record<string | number, string | number | QUnitVersionInfo>;
|
|
10277
|
+
/**
|
|
10278
|
+
* Version of QUnit that should be loaded.
|
|
10279
|
+
*
|
|
10280
|
+
* If set to a null, QUnit won't be loaded. If set to "edge", the newest available version of QUnit is used.
|
|
10281
|
+
* If set to a number, the corresponding major version of QUnit is used if supported. Currently supported
|
|
10282
|
+
* versions are 1 and 2. An error will be thrown for unsupported versions.
|
|
10283
|
+
*
|
|
10284
|
+
* Default is "edge"
|
|
10285
|
+
*/
|
|
10286
|
+
version?: null | false | int | "edge" | string;
|
|
10287
|
+
/**
|
|
10288
|
+
* Any valid QUnit configuration property
|
|
10289
|
+
*/
|
|
10290
|
+
[key: string]: any;
|
|
10291
|
+
};
|
|
10292
|
+
|
|
10293
|
+
/**
|
|
10294
|
+
* Describes the JavaScript and CSS resources of a certain QUnit version. Allows the test starter to start
|
|
10295
|
+
* a custom QUnit version not provided by the framework.
|
|
10296
|
+
*/
|
|
10297
|
+
export type QUnitVersionInfo = {
|
|
10298
|
+
/**
|
|
10299
|
+
* Module ID of the described QUnit version. Will be loaded with a sap.ui.require call when that QUnit version
|
|
10300
|
+
* is selected.
|
|
10301
|
+
*/
|
|
10302
|
+
module: string;
|
|
10303
|
+
/**
|
|
10304
|
+
* UI5 resource name of a CSS stylesheet that is loaded for the described QUnit version.
|
|
10305
|
+
*/
|
|
10306
|
+
css: string;
|
|
10307
|
+
};
|
|
10308
|
+
|
|
10309
|
+
/**
|
|
10310
|
+
* Describes what versions of Sinon are known to the test starter, which one to use for a test, and how
|
|
10311
|
+
* to configure it.
|
|
10312
|
+
*
|
|
10313
|
+
* For versions up to Sinon 4, further Sinon config options can be added and are copied into `sinon.config`.
|
|
10314
|
+
* Newer Sinon versions don't support such a config anymore. In Sinon 4, supported options are `injectIntoThis`,
|
|
10315
|
+
* `injectInto`, `properties`, `useFakeTimers`, `useFakeServer`
|
|
10316
|
+
*
|
|
10317
|
+
* The following default Sinon configuration is applied:
|
|
10318
|
+
*
|
|
10319
|
+
*
|
|
10320
|
+
* ```javascript
|
|
10321
|
+
*
|
|
10322
|
+
* {
|
|
10323
|
+
* versions: {
|
|
10324
|
+
* 1: {
|
|
10325
|
+
* module: "sap/ui/thirdparty/sinon",
|
|
10326
|
+
* bridge: "sap/ui/thirdparty/sinon-qunit"
|
|
10327
|
+
* },
|
|
10328
|
+
* 4: {
|
|
10329
|
+
* module: "sap/ui/thirdparty/sinon-4",
|
|
10330
|
+
* bridge: "sap/ui/qunit/sinon-qunit-bridge"
|
|
10331
|
+
* },
|
|
10332
|
+
* edge: 4,
|
|
10333
|
+
* "true": "edge"
|
|
10334
|
+
* },
|
|
10335
|
+
* version: "edge",
|
|
10336
|
+
* qunitBridge: true,
|
|
10337
|
+
* useFakeTimers: false,
|
|
10338
|
+
* useFakeServer: false
|
|
10339
|
+
* }
|
|
10340
|
+
* ```
|
|
10341
|
+
*/
|
|
10342
|
+
export type SinonConfiguration = {
|
|
10343
|
+
/**
|
|
10344
|
+
* Defines a set of available Sinon versions that the test starter can use.
|
|
10345
|
+
*
|
|
10346
|
+
* Allows for an easier switch between different Sinon versions for tests by simply changing the `version`
|
|
10347
|
+
* property in the test configuration. The test starter then uses the versions map to find the correct files
|
|
10348
|
+
* for the requested version.
|
|
10349
|
+
*
|
|
10350
|
+
* The keys of this map can be used as values of the `version` property. The value can either be a `SinonVersionInfo`
|
|
10351
|
+
* that names the JavaScript module for a Sinon version or it can be a reference to another key (e.g. "edge"
|
|
10352
|
+
* as an alias for a concrete version).
|
|
10353
|
+
*
|
|
10354
|
+
* By default, the map contains entries for the keys 1, 4, "edge" (same as 4) and "true" (same as "edge").
|
|
10355
|
+
* All predefined entries can be overridden in a testsuite or test.
|
|
10356
|
+
*/
|
|
10357
|
+
versions?: Record<string | number, string | number | SinonVersionInfo>;
|
|
10358
|
+
/**
|
|
10359
|
+
* Version of Sinon that should be loaded. Default: "edge"
|
|
10360
|
+
*
|
|
10361
|
+
* If set to null, Sinon won't be loaded. If set to "edge", the newest available version of Sinon is used.
|
|
10362
|
+
* If set to a number, the corresponding version of Sinon is used if supported. By default, supported versions
|
|
10363
|
+
* are 1 and 4. An error will be thrown for unsupported versions.
|
|
10364
|
+
*/
|
|
10365
|
+
version?: null | false | int | string;
|
|
10366
|
+
/**
|
|
10367
|
+
* Whether one of the sinon-qunit bridges is loaded.
|
|
10368
|
+
*
|
|
10369
|
+
* When set to true, the sap/ui/thirdparty/sinon-qunit bridge is loaded for Sinon 1 and the sap/ui/qunit/sinon-qunit-bridge
|
|
10370
|
+
* is loaded for newer versions of Sinon.
|
|
10371
|
+
*
|
|
10372
|
+
* The bridge is only loaded after both QUnit and Sinon have been loaded. If either QUnit or Sinon are not
|
|
10373
|
+
* loaded, no bridge is loaded.
|
|
10374
|
+
*
|
|
10375
|
+
* If Sinon is not loaded, but QUnit, the bridge will not be loaded, but a shim with dependencies will be
|
|
10376
|
+
* configured. This allows tests to load Sinon / the bridge on their own without taking care of the bridge
|
|
10377
|
+
* dependencies.
|
|
10378
|
+
*/
|
|
10379
|
+
qunitBridge?: boolean;
|
|
10380
|
+
/**
|
|
10381
|
+
* Any valid Sinon configuration property (up to Sinon version 4 at least)
|
|
10382
|
+
*/
|
|
10383
|
+
[key: string]: any;
|
|
10384
|
+
};
|
|
10385
|
+
|
|
10386
|
+
/**
|
|
10387
|
+
* Describes the JavaScript resource of a certain Sinon version. Allows the test starter to start a custom
|
|
10388
|
+
* Sinon version not provided by the framework.
|
|
10389
|
+
*/
|
|
10390
|
+
export type SinonVersionInfo = {
|
|
10391
|
+
/**
|
|
10392
|
+
* Module ID of the described Sinon version. Will be loaded with a sap.ui.require call when that Sinon version
|
|
10393
|
+
* is selected.
|
|
10394
|
+
*/
|
|
10395
|
+
module: string;
|
|
10396
|
+
/**
|
|
10397
|
+
* Module ID of a "bridge" that can integrate the Sinon version with QUnit, wrapping each test in a Sinon
|
|
10398
|
+
* sandbox. The bridge module will only be required by the test starter when the `qunitBridge` config option
|
|
10399
|
+
* of the test is set to true.
|
|
10400
|
+
*/
|
|
10401
|
+
bridge: string;
|
|
10402
|
+
};
|
|
10403
|
+
|
|
10404
|
+
export type SuiteConfiguration = {
|
|
10405
|
+
/**
|
|
10406
|
+
* Name of the test suite.
|
|
10407
|
+
*
|
|
10408
|
+
* This name is used as the title of the index page / testsuite page.
|
|
10409
|
+
*/
|
|
10410
|
+
name?: string;
|
|
10411
|
+
/**
|
|
10412
|
+
* An Object with default settings for all tests.
|
|
10413
|
+
*
|
|
10414
|
+
* The defaults and the test configuration are merged recursively in such a way that the merge contains
|
|
10415
|
+
* properties from both the defaults and the test config. If a property is defined by both config objects,
|
|
10416
|
+
* the value from the test config is used. There's no special handling for other types of values, e.g an
|
|
10417
|
+
* array value in the defaults is replaced by an array value in the test config.
|
|
10418
|
+
*
|
|
10419
|
+
* The test starter applies the following complete default configuration structure:
|
|
10420
|
+
*
|
|
10421
|
+
*
|
|
10422
|
+
* ```javascript
|
|
10423
|
+
*
|
|
10424
|
+
* {
|
|
10425
|
+
* name: null,
|
|
10426
|
+
* beforeBootstrap: null,
|
|
10427
|
+
* module: "./{name}.qunit",
|
|
10428
|
+
* page: "resources/sap/ui/test/starter/Test.qunit.html?testsuite={suite}&test={name}",
|
|
10429
|
+
* title: "QUnit tests '{name}' of suite '{suite}'",
|
|
10430
|
+
* qunit: "edge",
|
|
10431
|
+
* sinon: "edge",
|
|
10432
|
+
* coverage: {
|
|
10433
|
+
* only: null,
|
|
10434
|
+
* never: null,
|
|
10435
|
+
* branchTracking: false,
|
|
10436
|
+
* instrumenter: "auto"
|
|
10437
|
+
* },
|
|
10438
|
+
* ui5: {
|
|
10439
|
+
* bindingSyntax: "complex",
|
|
10440
|
+
* libs: []
|
|
10441
|
+
* },
|
|
10442
|
+
* bootCore: true,
|
|
10443
|
+
* autostart: true
|
|
10444
|
+
* }
|
|
10445
|
+
* ```
|
|
10446
|
+
*/
|
|
10447
|
+
defaults?: TestConfiguration;
|
|
10448
|
+
/**
|
|
10449
|
+
* A map with the individual test configurations, keyed by a unique test name.
|
|
10450
|
+
*
|
|
10451
|
+
* There's no technical limitation for the length or the characters of the test names. The name is used
|
|
10452
|
+
* only in the overview page showing all tests of your suite.
|
|
10453
|
+
*
|
|
10454
|
+
* By default, the name is also used to derive an ID for the module that contains the test cases. We therefore
|
|
10455
|
+
* recommend using names which are valid module IDs (no blanks, no special chars other than "/" or ".").
|
|
10456
|
+
* If you have multiple tests that execute the same module but with different configurations (e.g. different
|
|
10457
|
+
* QUnit versions or different URL parameters), you have to make up unique names and manually configure
|
|
10458
|
+
* the module IDs for them.
|
|
10459
|
+
*
|
|
10460
|
+
* The test starter applies the following complete default configuration structure:
|
|
10461
|
+
*
|
|
10462
|
+
*
|
|
10463
|
+
* ```javascript
|
|
10464
|
+
*
|
|
10465
|
+
* {
|
|
10466
|
+
* name: null,
|
|
10467
|
+
* beforeBootstrap: null,
|
|
10468
|
+
* module: "./{name}.qunit",
|
|
10469
|
+
* page: "resources/sap/ui/test/starter/Test.qunit.html?testsuite={suite}&test={name}",
|
|
10470
|
+
* title: "QUnit tests '{name}' of suite '{suite}'",
|
|
10471
|
+
* qunit: "edge",
|
|
10472
|
+
* sinon: "edge",
|
|
10473
|
+
* coverage: {
|
|
10474
|
+
* only: null,
|
|
10475
|
+
* never: null,
|
|
10476
|
+
* branchTracking: false,
|
|
10477
|
+
* instrumenter: "auto"
|
|
10478
|
+
* },
|
|
10479
|
+
* ui5: {
|
|
10480
|
+
* bindingSyntax: "complex",
|
|
10481
|
+
* libs: []
|
|
10482
|
+
* },
|
|
10483
|
+
* bootCore: true,
|
|
10484
|
+
* autostart: true
|
|
10485
|
+
* }
|
|
10486
|
+
* ```
|
|
10487
|
+
*/
|
|
10488
|
+
tests?: Record<string, TestConfiguration>;
|
|
10489
|
+
};
|
|
10490
|
+
|
|
10491
|
+
/**
|
|
10492
|
+
* Defines the configuration options for a single test in a testsuite. The same structure is also used for
|
|
10493
|
+
* the defaults of a testsuite.
|
|
10494
|
+
*
|
|
10495
|
+
* Some of the properties in this structure support placeholders for the name of the test (written as `{name}`)
|
|
10496
|
+
* and the module ID of the testsuite (written as {suite}>). These placeholders are substituted
|
|
10497
|
+
* before the test configuration is evaluated.
|
|
10498
|
+
*
|
|
10499
|
+
* Properties that represent UI5 module IDs also support relative module IDs (starting with `./`). They
|
|
10500
|
+
* are resolved relative to the package that contains the testsuite. This behaves the same as if the testsuite
|
|
10501
|
+
* module would use these IDs in its `sap.ui.define` call.
|
|
10502
|
+
*
|
|
10503
|
+
* The test starter applies the following complete default configuration structure:
|
|
10504
|
+
*
|
|
10505
|
+
*
|
|
10506
|
+
* ```javascript
|
|
10507
|
+
*
|
|
10508
|
+
* {
|
|
10509
|
+
* name: null, // Derived from test key
|
|
10510
|
+
* beforeBootstrap: null,
|
|
10511
|
+
* module: "./{name}.qunit",
|
|
10512
|
+
* page: "resources/sap/ui/test/starter/Test.qunit.html?testsuite={suite}&test={name}",
|
|
10513
|
+
* title: "QUnit tests '{name}' of suite '{suite}'",
|
|
10514
|
+
* qunit: "edge",
|
|
10515
|
+
* sinon: "edge",
|
|
10516
|
+
* coverage: {
|
|
10517
|
+
* only: null,
|
|
10518
|
+
* never: null,
|
|
10519
|
+
* branchTracking: false,
|
|
10520
|
+
* instrumenter: "auto"
|
|
10521
|
+
* },
|
|
10522
|
+
* ui5: {
|
|
10523
|
+
* bindingSyntax: "complex",
|
|
10524
|
+
* libs: []
|
|
10525
|
+
* },
|
|
10526
|
+
* bootCore: true,
|
|
10527
|
+
* autostart: true
|
|
10528
|
+
* }
|
|
10529
|
+
* ```
|
|
10530
|
+
*/
|
|
10531
|
+
export type TestConfiguration = {
|
|
10532
|
+
/**
|
|
10533
|
+
* The name of a group to which the test belongs.
|
|
10534
|
+
*
|
|
10535
|
+
* This is an optional string by which all tests in a testsuite will be sorted and grouped when they are
|
|
10536
|
+
* listed in a UI. The group name usually is shown as a prefix of the test name.
|
|
10537
|
+
*/
|
|
10538
|
+
group?: string;
|
|
10539
|
+
/**
|
|
10540
|
+
* Whether the test starter should skip a test file. Such tests will remain in the overview list but won't
|
|
10541
|
+
* be executed in the test suite.
|
|
10542
|
+
*/
|
|
10543
|
+
skip?: boolean;
|
|
10544
|
+
/**
|
|
10545
|
+
* Name of the test. If omitted, it is derived from the corresponding key in the ´tests` object of the enclosing
|
|
10546
|
+
* suite.
|
|
10547
|
+
*/
|
|
10548
|
+
name?: string;
|
|
10549
|
+
/**
|
|
10550
|
+
* A module to be executed before the UI5 framework is bootstrapped.
|
|
10551
|
+
*
|
|
10552
|
+
* This can be useful for setting up global configurations or mocks that need to exist before any UI5 code
|
|
10553
|
+
* runs.
|
|
10554
|
+
*
|
|
10555
|
+
* The value can be a relative module ID (e.g., `./mySetup.js`) and may use the placeholders `{name}` for
|
|
10556
|
+
* the test name and `{suite}` for the suite name.
|
|
10557
|
+
*/
|
|
10558
|
+
beforeBootstrap?: string;
|
|
10559
|
+
/**
|
|
10560
|
+
* ID(s) of the module(s) to load.
|
|
10561
|
+
*
|
|
10562
|
+
* Can either be a single string or an array of strings. Each given module ID can be a relative module ID
|
|
10563
|
+
* (relative to the package that contains the testsuite) and may use the placeholders `{name}` and `{suite}`.
|
|
10564
|
+
*
|
|
10565
|
+
* By default, a single module with the same name as the test and in the same package as the testsuite is
|
|
10566
|
+
* loaded.
|
|
10567
|
+
*/
|
|
10568
|
+
module?: string | string[];
|
|
10569
|
+
/**
|
|
10570
|
+
* URL of the test page to start for this test.
|
|
10571
|
+
*
|
|
10572
|
+
* By default, all tests use the generic starter page, which reads the suite configuration, finds the tests,
|
|
10573
|
+
* and starts the configured test components before it requires and executes the configured test module(s).
|
|
10574
|
+
*
|
|
10575
|
+
* The URL must either be relative to the application root or use the ui5:// protocol with a module name.
|
|
10576
|
+
* The URL can use the following placeholders, enclosed in curly braces: {suite} - replaced by the name
|
|
10577
|
+
* of the testsuite (configuration) {name} - replaced by the name of the current test
|
|
10578
|
+
*
|
|
10579
|
+
* By default, a generic test page uses the testsuite and test names as URL parameters `testsuite` and `test`,
|
|
10580
|
+
* respectively.
|
|
10581
|
+
*/
|
|
10582
|
+
page?: URI;
|
|
10583
|
+
/**
|
|
10584
|
+
* A map-like object with URL parameters that are appended to the `page` URL. Making this a separate property
|
|
10585
|
+
* allows to use the same page URL for all tests but with different URL parameters per test.
|
|
10586
|
+
*
|
|
10587
|
+
* Keys in the object are parameter names, and their values represent the parameter values. If the value
|
|
10588
|
+
* for a parameter is an array, the parameter will be added multiple times, once for each value in the array.
|
|
10589
|
+
*
|
|
10590
|
+
* Non-string values are not recommended and are cast to string (using the standard JavaScript `toString`
|
|
10591
|
+
* functionality).
|
|
10592
|
+
*/
|
|
10593
|
+
searchParams?: Record<string, string | string[]>;
|
|
10594
|
+
/**
|
|
10595
|
+
* A map-like object with URL parameters that are appended to the `page` URL. {@deprecated As of version
|
|
10596
|
+
* 1.141.0, use `searchParams` instead.}
|
|
10597
|
+
*/
|
|
10598
|
+
uriParams?: Record<string, string | string[]>;
|
|
10599
|
+
/**
|
|
10600
|
+
* Title of the test.
|
|
10601
|
+
*
|
|
10602
|
+
* The title can use the following placeholders, enclosed in curly braces: {suite} - replaced by the name
|
|
10603
|
+
* of the testsuite (configuration) {name} - replaced by the name of the current test
|
|
10604
|
+
*
|
|
10605
|
+
* By default, a title is chosen which contains the names of the testsuite and the test. The exact text
|
|
10606
|
+
* is not specified and may change.
|
|
10607
|
+
*
|
|
10608
|
+
* Default is "QUnit tests '{name}' of suite '{suite}'"
|
|
10609
|
+
*/
|
|
10610
|
+
title?: string;
|
|
10611
|
+
/**
|
|
10612
|
+
* Whether QUnit should be started, what version of it should be used, and what configuration should be
|
|
10613
|
+
* applied. Details are described in the {@link module:sap/ui/test/starter/config.QUnitConfiguration} type.
|
|
10614
|
+
*
|
|
10615
|
+
* The values `null`, `false`, `"edge"` as well as any numerical value are shortcut notations for `qunit:
|
|
10616
|
+
* { version: <value> }`.
|
|
10617
|
+
*
|
|
10618
|
+
* Default is to use the "edge" version without any additional configuration.
|
|
10619
|
+
*/
|
|
10620
|
+
qunit?: QUnitConfiguration | null | false | number | "edge";
|
|
10621
|
+
/**
|
|
10622
|
+
* Whether Sinon should be started, what version of it should be used, and what configuration should be
|
|
10623
|
+
* applied. Details are described in the {@link module:sap/ui/test/starter/config.SinonConfiguration} type.
|
|
10624
|
+
*
|
|
10625
|
+
* The values `null`, `false`, `"edge"` as well as any numerical value are shortcut notations for `sinon:
|
|
10626
|
+
* { version: <value> }`.
|
|
10627
|
+
*
|
|
10628
|
+
* Default is to use the "edge" version with a QUnit bridge, but without fake timers and fake servers.
|
|
10629
|
+
*/
|
|
10630
|
+
sinon?: SinonConfiguration;
|
|
10631
|
+
/**
|
|
10632
|
+
* Code coverage options.
|
|
10633
|
+
*
|
|
10634
|
+
* The qunit-coverage/qunit-coverage-istanbul module is always loaded after QUnit has been loaded to enable
|
|
10635
|
+
* the coverage option. When the 'coverage' parameter is set in the URL (e.g. because the `coverage` checkbox
|
|
10636
|
+
* has been clicked), then "blanket" (if Istanbul is not used instead) will be loaded before qunit-coverage
|
|
10637
|
+
* to avoid its synchronous loading.
|
|
10638
|
+
*
|
|
10639
|
+
* The `instrumenter` property identifies which tool for code coverage should be used. If "auto" is chosen,
|
|
10640
|
+
* a check determines whether Istanbul and its middleware are available, and if so, they will be loaded.
|
|
10641
|
+
* Otherwise, "blanket" is used as a fallback.
|
|
10642
|
+
*
|
|
10643
|
+
* The default is to automatically determine the instrumenter to use ("auto") and not to use branch tracking.
|
|
10644
|
+
*/
|
|
10645
|
+
coverage?: CoverageConfiguration;
|
|
10646
|
+
/**
|
|
10647
|
+
* Configuration options for the ui5loader.
|
|
10648
|
+
*
|
|
10649
|
+
* The configured object value is given to the {@link sap.ui.loader.config} API and supports nearly all
|
|
10650
|
+
* configuration options that are documented for that API. The only exception is the async flag, which is
|
|
10651
|
+
* already set to true by the test starter. The ui5loader doesn't support switching back to sync mode (async:false).
|
|
10652
|
+
*/
|
|
10653
|
+
loader?: Record<string, any>;
|
|
10654
|
+
/**
|
|
10655
|
+
* UI5 runtime configuration options.
|
|
10656
|
+
*
|
|
10657
|
+
* Any configured property is made available to the runtime as if it was given in the `window["sap-ui-config"]`
|
|
10658
|
+
* config object. If a value is of a type not supported for window["sap-ui-config"], executing the UI5 core
|
|
10659
|
+
* might fail. As the only current exception, the "libs" property can be an array of library names and not
|
|
10660
|
+
* only a comma-separated string.
|
|
10661
|
+
*
|
|
10662
|
+
* To ease test development, the test starter applies the following defaults. Note that any default is only
|
|
10663
|
+
* applied if the corresponding property has not been defined in the test-specific configuration.
|
|
10664
|
+
* - `bindingSyntax: "complex"`
|
|
10665
|
+
*/
|
|
10666
|
+
ui5?: Record<string, any>;
|
|
10667
|
+
/**
|
|
10668
|
+
* Whether the UI5 core (sap/ui/core/Core.js) should be required and booted.
|
|
10669
|
+
*
|
|
10670
|
+
* When this option is true, the core is not only loaded and started, but loading and execution of the test
|
|
10671
|
+
* module(s) is also delayed until a listener registered with sap.ui.getCore().attachInit() has been executed.
|
|
10672
|
+
*
|
|
10673
|
+
* {@deprecated As of version 1.120, it should not be used in new tests}
|
|
10674
|
+
*/
|
|
10675
|
+
bootCore?: boolean;
|
|
10676
|
+
/**
|
|
10677
|
+
* Whether the test starter should call QUnit.start() after all prerequisites have been fulfilled (e.g.
|
|
10678
|
+
* QUnit, Sinon, a bridge, have been loaded, coverage tooling has been loaded and configured, the Core has
|
|
10679
|
+
* been booted, the test modules have been loaded and executed, any Promises returned by the test modules
|
|
10680
|
+
* have been resolved).
|
|
10681
|
+
*/
|
|
10682
|
+
autostart?: boolean;
|
|
10683
|
+
};
|
|
10684
|
+
}
|
|
10685
|
+
|
|
10179
10686
|
declare module "sap/ui/test/utils/nextUIUpdate" {
|
|
10180
10687
|
/**
|
|
10181
10688
|
* Return a Promise that resolves when the next Rendering is ready. If no rendering is sheduled it resolves
|
|
@@ -28312,8 +28819,7 @@ declare module "sap/ui/core/Element" {
|
|
|
28312
28819
|
*
|
|
28313
28820
|
* UI5 currently does not provide a recommended implementation of `TooltipBase` as the use of content-rich
|
|
28314
28821
|
* tooltips is discouraged by the Fiori Design Guidelines. Existing subclasses of `TooltipBase` therefore
|
|
28315
|
-
* have been deprecated.
|
|
28316
|
-
* when needed (potentially taking the deprecated implementations as a starting point).
|
|
28822
|
+
* have been deprecated.
|
|
28317
28823
|
*
|
|
28318
28824
|
* See the section {@link https://experience.sap.com/fiori-design-web/using-tooltips/ Using Tooltips} in
|
|
28319
28825
|
* the Fiori Design Guideline.
|
|
@@ -33693,9 +34199,9 @@ declare module "sap/ui/core/Lib" {
|
|
|
33693
34199
|
*
|
|
33694
34200
|
* **Note:** Dependencies between libraries have to be modeled consistently in several places:
|
|
33695
34201
|
* - Both eager and lazy dependencies have to be modelled in the `.library` file.
|
|
33696
|
-
* - By default, UI5
|
|
33697
|
-
*
|
|
33698
|
-
*
|
|
34202
|
+
* - By default, UI5 CLI generates a `manifest.json` file from the content of the `.library` file. However,
|
|
34203
|
+
* if the `manifest.json` file for the library is not generated but maintained manually, it must be kept
|
|
34204
|
+
* consistent with the `.library` file, especially regarding its listed library dependencies.
|
|
33699
34205
|
* - All eager library dependencies must be declared as AMD dependencies of the `library.js` module by
|
|
33700
34206
|
* referring to the corresponding `"some/lib/namespace/library"` module of each library dependency.
|
|
33701
34207
|
*
|
|
@@ -42775,458 +43281,6 @@ declare module "sap/ui/core/routing/Target" {
|
|
|
42775
43281
|
>;
|
|
42776
43282
|
}
|
|
42777
43283
|
|
|
42778
|
-
declare module "sap/ui/core/routing/HashChanger" {
|
|
42779
|
-
import HashChangerBase from "sap/ui/core/routing/HashChangerBase";
|
|
42780
|
-
|
|
42781
|
-
import Metadata from "sap/ui/base/Metadata";
|
|
42782
|
-
|
|
42783
|
-
import { routing } from "sap/ui/core/library";
|
|
42784
|
-
|
|
42785
|
-
import Event from "sap/ui/base/Event";
|
|
42786
|
-
|
|
42787
|
-
/**
|
|
42788
|
-
* Class for manipulating and receiving changes of the browser hash with `hasher` framework.
|
|
42789
|
-
*
|
|
42790
|
-
* **IMPORTANT:** To set or replace the current browser hash, use {@link #setHash} or {@link #replaceHash }
|
|
42791
|
-
* and do NOT interact with the `hasher` framework directly in order to have the navigation direction calculated
|
|
42792
|
-
* as accurate as possible.
|
|
42793
|
-
*
|
|
42794
|
-
* Fires a `hashChanged` event if the browser hash changes.
|
|
42795
|
-
*/
|
|
42796
|
-
export default class HashChanger extends HashChangerBase {
|
|
42797
|
-
constructor();
|
|
42798
|
-
|
|
42799
|
-
/**
|
|
42800
|
-
* Creates a new subclass of class sap.ui.core.routing.HashChanger with name `sClassName` and enriches it
|
|
42801
|
-
* with the information contained in `oClassInfo`.
|
|
42802
|
-
*
|
|
42803
|
-
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.routing.HashChangerBase.extend}.
|
|
42804
|
-
*
|
|
42805
|
-
*
|
|
42806
|
-
* @returns Created class / constructor function
|
|
42807
|
-
*/
|
|
42808
|
-
static extend<T extends Record<string, unknown>>(
|
|
42809
|
-
/**
|
|
42810
|
-
* Name of the class being created
|
|
42811
|
-
*/
|
|
42812
|
-
sClassName: string,
|
|
42813
|
-
/**
|
|
42814
|
-
* Object literal with information about the class
|
|
42815
|
-
*/
|
|
42816
|
-
oClassInfo?: sap.ClassInfo<T, HashChanger>,
|
|
42817
|
-
/**
|
|
42818
|
-
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
42819
|
-
* used by this class
|
|
42820
|
-
*/
|
|
42821
|
-
FNMetaImpl?: Function
|
|
42822
|
-
): Function;
|
|
42823
|
-
/**
|
|
42824
|
-
* Gets a global singleton of the HashChanger. The singleton will get created when this function is invoked
|
|
42825
|
-
* for the first time.
|
|
42826
|
-
*
|
|
42827
|
-
*
|
|
42828
|
-
* @returns The global HashChanger
|
|
42829
|
-
*/
|
|
42830
|
-
static getInstance(): HashChanger;
|
|
42831
|
-
/**
|
|
42832
|
-
* Returns a metadata object for class sap.ui.core.routing.HashChanger.
|
|
42833
|
-
*
|
|
42834
|
-
*
|
|
42835
|
-
* @returns Metadata object describing this class
|
|
42836
|
-
*/
|
|
42837
|
-
static getMetadata(): Metadata;
|
|
42838
|
-
/**
|
|
42839
|
-
* Sets the hashChanger to a new instance, destroys the old one and copies all its event listeners to the
|
|
42840
|
-
* new one
|
|
42841
|
-
*
|
|
42842
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
42843
|
-
*/
|
|
42844
|
-
static replaceHashChanger(
|
|
42845
|
-
/**
|
|
42846
|
-
* the new instance for the global singleton
|
|
42847
|
-
*/
|
|
42848
|
-
oHashChanger: HashChanger
|
|
42849
|
-
): void;
|
|
42850
|
-
/**
|
|
42851
|
-
* Cleans the event registration
|
|
42852
|
-
* See:
|
|
42853
|
-
* sap.ui.base.Object.prototype.destroy
|
|
42854
|
-
*
|
|
42855
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
42856
|
-
*/
|
|
42857
|
-
destroy(): void;
|
|
42858
|
-
/**
|
|
42859
|
-
* Fires the `hashChanged` event, may be extended to modify the hash before firing the event
|
|
42860
|
-
*
|
|
42861
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
42862
|
-
*/
|
|
42863
|
-
fireHashChanged(
|
|
42864
|
-
/**
|
|
42865
|
-
* the new hash of the browser
|
|
42866
|
-
*/
|
|
42867
|
-
sNewHash: string,
|
|
42868
|
-
/**
|
|
42869
|
-
* the previous hash
|
|
42870
|
-
*/
|
|
42871
|
-
sOldHash: string
|
|
42872
|
-
): void;
|
|
42873
|
-
/**
|
|
42874
|
-
* Gets the current hash
|
|
42875
|
-
*
|
|
42876
|
-
*
|
|
42877
|
-
* @returns the current hash
|
|
42878
|
-
*/
|
|
42879
|
-
getHash(): string;
|
|
42880
|
-
/**
|
|
42881
|
-
* Defines the events and its parameters which should be used for tracking the hash changes
|
|
42882
|
-
*
|
|
42883
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
42884
|
-
*
|
|
42885
|
-
* @returns The array containing the events info
|
|
42886
|
-
*/
|
|
42887
|
-
getRelevantEventsInfo(): HashChangerEventInfo[];
|
|
42888
|
-
/**
|
|
42889
|
-
* Will start listening to hash changes. This will also fire a `hashChanged` event with the initial hash.
|
|
42890
|
-
*
|
|
42891
|
-
*
|
|
42892
|
-
* @returns false if it was initialized before, true if it was initialized the first time
|
|
42893
|
-
*/
|
|
42894
|
-
init(): boolean;
|
|
42895
|
-
/**
|
|
42896
|
-
* Replaces the hash with a certain value. When using the replace function, no browser history entry is
|
|
42897
|
-
* written. If you want to have an entry in the browser history, please use the {@link #setHash} function.
|
|
42898
|
-
*
|
|
42899
|
-
* The `sDirection` parameter can be used to provide direction information on the navigation which leads
|
|
42900
|
-
* to this hash replacement. This is typically used when synchronizing the hashes between multiple frames
|
|
42901
|
-
* to provide information to the frame where the hash is replaced with the navigation direction in the other
|
|
42902
|
-
* frame where the navigation occurs.
|
|
42903
|
-
*/
|
|
42904
|
-
replaceHash(
|
|
42905
|
-
/**
|
|
42906
|
-
* New hash
|
|
42907
|
-
*/
|
|
42908
|
-
sHash: string,
|
|
42909
|
-
/**
|
|
42910
|
-
* The direction information for this hash replacement
|
|
42911
|
-
*/
|
|
42912
|
-
sDirection:
|
|
42913
|
-
| routing.HistoryDirection
|
|
42914
|
-
| keyof typeof routing.HistoryDirection
|
|
42915
|
-
): void;
|
|
42916
|
-
/**
|
|
42917
|
-
* Sets the hash to a certain value. When using this function, a browser history entry is written. If you
|
|
42918
|
-
* do not want to have an entry in the browser history, please use the {@link #replaceHash} function.
|
|
42919
|
-
*/
|
|
42920
|
-
setHash(
|
|
42921
|
-
/**
|
|
42922
|
-
* New hash
|
|
42923
|
-
*/
|
|
42924
|
-
sHash: string
|
|
42925
|
-
): void;
|
|
42926
|
-
}
|
|
42927
|
-
/**
|
|
42928
|
-
* The object containing the event info for the events that are forwarded to {@link sap.ui.core.routing.RouterHashChanger}.
|
|
42929
|
-
*
|
|
42930
|
-
* @since 1.82.0
|
|
42931
|
-
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
42932
|
-
*/
|
|
42933
|
-
export type HashChangerEventInfo = {
|
|
42934
|
-
/**
|
|
42935
|
-
* The name of the event that is fired by the HashChanger and should be forwarded to the RouterHashChanger
|
|
42936
|
-
*
|
|
42937
|
-
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
42938
|
-
*/
|
|
42939
|
-
name: string;
|
|
42940
|
-
/**
|
|
42941
|
-
* The optional defined parameter name mapping that is used for forwarding the event to the {@link sap.ui.core.routing.RouterHashChanger}.
|
|
42942
|
-
*
|
|
42943
|
-
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
42944
|
-
*/
|
|
42945
|
-
paramMapping?: HashChangerEventParameterMapping;
|
|
42946
|
-
/**
|
|
42947
|
-
* Indicates whether the event is ignored by every RouterHashChanger instance and is only relevant for the
|
|
42948
|
-
* other routing classes, for example {@link sap.ui.core.routing.History}.
|
|
42949
|
-
*
|
|
42950
|
-
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
42951
|
-
*/
|
|
42952
|
-
updateHashOnly: boolean;
|
|
42953
|
-
};
|
|
42954
|
-
|
|
42955
|
-
/**
|
|
42956
|
-
* The object containing the parameter mapping for forwarding the event to the {@link sap.ui.core.routing.RouterHashChanger}.
|
|
42957
|
-
*
|
|
42958
|
-
* @since 1.82.0
|
|
42959
|
-
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
42960
|
-
*/
|
|
42961
|
-
export type HashChangerEventParameterMapping = {
|
|
42962
|
-
/**
|
|
42963
|
-
* The name of the parameter whose value is used as the `newHash` parameter in the event that is forwarded
|
|
42964
|
-
* to the {@link sap.ui.core.routing.RouterHashChanger}. If this isn't set, the value is taken from the
|
|
42965
|
-
* property `newHash`.
|
|
42966
|
-
*
|
|
42967
|
-
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
42968
|
-
*/
|
|
42969
|
-
newHash?: string;
|
|
42970
|
-
/**
|
|
42971
|
-
* The name of the parameter whose value is used as the `oldHash` parameter in the event that is forwarded
|
|
42972
|
-
* to the {@link sap.ui.core.routing.RouterHashChanger}. If this isn't set, the value is taken from the
|
|
42973
|
-
* property `oldHash`.
|
|
42974
|
-
*
|
|
42975
|
-
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
42976
|
-
*/
|
|
42977
|
-
oldHash?: string;
|
|
42978
|
-
/**
|
|
42979
|
-
* The name of the parameter whose value is used as the `fullHash` parameter in the event that is forwarded
|
|
42980
|
-
* to the {@link sap.ui.core.routing.RouterHashChanger}. If this isn't set, the value is taken from the
|
|
42981
|
-
* property `fullHash`.
|
|
42982
|
-
*
|
|
42983
|
-
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
42984
|
-
*/
|
|
42985
|
-
fullHash?: string;
|
|
42986
|
-
};
|
|
42987
|
-
|
|
42988
|
-
/**
|
|
42989
|
-
* Parameters of the HashChanger#hashSet event.
|
|
42990
|
-
*/
|
|
42991
|
-
export interface HashChanger$HashSetEventParameters {
|
|
42992
|
-
/**
|
|
42993
|
-
* The relevant hash segment
|
|
42994
|
-
*/
|
|
42995
|
-
hash?: string;
|
|
42996
|
-
}
|
|
42997
|
-
|
|
42998
|
-
/**
|
|
42999
|
-
* Event object of the HashChanger#hashSet event.
|
|
43000
|
-
*/
|
|
43001
|
-
export type HashChanger$HashSetEvent = Event<
|
|
43002
|
-
HashChanger$HashSetEventParameters,
|
|
43003
|
-
HashChanger
|
|
43004
|
-
>;
|
|
43005
|
-
}
|
|
43006
|
-
|
|
43007
|
-
declare module "sap/ui/core/routing/HashChangerBase" {
|
|
43008
|
-
import EventProvider from "sap/ui/base/EventProvider";
|
|
43009
|
-
|
|
43010
|
-
import Metadata from "sap/ui/base/Metadata";
|
|
43011
|
-
|
|
43012
|
-
import { routing } from "sap/ui/core/library";
|
|
43013
|
-
|
|
43014
|
-
import Event from "sap/ui/base/Event";
|
|
43015
|
-
|
|
43016
|
-
/**
|
|
43017
|
-
* Base Class for manipulating and receiving changes of hash segment.
|
|
43018
|
-
*
|
|
43019
|
-
* Fires a `hashChanged` event if the relevant hash changes.
|
|
43020
|
-
*
|
|
43021
|
-
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
43022
|
-
*/
|
|
43023
|
-
export default class HashChangerBase extends EventProvider {
|
|
43024
|
-
/**
|
|
43025
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
43026
|
-
*/
|
|
43027
|
-
protected constructor();
|
|
43028
|
-
|
|
43029
|
-
/**
|
|
43030
|
-
* Creates a new subclass of class sap.ui.core.routing.HashChangerBase with name `sClassName` and enriches
|
|
43031
|
-
* it with the information contained in `oClassInfo`.
|
|
43032
|
-
*
|
|
43033
|
-
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.EventProvider.extend}.
|
|
43034
|
-
*
|
|
43035
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
43036
|
-
*
|
|
43037
|
-
* @returns Created class / constructor function
|
|
43038
|
-
*/
|
|
43039
|
-
static extend<T extends Record<string, unknown>>(
|
|
43040
|
-
/**
|
|
43041
|
-
* Name of the class being created
|
|
43042
|
-
*/
|
|
43043
|
-
sClassName: string,
|
|
43044
|
-
/**
|
|
43045
|
-
* Object literal with information about the class
|
|
43046
|
-
*/
|
|
43047
|
-
oClassInfo?: sap.ClassInfo<T, HashChangerBase>,
|
|
43048
|
-
/**
|
|
43049
|
-
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
43050
|
-
* used by this class
|
|
43051
|
-
*/
|
|
43052
|
-
FNMetaImpl?: Function
|
|
43053
|
-
): Function;
|
|
43054
|
-
/**
|
|
43055
|
-
* Returns a metadata object for class sap.ui.core.routing.HashChangerBase.
|
|
43056
|
-
*
|
|
43057
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
43058
|
-
*
|
|
43059
|
-
* @returns Metadata object describing this class
|
|
43060
|
-
*/
|
|
43061
|
-
static getMetadata(): Metadata;
|
|
43062
|
-
/**
|
|
43063
|
-
* Replaces the hash with a certain value. When using the replace function, no browser history entry is
|
|
43064
|
-
* written. If you want to have an entry in the browser history, please use the {@link #setHash} function.
|
|
43065
|
-
*
|
|
43066
|
-
* The `sDirection` parameter can be used to provide direction information on the navigation which leads
|
|
43067
|
-
* to this hash replacement. This is typically used when synchronizing the hashes between multiple frames
|
|
43068
|
-
* to provide information to the frame where the hash is replaced with the navigation direction in the other
|
|
43069
|
-
* frame where the navigation occurs.
|
|
43070
|
-
*
|
|
43071
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
43072
|
-
*/
|
|
43073
|
-
replaceHash(
|
|
43074
|
-
/**
|
|
43075
|
-
* New hash
|
|
43076
|
-
*/
|
|
43077
|
-
sHash: string,
|
|
43078
|
-
/**
|
|
43079
|
-
* The direction information for this hash replacement
|
|
43080
|
-
*/
|
|
43081
|
-
sDirection:
|
|
43082
|
-
| routing.HistoryDirection
|
|
43083
|
-
| keyof typeof routing.HistoryDirection
|
|
43084
|
-
): void;
|
|
43085
|
-
/**
|
|
43086
|
-
* Sets the hash to a certain value. When using this function, a browser history entry is written. If you
|
|
43087
|
-
* do not want to have an entry in the browser history, please use the {@link #replaceHash} function.
|
|
43088
|
-
*
|
|
43089
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
43090
|
-
*/
|
|
43091
|
-
setHash(
|
|
43092
|
-
/**
|
|
43093
|
-
* New hash
|
|
43094
|
-
*/
|
|
43095
|
-
sHash: string
|
|
43096
|
-
): void;
|
|
43097
|
-
}
|
|
43098
|
-
/**
|
|
43099
|
-
* Parameters of the HashChangerBase#hashChanged event.
|
|
43100
|
-
*
|
|
43101
|
-
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
43102
|
-
*/
|
|
43103
|
-
export interface HashChangerBase$HashChangedEventParameters {
|
|
43104
|
-
/**
|
|
43105
|
-
* The hash segment before it's changed
|
|
43106
|
-
*/
|
|
43107
|
-
oldHash?: string;
|
|
43108
|
-
|
|
43109
|
-
/**
|
|
43110
|
-
* The new hash segment
|
|
43111
|
-
*/
|
|
43112
|
-
newHash?: object;
|
|
43113
|
-
|
|
43114
|
-
/**
|
|
43115
|
-
* The full format of the hash if the newHash only contains part of the relevant hash
|
|
43116
|
-
*/
|
|
43117
|
-
fullHash?: string;
|
|
43118
|
-
}
|
|
43119
|
-
|
|
43120
|
-
/**
|
|
43121
|
-
* Event object of the HashChangerBase#hashChanged event.
|
|
43122
|
-
*
|
|
43123
|
-
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
43124
|
-
*/
|
|
43125
|
-
export type HashChangerBase$HashChangedEvent = Event<
|
|
43126
|
-
HashChangerBase$HashChangedEventParameters,
|
|
43127
|
-
HashChangerBase
|
|
43128
|
-
>;
|
|
43129
|
-
|
|
43130
|
-
/**
|
|
43131
|
-
* Parameters of the HashChangerBase#hashReplaced event.
|
|
43132
|
-
*
|
|
43133
|
-
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
43134
|
-
*/
|
|
43135
|
-
export interface HashChangerBase$HashReplacedEventParameters {
|
|
43136
|
-
/**
|
|
43137
|
-
* The relevant hash segment
|
|
43138
|
-
*/
|
|
43139
|
-
hash?: string;
|
|
43140
|
-
}
|
|
43141
|
-
|
|
43142
|
-
/**
|
|
43143
|
-
* Event object of the HashChangerBase#hashReplaced event.
|
|
43144
|
-
*
|
|
43145
|
-
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
43146
|
-
*/
|
|
43147
|
-
export type HashChangerBase$HashReplacedEvent = Event<
|
|
43148
|
-
HashChangerBase$HashReplacedEventParameters,
|
|
43149
|
-
HashChangerBase
|
|
43150
|
-
>;
|
|
43151
|
-
}
|
|
43152
|
-
|
|
43153
|
-
declare module "sap/ui/core/routing/History" {
|
|
43154
|
-
import HashChanger from "sap/ui/core/routing/HashChanger";
|
|
43155
|
-
|
|
43156
|
-
import { routing } from "sap/ui/core/library";
|
|
43157
|
-
|
|
43158
|
-
export default class History {
|
|
43159
|
-
/**
|
|
43160
|
-
* Used to determine the {@link sap.ui.core.routing.HistoryDirection} of the current or a future navigation,
|
|
43161
|
-
* done with a {@link sap.ui.core.routing.Router} or {@link sap.ui.core.routing.HashChanger}.
|
|
43162
|
-
*
|
|
43163
|
-
* **ATTENTION:** this class will not be accurate if someone does hash-replacement without the named classes
|
|
43164
|
-
* above. If you are manipulating the hash directly, this class is not supported anymore.
|
|
43165
|
-
*/
|
|
43166
|
-
constructor(
|
|
43167
|
-
/**
|
|
43168
|
-
* required, without a HashChanger this class cannot work. The class needs to be aware of the hash-changes.
|
|
43169
|
-
*/
|
|
43170
|
-
oHashChanger: HashChanger
|
|
43171
|
-
);
|
|
43172
|
-
|
|
43173
|
-
/**
|
|
43174
|
-
*
|
|
43175
|
-
* @returns a global singleton that gets created as soon as the sap.ui.core.routing.History is required
|
|
43176
|
-
*/
|
|
43177
|
-
static getInstance(): History;
|
|
43178
|
-
/**
|
|
43179
|
-
* Determines what the navigation direction for a newly given hash would be.
|
|
43180
|
-
*
|
|
43181
|
-
* Returns the direction as {@link sap.ui.core.routing.HistoryDirection} (for example: Forwards, Backwards,
|
|
43182
|
-
* NewEntry). If no navigation has occurred yet, returns `undefined`. In cases where the direction cannot
|
|
43183
|
-
* be determined (if the same hash appears in multiple places), returns {@link sap.ui.core.routing.HistoryDirection.Unknown}.
|
|
43184
|
-
* For hash replacements, the history stack is updated at the current position.
|
|
43185
|
-
*
|
|
43186
|
-
* Example: It will say "Unknown" if there is a history "foo" - "bar" (current history) - "foo". If you
|
|
43187
|
-
* now ask for the direction of the hash "foo" you get "Unknown" because it might be backwards or forwards.
|
|
43188
|
-
*
|
|
43189
|
-
*
|
|
43190
|
-
* @returns Direction for the given hash or `undefined`, if no navigation has taken place yet.
|
|
43191
|
-
*/
|
|
43192
|
-
getDirection(
|
|
43193
|
-
/**
|
|
43194
|
-
* optional, if this parameter is not passed the last hashChange is taken.
|
|
43195
|
-
*/
|
|
43196
|
-
sNewHash?: string
|
|
43197
|
-
): routing.HistoryDirection | undefined;
|
|
43198
|
-
/**
|
|
43199
|
-
* Returns the length difference between the history state stored in browser's pushState and the state maintained
|
|
43200
|
-
* in this class.
|
|
43201
|
-
*
|
|
43202
|
-
* The function returns `undefined` when
|
|
43203
|
-
* - The current state in browser's history pushState isn't initialized, for example, between a new hash
|
|
43204
|
-
* is set or replaced and the "hashChange" event is processed by this class
|
|
43205
|
-
* - History pushState is already used before UI5 History is initialized, and UI5 can't maintain the hash
|
|
43206
|
-
* history by using the browser pushState
|
|
43207
|
-
*
|
|
43208
|
-
* Once the "hashChange" event is processed by this class, this method always returns 0. However, before
|
|
43209
|
-
* a "hashChange" event reaches this class, it returns the offset between the new hash and the previous
|
|
43210
|
-
* one within the history state.
|
|
43211
|
-
*
|
|
43212
|
-
* @since 1.70
|
|
43213
|
-
*
|
|
43214
|
-
* @returns The length difference or returns `undefined` when browser pushState can't be used at the moment
|
|
43215
|
-
* when this function is called
|
|
43216
|
-
*/
|
|
43217
|
-
getHistoryStateOffset(): int | undefined;
|
|
43218
|
-
/**
|
|
43219
|
-
* Gets the previous hash in the history.
|
|
43220
|
-
*
|
|
43221
|
-
* If the last direction was Unknown or there was no navigation yet, `undefined` will be returned.
|
|
43222
|
-
*
|
|
43223
|
-
*
|
|
43224
|
-
* @returns Previous hash in the history or `undefined`
|
|
43225
|
-
*/
|
|
43226
|
-
getPreviousHash(): string | undefined;
|
|
43227
|
-
}
|
|
43228
|
-
}
|
|
43229
|
-
|
|
43230
43284
|
declare module "sap/ui/core/routing/Router" {
|
|
43231
43285
|
import EventProvider from "sap/ui/base/EventProvider";
|
|
43232
43286
|
|
|
@@ -43255,6 +43309,21 @@ declare module "sap/ui/core/routing/Router" {
|
|
|
43255
43309
|
|
|
43256
43310
|
import Control from "sap/ui/core/Control";
|
|
43257
43311
|
|
|
43312
|
+
export type ComponentTargetParameters = {
|
|
43313
|
+
/**
|
|
43314
|
+
* The name of the route which should be matched after this navTo call.
|
|
43315
|
+
*/
|
|
43316
|
+
route: string;
|
|
43317
|
+
/**
|
|
43318
|
+
* The parameters for the route
|
|
43319
|
+
*/
|
|
43320
|
+
parameters?: Record<string, string | Record<string, string>>;
|
|
43321
|
+
/**
|
|
43322
|
+
* Information for deeper nested component targets
|
|
43323
|
+
*/
|
|
43324
|
+
componentTargetInfo?: Record<string, ComponentTargetParameters>;
|
|
43325
|
+
};
|
|
43326
|
+
|
|
43258
43327
|
export type RouteInfo = {
|
|
43259
43328
|
/**
|
|
43260
43329
|
* The route name
|
|
@@ -44224,45 +44293,23 @@ declare module "sap/ui/core/routing/Router" {
|
|
|
44224
44293
|
* **Parameter:**
|
|
44225
44294
|
* ```javascript
|
|
44226
44295
|
*
|
|
44227
|
-
*
|
|
44228
|
-
*
|
|
44229
|
-
*
|
|
44230
|
-
*
|
|
44231
|
-
*
|
|
44232
|
-
*
|
|
44233
|
-
*
|
|
44234
|
-
*
|
|
44296
|
+
* {
|
|
44297
|
+
* parameterName1: "parameterValue1",
|
|
44298
|
+
* parameterName2: "parameterValue2",
|
|
44299
|
+
* "?queryParameterName": {
|
|
44300
|
+
* queryParameterName1: "queryParameterValue1"
|
|
44301
|
+
* }
|
|
44302
|
+
* }
|
|
44303
|
+
* ```
|
|
44235
44304
|
*/
|
|
44236
44305
|
oParameters?: object,
|
|
44237
44306
|
/**
|
|
44238
|
-
*
|
|
44239
|
-
* route
|
|
44240
|
-
*
|
|
44241
|
-
*
|
|
44242
|
-
* target can be given within the `componentTargetInfo` property which contains the same properties as the
|
|
44243
|
-
* top level.
|
|
44307
|
+
* Defines routing information for nested component targets. For each nested component target, you can specify
|
|
44308
|
+
* the route name and its parameters of the nested router. This allows matching a non-empty route pattern
|
|
44309
|
+
* in the nested component directly during this `navTo` call. The same structure can be used recursively
|
|
44310
|
+
* for deeper levels of nested component targets.
|
|
44244
44311
|
*/
|
|
44245
|
-
oComponentTargetInfo?:
|
|
44246
|
-
/**
|
|
44247
|
-
* The name of a target which loads a component. This target is used in the Route which is specified by
|
|
44248
|
-
* `sName`.
|
|
44249
|
-
*/
|
|
44250
|
-
anyName?: {
|
|
44251
|
-
/**
|
|
44252
|
-
* The name of the route which should be matched after this navTo call.
|
|
44253
|
-
*/
|
|
44254
|
-
route?: string;
|
|
44255
|
-
/**
|
|
44256
|
-
* The parameters for the route. See the documentation of the `oParameters`.
|
|
44257
|
-
*/
|
|
44258
|
-
parameters?: object;
|
|
44259
|
-
/**
|
|
44260
|
-
* The information for the targets within a nested component. This shares the same structure with the `oComponentTargetInfo`
|
|
44261
|
-
* parameter.
|
|
44262
|
-
*/
|
|
44263
|
-
componentTargetInfo?: object;
|
|
44264
|
-
};
|
|
44265
|
-
},
|
|
44312
|
+
oComponentTargetInfo?: Record<string, ComponentTargetParameters>,
|
|
44266
44313
|
/**
|
|
44267
44314
|
* If set to `true`, the hash is replaced, and there will be no entry in the browser history. If set to
|
|
44268
44315
|
* `false`, the hash is set and the entry is stored in the browser history.
|
|
@@ -44304,14 +44351,14 @@ declare module "sap/ui/core/routing/Router" {
|
|
|
44304
44351
|
* **Parameter:**
|
|
44305
44352
|
* ```javascript
|
|
44306
44353
|
*
|
|
44307
|
-
*
|
|
44308
|
-
*
|
|
44309
|
-
*
|
|
44310
|
-
*
|
|
44311
|
-
*
|
|
44312
|
-
*
|
|
44313
|
-
*
|
|
44314
|
-
*
|
|
44354
|
+
* {
|
|
44355
|
+
* parameterName1: "parameterValue1",
|
|
44356
|
+
* parameterName2: "parameterValue2",
|
|
44357
|
+
* "?queryParameterName": {
|
|
44358
|
+
* queryParameterName1: "queryParameterValue1"
|
|
44359
|
+
* }
|
|
44360
|
+
* }
|
|
44361
|
+
* ```
|
|
44315
44362
|
*/
|
|
44316
44363
|
oParameters?: object,
|
|
44317
44364
|
/**
|
|
@@ -44578,6 +44625,458 @@ declare module "sap/ui/core/routing/Router" {
|
|
|
44578
44625
|
>;
|
|
44579
44626
|
}
|
|
44580
44627
|
|
|
44628
|
+
declare module "sap/ui/core/routing/HashChanger" {
|
|
44629
|
+
import HashChangerBase from "sap/ui/core/routing/HashChangerBase";
|
|
44630
|
+
|
|
44631
|
+
import Metadata from "sap/ui/base/Metadata";
|
|
44632
|
+
|
|
44633
|
+
import { routing } from "sap/ui/core/library";
|
|
44634
|
+
|
|
44635
|
+
import Event from "sap/ui/base/Event";
|
|
44636
|
+
|
|
44637
|
+
/**
|
|
44638
|
+
* Class for manipulating and receiving changes of the browser hash with `hasher` framework.
|
|
44639
|
+
*
|
|
44640
|
+
* **IMPORTANT:** To set or replace the current browser hash, use {@link #setHash} or {@link #replaceHash }
|
|
44641
|
+
* and do NOT interact with the `hasher` framework directly in order to have the navigation direction calculated
|
|
44642
|
+
* as accurate as possible.
|
|
44643
|
+
*
|
|
44644
|
+
* Fires a `hashChanged` event if the browser hash changes.
|
|
44645
|
+
*/
|
|
44646
|
+
export default class HashChanger extends HashChangerBase {
|
|
44647
|
+
constructor();
|
|
44648
|
+
|
|
44649
|
+
/**
|
|
44650
|
+
* Creates a new subclass of class sap.ui.core.routing.HashChanger with name `sClassName` and enriches it
|
|
44651
|
+
* with the information contained in `oClassInfo`.
|
|
44652
|
+
*
|
|
44653
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.routing.HashChangerBase.extend}.
|
|
44654
|
+
*
|
|
44655
|
+
*
|
|
44656
|
+
* @returns Created class / constructor function
|
|
44657
|
+
*/
|
|
44658
|
+
static extend<T extends Record<string, unknown>>(
|
|
44659
|
+
/**
|
|
44660
|
+
* Name of the class being created
|
|
44661
|
+
*/
|
|
44662
|
+
sClassName: string,
|
|
44663
|
+
/**
|
|
44664
|
+
* Object literal with information about the class
|
|
44665
|
+
*/
|
|
44666
|
+
oClassInfo?: sap.ClassInfo<T, HashChanger>,
|
|
44667
|
+
/**
|
|
44668
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
44669
|
+
* used by this class
|
|
44670
|
+
*/
|
|
44671
|
+
FNMetaImpl?: Function
|
|
44672
|
+
): Function;
|
|
44673
|
+
/**
|
|
44674
|
+
* Gets a global singleton of the HashChanger. The singleton will get created when this function is invoked
|
|
44675
|
+
* for the first time.
|
|
44676
|
+
*
|
|
44677
|
+
*
|
|
44678
|
+
* @returns The global HashChanger
|
|
44679
|
+
*/
|
|
44680
|
+
static getInstance(): HashChanger;
|
|
44681
|
+
/**
|
|
44682
|
+
* Returns a metadata object for class sap.ui.core.routing.HashChanger.
|
|
44683
|
+
*
|
|
44684
|
+
*
|
|
44685
|
+
* @returns Metadata object describing this class
|
|
44686
|
+
*/
|
|
44687
|
+
static getMetadata(): Metadata;
|
|
44688
|
+
/**
|
|
44689
|
+
* Sets the hashChanger to a new instance, destroys the old one and copies all its event listeners to the
|
|
44690
|
+
* new one
|
|
44691
|
+
*
|
|
44692
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
44693
|
+
*/
|
|
44694
|
+
static replaceHashChanger(
|
|
44695
|
+
/**
|
|
44696
|
+
* the new instance for the global singleton
|
|
44697
|
+
*/
|
|
44698
|
+
oHashChanger: HashChanger
|
|
44699
|
+
): void;
|
|
44700
|
+
/**
|
|
44701
|
+
* Cleans the event registration
|
|
44702
|
+
* See:
|
|
44703
|
+
* sap.ui.base.Object.prototype.destroy
|
|
44704
|
+
*
|
|
44705
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
44706
|
+
*/
|
|
44707
|
+
destroy(): void;
|
|
44708
|
+
/**
|
|
44709
|
+
* Fires the `hashChanged` event, may be extended to modify the hash before firing the event
|
|
44710
|
+
*
|
|
44711
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
44712
|
+
*/
|
|
44713
|
+
fireHashChanged(
|
|
44714
|
+
/**
|
|
44715
|
+
* the new hash of the browser
|
|
44716
|
+
*/
|
|
44717
|
+
sNewHash: string,
|
|
44718
|
+
/**
|
|
44719
|
+
* the previous hash
|
|
44720
|
+
*/
|
|
44721
|
+
sOldHash: string
|
|
44722
|
+
): void;
|
|
44723
|
+
/**
|
|
44724
|
+
* Gets the current hash
|
|
44725
|
+
*
|
|
44726
|
+
*
|
|
44727
|
+
* @returns the current hash
|
|
44728
|
+
*/
|
|
44729
|
+
getHash(): string;
|
|
44730
|
+
/**
|
|
44731
|
+
* Defines the events and its parameters which should be used for tracking the hash changes
|
|
44732
|
+
*
|
|
44733
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
44734
|
+
*
|
|
44735
|
+
* @returns The array containing the events info
|
|
44736
|
+
*/
|
|
44737
|
+
getRelevantEventsInfo(): HashChangerEventInfo[];
|
|
44738
|
+
/**
|
|
44739
|
+
* Will start listening to hash changes. This will also fire a `hashChanged` event with the initial hash.
|
|
44740
|
+
*
|
|
44741
|
+
*
|
|
44742
|
+
* @returns false if it was initialized before, true if it was initialized the first time
|
|
44743
|
+
*/
|
|
44744
|
+
init(): boolean;
|
|
44745
|
+
/**
|
|
44746
|
+
* Replaces the hash with a certain value. When using the replace function, no browser history entry is
|
|
44747
|
+
* written. If you want to have an entry in the browser history, please use the {@link #setHash} function.
|
|
44748
|
+
*
|
|
44749
|
+
* The `sDirection` parameter can be used to provide direction information on the navigation which leads
|
|
44750
|
+
* to this hash replacement. This is typically used when synchronizing the hashes between multiple frames
|
|
44751
|
+
* to provide information to the frame where the hash is replaced with the navigation direction in the other
|
|
44752
|
+
* frame where the navigation occurs.
|
|
44753
|
+
*/
|
|
44754
|
+
replaceHash(
|
|
44755
|
+
/**
|
|
44756
|
+
* New hash
|
|
44757
|
+
*/
|
|
44758
|
+
sHash: string,
|
|
44759
|
+
/**
|
|
44760
|
+
* The direction information for this hash replacement
|
|
44761
|
+
*/
|
|
44762
|
+
sDirection:
|
|
44763
|
+
| routing.HistoryDirection
|
|
44764
|
+
| keyof typeof routing.HistoryDirection
|
|
44765
|
+
): void;
|
|
44766
|
+
/**
|
|
44767
|
+
* Sets the hash to a certain value. When using this function, a browser history entry is written. If you
|
|
44768
|
+
* do not want to have an entry in the browser history, please use the {@link #replaceHash} function.
|
|
44769
|
+
*/
|
|
44770
|
+
setHash(
|
|
44771
|
+
/**
|
|
44772
|
+
* New hash
|
|
44773
|
+
*/
|
|
44774
|
+
sHash: string
|
|
44775
|
+
): void;
|
|
44776
|
+
}
|
|
44777
|
+
/**
|
|
44778
|
+
* The object containing the event info for the events that are forwarded to {@link sap.ui.core.routing.RouterHashChanger}.
|
|
44779
|
+
*
|
|
44780
|
+
* @since 1.82.0
|
|
44781
|
+
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
44782
|
+
*/
|
|
44783
|
+
export type HashChangerEventInfo = {
|
|
44784
|
+
/**
|
|
44785
|
+
* The name of the event that is fired by the HashChanger and should be forwarded to the RouterHashChanger
|
|
44786
|
+
*
|
|
44787
|
+
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
44788
|
+
*/
|
|
44789
|
+
name: string;
|
|
44790
|
+
/**
|
|
44791
|
+
* The optional defined parameter name mapping that is used for forwarding the event to the {@link sap.ui.core.routing.RouterHashChanger}.
|
|
44792
|
+
*
|
|
44793
|
+
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
44794
|
+
*/
|
|
44795
|
+
paramMapping?: HashChangerEventParameterMapping;
|
|
44796
|
+
/**
|
|
44797
|
+
* Indicates whether the event is ignored by every RouterHashChanger instance and is only relevant for the
|
|
44798
|
+
* other routing classes, for example {@link sap.ui.core.routing.History}.
|
|
44799
|
+
*
|
|
44800
|
+
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
44801
|
+
*/
|
|
44802
|
+
updateHashOnly: boolean;
|
|
44803
|
+
};
|
|
44804
|
+
|
|
44805
|
+
/**
|
|
44806
|
+
* The object containing the parameter mapping for forwarding the event to the {@link sap.ui.core.routing.RouterHashChanger}.
|
|
44807
|
+
*
|
|
44808
|
+
* @since 1.82.0
|
|
44809
|
+
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
44810
|
+
*/
|
|
44811
|
+
export type HashChangerEventParameterMapping = {
|
|
44812
|
+
/**
|
|
44813
|
+
* The name of the parameter whose value is used as the `newHash` parameter in the event that is forwarded
|
|
44814
|
+
* to the {@link sap.ui.core.routing.RouterHashChanger}. If this isn't set, the value is taken from the
|
|
44815
|
+
* property `newHash`.
|
|
44816
|
+
*
|
|
44817
|
+
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
44818
|
+
*/
|
|
44819
|
+
newHash?: string;
|
|
44820
|
+
/**
|
|
44821
|
+
* The name of the parameter whose value is used as the `oldHash` parameter in the event that is forwarded
|
|
44822
|
+
* to the {@link sap.ui.core.routing.RouterHashChanger}. If this isn't set, the value is taken from the
|
|
44823
|
+
* property `oldHash`.
|
|
44824
|
+
*
|
|
44825
|
+
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
44826
|
+
*/
|
|
44827
|
+
oldHash?: string;
|
|
44828
|
+
/**
|
|
44829
|
+
* The name of the parameter whose value is used as the `fullHash` parameter in the event that is forwarded
|
|
44830
|
+
* to the {@link sap.ui.core.routing.RouterHashChanger}. If this isn't set, the value is taken from the
|
|
44831
|
+
* property `fullHash`.
|
|
44832
|
+
*
|
|
44833
|
+
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
44834
|
+
*/
|
|
44835
|
+
fullHash?: string;
|
|
44836
|
+
};
|
|
44837
|
+
|
|
44838
|
+
/**
|
|
44839
|
+
* Parameters of the HashChanger#hashSet event.
|
|
44840
|
+
*/
|
|
44841
|
+
export interface HashChanger$HashSetEventParameters {
|
|
44842
|
+
/**
|
|
44843
|
+
* The relevant hash segment
|
|
44844
|
+
*/
|
|
44845
|
+
hash?: string;
|
|
44846
|
+
}
|
|
44847
|
+
|
|
44848
|
+
/**
|
|
44849
|
+
* Event object of the HashChanger#hashSet event.
|
|
44850
|
+
*/
|
|
44851
|
+
export type HashChanger$HashSetEvent = Event<
|
|
44852
|
+
HashChanger$HashSetEventParameters,
|
|
44853
|
+
HashChanger
|
|
44854
|
+
>;
|
|
44855
|
+
}
|
|
44856
|
+
|
|
44857
|
+
declare module "sap/ui/core/routing/HashChangerBase" {
|
|
44858
|
+
import EventProvider from "sap/ui/base/EventProvider";
|
|
44859
|
+
|
|
44860
|
+
import Metadata from "sap/ui/base/Metadata";
|
|
44861
|
+
|
|
44862
|
+
import { routing } from "sap/ui/core/library";
|
|
44863
|
+
|
|
44864
|
+
import Event from "sap/ui/base/Event";
|
|
44865
|
+
|
|
44866
|
+
/**
|
|
44867
|
+
* Base Class for manipulating and receiving changes of hash segment.
|
|
44868
|
+
*
|
|
44869
|
+
* Fires a `hashChanged` event if the relevant hash changes.
|
|
44870
|
+
*
|
|
44871
|
+
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
44872
|
+
*/
|
|
44873
|
+
export default class HashChangerBase extends EventProvider {
|
|
44874
|
+
/**
|
|
44875
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
44876
|
+
*/
|
|
44877
|
+
protected constructor();
|
|
44878
|
+
|
|
44879
|
+
/**
|
|
44880
|
+
* Creates a new subclass of class sap.ui.core.routing.HashChangerBase with name `sClassName` and enriches
|
|
44881
|
+
* it with the information contained in `oClassInfo`.
|
|
44882
|
+
*
|
|
44883
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.EventProvider.extend}.
|
|
44884
|
+
*
|
|
44885
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
44886
|
+
*
|
|
44887
|
+
* @returns Created class / constructor function
|
|
44888
|
+
*/
|
|
44889
|
+
static extend<T extends Record<string, unknown>>(
|
|
44890
|
+
/**
|
|
44891
|
+
* Name of the class being created
|
|
44892
|
+
*/
|
|
44893
|
+
sClassName: string,
|
|
44894
|
+
/**
|
|
44895
|
+
* Object literal with information about the class
|
|
44896
|
+
*/
|
|
44897
|
+
oClassInfo?: sap.ClassInfo<T, HashChangerBase>,
|
|
44898
|
+
/**
|
|
44899
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
44900
|
+
* used by this class
|
|
44901
|
+
*/
|
|
44902
|
+
FNMetaImpl?: Function
|
|
44903
|
+
): Function;
|
|
44904
|
+
/**
|
|
44905
|
+
* Returns a metadata object for class sap.ui.core.routing.HashChangerBase.
|
|
44906
|
+
*
|
|
44907
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
44908
|
+
*
|
|
44909
|
+
* @returns Metadata object describing this class
|
|
44910
|
+
*/
|
|
44911
|
+
static getMetadata(): Metadata;
|
|
44912
|
+
/**
|
|
44913
|
+
* Replaces the hash with a certain value. When using the replace function, no browser history entry is
|
|
44914
|
+
* written. If you want to have an entry in the browser history, please use the {@link #setHash} function.
|
|
44915
|
+
*
|
|
44916
|
+
* The `sDirection` parameter can be used to provide direction information on the navigation which leads
|
|
44917
|
+
* to this hash replacement. This is typically used when synchronizing the hashes between multiple frames
|
|
44918
|
+
* to provide information to the frame where the hash is replaced with the navigation direction in the other
|
|
44919
|
+
* frame where the navigation occurs.
|
|
44920
|
+
*
|
|
44921
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
44922
|
+
*/
|
|
44923
|
+
replaceHash(
|
|
44924
|
+
/**
|
|
44925
|
+
* New hash
|
|
44926
|
+
*/
|
|
44927
|
+
sHash: string,
|
|
44928
|
+
/**
|
|
44929
|
+
* The direction information for this hash replacement
|
|
44930
|
+
*/
|
|
44931
|
+
sDirection:
|
|
44932
|
+
| routing.HistoryDirection
|
|
44933
|
+
| keyof typeof routing.HistoryDirection
|
|
44934
|
+
): void;
|
|
44935
|
+
/**
|
|
44936
|
+
* Sets the hash to a certain value. When using this function, a browser history entry is written. If you
|
|
44937
|
+
* do not want to have an entry in the browser history, please use the {@link #replaceHash} function.
|
|
44938
|
+
*
|
|
44939
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
44940
|
+
*/
|
|
44941
|
+
setHash(
|
|
44942
|
+
/**
|
|
44943
|
+
* New hash
|
|
44944
|
+
*/
|
|
44945
|
+
sHash: string
|
|
44946
|
+
): void;
|
|
44947
|
+
}
|
|
44948
|
+
/**
|
|
44949
|
+
* Parameters of the HashChangerBase#hashChanged event.
|
|
44950
|
+
*
|
|
44951
|
+
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
44952
|
+
*/
|
|
44953
|
+
export interface HashChangerBase$HashChangedEventParameters {
|
|
44954
|
+
/**
|
|
44955
|
+
* The hash segment before it's changed
|
|
44956
|
+
*/
|
|
44957
|
+
oldHash?: string;
|
|
44958
|
+
|
|
44959
|
+
/**
|
|
44960
|
+
* The new hash segment
|
|
44961
|
+
*/
|
|
44962
|
+
newHash?: object;
|
|
44963
|
+
|
|
44964
|
+
/**
|
|
44965
|
+
* The full format of the hash if the newHash only contains part of the relevant hash
|
|
44966
|
+
*/
|
|
44967
|
+
fullHash?: string;
|
|
44968
|
+
}
|
|
44969
|
+
|
|
44970
|
+
/**
|
|
44971
|
+
* Event object of the HashChangerBase#hashChanged event.
|
|
44972
|
+
*
|
|
44973
|
+
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
44974
|
+
*/
|
|
44975
|
+
export type HashChangerBase$HashChangedEvent = Event<
|
|
44976
|
+
HashChangerBase$HashChangedEventParameters,
|
|
44977
|
+
HashChangerBase
|
|
44978
|
+
>;
|
|
44979
|
+
|
|
44980
|
+
/**
|
|
44981
|
+
* Parameters of the HashChangerBase#hashReplaced event.
|
|
44982
|
+
*
|
|
44983
|
+
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
44984
|
+
*/
|
|
44985
|
+
export interface HashChangerBase$HashReplacedEventParameters {
|
|
44986
|
+
/**
|
|
44987
|
+
* The relevant hash segment
|
|
44988
|
+
*/
|
|
44989
|
+
hash?: string;
|
|
44990
|
+
}
|
|
44991
|
+
|
|
44992
|
+
/**
|
|
44993
|
+
* Event object of the HashChangerBase#hashReplaced event.
|
|
44994
|
+
*
|
|
44995
|
+
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
44996
|
+
*/
|
|
44997
|
+
export type HashChangerBase$HashReplacedEvent = Event<
|
|
44998
|
+
HashChangerBase$HashReplacedEventParameters,
|
|
44999
|
+
HashChangerBase
|
|
45000
|
+
>;
|
|
45001
|
+
}
|
|
45002
|
+
|
|
45003
|
+
declare module "sap/ui/core/routing/History" {
|
|
45004
|
+
import HashChanger from "sap/ui/core/routing/HashChanger";
|
|
45005
|
+
|
|
45006
|
+
import { routing } from "sap/ui/core/library";
|
|
45007
|
+
|
|
45008
|
+
export default class History {
|
|
45009
|
+
/**
|
|
45010
|
+
* Used to determine the {@link sap.ui.core.routing.HistoryDirection} of the current or a future navigation,
|
|
45011
|
+
* done with a {@link sap.ui.core.routing.Router} or {@link sap.ui.core.routing.HashChanger}.
|
|
45012
|
+
*
|
|
45013
|
+
* **ATTENTION:** this class will not be accurate if someone does hash-replacement without the named classes
|
|
45014
|
+
* above. If you are manipulating the hash directly, this class is not supported anymore.
|
|
45015
|
+
*/
|
|
45016
|
+
constructor(
|
|
45017
|
+
/**
|
|
45018
|
+
* required, without a HashChanger this class cannot work. The class needs to be aware of the hash-changes.
|
|
45019
|
+
*/
|
|
45020
|
+
oHashChanger: HashChanger
|
|
45021
|
+
);
|
|
45022
|
+
|
|
45023
|
+
/**
|
|
45024
|
+
*
|
|
45025
|
+
* @returns a global singleton that gets created as soon as the sap.ui.core.routing.History is required
|
|
45026
|
+
*/
|
|
45027
|
+
static getInstance(): History;
|
|
45028
|
+
/**
|
|
45029
|
+
* Determines what the navigation direction for a newly given hash would be.
|
|
45030
|
+
*
|
|
45031
|
+
* Returns the direction as {@link sap.ui.core.routing.HistoryDirection} (for example: Forwards, Backwards,
|
|
45032
|
+
* NewEntry). If no navigation has occurred yet, returns `undefined`. In cases where the direction cannot
|
|
45033
|
+
* be determined (if the same hash appears in multiple places), returns {@link sap.ui.core.routing.HistoryDirection.Unknown}.
|
|
45034
|
+
* For hash replacements, the history stack is updated at the current position.
|
|
45035
|
+
*
|
|
45036
|
+
* Example: It will say "Unknown" if there is a history "foo" - "bar" (current history) - "foo". If you
|
|
45037
|
+
* now ask for the direction of the hash "foo" you get "Unknown" because it might be backwards or forwards.
|
|
45038
|
+
*
|
|
45039
|
+
*
|
|
45040
|
+
* @returns Direction for the given hash or `undefined`, if no navigation has taken place yet.
|
|
45041
|
+
*/
|
|
45042
|
+
getDirection(
|
|
45043
|
+
/**
|
|
45044
|
+
* optional, if this parameter is not passed the last hashChange is taken.
|
|
45045
|
+
*/
|
|
45046
|
+
sNewHash?: string
|
|
45047
|
+
): routing.HistoryDirection | undefined;
|
|
45048
|
+
/**
|
|
45049
|
+
* Returns the length difference between the history state stored in browser's pushState and the state maintained
|
|
45050
|
+
* in this class.
|
|
45051
|
+
*
|
|
45052
|
+
* The function returns `undefined` when
|
|
45053
|
+
* - The current state in browser's history pushState isn't initialized, for example, between a new hash
|
|
45054
|
+
* is set or replaced and the "hashChange" event is processed by this class
|
|
45055
|
+
* - History pushState is already used before UI5 History is initialized, and UI5 can't maintain the hash
|
|
45056
|
+
* history by using the browser pushState
|
|
45057
|
+
*
|
|
45058
|
+
* Once the "hashChange" event is processed by this class, this method always returns 0. However, before
|
|
45059
|
+
* a "hashChange" event reaches this class, it returns the offset between the new hash and the previous
|
|
45060
|
+
* one within the history state.
|
|
45061
|
+
*
|
|
45062
|
+
* @since 1.70
|
|
45063
|
+
*
|
|
45064
|
+
* @returns The length difference or returns `undefined` when browser pushState can't be used at the moment
|
|
45065
|
+
* when this function is called
|
|
45066
|
+
*/
|
|
45067
|
+
getHistoryStateOffset(): int | undefined;
|
|
45068
|
+
/**
|
|
45069
|
+
* Gets the previous hash in the history.
|
|
45070
|
+
*
|
|
45071
|
+
* If the last direction was Unknown or there was no navigation yet, `undefined` will be returned.
|
|
45072
|
+
*
|
|
45073
|
+
*
|
|
45074
|
+
* @returns Previous hash in the history or `undefined`
|
|
45075
|
+
*/
|
|
45076
|
+
getPreviousHash(): string | undefined;
|
|
45077
|
+
}
|
|
45078
|
+
}
|
|
45079
|
+
|
|
44581
45080
|
declare module "sap/ui/core/routing/RouterHashChanger" {
|
|
44582
45081
|
import HashChangerBase from "sap/ui/core/routing/HashChangerBase";
|
|
44583
45082
|
|
|
@@ -59765,6 +60264,10 @@ declare module "sap/ui/model/json/JSONModel" {
|
|
|
59765
60264
|
* Sets `oValue` as new value for the property defined by the given `sPath` and `oContext`. Once the new
|
|
59766
60265
|
* model value has been set, all interested parties are informed.
|
|
59767
60266
|
*
|
|
60267
|
+
* Consecutive calls of this method which update bindings ***synchronously*** may cause performance issues;
|
|
60268
|
+
* see {@link https://ui5.sap.com/#/topic/18a76b577b144bc2b9b424e39d379c06 Performance Impact of Model Updates }
|
|
60269
|
+
* for details.
|
|
60270
|
+
*
|
|
59768
60271
|
*
|
|
59769
60272
|
* @returns `true` if the value was set correctly, and `false` if errors occurred, for example if the entry
|
|
59770
60273
|
* was not found.
|
|
@@ -59783,7 +60286,7 @@ declare module "sap/ui/model/json/JSONModel" {
|
|
|
59783
60286
|
*/
|
|
59784
60287
|
oContext?: Context,
|
|
59785
60288
|
/**
|
|
59786
|
-
* Whether to update
|
|
60289
|
+
* Whether to update bindings dependent on this property asynchronously
|
|
59787
60290
|
*/
|
|
59788
60291
|
bAsyncUpdate?: boolean
|
|
59789
60292
|
): boolean;
|
|
@@ -67402,7 +67905,7 @@ declare module "sap/ui/model/odata/type/Decimal" {
|
|
|
67402
67905
|
* `Edm.Decimal`.
|
|
67403
67906
|
*
|
|
67404
67907
|
* In both {@link sap.ui.model.odata.v2.ODataModel} and {@link sap.ui.model.odata.v4.ODataModel} this type
|
|
67405
|
-
* is represented as a `string`.
|
|
67908
|
+
* is represented as a `string`.
|
|
67406
67909
|
*
|
|
67407
67910
|
* @since 1.27.0
|
|
67408
67911
|
*/
|
|
@@ -67414,7 +67917,8 @@ declare module "sap/ui/model/odata/type/Decimal" {
|
|
|
67414
67917
|
/**
|
|
67415
67918
|
* Format options as defined in {@link sap.ui.core.format.NumberFormat.getFloatInstance}. In contrast to
|
|
67416
67919
|
* NumberFormat `groupingEnabled` defaults to `true`. Note that `maxFractionDigits` and `minFractionDigits`
|
|
67417
|
-
* are set to the value of the constraint `scale` unless it is "variable". They can however
|
|
67920
|
+
* are set to the value of the constraint `scale` unless it is "variable" or "floating". They can however
|
|
67921
|
+
* be overwritten.
|
|
67418
67922
|
*/
|
|
67419
67923
|
oFormatOptions?: {
|
|
67420
67924
|
/**
|
|
@@ -67457,15 +67961,26 @@ declare module "sap/ui/model/odata/type/Decimal" {
|
|
|
67457
67961
|
*/
|
|
67458
67962
|
precision?: int | string;
|
|
67459
67963
|
/**
|
|
67460
|
-
*
|
|
67461
|
-
* or equal to `precision` (if given).
|
|
67964
|
+
* The maximum number of digits allowed to the right of the decimal point; the number must be less than
|
|
67965
|
+
* or equal to `precision` (if given). The `Decimal` is then always displayed with exactly that number of
|
|
67966
|
+
* digits to the right of the decimal point. If `scale` is equal to `precision`, a single zero has to precede
|
|
67967
|
+
* the decimal point.
|
|
67968
|
+
*
|
|
67969
|
+
* In addition, the `scale` values "variable" and (as of UI5 version 1.142.0) "floating" are supported.
|
|
67462
67970
|
*
|
|
67463
|
-
*
|
|
67464
|
-
* of digits to the left of the decimal point
|
|
67465
|
-
* is equal to `precision`, a single zero has to precede the decimal point.
|
|
67971
|
+
* For `scale="variable"`, the number of digits to the right of the decimal point can vary from zero to
|
|
67972
|
+
* `precision` minus the number of digits to the left of the decimal point.
|
|
67466
67973
|
*
|
|
67467
|
-
*
|
|
67468
|
-
*
|
|
67974
|
+
* **Examples for `Decimal`s with precision=3 and scale="variable":**
|
|
67975
|
+
* - Valid values: 123, 1.23, 12.3, 0.12
|
|
67976
|
+
* - Invalid values: 1230, 1.234, 12.34, 0.123 For `scale="floating"`, the number of
|
|
67977
|
+
* significant digits, i.e. the number of digits excluding leading or trailing zeros, must be less than
|
|
67978
|
+
* or equal to `precision`. For more information on `scale="floating"`, see
|
|
67979
|
+
* OData Version 4.01 Common Schema Definition Language (CSDL) XML Representation - Scale .
|
|
67980
|
+
*
|
|
67981
|
+
* **Examples for `Decimal`s with precision=3 and scale="floating":**
|
|
67982
|
+
* - Valid values: 1230, 1.23, 12.3, 0.123
|
|
67983
|
+
* - Invalid values: 1234, 1.234, 12.34, 0.001234
|
|
67469
67984
|
*/
|
|
67470
67985
|
scale?: int | string;
|
|
67471
67986
|
}
|
|
@@ -71238,23 +71753,23 @@ declare module "sap/ui/model/odata/v4/AnnotationHelper" {
|
|
|
71238
71753
|
*
|
|
71239
71754
|
*
|
|
71240
71755
|
* Supported Expressions:
|
|
71241
|
-
* "14.
|
|
71242
|
-
* "edm:Guid", "edm:Int", "edm:TimeOfDay". constant "14.
|
|
71756
|
+
* "14.3 Constant Expressions" for "edm:Bool", "edm:Date", "edm:DateTimeOffset", "edm:Decimal", "edm:Float",
|
|
71757
|
+
* "edm:Guid", "edm:Int", "edm:TimeOfDay". constant "14.3.11 Expression edm:String": This is turned
|
|
71243
71758
|
* into a fixed text (for example `"Width"`). String constants that contain a simple binding `"{@i18n>...}"`
|
|
71244
71759
|
* to the hard-coded model name "@i18n" with arbitrary path are not turned into a fixed text, but kept as
|
|
71245
71760
|
* a data binding expression; this allows local annotation files to refer to a resource bundle for internationalization.
|
|
71246
|
-
* dynamic "14.
|
|
71247
|
-
* perform the operations at runtime. dynamic "14.
|
|
71248
|
-
* "14.
|
|
71249
|
-
* "14.
|
|
71250
|
-
* template at runtime. "14.
|
|
71251
|
-
* to encode the parameter at runtime. Apply functions may be nested arbitrarily.
|
|
71252
|
-
* "14.
|
|
71253
|
-
* Elements can be conditionally added to the collection when using dynamic "14.
|
|
71254
|
-
* a direct child. dynamic "14.
|
|
71255
|
-
* be evaluated at runtime. The expression is a conditional expression like `"{=condition ? expression1
|
|
71256
|
-
* : expression2}"`. dynamic "14.
|
|
71257
|
-
* is ignored in `odata.concat`. dynamic "14.
|
|
71761
|
+
* dynamic "14.4.2 Comparison and Logical Operators": These are turned into expression bindings to
|
|
71762
|
+
* perform the operations at runtime. dynamic "14.4.4 Expression edm:Apply":
|
|
71763
|
+
* "odata.concat" from "14.4.4.1 Canonical Functions": This is turned into a data binding expression relative
|
|
71764
|
+
* to an entity. "14.4.4.2 Function odata.fillUriTemplate": This is turned into an expression binding
|
|
71765
|
+
* to fill the template at runtime. "14.4.4.4 Function odata.uriEncode": This is turned into an expression
|
|
71766
|
+
* binding to encode the parameter at runtime. Apply functions may be nested arbitrarily.
|
|
71767
|
+
* dynamic "14.4.6 Expression edm:Collection": This is turned into an expression binding to be evaluated
|
|
71768
|
+
* at runtime. Elements can be conditionally added to the collection when using dynamic "14.4.7 Expression
|
|
71769
|
+
* edm:If" as a direct child. dynamic "14.4.7 Expression edm:If": This is turned into an expression
|
|
71770
|
+
* binding to be evaluated at runtime. The expression is a conditional expression like `"{=condition ? expression1
|
|
71771
|
+
* : expression2}"`. dynamic "14.4.11 Expression edm:Null": This is turned into a `null` value. It
|
|
71772
|
+
* is ignored in `odata.concat`. dynamic "14.4.1.7 Expression edm:Path" and "14.4.1.6 Expression edm:PropertyPath":
|
|
71258
71773
|
* These are turned into data bindings relative to an entity, including type information and constraints
|
|
71259
71774
|
* as available from metadata, for example `"{path : 'Name', type : 'sap.ui.model.odata.type.String', constraints
|
|
71260
71775
|
* : {'maxLength' : 255}, formatOptions : {'parseKeepsEmptyString' : true}}"`. Depending on the used type,
|
|
@@ -71270,11 +71785,11 @@ declare module "sap/ui/model/odata/v4/AnnotationHelper" {
|
|
|
71270
71785
|
* note that in this case only constant expressions are supported to determine the annotation value. The
|
|
71271
71786
|
* "parseKeepsEmptyString" format option is set. Since 1.78.0, both "edm:Path" and "edm:PropertyPath"
|
|
71272
71787
|
* are also supported if `vRawValue` is the path itself, and not the object wrapping it. **Note: Import
|
|
71273
|
-
* the `sap/ui/model/odata/ODataExpressionAddons` module when using 14.
|
|
71788
|
+
* the `sap/ui/model/odata/ODataExpressionAddons` module when using 14.4.2 or 14.4.4**
|
|
71274
71789
|
*
|
|
71275
71790
|
* $AnnotationPath and $Path: If `oDetails.context.getPath()` contains a single "$AnnotationPath" or "$Path"
|
|
71276
71791
|
* segment, the value corresponding to that segment is considered as a data binding path prefix whenever
|
|
71277
|
-
* a dynamic "14.
|
|
71792
|
+
* a dynamic "14.4.1.7 Expression edm:Path" or "14.4.1.6 Expression edm:PropertyPath" is turned into a data
|
|
71278
71793
|
* binding. Use {@link sap.ui.model.odata.v4.AnnotationHelper.resolve$Path} to avoid these prefixes in cases
|
|
71279
71794
|
* where they are not applicable.
|
|
71280
71795
|
*
|
|
@@ -71325,12 +71840,12 @@ declare module "sap/ui/model/odata/v4/AnnotationHelper" {
|
|
|
71325
71840
|
* `format` returns a binding with path "EQUIPMENT_2_PRODUCT/PRODUCT_2_SUPPLIER/Supplier_Name".
|
|
71326
71841
|
*
|
|
71327
71842
|
* Annotations on an Operation or a Parameter: Since 1.71.0, for annotations on an operation or a parameter,
|
|
71328
|
-
* the binding parameter's name is stripped off any dynamic "14.
|
|
71329
|
-
* edm:PropertyPath" where it might be used as a first segment. Since 1.76.0, this does not apply
|
|
71330
|
-
* on a parameter. In the former case, we assume that the resulting data binding is relative
|
|
71331
|
-
* context of the operation binding, that is, to the context representing the binding parameter
|
|
71332
|
-
* In the latter case, we assume that the resulting data binding is relative to the parameter context
|
|
71333
|
-
* the operation binding (see {@link sap.ui.model.odata.v4.ODataContextBinding#getParameterContext}).
|
|
71843
|
+
* the binding parameter's name is stripped off any dynamic "14.4.1.7 Expression edm:Path" and "14.4.1.6
|
|
71844
|
+
* Expression edm:PropertyPath" where it might be used as a first segment. Since 1.76.0, this does not apply
|
|
71845
|
+
* to annotations on a parameter. In the former case, we assume that the resulting data binding is relative
|
|
71846
|
+
* to the parent context of the operation binding, that is, to the context representing the binding parameter
|
|
71847
|
+
* itself. In the latter case, we assume that the resulting data binding is relative to the parameter context
|
|
71848
|
+
* of the operation binding (see {@link sap.ui.model.odata.v4.ODataContextBinding#getParameterContext}).
|
|
71334
71849
|
*
|
|
71335
71850
|
* Example:
|
|
71336
71851
|
* ```javascript
|
|
@@ -71364,7 +71879,7 @@ declare module "sap/ui/model/odata/v4/AnnotationHelper" {
|
|
|
71364
71879
|
* on.
|
|
71365
71880
|
*
|
|
71366
71881
|
* Operation Parameters: Since 1.73.0, this function can be used on action or function parameters and results
|
|
71367
|
-
* in a relative data binding, just like a "14.
|
|
71882
|
+
* in a relative data binding, just like a "14.4.1.7 Expression edm:Path".
|
|
71368
71883
|
*
|
|
71369
71884
|
* Assume we have the following metadata for an unbound action "AcChangeTeamBudgetByID":
|
|
71370
71885
|
* ```javascript
|
|
@@ -71400,7 +71915,7 @@ declare module "sap/ui/model/odata/v4/AnnotationHelper" {
|
|
|
71400
71915
|
* in case no binding parameters are needed.
|
|
71401
71916
|
*
|
|
71402
71917
|
* Structural Properties: Since 1.78.0, this function can be used on a structural property and results in
|
|
71403
|
-
* a relative data binding, just like a "14.
|
|
71918
|
+
* a relative data binding, just like a "14.4.1.7 Expression edm:Path". The usage
|
|
71404
71919
|
* ```javascript
|
|
71405
71920
|
*
|
|
71406
71921
|
* <Input value="{meta>/Department/Name@@sap.ui.model.odata.v4.AnnotationHelper.format}"/>
|
|
@@ -71440,7 +71955,7 @@ declare module "sap/ui/model/odata/v4/AnnotationHelper" {
|
|
|
71440
71955
|
context: Context;
|
|
71441
71956
|
/**
|
|
71442
71957
|
* The single operation overload that was targeted by annotations on an operation or a parameter; needed
|
|
71443
|
-
* to strip off the binding parameter's name from any dynamic "14.
|
|
71958
|
+
* to strip off the binding parameter's name from any dynamic "14.4.1.7 Expression edm:Path" and "14.4.1.6
|
|
71444
71959
|
* Expression edm:PropertyPath" where it might be used as a first segment (since 1.71.0). This does not
|
|
71445
71960
|
* apply to annotations on a parameter (since 1.76.0).
|
|
71446
71961
|
*/
|
|
@@ -71465,10 +71980,10 @@ declare module "sap/ui/model/odata/v4/AnnotationHelper" {
|
|
|
71465
71980
|
/**
|
|
71466
71981
|
* A function that helps to interpret OData V4 annotations. It knows about the syntax of the path value
|
|
71467
71982
|
* used by the following dynamic expressions:
|
|
71468
|
-
* "14.
|
|
71469
|
-
* Expression edm:Path" "14.
|
|
71470
|
-
* and navigation properties from the given path value, but removes "$count", types casts,
|
|
71471
|
-
* annotations on navigation properties.
|
|
71983
|
+
* "14.4.1.3 Expression edm:AnnotationPath" "14.4.1.5 Expression edm:NavigationPropertyPath"
|
|
71984
|
+
* "14.4.1.7 Expression edm:Path" "14.4.1.6 Expression edm:PropertyPath" It returns the path
|
|
71985
|
+
* of structural and navigation properties from the given path value, but removes "$count", types casts,
|
|
71986
|
+
* term casts, and annotations on navigation properties.
|
|
71472
71987
|
*
|
|
71473
71988
|
* @since 1.43.0
|
|
71474
71989
|
*
|
|
@@ -71516,10 +72031,10 @@ declare module "sap/ui/model/odata/v4/AnnotationHelper" {
|
|
|
71516
72031
|
/**
|
|
71517
72032
|
* A function that helps to interpret OData V4 annotations. It knows about the syntax of the path value
|
|
71518
72033
|
* used by the following dynamic expressions:
|
|
71519
|
-
* "14.
|
|
71520
|
-
* Expression edm:Path" "14.
|
|
71521
|
-
* the given path ends with "$count" or with a multi-valued structural or navigation property. Term
|
|
71522
|
-
* and annotations on navigation properties are ignored.
|
|
72034
|
+
* "14.4.1.3 Expression edm:AnnotationPath" "14.4.1.5 Expression edm:NavigationPropertyPath"
|
|
72035
|
+
* "14.4.1.7 Expression edm:Path" "14.4.1.6 Expression edm:PropertyPath" It returns the information
|
|
72036
|
+
* whether the given path ends with "$count" or with a multi-valued structural or navigation property. Term
|
|
72037
|
+
* casts and annotations on navigation properties are ignored.
|
|
71523
72038
|
*
|
|
71524
72039
|
* Example:
|
|
71525
72040
|
* ```javascript
|
|
@@ -71625,33 +72140,33 @@ declare module "sap/ui/model/odata/v4/AnnotationHelper" {
|
|
|
71625
72140
|
*
|
|
71626
72141
|
*
|
|
71627
72142
|
* Supported Expressions:
|
|
71628
|
-
* "14.
|
|
71629
|
-
* "edm:Guid", "edm:Int", "edm:TimeOfDay". constant "14.
|
|
72143
|
+
* "14.3 Constant Expressions" for "edm:Bool", "edm:Date", "edm:DateTimeOffset", "edm:Decimal", "edm:Float",
|
|
72144
|
+
* "edm:Guid", "edm:Int", "edm:TimeOfDay". constant "14.3.11 Expression edm:String": This is turned
|
|
71630
72145
|
* into a fixed text (for example `"Width"`). String constants that contain a simple binding `"{@i18n>...}"`
|
|
71631
72146
|
* to the hard-coded model name "@i18n" with arbitrary path are not turned into a fixed text, but kept as
|
|
71632
72147
|
* a data binding expression; this allows local annotation files to refer to a resource bundle for internationalization.
|
|
71633
|
-
* dynamic "14.
|
|
71634
|
-
* perform the operations at runtime. dynamic "14.
|
|
71635
|
-
* "14.
|
|
71636
|
-
* Function odata.fillUriTemplate": This is turned into an expression binding to fill the
|
|
71637
|
-
* "14.
|
|
71638
|
-
* at runtime. Apply functions may be nested arbitrarily. dynamic
|
|
71639
|
-
* This is turned into an expression binding to be evaluated at runtime.
|
|
71640
|
-
* to the collection when using dynamic "14.
|
|
71641
|
-
* Expression edm:If": This is turned into an expression binding to
|
|
71642
|
-
* is a conditional expression like `"{=condition ? expression1
|
|
71643
|
-
* Expression edm:Null": This is turned into a `null` value. It
|
|
71644
|
-
* "14.
|
|
71645
|
-
* data bindings, for example `"{Name}"`. Since 1.78.0, both are also supported
|
|
71646
|
-
* itself, and not the object wrapping it.
|
|
72148
|
+
* dynamic "14.4.2 Comparison and Logical Operators": These are turned into expression bindings to
|
|
72149
|
+
* perform the operations at runtime. dynamic "14.4.4 Expression edm:Apply":
|
|
72150
|
+
* "odata.concat" from "14.4.4.1 Canonical Functions": This is turned into a data binding expression.
|
|
72151
|
+
* "14.4.4.2 Function odata.fillUriTemplate": This is turned into an expression binding to fill the
|
|
72152
|
+
* template at runtime. "14.4.4.4 Function odata.uriEncode": This is turned into an expression binding
|
|
72153
|
+
* to encode the parameter at runtime. Apply functions may be nested arbitrarily. dynamic
|
|
72154
|
+
* "14.4.6 Expression edm:Collection": This is turned into an expression binding to be evaluated at runtime.
|
|
72155
|
+
* Elements can be conditionally added to the collection when using dynamic "14.4.7 Expression edm:If" as
|
|
72156
|
+
* a direct child. dynamic "14.4.7 Expression edm:If": This is turned into an expression binding to
|
|
72157
|
+
* be evaluated at runtime. The expression is a conditional expression like `"{=condition ? expression1
|
|
72158
|
+
* : expression2}"`. dynamic "14.4.11 Expression edm:Null": This is turned into a `null` value. It
|
|
72159
|
+
* is ignored in `odata.concat`. dynamic "14.4.1.7 Expression edm:Path" and "14.4.1.6 Expression edm:PropertyPath":
|
|
72160
|
+
* These are turned into simple data bindings, for example `"{Name}"`. Since 1.78.0, both are also supported
|
|
72161
|
+
* if `vRawValue` is the path itself, and not the object wrapping it.
|
|
71647
72162
|
*
|
|
71648
72163
|
* Annotations on an Operation or a Parameter: Since 1.71.0, for annotations on an operation or a parameter,
|
|
71649
|
-
* the binding parameter's name is stripped off any dynamic "14.
|
|
71650
|
-
* edm:PropertyPath" where it might be used as a first segment. Since 1.76.0, this does not apply
|
|
71651
|
-
* on a parameter. In the former case, we assume that the resulting data binding is relative
|
|
71652
|
-
* context of the operation binding, that is, to the context representing the binding parameter
|
|
71653
|
-
* In the latter case, we assume that the resulting data binding is relative to the parameter context
|
|
71654
|
-
* the operation binding (see {@link sap.ui.model.odata.v4.ODataContextBinding#getParameterContext}).
|
|
72164
|
+
* the binding parameter's name is stripped off any dynamic "14.4.1.7 Expression edm:Path" and "14.4.1.6
|
|
72165
|
+
* Expression edm:PropertyPath" where it might be used as a first segment. Since 1.76.0, this does not apply
|
|
72166
|
+
* to annotations on a parameter. In the former case, we assume that the resulting data binding is relative
|
|
72167
|
+
* to the parent context of the operation binding, that is, to the context representing the binding parameter
|
|
72168
|
+
* itself. In the latter case, we assume that the resulting data binding is relative to the parameter context
|
|
72169
|
+
* of the operation binding (see {@link sap.ui.model.odata.v4.ODataContextBinding#getParameterContext}).
|
|
71655
72170
|
*
|
|
71656
72171
|
* Example:
|
|
71657
72172
|
* ```javascript
|
|
@@ -71685,7 +72200,7 @@ declare module "sap/ui/model/odata/v4/AnnotationHelper" {
|
|
|
71685
72200
|
* on.
|
|
71686
72201
|
*
|
|
71687
72202
|
* Operation Parameters: Since 1.73.0, this function can be used on action or function parameters and results
|
|
71688
|
-
* in a relative data binding, just like a "14.
|
|
72203
|
+
* in a relative data binding, just like a "14.4.1.7 Expression edm:Path".
|
|
71689
72204
|
*
|
|
71690
72205
|
* Assume we have the following metadata for an unbound action "AcChangeTeamBudgetByID":
|
|
71691
72206
|
* ```javascript
|
|
@@ -71719,7 +72234,7 @@ declare module "sap/ui/model/odata/v4/AnnotationHelper" {
|
|
|
71719
72234
|
* brackets must be replaced by `$(` and `$)` respectively.
|
|
71720
72235
|
*
|
|
71721
72236
|
* Structural Properties: Since 1.78.0, this function can be used on a structural property and results in
|
|
71722
|
-
* a relative data binding, just like a "14.
|
|
72237
|
+
* a relative data binding, just like a "14.4.1.7 Expression edm:Path". The usage
|
|
71723
72238
|
* ```javascript
|
|
71724
72239
|
*
|
|
71725
72240
|
* <Input value="{meta>/Department/Name@@sap.ui.model.odata.v4.AnnotationHelper.value}"/>
|
|
@@ -71757,13 +72272,13 @@ declare module "sap/ui/model/odata/v4/AnnotationHelper" {
|
|
|
71757
72272
|
context: Context;
|
|
71758
72273
|
/**
|
|
71759
72274
|
* The single operation overload that was targeted by annotations on an operation or a parameter; needed
|
|
71760
|
-
* to strip off the binding parameter's name from any dynamic "14.
|
|
72275
|
+
* to strip off the binding parameter's name from any dynamic "14.4.1.7 Expression edm:Path" and "14.4.1.6
|
|
71761
72276
|
* Expression edm:PropertyPath" where it might be used as a first segment (since 1.72.0). This does not
|
|
71762
72277
|
* apply to annotations on a parameter (since 1.76.0).
|
|
71763
72278
|
*/
|
|
71764
72279
|
overload?: object;
|
|
71765
72280
|
/**
|
|
71766
|
-
* Optional prefix to be added to each dynamic "14.
|
|
72281
|
+
* Optional prefix to be added to each dynamic "14.4.1.7 Expression edm:Path" and "14.4.1.6 Expression edm:PropertyPath";
|
|
71767
72282
|
* is either an empty string or a path ending with a "/" (since 1.141.0)
|
|
71768
72283
|
*/
|
|
71769
72284
|
prefix?: string;
|
|
@@ -71988,7 +72503,7 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
71988
72503
|
*/
|
|
71989
72504
|
getBinding(): ODataContextBinding | ODataListBinding;
|
|
71990
72505
|
/**
|
|
71991
|
-
* Returns the "canonical path" of the entity for this context. According to "4.3.1 Canonical URL" of the specification "OData Version 4.
|
|
72506
|
+
* Returns the "canonical path" of the entity for this context. According to "4.3.1 Canonical URL" of the specification "OData Version 4.01. Part 2: URL Conventions", this is
|
|
71992
72507
|
* the "name of the entity set associated with the entity followed by the key predicate identifying the
|
|
71993
72508
|
* entity within the collection". Use the canonical path in {@link sap.ui.core.Element#bindElement} to create
|
|
71994
72509
|
* an element binding.
|
|
@@ -72038,7 +72553,7 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
72038
72553
|
/**
|
|
72039
72554
|
* Returns the value for the given path relative to this context. The function allows access to the complete
|
|
72040
72555
|
* data the context points to (if `sPath` is "") or any part thereof. The data is a JSON structure as described
|
|
72041
|
-
* in "OData JSON Format Version 4.
|
|
72556
|
+
* in "OData JSON Format Version 4.01".
|
|
72042
72557
|
* Note that the function clones the result. Modify values via {@link sap.ui.model.odata.v4.ODataPropertyBinding#setValue}.
|
|
72043
72558
|
*
|
|
72044
72559
|
* Returns `undefined` if the data is not (yet) available; no request is initiated. Use {@link #requestObject }
|
|
@@ -72285,7 +72800,8 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
72285
72800
|
* If the context belongs to a list binding, the parameter allows the list binding to remove the context
|
|
72286
72801
|
* from the list binding's collection because the entity does not match the binding's filter anymore, see
|
|
72287
72802
|
* {@link sap.ui.model.odata.v4.ODataListBinding#filter}; a removed context is destroyed, see {@link #destroy}.
|
|
72288
|
-
* If the context belongs to a context binding
|
|
72803
|
+
* If the context belongs to a context binding or to a list binding with "$$aggregation", the parameter
|
|
72804
|
+
* must not be used. Supported since 1.55.0
|
|
72289
72805
|
*
|
|
72290
72806
|
* Since 1.84.0, if this context is {@link #isKeepAlive kept alive}, it is only destroyed if the corresponding
|
|
72291
72807
|
* entity does no longer exist in the back end. In this case, the `fnOnBeforeDestroy` callback passed with
|
|
@@ -72307,7 +72823,7 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
72307
72823
|
oOtherContext: Context
|
|
72308
72824
|
): void;
|
|
72309
72825
|
/**
|
|
72310
|
-
* Returns a promise for the "canonical path" of the entity for this context. According to "4.3.1 Canonical URL" of the specification "OData Version 4.
|
|
72826
|
+
* Returns a promise for the "canonical path" of the entity for this context. According to "4.3.1 Canonical URL" of the specification "OData Version 4.01. Part 2: URL Conventions", this is
|
|
72311
72827
|
* the "name of the entity set associated with the entity followed by the key predicate identifying the
|
|
72312
72828
|
* entity within the collection". Use the canonical path in {@link sap.ui.core.Element#bindElement} to create
|
|
72313
72829
|
* an element binding.
|
|
@@ -72328,7 +72844,7 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
72328
72844
|
* Returns a promise on the value for the given path relative to this context. The function allows access
|
|
72329
72845
|
* to the complete data the context points to (if `sPath` is "") or any part thereof. The data is a JSON
|
|
72330
72846
|
* structure as described in "OData
|
|
72331
|
-
* JSON Format Version 4.
|
|
72847
|
+
* JSON Format Version 4.01". Note that the function clones the result. Modify values via {@link #setProperty}.
|
|
72332
72848
|
*
|
|
72333
72849
|
* The header context of a list binding only delivers `$count` and `@$ui5.context.isSelected` (wrapped in
|
|
72334
72850
|
* an object if `sPath` is "").
|
|
@@ -72410,10 +72926,10 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
72410
72926
|
bAllowRemoval?: boolean
|
|
72411
72927
|
): Promise<void>;
|
|
72412
72928
|
/**
|
|
72413
|
-
* Loads side effects for this context using the given "14.5
|
|
72414
|
-
* "14.
|
|
72415
|
-
* implicit loading is switched off via the binding-specific parameter `$$patchWithoutSideEffects`.
|
|
72416
|
-
* method can be called on
|
|
72929
|
+
* Loads side effects for this context using the given "14.4.1.5 Expression edm:NavigationPropertyPath"
|
|
72930
|
+
* or "14.4.1.6 Expression edm:PropertyPath" objects. Use this method to explicitly load side effects in
|
|
72931
|
+
* case implicit loading is switched off via the binding-specific parameter `$$patchWithoutSideEffects`.
|
|
72932
|
+
* The method can be called on
|
|
72417
72933
|
* the bound context of a context binding, the return value context of an operation binding,
|
|
72418
72934
|
* a context of a list binding representing a single entity, the header context of a list binding;
|
|
72419
72935
|
* side effects are loaded for the whole binding in this case. Key predicates must be available in
|
|
@@ -72459,7 +72975,7 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
72459
72975
|
*/
|
|
72460
72976
|
requestSideEffects(
|
|
72461
72977
|
/**
|
|
72462
|
-
* The "14.5
|
|
72978
|
+
* The "14.4.1.5 Expression edm:NavigationPropertyPath" or "14.4.1.6 Expression edm:PropertyPath" objects
|
|
72463
72979
|
* describing which properties need to be loaded because they may have changed due to side effects of a
|
|
72464
72980
|
* previous update, for example `[{$PropertyPath : "TEAM_ID"}, {$NavigationPropertyPath : "EMPLOYEE_2_MANAGER"},
|
|
72465
72981
|
* {$PropertyPath : "EMPLOYEE_2_TEAM/Team_Id"}]`. An empty navigation property path means that the whole
|
|
@@ -72470,7 +72986,7 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
72470
72986
|
*
|
|
72471
72987
|
* Since 1.82.0, absolute paths are supported. Absolute paths must start with the entity container (example
|
|
72472
72988
|
* "/com.sap.gateway.default.iwbep.tea_busi.v0001.Container/TEAMS") of the service. All (navigation) properties
|
|
72473
|
-
* in the complete model matching such an absolute path are updated. Since 1.85.0, "14.
|
|
72989
|
+
* in the complete model matching such an absolute path are updated. Since 1.85.0, "14.3.11 Expression edm:String"
|
|
72474
72990
|
* is accepted as well.
|
|
72475
72991
|
*
|
|
72476
72992
|
* Since 1.108.8, a property path matching the "com.sap.vocabularies.Common.v1.Messages" annotation of a
|
|
@@ -73105,7 +73621,7 @@ declare module "sap/ui/model/odata/v4/ODataContextBinding" {
|
|
|
73105
73621
|
* Returns a promise on the value for the given path relative to this binding. The function allows access
|
|
73106
73622
|
* to the complete data the binding points to (if `sPath` is "") or any part thereof. The data is a JSON
|
|
73107
73623
|
* structure as described in "OData
|
|
73108
|
-
* JSON Format Version 4.
|
|
73624
|
+
* JSON Format Version 4.01". Note that the function clones the result. Modify values via {@link sap.ui.model.odata.v4.Context#setProperty}.
|
|
73109
73625
|
*
|
|
73110
73626
|
* If you want {@link #requestObject} to read fresh data, call `oBinding.refresh()` first.
|
|
73111
73627
|
* See:
|
|
@@ -74359,7 +74875,7 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
74359
74875
|
*/
|
|
74360
74876
|
hierarchyQualifier?: string;
|
|
74361
74877
|
/**
|
|
74362
|
-
* Like the "5.1.
|
|
74878
|
+
* Like the "5.1.8 System Query Option $search", but applied before data aggregation (since 1.93.0). Note that
|
|
74363
74879
|
* certain content will break the syntax of the system query option `$apply` and result in an invalid request.
|
|
74364
74880
|
* If the OData service supports the proposal ODATA-1452,
|
|
74365
74881
|
* then `ODataUtils.formatLiteral(sSearch, "Edm.String");` should be used to encapsulate the whole search
|
|
@@ -75189,12 +75705,12 @@ declare module "sap/ui/model/odata/v4/ODataMetaModel" {
|
|
|
75189
75705
|
* ```
|
|
75190
75706
|
*
|
|
75191
75707
|
*
|
|
75192
|
-
* The basic idea is that every path described in "14.2.
|
|
75193
|
-
* is a valid absolute path within the metadata model if a leading slash is added; for example
|
|
75194
|
-
*
|
|
75195
|
-
*
|
|
75196
|
-
*
|
|
75197
|
-
*
|
|
75708
|
+
* The basic idea is that every path described in "14.2.2 Target" in specification "OData Common Schema Definition Language (CSDL) XML Representation
|
|
75709
|
+
* Version 4.01" is a valid absolute path within the metadata model if a leading slash is added; for example
|
|
75710
|
+
* "/" + "MySchema.MyEntityContainer/MyEntitySet/MyComplexProperty/MyNavigationProperty". Also, every path
|
|
75711
|
+
* described in "14.4.1.1 Path Syntax" is a valid relative path within the metadata model if a suitable
|
|
75712
|
+
* prefix is added which addresses an entity container, entity set, singleton, complex type, entity type,
|
|
75713
|
+
* or property; for example "/MySchema.MyEntityType/MyProperty" + "@vCard.Address#work/FullName".
|
|
75198
75714
|
*
|
|
75199
75715
|
* The absolute path is split into segments and followed step-by-step, starting at the global scope of all
|
|
75200
75716
|
* known qualified OData names. There are two technical properties there: "$Version" (typically "4.0") and
|
|
@@ -75224,21 +75740,21 @@ declare module "sap/ui/model/odata/v4/ODataMetaModel" {
|
|
|
75224
75740
|
* and followed step-by-step before the next segment is processed. Except for this, a path must not continue
|
|
75225
75741
|
* if it comes across a non-object value. Such a string value can be a qualified name (example path "/$EntityContainer/..."),
|
|
75226
75742
|
* a simple identifier (example path "/TEAMS/$NavigationPropertyBinding/TEAM_2_EMPLOYEES/...") including
|
|
75227
|
-
* the special name "$ReturnType" (since 1.71.0), or even a path according to "14.
|
|
75228
|
-
*
|
|
75743
|
+
* the special name "$ReturnType" (since 1.71.0), or even a path according to "14.4.1.1 Path Syntax" (example
|
|
75744
|
+
* path "/TEAMS/@com.sap.vocabularies.UI.v1.LineItem/0/Value/$Path/...".
|
|
75229
75745
|
*
|
|
75230
75746
|
* Segments starting with an "@" character, for example "@com.sap.vocabularies.Common.v1.Label", address
|
|
75231
75747
|
* annotations at the current object. As the first segment, they refer to the single entity container. For
|
|
75232
|
-
* objects which can only be annotated inline (see "14.
|
|
75233
|
-
*
|
|
75234
|
-
*
|
|
75235
|
-
*
|
|
75236
|
-
*
|
|
75748
|
+
* objects which can only be annotated inline (see "14.2 Annotation" minus "14.2.2 Target"), the object
|
|
75749
|
+
* already contains the annotations as a property. For objects which can (only or also) be annotated via
|
|
75750
|
+
* external targeting, the object does not contain any annotation as a property. Such annotations MUST be
|
|
75751
|
+
* accessed via a path. Such objects include operations (that is, actions and functions) and their parameters,
|
|
75752
|
+
* which can be annotated for a single overload or for all overloads at the same time.
|
|
75237
75753
|
*
|
|
75238
75754
|
* Segments starting with an OData name followed by an "@" character, for example "/TEAMS@Org.OData.Capabilities.V1.TopSupported",
|
|
75239
75755
|
* address annotations at an entity set, singleton, or property, not at the corresponding type. In contrast,
|
|
75240
75756
|
* "/TEAMS/@com.sap.vocabularies.Common.v1.Deletable" (note the separating slash) addresses an annotation
|
|
75241
|
-
* at the entity set's type. This is in line with the special rule of "14.
|
|
75757
|
+
* at the entity set's type. This is in line with the special rule of "14.4.1.2 Path Evaluation" regarding
|
|
75242
75758
|
* annotations at a navigation property itself.
|
|
75243
75759
|
*
|
|
75244
75760
|
* "@" can be used as a segment to address a map of all annotations of the current object. This is useful
|
|
@@ -75248,11 +75764,11 @@ declare module "sap/ui/model/odata/v4/ODataMetaModel" {
|
|
|
75248
75764
|
* "@com.sap.vocabularies.Common.v1.Text@com.sap.vocabularies.Common.v1.TextArrangement". Each annotation
|
|
75249
75765
|
* can have a qualifier, for example "@first#foo@second#bar". Note: If the first annotation's value is a
|
|
75250
75766
|
* record, a separate segment addresses an annotation of that record, not an annotation of the first annotation
|
|
75251
|
-
* itself. In a similar way, annotations of "
|
|
75252
|
-
* "10.
|
|
75253
|
-
* Attribute Property>@...", "$OnDelete@...", "<10.
|
|
75254
|
-
* Property>@..." (where angle brackets denote a variable part and sections refer to specification "OData
|
|
75255
|
-
*
|
|
75767
|
+
* itself. In a similar way, annotations of "8.5 Element edm:ReferentialConstraint", "8.6 Element edm:OnDelete",
|
|
75768
|
+
* "10.3 Element edm:Member" and "14.4.12 Element edm:PropertyValue" are addressed by segments like "<8.5
|
|
75769
|
+
* Attribute Property>@...", "$OnDelete@...", "<10.3 Attribute Name>@..." and "<14.4.12 Attribute
|
|
75770
|
+
* Property>@..." (where angle brackets denote a variable part and sections refer to specification "OData Common Schema
|
|
75771
|
+
* Definition Language (CSDL) XML Representation Version 4.01").
|
|
75256
75772
|
*
|
|
75257
75773
|
* Annotations starting with "@@", for example "@@sap.ui.model.odata.v4.AnnotationHelper.isMultiple" or
|
|
75258
75774
|
* "@@.AH.isMultiple" or "@@.isMultiple", represent computed annotations. Their name without the "@@" prefix
|
|
@@ -75497,7 +76013,7 @@ declare module "sap/ui/model/odata/v4/ODataMetaModel" {
|
|
|
75497
76013
|
*/
|
|
75498
76014
|
bAutoExpandSelect?: boolean,
|
|
75499
76015
|
/**
|
|
75500
|
-
* Context to resolve "14.
|
|
76016
|
+
* Context to resolve "14.4.1.7 Expression edm:Path" references contained in a "com.sap.vocabularies.Common.v1.ValueListRelevantQualifiers"
|
|
75501
76017
|
* annotation. Supported since 1.84.0
|
|
75502
76018
|
*/
|
|
75503
76019
|
oContext?: Context1
|
|
@@ -75578,9 +76094,9 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
|
|
|
75578
76094
|
*
|
|
75579
76095
|
* This model is not prepared to be inherited from.
|
|
75580
76096
|
*
|
|
75581
|
-
* Every resource path (relative to the service root URL, no query options) according to "4 Resource Path" in specification "OData Version 4.
|
|
75582
|
-
* path within this model if a leading slash is added; for example "/" + "SalesOrderList('A%2FB%26C')"
|
|
75583
|
-
* access an entity instance with key "A/B&C". Note that appropriate URI encoding is necessary, see the
|
|
76097
|
+
* Every resource path (relative to the service root URL, no query options) according to "4 Resource Path" in specification "OData Version 4.01. Part 2: URL Conventions" is a valid data
|
|
76098
|
+
* binding path within this model if a leading slash is added; for example "/" + "SalesOrderList('A%2FB%26C')"
|
|
76099
|
+
* to access an entity instance with key "A/B&C". Note that appropriate URI encoding is necessary, see the
|
|
75584
76100
|
* example of {@link sap.ui.model.odata.v4.ODataUtils.formatLiteral}. "4.5.1 Addressing Actions" needs an
|
|
75585
76101
|
* operation binding, see {@link sap.ui.model.odata.v4.ODataContextBinding}.
|
|
75586
76102
|
*
|
|
@@ -75662,7 +76178,7 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
|
|
|
75662
76178
|
*/
|
|
75663
76179
|
metadataUrlParams?: object;
|
|
75664
76180
|
/**
|
|
75665
|
-
* The version of the OData service. Supported values are "2.0" and "4.
|
|
76181
|
+
* The version of the OData service. Supported values are "2.0", "4.0", and "4.01".
|
|
75666
76182
|
*/
|
|
75667
76183
|
odataVersion?: string;
|
|
75668
76184
|
/**
|
|
@@ -75676,7 +76192,7 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
|
|
|
75676
76192
|
* Root URL of the service to request data from. The path part of the URL must end with a forward slash
|
|
75677
76193
|
* according to OData V4 specification ABNF, rule "serviceRoot". You may append OData custom query options
|
|
75678
76194
|
* to the service root URL separated with a "?", for example "/MyService/?custom=foo". See specification
|
|
75679
|
-
* "OData Version 4.
|
|
76195
|
+
* "OData Version 4.01. Part 2: URL Conventions", "5.2 Custom Query Options". OData system query options
|
|
75680
76196
|
* and OData parameter aliases lead to an error.
|
|
75681
76197
|
*/
|
|
75682
76198
|
serviceUrl: string;
|
|
@@ -75812,7 +76328,7 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
|
|
|
75812
76328
|
*/
|
|
75813
76329
|
oContext?: Context,
|
|
75814
76330
|
/**
|
|
75815
|
-
* Map of binding parameters which can be OData query options as specified in "OData Version 4.
|
|
76331
|
+
* Map of binding parameters which can be OData query options as specified in "OData Version 4.01. Part 2: URL Conventions" or the binding-specific parameters as specified below.
|
|
75816
76332
|
* Note: The binding creates its own data service request if it is absolute or if it has any parameters
|
|
75817
76333
|
* or if it is relative and has a context created via {@link #createBindingContext}. The following OData
|
|
75818
76334
|
* query options are allowed:
|
|
@@ -75824,7 +76340,7 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
|
|
|
75824
76340
|
*/
|
|
75825
76341
|
mParameters?: {
|
|
75826
76342
|
/**
|
|
75827
|
-
* The value for the "5.1.
|
|
76343
|
+
* The value for the "5.1.3 System Query Option $expand" or an object which determines that value. The object
|
|
75828
76344
|
* is a map from expand path to expand options, where the options are again maps of system query options,
|
|
75829
76345
|
* typically with string values. $count can also be given as a `boolean` value, $expand can recursively
|
|
75830
76346
|
* be given as a map, $levels can also be given as a `number` value, and $select can also be given as an
|
|
@@ -75832,9 +76348,9 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
|
|
|
75832
76348
|
*/
|
|
75833
76349
|
$expand?: string | object;
|
|
75834
76350
|
/**
|
|
75835
|
-
* A comma separated list or an array of items which determine the value for the "5.1.
|
|
76351
|
+
* A comma separated list or an array of items which determine the value for the "5.1.4 System Query Option
|
|
75836
76352
|
* $select". Since 1.75.0, when using the "autoExpandSelect" model parameter (see {@link #constructor}),
|
|
75837
|
-
* paths with navigation properties can be included and will contribute to the "5.1.
|
|
76353
|
+
* paths with navigation properties can be included and will contribute to the "5.1.3 System Query Option
|
|
75838
76354
|
* $expand".
|
|
75839
76355
|
*/
|
|
75840
76356
|
$select?: string | string[];
|
|
@@ -75908,10 +76424,10 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
|
|
|
75908
76424
|
*/
|
|
75909
76425
|
vFilters?: Filter | Filter[],
|
|
75910
76426
|
/**
|
|
75911
|
-
* Map of binding parameters which can be OData query options as specified in "OData Version 4.
|
|
75912
|
-
* The binding creates its own data service request if it is absolute or if it has any parameters
|
|
75913
|
-
* it is relative and has a context created via {@link #createBindingContext} or if it has sorters
|
|
75914
|
-
* The following OData query options are allowed:
|
|
76427
|
+
* Map of binding parameters which can be OData query options as specified in "OData Version 4.01. Part 2: URL Conventions" or binding-specific parameters as specified below.
|
|
76428
|
+
* Note: The binding creates its own data service request if it is absolute or if it has any parameters
|
|
76429
|
+
* or if it is relative and has a context created via {@link #createBindingContext} or if it has sorters
|
|
76430
|
+
* or filters. The following OData query options are allowed:
|
|
75915
76431
|
* All "5.2 Custom Query Options" except for those with a name starting with "sap-" (unless starting with
|
|
75916
76432
|
* "sap-valid-") The $apply, $count, $expand, $filter, $levels, $orderby, $search, and $select "5.1
|
|
75917
76433
|
* System Query Options"; OData V4 only allows $levels inside $expand. All other query options lead
|
|
@@ -75924,11 +76440,11 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
|
|
|
75924
76440
|
*/
|
|
75925
76441
|
$apply?: string;
|
|
75926
76442
|
/**
|
|
75927
|
-
* The value for the "5.1.
|
|
76443
|
+
* The value for the "5.1.7 System Query Option $count", useful for creation at the end and {@link sap.ui.model.odata.v4.ODataListBinding#getCount}
|
|
75928
76444
|
*/
|
|
75929
76445
|
$count?: string | boolean;
|
|
75930
76446
|
/**
|
|
75931
|
-
* The value for the "5.1.
|
|
76447
|
+
* The value for the "5.1.3 System Query Option $expand" or an object which determines that value. The object
|
|
75932
76448
|
* is a map from expand path to expand options, where the options are again maps of system query options,
|
|
75933
76449
|
* typically with string values. $count can also be given as a `boolean` value, $expand can recursively
|
|
75934
76450
|
* be given as a map, $levels can also be given as a `number` value, and $select can also be given as an
|
|
@@ -75936,22 +76452,22 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
|
|
|
75936
76452
|
*/
|
|
75937
76453
|
$expand?: string | object;
|
|
75938
76454
|
/**
|
|
75939
|
-
* The value for the "5.1.
|
|
76455
|
+
* The value for the "5.1.2 System Query Option $filter" used in addition to `vFilters`
|
|
75940
76456
|
*/
|
|
75941
76457
|
$filter?: string;
|
|
75942
76458
|
/**
|
|
75943
|
-
* The value for the "5.1.
|
|
76459
|
+
* The value for the "5.1.5 System Query Option $orderby" used in addition to `vSorters`
|
|
75944
76460
|
*/
|
|
75945
76461
|
$orderby?: string | number;
|
|
75946
76462
|
/**
|
|
75947
|
-
* The value for the "5.1.
|
|
76463
|
+
* The value for the "5.1.8 System Query Option $search"; see also `oAggregation.search` at {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation }
|
|
75948
76464
|
* and the note there!
|
|
75949
76465
|
*/
|
|
75950
76466
|
$search?: string;
|
|
75951
76467
|
/**
|
|
75952
|
-
* A comma separated list or an array of items which determine the value for the "5.1.
|
|
76468
|
+
* A comma separated list or an array of items which determine the value for the "5.1.4 System Query Option
|
|
75953
76469
|
* $select". Since 1.75.0, when using the "autoExpandSelect" model parameter (see {@link #constructor}),
|
|
75954
|
-
* paths with navigation properties can be included and will contribute to the "5.1.
|
|
76470
|
+
* paths with navigation properties can be included and will contribute to the "5.1.3 System Query Option
|
|
75955
76471
|
* $expand".
|
|
75956
76472
|
*/
|
|
75957
76473
|
$select?: string | string[];
|
|
@@ -76086,7 +76602,7 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
|
|
|
76086
76602
|
*/
|
|
76087
76603
|
oContext?: Context1,
|
|
76088
76604
|
/**
|
|
76089
|
-
* Map of binding parameters which can be OData query options as specified in "OData Version 4.
|
|
76605
|
+
* Map of binding parameters which can be OData query options as specified in "OData Version 4.01. Part 2: URL Conventions" or the binding-specific parameters as specified below.
|
|
76090
76606
|
* The following OData query options are allowed:
|
|
76091
76607
|
* All "5.2 Custom Query Options" except for those with a name starting with "sap-" (unless starting with
|
|
76092
76608
|
* "sap-valid-") The $apply, $filter, and $search "5.1 System Query Options" if the path ends with
|
|
@@ -76102,11 +76618,11 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
|
|
|
76102
76618
|
*/
|
|
76103
76619
|
$apply?: string;
|
|
76104
76620
|
/**
|
|
76105
|
-
* The value for the "5.1.
|
|
76621
|
+
* The value for the "5.1.2 System Query Option $filter", if the path ends with a "$count" segment
|
|
76106
76622
|
*/
|
|
76107
76623
|
$filter?: string;
|
|
76108
76624
|
/**
|
|
76109
|
-
* The value for the "5.1.
|
|
76625
|
+
* The value for the "5.1.8 System Query Option $search", if the path ends with a "$count" segment
|
|
76110
76626
|
*/
|
|
76111
76627
|
$search?: string;
|
|
76112
76628
|
/**
|
|
@@ -76164,10 +76680,10 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
|
|
|
76164
76680
|
* requests within the batch. The headers are changed according to the given map of headers: Headers with
|
|
76165
76681
|
* an `undefined` value are removed, the other headers are set, and missing headers remain unchanged. The
|
|
76166
76682
|
* following headers must not be used:
|
|
76167
|
-
* OData V4 requests headers as specified in "8.1 Common Headers" and "8.2 Request Headers" of the specification "OData Version 4.
|
|
76168
|
-
* OData V2 request headers as specified in "2.2.5 HTTP Header Fields" of the specification
|
|
76169
|
-
* Version 2 v10.1" The headers "Content-Id" and "Content-Transfer-Encoding" The header
|
|
76170
|
-
* Note: The "X-CSRF-Token" header will not be used for metadata requests.
|
|
76683
|
+
* OData V4 requests headers as specified in "8.1 Common Headers" and "8.2 Request Headers" of the specification "OData Version 4.01. Part 1:
|
|
76684
|
+
* Protocol" OData V2 request headers as specified in "2.2.5 HTTP Header Fields" of the specification
|
|
76685
|
+
* "OData Version 2 v10.1" The headers "Content-Id" and "Content-Transfer-Encoding" The header
|
|
76686
|
+
* "SAP-ContextId" Note: The "X-CSRF-Token" header will not be used for metadata requests.
|
|
76171
76687
|
*
|
|
76172
76688
|
* If not `undefined`, a header value must conform to the following rules:
|
|
76173
76689
|
* It must be a non-empty string. It must be completely in the US-ASCII character set. It must
|
|
@@ -76551,10 +77067,11 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
|
|
|
76551
77067
|
sGroupId?: string | boolean
|
|
76552
77068
|
): void;
|
|
76553
77069
|
/**
|
|
76554
|
-
* Returns a promise for the "canonical path" of the entity for the given context. According to "4.3.1
|
|
76555
|
-
*
|
|
76556
|
-
* entity
|
|
76557
|
-
* an element
|
|
77070
|
+
* Returns a promise for the "canonical path" of the entity for the given context. According to "4.3.1
|
|
77071
|
+
* Canonical URL" of the specification "OData Version 4.01. Part 2: URL Conventions", this is the "name
|
|
77072
|
+
* of the entity set associated with the entity followed by the key predicate identifying the entity within
|
|
77073
|
+
* the collection". Use the canonical path in {@link sap.ui.core.Element#bindElement} to create an element
|
|
77074
|
+
* binding.
|
|
76558
77075
|
*
|
|
76559
77076
|
* @since 1.37.0
|
|
76560
77077
|
* @deprecated As of version 1.39.0. Use {@link sap.ui.model.odata.v4.Context#requestCanonicalPath} instead.
|
|
@@ -77276,11 +77793,11 @@ declare module "sap/ui/model/odata/v4/ODataUtils" {
|
|
|
77276
77793
|
*
|
|
77277
77794
|
* @since 1.64.0
|
|
77278
77795
|
*
|
|
77279
|
-
* @returns The literal according to "OData Version 4.
|
|
77796
|
+
* @returns The literal according to "OData Version 4.01. Part 2: URL Conventions" section "5.1.1.14.1 Primitive Literals"
|
|
77280
77797
|
*/
|
|
77281
77798
|
formatLiteral(
|
|
77282
77799
|
/**
|
|
77283
|
-
* The value according to "OData JSON Format Version 4.
|
|
77800
|
+
* The value according to "OData JSON Format Version 4.01" section "7.1 Primitive Value"
|
|
77284
77801
|
*/
|
|
77285
77802
|
vValue: any,
|
|
77286
77803
|
/**
|
|
@@ -77367,7 +77884,7 @@ declare module "sap/ui/model/odata/v4/ts" {
|
|
|
77367
77884
|
export default ts;
|
|
77368
77885
|
|
|
77369
77886
|
/**
|
|
77370
|
-
* An object representing a "14.5
|
|
77887
|
+
* An object representing a "14.4.1.5 Expression edm:NavigationPropertyPath". Its shape corresponds exactly
|
|
77371
77888
|
* to the shape of such an expression in the {@link https://ui5.sap.com/#/topic/87aac894a40640f89920d7b2a414499b OData V4 Metadata JSON Format }
|
|
77372
77889
|
* as returned by {@link sap.ui.model.odata.v4.ODataMetaModel#requestObject}.
|
|
77373
77890
|
* See:
|
|
@@ -77383,7 +77900,7 @@ declare module "sap/ui/model/odata/v4/ts" {
|
|
|
77383
77900
|
};
|
|
77384
77901
|
|
|
77385
77902
|
/**
|
|
77386
|
-
* An object representing a "14.
|
|
77903
|
+
* An object representing a "14.4.1.6 Expression edm:PropertyPath". Its shape corresponds exactly to the
|
|
77387
77904
|
* shape of such an expression in the {@link https://ui5.sap.com/#/topic/87aac894a40640f89920d7b2a414499b OData V4 Metadata JSON Format }
|
|
77388
77905
|
* as returned by {@link sap.ui.model.odata.v4.ODataMetaModel#requestObject}.
|
|
77389
77906
|
* See:
|
|
@@ -89258,12 +89775,16 @@ declare namespace sap {
|
|
|
89258
89775
|
|
|
89259
89776
|
"sap/ui/test/RecordReplay": undefined;
|
|
89260
89777
|
|
|
89778
|
+
"sap/ui/test/starter/config": undefined;
|
|
89779
|
+
|
|
89261
89780
|
"sap/ui/test/utils/nextUIUpdate": undefined;
|
|
89262
89781
|
|
|
89263
89782
|
"sap/ui/test/utils/waitForThemeApplied": undefined;
|
|
89264
89783
|
|
|
89265
89784
|
"sap/ui/thirdparty/jquery": undefined;
|
|
89266
89785
|
|
|
89786
|
+
"sap/ui/util/_URL": undefined;
|
|
89787
|
+
|
|
89267
89788
|
"sap/ui/util/ActivityDetection": undefined;
|
|
89268
89789
|
|
|
89269
89790
|
"sap/ui/util/defaultLinkTypes": undefined;
|