Interface IScanbotOperations

Namespace

ScanbotSDK.MAUI

Assembly

DocumentSDK.MAUI.dll

public interface IScanbotOperations

Properties

Analytics

IScanbotAnalytics Analytics { get; }

Property Value

IScanbotAnalytics

DefaultOcrConfig

OcrConfig DefaultOcrConfig { get; }

Property Value

OcrConfig

IsEncryptionEnabled

bool IsEncryptionEnabled { get; }

Property Value

bool

IsLicenseValid

bool IsLicenseValid { get; }

Property Value

bool

LicenseInfo

LicenseInfo LicenseInfo { get; }

Property Value

LicenseInfo

Methods

ApplyImageFilterAsync(PlatformImage, ParametricFilter, ResultOptions)

[Obsolete("This method may be moved to ImageProcessor or a related extension class in the future")]
Task<PlatformImage> ApplyImageFilterAsync(PlatformImage image, ParametricFilter filter, ResultOptions resultOptions = null)

Parameters

image PlatformImage

filter ParametricFilter

resultOptions ResultOptions

Returns

Task<PlatformImage>

CleanUp()

Task CleanUp()

Returns

Task

ConfigureMockCamera(MockCameraConfiguration)

void ConfigureMockCamera(MockCameraConfiguration configuration)

Parameters

configuration MockCameraConfiguration

CreatePdfAsync(IEnumerable<FileImageSource>, bool, PdfConfiguration)

Task<Uri> CreatePdfAsync(IEnumerable<FileImageSource> sourceImages, bool sourceImagesEncrypted, PdfConfiguration configuration = null)

Parameters

sourceImages IEnumerable<FileImageSource>

sourceImagesEncrypted bool

configuration PdfConfiguration

Returns

Task<Uri>

CreateSandwichPdfAsync(IEnumerable<FileImageSource>, bool, PdfConfiguration, OcrConfig)

Task<Uri> CreateSandwichPdfAsync(IEnumerable<FileImageSource> sourceImages, bool sourceImagesEncrypted, PdfConfiguration pdfConfig = null, OcrConfig ocrConfig = null)

Parameters

sourceImages IEnumerable<FileImageSource>

sourceImagesEncrypted bool

pdfConfig PdfConfiguration

ocrConfig OcrConfig

Returns

Task<Uri>

CreateScannedPageAsync(PlatformImage)

[Obsolete("This makes use of the legacy page storage feature. Prefer to use the new ScannedDocument and ScannedPage classes and related APIs.")]
Task<IScannedPage> CreateScannedPageAsync(PlatformImage source)

Parameters

source PlatformImage

Returns

Task<IScannedPage>

DetectDocumentQualityAsync(PlatformImage, DocumentQualityAnalyzerConfiguration)

Task<DocumentQualityAnalyzerResult> DetectDocumentQualityAsync(PlatformImage image, DocumentQualityAnalyzerConfiguration configuration = null)

Parameters

image PlatformImage

configuration DocumentQualityAnalyzerConfiguration

Returns

Task<DocumentQualityAnalyzerResult>

GetAllPagesAsync()

[Obsolete("This makes use of the legacy page storage feature. Prefer to use the new ScannedDocument and ScannedPage classes and related APIs.")]
Task<IReadOnlyCollection<IScannedPage>> GetAllPagesAsync()

Returns

Task<IReadOnlyCollection<IScannedPage>>

ParseBarcodeDocument(string, BarcodeDocumentFormat[])

Task<GenericDocument> ParseBarcodeDocument(string barcodeText, BarcodeDocumentFormat[] documentFormats = null)

Parameters

barcodeText string

documentFormats BarcodeDocumentFormat[]

Returns

Task<GenericDocument>

PerformOcrAsync(IEnumerable<FileImageSource>, bool, OcrConfig)

Task<OcrResult> PerformOcrAsync(IEnumerable<FileImageSource> sourceImages, bool sourceImagesEncrypted, OcrConfig configuration = null)

Parameters

sourceImages IEnumerable<FileImageSource>

sourceImagesEncrypted bool

configuration OcrConfig

Returns

Task<OcrResult>

ReconstructPage(string, PointF[], ParametricFilter[], DocumentDetectionStatus)

[Obsolete("This makes use of the legacy page storage feature. Prefer to use the new ScannedDocument and ScannedPage classes and related APIs.")]
Task<IScannedPage> ReconstructPage(string id, PointF[] polygon, ParametricFilter[] filter, DocumentDetectionStatus status)

Parameters

id string

polygon PointF[]

filter ParametricFilter[]

status DocumentDetectionStatus

Returns

Task<IScannedPage>

RefreshImageUris(IEnumerable<IScannedPage>)

[Obsolete("This makes use of the legacy page storage feature. Prefer to use the new ScannedDocument and ScannedPage classes and related APIs.")]
Task<IReadOnlyCollection<IScannedPage>> RefreshImageUris(IEnumerable<IScannedPage> pages)

Parameters

pages IEnumerable<IScannedPage>

Returns

Task<IReadOnlyCollection<IScannedPage>>

ResizeImageAsync(ImageSource, int, ResultOptions)

[Obsolete("This method may be updated to use PlatformImage or moved to ImageProcessor in the future")]
Task<ImageSource> ResizeImageAsync(ImageSource image, int maxSize, ResultOptions resultOptions = null)

Parameters

image ImageSource

maxSize int

resultOptions ResultOptions

Returns

Task<ImageSource>

RotateImageAsync(ImageSource, double, ResultOptions)

[Obsolete("This method may be updated to use PlatformImage or moved to ImageProcessor in the future")]
Task<ImageSource> RotateImageAsync(ImageSource image, double degrees, ResultOptions resultOptions = null)

Parameters

image ImageSource

degrees double

resultOptions ResultOptions

Returns

Task<ImageSource>

WriteTiffAsync(IEnumerable<FileImageSource>, bool, TiffGeneratorParameters)

Task<Uri> WriteTiffAsync(IEnumerable<FileImageSource> sourceImages, bool sourceImagesEncrypted, TiffGeneratorParameters parameters = null)

Parameters

sourceImages IEnumerable<FileImageSource>

sourceImagesEncrypted bool

parameters TiffGeneratorParameters

Returns

Task<Uri>