capacitor-plugin-scanbot-sdk/dist/esm/ui_v2/barcode/FindAndPickScanningModeUseCase.d.ts

Scanbot Document and Barcode Scanner SDK for Capacitor

import { ArOverlayFindAndPickConfiguration } from '../../ui_v2/barcode/ArTrackingOverlayConfiguration';
import { ManualCountEditDialog, Sheet, SheetContent } from '../../ui_v2/barcode/MultipleScanningModeUseCase';
import { ScanbotAlertDialog } from '../../ui_v2/common/ScanbotAlertDialog';
import type { DeepPartial } from '../../utils/utils';
import { PartiallyConstructible } from '../../utils/utils';
/**
Configuration of the barcode to find and scan.
*/
export declare class ExpectedBarcode extends PartiallyConstructible {
    /**
      Value of the barcode to find. If not set, any barcode value will be accepted.
      */
    barcodeValue: string;
    /**
      Title of the barcode to find.
      */
    title: string | null;
    /**
      Image of the barcode to find.
      */
    image: string | null;
    /**
      Number of barcodes with given symbology/value required to scan.
      
      Default is 1
      */
    count: number;
    /** @param source {@displayType `DeepPartial<ExpectedBarcode>`} */
    constructor(source?: DeepPartial<ExpectedBarcode>);
}
export declare namespace ExpectedBarcode {
    /**
      Use this key to display the original barcode image.
      
      Default is "BARCODE_IMAGE"
      */
    const BARCODE_IMAGE_KEY = "BARCODE_IMAGE";
}
/**
Configuration of the Find and Pick barcode scanning mode.
*/
export declare class FindAndPickScanningMode extends PartiallyConstructible {
    readonly _type: 'FindAndPickScanningMode';
    /**
      Color of the selected barcode.
      
      Default is "?sbColorPositive"
      */
    scanningCompletedColor: string;
    /**
      Color of the partially scanned barcode.
      
      Default is "?sbColorWarning"
      */
    scanningPartiallyColor: string;
    /**
      Color of the not scanned barcode .
      
      Default is "?sbColorOutline"
      */
    scanningNotScannedColor: string;
    /**
      If the user is allowed to finish the scanning process without scanning all the expected barcodes.
      
      Default is false
      */
    allowPartialScan: boolean;
    /**
      List of barcodes that the user has to find and scan.
      */
    expectedBarcodes: ExpectedBarcode[];
    /**
      Time interval in milliseconds before a barcode is counted again. 0 = no delay. The default value is 1000.
      
      Default is 1000
      */
    countingRepeatDelay: number;
    /**
      Configuration of the preview mode for the barcodes required to be found and scanned.
      */
    sheet: Sheet;
    /**
      Configuration of the list of barcodes required to be found and scanned.
      */
    sheetContent: SheetContent;
    /**
      Configuration of the dialog to manually edit the barcode count.
      */
    manualCountEditDialog: ManualCountEditDialog;
    /**
      Configuration of the AR overlay.
      */
    arOverlay: ArOverlayFindAndPickConfiguration;
    /**
      If the partial scanned alert dialog is enabled.
      
      Default is true
      */
    partialScannedAlertDialogEnabled: boolean;
    /**
      Configuration of the partial scanned alert dialog.
      */
    partialScannedAlertDialog: ScanbotAlertDialog;
    /**
      If the confirmation alert dialog is enabled.
      
      Default is false
      */
    confirmationAlertDialogEnabled: boolean;
    /**
      Configuration of the confirmation alert dialog.
      */
    confirmationAlertDialog: ScanbotAlertDialog;
    /** @param source {@displayType `DeepPartial<FindAndPickScanningMode>`} */
    constructor(source?: DeepPartial<FindAndPickScanningMode>);
}