Interface IScanbotDocument

Namespace

ScanbotSDK.MAUI.Document

Assembly

DocumentSDK.MAUI.dll

public interface IScanbotDocument : IScanbotCroppingScreen

Inherited Members

IScanbotCroppingScreen.StartCroppingScreenAsync(CroppingConfiguration)

Methods

AnalyzeQualityOnImageAsync(ImageSource, DocumentQualityAnalyzerConfiguration)

Task<Result<DocumentQualityAnalyzerResult>> AnalyzeQualityOnImageAsync(ImageSource image, DocumentQualityAnalyzerConfiguration configuration)

Parameters

image ImageSource

configuration DocumentQualityAnalyzerConfiguration

Returns

Task<Result<DocumentQualityAnalyzerResult>>

AnalyzeQualityOnImageAsync(ImageRef, DocumentQualityAnalyzerConfiguration)

Task<Result<DocumentQualityAnalyzerResult>> AnalyzeQualityOnImageAsync(ImageRef image, DocumentQualityAnalyzerConfiguration configuration)

Parameters

image ImageRef

configuration DocumentQualityAnalyzerConfiguration

Returns

Task<Result<DocumentQualityAnalyzerResult>>

CreateDocumentFromImagesAsync(IEnumerable<ImageSource>, CreateDocumentOptions)

Task<Result<IScannedDocument>> CreateDocumentFromImagesAsync(IEnumerable<ImageSource> images, CreateDocumentOptions options = null)

Parameters

images IEnumerable<ImageSource>

options CreateDocumentOptions

Returns

Task<Result<IScannedDocument>>

CreateDocumentFromImagesAsync(IEnumerable<ImageRef>, CreateDocumentOptions)

Task<Result<IScannedDocument>> CreateDocumentFromImagesAsync(IEnumerable<ImageRef> images, CreateDocumentOptions options = null)

Parameters

images IEnumerable<ImageRef>

options CreateDocumentOptions

Returns

Task<Result<IScannedDocument>>

CreateDocumentFromLegacyPagesAsync(IEnumerable<IScannedPage>, int)

Task<Result<IScannedDocument>> CreateDocumentFromLegacyPagesAsync(IEnumerable<IScannedPage> pages, int documentImageSizeLimit = 0)

Parameters

pages IEnumerable<IScannedPage>

documentImageSizeLimit int

Returns

Task<Result<IScannedDocument>>

CreateDocumentFromPdfAsync(string, CreateDocumentOptions)

Task<Result<IScannedDocument>> CreateDocumentFromPdfAsync(string pdfFileUri, CreateDocumentOptions options = null)

Parameters

pdfFileUri string

options CreateDocumentOptions

Returns

Task<Result<IScannedDocument>>

DeleteAllDocumentsAsync()

Task<Result> DeleteAllDocumentsAsync()

Returns

Task<Result>

DeleteDocumentAsync(string)

Task<Result> DeleteDocumentAsync(string documentUuid)

Parameters

documentUuid string

Returns

Task<Result>

DocumentExists(string)

Result<bool> DocumentExists(string documentUuid)

Parameters

documentUuid string

Returns

Result<bool>

ForceCloseScannerAsync()

Task ForceCloseScannerAsync()

Returns

Task

LoadDocument(string)

Result<IScannedDocument> LoadDocument(string documentUuid)

Parameters

documentUuid string

Returns

Result<IScannedDocument>

ScanFromImageAsync(ImageSource, DocumentScannerConfiguration)

Task<Result<DocumentScanningResult>> ScanFromImageAsync(ImageSource image, DocumentScannerConfiguration configuration)

Parameters

image ImageSource

configuration DocumentScannerConfiguration

Returns

Task<Result<DocumentScanningResult>>

ScanFromImageAsync(ImageRef, DocumentScannerConfiguration)

Task<Result<DocumentScanningResult>> ScanFromImageAsync(ImageRef image, DocumentScannerConfiguration configuration)

Parameters

image ImageRef

configuration DocumentScannerConfiguration

Returns

Task<Result<DocumentScanningResult>>

StartScannerAsync(DocumentScanningFlow)

Task<Result<IScannedDocument>> StartScannerAsync(DocumentScanningFlow configuration)

Parameters

configuration DocumentScanningFlow

Returns

Task<Result<IScannedDocument>>

StoredDocumentUuids()

Result<string[]> StoredDocumentUuids()

Returns

Result<string[]>