kmp-bundle-sdk/io.scanbot.sdk.kmp/ScanbotDocument

ScanbotDocument

Functions

abstract fun addPages(documentUuid: String, images: List<ImageRef>, options: AddPageOptions? = null): Result<DocumentData>

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

analyzeQualityOnImage

abstract fun analyzeQualityOnImage(image: ImageRef, configuration: DocumentQualityAnalyzerConfiguration): Result<DocumentQualityAnalyzerResult>

Analyzes the quality of the document on the provided image.

cloneDocument

abstract fun cloneDocument(documentUuid: String): Result<DocumentData>

Clones the document with the specified Uuid.

createDocumentFromImages

abstract fun createDocumentFromImages(images: List<ImageRef>?, options: CreateDocumentOptions? = null): Result<DocumentData>

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

deleteAllDocuments

abstract fun deleteAllDocuments(): Result<Unit>

Deletes all stored documents.

deleteDocument

abstract fun deleteDocument(documentUuid: String): Result<Unit>

Deletes the document with the specified Uuid.

documentExists

abstract fun documentExists(documentUuid: String): Result<Boolean>

Checks if a document with the specified Uuid exists.

getStoredDocumentUuids

abstract fun getStoredDocumentUuids(): Result<List<String>>

Retrieves the Uuids of all stored documents.

loadDocument

abstract fun loadDocument(documentUuid: String): Result<DocumentData>

Loads the document with the specified Uuid.

modifyPage

abstract fun modifyPage(documentUuid: String, pageUuid: String, options: ModifyPageOptions? = null): Result<DocumentData>

Modifies a page within the document using the specified options.

movePage

abstract fun movePage(documentUuid: String, fromIndex: Int, toIndex: Int): Result<DocumentData>

Moves a page within the document to a new position.

removeAllPages

abstract fun removeAllPages(documentUuid: String): Result<DocumentData>

Removes all pages from the document with the specified UUID.

removePages

abstract fun removePages(documentUuid: String, pageUuids: List<String>): Result<DocumentData>

Removes pages with the specified UUIDs from the document.

scanFromImage

abstract fun scanFromImage(image: ImageRef, configuration: DocumentScannerConfiguration): Result<DocumentScanningResult>

Scans a document from the provided image.

startCroppingScreen

abstract fun startCroppingScreen(configuration: CroppingConfiguration, onResult: (Result<DocumentData>) -> Unit, onCanceled: () -> Unit? = null)

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

startScanner

abstract fun startScanner(configuration: DocumentScanningFlow, onResult: (Result<DocumentData>) -> Unit, onCanceled: () -> Unit? = null)

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