capacitor-plugin-scanbot-sdk/dist/esm/Check.d.ts

Scanbot Document and Barcode Scanner SDK for Capacitor

import type { ImageInput, ResultWrapper } from './types/base/customTypes';
import type { CheckScannerConfiguration, CheckScanningResult } from './types/core/check/CheckScannerTypes';
import type { CheckScannerScreenConfiguration } from './types/core/ui_v2/check/CheckScannerScreenConfiguration';
import type { CheckScannerUiResult } from './types/core/ui_v2/check/CheckScannerUiResult';
/**
 * Entry point for all Check scanning features.
 */
export declare const ScanbotCheck: {
    /**
     * Opens the Ready-To-Use UI Check scanner with the desired configuration.
     * @param {CheckScannerScreenConfiguration} configuration - The Check scanner configuration to be used for scanning.
     * @returns {Promise<ResultWrapper<CheckScannerUiResult>>} - The result of the Check scanning operation.
     */
    startScanner(configuration: CheckScannerScreenConfiguration): Promise<ResultWrapper<CheckScannerUiResult>>;
    /**
     * Scans Check from a given image with the desired configuration.
     * @param {ImageInput} params.image - The image to be used for scanning.
     * @param {CheckScannerConfiguration} params.configuration - The Check scanner configuration to be used for scanning.
     * @returns {Promise<CheckScanningResult>} - The result of the Check scanning operation.
     */
    scanFromImage(params: {
        image: ImageInput;
        configuration: CheckScannerConfiguration;
    }): Promise<CheckScanningResult>;
};