@sapui5/ts-types 1.84.29 → 1.84.32

package/types/sap.ndc.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.84.28
+// For Library Version: 1.84.32
 
 declare namespace sap {
   /**
@@ -8,6 +8,9 @@ declare namespace sap {
     /**
      * @SINCE 1.28.0
      *
+     * Please refer to SAP
+     * Note 2402585 for information on Barcode Scanner support in native iOS and Android browsers.
+     *
      * Here is an example of how to trigger the scan function of BarcodeScanner:
      * ```javascript
      *
@@ -19,30 +22,80 @@ declare namespace sap {
      * 	);
      * });
      * ```
+     *
+     *
+     * The Barcode Scanner control integrates with the laser scanner when the page is loaded in the Enterprise
+     * Browser on a Zebra device. To enable laser scanning with a Zebra device, two JavaScript files (ebapi.js
+     * and eb.barcode.js) need to be loaded during runtime by the Enterprise Browser.
+     * 	 - Your company admin / IT should configure the Barcode API settings in the Enterprise Browser config.xml
+     * 			file using mobile device management (MDM). Refer to CustomDOMElements
+     * 			for detailed information (recommended).
+     * 	 - Developers can load these files directly into an HTML file. Refer to Enabling the API for detailed
+     * 			information.
      */
     namespace BarcodeScanner {
       /**
-       * Closes the bar code input dialog. It can be used to close the dialog before the user presses the OK or
+       * Closes the barcode input dialog. It can be used to close the dialog before the user presses the OK or
        * the Cancel button (e.g. in the fnLiveUpdate callback function of the {@link sap.ndc.BarcodeScanner.scan}
        * method.)
        */
       function closeScanDialog(): void;
       /**
-       * Returns the status model of the BarcodeScanner. It is a JSON model which contains a single boolean property
-       * '`available`' indicating whether or not the bar code scanner feature is available. It can be used to
-       * bind to the `visible` property of UI controls which have to be hidden in case the feature is unavailable.
+       * Returns the scanner API info that will be used to scan the barcode.
+       */
+      function getScanAPIInfo(): string;
+      /**
+       * Returns the status model of the Barcode Scanner. It is a JSON model which contains below properties:
+       *
+       * ```javascript
+       *
+       * {
+       * 		scannerAPI: "ZXingCPP",
+       * 		available: true,
+       * 		deviceId: undefined,
+       * 		devices: [],
+       * 		apis: [
+       * 			{
+       * 				key: "ZebraEnterpriseBrowser",
+       * 				status: "UnAvailable"
+       * 			},
+       * 			{
+       * 				key: "Cordova",
+       * 				status: "UnAvailable"
+       * 			},
+       * 			{
+       * 				key: "ZXingCPP",
+       * 				status: "Available"
+       * 			},
+       * 			{
+       * 				key: "ZXing",
+       * 				status: "Initial"
+       * 			}
+       * 		]
+       * 	}
+       * ```
+       *  '`scannerAPI`' shows the current scanner API used to scan the Barcode. '`available`' indicating whether
+       * or not the Barcode Scanner feature is available. It can be used to bind to the `visible` property of
+       * UI controls which have to be hidden in case the feature is unavailable. '`deviceId`' lists the current
+       * used camera id of current device. Not working for iOS devices since do not support to get all the cameras.
+       * '`devices`' lists all the cameras of current device. Not working for iOS devices since do not support
+       * to get all the cameras. '`apis`' lists scanner APIs with status value. Status value can be: "Initial",
+       * "Loading", "Available" or "UnAvailable".
+       *
+       * IMPORTANT: This model just shows current status of Barcode Scanner. Any change to it will not impact
+       * Barcode Scanner.
        */
       function getStatusModel(): sap.ui.model.json.JSONModel;
       /**
-       * Starts the bar code scanning process either showing the live input from the camera or displaying a dialog
-       * to enter the value directly if the bar code scanning feature is not available.
+       * Starts the barcode scanning process either showing the live input from the camera or displaying a dialog
+       * to enter the value directly if the barcode scanning feature is unavailable.
        *
-       * The bar code scanning is done asynchronously. When it is triggered, this function returns without waiting
+       * The barcode scanning is done asynchronously. When it is triggered, this function returns without waiting
        * for the scanning process to finish. The applications have to provide callback functions to react to the
        * events of a successful scanning, an error during scanning, and the live input on the dialog.
        *
        * `fnSuccess` is passed an object with text, format and cancelled properties. Text is the text representation
-       * of the bar code data, format is the type of the bar code detected, and cancelled is whether or not the
+       * of the barcode data, format is the type of the barcode detected, and cancelled is whether or not the
        * user cancelled the scan. `fnError` is given the error, `fnLiveUpdate` is passed the new value entered
        * in the dialog's input field. An example:
        *
@@ -52,7 +105,7 @@ declare namespace sap {
        * sap.ui.require(["sap/ndc/BarcodeScanner"], function(BarcodeScanner) {
        * 	BarcodeScanner.scan(
        * 		function (mResult) {
-       * 			alert("We got a bar code\n" +
+       * 			alert("We got a barcode\n" +
        * 			 	"Result: " + mResult.text + "\n" +
        * 			 	"Format: " + mResult.format + "\n" +
        * 			 	"Cancelled: " + mResult.cancelled);
@@ -63,10 +116,11 @@ declare namespace sap {
        * 		function (mParams) {
        * 			alert("Value entered: " + mParams.newValue);
        * 		},
-       * 		"Enter Product Bar Code",
+       * 		"Enter Product Barcode",
        * 		true,
        * 		30,
-       * 		1
+       * 		1,
+       * 		false
        * 	);
        * });
        * ```
@@ -85,7 +139,7 @@ declare namespace sap {
          */
         fnLiveUpdate?: Function,
         /**
-         * Defines the bar code input dialog title. If unset, a predefined title will be used.
+         * Defines the barcode input dialog title. If unset, a predefined title will be used.
          */
         dialogTitle?: string,
         /**
@@ -99,20 +153,61 @@ declare namespace sap {
         /**
          * Defines the zoom of the camera. This parameter is not supported on iOS.
          */
-        zoom?: number
+        zoom?: number,
+        /**
+         * Flag, which defines whether the camera should be used for scanning in Zebra Enterprise Browser.
+         */
+        keepCameraScan?: boolean
       ): void;
+      /**
+       * Set the configs of the control Barcode Scanner.
+       */
+      function setConfig(
+        /**
+         * The options are the configs that will be used to scan. It is a object which contains below key and value:
+         * { "enableGS1Header": true, //If set to true, add the symbology identifier (GS1 specification 5.4.3.7.
+         * and 5.4.6.4.) as prefix into the result text "deviceId": "string" // The specific camera id to scan the
+         * Barcode. If set to "", Barcode Scanner will use default camera. This option is not working for iOS devices
+         * since do not support to get all the cameras. }
+         */
+        options?: object
+      ): void;
+      /**
+       * Set the callback function for the physical scan button.
+       */
+      function setPhysicalScan(
+        /**
+         * Function to be called when the scanning is done by pressing physical scan button.
+         */
+        fnPhysicalScan?: Function
+      ): void;
+      /**
+       * Set the scanner API info that will be used to scan the barcode.
+       *
+       * IMPORTANT: The status of the scanner API must be **"Available"**(for ZXingCPP and ZXing, status is **NOT
+       * "UnAvailable"**), or will return False. Scanner APIs with status value can be got by using {@link #getStatusModel}.
+       * By default, Barcode Scanner will select the scanner API(Available) with priority: ZebraEnterpriseBrowser
+       * > Cordova > ZXingCPP > ZXing.
+       */
+      function setScanAPIInfo(
+        /**
+         * Defines the scanner API to scan the barcode. Scanner API can be "ZebraEnterpriseBrowser", "Cordova",
+         * "ZXingCPP" or "ZXing".
+         */
+        scannerAPI?: string
+      ): boolean;
     }
 
     interface $BarcodeScannerButtonSettings
       extends sap.ui.core.$ControlSettings {
       /**
        * If set to true, the button remains visible if the scanner is not available and triggers a dialog to enter
-       * bar code.
+       * barcode.
        */
       provideFallback?: boolean;
 
       /**
-       * The invisible bar code scanner button is not rendered regardless of the availability of the native scan
+       * The invisible barcode scanner button is not rendered regardless of the availability of the native scan
        * feature.
        */
       visible?: boolean;
@@ -123,7 +218,7 @@ declare namespace sap {
       width?: sap.ui.core.CSSSize;
 
       /**
-       * Defines the bar code input dialog title. If unset, a predefined title will be used.
+       * Defines the barcode input dialog title. If unset, a predefined title will be used.
        */
       dialogTitle?: string;
 
@@ -142,6 +237,11 @@ declare namespace sap {
        */
       zoom?: number;
 
+      /**
+       * If set to true, the camera should be used for scanning in Zebra Enterprise Browser.
+       */
+      keepCameraScan?: boolean;
+
       /**
        * Event is fired when the scanning is finished or cancelled
        */
@@ -158,9 +258,9 @@ declare namespace sap {
       inputLiveUpdate?: Function;
     }
     /**
-     * A button control (displaying a bar code icon) to start the bar code scanning process. If the native scanning
+     * A button control (displaying a barcode icon) to start the barcode scanning process. If the native scanning
      * feature is not available or camera capability is not granted, the button is either hidden or it provides
-     * a fallback by opening a dialog with an input field where the bar code can be entered manually.
+     * a fallback by opening a dialog with an input field where the barcode can be entered manually.
      */
     class BarcodeScannerButton extends sap.ui.core.Control {
       /**
@@ -351,11 +451,11 @@ declare namespace sap {
          */
         mParameters?: {
           /**
-           * The the text representation of the bar code data.
+           * The the text representation of the barcode data.
            */
           text?: string;
           /**
-           * The type of the bar code detected.
+           * The type of the barcode detected.
            */
           format?: string;
           /**
@@ -367,7 +467,7 @@ declare namespace sap {
       /**
        * Gets current value of property {@link #getDialogTitle dialogTitle}.
        *
-       * Defines the bar code input dialog title. If unset, a predefined title will be used.
+       * Defines the barcode input dialog title. If unset, a predefined title will be used.
        */
       getDialogTitle(): string;
       /**
@@ -376,6 +476,14 @@ declare namespace sap {
        * Defines the frame rate of the camera.
        */
       getFrameRate(): number;
+      /**
+       * Gets current value of property {@link #getKeepCameraScan keepCameraScan}.
+       *
+       * If set to true, the camera should be used for scanning in Zebra Enterprise Browser.
+       *
+       * Default value is `false`.
+       */
+      getKeepCameraScan(): boolean;
       /**
        * Returns a metadata object for class sap.ndc.BarcodeScannerButton.
        */
@@ -393,7 +501,7 @@ declare namespace sap {
        * Gets current value of property {@link #getProvideFallback provideFallback}.
        *
        * If set to true, the button remains visible if the scanner is not available and triggers a dialog to enter
-       * bar code.
+       * barcode.
        *
        * Default value is `true`.
        */
@@ -401,7 +509,7 @@ declare namespace sap {
       /**
        * Gets current value of property {@link #getVisible visible}.
        *
-       * The invisible bar code scanner button is not rendered regardless of the availability of the native scan
+       * The invisible barcode scanner button is not rendered regardless of the availability of the native scan
        * feature.
        *
        * Default value is `true`.
@@ -423,7 +531,7 @@ declare namespace sap {
       /**
        * Sets a new value for property {@link #getDialogTitle dialogTitle}.
        *
-       * Defines the bar code input dialog title. If unset, a predefined title will be used.
+       * Defines the barcode input dialog title. If unset, a predefined title will be used.
        *
        * When called with a value of `null` or `undefined`, the default value of the property will be restored.
        */
@@ -446,6 +554,21 @@ declare namespace sap {
          */
         fFrameRate: number
       ): sap.ndc.BarcodeScannerButton;
+      /**
+       * Sets a new value for property {@link #getKeepCameraScan keepCameraScan}.
+       *
+       * If set to true, the camera should be used for scanning in Zebra Enterprise Browser.
+       *
+       * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+       *
+       * Default value is `false`.
+       */
+      setKeepCameraScan(
+        /**
+         * New value for property `keepCameraScan`
+         */
+        bKeepCameraScan?: boolean
+      ): sap.ndc.BarcodeScannerButton;
       /**
        * Sets a new value for property {@link #getPreferFrontCamera preferFrontCamera}.
        *
@@ -465,7 +588,7 @@ declare namespace sap {
        * Sets a new value for property {@link #getProvideFallback provideFallback}.
        *
        * If set to true, the button remains visible if the scanner is not available and triggers a dialog to enter
-       * bar code.
+       * barcode.
        *
        * When called with a value of `null` or `undefined`, the default value of the property will be restored.
        *
@@ -480,7 +603,7 @@ declare namespace sap {
       /**
        * Sets a new value for property {@link #getVisible visible}.
        *
-       * The invisible bar code scanner button is not rendered regardless of the availability of the native scan
+       * The invisible barcode scanner button is not rendered regardless of the availability of the native scan
        * feature.
        *
        * When called with a value of `null` or `undefined`, the default value of the property will be restored.

package/types/sap.ovp.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.84.11
+// For Library Version: 1.84.12
 
 declare namespace sap {
   /**

package/types/sap.suite.ui.commons.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.84.14
+// For Library Version: 1.84.17
 
 declare namespace sap {
   namespace suite {

package/types/sap.suite.ui.generic.template.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.84.23
+// For Library Version: 1.84.26
 
 declare namespace sap {
   namespace suite {

package/types/sap.suite.ui.microchart.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.84.28
+// For Library Version: 1.84.32
 
 declare namespace sap {
   namespace suite {

package/types/sap.tnt.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.84.28
+// For Library Version: 1.84.32
 
 declare namespace sap {
   /**

package/types/sap.ui.codeeditor.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.84.28
+// For Library Version: 1.84.32
 
 declare namespace sap {
   namespace ui {

package/types/sap.ui.commons.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.84.28
+// For Library Version: 1.84.32
 
 declare namespace sap {
   namespace ui {

package/types/sap.ui.comp.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.84.28
+// For Library Version: 1.84.32
 
 declare namespace sap {
   namespace ui {
@@ -25192,6 +25192,7 @@ declare namespace sap {
 
           /**
            * @SINCE 1.24
+           * @deprecated (since 1.84.1)
            *
            * Defines the maximum number of include ranges.
            */
@@ -25199,6 +25200,7 @@ declare namespace sap {
 
           /**
            * @SINCE 1.24
+           * @deprecated (since 1.84.1)
            *
            * Defines the maximum number of exclude ranges.
            */
@@ -25715,6 +25717,7 @@ declare namespace sap {
           getKeys(): string[];
           /**
            * @SINCE 1.24
+           * @deprecated (since 1.84.1)
            *
            * Gets current value of property {@link #getMaxExcludeRanges maxExcludeRanges}.
            *
@@ -25725,6 +25728,7 @@ declare namespace sap {
           getMaxExcludeRanges(): string;
           /**
            * @SINCE 1.24
+           * @deprecated (since 1.84.1)
            *
            * Gets current value of property {@link #getMaxIncludeRanges maxIncludeRanges}.
            *
@@ -25937,6 +25941,7 @@ declare namespace sap {
           ): sap.ui.comp.valuehelpdialog.ValueHelpDialog;
           /**
            * @SINCE 1.24
+           * @deprecated (since 1.84.1)
            *
            * Sets a new value for property {@link #getMaxExcludeRanges maxExcludeRanges}.
            *
@@ -25954,6 +25959,7 @@ declare namespace sap {
           ): sap.ui.comp.valuehelpdialog.ValueHelpDialog;
           /**
            * @SINCE 1.24
+           * @deprecated (since 1.84.1)
            *
            * Sets a new value for property {@link #getMaxIncludeRanges maxIncludeRanges}.
            *

package/types/sap.ui.core.d.ts

@@ -18,7 +18,7 @@ declare module "sap/base/util/Version";
 declare module "sap/ui/performance/Measurement.Entry";
 
 declare module "sap/ui/util/Storage.Type";
-// For Library Version: 1.84.28
+// For Library Version: 1.84.32
 /**
  * Root namespace for JavaScript functionality provided by SAP SE.
  *
@@ -8285,6 +8285,11 @@ declare namespace sap {
              * Object which defines the format options
              */
             oFormatOptions?: {
+              /**
+               * @since 1.84.31 specifies the calendar week numbering. Note: This API has been introduced with version
+               * 1.108 and downported to this release with patch level 31.
+               */
+              calendarWeekNumbering?: sap.ui.core.date.CalendarWeekNumbering;
               /**
                * @since 1.34.0 contains pattern symbols (e.g. "yMMMd" or "Hms") which will be converted into the pattern
                * in the used locale, which matches the wanted symbols best. The symbols must be in canonical order, that
@@ -8361,6 +8366,11 @@ declare namespace sap {
              * Object which defines the format options
              */
             oFormatOptions?: {
+              /**
+               * @since 1.84.31 specifies the calendar week numbering. Note: This API has been introduced with version
+               * 1.108 and downported to this release with patch level 31.
+               */
+              calendarWeekNumbering?: sap.ui.core.date.CalendarWeekNumbering;
               /**
                * @since 1.34.0 contains pattern symbols (e.g. "yMMMd" or "Hms") which will be converted into the pattern
                * in the used locale, which matches the wanted symbols best. The symbols must be in canonical order, that
@@ -8440,6 +8450,11 @@ declare namespace sap {
              * Object which defines the format options
              */
             oFormatOptions?: {
+              /**
+               * @since 1.84.31 specifies the calendar week numbering. Note: This API has been introduced with version
+               * 1.108 and downported to this release with patch level 31.
+               */
+              calendarWeekNumbering?: sap.ui.core.date.CalendarWeekNumbering;
               /**
                * @since 1.34.0 contains pattern symbols (e.g. "yMMMd" or "Hms") which will be converted into the pattern
                * in the used locale, which matches the wanted symbols best. The symbols must be in canonical order, that
@@ -12331,6 +12346,44 @@ declare namespace sap {
         }
       }
 
+      namespace date {
+        /**
+         * @SINCE 1.84.31
+         *
+         * The `CalendarWeekNumbering` enum defines how to calculate calendar weeks. Each value defines:
+         * 	 - The first day of the week,
+         * 	 - the first week of the year.
+         *
+         * Note: This API has been introduced with version 1.108 and downported to this release with patch level
+         * 31.
+         */
+        enum CalendarWeekNumbering {
+          /**
+           * The default calendar week numbering:
+           *
+           * The framework determines the week numbering scheme; currently it is derived from the active format locale.
+           * Future versions of UI5 might select a different week numbering scheme.
+           */
+          Default,
+          /**
+           * Official calendar week numbering in most of Europe (ISO 8601 standard):
+           * 	Monday is first day of the week, the week containing January 4th is first week of the year.
+           */
+          ISO_8601,
+          /**
+           * Official calendar week numbering in much of the Middle East (Middle Eastern calendar):
+           * 	Saturday is first day of the week, the week containing January 1st is first week of the year.
+           */
+          MiddleEastern,
+          /**
+           * Official calendar week numbering in the United States, Canada, Brazil, Israel, Japan, and other countries
+           * (Western traditional calendar):
+           * 	Sunday is first day of the week, the week containing January 1st is first week of the year.
+           */
+          WesternTraditional,
+        }
+      }
+
       namespace hyphenation {
         /**
          * @SINCE 1.60
@@ -18943,8 +18996,6 @@ declare namespace sap {
 
       interface URI {}
 
-      interface date {}
-
       interface postmessage {}
 
       interface service {}

package/types/sap.ui.dt.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.84.28
+// For Library Version: 1.84.32
 
 declare namespace sap {
   interface IUI5DefineDependencyNames {}

package/types/sap.ui.export.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.84.28
+// For Library Version: 1.84.32
 
 declare namespace sap {
 
@@ -75,7 +75,7 @@ class Spreadsheet{
  * 	 - `workbook.context` - Context object that will be applied to the generated file. It may contain the
  * 			following fields:  
  * 	 - `application` (string) - The application that creates the XLSX document (default: "SAP UI5") 
- * 	 - `version` (string) - Application version that creates the XLSX document (default: "1.84.28") 
+ * 	 - `version` (string) - Application version that creates the XLSX document (default: "1.84.32") 
  * 	 - `title` (string) - Title of the XLSX document (NOT the filename) 
  * 	 - `modifiedBy` (string) - User context for the XLSX document 
  * 	 - `sheetName` (string) - The label of the data sheet 
@@ -161,7 +161,7 @@ class Spreadsheet{
  *       columns: aColumns,
  *       context: {
  *         application: 'Debug Test Application',
- *         version: '1.84.28',
+ *         version: '1.84.32',
  *         title: 'Some random title',
  *         modifiedBy: 'John Doe',
  *         metaSheetName: 'Custom metadata',

package/types/sap.ui.fl.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.84.28
+// For Library Version: 1.84.32
 
 declare namespace sap {
   namespace ui {}

package/types/sap.ui.integration.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.84.28
+// For Library Version: 1.84.32
 
 declare namespace sap {
   namespace ui {

package/types/sap.ui.layout.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.84.28
+// For Library Version: 1.84.32
 
 declare namespace sap {
   namespace ui {

package/types/sap.ui.mdc.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.84.28
+// For Library Version: 1.84.32
 
 declare namespace sap {
   namespace ui {}

package/types/sap.ui.richtexteditor.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.84.28
+// For Library Version: 1.84.32
 
 declare namespace sap {
   namespace ui {

package/types/sap.ui.rta.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.84.28
+// For Library Version: 1.84.32
 
 declare namespace sap {
   namespace ui {

package/types/sap.ui.suite.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.84.28
+// For Library Version: 1.84.32
 
 declare namespace sap {
   namespace ui {

package/types/sap.ui.support.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.84.28
+// For Library Version: 1.84.32
 
 declare namespace sap {
   namespace ui {
@@ -237,7 +237,7 @@ declare namespace sap {
         static getType(): string;
       }
       /**
-       * @SINCE 1.84.28
+       * @SINCE 1.84.32
        *
        * Defines the Audiences.
        */
@@ -256,7 +256,7 @@ declare namespace sap {
         Internal,
       }
       /**
-       * @SINCE 1.84.28
+       * @SINCE 1.84.32
        *
        * Issue Categories.
        */
@@ -311,7 +311,7 @@ declare namespace sap {
         Usage,
       }
       /**
-       * @SINCE 1.84.28
+       * @SINCE 1.84.32
        *
        * Analysis history formats.
        */
@@ -326,7 +326,7 @@ declare namespace sap {
         String,
       }
       /**
-       * @SINCE 1.84.28
+       * @SINCE 1.84.32
        *
        * Defines severity types.
        */
@@ -345,7 +345,7 @@ declare namespace sap {
         Medium,
       }
       /**
-       * @SINCE 1.84.28
+       * @SINCE 1.84.32
        *
        * Contains the available system presets.
        */

package/types/sap.ui.table.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.84.28
+// For Library Version: 1.84.32
 
 declare namespace sap {
   namespace ui {