Interface IScannedDocument

Namespace

ScanbotSDK.MAUI.Document

Assembly

DocumentSDK.MAUI.dll

public interface IScannedDocument

Properties

CreationTimestamp

long CreationTimestamp { get; }

Property Value

long

DocumentImageSizeLimit

int DocumentImageSizeLimit { get; set; }

Property Value

int

this[int]

Result<IScannedDocument.IPage> this[int index] { get; }

Parameters

index int

Property Value

Result<IScannedDocument.IPage>

this[string]

Result<IScannedDocument.IPage> this[string pageUuid] { get; }

Parameters

pageUuid string

Property Value

Result<IScannedDocument.IPage>

PageCount

int PageCount { get; }

Property Value

int

Pages

IEnumerable<IScannedDocument.IPage> Pages { get; }

Property Value

IEnumerable<IScannedDocument.IPage>

PdfUri

Uri PdfUri { get; }

Property Value

Uri

TiffUri

Uri TiffUri { get; }

Property Value

Uri

Uuid

string Uuid { get; }

Property Value

string

Methods

AddPagesAsync(IEnumerable<ImageSource>, AddPageOptions)

Task<Result<IEnumerable<IScannedDocument.IPage>>> AddPagesAsync(IEnumerable<ImageSource> images, AddPageOptions options = null)

Parameters

images IEnumerable<ImageSource>

options AddPageOptions

Returns

Task<Result<IEnumerable<IScannedDocument.IPage>>>

AddPagesAsync(IEnumerable<ImageRef>, AddPageOptions)

Task<Result<IEnumerable<IScannedDocument.IPage>>> AddPagesAsync(IEnumerable<ImageRef> images, AddPageOptions options = null)

Parameters

images IEnumerable<ImageRef>

options AddPageOptions

Returns

Task<Result<IEnumerable<IScannedDocument.IPage>>>

CloneDocument()

Result<IScannedDocument> CloneDocument()

Returns

Result<IScannedDocument>

CreatePdfAsync(PdfConfiguration, OcrConfiguration)

Task<Result<Uri>> CreatePdfAsync(PdfConfiguration pdfConfiguration, OcrConfiguration ocrConfiguration = null)

Parameters

pdfConfiguration PdfConfiguration

ocrConfiguration OcrConfiguration

Returns

Task<Result<Uri>>

CreateTiffAsync(TiffGeneratorParameters)

Task<Result<Uri>> CreateTiffAsync(TiffGeneratorParameters tiffGeneratorParameters)

Parameters

tiffGeneratorParameters TiffGeneratorParameters

Returns

Task<Result<Uri>>

DeleteDocumentAsync()

Task<Result> DeleteDocumentAsync()

Returns

Task<Result>

MovePage(int, int)

Result MovePage(int fromIndex, int toIndex)

Parameters

fromIndex int

toIndex int

Returns

Result

RemoveAllPagesAsync()

Task<Result<IScannedDocument>> RemoveAllPagesAsync()

Returns

Task<Result<IScannedDocument>>

RemovePageAsync(IPage)

Task<Result<IScannedDocument>> RemovePageAsync(IScannedDocument.IPage page)

Parameters

page IScannedDocument.IPage

Returns

Task<Result<IScannedDocument>>

RemovePagesAsync(IEnumerable<string>)

Task<Result<IScannedDocument>> RemovePagesAsync(IEnumerable<string> pageUuids)

Parameters

pageUuids IEnumerable<string>

Returns

Task<Result<IScannedDocument>>