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

Scanbot Document and Barcode Scanner SDK for Capacitor

import type { DocumentDataExtractionStatus } from '../../document_data_extractor/DocumentDataExtractorTypes';
import { GenericDocument } from '../../documents/GenericDocument';
import { ImageRef } from '../../imageRef/image';
import { ToJsonConfiguration } from '../../utils/json/JsonSerializationTypes';
import type { DeepPartial } from '../../utils/utils';
import { PartiallyConstructible } from '../../utils/utils';
/**
Configuration of the generic text scanner RTU UI result.
*/
export declare class DocumentDataExtractorUiResult extends PartiallyConstructible {
    /**
      The status of the generic text recognition step.
      */
    readonly recognitionStatus: DocumentDataExtractionStatus;
    /**
      Generic document containing text data. Not present, if status is FAIL.
      */
    readonly document: GenericDocument | null;
    /**
      Crop of the document if it was detected.
      */
    readonly croppedImage: ImageRef | null;
    /** @param source {@displayType `DeepPartial<DocumentDataExtractorUiResult>`} */
    constructor(source?: DeepPartial<DocumentDataExtractorUiResult>);
    serialize(config?: ToJsonConfiguration): Promise<DeepPartial<DocumentDataExtractorUiResult>>;
    private _released;
    release(): void;
    encodeImages(): Promise<void>;
}