capacitor-plugin-scanbot-sdk/dist/esm/ui_v2/dde/DocumentDataExtractorScreenConfiguration.d.ts

Scanbot Document and Barcode Scanner SDK for Capacitor

import { DocumentDataExtractorConfiguration } from '../../document_data_extractor/DocumentDataExtractorTypes';
import { ActionBarConfiguration } from '../../ui_v2/common/ActionBarConfiguration';
import { CameraConfiguration } from '../../ui_v2/common/CameraConfiguration';
import { CameraPermissionScreen } from '../../ui_v2/common/CameraPermission';
import { IconButton, Palette, Sound, Vibration } from '../../ui_v2/common/Common';
import { ScanCompletionOverlay } from '../../ui_v2/common/ScanCompletionOverlay';
import { ScanbotAlertDialog } from '../../ui_v2/common/ScanbotAlertDialog';
import { TopBarConfiguration } from '../../ui_v2/common/TopBarConfiguration';
import { UserGuidanceConfiguration } from '../../ui_v2/common/UserGuidanceConfiguration';
import { PermanentViewFinderConfiguration } from '../../ui_v2/common/ViewFinderConfiguration';
import { DocumentDataExtractionProgressConfiguration } from '../../ui_v2/dde/DocumentDataExtractionProgressConfiguration';
import { DocumentDataExtractorIntroScreenConfiguration } from '../../ui_v2/dde/DocumentDataExtractorIntroScreenConfiguration';
import { DocumentDataExtractorScreenTextLocalization } from '../../ui_v2/dde/DocumentDataExtractorScreenTextLocalization';
import { DocumentDataExtractorGuidanceConfiguration } from '../../ui_v2/dde/DocumentDataExtractorUserGuidance';
import type { DeepPartial } from '../../utils/utils';
import { PartiallyConstructible } from '../../utils/utils';
/**
Configuration of the screen for extracting data from ID documents.
*/
export declare class DocumentDataExtractorScreenConfiguration extends PartiallyConstructible {
    /**
      Version number of the configuration object.
      
      Default is "1.0"
      */
    readonly version: string;
    /**
      The configuration object should be applied for this screen.
      
      Default is "DocumentDataExtractor"
      */
    readonly screen: string;
    /**
      Configuration of the all strings for document data extractor screen.
      */
    localization: DocumentDataExtractorScreenTextLocalization;
    /**
      Define the screen's base color values from which other colors are derived.
      */
    palette: Palette;
    /**
      The background color of the document data extractor screen.
      
      Default is "?sbColorSurfaceLow"
      */
    backgroundColor: string;
    /**
      Configuration of the camera behavior.
      */
    cameraConfiguration: CameraConfiguration;
    /**
      Configuration of the dialog for requesting camera permissions.
      */
    cameraPermission: CameraPermissionScreen;
    /**
      Configuration of the top user guidance.
      */
    topUserGuidance: UserGuidanceConfiguration;
    /**
      Configuration of the extracting status.
      */
    scanStatusUserGuidance: DocumentDataExtractorGuidanceConfiguration;
    /**
      Configuration of the top bar on the document data extractor screen.
      */
    topBar: TopBarConfiguration;
    /**
      Configuration of the button in the top bar that opens the introduction screen.
      */
    topBarOpenIntroScreenButton: IconButton;
    /**
      Configuration of the introduction screen for the document data extractor screen.
      */
    introScreen: DocumentDataExtractorIntroScreenConfiguration;
    /**
      Configuration of the action bar.
      */
    actionBar: ActionBarConfiguration;
    /**
      Configuration of the view finder.
      */
    viewFinder: PermanentViewFinderConfiguration;
    /**
      Configuration of the scanner.
      */
    scannerConfiguration: DocumentDataExtractorConfiguration;
    /**
      Configuration of visualization of the scanning progress.
      */
    extractionProgress: DocumentDataExtractionProgressConfiguration;
    /**
      Timeout for the no document found state. If the no document found state is active longer than this value, the alert will be presented.
      
      Default is 5000
      */
    noDocumentFoundTimeout: number;
    /**
      Timeout for the accumulation state. If the accumulation state is active longer than this value, the alert will be presented.
      
      Default is 3000
      */
    accumulationTimeout: number;
    /**
      Configuration of the result overlay.
      */
    successOverlay: ScanCompletionOverlay;
    /**
      Configuration of the alert dialog that will be presented when no document is detected.
      */
    noDocumentDetectedAlertDialog: ScanbotAlertDialog;
    /**
      Configuration of the alert dialog that will be presented when the document is recognised but not presented in the list of enabled for scanning.
      */
    cantProcessDocumentAlertDialog: ScanbotAlertDialog;
    /**
      Configuration of the alert dialog that will be presented when document is not detected as one that is supported by the SDK.
      */
    unsupportedDocumentAlertDialog: ScanbotAlertDialog;
    /**
      Configuration of the alert dialog that will be presented when initial timeout for scanning document is overreached.
      */
    scanningTooLongAlertDialog: ScanbotAlertDialog;
    /**
      Configuration of the scan confirmation sound.
      */
    sound: Sound;
    /**
      Configuration of the vibration feedback.
      */
    vibration: Vibration;
    /**
      If enabled, the screen will not turn off while the document data extractor is active. (Android only).
      
      Default is true
      */
    keepScreenOn: boolean;
    /** @param source {@displayType `DeepPartial<DocumentDataExtractorScreenConfiguration>`} */
    constructor(source?: DeepPartial<DocumentDataExtractorScreenConfiguration>);
}