@sapui5/ts-types 1.101.1 → 1.103.0

package/types/sap.ndc.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.101.0
+// For Library Version: 1.103.0
 
 declare namespace sap {
   /**
@@ -11,20 +11,27 @@ declare namespace sap {
        * If set to true, the button remains visible if the scanner is not available and triggers a dialog to enter
        * bar code.
        */
-      provideFallback?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
+      provideFallback?:
+        | boolean
+        | sap.ui.base.ManagedObject.PropertyBindingInfo
+        | `{${string}}`;
 
       /**
        * The invisible bar code scanner button is not rendered regardless of the availability of the native scan
        * feature.
        */
-      visible?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
+      visible?:
+        | boolean
+        | sap.ui.base.ManagedObject.PropertyBindingInfo
+        | `{${string}}`;
 
       /**
        * Defines the width of the scanner button.
        */
       width?:
         | sap.ui.core.CSSSize
-        | sap.ui.base.ManagedObject.PropertyBindingInfo;
+        | sap.ui.base.ManagedObject.PropertyBindingInfo
+        | `{${string}}`;
 
       /**
        * Defines the bar code input dialog title. If unset, a predefined title will be used.
@@ -36,7 +43,24 @@ declare namespace sap {
        */
       preferFrontCamera?:
         | boolean
-        | sap.ui.base.ManagedObject.PropertyBindingInfo;
+        | sap.ui.base.ManagedObject.PropertyBindingInfo
+        | `{${string}}`;
+
+      /**
+       * Defines the frame rate of the camera.
+       */
+      frameRate?:
+        | float
+        | sap.ui.base.ManagedObject.PropertyBindingInfo
+        | `{${string}}`;
+
+      /**
+       * Defines the zoom of the camera. This parameter is not supported on iOS.
+       */
+      zoom?:
+        | float
+        | sap.ui.base.ManagedObject.PropertyBindingInfo
+        | `{${string}}`;
 
       /**
        * Event is fired when the scanning is finished or cancelled
@@ -80,6 +104,8 @@ declare namespace sap {
        * 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 A JSON model containing the 'available' property
        */
       getStatusModel(): sap.ui.model.json.JSONModel;
       /**
@@ -113,7 +139,9 @@ declare namespace sap {
        * 			alert("Value entered: " + mParams.newValue);
        * 		},
        * 		"Enter Product Bar Code",
-       * 		true
+       * 		true,
+       * 		30,
+       * 		1
        * 	);
        * });
        * ```
@@ -138,7 +166,15 @@ declare namespace sap {
         /**
          * Flag, which defines whether the front or back camera should be used.
          */
-        preferFrontCamera?: boolean
+        preferFrontCamera?: boolean,
+        /**
+         * Defines the frame rate of the camera.
+         */
+        frameRate?: float,
+        /**
+         * Defines the zoom of the camera. This parameter is not supported on iOS.
+         */
+        zoom?: float
       ): void;
     }
     const BarcodeScanner: BarcodeScanner;
@@ -185,6 +221,8 @@ declare namespace sap {
        * the information contained in `oClassInfo`.
        *
        * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
+       *
+       * @returns Created class / constructor function
        */
       static extend<T extends Record<string, unknown>>(
         /**
@@ -203,6 +241,8 @@ declare namespace sap {
       ): Function;
       /**
        * Returns a metadata object for class sap.ndc.BarcodeScannerButton.
+       *
+       * @returns Metadata object describing this class
        */
       static getMetadata(): sap.ui.core.ElementMetadata;
       /**
@@ -213,6 +253,8 @@ declare namespace sap {
        * otherwise it will be bound to this `sap.ndc.BarcodeScannerButton` itself.
        *
        * Event is fired when the text in the dialog's input field is changed.
+       *
+       * @returns Reference to `this` in order to allow method chaining
        */
       attachInputLiveUpdate(
         /**
@@ -237,6 +279,8 @@ declare namespace sap {
        * otherwise it will be bound to this `sap.ndc.BarcodeScannerButton` itself.
        *
        * Event is fired when the text in the dialog's input field is changed.
+       *
+       * @returns Reference to `this` in order to allow method chaining
        */
       attachInputLiveUpdate(
         /**
@@ -255,6 +299,8 @@ declare namespace sap {
        * otherwise it will be bound to this `sap.ndc.BarcodeScannerButton` itself.
        *
        * Event is fired when the native scanning process is failed.
+       *
+       * @returns Reference to `this` in order to allow method chaining
        */
       attachScanFail(
         /**
@@ -278,6 +324,8 @@ declare namespace sap {
        * otherwise it will be bound to this `sap.ndc.BarcodeScannerButton` itself.
        *
        * Event is fired when the native scanning process is failed.
+       *
+       * @returns Reference to `this` in order to allow method chaining
        */
       attachScanFail(
         /**
@@ -296,6 +344,8 @@ declare namespace sap {
        * otherwise it will be bound to this `sap.ndc.BarcodeScannerButton` itself.
        *
        * Event is fired when the scanning is finished or cancelled
+       *
+       * @returns Reference to `this` in order to allow method chaining
        */
       attachScanSuccess(
         /**
@@ -319,6 +369,8 @@ declare namespace sap {
        * otherwise it will be bound to this `sap.ndc.BarcodeScannerButton` itself.
        *
        * Event is fired when the scanning is finished or cancelled
+       *
+       * @returns Reference to `this` in order to allow method chaining
        */
       attachScanSuccess(
         /**
@@ -335,6 +387,8 @@ declare namespace sap {
        * this `sap.ndc.BarcodeScannerButton`.
        *
        * The passed function and listener object must match the ones used for event registration.
+       *
+       * @returns Reference to `this` in order to allow method chaining
        */
       detachInputLiveUpdate(
         /**
@@ -350,6 +404,8 @@ declare namespace sap {
        * Detaches event handler `fnFunction` from the {@link #event:scanFail scanFail} event of this `sap.ndc.BarcodeScannerButton`.
        *
        * The passed function and listener object must match the ones used for event registration.
+       *
+       * @returns Reference to `this` in order to allow method chaining
        */
       detachScanFail(
         /**
@@ -365,6 +421,8 @@ declare namespace sap {
        * Detaches event handler `fnFunction` from the {@link #event:scanSuccess scanSuccess} event of this `sap.ndc.BarcodeScannerButton`.
        *
        * The passed function and listener object must match the ones used for event registration.
+       *
+       * @returns Reference to `this` in order to allow method chaining
        */
       detachScanSuccess(
         /**
@@ -378,6 +436,8 @@ declare namespace sap {
       ): this;
       /**
        * Fires event {@link #event:inputLiveUpdate inputLiveUpdate} to attached listeners.
+       *
+       * @returns Reference to `this` in order to allow method chaining
        */
       fireInputLiveUpdate(
         /**
@@ -392,6 +452,8 @@ declare namespace sap {
       ): this;
       /**
        * Fires event {@link #event:scanFail scanFail} to attached listeners.
+       *
+       * @returns Reference to `this` in order to allow method chaining
        */
       fireScanFail(
         /**
@@ -401,6 +463,8 @@ declare namespace sap {
       ): this;
       /**
        * Fires event {@link #event:scanSuccess scanSuccess} to attached listeners.
+       *
+       * @returns Reference to `this` in order to allow method chaining
        */
       fireScanSuccess(
         /**
@@ -425,14 +489,26 @@ 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.
+       *
+       * @returns Value of property `dialogTitle`
        */
       getDialogTitle(): string;
+      /**
+       * Gets current value of property {@link #getFrameRate frameRate}.
+       *
+       * Defines the frame rate of the camera.
+       *
+       * @returns Value of property `frameRate`
+       */
+      getFrameRate(): float;
       /**
        * Gets current value of property {@link #getPreferFrontCamera preferFrontCamera}.
        *
        * If set to true, the front camera will be used to decode.
        *
        * Default value is `false`.
+       *
+       * @returns Value of property `preferFrontCamera`
        */
       getPreferFrontCamera(): boolean;
       /**
@@ -442,6 +518,8 @@ declare namespace sap {
        * bar code.
        *
        * Default value is `true`.
+       *
+       * @returns Value of property `provideFallback`
        */
       getProvideFallback(): boolean;
       /**
@@ -451,20 +529,34 @@ declare namespace sap {
        * feature.
        *
        * Default value is `true`.
+       *
+       * @returns Value of property `visible`
        */
       getVisible(): boolean;
       /**
        * Gets current value of property {@link #getWidth width}.
        *
        * Defines the width of the scanner button.
+       *
+       * @returns Value of property `width`
        */
       getWidth(): sap.ui.core.CSSSize;
+      /**
+       * Gets current value of property {@link #getZoom zoom}.
+       *
+       * Defines the zoom of the camera. This parameter is not supported on iOS.
+       *
+       * @returns Value of property `zoom`
+       */
+      getZoom(): float;
       /**
        * Sets a new value for property {@link #getDialogTitle dialogTitle}.
        *
        * Defines the bar code 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.
+       *
+       * @returns Reference to `this` in order to allow method chaining
        */
       setDialogTitle(
         /**
@@ -472,6 +564,21 @@ declare namespace sap {
          */
         sDialogTitle?: string
       ): this;
+      /**
+       * Sets a new value for property {@link #getFrameRate frameRate}.
+       *
+       * Defines the frame rate of the camera.
+       *
+       * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      setFrameRate(
+        /**
+         * New value for property `frameRate`
+         */
+        fFrameRate: float
+      ): this;
       /**
        * Sets a new value for property {@link #getPreferFrontCamera preferFrontCamera}.
        *
@@ -480,6 +587,8 @@ declare namespace sap {
        * When called with a value of `null` or `undefined`, the default value of the property will be restored.
        *
        * Default value is `false`.
+       *
+       * @returns Reference to `this` in order to allow method chaining
        */
       setPreferFrontCamera(
         /**
@@ -496,6 +605,8 @@ declare namespace sap {
        * When called with a value of `null` or `undefined`, the default value of the property will be restored.
        *
        * Default value is `true`.
+       *
+       * @returns Reference to `this` in order to allow method chaining
        */
       setProvideFallback(
         /**
@@ -512,6 +623,8 @@ declare namespace sap {
        * When called with a value of `null` or `undefined`, the default value of the property will be restored.
        *
        * Default value is `true`.
+       *
+       * @returns Reference to `this` in order to allow method chaining
        */
       setVisible(
         /**
@@ -525,6 +638,8 @@ declare namespace sap {
        * Defines the width of the scanner button.
        *
        * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+       *
+       * @returns Reference to `this` in order to allow method chaining
        */
       setWidth(
         /**
@@ -532,6 +647,21 @@ declare namespace sap {
          */
         sWidth?: sap.ui.core.CSSSize
       ): this;
+      /**
+       * Sets a new value for property {@link #getZoom zoom}.
+       *
+       * Defines the zoom of the camera. This parameter is not supported on iOS.
+       *
+       * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      setZoom(
+        /**
+         * New value for property `zoom`
+         */
+        fZoom: float
+      ): this;
     }
   }
 

package/types/sap.ovp.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.101.0
+// For Library Version: 1.103.0
 
 declare namespace sap {
   /**
@@ -17,6 +17,8 @@ declare namespace sap {
          * it with the information contained in `oClassInfo`.
          *
          * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.mvc.ControllerExtension.extend}.
+         *
+         * @returns Created class / constructor function
          */
         extend(
           /**
@@ -35,6 +37,8 @@ declare namespace sap {
         ): Function;
         /**
          * Returns a metadata object for class sap.ovp.app.TemplateBaseExtension.
+         *
+         * @returns Metadata object describing this class
          */
         getMetadata(): sap.ui.base.Metadata;
       }