capacitor-plugin-scanbot-sdk
Version:
Scanbot Document and Barcode Scanner SDK for Capacitor
30 lines (29 loc) • 1.31 kB
TypeScript
import type { CheckMagneticInkStripScanningStatus } from '../../check/CheckScannerTypes';
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 check scanner RTU UI result.
*/
export declare class CheckScannerUiResult extends PartiallyConstructible {
/**
The status of the check recognition step.
*/
readonly recognitionStatus: CheckMagneticInkStripScanningStatus;
/**
Crop of the check if documentDetectionMode is set to DETECT_AND_CROP_DOCUMENT. Will be non-empty, only if check recognition succeeded.
*/
readonly croppedImage: ImageRef | null;
/**
Generic document containing check data. Not present, if status is FAIL.
*/
readonly check: GenericDocument | null;
/** @param source {@displayType `DeepPartial<CheckScannerUiResult>`} */
constructor(source?: DeepPartial<CheckScannerUiResult>);
serialize(config?: ToJsonConfiguration): Promise<DeepPartial<CheckScannerUiResult>>;
private _released;
release(): void;
encodeImages(): Promise<void>;
}