capacitor-plugin-scanbot-sdk
Version:
Scanbot Document and Barcode Scanner SDK for Capacitor
56 lines (55 loc) • 1.85 kB
TypeScript
import type { DocumentDetectionStatus } from '../document_scanner/DocumentScannerTypes';
import type { PageImageSource } from '../document_scanner/PageImageSource';
import type { DocumentQuality } from '../dqa/DocumentQualityAnalyzerTypes';
import { ParametricFilter } from '../image_filters/ParametricFilters';
import { ToJsonConfiguration } from '../utils/json/JsonSerializationTypes';
import type { DeepPartial, Point } from '../utils/utils';
import { PartiallyConstructible } from '../utils/utils';
/**
The result of the health insurance card recognition.
*/
export declare class PageData extends PartiallyConstructible {
/**
The unique identifier of the page.
*/
readonly uuid: string;
/**
The list of filters applied to the page.
*/
readonly filters: ParametricFilter[] | null;
/**
The polygon of the page.
*/
readonly polygon: Point[];
/**
The detection status of the page.
*/
readonly documentDetectionStatus: DocumentDetectionStatus | null;
/**
The quality score of the page.
*/
readonly documentQuality: DocumentQuality | null;
/**
The source of the page image.
*/
readonly source: PageImageSource | null;
/**
The URI of the original image.
*/
readonly originalImageURI: string;
/**
The URI of the document image.
*/
readonly documentImageURI: string | null;
/**
The URI of the unfiltered document image.
*/
readonly unfilteredDocumentImageURI: string | null;
/**
The URI of the document image preview.
*/
readonly documentImagePreviewURI: string | null;
/** @param source {@displayType `DeepPartial<PageData>`} */
constructor(source?: DeepPartial<PageData>);
serialize(config?: ToJsonConfiguration): DeepPartial<PageData>;
}