Namespace sap.ndc.BarcodeScannerModule: sap/ndc/BarcodeScanner

Closes the bar code 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 sap.ndc.BarcodeScanner.scan method.)

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.

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.

sap.ndc.BarcodeScanner.scan(fnSuccess, fnFail, fnLiveUpdate)

The bar code 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 user cancelled the scan. fnError is given the error, fnLiveUpdate is passed the new value entered in the dialog's input field. An example:

sap.ndc.BarcodeScanner.scan(
   function (mResult) {
      alert("We got a bar code\n" + 
            "Result: " + mResult.text + "\n" +
            "Format: " + mResult.format + "\n" +
            "Cancelled: " + mResult.cancelled);
   },
   function (Error) {
      alert("Scanning failed: " + Error);
   },
   function (mParams) {
      alert("Value entered: " + mParams.newValue);
   }
);