Variable ScanbotDocumentConst

Type declaration

• addPages:function

  • addPages(params): Promise<DocumentData>

  • Adds new pages from the provided images to the document with the specified Uuid.

    Parameters

    • params: {
          documentUuid: string;
          images: ImageInput[];
          options?: AddPageOptions;
      }

      • documentUuid: string

        The Uuid of the document to which pages will be added.

      • images: ImageInput[]

        The images to be added as new pages.

      • Optional options?: AddPageOptions

        The options to be used when adding pages.

    Returns Promise<DocumentData>

    • Updated document with added pages.

• analyzeQualityOnImage:function

  • analyzeQualityOnImage(params): Promise<DocumentQualityAnalyzerResult>

  • Analyzes the quality of the document on the provided image.

    Parameters

    • params: {
          configuration: DocumentQualityAnalyzerConfiguration;
          image: ImageInput;
      }

      • configuration: DocumentQualityAnalyzerConfiguration

        The configuration to be used for analysis.

      • image: ImageInput

        The image to be analyzed.

    Returns Promise<DocumentQualityAnalyzerResult>

    • Result of the quality analysis.

• cloneDocument:function

  • cloneDocument(documentUuid): Promise<DocumentData>

  • Clones the document with the specified Uuid.

    Parameters

    • documentUuid: string

      The Uuid of the document to be cloned.

    Returns Promise<DocumentData>

    • Cloned document.

• createDocumentFromImages:function

  • createDocumentFromImages(params): Promise<DocumentData>

  • Creates a document from the provided images with the specified options.

    Parameters

    • params: {
          images?: ImageInput[];
          options?: CreateDocumentOptions;
      }

      • Optional images?: ImageInput[]

        The images to be used for document creation.

      • Optional options?: CreateDocumentOptions

        The options to be used for document creation.

    Returns Promise<DocumentData>

    • Created document.

• createDocumentFromLegacyPages:function

  • createDocumentFromLegacyPages(params): Promise<DocumentData>

  • Creates a document from the provided legacy pages with the specified image size limit.

    Parameters

    • params: {
          documentImageSizeLimit?: number;
          pages: Page[];
      }

      • Optional documentImageSizeLimit?: number

        The maximum size of the longest edge of the document image. If the image exceeds this limit, it will be downscaled proportionally. Default is 0

      • pages: Page[]

        The legacy pages to be used for document creation. Legacy filters that are set on the pages will be ignored. Please switch to ParametricFilters instead.

    Returns Promise<DocumentData>

    • Created document.

    Deprecated

• createDocumentFromPdf:function

  • createDocumentFromPdf(params): Promise<DocumentData>

  • Creates a document from the provided PDF file with the specified options.

    Parameters

    • params: {
          options?: CreateDocumentOptions;
          pdfFileUri: string;
      }

      • Optional options?: CreateDocumentOptions

        The options to be used for document creation.

      • pdfFileUri: string

        The PDF file uri to be used for document creation.

    Returns Promise<DocumentData>

    • Created document.

• deleteAllDocuments:function

  • deleteAllDocuments(): Promise<void>

  • Deletes all stored documents.

    Returns Promise<void>

• deleteDocument:function

  • deleteDocument(documentUuid): Promise<void>

  • Deletes the document with the specified Uuid.

    Parameters

    • documentUuid: string

      The Uuid of the document to be deleted.

    Returns Promise<void>

• documentExists:function

  • documentExists(documentUuid): Promise<boolean>

  • Checks if a document with the specified Uuid exists.

    Parameters

    • documentUuid: string

      The Uuid of the document.

    Returns Promise<boolean>

    • True if the document exists, false otherwise.

• getStoredDocumentUuids:function

  • getStoredDocumentUuids(): Promise<string[]>

  • Retrieves the Uuids of all stored documents.

    Returns Promise<string[]>

    • List of stored document Uuids.

• loadDocument:function

  • loadDocument(documentUuid): Promise<DocumentData>

  • Loads the document with the specified Uuid.

    Parameters

    • documentUuid: string

      The Uuid of the document.

    Returns Promise<DocumentData>

    • Loaded document.

• modifyPage:function

  • modifyPage(params): Promise<DocumentData>

  • Modifies a page within the document using the specified options.

    Parameters

    • params: {
          documentUuid: string;
          options?: ModifyPageOptions;
          pageUuid: string;
      }

      • documentUuid: string

        The Uuid of the document containing the page to be modified.

      • Optional options?: ModifyPageOptions

        The options specifying the modifications to be made to the page.

      • pageUuid: string

        The Uuid of the page to be modified.

    Returns Promise<DocumentData>

    • Updated document with the modified page.

• movePage:function

  • movePage(params): Promise<DocumentData>

  • Moves a page within the document to a new position.

    Parameters

    • params: {
          documentUuid: string;
          fromIndex: number;
          toIndex: number;
      }

      • documentUuid: string

        The Uuid of the document containing the page to be moved.

      • fromIndex: number

        The index of the page to be moved.

      • toIndex: number

        The new index position for the page.

    Returns Promise<DocumentData>

    • Updated document with the page moved to the new position.

• removeAllPages:function

  • removeAllPages(documentUuid): Promise<DocumentData>

  • Removes all pages from the document with the specified Uuid.

    Parameters

    • documentUuid: string

      The Uuid of the document from which all pages will be removed.

    Returns Promise<DocumentData>

    • Updated document with all pages removed.

• removePages:function

  • removePages(params): Promise<DocumentData>

  • Removes pages with the specified Uuids from the document.

    Parameters

    • params: {
          documentUuid: string;
          pageUuids: string[];
      }

      • documentUuid: string

        The Uuid of the document from which pages will be removed.

      • pageUuids: string[]

        The Uuids of the pages to be removed.

    Returns Promise<DocumentData>

    • Updated document with the specified pages removed.

• scanFromImage:function

  • scanFromImage(params): Promise<DocumentScanningResult>

  • Scans a document from the provided image.

    Parameters

    • params: {
          configuration: DocumentScannerConfiguration;
          image: ImageInput;
      }

      • configuration: DocumentScannerConfiguration

        The configuration to be used for scanning.

      • image: ImageInput

        The image to be scanned.

    Returns Promise<DocumentScanningResult>

    • Result of the scanning process.

• startCroppingScreen:function

  • startCroppingScreen(configuration): Promise<ResultWrapper<DocumentData>>

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

    Parameters

    • configuration: CroppingConfiguration

      The configuration to be used for the cropping screen.

    Returns Promise<ResultWrapper<DocumentData>>

    • Updated document after cropping.

• startScanner:function

  • startScanner(configuration): Promise<ResultWrapper<DocumentData>>

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

    Parameters

    • configuration: DocumentScanningFlow

      The configuration to be used for the document scanner.

    Returns Promise<ResultWrapper<DocumentData>>

    • Scanned document.