Variable ScanbotSDKConst

Type declaration

• Document: {
      addPage(params): Promise<DocumentData>;
      cloneDocument(params): Promise<DocumentData>;
      createDocument(params): Promise<DocumentData>;
      createDocumentFromLegacyPages(params): Promise<DocumentData>;
      createDocumentFromPDF(params): Promise<DocumentData>;
      createPDF(params): Promise<CreatePDFResult>;
      createTIFF(params): Promise<CreateTIFFResult>;
      deleteAllDocuments(): Promise<void>;
      deleteDocument(params): Promise<void>;
      documentExists(params): Promise<DocumentExistsResult>;
      loadDocument(params): Promise<DocumentData>;
      modifyPage(params): Promise<DocumentData>;
      movePage(params): Promise<DocumentData>;
      removeAllPages(params): Promise<DocumentData>;
      removePage(params): Promise<DocumentData>;
      storedDocumentIDs(): Promise<StoredDocumentIDsResult>;
  }

  • addPage:function

    • addPage(params): Promise<DocumentData>

    • Add a new page to a document and return the updated document.

      Parameters

      • params: AddPageParams

      Returns Promise<DocumentData>

  • cloneDocument:function

    • cloneDocument(params): Promise<DocumentData>

    • Clone a document by its ID.

      Parameters

      • params: {
            documentID: string;
        }

        • documentID: string

      Returns Promise<DocumentData>

  • createDocument:function

    • createDocument(params): Promise<DocumentData>

    • Create a new document.

      Parameters

      • params: CreateDocumentParams

      Returns Promise<DocumentData>

  • createDocumentFromLegacyPages:function

    • createDocumentFromLegacyPages(params): Promise<DocumentData>

    • Create a new document from legacy pages.

      Parameters

      • params: DocumentFromLegacyPagesParams

      Returns Promise<DocumentData>

  • createDocumentFromPDF:function

    • createDocumentFromPDF(params): Promise<DocumentData>

    • Create a new document from PDF file.

      Parameters

      • params: {
            pdfUri: string;
        }

        • pdfUri: string

      Returns Promise<DocumentData>

  • createPDF:function

    • createPDF(params): Promise<CreatePDFResult>

    • Creates a PDF for the given document. Please check the extra options that are part of the input params to modify the created PDF file per your needs.

      Parameters

      • params: PDFFromDocumentParams

      Returns Promise<CreatePDFResult>

  • createTIFF:function

    • createTIFF(params): Promise<CreateTIFFResult>

    • Creates a TIFF for the given document. Please check the extra options that are part of the input params to modify the created TIFF file per your needs.

      Parameters

      • params: TIFFFromDocumentParams

      Returns Promise<CreateTIFFResult>

  • deleteAllDocuments:function

    • deleteAllDocuments(): Promise<void>

    • Delete all documents.

      Returns Promise<void>

  • deleteDocument:function

    • deleteDocument(params): Promise<void>

    • Delete a document by its ID.

      Parameters

      • params: {
            documentID: string;
        }

        • documentID: string

      Returns Promise<void>

  • documentExists:function

    • documentExists(params): Promise<DocumentExistsResult>

    • Check if a document with the given ID exists.

      Parameters

      • params: {
            documentID: string;
        }

        • documentID: string

      Returns Promise<DocumentExistsResult>

  • loadDocument:function

    • loadDocument(params): Promise<DocumentData>

    • Load a document by its ID.

      Parameters

      • params: {
            documentID: string;
        }

        • documentID: string

      Returns Promise<DocumentData>

  • modifyPage:function

    • modifyPage(params): Promise<DocumentData>

    • Modify a page in a document and return the updated document.

      Parameters

      • params: ModifyPageParams

      Returns Promise<DocumentData>

  • movePage:function

    • movePage(params): Promise<DocumentData>

    • Move a page in a document and return the updated document.

      Parameters

      • params: MovePageParams

      Returns Promise<DocumentData>

  • removeAllPages:function

    • removeAllPages(params): Promise<DocumentData>

    • Remove all pages from a document in one batch operation.

      Parameters

      • params: {
            documentID: string;
        }

        • documentID: string

      Returns Promise<DocumentData>

  • removePage:function

    • removePage(params): Promise<DocumentData>

    • Remove a page from a document.

      Parameters

      • params: RemovePageParams

      Returns Promise<DocumentData>

  • storedDocumentIDs:function

    • storedDocumentIDs(): Promise<StoredDocumentIDsResult>

    • Gets all stored document IDs.

      Returns Promise<StoredDocumentIDsResult>

• applyImageFilters:function

  • applyImageFilters(params): Promise<ApplyImageFiltersResult>

  • Applies the given filters to the given image, and returns its URI.

    Parameters

    • params: {
          filters: ParametricFilter[];
          imageFileUri: string;
      }

      • filters: ParametricFilter[]

      • imageFileUri: string

    Returns Promise<ApplyImageFiltersResult>

• applyImageFiltersOnPage:function

  • applyImageFiltersOnPage(params): Promise<Page>

  • Applies the given filters to the given page.

    Parameters

    • params: {
          filters: ParametricFilter[];
          page: Page;
      }

      • filters: ParametricFilter[]

      • page: Page

    Returns Promise<Page>

• cleanup:function

  • cleanup(): Promise<void>

  • Removes all files generated by this plugin.

    Returns Promise<void>

• closeCheckScanner:function

  • closeCheckScanner(): Promise<void>

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

    Returns Promise<void>

• closeCroppingScreen:function

  • closeCroppingScreen(): Promise<void>

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

    Returns Promise<void>

    Deprecated

• closeDocumentDataExtractor:function

  • closeDocumentDataExtractor(): Promise<void>

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

    Returns Promise<void>

• closeDocumentScanner:function

  • closeDocumentScanner(): Promise<void>

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

    Returns Promise<void>

    Deprecated

• closeEHICScanner:function

  • closeEHICScanner(): Promise<void>

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

    Returns Promise<void>

    Deprecated

• closeFinderDocumentScanner:function

  • closeFinderDocumentScanner(): Promise<void>

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

    Returns Promise<void>

    Deprecated

• closeMedicalCertificateScanner:function

  • closeMedicalCertificateScanner(): Promise<void>

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

    Returns Promise<void>

• closeVinScanner:function

  • closeVinScanner(): Promise<void>

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

    Returns Promise<void>

• createPDF:function

  • createPDF(params): Promise<CreatePDFResult>

  • Creates a PDF using the given list of image file URIs. Please check the extra options that are part of the input params to modify the created PDF file per your needs.

    Parameters

    • params: CreatePDFArguments

    Returns Promise<CreatePDFResult>

• createPage:function

  • createPage(params): Promise<Page>

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

    Parameters

    • params: {
          imageUri: string;
      }

      • imageUri: string

    Returns Promise<Page>

• detectBarcodesOnImage:function

  • detectBarcodesOnImage(imageFileUri, configuration): Promise<BarcodeScannerResult>

  • Detects barcodes on the image represented by the file URI.

    Parameters

    • imageFileUri: string
    • configuration: BarcodeScannerConfiguration

    Returns Promise<BarcodeScannerResult>

• detectDocument:function

  • detectDocument(params): Promise<DetectDocumentResult>

  • Detects document on the given image and returns the result.

    Parameters

    • params: {
          imageFileUri: string;
      }

      • imageFileUri: string

    Returns Promise<DetectDocumentResult>

• detectDocumentOnPage:function

  • detectDocumentOnPage(params): Promise<Page>

  • Detects document on the given page and returns the result.

    Parameters

    • params: {
          page: Page;
      }

      • page: Page

    Returns Promise<Page>

• documentDataExtractor:function

  • documentDataExtractor(imageFileUri, configuration): Promise<DocumentDataExtractionResult>

  • Extract data on the given image. Set the expected document formats or leave it empty/undefined to recognize all supported document formats.

    Parameters

    • imageFileUri: string
    • configuration: DocumentDataExtractorConfiguration

    Returns Promise<DocumentDataExtractionResult>

• documentQualityAnalyzer:function

  • documentQualityAnalyzer(imageFileUri, configuration): Promise<DocumentQualityAnalyzerResult>

  • Detects the quality of the document on a still image.

    Parameters

    • imageFileUri: string
    • configuration: DocumentQualityAnalyzerConfiguration

    Returns Promise<DocumentQualityAnalyzerResult>

• extractImagesFromPdf:function

  • extractImagesFromPdf(params): Promise<ExtractImagesFromPdfResult>

  • Extracts images from a PDF represented by the file URL. The PDF file URL is part of the input params.

    Parameters

    • params: PdfExtractorArguments

    Returns Promise<ExtractImagesFromPdfResult>

• extractPagesFromPdf:function

  • extractPagesFromPdf(params): Promise<ExtractPagesFromPdfResult>

  • Extracts images from a PDF represented by the file URL, creates pages from them and returns the created pages. The PDF file URL is part of the input params.

    Parameters

    • params: PdfExtractorArguments

    Returns Promise<ExtractPagesFromPdfResult>

• getImageData:function

  • getImageData(params): Promise<ImageDataResult>

  • Returns the BASE64 Image Data for the given image.

    Parameters

    • params: {
          imageFileUri: string;
      }

      • imageFileUri: string

    Returns Promise<ImageDataResult>

• getLicenseInfo:function

  • getLicenseInfo(): Promise<LicenseInfoResult>

  • Provides complete information about the current license status.

    Returns Promise<LicenseInfoResult>

• getOCRConfigs:function

  • getOCRConfigs(): Promise<OCRConfigsResult>

  • Returns the available OCR configs.

    Returns Promise<OCRConfigsResult>

• initializeSDK:function

  • initializeSDK(config): Promise<LicenseInfoResult>

  • Initializes the Scanbot SDK with the preferred configuration.

    Parameters

    • config: ScanbotSdkConfiguration

    Returns Promise<LicenseInfoResult>

• performOCR:function

  • performOCR(params): Promise<PerformOCRResult>

  • Performs OCR on given images. Set preferred ocrConfiguration engine, or leave it undefined to use the default one which is OCRScanbotEngineConfiguration. If OCRTesseractConfiguration is used, the expected languages need to be set.

    Parameters

    • params: PerformOCRArguments

    Returns Promise<PerformOCRResult>

• recognizeCheck:function

  • recognizeCheck(imageFileUri, configuration, acceptedCheckStandards?): Promise<CheckScanningResult>

  • Recognizes a Check on the given image. Set desired check standards or leave it empty/undefined to recognize all supported checks.

    Parameters

    • imageFileUri: string
    • configuration: CheckScannerConfiguration
    • Optional acceptedCheckStandards: CheckDocumentModelRootType[]

    Returns Promise<CheckScanningResult>

• recognizeCreditCard:function

  • recognizeCreditCard(imageFileUri, configuration): Promise<CreditCardScanningResult>

  • Recognizes a Credit Card on the given image. Modify the result with extra options that are part of the configuration.

    Parameters

    • imageFileUri: string
    • configuration: CreditCardScannerConfiguration

    Returns Promise<CreditCardScanningResult>

• recognizeEHIC:function

  • recognizeEHIC(imageFileUri, configuration): Promise<EuropeanHealthInsuranceCardRecognitionResult>

  • Recognizes a European Health Insurance Card (EHIC) on the given image.

    Parameters

    • imageFileUri: string
    • configuration: EuropeanHealthInsuranceCardRecognizerConfiguration

    Returns Promise<EuropeanHealthInsuranceCardRecognitionResult>

    Deprecated

    Use documentDataExtractor instead and enable EuropeanHealthInsuranceCardConfiguration configuration element.

• recognizeMedicalCertificate:function

  • recognizeMedicalCertificate(imageFileUri, configuration): Promise<MedicalCertificateScanningResult>

  • Recognizes a Medical Certificate on the given image. Modify the result with extra options that are part of the input params.

    Parameters

    • imageFileUri: string
    • configuration: MedicalCertificateScanningParameters

    Returns Promise<MedicalCertificateScanningResult>

• recognizeMrz:function

  • recognizeMrz(imageFileUri, configuration): Promise<MrzScannerResult>

  • Recognizes an MRZ on the given image.

    Parameters

    • imageFileUri: string
    • configuration: MrzScannerConfiguration

    Returns Promise<MrzScannerResult>

• refreshImageUris:function

  • refreshImageUris(params): Promise<RefreshImageUrisResult>

  • Recreates the given pages to refresh the Image URIs.

    Parameters

    • params: {
          pages: Page[];
      }

      • pages: Page[]

    Returns Promise<RefreshImageUrisResult>

• removePage:function

  • removePage(params): Promise<void>

  • Removes the given page from the storage.

    Parameters

    • params: {
          page: Page;
      }

      • page: Page

    Returns Promise<void>

• rotateImage:function

  • rotateImage(params): Promise<RotateImageResult>

  • Rotates the given image by the specified degrees.

    Parameters

    • params: {
          degrees: number;
          imageFileUri: string;
      }

      • degrees: number

      • imageFileUri: string

    Returns Promise<RotateImageResult>

• rotatePage:function

  • rotatePage(params): Promise<Page>

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

    Parameters

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

      • page: Page

      • times: number

    Returns Promise<Page>

• setDocumentImage:function

  • setDocumentImage(params): Promise<Page>

  • Applies the given image to the desired page.

    Parameters

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

      • imageFileUri: string

      • page: Page

    Returns Promise<Page>

• startCheckScanner:function

  • startCheckScanner(configuration): Promise<ResultWrapper<CheckScanningResult>>

  • Opens the Ready-To-Use UI Check Scanner screen with the desired configuration.

    Parameters

    • configuration: CheckScannerScreenConfiguration

    Returns Promise<ResultWrapper<CheckScanningResult>>

• startCroppingScreen:function

  • startCroppingScreen(params): Promise<ResultWrapper<CroppingResult>>

  • Opens the Ready-To-Use UI Cropping screen with the desired configuration.

    Parameters

    • params: {
          configuration: CroppingConfiguration;
          page: Page;
      }

      • configuration: CroppingConfiguration

      • page: Page

    Returns Promise<ResultWrapper<CroppingResult>>

    Deprecated

    Use startCroppingScreen from 'capacitor-plugin-scanbot-sdk/ui_v2' instead.

• startDocumentDataExtractor:function

  • startDocumentDataExtractor(configuration): Promise<ResultWrapper<DocumentDataExtractionResult[]>>

  • Opens the Ready-To-Use UI Document Data Extractor screen with the desired configuration.

    Parameters

    • configuration: DocumentDataExtractorScreenConfiguration

    Returns Promise<ResultWrapper<DocumentDataExtractionResult[]>>

• startDocumentScanner:function

  • startDocumentScanner(configuration): Promise<ResultWrapperWithMetadata<DocumentScannerResult, DocumentScannerMetadata>>

  • Opens the Ready-To-Use UI Document Scanner screen with the desired configuration.

    Parameters

    • configuration: DocumentScannerScreenConfiguration

    Returns Promise<ResultWrapperWithMetadata<DocumentScannerResult, DocumentScannerMetadata>>

    Deprecated

    Use startDocumentScanner from 'capacitor-plugin-scanbot-sdk/ui_v2' instead.

• startEHICScanner:function

  • startEHICScanner(configuration): Promise<ResultWrapper<EuropeanHealthInsuranceCardRecognitionResult>>

  • Opens the Ready-To-Use UI European Health Insurance Card Scanner screen with the desired configuration.

    Parameters

    • configuration: HealthInsuranceCardScannerConfiguration

    Returns Promise<ResultWrapper<EuropeanHealthInsuranceCardRecognitionResult>>

    Deprecated

    Use startDocumentDataExtractor instead and enable DE_HEALTH_INSURANCE_CARD_FRONT and EU_HEALTH_INSURANCE_CARD document formats.

• startFinderDocumentScanner:function

  • startFinderDocumentScanner(configuration): Promise<ResultWrapper<DocumentScannerResult>>

  • Opens the Ready-To-Use UI Finder Document Scanner screen with the desired configuration.

    Parameters

    • configuration: FinderDocumentScannerConfiguration

    Returns Promise<ResultWrapper<DocumentScannerResult>>

    Deprecated

    Use startDocumentScanner from 'capacitor-plugin-scanbot-sdk/ui_v2' instead.

• startMedicalCertificateScanner:function

  • startMedicalCertificateScanner(configuration): Promise<ResultWrapper<MedicalCertificateScanningResult>>

  • Opens the Ready-To-Use UI Medical Certificate Scanner screen with the desired configuration.

    Parameters

    • configuration: MedicalCertificateScannerConfiguration

    Returns Promise<ResultWrapper<MedicalCertificateScanningResult>>

• startVinScanner:function

  • startVinScanner(configuration): Promise<ResultWrapper<VinScannerResult>>

  • Opens the Ready-To-Use UI VIN Scanner screen with the desired configuration.

    Parameters

    • configuration: VinScannerConfiguration

    Returns Promise<ResultWrapper<VinScannerResult>>

• writeTIFF:function

  • writeTIFF(params): Promise<WriteTIFFResult>

  • Creates a TIFF using the given list of image file URIs. Please check the extra options that are part of the input params to modify the created TIFF file per your needs.

    Parameters

    • params: WriteTIFFArguments

    Returns Promise<WriteTIFFResult>