@openui5/ts-types 1.135.0 → 1.136.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.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.135.0
1
+ // For Library Version: 1.136.0
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.135.0
1
+ // For Library Version: 1.136.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.135.0
1
+ // For Library Version: 1.136.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -279,7 +279,7 @@ declare namespace sap {
279
279
  "sap/ui/thirdparty/qunit-2": undefined;
280
280
  }
281
281
  }
282
- // For Library Version: 1.135.0
282
+ // For Library Version: 1.136.0
283
283
 
284
284
  declare module "sap/base/assert" {
285
285
  /**
@@ -1748,7 +1748,7 @@ declare module "sap/base/Log" {
1748
1748
  sComponent?: string,
1749
1749
  /**
1750
1750
  * Callback that returns an additional support object to be logged in support mode. This function is only
1751
- * called if support info mode is turned on with `logSupportInfo(true)`. To avoid negative effects regarding
1751
+ * called if support info mode is turned on via the Support Assistant. To avoid negative effects regarding
1752
1752
  * execution times and memory consumption, the returned object should be a simple immutable JSON object
1753
1753
  * with mostly static and stable content.
1754
1754
  */
@@ -1773,7 +1773,7 @@ declare module "sap/base/Log" {
1773
1773
  sComponent?: string,
1774
1774
  /**
1775
1775
  * Callback that returns an additional support object to be logged in support mode. This function is only
1776
- * called if support info mode is turned on with `logSupportInfo(true)`. To avoid negative effects regarding
1776
+ * called if support info mode is turned on via the Support Assistant. To avoid negative effects regarding
1777
1777
  * execution times and memory consumption, the returned object should be a simple immutable JSON object
1778
1778
  * with mostly static and stable content.
1779
1779
  */
@@ -1798,7 +1798,7 @@ declare module "sap/base/Log" {
1798
1798
  sComponent?: string,
1799
1799
  /**
1800
1800
  * Callback that returns an additional support object to be logged in support mode. This function is only
1801
- * called if support info mode is turned on with `logSupportInfo(true)`. To avoid negative effects regarding
1801
+ * called if support info mode is turned on via the Support Assistant. To avoid negative effects regarding
1802
1802
  * execution times and memory consumption, the returned object should be a simple immutable JSON object
1803
1803
  * with mostly static and stable content.
1804
1804
  */
@@ -1872,7 +1872,7 @@ declare module "sap/base/Log" {
1872
1872
  sComponent?: string,
1873
1873
  /**
1874
1874
  * Callback that returns an additional support object to be logged in support mode. This function is only
1875
- * called if support info mode is turned on with `logSupportInfo(true)`. To avoid negative effects regarding
1875
+ * called if support info mode is turned on via the Support Assistant. To avoid negative effects regarding
1876
1876
  * execution times and memory consumption, the returned object should be a simple immutable JSON object
1877
1877
  * with mostly static and stable content.
1878
1878
  */
@@ -1944,7 +1944,7 @@ declare module "sap/base/Log" {
1944
1944
  sComponent?: string,
1945
1945
  /**
1946
1946
  * Callback that returns an additional support object to be logged in support mode. This function is only
1947
- * called if support info mode is turned on with `logSupportInfo(true)`. To avoid negative effects regarding
1947
+ * called if support info mode is turned on via the Support Assistant. To avoid negative effects regarding
1948
1948
  * execution times and memory consumption, the returned object should be a simple immutable JSON object
1949
1949
  * with mostly static and stable content.
1950
1950
  */
@@ -1969,7 +1969,7 @@ declare module "sap/base/Log" {
1969
1969
  sComponent?: string,
1970
1970
  /**
1971
1971
  * Callback that returns an additional support object to be logged in support mode. This function is only
1972
- * called if support info mode is turned on with `logSupportInfo(true)`. To avoid negative effects regarding
1972
+ * called if support info mode is turned on via the Support Assistant. To avoid negative effects regarding
1973
1973
  * execution times and memory consumption, the returned object should be a simple immutable JSON object
1974
1974
  * with mostly static and stable content.
1975
1975
  */
@@ -2133,7 +2133,7 @@ declare module "sap/base/Log" {
2133
2133
  sComponent?: string,
2134
2134
  /**
2135
2135
  * Callback that returns an additional support object to be logged in support mode. This function is only
2136
- * called if support info mode is turned on with `logSupportInfo(true)`. To avoid negative effects regarding
2136
+ * called if support info mode is turned on via the Support Assistant. To avoid negative effects regarding
2137
2137
  * execution times and memory consumption, the returned object should be a simple immutable JSON object
2138
2138
  * with mostly static and stable content.
2139
2139
  */
@@ -2158,7 +2158,7 @@ declare module "sap/base/Log" {
2158
2158
  sComponent?: string,
2159
2159
  /**
2160
2160
  * Callback that returns an additional support object to be logged in support mode. This function is only
2161
- * called if support info mode is turned on with `logSupportInfo(true)`. To avoid negative effects regarding
2161
+ * called if support info mode is turned on via the Support Assistant. To avoid negative effects regarding
2162
2162
  * execution times and memory consumption, the returned object should be a simple immutable JSON object
2163
2163
  * with mostly static and stable content.
2164
2164
  */
@@ -2183,7 +2183,7 @@ declare module "sap/base/Log" {
2183
2183
  sComponent?: string,
2184
2184
  /**
2185
2185
  * Callback that returns an additional support object to be logged in support mode. This function is only
2186
- * called if support info mode is turned on with `logSupportInfo(true)`. To avoid negative effects regarding
2186
+ * called if support info mode is turned on via the Support Assistant. To avoid negative effects regarding
2187
2187
  * execution times and memory consumption, the returned object should be a simple immutable JSON object
2188
2188
  * with mostly static and stable content.
2189
2189
  */
@@ -2222,7 +2222,7 @@ declare module "sap/base/Log" {
2222
2222
  sComponent?: string,
2223
2223
  /**
2224
2224
  * Callback that returns an additional support object to be logged in support mode. This function is only
2225
- * called if support info mode is turned on with `logSupportInfo(true)`. To avoid negative effects regarding
2225
+ * called if support info mode is turned on via the Support Assistant. To avoid negative effects regarding
2226
2226
  * execution times and memory consumption, the returned object should be a simple immutable JSON object
2227
2227
  * with mostly static and stable content.
2228
2228
  */
@@ -2285,7 +2285,7 @@ declare module "sap/base/Log" {
2285
2285
  sComponent?: string,
2286
2286
  /**
2287
2287
  * Callback that returns an additional support object to be logged in support mode. This function is only
2288
- * called if support info mode is turned on with `logSupportInfo(true)`. To avoid negative effects regarding
2288
+ * called if support info mode is turned on via the Support Assistant. To avoid negative effects regarding
2289
2289
  * execution times and memory consumption, the returned object should be a simple immutable JSON object
2290
2290
  * with mostly static and stable content.
2291
2291
  */
@@ -2310,7 +2310,7 @@ declare module "sap/base/Log" {
2310
2310
  sComponent?: string,
2311
2311
  /**
2312
2312
  * Callback that returns an additional support object to be logged in support mode. This function is only
2313
- * called if support info mode is turned on with `logSupportInfo(true)`. To avoid negative effects regarding
2313
+ * called if support info mode is turned on via the Support Assistant. To avoid negative effects regarding
2314
2314
  * execution times and memory consumption, the returned object should be a simple immutable JSON object
2315
2315
  * with mostly static and stable content.
2316
2316
  */
@@ -20925,86 +20925,15 @@ declare namespace sap {
20925
20925
  */
20926
20926
  static getMetadata(): sap.ui.base.Metadata;
20927
20927
  /**
20928
- * Registers a callback module, which provides code enhancements for the lifecycle and event handler functions
20929
- * of a specific controller. The code enhancements are returned either in sync or async mode.
20930
- *
20931
- * The extension provider module provides the `getControllerExtensions` function which returns either directly
20932
- * an array of objects or a Promise that returns an array of objects when it resolves. These objects are
20933
- * object literals defining the methods and properties of the controller in a similar way as for {@link sap.ui.core.mvc.Controller Controller }
20934
- * subclasses.
20935
- *
20936
- * **Example for a callback module definition (sync):**
20937
- * ```javascript
20938
- *
20939
- * sap.ui.define("my/custom/sync/ExtensionProvider", [], function() {
20940
- * var ExtensionProvider = function() {};
20941
- * ExtensionProvider.prototype.getControllerExtensions = function(sControllerName, sComponentId, bAsync) {
20942
- * if (!bAsync && sControllerName == "my.own.Controller") {
20943
- * // IMPORTANT: only return extensions for a specific controller
20944
- * return [{
20945
- * onInit: function() {
20946
- * // Do something here...
20947
- * },
20948
- * onAfterRendering: function() {
20949
- * // Do something here...
20950
- * },
20951
- * onButtonClick: function(oEvent) {
20952
- * // Handle the button click event
20953
- * }
20954
- * }
20955
- * }];
20956
- * };
20957
- * return ExtensionProvider;
20958
- * });
20959
- * ```
20960
- *
20961
- *
20962
- * **Example for a callback module definition (async):**
20963
- * ```javascript
20964
- *
20965
- * sap.ui.define("my/custom/async/ExtensionProvider", [], function() {
20966
- * var ExtensionProvider = function() {};
20967
- * ExtensionProvider.prototype.getControllerExtensions = function(sControllerName, sComponentId, bAsync) {
20968
- * if (bAsync && sControllerName == "my.own.Controller") {
20969
- * // IMPORTANT:
20970
- * // only return a Promise for a specific controller since it
20971
- * // requires the View/Controller and its parents to run in async
20972
- * // mode!
20973
- * return new Promise(function(fnResolve, fnReject) {
20974
- * fnResolve([{
20975
- * onInit: function() {
20976
- * // Do something here...
20977
- * },
20978
- * onAfterRendering: function() {
20979
- * // Do something here...
20980
- * },
20981
- * onButtonClick: function(oEvent) {
20982
- * // Handle the button click event
20983
- * }
20984
- * }]);
20985
- * }
20986
- * };
20987
- * };
20988
- * return ExtensionProvider;
20989
- * });
20990
- * ```
20991
- *
20992
- *
20993
- * The lifecycle functions `onInit`, `onExit`, `onBeforeRendering` and `onAfterRendering` are added before
20994
- * or after the lifecycle functions of the original controller. The event handler functions, such as `onButtonClick`,
20995
- * are replacing the original controller's function.
20996
- *
20997
- * When using an async extension provider, you need to ensure that the view is loaded in async mode.
20998
- *
20999
- * In both cases, return `undefined` if no controller extension shall be applied.
20928
+ * See {@link sap.ui.core.mvc.ControllerExtensionProvider.registerExtensionProvider}.
21000
20929
  *
21001
20930
  * @since 1.34.0
20931
+ * @deprecated As of version 1.136.0. without replacement, the extension provider concept is intended for
20932
+ * framework internal use only.
21002
20933
  */
21003
20934
  static registerExtensionProvider(
21004
20935
  /**
21005
20936
  * the module name of the extension provider
21006
- *
21007
- * See {@link sap.ui.core.mvc.Controller} for an overview of the available functions for controllers.
21008
20937
  */
21009
20938
  sExtensionProvider: string
21010
20939
  ): void;
@@ -24296,35 +24225,35 @@ declare namespace sap {
24296
24225
  * This enum is part of the 'sap/ui/core/Popup' module export and must be accessed by the property 'Dock'.
24297
24226
  */
24298
24227
  enum Dock {
24299
- BeginBottom = "begin bottom",
24228
+ BeginBottom = "BeginBottom",
24300
24229
 
24301
- BeginCenter = "begin center",
24230
+ BeginCenter = "BeginCenter",
24302
24231
 
24303
- BeginTop = "begin top",
24232
+ BeginTop = "BeginTop",
24304
24233
 
24305
- CenterBottom = "center bottom",
24234
+ CenterBottom = "CenterBottom",
24306
24235
 
24307
- CenterCenter = "center center",
24236
+ CenterCenter = "CenterCenter",
24308
24237
 
24309
- CenterTop = "center top",
24238
+ CenterTop = "CenterTop",
24310
24239
 
24311
- EndBottom = "end bottom",
24240
+ EndBottom = "EndBottom",
24312
24241
 
24313
- EndCenter = "end center",
24242
+ EndCenter = "EndCenter",
24314
24243
 
24315
- EndTop = "end top",
24244
+ EndTop = "EndTop",
24316
24245
 
24317
- LeftBottom = "left bottom",
24246
+ LeftBottom = "LeftBottom",
24318
24247
 
24319
- LeftCenter = "left center",
24248
+ LeftCenter = "LeftCenter",
24320
24249
 
24321
- LeftTop = "left top",
24250
+ LeftTop = "LeftTop",
24322
24251
 
24323
- RightBottom = "right bottom",
24252
+ RightBottom = "RightBottom",
24324
24253
 
24325
- RightCenter = "right center",
24254
+ RightCenter = "RightCenter",
24326
24255
 
24327
- RightTop = "right top",
24256
+ RightTop = "RightTop",
24328
24257
  }
24329
24258
 
24330
24259
  type PositionInfo = {
@@ -37874,7 +37803,9 @@ declare namespace sap {
37874
37803
  * the manifest will not be evaluated before the controller. It might still be loaded synchronously if declared
37875
37804
  * in the Component metadata. A non-empty string value will be interpreted as the URL to load the manifest
37876
37805
  * from. If the manifest could not be loaded from a given URL, the Promise returned by the Component.create
37877
- * factory rejects. A non-null object value will be interpreted as manifest content.
37806
+ * factory rejects. A non-null object value will be interpreted as manifest content. **Note:** If a manifest
37807
+ * is provided as URL or plain object, it must use the same major schema version as the original manifest
37808
+ * to avoid incompatible changes in the behavior of the component.
37878
37809
  */
37879
37810
  manifest?: boolean | string | object;
37880
37811
  /**
@@ -60897,10 +60828,7 @@ declare namespace sap {
60897
60828
  * - `properties` could be an array containing the property names which should be included in the new
60898
60829
  * entry. Other properties defined in the entity type won't be included.
60899
60830
  * - `properties` could be an object which includes the desired properties and the corresponding values
60900
- * which should be used for the created entry. If `properties` is not specified, all properties in
60901
- * the entity type will be included in the created entry.
60902
- *
60903
- * If there are no values specified, the properties will have `undefined` values.
60831
+ * which should be used for the created entry.
60904
60832
  *
60905
60833
  * The `properties` can be modified via property bindings relative to the returned context instance.
60906
60834
  *
@@ -64106,8 +64034,8 @@ declare namespace sap {
64106
64034
  *
64107
64035
  * @since 1.125.0
64108
64036
  *
64109
- * @returns A promise which is resolved without a defined result when the move is finished, or rejected
64110
- * in case of an error
64037
+ * @returns A promise which is resolved without a defined result when the move is finished, or with the
64038
+ * index for the copied node, or rejected in case of an error
64111
64039
  */
64112
64040
  move(
64113
64041
  /**
@@ -64115,7 +64043,8 @@ declare namespace sap {
64115
64043
  */
64116
64044
  oParameters: {
64117
64045
  /**
64118
- * Whether the node should be copied instead of moved (@experimental as of version 1.135.0)
64046
+ * Whether the node should be copied instead of moved (@experimental as of version 1.135.0). The returned
64047
+ * promise resolves with the index for the copied node.
64119
64048
  */
64120
64049
  copy?: boolean;
64121
64050
  /**
@@ -64128,7 +64057,7 @@ declare namespace sap {
64128
64057
  */
64129
64058
  parent: sap.ui.model.odata.v4.Context | null;
64130
64059
  }
64131
- ): Promise<void>;
64060
+ ): Promise<number | undefined>;
64132
64061
  /**
64133
64062
  * Refreshes the single entity represented by this context. Use {@link #requestRefresh} if you want to wait
64134
64063
  * for the refresh.
@@ -65203,6 +65132,40 @@ declare namespace sap {
65203
65132
  */
65204
65133
  oListener?: object
65205
65134
  ): this;
65135
+ /**
65136
+ * Attach event handler `fnFunction` to the 'selectionChanged' event of this binding.
65137
+ *
65138
+ * @since 1.136.0
65139
+ *
65140
+ * @returns `this` to allow method chaining
65141
+ */
65142
+ attachSelectionChanged(
65143
+ /**
65144
+ * The function to call when the event occurs
65145
+ */
65146
+ fnFunction: Function,
65147
+ /**
65148
+ * Object on which to call the given function
65149
+ */
65150
+ oListener?: object
65151
+ ): this;
65152
+ /**
65153
+ * Attach event handler `fnFunction` to the 'separateReceived' event of this binding.
65154
+ *
65155
+ * @since 1.136.0
65156
+ *
65157
+ * @returns `this` to allow method chaining
65158
+ */
65159
+ attachSeparateReceived(
65160
+ /**
65161
+ * The function to call when the event occurs
65162
+ */
65163
+ fnFunction: Function,
65164
+ /**
65165
+ * Object on which to call the given function
65166
+ */
65167
+ oListener?: object
65168
+ ): this;
65206
65169
  /**
65207
65170
  * Changes this binding's parameters and refreshes the binding. Since 1.111.0, a list binding's header context
65208
65171
  * is deselected, but (since 1.120.13) only if the binding parameter '$$clearSelectionOnFilter' is set and
@@ -65434,6 +65397,40 @@ declare namespace sap {
65434
65397
  */
65435
65398
  oListener?: object
65436
65399
  ): this;
65400
+ /**
65401
+ * Detach event handler `fnFunction` from the 'selectionChanged' event of this binding.
65402
+ *
65403
+ * @since 1.136.0
65404
+ *
65405
+ * @returns `this` to allow method chaining
65406
+ */
65407
+ detachSelectionChanged(
65408
+ /**
65409
+ * The function to call when the event occurs
65410
+ */
65411
+ fnFunction: (evt: ODataListBinding$SelectionChangedEvent) => void,
65412
+ /**
65413
+ * Object on which to call the given function
65414
+ */
65415
+ oListener?: object
65416
+ ): this;
65417
+ /**
65418
+ * Detach event handler `fnFunction` from the 'separateReceived' event of this binding.
65419
+ *
65420
+ * @since 1.136.0
65421
+ *
65422
+ * @returns `this` to allow method chaining
65423
+ */
65424
+ detachSeparateReceived(
65425
+ /**
65426
+ * The function to call when the event occurs
65427
+ */
65428
+ fnFunction: (evt: ODataListBinding$SeparateReceivedEvent) => void,
65429
+ /**
65430
+ * Object on which to call the given function
65431
+ */
65432
+ oListener?: object
65433
+ ): this;
65437
65434
  /**
65438
65435
  * Filters the list with the given filters. Since 1.97.0, if filters are unchanged, no request is sent,
65439
65436
  * regardless of pending changes. Since 1.111.0, all contexts (incl. the header context) are deselected,
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.135.0
1
+ // For Library Version: 1.136.0
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.135.0
1
+ // For Library Version: 1.136.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.135.0
1
+ // For Library Version: 1.136.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -4262,7 +4262,7 @@ declare namespace sap {
4262
4262
  ): this;
4263
4263
  }
4264
4264
  /**
4265
- * Defines the layout type of the List card attributes.
4265
+ * Defines the layout type of the List Card attributes.
4266
4266
  *
4267
4267
  * This enum is part of the 'sap/ui/integration/library' module export and must be accessed by the property
4268
4268
  * 'AttributesLayoutType'.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.135.0
1
+ // For Library Version: 1.136.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {