@openui5/ts-types 1.136.2 → 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.2
1
+ // For Library Version: 1.138.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -495,12 +495,11 @@ declare namespace sap {
495
495
  /**
496
496
  * Gets translated text from the i18n properties files configured for this card.
497
497
  *
498
- * For more details see {@link module:sap/base/i18n/ResourceBundle#getText}.
498
+ * This method uses `ResourceBundle.getText()`. For more details see {@link module:sap/base/i18n/ResourceBundle#getText}.
499
499
  *
500
- * @experimental As of version 1.83. The API might change.
501
500
  *
502
- * @returns The value belonging to the key, if found; otherwise the key itself or `undefined` depending
503
- * on `bIgnoreKeyFallback`.
501
+ * @returns The value belonging to the key, if found; otherwise, it returns the key itself or `undefined`
502
+ * depending on `bIgnoreKeyFallback`.
504
503
  */
505
504
  getTranslatedText(
506
505
  /**
@@ -519,7 +518,7 @@ declare namespace sap {
519
518
  * fallback bundle.
520
519
  */
521
520
  bIgnoreKeyFallback?: boolean
522
- ): string;
521
+ ): string | undefined;
523
522
  /**
524
523
  * Hide the blocking message that is shown in the card by `showBlockingMessage` call.
525
524
  *
@@ -634,15 +633,26 @@ declare namespace sap {
634
633
  */
635
634
  method?: string;
636
635
  /**
637
- * The request parameters. If the HTTP method is "POST", "PUT", "PATCH", or "DELETE" the parameters will
638
- * be put into the body of the request.
636
+ * The request parameters to be sent to the server. They are sent as follows:
637
+ * - When the HTTP method is "GET" or "HEAD", and parameters are set as:
638
+ * object - Sent as part of the URL, appended as key/value pairs in the query string
639
+ * - FormData - Not sent
640
+ * - string - Not sent
641
+ * - When the HTTP method is "POST", "PUT", "PATCH", or "DELETE", the parameters will be sent in the
642
+ * request body, encoded based on the `Content-Type` header and parameters type:
643
+ * object - Supports the following encodings, decided based on the Content-Type header of the request:
639
644
  *
640
- * **Note:** If parameters are of type "FormData", the "FormData" will not be resolved for bindings, destinations
641
- * and others. It will be sent as it is.
645
+ * `application/x-www-form-urlencoded` - Default
646
+ * - `application/json`
647
+ * - FormData - Encoded as `multipart/form-data`. The `Content-Type` header on the request must not be
648
+ * set explicitly. **Note:** FormData will not be resolved for bindings, destinations and others. It will
649
+ * be sent as it is. Added since version 1.130
650
+ * - string - Must be used in combination with `Content-Type: text/plain`. Will be sent as is. Added since
651
+ * version 1.138
642
652
  */
643
- parameters?: object | FormData;
653
+ parameters?: object | FormData | string;
644
654
  /**
645
- * Deprecated. Use the correct Accept headers and correct Content-Type header in the response.
655
+ * Deprecated. Use the correct `Accept` headers and set correct `Content-Type` header in the response.
646
656
  */
647
657
  dataType?: string;
648
658
  /**
@@ -1779,12 +1789,11 @@ declare namespace sap {
1779
1789
  /**
1780
1790
  * Gets translated text from the i18n properties files configured for this card.
1781
1791
  *
1782
- * For more details see {@link module:sap/base/i18n/ResourceBundle#getText}.
1792
+ * This method uses `ResourceBundle.getText()`. For more details see {@link module:sap/base/i18n/ResourceBundle#getText}.
1783
1793
  *
1784
- * @experimental As of version 1.83. The API might change.
1785
1794
  *
1786
- * @returns The value belonging to the key, if found; otherwise the key itself or `undefined` depending
1787
- * on `bIgnoreKeyFallback`.
1795
+ * @returns The value belonging to the key, if found; otherwise, it returns the key itself or `undefined`
1796
+ * depending on `bIgnoreKeyFallback`.
1788
1797
  */
1789
1798
  getTranslatedText(
1790
1799
  /**
@@ -1803,7 +1812,7 @@ declare namespace sap {
1803
1812
  * fallback bundle.
1804
1813
  */
1805
1814
  bIgnoreKeyFallback?: boolean
1806
- ): string;
1815
+ ): string | undefined;
1807
1816
  /**
1808
1817
  * Gets current value of property {@link #getUseProgressiveDisclosure useProgressiveDisclosure}.
1809
1818
  *
@@ -1963,15 +1972,26 @@ declare namespace sap {
1963
1972
  */
1964
1973
  method?: string;
1965
1974
  /**
1966
- * The request parameters. If the HTTP method is "POST", "PUT", "PATCH", or "DELETE" the parameters will
1967
- * be put into the body of the request.
1975
+ * The request parameters to be sent to the server. They are sent as follows:
1976
+ * - When the HTTP method is "GET" or "HEAD", and parameters are set as:
1977
+ * object - Sent as part of the URL, appended as key/value pairs in the query string
1978
+ * - FormData - Not sent
1979
+ * - string - Not sent
1980
+ * - When the HTTP method is "POST", "PUT", "PATCH", or "DELETE", the parameters will be sent in the
1981
+ * request body, encoded based on the `Content-Type` header and parameters type:
1982
+ * object - Supports the following encodings, decided based on the Content-Type header of the request:
1968
1983
  *
1969
- * **Note:** If parameters are of type "FormData", the "FormData" will not be resolved for bindings, destinations
1970
- * and others. It will be sent as it is.
1984
+ * `application/x-www-form-urlencoded` - Default
1985
+ * - `application/json`
1986
+ * - FormData - Encoded as `multipart/form-data`. The `Content-Type` header on the request must not be
1987
+ * set explicitly. **Note:** FormData will not be resolved for bindings, destinations and others. It will
1988
+ * be sent as it is. Added since version 1.130
1989
+ * - string - Must be used in combination with `Content-Type: text/plain`. Will be sent as is. Added since
1990
+ * version 1.138
1971
1991
  */
1972
- parameters?: object | FormData;
1992
+ parameters?: object | FormData | string;
1973
1993
  /**
1974
- * Deprecated. Use the correct Accept headers and correct Content-Type header in the response.
1994
+ * Deprecated. Use the correct `Accept` headers and set correct `Content-Type` header in the response.
1975
1995
  */
1976
1996
  dataType?: string;
1977
1997
  /**
@@ -3513,7 +3533,7 @@ declare namespace sap {
3513
3533
  *
3514
3534
  * @returns Value of property `formatters`
3515
3535
  */
3516
- getFormatters(): Record<string, () => void> | undefined;
3536
+ getFormatters(): Record<string, Function> | undefined;
3517
3537
  /**
3518
3538
  * Override this method to lazy load dependencies for the extension.
3519
3539
  *
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.136.2
1
+ // For Library Version: 1.138.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {