@openui5/types 1.136.1 → 1.138.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.136.1
1
+ // For Library Version: 1.138.0
2
2
 
3
3
  declare module "sap/ui/integration/library" {
4
4
  import { URI } from "sap/ui/core/library";
@@ -1718,12 +1718,11 @@ declare module "sap/ui/integration/widgets/Card" {
1718
1718
  /**
1719
1719
  * Gets translated text from the i18n properties files configured for this card.
1720
1720
  *
1721
- * For more details see {@link module:sap/base/i18n/ResourceBundle#getText}.
1721
+ * This method uses `ResourceBundle.getText()`. For more details see {@link module:sap/base/i18n/ResourceBundle#getText}.
1722
1722
  *
1723
- * @experimental As of version 1.83. The API might change.
1724
1723
  *
1725
- * @returns The value belonging to the key, if found; otherwise the key itself or `undefined` depending
1726
- * on `bIgnoreKeyFallback`.
1724
+ * @returns The value belonging to the key, if found; otherwise, it returns the key itself or `undefined`
1725
+ * depending on `bIgnoreKeyFallback`.
1727
1726
  */
1728
1727
  getTranslatedText(
1729
1728
  /**
@@ -1742,7 +1741,7 @@ declare module "sap/ui/integration/widgets/Card" {
1742
1741
  * fallback bundle.
1743
1742
  */
1744
1743
  bIgnoreKeyFallback?: boolean
1745
- ): string;
1744
+ ): string | undefined;
1746
1745
  /**
1747
1746
  * Gets current value of property {@link #getUseProgressiveDisclosure useProgressiveDisclosure}.
1748
1747
  *
@@ -1899,15 +1898,26 @@ declare module "sap/ui/integration/widgets/Card" {
1899
1898
  */
1900
1899
  method?: string;
1901
1900
  /**
1902
- * The request parameters. If the HTTP method is "POST", "PUT", "PATCH", or "DELETE" the parameters will
1903
- * be put into the body of the request.
1901
+ * The request parameters to be sent to the server. They are sent as follows:
1902
+ * - When the HTTP method is "GET" or "HEAD", and parameters are set as:
1903
+ * object - Sent as part of the URL, appended as key/value pairs in the query string
1904
+ * - FormData - Not sent
1905
+ * - string - Not sent
1906
+ * - When the HTTP method is "POST", "PUT", "PATCH", or "DELETE", the parameters will be sent in the
1907
+ * request body, encoded based on the `Content-Type` header and parameters type:
1908
+ * object - Supports the following encodings, decided based on the Content-Type header of the request:
1904
1909
  *
1905
- * **Note:** If parameters are of type "FormData", the "FormData" will not be resolved for bindings, destinations
1906
- * and others. It will be sent as it is.
1910
+ * `application/x-www-form-urlencoded` - Default
1911
+ * - `application/json`
1912
+ * - FormData - Encoded as `multipart/form-data`. The `Content-Type` header on the request must not be
1913
+ * set explicitly. **Note:** FormData will not be resolved for bindings, destinations and others. It will
1914
+ * be sent as it is. Added since version 1.130
1915
+ * - string - Must be used in combination with `Content-Type: text/plain`. Will be sent as is. Added since
1916
+ * version 1.138
1907
1917
  */
1908
- parameters?: object | FormData;
1918
+ parameters?: object | FormData | string;
1909
1919
  /**
1910
- * Deprecated. Use the correct Accept headers and correct Content-Type header in the response.
1920
+ * Deprecated. Use the correct `Accept` headers and set correct `Content-Type` header in the response.
1911
1921
  */
1912
1922
  dataType?: string;
1913
1923
  /**
@@ -2358,12 +2368,11 @@ declare module "sap/ui/integration/widgets/Card" {
2358
2368
  /**
2359
2369
  * Gets translated text from the i18n properties files configured for this card.
2360
2370
  *
2361
- * For more details see {@link module:sap/base/i18n/ResourceBundle#getText}.
2371
+ * This method uses `ResourceBundle.getText()`. For more details see {@link module:sap/base/i18n/ResourceBundle#getText}.
2362
2372
  *
2363
- * @experimental As of version 1.83. The API might change.
2364
2373
  *
2365
- * @returns The value belonging to the key, if found; otherwise the key itself or `undefined` depending
2366
- * on `bIgnoreKeyFallback`.
2374
+ * @returns The value belonging to the key, if found; otherwise, it returns the key itself or `undefined`
2375
+ * depending on `bIgnoreKeyFallback`.
2367
2376
  */
2368
2377
  getTranslatedText(
2369
2378
  /**
@@ -2382,7 +2391,7 @@ declare module "sap/ui/integration/widgets/Card" {
2382
2391
  * fallback bundle.
2383
2392
  */
2384
2393
  bIgnoreKeyFallback?: boolean
2385
- ): string;
2394
+ ): string | undefined;
2386
2395
  /**
2387
2396
  * Hide the blocking message that is shown in the card by `showBlockingMessage` call.
2388
2397
  *
@@ -2494,15 +2503,26 @@ declare module "sap/ui/integration/widgets/Card" {
2494
2503
  */
2495
2504
  method?: string;
2496
2505
  /**
2497
- * The request parameters. If the HTTP method is "POST", "PUT", "PATCH", or "DELETE" the parameters will
2498
- * be put into the body of the request.
2506
+ * The request parameters to be sent to the server. They are sent as follows:
2507
+ * - When the HTTP method is "GET" or "HEAD", and parameters are set as:
2508
+ * object - Sent as part of the URL, appended as key/value pairs in the query string
2509
+ * - FormData - Not sent
2510
+ * - string - Not sent
2511
+ * - When the HTTP method is "POST", "PUT", "PATCH", or "DELETE", the parameters will be sent in the
2512
+ * request body, encoded based on the `Content-Type` header and parameters type:
2513
+ * object - Supports the following encodings, decided based on the Content-Type header of the request:
2499
2514
  *
2500
- * **Note:** If parameters are of type "FormData", the "FormData" will not be resolved for bindings, destinations
2501
- * and others. It will be sent as it is.
2515
+ * `application/x-www-form-urlencoded` - Default
2516
+ * - `application/json`
2517
+ * - FormData - Encoded as `multipart/form-data`. The `Content-Type` header on the request must not be
2518
+ * set explicitly. **Note:** FormData will not be resolved for bindings, destinations and others. It will
2519
+ * be sent as it is. Added since version 1.130
2520
+ * - string - Must be used in combination with `Content-Type: text/plain`. Will be sent as is. Added since
2521
+ * version 1.138
2502
2522
  */
2503
- parameters?: object | FormData;
2523
+ parameters?: object | FormData | string;
2504
2524
  /**
2505
- * Deprecated. Use the correct Accept headers and correct Content-Type header in the response.
2525
+ * Deprecated. Use the correct `Accept` headers and set correct `Content-Type` header in the response.
2506
2526
  */
2507
2527
  dataType?: string;
2508
2528
  /**
@@ -3706,7 +3726,7 @@ declare module "sap/ui/integration/Extension" {
3706
3726
  *
3707
3727
  * @returns Value of property `formatters`
3708
3728
  */
3709
- getFormatters(): Record<string, () => void> | undefined;
3729
+ getFormatters(): Record<string, Function> | undefined;
3710
3730
  /**
3711
3731
  * Override this method to lazy load dependencies for the extension.
3712
3732
  *
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.136.1
1
+ // For Library Version: 1.138.0
2
2
 
3
3
  declare module "sap/ui/layout/library" {
4
4
  import Control from "sap/ui/core/Control";