Interface ScanbotSDKCapacitorPlugin

interface ScanbotSDKCapacitorPlugin {
    applyImageFilters(args): Promise<ResultWrapper<ApplyImageFiltersResult>>;
    applyImageFiltersOnPage(args): Promise<ResultWrapper<Page>>;
    cleanup(): Promise<ResultWrapper<void>>;
    closeBarcodeScanner(): Promise<void>;
    closeBatchBarcodeScanner(): Promise<void>;
    closeCheckRecognizer(): Promise<void>;
    closeCroppingScreen(): Promise<void>;
    closeDocumentScanner(): Promise<void>;
    closeEHICScanner(): Promise<void>;
    closeFinderDocumentScanner(): Promise<void>;
    closeGenericDocumentRecognizer(): Promise<void>;
    closeLicensePlateScanner(): Promise<void>;
    closeMedicalCertificateRecognizer(): Promise<void>;
    closeMrzScanner(): Promise<void>;
    closeTextDataScanner(): Promise<void>;
    closeVinScanner(): Promise<void>;
    createPDF(args): Promise<ResultWrapper<CreatePDFResult>>;
    createPage(args): Promise<ResultWrapper<Page>>;
    detectBarcodesOnImage(args): Promise<ResultWrapper<DetectBarcodesOnImageResult>>;
    detectDocument(args): Promise<ResultWrapper<DetectDocumentResult>>;
    detectDocumentOnPage(args): Promise<ResultWrapper<Page>>;
    documentQualityAnalyzer(args): Promise<ResultWrapper<DocumentQualityAnalyzerResult>>;
    extractImagesFromPdf(args): Promise<ResultWrapper<ExtractImagesFromPdfResult>>;
    extractPagesFromPdf(args): Promise<ResultWrapper<ExtractPagesFromPdfResult>>;
    getImageData(args): Promise<ResultWrapper<GetImageDataResult>>;
    getLicenseInfo(): Promise<ResultWrapper<GetLicenseInfoResult>>;
    getOCRConfigs(): Promise<ResultWrapper<GetOCRConfigsResult>>;
    initializeSDK(config): Promise<ResultWrapper<InitializeSDKResult>>;
    performOCR(args): Promise<ResultWrapper<PerformOCRResult>>;
    recognizeCheck(args): Promise<ResultWrapper<CheckRecognizerResult>>;
    recognizeEHIC(args): Promise<ResultWrapper<HealthInsuranceCardScannerResult>>;
    recognizeGenericDocument(args): Promise<ResultWrapper<RecognizeGenericDocumentResult>>;
    recognizeMedicalCertificate(args): Promise<ResultWrapper<MedicalCertificateScannerResult>>;
    recognizeMrz(args): Promise<ResultWrapper<RecognizeMRZResult>>;
    refreshImageUris(args): Promise<ResultWrapper<RefreshImageUrisResult>>;
    removePage(args): Promise<ResultWrapper<void>>;
    rotateImage(args): Promise<ResultWrapper<RotateImageResult>>;
    rotatePage(args): Promise<ResultWrapper<Page>>;
    setDocumentImage(args): Promise<ResultWrapper<Page>>;
    startBarcodeScanner(configuration): Promise<ResultWrapper<BarcodeScannerResult>>;
    startBatchBarcodeScanner(configuration): Promise<ResultWrapper<BarcodeScannerResult>>;
    startCheckRecognizer(configuration): Promise<ResultWrapper<CheckRecognizerResult>>;
    startCroppingScreen(args): Promise<ResultWrapper<CroppingResult>>;
    startDocumentScanner(configuration): Promise<ResultWrapperWithMetadata<DocumentScannerResult, DocumentScannerMetadata>>;
    startEHICScanner(configuration): Promise<ResultWrapper<HealthInsuranceCardScannerResult>>;
    startFinderDocumentScanner(configuration): Promise<ResultWrapper<DocumentScannerResult>>;
    startGenericDocumentRecognizer(configuration): Promise<ResultWrapper<GenericDocumentRecognizerResult>>;
    startLicensePlateScanner(configuration): Promise<ResultWrapper<LicensePlateScannerResult>>;
    startMedicalCertificateRecognizer(configuration): Promise<ResultWrapper<MedicalCertificateScannerResult>>;
    startMrzScanner(configuration): Promise<ResultWrapper<RecognizeMRZResult>>;
    startTextDataScanner(configuration): Promise<ResultWrapper<TextDataScannerResult>>;
    startVinScanner(configuration): Promise<ResultWrapper<VinScannerResult>>;
    writeTIFF(args): Promise<ResultWrapper<WriteTIFFResult>>;
}

Methods

applyImageFilters applyImageFiltersOnPage cleanup closeBarcodeScanner closeBatchBarcodeScanner closeCheckRecognizer closeCroppingScreen closeDocumentScanner closeEHICScanner closeFinderDocumentScanner closeGenericDocumentRecognizer closeLicensePlateScanner closeMedicalCertificateRecognizer closeMrzScanner closeTextDataScanner closeVinScanner createPDF createPage detectBarcodesOnImage detectDocument detectDocumentOnPage documentQualityAnalyzer extractImagesFromPdf extractPagesFromPdf getImageData getLicenseInfo getOCRConfigs initializeSDK performOCR recognizeCheck recognizeEHIC recognizeGenericDocument recognizeMedicalCertificate recognizeMrz refreshImageUris removePage rotateImage rotatePage setDocumentImage startBarcodeScanner startBatchBarcodeScanner startCheckRecognizer startCroppingScreen startDocumentScanner startEHICScanner startFinderDocumentScanner startGenericDocumentRecognizer startLicensePlateScanner startMedicalCertificateRecognizer startMrzScanner startTextDataScanner startVinScanner writeTIFF

Methods

applyImageFilters

applyImageFiltersOnPage

cleanup

closeBarcodeScanner

  • closeBarcodeScanner(): Promise<void>

  • Forces the Ready-To-Use UI Barcode Scanner screen to close while it is running.

    Returns Promise<void>

    Deprecated

closeBatchBarcodeScanner

  • closeBatchBarcodeScanner(): Promise<void>

  • Forces the Ready-To-Use UI Batch Barcode Scanner screen to close while it is running.

    Returns Promise<void>

    Deprecated

closeCheckRecognizer

  • closeCheckRecognizer(): Promise<void>

  • Forces the Ready-To-Use UI Check Recognizer screen to close while it is running.

    Returns Promise<void>

closeCroppingScreen

  • closeCroppingScreen(): Promise<void>

  • Forces the Ready-To-Use UI Cropping screen to close while it is running.

    Returns Promise<void>

closeDocumentScanner

  • closeDocumentScanner(): Promise<void>

  • Forces the Ready-To-Use UI Document Scanner screen to close while it is running.

    Returns Promise<void>

closeEHICScanner

  • closeEHICScanner(): Promise<void>

  • Forces the Ready-To-Use UI European Health Insurance Card Scanner screen to close while it is running.

    Returns Promise<void>

closeFinderDocumentScanner

  • closeFinderDocumentScanner(): Promise<void>

  • Forces the Ready-To-Use UI Finder Document Scanner screen to close while it is running.

    Returns Promise<void>

closeGenericDocumentRecognizer

  • closeGenericDocumentRecognizer(): Promise<void>

  • Forces the Ready-To-Use UI Generic Document Recognizer screen to close while it is running.

    Returns Promise<void>

closeLicensePlateScanner

  • closeLicensePlateScanner(): Promise<void>

  • Forces the Ready-To-Use UI License Plate Scanner screen to close while it is running.

    Returns Promise<void>

closeMedicalCertificateRecognizer

  • closeMedicalCertificateRecognizer(): Promise<void>

  • Forces the Ready-To-Use UI Medical Certificate Recognizer screen to close while it is running.

    Returns Promise<void>

closeMrzScanner

  • closeMrzScanner(): Promise<void>

  • Forces the Ready-To-Use UI MRZ Scanner screen to close while it is running.

    Returns Promise<void>

closeTextDataScanner

  • closeTextDataScanner(): Promise<void>

  • Forces the Ready-To-Use UI Text Data Scanner screen to close while it is running.

    Returns Promise<void>

closeVinScanner

  • closeVinScanner(): Promise<void>

  • Forces the Ready-To-Use UI VIN Scanner screen to close while it is running.

    Returns Promise<void>

createPDF

createPage

  • createPage(args): Promise<ResultWrapper<Page>>

  • Creates a page with the image located at the given URI.

    Parameters

    • args: {
          imageUri: string;
      }
      • imageUri: string

    Returns Promise<ResultWrapper<Page>>

detectBarcodesOnImage

detectDocument

detectDocumentOnPage

documentQualityAnalyzer

extractImagesFromPdf

extractPagesFromPdf

getImageData

getLicenseInfo

getOCRConfigs

initializeSDK

performOCR

recognizeCheck

recognizeEHIC

recognizeGenericDocument

recognizeMedicalCertificate

recognizeMrz

refreshImageUris

removePage

  • removePage(args): Promise<ResultWrapper<void>>

  • Removes the given page from the storage.

    Parameters

    Returns Promise<ResultWrapper<void>>

rotateImage

rotatePage

  • rotatePage(args): Promise<ResultWrapper<Page>>

  • Rotates the given page for the number of 90 degree clockwise rotations. Negative values will rotate counterclockwise.

    Parameters

    • args: {
          page: Page;
          times: number;
      }
      • page: Page
      • times: number

    Returns Promise<ResultWrapper<Page>>

setDocumentImage

  • setDocumentImage(args): Promise<ResultWrapper<Page>>

  • Applies the given image to the desired page.

    Parameters

    • args: {
          imageFileUri: string;
          page: Page;
      }
      • imageFileUri: string
      • page: Page

    Returns Promise<ResultWrapper<Page>>

startBarcodeScanner

startBatchBarcodeScanner

startCheckRecognizer

startCroppingScreen

startDocumentScanner

startEHICScanner

startFinderDocumentScanner

startGenericDocumentRecognizer

startLicensePlateScanner

startMedicalCertificateRecognizer

startMrzScanner

startTextDataScanner

startVinScanner

writeTIFF

Settings

Member Visibility

Theme

On This Page

applyImageFiltersapplyImageFiltersOnPagecleanupcloseBarcodeScannercloseBatchBarcodeScannercloseCheckRecognizercloseCroppingScreencloseDocumentScannercloseEHICScannercloseFinderDocumentScannercloseGenericDocumentRecognizercloseLicensePlateScannercloseMedicalCertificateRecognizercloseMrzScannercloseTextDataScannercloseVinScannercreatePDFcreatePagedetectBarcodesOnImagedetectDocumentdetectDocumentOnPagedocumentQualityAnalyzerextractImagesFromPdfextractPagesFromPdfgetImageDatagetLicenseInfogetOCRConfigsinitializeSDKperformOCRrecognizeCheckrecognizeEHICrecognizeGenericDocumentrecognizeMedicalCertificaterecognizeMrzrefreshImageUrisremovePagerotateImagerotatePagesetDocumentImagestartBarcodeScannerstartBatchBarcodeScannerstartCheckRecognizerstartCroppingScreenstartDocumentScannerstartEHICScannerstartFinderDocumentScannerstartGenericDocumentRecognizerstartLicensePlateScannerstartMedicalCertificateRecognizerstartMrzScannerstartTextDataScannerstartVinScannerwriteTIFF