@openui5/ts-types 1.133.0 → 1.134.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/types/sap.f.d.ts +49 -8
- package/types/sap.m.d.ts +641 -74
- package/types/sap.tnt.d.ts +105 -7
- package/types/sap.ui.codeeditor.d.ts +9 -7
- package/types/sap.ui.commons.d.ts +1 -1
- package/types/sap.ui.core.d.ts +351 -55
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +1 -1
- package/types/sap.ui.integration.d.ts +1 -3
- package/types/sap.ui.layout.d.ts +2 -2
- package/types/sap.ui.mdc.d.ts +227 -11
- package/types/sap.ui.rta.d.ts +79 -1
- package/types/sap.ui.suite.d.ts +1 -1
- package/types/sap.ui.support.d.ts +1 -1
- package/types/sap.ui.table.d.ts +1 -1
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +41 -47
- package/types/sap.ui.ux3.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.uxap.d.ts +7 -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.134.0
|
|
283
283
|
|
|
284
284
|
declare module "sap/base/assert" {
|
|
285
285
|
/**
|
|
@@ -2989,7 +2989,7 @@ declare module "sap/base/util/each" {
|
|
|
2989
2989
|
/**
|
|
2990
2990
|
* function to call for each property name
|
|
2991
2991
|
*/
|
|
2992
|
-
fnCallback: (p1: Key, p2: any) => boolean
|
|
2992
|
+
fnCallback: (this: any, p1: Key, p2: any) => boolean
|
|
2993
2993
|
): object | any[];
|
|
2994
2994
|
/**
|
|
2995
2995
|
* The key that is passed to the callback as the first parameter
|
|
@@ -4800,7 +4800,9 @@ declare module "sap/ui/core/fieldhelp/FieldHelpUtil" {
|
|
|
4800
4800
|
protected constructor();
|
|
4801
4801
|
|
|
4802
4802
|
/**
|
|
4803
|
-
* Sets the field help information for the given element as `sap-ui-DocumentationRef` custom data.
|
|
4803
|
+
* Sets the field help information for the given element as `sap-ui-DocumentationRef` custom data. Note
|
|
4804
|
+
* that field help inferred from data bindings of control properties is overwritten by this method unless
|
|
4805
|
+
* an empty array is given in parameter `vDocumentationRefs`.
|
|
4804
4806
|
*/
|
|
4805
4807
|
static setDocumentationRef(
|
|
4806
4808
|
/**
|
|
@@ -5764,6 +5766,24 @@ declare module "sap/ui/model/odata/ODataExpressionAddons" {
|
|
|
5764
5766
|
export default ODataExpressionAddons;
|
|
5765
5767
|
}
|
|
5766
5768
|
|
|
5769
|
+
declare module "sap/ui/model/odata/v2/ODataModel" {
|
|
5770
|
+
/**
|
|
5771
|
+
* The error object passed to the retry after callback.
|
|
5772
|
+
*
|
|
5773
|
+
* @since 1.134.0
|
|
5774
|
+
*/
|
|
5775
|
+
export type RetryAfterError = Error & {
|
|
5776
|
+
/**
|
|
5777
|
+
* Error message returned by the 503 HTTP status response
|
|
5778
|
+
*/
|
|
5779
|
+
message: string;
|
|
5780
|
+
/**
|
|
5781
|
+
* The earliest point in time the request may be repeated
|
|
5782
|
+
*/
|
|
5783
|
+
retryAfter: Date;
|
|
5784
|
+
};
|
|
5785
|
+
}
|
|
5786
|
+
|
|
5767
5787
|
declare module "sap/ui/performance/Measurement" {
|
|
5768
5788
|
/**
|
|
5769
5789
|
* Performance Measurement API.
|
|
@@ -10974,25 +10994,31 @@ declare namespace sap {
|
|
|
10974
10994
|
*/
|
|
10975
10995
|
useInternalValues?: boolean;
|
|
10976
10996
|
/**
|
|
10977
|
-
* A type object or the name of a type class to create
|
|
10978
|
-
*
|
|
10979
|
-
|
|
10980
|
-
|
|
10981
|
-
/**
|
|
10982
|
-
* Target type to be used by the type when formatting model data, for example "boolean" or "string" or "any";
|
|
10983
|
-
* defaults to the property's type
|
|
10997
|
+
* A type object, or the name or constructor of a type class which is used to create a type object.
|
|
10998
|
+
*
|
|
10999
|
+
* The type will be used for converting model data to a property value (aka "formatting") and vice versa
|
|
11000
|
+
* (in binding mode `TwoWay`, aka "parsing")
|
|
10984
11001
|
*/
|
|
10985
|
-
|
|
11002
|
+
type?:
|
|
11003
|
+
| sap.ui.model.Type
|
|
11004
|
+
| string
|
|
11005
|
+
| (new (p1?: object, p2?: object) => sap.ui.model.Type);
|
|
10986
11006
|
/**
|
|
10987
|
-
* Format options to be used
|
|
10988
|
-
*
|
|
11007
|
+
* Format options to be used when creating the type instance; the structure of the options depends on the
|
|
11008
|
+
* given type class. If a type object is given as `type`, it won't be modified - the formatOptions
|
|
11009
|
+
* will be ignored
|
|
10989
11010
|
*/
|
|
10990
11011
|
formatOptions?: object;
|
|
10991
11012
|
/**
|
|
10992
|
-
* Additional constraints to be used when constructing a type
|
|
10993
|
-
* object is given
|
|
11013
|
+
* Additional constraints to be used when constructing a type instance. Their structure depends on the given
|
|
11014
|
+
* type class. If a type object is given as `type`, it won't be modified - the `constraints` will be ignored
|
|
10994
11015
|
*/
|
|
10995
11016
|
constraints?: object;
|
|
11017
|
+
/**
|
|
11018
|
+
* Target type to be used by the type when formatting model data, for example "boolean" or "string" or "any";
|
|
11019
|
+
* defaults to the property's type
|
|
11020
|
+
*/
|
|
11021
|
+
targetType?: string;
|
|
10996
11022
|
/**
|
|
10997
11023
|
* Binding mode to be used for this property binding (e.g. one way)
|
|
10998
11024
|
*/
|
|
@@ -14873,7 +14899,7 @@ declare namespace sap {
|
|
|
14873
14899
|
*
|
|
14874
14900
|
* @returns class described by this metadata
|
|
14875
14901
|
*/
|
|
14876
|
-
getClass(): (
|
|
14902
|
+
getClass(): new () => sap.ui.base.Object;
|
|
14877
14903
|
/**
|
|
14878
14904
|
* Returns the fully qualified name of the described class
|
|
14879
14905
|
*
|
|
@@ -15212,7 +15238,7 @@ declare namespace sap {
|
|
|
15212
15238
|
/**
|
|
15213
15239
|
* Constructor for the class of objects that this pool should manage
|
|
15214
15240
|
*/
|
|
15215
|
-
oObjectClass: (
|
|
15241
|
+
oObjectClass: new () => Object
|
|
15216
15242
|
);
|
|
15217
15243
|
|
|
15218
15244
|
/**
|
|
@@ -51388,6 +51414,15 @@ declare namespace sap {
|
|
|
51388
51414
|
*/
|
|
51389
51415
|
type CSSColor = string;
|
|
51390
51416
|
|
|
51417
|
+
/**
|
|
51418
|
+
* A string type that represents a short hand CSS gap.
|
|
51419
|
+
* See:
|
|
51420
|
+
* {@link https://developer.mozilla.org/en-US/docs/Web/CSS/gap}
|
|
51421
|
+
*
|
|
51422
|
+
* @since 1.134
|
|
51423
|
+
*/
|
|
51424
|
+
type CSSGapShortHand = string;
|
|
51425
|
+
|
|
51391
51426
|
/**
|
|
51392
51427
|
* A string type that represents CSS size values.
|
|
51393
51428
|
*
|
|
@@ -51632,6 +51667,223 @@ declare namespace sap {
|
|
|
51632
51667
|
TooltipBase
|
|
51633
51668
|
>;
|
|
51634
51669
|
}
|
|
51670
|
+
/**
|
|
51671
|
+
* Provides access to UI5 loader configuration.
|
|
51672
|
+
*
|
|
51673
|
+
* The configuration is used by {@link sap.ui.require} and {@link sap.ui.define}.
|
|
51674
|
+
*/
|
|
51675
|
+
namespace loader {
|
|
51676
|
+
/**
|
|
51677
|
+
* Sets the configuration for the UI5 loader. The configuration can be updated multiple times. Later changes
|
|
51678
|
+
* do not impact modules that have been loaded before.
|
|
51679
|
+
*
|
|
51680
|
+
* If no parameter is given, a partial copy of UI5 loader configuration in use is returned.
|
|
51681
|
+
*
|
|
51682
|
+
* The configuration options are aligned with the "Common Config" draft of the AMD spec (https://github.com/amdjs/amdjs-api/blob/master/CommonConfig.md).
|
|
51683
|
+
*
|
|
51684
|
+
* The following code shows an example of what a UI5 loader configuration might look like:
|
|
51685
|
+
* ```javascript
|
|
51686
|
+
*
|
|
51687
|
+
*
|
|
51688
|
+
* sap.ui.loader.config({
|
|
51689
|
+
*
|
|
51690
|
+
* // location from where to load all modules by default
|
|
51691
|
+
* baseUrl: '../../resources/',
|
|
51692
|
+
*
|
|
51693
|
+
* paths: {
|
|
51694
|
+
* // load modules whose ID equals to or starts with 'my/module' from example.com
|
|
51695
|
+
* 'my/module': 'https://example.com/resources/my/module'
|
|
51696
|
+
* },
|
|
51697
|
+
*
|
|
51698
|
+
* map: {
|
|
51699
|
+
* // if any module requires 'sinon', load module 'sap/ui/thirdparty/sinon-4'
|
|
51700
|
+
* '*': {
|
|
51701
|
+
* 'sinon': 'sap/ui/thirdparty/sinon-4'
|
|
51702
|
+
* },
|
|
51703
|
+
* // but if a module whose ID equals to or starts with 'app' requires 'sinon'
|
|
51704
|
+
* // then load a legacy version instead
|
|
51705
|
+
* "app": {
|
|
51706
|
+
* 'sinon': 'sap/ui/legacy/sinon'
|
|
51707
|
+
* }
|
|
51708
|
+
* },
|
|
51709
|
+
*
|
|
51710
|
+
* // define two bundles that consists of JS modules only
|
|
51711
|
+
* bundles: {
|
|
51712
|
+
* bundle1: ['module1', 'module2'],
|
|
51713
|
+
* bundle2: ['moduleX', 'moduleY']
|
|
51714
|
+
* },
|
|
51715
|
+
*
|
|
51716
|
+
* // define a bundle that also contains non-JS resources
|
|
51717
|
+
* bundlesUI5: {
|
|
51718
|
+
* 'all.js': ['Component.js', 'manifest.json',
|
|
51719
|
+
* 'App.controller.js', 'App.view.xml']
|
|
51720
|
+
* },
|
|
51721
|
+
*
|
|
51722
|
+
* // activate real async loading and module definitions
|
|
51723
|
+
* async: true,
|
|
51724
|
+
*
|
|
51725
|
+
* // provide dependency and export metadata for non-UI5 modules
|
|
51726
|
+
* shim: {
|
|
51727
|
+
* 'sap/ui/thirdparty/blanket': {
|
|
51728
|
+
* amd: true,
|
|
51729
|
+
* exports: 'blanket'
|
|
51730
|
+
* }
|
|
51731
|
+
* }
|
|
51732
|
+
*
|
|
51733
|
+
* });
|
|
51734
|
+
*
|
|
51735
|
+
* ```
|
|
51736
|
+
*
|
|
51737
|
+
*
|
|
51738
|
+
* @since 1.56.0
|
|
51739
|
+
*
|
|
51740
|
+
* @returns UI5 loader configuration in use.
|
|
51741
|
+
*/
|
|
51742
|
+
function config(
|
|
51743
|
+
/**
|
|
51744
|
+
* The provided configuration gets merged with the UI5 loader configuration in use. If `cfg` is omitted
|
|
51745
|
+
* or `undefined`, a copy of the current configuration gets returned, containing at least the properties
|
|
51746
|
+
* `amd` and `async`.
|
|
51747
|
+
*/
|
|
51748
|
+
cfg?: {
|
|
51749
|
+
/**
|
|
51750
|
+
* Default location to load modules from. If none of the configured `paths` prefixes matches a module ID,
|
|
51751
|
+
* the module will be loaded from the concatenation of the `baseUrl` and the module ID.
|
|
51752
|
+
*
|
|
51753
|
+
* If the `baseUrl` itself is a relative URL, it is evaluated relative to `document.baseURI`.
|
|
51754
|
+
*/
|
|
51755
|
+
baseUrl?: string;
|
|
51756
|
+
/**
|
|
51757
|
+
* A map of resource locations keyed by a corresponding module ID prefix. When a module is to be loaded,
|
|
51758
|
+
* the longest key in `paths` is searched that is a prefix of the module ID. The module will be loaded from
|
|
51759
|
+
* the concatenation of the corresponding value in `paths` and the remainder of the module ID (after the
|
|
51760
|
+
* prefix). If no entry in `paths` matches, then the module will be loaded from the `baseUrl`.
|
|
51761
|
+
*
|
|
51762
|
+
* The prefixes (keys) must not contain relative segments (./ or ../), a trailing slash will be removed,
|
|
51763
|
+
* and only full name segment matches are considered a match (prefix 'sap/m' does not match a module ID
|
|
51764
|
+
* 'sap/main').
|
|
51765
|
+
*
|
|
51766
|
+
* **Note**: In contrast to the "Common Config" of the AMD spec, the paths (values in the map) are interpreted
|
|
51767
|
+
* relative to `document.baseURI`, not relative to `cfg.baseUrl`.
|
|
51768
|
+
*/
|
|
51769
|
+
paths?: Record<string, string>;
|
|
51770
|
+
/**
|
|
51771
|
+
* A map of maps that defines how to map module IDs to other module IDs (inner maps) in the context of a
|
|
51772
|
+
* specific set of modules (keys of outer map).
|
|
51773
|
+
*
|
|
51774
|
+
* Each key of the outer map represents a module ID prefix that describes the context for which its value
|
|
51775
|
+
* (inner map) has to be used. The special key `*` describes the default context which applies for any module.
|
|
51776
|
+
* Only the most specific matching context will be taken into account.
|
|
51777
|
+
*
|
|
51778
|
+
* Each inner map maps a module ID or module ID prefix to another module ID or module ID prefix. Again,
|
|
51779
|
+
* only the most specific match is taken into account and only one mapping is evaluated (the evaluation
|
|
51780
|
+
* of the mappings is not done recursively).
|
|
51781
|
+
*
|
|
51782
|
+
* Matches are always complete matches, a prefix 'a/b/c' does not match the module ID 'a/b/com'.
|
|
51783
|
+
*/
|
|
51784
|
+
map?: Record<string, Record<string, string>>;
|
|
51785
|
+
/**
|
|
51786
|
+
* Defines additional metadata for modules for which the normal behavior of the AMD APIs is not sufficient.
|
|
51787
|
+
*
|
|
51788
|
+
* A typical example are scripts that don't use `define` or `sap.ui.define`, but export to a global name.
|
|
51789
|
+
* With the `exports` property, one or more export names can be specified, and the loader can retrieve the
|
|
51790
|
+
* exported value after executing the corresponding module. If such a module has dependencies, they can
|
|
51791
|
+
* be specified in the `deps` array and are loaded and executed before executing the module.
|
|
51792
|
+
*
|
|
51793
|
+
* The `amd` flag of a shim is a ui5loader-specific extension of the standard AMD shims. If set, the ui5loader
|
|
51794
|
+
* hides a currently active AMD loader before executing the module and restores it afterwards. Otherwise,
|
|
51795
|
+
* it might miss the export of third party modules that check for an AMD loader and register with it instead
|
|
51796
|
+
* of exporting to a global name. A future version of the ui5loader might ignore this flag when it acts
|
|
51797
|
+
* as an AMD loader by itself.
|
|
51798
|
+
*
|
|
51799
|
+
* **Note:** The ui5loader does not support the `init` option described by the "Common Config" section of
|
|
51800
|
+
* the AMD spec.
|
|
51801
|
+
*/
|
|
51802
|
+
shim?: Record<
|
|
51803
|
+
string,
|
|
51804
|
+
{
|
|
51805
|
+
amd: boolean;
|
|
51806
|
+
|
|
51807
|
+
deps: string[];
|
|
51808
|
+
|
|
51809
|
+
exports: string | string[];
|
|
51810
|
+
}
|
|
51811
|
+
>;
|
|
51812
|
+
/**
|
|
51813
|
+
* A map of arrays that each define the modules contained in a bundle.
|
|
51814
|
+
*
|
|
51815
|
+
* Each key of the map represents the module ID of a bundle file. The array value represents the set of
|
|
51816
|
+
* JavaScript modules (their module IDs) that are contained in the bundle.
|
|
51817
|
+
*
|
|
51818
|
+
* When a module is required that has not been loaded yet, and for which a containing bundle is known, that
|
|
51819
|
+
* bundle will be required first. Only then the original module will be required again and usually be taken
|
|
51820
|
+
* from the just loaded bundle.
|
|
51821
|
+
*
|
|
51822
|
+
* A bundle will be loaded asynchronously only when the loader is in asynchronous mode and when the request
|
|
51823
|
+
* for the contained module originates from an asynchronous API. In all other cases, the bundle has to be
|
|
51824
|
+
* loaded synchronously to fulfill API contracts.
|
|
51825
|
+
*
|
|
51826
|
+
* **Note:** The loader only supports one containing bundle per module. If a module is declared to be part
|
|
51827
|
+
* of multiple bundles, only the last one will be taken into account.
|
|
51828
|
+
*
|
|
51829
|
+
* This configuration option is basically provided to be compatible with requireJS or SystemJS configuration.
|
|
51830
|
+
*/
|
|
51831
|
+
bundles?: Record<string, string[]>;
|
|
51832
|
+
/**
|
|
51833
|
+
* A map of arrays that each define the resources contained in a bundle.
|
|
51834
|
+
*
|
|
51835
|
+
* This is similar to `bundles`, but all strings are unified resource names including a file type extension,
|
|
51836
|
+
* not only module IDs. This allows to represent more than just JavaScript modules.
|
|
51837
|
+
*
|
|
51838
|
+
* Each key of the map represents the resource name (in unified resource name syntax) of a bundle file.
|
|
51839
|
+
* The array value represents the set of resources (also in unified resource name syntax) that are contained
|
|
51840
|
+
* in the bundle. The array can contain JavaScript as well as other textual resource types (e.g. *.xml or
|
|
51841
|
+
* *.json resources).
|
|
51842
|
+
*
|
|
51843
|
+
* When a module is required that has not been loaded yet, and for which a containing bundle is known, that
|
|
51844
|
+
* bundle will be required first. Only then the original module will be required again and usually be taken
|
|
51845
|
+
* from the just loaded bundle.
|
|
51846
|
+
*
|
|
51847
|
+
* A bundle will be loaded asynchronously only when the loader is in asynchronous mode and when the request
|
|
51848
|
+
* for the contained module originates from an asynchronous API. In all other cases, the bundle has to be
|
|
51849
|
+
* loaded synchronously to fulfill API contracts.
|
|
51850
|
+
*
|
|
51851
|
+
* **Note:** The loader only supports one containing bundle per module. If a module is declared to be part
|
|
51852
|
+
* of multiple bundles, only the last one will be taken into account.
|
|
51853
|
+
*
|
|
51854
|
+
* **Note:** Although non-JS resources can be declared to be part of a bundle, only requests for JavaScript
|
|
51855
|
+
* modules will currently trigger the loading of a bundle.
|
|
51856
|
+
*/
|
|
51857
|
+
bundlesUI5?: Record<string, string[]>;
|
|
51858
|
+
/**
|
|
51859
|
+
* When set to true, `sap.ui.require` loads modules asynchronously via script tags and `sap.ui.define` executes
|
|
51860
|
+
* asynchronously. To enable this feature, it is recommended to set the attribute `data-sap-ui-async="true"`
|
|
51861
|
+
* on the application bootstrap tag.
|
|
51862
|
+
*
|
|
51863
|
+
* **Note:** Switching back from async to sync is not supported and trying to do so will throw an `Error`
|
|
51864
|
+
*/
|
|
51865
|
+
async?: boolean;
|
|
51866
|
+
/**
|
|
51867
|
+
* When set to true, the ui5loader will overwrite the global properties `define` and `require` with its
|
|
51868
|
+
* own implementations. Any previously active AMD loader will be remembered internally and can be restored
|
|
51869
|
+
* by setting `amd` to false again.
|
|
51870
|
+
*
|
|
51871
|
+
* **Note:** Switching to the `amd` mode, the ui5loader will set `async` to true implicitly for activating
|
|
51872
|
+
* asynchronous loading. Once the loading behaviour has been defined to be asynchronous, it can not be changed
|
|
51873
|
+
* to synchronous behaviour again, also not via setting `amd` to false.
|
|
51874
|
+
*/
|
|
51875
|
+
amd?: boolean;
|
|
51876
|
+
}
|
|
51877
|
+
):
|
|
51878
|
+
| {
|
|
51879
|
+
amd: boolean;
|
|
51880
|
+
|
|
51881
|
+
async: boolean;
|
|
51882
|
+
|
|
51883
|
+
noConflict: boolean;
|
|
51884
|
+
}
|
|
51885
|
+
| undefined;
|
|
51886
|
+
}
|
|
51635
51887
|
/**
|
|
51636
51888
|
* The SAPUI5 Data Binding API.
|
|
51637
51889
|
*
|
|
@@ -59324,7 +59576,7 @@ declare namespace sap {
|
|
|
59324
59576
|
): sap.ui.model.odata.v2.Context[];
|
|
59325
59577
|
/**
|
|
59326
59578
|
* Returns the count of active entries in the list if the list length is final, otherwise `undefined`. Contrary
|
|
59327
|
-
* to {#getLength}, this method does not consider inactive entries which are created via {#create}.
|
|
59579
|
+
* to {@link #getLength}, this method does not consider inactive entries which are created via {@link #create}.
|
|
59328
59580
|
* See:
|
|
59329
59581
|
* #create
|
|
59330
59582
|
* #getLength
|
|
@@ -60159,6 +60411,8 @@ declare namespace sap {
|
|
|
60159
60411
|
* with hierarchy annotations including the `hierarchy-node-descendant-count-for` annotation, do **not**
|
|
60160
60412
|
* support the operation modes `Client` and `Auto`. **Note:** {@link sap.ui.model.odata.OperationMode.Auto }
|
|
60161
60413
|
* is deprecated since 1.102.0.
|
|
60414
|
+
*
|
|
60415
|
+
* **Note:** OData tree bindings do neither support {@link sap.ui.model.Binding#suspend suspend} nor {@link sap.ui.model.Binding#resume resume}.
|
|
60162
60416
|
* See:
|
|
60163
60417
|
* {@link http://www.sap.com/protocols/SAPData "SAP Annotations for OData Version 2.0" Specification}
|
|
60164
60418
|
*
|
|
@@ -61807,6 +62061,31 @@ declare namespace sap {
|
|
|
61807
62061
|
*/
|
|
61808
62062
|
bRefreshAfterChange: boolean
|
|
61809
62063
|
): void;
|
|
62064
|
+
/**
|
|
62065
|
+
* Sets a "Retry-After" handler, which is called when an OData request fails with HTTP status 503 (Service
|
|
62066
|
+
* Unavailable) and the response has a "Retry-After" header.
|
|
62067
|
+
*
|
|
62068
|
+
* The handler is called with an `Error` having a property `retryAfter` of type `Date`, which is the earliest
|
|
62069
|
+
* point in time when the request should be repeated. The handler has to return a promise. With this promise,
|
|
62070
|
+
* you can control the repetition of all pending requests including the failed HTTP request. If the promise
|
|
62071
|
+
* is resolved, the requests are repeated; if it is rejected, the requests are not repeated. If it is rejected
|
|
62072
|
+
* with the same `Error` reason as previously passed to the handler, then this reason is reported to the
|
|
62073
|
+
* message model.
|
|
62074
|
+
*
|
|
62075
|
+
* **Note:** For APIs, like e.g. {@link #submitChanges}, which return an object having an `abort` function
|
|
62076
|
+
* to abort the request triggered by the API, this abort function must not be called as long as the above
|
|
62077
|
+
* promise is pending. Otherwise an error will be thrown.
|
|
62078
|
+
*
|
|
62079
|
+
* @since 1.134.0
|
|
62080
|
+
*/
|
|
62081
|
+
setRetryAfterHandler(
|
|
62082
|
+
/**
|
|
62083
|
+
* A "Retry-After" handler
|
|
62084
|
+
*/
|
|
62085
|
+
fnRetryAfter: (
|
|
62086
|
+
p1: import("sap/ui/model/odata/v2/ODataModel").RetryAfterError
|
|
62087
|
+
) => Promise<undefined>
|
|
62088
|
+
): void;
|
|
61810
62089
|
/**
|
|
61811
62090
|
* Enable/Disable security token handling.
|
|
61812
62091
|
*/
|
|
@@ -63375,7 +63654,7 @@ declare namespace sap {
|
|
|
63375
63654
|
*
|
|
63376
63655
|
* @returns A promise which is resolved without a defined result when the entity represented by this context
|
|
63377
63656
|
* has been created in the back end. It is rejected with an `Error` instance where `oError.canceled ===
|
|
63378
|
-
* true` if the transient entity is deleted before it is created in the back end, for example via {@link
|
|
63657
|
+
* true` if the transient entity is deleted before it is created in the back end, for example via {@link #delete},
|
|
63379
63658
|
* {@link sap.ui.model.odata.v4.ODataListBinding#resetChanges} or {@link sap.ui.model.odata.v4.ODataModel#resetChanges},
|
|
63380
63659
|
* and for all nested contexts within a deep create. It is rejected with an `Error` instance without `oError.canceled`
|
|
63381
63660
|
* if loading of $metadata fails. Returns `undefined` if the context has not been created using {@link sap.ui.model.odata.v4.ODataListBinding#create}.
|
|
@@ -63819,7 +64098,7 @@ declare namespace sap {
|
|
|
63819
64098
|
/**
|
|
63820
64099
|
* Returns a promise on the value for the given path relative to this context. The function allows access
|
|
63821
64100
|
* to the complete data the context points to (if `sPath` is "") or any part thereof. The data is a JSON
|
|
63822
|
-
* structure as described in "OData JSON Format Version 4.0". Note that the function clones the result. Modify values via {@link
|
|
64101
|
+
* structure as described in "OData JSON Format Version 4.0". Note that the function clones the result. Modify values via {@link #setProperty}.
|
|
63823
64102
|
*
|
|
63824
64103
|
* The header context of a list binding only delivers `$count` and `@$ui5.context.isSelected` (wrapped in
|
|
63825
64104
|
* an object if `sPath` is "").
|
|
@@ -63984,8 +64263,8 @@ declare namespace sap {
|
|
|
63984
64263
|
): Promise<void>;
|
|
63985
64264
|
/**
|
|
63986
64265
|
* Resets all property changes, created entities, and entity deletions of this context. Resets also invalid
|
|
63987
|
-
* user input and inactive contexts which had their activation prevented (see {@link
|
|
63988
|
-
*
|
|
64266
|
+
* user input and inactive contexts which had their activation prevented (see {@link #isInactive}). This
|
|
64267
|
+
* function does not reset the invocation of OData operations (see {@link sap.ui.model.odata.v4.ODataContextBinding#invoke}).
|
|
63989
64268
|
* For a context which is currently {@link #delete deleted} on the client, but not yet on the server, this
|
|
63990
64269
|
* method cancels the deletion and restores the context.
|
|
63991
64270
|
* See:
|
|
@@ -64499,11 +64778,10 @@ declare namespace sap {
|
|
|
64499
64778
|
invoke(
|
|
64500
64779
|
/**
|
|
64501
64780
|
* The group ID to be used for the request; if not specified, the group ID for this binding is used, see
|
|
64502
|
-
* {@link
|
|
64503
|
-
*
|
|
64504
|
-
*
|
|
64505
|
-
*
|
|
64506
|
-
* '$auto' (since 1.121.0).
|
|
64781
|
+
* {@link #constructor} and {@link #getGroupId}. To use the update group ID, see {@link #getUpdateGroupId},
|
|
64782
|
+
* it needs to be specified explicitly. Valid values are `undefined`, '$auto', '$auto.*', '$direct', '$single',
|
|
64783
|
+
* or application group IDs as specified in {@link sap.ui.model.odata.v4.ODataModel}. If '$single' is used,
|
|
64784
|
+
* the request will be sent as fast as '$direct', but wrapped in a batch request like '$auto' (since 1.121.0).
|
|
64507
64785
|
*/
|
|
64508
64786
|
sGroupId?: string,
|
|
64509
64787
|
/**
|
|
@@ -64965,9 +65243,8 @@ declare namespace sap {
|
|
|
64965
65243
|
* Create an inactive context. Such a context will only be sent to the server after the first property update.
|
|
64966
65244
|
* From then on it behaves like any other created context. Supported since 1.97.0
|
|
64967
65245
|
* Since 1.98.0, when the first property updates happens, the context is no longer {@link sap.ui.model.odata.v4.Context#isInactive inactive }
|
|
64968
|
-
* and the {@link
|
|
64969
|
-
*
|
|
64970
|
-
* contribute to the {@link #getCount count}.
|
|
65246
|
+
* and the {@link #event:createActivate 'createActivate'} event is fired. While inactive, it does not count
|
|
65247
|
+
* as a {@link #hasPendingChanges pending change} and does not contribute to the {@link #getCount count}.
|
|
64971
65248
|
*/
|
|
64972
65249
|
bInactive?: boolean
|
|
64973
65250
|
): sap.ui.model.odata.v4.Context;
|
|
@@ -65320,9 +65597,9 @@ declare namespace sap {
|
|
|
65320
65597
|
* @since 1.66.0
|
|
65321
65598
|
*
|
|
65322
65599
|
* @returns mQueryOptions The object with the query options. Query options can be provided with {@link sap.ui.model.odata.v4.ODataModel#bindList},
|
|
65323
|
-
* {@link sap.ui.model.odata.v4.ODataModel#bindContext}, {@link sap.ui.model.odata.v4.
|
|
65324
|
-
*
|
|
65325
|
-
*
|
|
65600
|
+
* {@link sap.ui.model.odata.v4.ODataModel#bindContext}, {@link #changeParameters}, and {@link sap.ui.model.odata.v4.ODataContextBinding#changeParameters}.
|
|
65601
|
+
* System query options can also be calculated, e.g. `$filter` can be calculated based on provided filter
|
|
65602
|
+
* objects.
|
|
65326
65603
|
*/
|
|
65327
65604
|
getQueryOptions(
|
|
65328
65605
|
/**
|
|
@@ -66830,7 +67107,7 @@ declare namespace sap {
|
|
|
66830
67107
|
$expand?: string | object;
|
|
66831
67108
|
/**
|
|
66832
67109
|
* A comma separated list or an array of items which determine the value for the "5.1.3 System Query Option
|
|
66833
|
-
* $select". Since 1.75.0, when using the "autoExpandSelect" model parameter (see {@link
|
|
67110
|
+
* $select". Since 1.75.0, when using the "autoExpandSelect" model parameter (see {@link #constructor}),
|
|
66834
67111
|
* paths with navigation properties can be included and will contribute to the "5.1.2 System Query Option
|
|
66835
67112
|
* $expand".
|
|
66836
67113
|
*/
|
|
@@ -66842,7 +67119,7 @@ declare namespace sap {
|
|
|
66842
67119
|
$$canonicalPath?: boolean;
|
|
66843
67120
|
/**
|
|
66844
67121
|
* The group ID to be used for **read** requests initiated by this binding; if not specified, either the
|
|
66845
|
-
* parent binding's group ID (if the binding is relative) or the model's group ID is used, see {@link
|
|
67122
|
+
* parent binding's group ID (if the binding is relative) or the model's group ID is used, see {@link #constructor}.
|
|
66846
67123
|
* Valid values are `undefined`, '$auto', '$auto.*', '$direct' or application group IDs as specified in
|
|
66847
67124
|
* {@link sap.ui.model.odata.v4.ODataModel}.
|
|
66848
67125
|
*/
|
|
@@ -66867,7 +67144,7 @@ declare namespace sap {
|
|
|
66867
67144
|
/**
|
|
66868
67145
|
* The group ID to be used for **update** requests initiated by this binding; if not specified, either the
|
|
66869
67146
|
* parent binding's update group ID (if the binding is relative) or the model's update group ID is used,
|
|
66870
|
-
* see {@link
|
|
67147
|
+
* see {@link #constructor}. For valid values, see parameter "$$groupId".
|
|
66871
67148
|
*/
|
|
66872
67149
|
$$updateGroupId?: string;
|
|
66873
67150
|
}
|
|
@@ -66947,7 +67224,7 @@ declare namespace sap {
|
|
|
66947
67224
|
$search?: string;
|
|
66948
67225
|
/**
|
|
66949
67226
|
* A comma separated list or an array of items which determine the value for the "5.1.3 System Query Option
|
|
66950
|
-
* $select". Since 1.75.0, when using the "autoExpandSelect" model parameter (see {@link
|
|
67227
|
+
* $select". Since 1.75.0, when using the "autoExpandSelect" model parameter (see {@link #constructor}),
|
|
66951
67228
|
* paths with navigation properties can be included and will contribute to the "5.1.2 System Query Option
|
|
66952
67229
|
* $expand".
|
|
66953
67230
|
*/
|
|
@@ -66976,7 +67253,7 @@ declare namespace sap {
|
|
|
66976
67253
|
$$getKeepAliveContext?: boolean;
|
|
66977
67254
|
/**
|
|
66978
67255
|
* The group ID to be used for **read** requests initiated by this binding; if not specified, either the
|
|
66979
|
-
* parent binding's group ID (if the binding is relative) or the model's group ID is used, see {@link
|
|
67256
|
+
* parent binding's group ID (if the binding is relative) or the model's group ID is used, see {@link #constructor}.
|
|
66980
67257
|
* Valid values are `undefined`, '$auto', '$auto.*', '$direct' or application group IDs as specified in
|
|
66981
67258
|
* {@link sap.ui.model.odata.v4.ODataModel}.
|
|
66982
67259
|
*/
|
|
@@ -67003,13 +67280,13 @@ declare namespace sap {
|
|
|
67003
67280
|
* request instead (@experimental as of version 1.129.0). This results in the main list becoming available
|
|
67004
67281
|
* faster, while the separate properties are merged as soon as the data is received. Note that the separate
|
|
67005
67282
|
* properties must be single valued and part of the '$expand' system query option, either automatically
|
|
67006
|
-
* via the "autoExpandSelect" model parameter (see {@link
|
|
67007
|
-
*
|
|
67283
|
+
* via the "autoExpandSelect" model parameter (see {@link #constructor}) or manually. The `$$separate` parameter
|
|
67284
|
+
* must not be combined with `$$aggregation`.
|
|
67008
67285
|
*/
|
|
67009
67286
|
$$separate?: string[];
|
|
67010
67287
|
/**
|
|
67011
67288
|
* Whether multiple bindings for the same resource path share the data, so that it is requested only once.
|
|
67012
|
-
* This parameter can be inherited from the model's parameter "sharedRequests", see {@link
|
|
67289
|
+
* This parameter can be inherited from the model's parameter "sharedRequests", see {@link #constructor}.
|
|
67013
67290
|
* Supported since 1.80.0 **Note:** These bindings are read-only, so they may be especially useful for value
|
|
67014
67291
|
* lists; state messages (since 1.108.0) and the following APIs are **not** allowed
|
|
67015
67292
|
* for the list binding itself:
|
|
@@ -67030,7 +67307,7 @@ declare namespace sap {
|
|
|
67030
67307
|
/**
|
|
67031
67308
|
* The group ID to be used for **update** requests initiated by this binding; if not specified, either the
|
|
67032
67309
|
* parent binding's update group ID (if the binding is relative) or the model's update group ID is used,
|
|
67033
|
-
* see {@link
|
|
67310
|
+
* see {@link #constructor}. For valid values, see parameter "$$groupId".
|
|
67034
67311
|
*/
|
|
67035
67312
|
$$updateGroupId?: string;
|
|
67036
67313
|
}
|
|
@@ -67095,7 +67372,7 @@ declare namespace sap {
|
|
|
67095
67372
|
$search?: string;
|
|
67096
67373
|
/**
|
|
67097
67374
|
* The group ID to be used for **read** requests initiated by this binding; if not specified, either the
|
|
67098
|
-
* parent binding's group ID (if the binding is relative) or the model's group ID is used, see {@link
|
|
67375
|
+
* parent binding's group ID (if the binding is relative) or the model's group ID is used, see {@link #constructor}.
|
|
67099
67376
|
* Valid values are `undefined`, '$auto', '$auto.*', '$direct' or application group IDs as specified in
|
|
67100
67377
|
* {@link sap.ui.model.odata.v4.ODataModel}.
|
|
67101
67378
|
*/
|
|
@@ -67321,7 +67598,7 @@ declare namespace sap {
|
|
|
67321
67598
|
/**
|
|
67322
67599
|
* Returns the model's group ID.
|
|
67323
67600
|
* See:
|
|
67324
|
-
*
|
|
67601
|
+
* #constructor
|
|
67325
67602
|
*
|
|
67326
67603
|
* @since 1.41.0
|
|
67327
67604
|
*
|
|
@@ -67335,7 +67612,7 @@ declare namespace sap {
|
|
|
67335
67612
|
* See:
|
|
67336
67613
|
* #changeHttpHeaders
|
|
67337
67614
|
*
|
|
67338
|
-
* @since 1.71
|
|
67615
|
+
* @since 1.71.0
|
|
67339
67616
|
*
|
|
67340
67617
|
* @returns The map of HTTP headers
|
|
67341
67618
|
*/
|
|
@@ -67472,7 +67749,7 @@ declare namespace sap {
|
|
|
67472
67749
|
getProperty(): void;
|
|
67473
67750
|
/**
|
|
67474
67751
|
* Returns this model's root URL of the service to request data from (as defined by the "serviceUrl" model
|
|
67475
|
-
* parameter, see {@link
|
|
67752
|
+
* parameter, see {@link #constructor}), without query options.
|
|
67476
67753
|
*
|
|
67477
67754
|
* @since 1.107.0
|
|
67478
67755
|
*
|
|
@@ -67482,7 +67759,7 @@ declare namespace sap {
|
|
|
67482
67759
|
/**
|
|
67483
67760
|
* Returns the model's update group ID.
|
|
67484
67761
|
* See:
|
|
67485
|
-
*
|
|
67762
|
+
* #constructor
|
|
67486
67763
|
*
|
|
67487
67764
|
* @since 1.41.0
|
|
67488
67765
|
*
|
|
@@ -67581,7 +67858,7 @@ declare namespace sap {
|
|
|
67581
67858
|
* the same group ID and (since 1.111.0) inactive contexts which had their activation prevented (see {@link sap.ui.model.odata.v4.Context#isInactive}).
|
|
67582
67859
|
* This function does not reset the invocation of OData operations (see {@link sap.ui.model.odata.v4.ODataContextBinding#invoke}).
|
|
67583
67860
|
* See:
|
|
67584
|
-
*
|
|
67861
|
+
* #constructor
|
|
67585
67862
|
* #hasPendingChanges
|
|
67586
67863
|
*
|
|
67587
67864
|
* @since 1.39.0
|
|
@@ -67600,6 +67877,25 @@ declare namespace sap {
|
|
|
67600
67877
|
* @since 1.37.0
|
|
67601
67878
|
*/
|
|
67602
67879
|
setLegacySyntax(): void;
|
|
67880
|
+
/**
|
|
67881
|
+
* Sets a "Retry-After" handler, which is called when an OData request fails with HTTP status 503 (Service
|
|
67882
|
+
* Unavailable) and the response has a "Retry-After" header.
|
|
67883
|
+
*
|
|
67884
|
+
* The handler is called with an `Error` having a property `retryAfter` of type `Date`, which is the earliest
|
|
67885
|
+
* point in time when the request should be repeated. The handler has to return a promise. With this promise,
|
|
67886
|
+
* you can control the repetition of all pending requests including the failed HTTP request. If the promise
|
|
67887
|
+
* is resolved, the requests are repeated; if it is rejected, the requests are not repeated. If it is rejected
|
|
67888
|
+
* with the same `Error` reason as previously passed to the handler, then this reason is reported to the
|
|
67889
|
+
* message model.
|
|
67890
|
+
*
|
|
67891
|
+
* @since 1.134.0
|
|
67892
|
+
*/
|
|
67893
|
+
setRetryAfterHandler(
|
|
67894
|
+
/**
|
|
67895
|
+
* A "Retry-After" handler
|
|
67896
|
+
*/
|
|
67897
|
+
fnRetryAfter: (p1: Error) => Promise<undefined>
|
|
67898
|
+
): void;
|
|
67603
67899
|
/**
|
|
67604
67900
|
* Submits the requests associated with the given group ID in one batch request. Requests from subsequent
|
|
67605
67901
|
* calls to this method for the same group ID may be combined in one batch request using separate change
|
|
@@ -67850,7 +68146,7 @@ declare namespace sap {
|
|
|
67850
68146
|
/**
|
|
67851
68147
|
* Requests the value of the property binding.
|
|
67852
68148
|
*
|
|
67853
|
-
* @since 1.69
|
|
68149
|
+
* @since 1.69.0
|
|
67854
68150
|
*
|
|
67855
68151
|
* @returns A promise resolved with the resulting value or `undefined` if it could not be determined, or
|
|
67856
68152
|
* rejected in case of an error
|
|
@@ -75437,12 +75733,12 @@ declare namespace sap {
|
|
|
75437
75733
|
/**
|
|
75438
75734
|
* Tree binding implementation for client models.
|
|
75439
75735
|
*
|
|
75440
|
-
*
|
|
75441
|
-
*
|
|
75442
|
-
*
|
|
75443
|
-
*
|
|
75444
|
-
*
|
|
75445
|
-
*
|
|
75736
|
+
* Note that a hierarchy's "state" (i.e. the information about expanded, collapsed, selected, and deselected
|
|
75737
|
+
* nodes) may become inconsistent when the structure of the model data is changed at runtime. This is because
|
|
75738
|
+
* each node is identified internally by its index position relative to its parent, plus its parent's ID.
|
|
75739
|
+
* Therefore, inserting or removing a node in the model data will likely lead to a shift in the index positions
|
|
75740
|
+
* of other nodes, causing them to lose their state and/or to gain the state of another node. **Note:**
|
|
75741
|
+
* Tree bindings of client models do neither support {@link sap.ui.model.Binding#suspend suspend} nor {@link sap.ui.model.Binding#resume resume}.
|
|
75446
75742
|
*
|
|
75447
75743
|
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
75448
75744
|
*/
|
package/types/sap.ui.dt.d.ts
CHANGED
package/types/sap.ui.fl.d.ts
CHANGED