Variable ScanbotBarcodeConst

Type declaration

• forceCloseScanner:function

  • forceCloseScanner(): Promise<void>

  • Forces the Ready-To-Use UI Barcode scanner to close if it is currently open.

    Returns Promise<void>

• parseDocument:function

  • parseDocument(params): Promise<BarcodeDocumentParserResult>

  • Parses a barcode document from the given raw text content with the specified accepted formats.

    Parameters

    • params: {
          acceptedFormats?: BarcodeDocumentFormat[];
          rawText: string;
      }

      • Optional acceptedFormats?: BarcodeDocumentFormat[]

        The list of accepted barcode document formats to be parsed. If not provided, all supported formats will be parsed.

      • rawText: string

        The raw text content representing the document to be parsed.

    Returns Promise<BarcodeDocumentParserResult>

    • The result of the Barcode document parsing operation.

• scanFromImage:function

  • scanFromImage(params): Promise<BarcodeScannerResult>

  • Scans Barcode from a given image with the desired configuration.

    Parameters

    • params: {
          configuration: BarcodeScannerConfiguration;
          image: ImageInput;
      }

      • configuration: BarcodeScannerConfiguration

        The Barcode scanner configuration to be used for scanning.

      • image: ImageInput

        The image to be used for scanning.

    Returns Promise<BarcodeScannerResult>

    • The result of the Barcode scanning operation.

• scanFromPdf:function

  • scanFromPdf(params): Promise<BarcodeScannerResult>

  • Scans Barcode from a given PDF document with the desired configuration.

    Parameters

    • params: {
          configuration: BarcodeScannerConfiguration;
          pdfFileUri: string;
      }

      • configuration: BarcodeScannerConfiguration

        The Barcode scanner configuration to be used for scanning.

      • pdfFileUri: string

        The PDF file uri to be used for scanning.

    Returns Promise<BarcodeScannerResult>

    • The result of the Barcode scanning operation.

• startScanner:function

  • startScanner(configuration): Promise<ResultWrapper<BarcodeScannerUiResult>>

  • Opens the Ready-To-Use UI screen for scanning barcodes with the desired configuration.

    Parameters

    • configuration: BarcodeScannerScreenConfiguration

      The Barcode scanner configuration to be used for scanning.

    Returns Promise<ResultWrapper<BarcodeScannerUiResult>>

    • The result of the Barcode scanning operation.