@sapui5/ts-types-esm 1.140.0 → 1.141.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.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.esh.search.ui.d.ts +2680 -1
- package/types/sap.f.d.ts +44 -3
- 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 +84 -1
- package/types/sap.fe.ina.d.ts +1 -1
- package/types/sap.fe.macros.d.ts +367 -42
- package/types/sap.fe.navigation.d.ts +13 -15
- 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 +1 -1
- package/types/sap.fe.test.d.ts +1 -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 +7 -1
- package/types/sap.insights.d.ts +1 -1
- package/types/sap.m.d.ts +78 -9
- package/types/sap.makit.d.ts +1 -1
- package/types/sap.me.d.ts +1 -1
- package/types/sap.ndc.d.ts +1 -1
- package/types/sap.ovp.d.ts +1 -1
- package/types/sap.rules.ui.d.ts +1 -1
- package/types/sap.sac.df.d.ts +20 -5
- package/types/sap.suite.ui.commons.d.ts +1 -1
- package/types/sap.suite.ui.generic.template.d.ts +41 -5
- 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 +1 -1
- package/types/sap.ui.core.d.ts +130 -67
- package/types/sap.ui.dt.d.ts +202 -1
- package/types/sap.ui.export.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +8 -7
- 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 +63 -47
- package/types/sap.ui.mdc.d.ts +4 -4
- package/types/sap.ui.richtexteditor.d.ts +309 -9
- 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 +18 -4
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +55 -3
- 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 +132 -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 +32 -3
- package/types/sap.ushell_abap.d.ts +5 -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 +1 -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.141.0
|
|
283
283
|
|
|
284
284
|
declare module "sap/base/assert" {
|
|
285
285
|
/**
|
|
@@ -787,7 +787,7 @@ declare module "sap/base/i18n/Formatting" {
|
|
|
787
787
|
*/
|
|
788
788
|
setLanguageTag(
|
|
789
789
|
/**
|
|
790
|
-
* the new BCP47 compliant language tag; case doesn't matter and underscores can be used instead of
|
|
790
|
+
* the new BCP47 compliant language tag; case doesn't matter and underscores can be used instead of hyphens
|
|
791
791
|
* to separate components (compatibility with Java Locale IDs)
|
|
792
792
|
*/
|
|
793
793
|
vLanguageTag: string | LanguageTag | null
|
|
@@ -1090,15 +1090,15 @@ declare module "sap/base/i18n/LanguageTag" {
|
|
|
1090
1090
|
/**
|
|
1091
1091
|
* Get the extension as a single string or `null`.
|
|
1092
1092
|
*
|
|
1093
|
-
* The extension always consists of a singleton character (not 'x'), a
|
|
1094
|
-
* token, each separated again with a
|
|
1093
|
+
* The extension always consists of a singleton character (not 'x'), a hyphen '-' and one or more extension
|
|
1094
|
+
* token, each separated again with a hyphen.
|
|
1095
1095
|
*/
|
|
1096
1096
|
extension: string | null;
|
|
1097
1097
|
|
|
1098
1098
|
/**
|
|
1099
1099
|
* Get the extensions as an array of tokens.
|
|
1100
1100
|
*
|
|
1101
|
-
* The leading singleton and the separating
|
|
1101
|
+
* The leading singleton and the separating hyphens are not part of the result. If there is no extensions
|
|
1102
1102
|
* section in the language tag, an empty array is returned.
|
|
1103
1103
|
*/
|
|
1104
1104
|
extensionSubtags: string[];
|
|
@@ -1130,14 +1130,14 @@ declare module "sap/base/i18n/LanguageTag" {
|
|
|
1130
1130
|
/**
|
|
1131
1131
|
* Get the variants as a single string or `null`.
|
|
1132
1132
|
*
|
|
1133
|
-
* Multiple variants are separated by a
|
|
1133
|
+
* Multiple variants are separated by a hyphen '-'.
|
|
1134
1134
|
*/
|
|
1135
1135
|
variant: string | null;
|
|
1136
1136
|
|
|
1137
1137
|
/**
|
|
1138
1138
|
* Get the variants as an array of individual variants.
|
|
1139
1139
|
*
|
|
1140
|
-
* The separating
|
|
1140
|
+
* The separating hyphens are not part of the result. If there is no variant section in the language tag,
|
|
1141
1141
|
* an empty array is returned.
|
|
1142
1142
|
*/
|
|
1143
1143
|
variantSubtags: string[];
|
|
@@ -1189,8 +1189,8 @@ declare module "sap/base/i18n/Localization" {
|
|
|
1189
1189
|
* The value returned by config method in most cases corresponds to the exact value that has been configured
|
|
1190
1190
|
* by the user or application or that has been determined from the user agent settings. It has not been
|
|
1191
1191
|
* normalized, but has been validated against a relaxed version of {@link http://www.ietf.org/rfc/bcp/bcp47.txt BCP47},
|
|
1192
|
-
* allowing underscores ('_') instead of the suggested
|
|
1193
|
-
* account.
|
|
1192
|
+
* allowing underscores ('_') instead of the suggested hyphens ('-') and not taking the case of letters
|
|
1193
|
+
* into account.
|
|
1194
1194
|
*
|
|
1195
1195
|
* The exceptions mentioned above affect languages that have been specified via the URL parameter `sap-language`.
|
|
1196
1196
|
* That parameter by definition represents an SAP logon language code ('ABAP language'). Most but not all
|
|
@@ -1308,7 +1308,7 @@ declare module "sap/base/i18n/Localization" {
|
|
|
1308
1308
|
setLanguage(
|
|
1309
1309
|
/**
|
|
1310
1310
|
* the new language as a BCP47 compliant language tag; case doesn't matter and underscores can be used instead
|
|
1311
|
-
* of
|
|
1311
|
+
* of hyphens to separate components (compatibility with Java Locale IDs)
|
|
1312
1312
|
*/
|
|
1313
1313
|
sLanguage: string,
|
|
1314
1314
|
/**
|
|
@@ -2355,7 +2355,7 @@ declare module "sap/base/security/encodeURL" {
|
|
|
2355
2355
|
/**
|
|
2356
2356
|
* Encode the string for inclusion into a URL parameter.
|
|
2357
2357
|
*
|
|
2358
|
-
* Unescaped characters: alphabetic, decimal digits, -_. (
|
|
2358
|
+
* Unescaped characters: alphabetic, decimal digits, -_. (hyphen, underscore, dot)
|
|
2359
2359
|
*
|
|
2360
2360
|
* @since 1.58
|
|
2361
2361
|
*
|
|
@@ -3918,7 +3918,7 @@ declare module "sap/ui/core/ComponentSupport" {
|
|
|
3918
3918
|
* instance of the {@link sap.ui.core.ComponentContainer ComponentContainer} in the JavaScript code.
|
|
3919
3919
|
*
|
|
3920
3920
|
* As HTML is case-insensitive, in order to define a property with upper-case characters, you have to "escape"
|
|
3921
|
-
* them with a
|
|
3921
|
+
* them with a hyphen character, similar to CSS attributes. The following code gives an example:
|
|
3922
3922
|
*
|
|
3923
3923
|
*
|
|
3924
3924
|
* ```javascript
|
|
@@ -6643,6 +6643,11 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
|
|
|
6643
6643
|
* property has to be an integer type
|
|
6644
6644
|
*/
|
|
6645
6645
|
hierarchyNodeDescendantCountFor?: string;
|
|
6646
|
+
/**
|
|
6647
|
+
* The property name in the same type holding the preorder rank for the node; the type of the referenced
|
|
6648
|
+
* property has to be an integer type
|
|
6649
|
+
*/
|
|
6650
|
+
hierarchyPreorderRankFor?: string;
|
|
6646
6651
|
};
|
|
6647
6652
|
/**
|
|
6648
6653
|
* The number of levels that are auto-expanded initially. Setting this property might lead to multiple back-end
|
|
@@ -6687,6 +6692,18 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
|
|
|
6687
6692
|
* or {@link sap.ui.model.odata.OperationMode.Auto OperationMode.Auto} is used.
|
|
6688
6693
|
*/
|
|
6689
6694
|
treeState?: any;
|
|
6695
|
+
/**
|
|
6696
|
+
* This parameter is experimental as of version 1.141.0.
|
|
6697
|
+
*
|
|
6698
|
+
* Whether the tree state is restored on hierarchy maintenance, such as adding, removing, or deleting a
|
|
6699
|
+
* node. This is only supported if the following conditions are met:
|
|
6700
|
+
* - The binding has to use {@link sap.ui.model.odata.OperationMode.Server OperationMode.Server}
|
|
6701
|
+
* - The `"hierarchy-node-descendant-count-for"` annotation must be present in the service metadata or
|
|
6702
|
+
* provided via `treeAnnotationProperties.hierarchyNodeDescendantCountFor`
|
|
6703
|
+
* - The `"hierarchy-preorder-rank-for"` annotation must be present in the service metadata or provided
|
|
6704
|
+
* via `treeAnnotationProperties.hierarchyPreorderRankFor`
|
|
6705
|
+
*/
|
|
6706
|
+
restoreTreeStateAfterChange?: boolean;
|
|
6690
6707
|
/**
|
|
6691
6708
|
* Defines the count mode of this binding; if not specified, the default count mode of the binding's model
|
|
6692
6709
|
* is applied. The resulting count mode must not be {@link sap.ui.model.odata.CountMode.None}.
|
|
@@ -16817,7 +16834,7 @@ declare module "sap/ui/core/library" {
|
|
|
16817
16834
|
/**
|
|
16818
16835
|
* A string type representing an ID or a name.
|
|
16819
16836
|
*
|
|
16820
|
-
* Allowed is a sequence of characters (capital/lowercase), digits, underscores,
|
|
16837
|
+
* Allowed is a sequence of characters (capital/lowercase), digits, underscores, hyphens, dots and/or colons.
|
|
16821
16838
|
* It may start with a character or underscore only.
|
|
16822
16839
|
*/
|
|
16823
16840
|
export type ID = string;
|
|
@@ -19449,7 +19466,7 @@ declare module "sap/ui/core/ComponentContainer" {
|
|
|
19449
19466
|
* Gets current value of property {@link #getAutoPrefixId autoPrefixId}.
|
|
19450
19467
|
*
|
|
19451
19468
|
* Flag, whether to auto-prefix the ID of the nested Component or not. If this property is set to true the
|
|
19452
|
-
* ID of the Component will be prefixed with the ID of the ComponentContainer followed by a single
|
|
19469
|
+
* ID of the Component will be prefixed with the ID of the ComponentContainer followed by a single hyphen.
|
|
19453
19470
|
* This property can only be applied initially.
|
|
19454
19471
|
*
|
|
19455
19472
|
* Default value is `false`.
|
|
@@ -19602,7 +19619,7 @@ declare module "sap/ui/core/ComponentContainer" {
|
|
|
19602
19619
|
* Sets a new value for property {@link #getAutoPrefixId autoPrefixId}.
|
|
19603
19620
|
*
|
|
19604
19621
|
* Flag, whether to auto-prefix the ID of the nested Component or not. If this property is set to true the
|
|
19605
|
-
* ID of the Component will be prefixed with the ID of the ComponentContainer followed by a single
|
|
19622
|
+
* ID of the Component will be prefixed with the ID of the ComponentContainer followed by a single hyphen.
|
|
19606
19623
|
* This property can only be applied initially.
|
|
19607
19624
|
*
|
|
19608
19625
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
@@ -19884,7 +19901,7 @@ declare module "sap/ui/core/ComponentContainer" {
|
|
|
19884
19901
|
|
|
19885
19902
|
/**
|
|
19886
19903
|
* Flag, whether to auto-prefix the ID of the nested Component or not. If this property is set to true the
|
|
19887
|
-
* ID of the Component will be prefixed with the ID of the ComponentContainer followed by a single
|
|
19904
|
+
* ID of the Component will be prefixed with the ID of the ComponentContainer followed by a single hyphen.
|
|
19888
19905
|
* This property can only be applied initially.
|
|
19889
19906
|
*/
|
|
19890
19907
|
autoPrefixId?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
@@ -20543,8 +20560,8 @@ declare module "sap/ui/core/Configuration" {
|
|
|
20543
20560
|
* The value returned by config method in most cases corresponds to the exact value that has been configured
|
|
20544
20561
|
* by the user or application or that has been determined from the user agent settings. It has not been
|
|
20545
20562
|
* normalized, but has been validated against a relaxed version of {@link http://www.ietf.org/rfc/bcp/bcp47.txt BCP47},
|
|
20546
|
-
* allowing underscores ('_') instead of the suggested
|
|
20547
|
-
* account.
|
|
20563
|
+
* allowing underscores ('_') instead of the suggested hyphens ('-') and not taking the case of letters
|
|
20564
|
+
* into account.
|
|
20548
20565
|
*
|
|
20549
20566
|
* The exceptions mentioned above affect languages that have been specified via the URL parameter `sap-language`.
|
|
20550
20567
|
* That parameter by definition represents an SAP logon language code ('ABAP language'). Most but not all
|
|
@@ -20813,7 +20830,7 @@ declare module "sap/ui/core/Configuration" {
|
|
|
20813
20830
|
setFormatLocale(
|
|
20814
20831
|
/**
|
|
20815
20832
|
* the new format locale as a BCP47 compliant language tag; case doesn't matter and underscores can be used
|
|
20816
|
-
* instead of
|
|
20833
|
+
* instead of hyphens to separate components (compatibility with Java Locale IDs)
|
|
20817
20834
|
*/
|
|
20818
20835
|
sFormatLocale: string | null
|
|
20819
20836
|
): this;
|
|
@@ -20870,7 +20887,7 @@ declare module "sap/ui/core/Configuration" {
|
|
|
20870
20887
|
setLanguage(
|
|
20871
20888
|
/**
|
|
20872
20889
|
* the new language as a BCP47 compliant language tag; case doesn't matter and underscores can be used instead
|
|
20873
|
-
* of
|
|
20890
|
+
* of hyphens to separate components (compatibility with Java Locale IDs)
|
|
20874
20891
|
*/
|
|
20875
20892
|
sLanguage: string,
|
|
20876
20893
|
/**
|
|
@@ -27171,8 +27188,8 @@ declare module "sap/ui/core/Element" {
|
|
|
27171
27188
|
* returned by {@link sap.ui.core.Element#getDomRef} is wrapped and returned.
|
|
27172
27189
|
*
|
|
27173
27190
|
* If an ID suffix is given, the ID of this Element is concatenated with the suffix (separated by a single
|
|
27174
|
-
*
|
|
27175
|
-
* for named inner DOM nodes of a control.
|
|
27191
|
+
* hyphen) and the DOM node with that compound ID will be wrapped by jQuery. This matches the UI5 naming
|
|
27192
|
+
* convention for named inner DOM nodes of a control.
|
|
27176
27193
|
*
|
|
27177
27194
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
27178
27195
|
*
|
|
@@ -27606,7 +27623,7 @@ declare module "sap/ui/core/Element" {
|
|
|
27606
27623
|
* their current state (e.g. an initial, not yet rendered control).
|
|
27607
27624
|
*
|
|
27608
27625
|
* If an ID suffix is given, the ID of this Element is concatenated with the suffix (separated by a single
|
|
27609
|
-
*
|
|
27626
|
+
* hyphen) and the DOM node with that compound ID will be returned. This matches the UI5 naming convention
|
|
27610
27627
|
* for named inner DOM nodes of a control.
|
|
27611
27628
|
*
|
|
27612
27629
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
@@ -34212,8 +34229,8 @@ declare module "sap/ui/core/Locale" {
|
|
|
34212
34229
|
/**
|
|
34213
34230
|
* Get the locale extension as a single string or `null`.
|
|
34214
34231
|
*
|
|
34215
|
-
* The extension always consists of a singleton character (not 'x'), a
|
|
34216
|
-
* token, each separated again with a
|
|
34232
|
+
* The extension always consists of a singleton character (not 'x'), a hyphen '-' and one or more extension
|
|
34233
|
+
* token, each separated again with a hyphen.
|
|
34217
34234
|
*
|
|
34218
34235
|
* Use {@link #getExtensions} to get the individual extension tokens as an array.
|
|
34219
34236
|
*
|
|
@@ -34224,7 +34241,7 @@ declare module "sap/ui/core/Locale" {
|
|
|
34224
34241
|
/**
|
|
34225
34242
|
* Get the locale extensions as an array of tokens.
|
|
34226
34243
|
*
|
|
34227
|
-
* The leading singleton and the separating
|
|
34244
|
+
* The leading singleton and the separating hyphens are not part of the result. If there is no extensions
|
|
34228
34245
|
* section in the locale tag, an empty array is returned.
|
|
34229
34246
|
*
|
|
34230
34247
|
*
|
|
@@ -34251,7 +34268,7 @@ declare module "sap/ui/core/Locale" {
|
|
|
34251
34268
|
/**
|
|
34252
34269
|
* Get the locale private use section as an array of tokens.
|
|
34253
34270
|
*
|
|
34254
|
-
* The leading singleton and the separating
|
|
34271
|
+
* The leading singleton and the separating hyphens are not part of the result. If there is no private use
|
|
34255
34272
|
* section in the locale tag, an empty array is returned.
|
|
34256
34273
|
*
|
|
34257
34274
|
*
|
|
@@ -34303,7 +34320,7 @@ declare module "sap/ui/core/Locale" {
|
|
|
34303
34320
|
/**
|
|
34304
34321
|
* Get the locale variants as a single string or `null`.
|
|
34305
34322
|
*
|
|
34306
|
-
* Multiple variants are separated by a
|
|
34323
|
+
* Multiple variants are separated by a hyphen '-'.
|
|
34307
34324
|
*
|
|
34308
34325
|
*
|
|
34309
34326
|
* @returns the variant or `null`
|
|
@@ -34312,8 +34329,8 @@ declare module "sap/ui/core/Locale" {
|
|
|
34312
34329
|
/**
|
|
34313
34330
|
* Get the locale variants as an array of individual variants.
|
|
34314
34331
|
*
|
|
34315
|
-
* The separating
|
|
34316
|
-
* empty array is returned.
|
|
34332
|
+
* The separating hyphens are not part of the result. If there is no variant section in the locale tag,
|
|
34333
|
+
* an empty array is returned.
|
|
34317
34334
|
*
|
|
34318
34335
|
*
|
|
34319
34336
|
* @returns the individual variant sections
|
|
@@ -43159,10 +43176,15 @@ declare module "sap/ui/core/routing/History" {
|
|
|
43159
43176
|
*/
|
|
43160
43177
|
static getInstance(): History;
|
|
43161
43178
|
/**
|
|
43162
|
-
* Determines what the navigation direction for a newly given hash would be
|
|
43163
|
-
*
|
|
43164
|
-
*
|
|
43165
|
-
*
|
|
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.
|
|
43166
43188
|
*
|
|
43167
43189
|
*
|
|
43168
43190
|
* @returns Direction for the given hash or `undefined`, if no navigation has taken place yet.
|
|
@@ -49330,11 +49352,21 @@ declare module "sap/ui/core/UIComponent" {
|
|
|
49330
49352
|
/**
|
|
49331
49353
|
* Initializes the component instance after creation.
|
|
49332
49354
|
*
|
|
49333
|
-
*
|
|
49334
|
-
*
|
|
49355
|
+
* The primary responsibility of this method is to create the root control of the component and manage its
|
|
49356
|
+
* aggregation in the "rootControl" aggregation. This is performed internally by invoking the {@link sap.ui.core.UIComponent#createContent }
|
|
49357
|
+
* method.
|
|
49358
|
+
*
|
|
49359
|
+
* Depending on the class metadata (e.g., if the "sap.ui.core.IAsyncContentCreation" interface is implemented),
|
|
49360
|
+
* the root control may be created synchronously or asynchronously.
|
|
49335
49361
|
*
|
|
49336
|
-
*
|
|
49337
|
-
*
|
|
49362
|
+
* Additionally, this method is responsible for creating the router and targets instances.
|
|
49363
|
+
*
|
|
49364
|
+
* **Note:** Applications must not call this hook method directly; it is invoked by the framework during
|
|
49365
|
+
* the execution of the Component constructor.
|
|
49366
|
+
*
|
|
49367
|
+
* Subclasses of `UIComponent` should override this hook to implement any required initialization logic.
|
|
49368
|
+
* **When overriding this method, ensure that you always invoke the `init` method of the `UIComponent` base
|
|
49369
|
+
* class.**
|
|
49338
49370
|
*
|
|
49339
49371
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
49340
49372
|
*/
|
|
@@ -71294,7 +71326,7 @@ declare module "sap/ui/model/odata/v4/AnnotationHelper" {
|
|
|
71294
71326
|
*
|
|
71295
71327
|
* Annotations on an Operation or a Parameter: Since 1.71.0, for annotations on an operation or a parameter,
|
|
71296
71328
|
* the binding parameter's name is stripped off any dynamic "14.5.12 Expression edm:Path" and "14.5.13 Expression
|
|
71297
|
-
* edm:PropertyPath" where it might be used as a first segment. Since 1.76.0 this does not apply to annotations
|
|
71329
|
+
* edm:PropertyPath" where it might be used as a first segment. Since 1.76.0, this does not apply to annotations
|
|
71298
71330
|
* on a parameter. In the former case, we assume that the resulting data binding is relative to the parent
|
|
71299
71331
|
* context of the operation binding, that is, to the context representing the binding parameter itself.
|
|
71300
71332
|
* In the latter case, we assume that the resulting data binding is relative to the parameter context of
|
|
@@ -71615,7 +71647,7 @@ declare module "sap/ui/model/odata/v4/AnnotationHelper" {
|
|
|
71615
71647
|
*
|
|
71616
71648
|
* Annotations on an Operation or a Parameter: Since 1.71.0, for annotations on an operation or a parameter,
|
|
71617
71649
|
* the binding parameter's name is stripped off any dynamic "14.5.12 Expression edm:Path" and "14.5.13 Expression
|
|
71618
|
-
* edm:PropertyPath" where it might be used as a first segment. Since 1.76.0 this does not apply to annotations
|
|
71650
|
+
* edm:PropertyPath" where it might be used as a first segment. Since 1.76.0, this does not apply to annotations
|
|
71619
71651
|
* on a parameter. In the former case, we assume that the resulting data binding is relative to the parent
|
|
71620
71652
|
* context of the operation binding, that is, to the context representing the binding parameter itself.
|
|
71621
71653
|
* In the latter case, we assume that the resulting data binding is relative to the parameter context of
|
|
@@ -71730,6 +71762,11 @@ declare module "sap/ui/model/odata/v4/AnnotationHelper" {
|
|
|
71730
71762
|
* apply to annotations on a parameter (since 1.76.0).
|
|
71731
71763
|
*/
|
|
71732
71764
|
overload?: object;
|
|
71765
|
+
/**
|
|
71766
|
+
* Optional prefix to be added to each dynamic "14.5.12 Expression edm:Path" and "14.5.13 Expression edm:PropertyPath";
|
|
71767
|
+
* is either an empty string or a path ending with a "/" (since 1.141.0)
|
|
71768
|
+
*/
|
|
71769
|
+
prefix?: string;
|
|
71733
71770
|
}
|
|
71734
71771
|
): string;
|
|
71735
71772
|
}
|
|
@@ -71853,7 +71890,7 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
71853
71890
|
* as a binding context. Exceptions hold for status APIs like {@link #isDeleted}, {@link #isKeepAlive},
|
|
71854
71891
|
* {@link #hasPendingChanges}, {@link #resetChanges}, or {@link #isSelected} (returns `false` since 1.114.0).
|
|
71855
71892
|
*
|
|
71856
|
-
* Since 1.105 such a pending deletion is a pending change. It causes `hasPendingChanges` to return `true`
|
|
71893
|
+
* Since 1.105, such a pending deletion is a pending change. It causes `hasPendingChanges` to return `true`
|
|
71857
71894
|
* for the context, the binding containing it, and the model. The `resetChanges` method called on the context,
|
|
71858
71895
|
* the binding, or the model cancels the deletion and restores the context.
|
|
71859
71896
|
*
|
|
@@ -71897,7 +71934,7 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
71897
71934
|
* binding is used, see {@link #getUpdateGroupId}. Since 1.81, if this context is transient (see {@link #isTransient}),
|
|
71898
71935
|
* no group ID needs to be specified. Since 1.98.0, you can use `null` to prevent the DELETE request in
|
|
71899
71936
|
* case of a kept-alive context that is not in the collection and of which you know that it does not exist
|
|
71900
|
-
* on the server anymore (for example, a draft after activation). Since 1.108.0 the usage of a group ID
|
|
71937
|
+
* on the server anymore (for example, a draft after activation). Since 1.108.0, the usage of a group ID
|
|
71901
71938
|
* with {@link sap.ui.model.odata.v4.SubmitMode.API} is possible. Since 1.121.0, you can use the '$single'
|
|
71902
71939
|
* group ID to send a DELETE request as fast as possible; it will be wrapped in a batch request as for a
|
|
71903
71940
|
* '$auto' group.
|
|
@@ -72217,8 +72254,8 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
72217
72254
|
*/
|
|
72218
72255
|
oParameters: {
|
|
72219
72256
|
/**
|
|
72220
|
-
* Whether the node should be copied instead of moved
|
|
72221
|
-
*
|
|
72257
|
+
* Whether the node should be copied instead of moved. The returned promise resolves with the index for
|
|
72258
|
+
* the copied node. Supported since 1.141.0.
|
|
72222
72259
|
*/
|
|
72223
72260
|
copy?: boolean;
|
|
72224
72261
|
/**
|
|
@@ -72332,7 +72369,7 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
72332
72369
|
requestParent(): Promise<Context | null>;
|
|
72333
72370
|
/**
|
|
72334
72371
|
* Returns a promise on the property value for the given path relative to this context. The path is expected
|
|
72335
|
-
* to point to a structural property with primitive type. Since 1.81.1 it is possible to request more than
|
|
72372
|
+
* to point to a structural property with primitive type. Since 1.81.1, it is possible to request more than
|
|
72336
72373
|
* one property. Property values that are not cached yet are requested from the back end.
|
|
72337
72374
|
* See:
|
|
72338
72375
|
* sap.ui.model.odata.v4.ODataMetaModel#requestUI5Type
|
|
@@ -72431,7 +72468,7 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
72431
72468
|
* (unless listed explicitly), for example `[{$PropertyPath : "*"}, {$NavigationPropertyPath : "EMPLOYEE_2_MANAGER"}]`
|
|
72432
72469
|
* or `[{$PropertyPath : "EMPLOYEE_2_MANAGER/*"}]`.
|
|
72433
72470
|
*
|
|
72434
|
-
* Since 1.82.0 absolute paths are supported. Absolute paths must start with the entity container (example
|
|
72471
|
+
* Since 1.82.0, absolute paths are supported. Absolute paths must start with the entity container (example
|
|
72435
72472
|
* "/com.sap.gateway.default.iwbep.tea_busi.v0001.Container/TEAMS") of the service. All (navigation) properties
|
|
72436
72473
|
* in the complete model matching such an absolute path are updated. Since 1.85.0, "14.4.11 Expression edm:String"
|
|
72437
72474
|
* is accepted as well.
|
|
@@ -72508,7 +72545,7 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
72508
72545
|
/**
|
|
72509
72546
|
* Sets a new value for the property identified by the given path. The path is relative to this context
|
|
72510
72547
|
* and is expected to point to a structural property with primitive type or, since 1.85.0, to an instance
|
|
72511
|
-
* annotation. Since 1.122.0 the client-side annotation "@$ui5.context.isSelected" can be given as a path.
|
|
72548
|
+
* annotation. Since 1.122.0, the client-side annotation "@$ui5.context.isSelected" can be given as a path.
|
|
72512
72549
|
* Note: Writing to a client-side annotation never initiates a PATCH request, even if `sGroupId` is given.
|
|
72513
72550
|
* Thus, reverting the value of this annotation cannot be done via {@link #resetChanges}.
|
|
72514
72551
|
* See:
|
|
@@ -72976,11 +73013,12 @@ declare module "sap/ui/model/odata/v4/ODataContextBinding" {
|
|
|
72976
73013
|
* messages will be related to the return value context only. Such a message can only be connected to a
|
|
72977
73014
|
* corresponding control if the control's property bindings use the return value context as binding context.
|
|
72978
73015
|
*
|
|
72979
|
-
*
|
|
72980
|
-
* property. In addition to the existing preconditions for a return value context, the
|
|
72981
|
-
* a partner attribute for the navigation property and the partner relationship
|
|
72982
|
-
* Also
|
|
72983
|
-
* parent context's path
|
|
73016
|
+
* Since 1.141.0, a return value context may also be provided if the parent context's path contains a maximum
|
|
73017
|
+
* of one navigation property. In addition to the existing preconditions for a return value context, the
|
|
73018
|
+
* metadata has to specify a partner attribute for the navigation property and the partner relationship
|
|
73019
|
+
* has to be bi-directional. Also a navigation property binding has to be available for the entity set of
|
|
73020
|
+
* the first segment in the parent context's path. **Note:** Ensure your service implementation returns
|
|
73021
|
+
* all selected key properties; otherwise, no return value context is provided.
|
|
72984
73022
|
*/
|
|
72985
73023
|
invoke(
|
|
72986
73024
|
/**
|
|
@@ -73142,7 +73180,7 @@ declare module "sap/ui/model/odata/v4/ODataContextBinding" {
|
|
|
73142
73180
|
* requests. Call {@link #resume} to resume the binding. Before 1.53.0, this method was not supported and
|
|
73143
73181
|
* threw an error. Since 1.97.0, pending changes are ignored if they relate to a {@link sap.ui.model.odata.v4.Context#isKeepAlive kept-alive }
|
|
73144
73182
|
* context of this binding. Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isTransient transient} contexts
|
|
73145
|
-
* of a {@link #getRootBinding root binding} do not count as pending changes. Since 1.108.0 {@link sap.ui.model.odata.v4.Context#delete deleted }
|
|
73183
|
+
* of a {@link #getRootBinding root binding} do not count as pending changes. Since 1.108.0, {@link sap.ui.model.odata.v4.Context#delete deleted }
|
|
73146
73184
|
* contexts do not count as pending changes.
|
|
73147
73185
|
* See:
|
|
73148
73186
|
* {@link https://ui5.sap.com/#/topic/b0f5c531e5034a27952cc748954cbe39 Suspend and Resume}
|
|
@@ -73516,12 +73554,15 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
73516
73554
|
* set `bSkipRefresh` to `true`. To avoid errors you must skip this refresh when using {@link sap.ui.model.odata.v4.Context#requestSideEffects }
|
|
73517
73555
|
* in the same $batch to refresh the complete collection containing the newly created entity.
|
|
73518
73556
|
*
|
|
73519
|
-
* Since 1.115.0 it is possible to create nested entities in a collection-valued navigation property together
|
|
73557
|
+
* Since 1.115.0, it is possible to create nested entities in a collection-valued navigation property together
|
|
73520
73558
|
* with the entity (so-called "deep create"), for example a list of items for an order. For this purpose,
|
|
73521
73559
|
* bind the list relative to a transient context. Calling this method then adds a transient entity to the
|
|
73522
73560
|
* parent's navigation property, which is sent with the payload of the parent entity. Such a nested context
|
|
73523
73561
|
* cannot be inactive.
|
|
73524
73562
|
*
|
|
73563
|
+
* **Caution:** Only a single list must be bound to the same collection-valued navigation property relative
|
|
73564
|
+
* to a transient context. Created data cannot be shared between list bindings.
|
|
73565
|
+
*
|
|
73525
73566
|
* **Note:** After a successful creation of the main entity the context returned for a nested entity is
|
|
73526
73567
|
* no longer valid. Do not use the {@link sap.ui.model.odata.v4.Context#created created} promise of such
|
|
73527
73568
|
* a context! New contexts are created for the nested collection because it is not possible to reliably
|
|
@@ -73529,7 +73570,7 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
73529
73570
|
* the `created` promises of all nested contexts are always rejected with an instance of `Error`, even if
|
|
73530
73571
|
* the deep create succeeds. This error always has the property `canceled` with the value `true`.
|
|
73531
73572
|
*
|
|
73532
|
-
* Since 1.118.0 deep create also supports single-valued navigation properties; no API call is required
|
|
73573
|
+
* Since 1.118.0, deep create also supports single-valued navigation properties; no API call is required
|
|
73533
73574
|
* in this case. Simply bind properties of the related entity relative to a transient context. An update
|
|
73534
73575
|
* to the property adds it to the POST request of the parent entity, and by this the create becomes deep.
|
|
73535
73576
|
*
|
|
@@ -73581,7 +73622,7 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
73581
73622
|
*/
|
|
73582
73623
|
bSkipRefresh?: boolean,
|
|
73583
73624
|
/**
|
|
73584
|
-
* Whether the entity is inserted at the end of the list. Supported since 1.66.0. Since 1.99.0 the first
|
|
73625
|
+
* Whether the entity is inserted at the end of the list. Supported since 1.66.0. Since 1.99.0, the first
|
|
73585
73626
|
* insertion determines the overall position of created contexts within the binding's context list. Every
|
|
73586
73627
|
* succeeding insertion is relative to the created contexts within this list.
|
|
73587
73628
|
*/
|
|
@@ -73937,7 +73978,7 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
73937
73978
|
getHeaderContext(): Context | null;
|
|
73938
73979
|
/**
|
|
73939
73980
|
* Calls {@link sap.ui.model.odata.v4.Context#setKeepAlive} at the context for the given path and returns
|
|
73940
|
-
* it. Since 1.100.0 the function always returns such a context. If none exists yet, it is created without
|
|
73981
|
+
* it. Since 1.100.0, the function always returns such a context. If none exists yet, it is created without
|
|
73941
73982
|
* data and a request for its entity is sent.
|
|
73942
73983
|
* See:
|
|
73943
73984
|
* sap.ui.model.odata.v4.ODataModel#getKeepAliveContext
|
|
@@ -74378,7 +74419,7 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
74378
74419
|
* requests. Call {@link #resume} to resume the binding. Before 1.53.0, this method was not supported and
|
|
74379
74420
|
* threw an error. Since 1.97.0, pending changes are ignored if they relate to a {@link sap.ui.model.odata.v4.Context#isKeepAlive kept-alive }
|
|
74380
74421
|
* context of this binding. Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isTransient transient} contexts
|
|
74381
|
-
* of a {@link #getRootBinding root binding} do not count as pending changes. Since 1.108.0 {@link sap.ui.model.odata.v4.Context#delete deleted }
|
|
74422
|
+
* of a {@link #getRootBinding root binding} do not count as pending changes. Since 1.108.0, {@link sap.ui.model.odata.v4.Context#delete deleted }
|
|
74382
74423
|
* contexts do not count as pending changes.
|
|
74383
74424
|
* See:
|
|
74384
74425
|
* {@link https://ui5.sap.com/#/topic/b0f5c531e5034a27952cc748954cbe39 Suspend and Resume}
|
|
@@ -75179,9 +75220,9 @@ declare module "sap/ui/model/odata/v4/ODataMetaModel" {
|
|
|
75179
75220
|
* results either in a simple name like "EMPLOYEES" or maybe in a path like "some.other.EntityContainer/SomeEntitySet".
|
|
75180
75221
|
* The path must not continue after "@sapui.name".
|
|
75181
75222
|
*
|
|
75182
|
-
* If the current object is a string value, that string value is treated as
|
|
75183
|
-
* step-by-step before the next segment is processed. Except for this, a path must not continue
|
|
75184
|
-
* across a non-object value. Such a string value can be a qualified name (example path "/$EntityContainer/..."),
|
|
75223
|
+
* If the current object is a string value, that string value is treated as an absolute or relative path
|
|
75224
|
+
* and followed step-by-step before the next segment is processed. Except for this, a path must not continue
|
|
75225
|
+
* if it comes across a non-object value. Such a string value can be a qualified name (example path "/$EntityContainer/..."),
|
|
75185
75226
|
* a simple identifier (example path "/TEAMS/$NavigationPropertyBinding/TEAM_2_EMPLOYEES/...") including
|
|
75186
75227
|
* the special name "$ReturnType" (since 1.71.0), or even a path according to "14.5.12 Expression edm:Path"
|
|
75187
75228
|
* etc. (example path "/TEAMS/@com.sap.vocabularies.UI.v1.LineItem/0/Value/$Path/...".
|
|
@@ -75333,7 +75374,7 @@ declare module "sap/ui/model/odata/v4/ODataMetaModel" {
|
|
|
75333
75374
|
/**
|
|
75334
75375
|
* Scope for lookup of aliases for computed annotations (since 1.43.0) as a map from alias to a module (like
|
|
75335
75376
|
* `{AH : AnnotationHelper}`) or function (like `{format : AnnotationHelper.format}`); the alias must not
|
|
75336
|
-
* contain a dot. Since 1.120.3 looking up a computed annotation via its global name is **deprecated**;
|
|
75377
|
+
* contain a dot. Since 1.120.3, looking up a computed annotation via its global name is **deprecated**;
|
|
75337
75378
|
* always use this scope instead.
|
|
75338
75379
|
*/
|
|
75339
75380
|
scope?: Record<string, object | Function>;
|
|
@@ -76324,8 +76365,8 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
|
|
|
76324
76365
|
* Returns a context with the given path belonging to a matching list binding that has been marked with
|
|
76325
76366
|
* `$$getKeepAliveContext` (see {@link #bindList}). If such a matching binding can be found, a context is
|
|
76326
76367
|
* returned and kept alive (see {@link sap.ui.model.odata.v4.ODataListBinding#getKeepAliveContext}). Since
|
|
76327
|
-
* 1.100.0 a temporary binding is used if no such binding could be found. If such a binding is created
|
|
76328
|
-
* resolved later, the context and its data are transferred to it, and the temporary binding is destroyed
|
|
76368
|
+
* 1.100.0, a temporary binding is used if no such binding could be found. If such a binding is created
|
|
76369
|
+
* or resolved later, the context and its data are transferred to it, and the temporary binding is destroyed
|
|
76329
76370
|
* again.
|
|
76330
76371
|
*
|
|
76331
76372
|
* A `$$getKeepAliveContext` binding matches if its resolved binding path is the collection path of the
|
|
@@ -76569,6 +76610,28 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
|
|
|
76569
76610
|
*/
|
|
76570
76611
|
sGroupId?: string
|
|
76571
76612
|
): void;
|
|
76613
|
+
/**
|
|
76614
|
+
* Sets the "odata.continue-on-error" preference for the **current** batch request associated with the given
|
|
76615
|
+
* group ID. This method can be called early on, when the batch queue is still empty, or even synchronously
|
|
76616
|
+
* after {@link #submitBatch} - just as long as the $batch request is not already being sent to the server.
|
|
76617
|
+
* It needs to be called again for future batch requests with the same group ID. It is safe to call it multiple
|
|
76618
|
+
* times for the same batch request.
|
|
76619
|
+
*
|
|
76620
|
+
* **Caution:** Make sure that no user input is lost due to a side-effects GET being applied even after
|
|
76621
|
+
* a failed PATCH. It's safe to use this method if, for example, only actions are invoked or when {@link sap.ui.model.odata.v4.Context#setProperty }
|
|
76622
|
+
* is used without `bRetry` for mass updates.
|
|
76623
|
+
*
|
|
76624
|
+
* @since 1.141.0
|
|
76625
|
+
*/
|
|
76626
|
+
setContinueOnError(
|
|
76627
|
+
/**
|
|
76628
|
+
* A valid group ID as specified in {@link sap.ui.model.odata.v4.ODataModel}. Avoid '$auto' to control which
|
|
76629
|
+
* requests are affected by this preference. Using a {@link module:sap/base/util/uid UID} may be one way
|
|
76630
|
+
* to achieve this, but take care to replace hyphens with underscores: `"$auto." + uid().replaceAll("-",
|
|
76631
|
+
* "_")`
|
|
76632
|
+
*/
|
|
76633
|
+
sGroupId: string
|
|
76634
|
+
): void;
|
|
76572
76635
|
/**
|
|
76573
76636
|
* Method not supported
|
|
76574
76637
|
*
|
|
@@ -77075,7 +77138,7 @@ declare module "sap/ui/model/odata/v4/ODataPropertyBinding" {
|
|
|
77075
77138
|
* Sets the new current value and updates the cache. If the value cannot be accepted or cannot be updated
|
|
77076
77139
|
* on the server, an error is logged to the console and added to the message manager as a technical message.
|
|
77077
77140
|
* Unless preconditions fail synchronously, a {@link sap.ui.model.odata.v4.ODataModel#event:propertyChange 'propertyChange' }
|
|
77078
|
-
* event is fired and provides a promise on the outcome of the asynchronous operation. Since 1.122.0 this
|
|
77141
|
+
* event is fired and provides a promise on the outcome of the asynchronous operation. Since 1.122.0, this
|
|
77079
77142
|
* method allows updates to the client-side annotation "@$ui5.context.isSelected". Note: Changing the value
|
|
77080
77143
|
* of a client-side annotation never initiates a PATCH request, no matter which `sGroupId` is given. Thus,
|
|
77081
77144
|
* it cannot be reverted via {@link #resetChanges}.
|
|
@@ -81605,7 +81668,7 @@ declare module "sap/ui/test/gherkin/dataTableUtils" {
|
|
|
81605
81668
|
*
|
|
81606
81669
|
*
|
|
81607
81670
|
* - Trim spaces off the string on both sides. For example: `" hello "` becomes `"hello"`.
|
|
81608
|
-
* - Assume that
|
|
81671
|
+
* - Assume that hyphens and underscores are analogs for a space. For example: `"sold-to party"` and `"sold
|
|
81609
81672
|
* to party"` are equivalent, and would both convert to the camelCase `"soldToParty"`.
|
|
81610
81673
|
* - Trim multiple spaces between words. For example: `"hello____world"` becomes `"hello world"`.
|
|
81611
81674
|
* - Remove any characters that are not alphanumeric or whitespace. For example: `"(hello)"` becomes `"hello"`.
|
|
@@ -81704,7 +81767,7 @@ declare module "sap/ui/test/gherkin/dataTableUtils" {
|
|
|
81704
81767
|
*
|
|
81705
81768
|
*
|
|
81706
81769
|
* - Trim spaces off the string on both sides. For example: `" hello "` becomes `"hello"`.
|
|
81707
|
-
* - Assume that
|
|
81770
|
+
* - Assume that hyphens and underscores are analogs for a space. For example: `"sold-to party"` and `"sold
|
|
81708
81771
|
* to party"` are equivalent, and would both convert to the camelCase `"soldToParty"`.
|
|
81709
81772
|
* - Trim multiple spaces between words. For example: `"hello____world"` becomes `"hello world"`.
|
|
81710
81773
|
* - Remove any characters that are not alphanumeric or whitespace. For example: `"(hello)"` becomes `"hello"`.
|