Class ReadyToUseUi

Namespace

ScanbotSDK.MAUI.Droid

Assembly

DocumentSDK.MAUI.dll

public class ReadyToUseUi : IReadyToUseUIService, IBarcodeScanner, IDocumentScanner, ICheckRecognizer, ICroppingScreen, IMrzScanner, IEhicScanner, IGenericDocumentRecognizer, ITextDataScanner, IVinScanner, ILicensePlateScanner, IMedicalCertificateScanner

Inheritance

object

ReadyToUseUi

Implements

IReadyToUseUIService

IBarcodeScanner

IDocumentScanner

ICheckRecognizer

ICroppingScreen

IMrzScanner

IEhicScanner

IGenericDocumentRecognizer

ITextDataScanner

IVinScanner

ILicensePlateScanner

IMedicalCertificateScanner

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

CloseBarcodeScannerAsync()

Force Closes the Barcode scanning view.

public Task CloseBarcodeScannerAsync()

Returns

Task

CloseCheckRecognizerAsync()

Force closes the ready-to-use Check Recognizer UI

public Task CloseCheckRecognizerAsync()

Returns

Task

CloseCroppingScreenAsync()

Force closes the ready-to-use Cropping Screen UI.

public Task CloseCroppingScreenAsync()

Returns

Task

CloseDocumentScannerAsync()

Force closes the ready-to-use Document Scanner UI.

public Task CloseDocumentScannerAsync()

Returns

Task

CloseFinderDocumentScannerAsync()

Force closes the ready-to-use Finder Document Scanner UI.

public Task CloseFinderDocumentScannerAsync()

Returns

Task

CloseGenericDocumentRecognizerAsync()

Force closes the ready-to-use Generic Document Recognizer UI.

public Task CloseGenericDocumentRecognizerAsync()

Returns

Task

CloseHealthInsuranceCardScannerAsync()

Force closes the ready-to-use Health Insurance Card Scanner UI.

public Task CloseHealthInsuranceCardScannerAsync()

Returns

Task

CloseLicensePlateScannerAsync()

Force closes the ready-to-use License Plate Scanner UI.

public Task CloseLicensePlateScannerAsync()

Returns

Task

CloseMedicalCertificateScannerAsync()

Force closes the ready-to-use Medical Certificate Scanner UI.

public Task CloseMedicalCertificateScannerAsync()

Returns

Task

CloseMrzScannerAsync()

Force closes the ready-to-use MRZ Scanner UI.

public Task CloseMrzScannerAsync()

Returns

Task

CloseTextDataScannerAsync()

Force closes the ready-to-use Text Data Scanner UI.

public Task CloseTextDataScannerAsync()

Returns

Task

CloseVINScannerAsync()

Force closes the ready-to-use VIN Scanner UI.

public Task CloseVINScannerAsync()

Returns

Task

LaunchCheckRecognizerAsync(CheckRecognizerConfiguration)

Launches the ready-to-use Check Recognizer UI

public Task<CheckRecognizerResult> LaunchCheckRecognizerAsync(CheckRecognizerConfiguration configuration = null)

Parameters

configuration CheckRecognizerConfiguration

Returns

Task<CheckRecognizerResult>

A task returning the Check Recognizer result. The result will be null if the user cancels the scan.

LaunchCroppingScreenAsync(IScannedPage, CroppingScreenConfiguration)

Launches the ready-to-use Cropping Screen UI.

public Task<CroppingResult> LaunchCroppingScreenAsync(IScannedPage pageToCrop, CroppingScreenConfiguration configuration = null)

Parameters

pageToCrop IScannedPage

configuration CroppingScreenConfiguration

Returns

Task<CroppingResult>

A task returning the cropped page. The result will be null if the user cancels cropping.

LaunchDocumentScannerAsync(DocumentScannerConfiguration)

Launches the ready-to-use Document Scanner UI.

public Task<DocumentScannerResult> LaunchDocumentScannerAsync(DocumentScannerConfiguration configuration = null)

Parameters

configuration DocumentScannerConfiguration

Returns

Task<DocumentScannerResult>

A task returning the scanned pages.

LaunchFinderDocumentScannerAsync(FinderDocumentScannerConfiguration)

Launches the ready-to-use Finder Document Scanner UI.

public Task<DocumentScannerResult> LaunchFinderDocumentScannerAsync(FinderDocumentScannerConfiguration configuration = null)

Parameters

configuration FinderDocumentScannerConfiguration

Returns

Task<DocumentScannerResult>

A task returning the scanned page.

LaunchGenericDocumentRecognizerAsync(GenericDocumentRecognizerConfiguration)

Launches the ready-to-use Generic Document recognizer

public Task<GenericDocumentRecognizerResult> LaunchGenericDocumentRecognizerAsync(GenericDocumentRecognizerConfiguration configuration = null)

Parameters

configuration GenericDocumentRecognizerConfiguration

Optional configuration parameters of type GenericDocumentRecognizerConfiguration

Returns

Task<GenericDocumentRecognizerResult>

A task returning the Generic Document Recognizer result.

LaunchHealthInsuranceCardScannerAsync(HealthInsuranceCardConfiguration)

Launches the ready-to-use Health Insurance Card Scanner UI.

public Task<HealthInsuranceCardScannerResult> LaunchHealthInsuranceCardScannerAsync(HealthInsuranceCardConfiguration configuration)

Parameters

configuration HealthInsuranceCardConfiguration

Returns

Task<HealthInsuranceCardScannerResult>

A task returning the scanned pages.

LaunchLicensePlateScannerAsync(LicensePlateScannerConfiguration)

Launches the ready-to-use License Plate Scanner UI.

public Task<LicensePlateScannerResult> LaunchLicensePlateScannerAsync(LicensePlateScannerConfiguration configuration = null)

Parameters

configuration LicensePlateScannerConfiguration

Returns

Task<LicensePlateScannerResult>

A task returning the found LicensePlate data.

LaunchMedicalCertificateScannerAsync(MedicalCertificateRecognizerConfiguration)

Launches the ready-to-use Medical Certificate Scanner UI.

public Task<MedicalCertificateResult> LaunchMedicalCertificateScannerAsync(MedicalCertificateRecognizerConfiguration configuration = null)

Parameters

configuration MedicalCertificateRecognizerConfiguration

Returns

Task<MedicalCertificateResult>

A task returning the found MedicalCertificate data.

LaunchMrzScannerAsync(MrzScannerConfiguration)

Launches the ready-to-use MRZ Scanner UI.

public Task<MrzScannerResult> LaunchMrzScannerAsync(MrzScannerConfiguration configuration = null)

Parameters

configuration MrzScannerConfiguration

Returns

Task<MrzScannerResult>

A task returning the found MRZ data.

LaunchTextDataScannerAsync(TextDataScannerConfiguration)

Launches the ready-to-use Text Data Scanner UI

public Task<TextDataScannerResult> LaunchTextDataScannerAsync(TextDataScannerConfiguration configuration)

Parameters

configuration TextDataScannerConfiguration

Configuration parameters of type TextDataScannerConfiguration

Returns

Task<TextDataScannerResult>

A task returning the Text Data Scanner result.

LaunchVINScannerAsync(VINScannerConfiguration)

Launches the ready-to-use VIN Scanner UI.

public Task<VINScannerResult> LaunchVINScannerAsync(VINScannerConfiguration configuration = null)

Parameters

configuration VINScannerConfiguration

Returns

Task<VINScannerResult>

A task returning the found VIN data.

OpenBarcodeScannerAsync(BarcodeScannerConfiguration)

Scan Barcode from configuration.

public Task<BarcodeScannerResult> OpenBarcodeScannerAsync(BarcodeScannerConfiguration configuration)

Parameters

configuration BarcodeScannerConfiguration

Returns

Task<BarcodeScannerResult>