capacitor-plugin-scanbot-sdk
Version:
Scanbot Document and Barcode Scanner SDK for Capacitor
33 lines (32 loc) • 2.15 kB
TypeScript
import type { ImageInput, ResultWrapper } from './types/base/customTypes';
import type { DocumentDataExtractionResult, DocumentDataExtractorConfiguration, DocumentVerificationReport } from './types/core/document_data/DocumentDataExtractorTypes';
import type { GenericDocument } from './types/core/generic_document/GenericDocument';
import type { DocumentDataExtractorScreenConfiguration } from './types/core/ui_v2/document_data/DocumentDataExtractorScreenConfiguration';
import type { DocumentDataExtractorUiResult } from './types/core/ui_v2/document_data/DocumentDataExtractorUiResult';
/**
* Entry point for all Document Data Extractor features.
*/
export declare const ScanbotDocumentDataExtractor: {
/**
* Opens the Ready-To-Use UI Document Data Extractor screen with the desired configuration.
* @param {DocumentDataExtractorScreenConfiguration} configuration - The Document Data Extractor configuration to be used for extracting.
* @returns {Promise<ResultWrapper<DocumentDataExtractorUiResult>>} - The result of the Document Data Extractor operation.
*/
startExtractorScreen(configuration: DocumentDataExtractorScreenConfiguration): Promise<ResultWrapper<DocumentDataExtractorUiResult>>;
/**
* Extracts data from a given image with the desired configuration.
* @param {ImageInput} params.image - The image to be used for extracting.
* @param {DocumentDataExtractorConfiguration} params.configuration - The Document Data Extractor configuration to be used for extracting.
* @returns {Promise<DocumentDataExtractionResult>} - The result of the Document Data Extractor operation.
*/
extractFromImage(params: {
image: ImageInput;
configuration: DocumentDataExtractorConfiguration;
}): Promise<DocumentDataExtractionResult>;
/**
* Verifies document parts.
* @param {GenericDocument[]} documentParts - The document parts to be used for verifying.
* @returns {Promise<DocumentVerificationReport>} - The result of the Document Verification operation.
*/
verifyDocument(documentParts: GenericDocument[]): Promise<DocumentVerificationReport>;
};