Table of Contents

Class ScanbotSDK

Namespace
IO.Scanbot.Sdk
Assembly
DocumentSDK.NET.Droid.dll
[Register("io/scanbot/sdk/ScanbotSDK", DoNotGenerateAcw = true)]
public class ScanbotSDK : Object, ILicensableSdk, IBarcodeScanningSdk, IStorageSpaceAware, IJavaObject, IJavaPeerable, IDisposable
Inheritance
ScanbotSDK
Implements
Derived
Inherited Members

Constructors

ScanbotSDK(Activity) 

[Register(".ctor", "(Landroid/app/Activity;)V", "")]
public ScanbotSDK(Activity activity)

Parameters

activity Activity

ScanbotSDK(Application) 

[Register(".ctor", "(Landroid/app/Application;)V", "")]
public ScanbotSDK(Application application)

Parameters

application Application

ScanbotSDK(Service) 

[Register(".ctor", "(Landroid/app/Service;)V", "")]
public ScanbotSDK(Service service)

Parameters

service Service

ScanbotSDK(Context) 

[Register(".ctor", "(Landroid/content/Context;)V", "")]
public ScanbotSDK(Context context)

Parameters

context Context

ScanbotSDK(nint, JniHandleOwnership) 

protected ScanbotSDK(nint javaReference, JniHandleOwnership transfer)

Parameters

javaReference nint
transfer JniHandleOwnership

Properties

AnalyticsManager 

public IScanbotAnalyticsManager AnalyticsManager { get; }

Property Value

IScanbotAnalyticsManager

AvailableDiskSpace 

public virtual long AvailableDiskSpace { get; }

Property Value

long

DocumentApi 

public IDocumentApi DocumentApi { get; }

Property Value

IDocumentApi

LicenseInfo 

public virtual LicenseInfo LicenseInfo { get; }

Property Value

LicenseInfo

PageFileStorage 

[Obsolete("deprecated")]
public PageFileStorage PageFileStorage { get; }

Property Value

PageFileStorage

StorageAware 

public IStorageSpaceAware StorageAware { get; set; }

Property Value

IStorageSpaceAware

TotalDiskSpace 

public virtual long TotalDiskSpace { get; }

Property Value

long

UsedDiskSpace 

public virtual long UsedDiskSpace { get; }

Property Value

long

Methods

CreateBarcodeDocumentParser(IList<BarcodeDocumentFormat>) 

[Register("createBarcodeDocumentParser", "(Ljava/util/List;)Lio/scanbot/common/Result;", "GetCreateBarcodeDocumentParser_Ljava_util_List_Handler")]
public virtual IResult CreateBarcodeDocumentParser(IList<BarcodeDocumentFormat> acceptedFormats)

Parameters

acceptedFormats IList<BarcodeDocumentFormat>

Returns

IResult

CreateBarcodeFileStorage() 

[Register("createBarcodeFileStorage", "()Lio/scanbot/sdk/persistence/BarcodeFileStorage;", "GetCreateBarcodeFileStorageHandler")]
public virtual BarcodeFileStorage CreateBarcodeFileStorage()

Returns

BarcodeFileStorage

CreateBarcodeScanner(BarcodeScannerConfiguration) 

[Register("createBarcodeScanner", "(Lio/scanbot/sdk/barcode/BarcodeScannerConfiguration;)Lio/scanbot/common/Result;", "GetCreateBarcodeScanner_Lio_scanbot_sdk_barcode_BarcodeScannerConfiguration_Handler")]
public virtual IResult CreateBarcodeScanner(BarcodeScannerConfiguration configuration)

Parameters

configuration BarcodeScannerConfiguration

Returns

IResult

CreateBlobFactory() 

[Register("createBlobFactory", "()Lio/scanbot/sdk/blob/BlobFactory;", "")]
public BlobFactory CreateBlobFactory()

Returns

BlobFactory

CreateBlobManager() 

[Register("createBlobManager", "()Lio/scanbot/sdk/blob/BlobManager;", "")]
public BlobManager CreateBlobManager()

Returns

BlobManager

CreateCheckScanner() 

[Register("createCheckScanner", "()Lio/scanbot/common/Result;", "")]
public IResult CreateCheckScanner()

Returns

IResult

CreateCheckScanner(CheckScannerConfiguration) 

[Register("createCheckScanner", "(Lio/scanbot/sdk/check/CheckScannerConfiguration;)Lio/scanbot/common/Result;", "")]
public IResult CreateCheckScanner(CheckScannerConfiguration configuration)

Parameters

configuration CheckScannerConfiguration

Returns

IResult

CreateCleaner() 

[Obsolete("deprecated")]
[Register("createCleaner", "()Lio/scanbot/sdk/persistence/cleanup/Cleaner;", "")]
public Cleaner CreateCleaner()

Returns

Cleaner

CreateCreditCardScanner() 

[Register("createCreditCardScanner", "()Lio/scanbot/common/Result;", "")]
public IResult CreateCreditCardScanner()

Returns

IResult

CreateCreditCardScanner(CreditCardScannerConfiguration) 

[Register("createCreditCardScanner", "(Lio/scanbot/sdk/creditcard/CreditCardScannerConfiguration;)Lio/scanbot/common/Result;", "")]
public IResult CreateCreditCardScanner(CreditCardScannerConfiguration configuration)

Parameters

configuration CreditCardScannerConfiguration

Returns

IResult

CreateDocumentCleanup(ImageRef) 

[Register("createDocumentCleanup", "(Lio/scanbot/sdk/image/ImageRef;)Lio/scanbot/common/Result;", "")]
public IResult CreateDocumentCleanup(ImageRef image)

Parameters

image ImageRef

Returns

IResult

CreateDocumentCleanup(ImageRef, DocumentCleanupConfiguration) 

[Register("createDocumentCleanup", "(Lio/scanbot/sdk/image/ImageRef;Lio/scanbot/sdk/imageprocessing/DocumentCleanupConfiguration;)Lio/scanbot/common/Result;", "")]
public IResult CreateDocumentCleanup(ImageRef image, DocumentCleanupConfiguration configuration)

Parameters

image ImageRef
configuration DocumentCleanupConfiguration

Returns

IResult

CreateDocumentDataExtractor() 

[Register("createDocumentDataExtractor", "()Lio/scanbot/common/Result;", "")]
public IResult CreateDocumentDataExtractor()

Returns

IResult

CreateDocumentDataExtractor(DocumentDataExtractorConfiguration) 

[Register("createDocumentDataExtractor", "(Lio/scanbot/sdk/documentdata/DocumentDataExtractorConfiguration;)Lio/scanbot/common/Result;", "")]
public IResult CreateDocumentDataExtractor(DocumentDataExtractorConfiguration configuration)

Parameters

configuration DocumentDataExtractorConfiguration

Returns

IResult

CreateDocumentQualityAnalyzer() 

[Register("createDocumentQualityAnalyzer", "()Lio/scanbot/common/Result;", "")]
public IResult CreateDocumentQualityAnalyzer()

Returns

IResult

CreateDocumentQualityAnalyzer(DocumentQualityAnalyzerConfiguration) 

[Register("createDocumentQualityAnalyzer", "(Lio/scanbot/sdk/documentqualityanalyzer/DocumentQualityAnalyzerConfiguration;)Lio/scanbot/common/Result;", "")]
public IResult CreateDocumentQualityAnalyzer(DocumentQualityAnalyzerConfiguration configuration)

Parameters

configuration DocumentQualityAnalyzerConfiguration

Returns

IResult

CreateDocumentScanner() 

[Register("createDocumentScanner", "()Lio/scanbot/common/Result;", "")]
public IResult CreateDocumentScanner()

Returns

IResult

CreateDocumentScanner(DocumentScannerConfiguration) 

[Register("createDocumentScanner", "(Lio/scanbot/sdk/documentscanner/DocumentScannerConfiguration;)Lio/scanbot/common/Result;", "")]
public IResult CreateDocumentScanner(DocumentScannerConfiguration configuration)

Parameters

configuration DocumentScannerConfiguration

Returns

IResult

CreateDocumentStraightener() 

[Register("createDocumentStraightener", "()Lio/scanbot/common/Result;", "")]
public IResult CreateDocumentStraightener()

Returns

IResult

CreateMedicalCertificateScanner() 

[Register("createMedicalCertificateScanner", "()Lio/scanbot/common/Result;", "")]
public IResult CreateMedicalCertificateScanner()

Returns

IResult

CreateMrzScanner() 

[Register("createMrzScanner", "()Lio/scanbot/common/Result;", "")]
public IResult CreateMrzScanner()

Returns

IResult

CreateMrzScanner(MrzScannerConfiguration) 

[Register("createMrzScanner", "(Lio/scanbot/sdk/mrz/MrzScannerConfiguration;)Lio/scanbot/common/Result;", "")]
public IResult CreateMrzScanner(MrzScannerConfiguration configuration)

Parameters

configuration MrzScannerConfiguration

Returns

IResult

CreateOcrEngineManager() 

[Register("createOcrEngineManager", "()Lio/scanbot/sdk/ocr/OcrEngineManager;", "")]
public IOcrEngineManager CreateOcrEngineManager()

Returns

IOcrEngineManager

CreatePageFileStorage() 

[Obsolete("deprecated")]
[Register("createPageFileStorage", "()Lio/scanbot/sdk/persistence/page/legacy/PageFileStorage;", "")]
public PageFileStorage CreatePageFileStorage()

Returns

PageFileStorage

CreatePageProcessor() 

[Obsolete("deprecated")]
[Register("createPageProcessor", "()Lio/scanbot/sdk/docprocessing/legacy/PageProcessor;", "")]
public PageProcessor CreatePageProcessor()

Returns

PageProcessor

CreatePdfGenerator(OcrConfig) 

[Register("createPdfGenerator", "(Lio/scanbot/sdk/ocr/OcrEngineManager$OcrConfig;)Lio/scanbot/sdk/pdf/PdfGenerator;", "")]
public IPdfGenerator CreatePdfGenerator(IOcrEngineManager.OcrConfig ocrConfiguration)

Parameters

ocrConfiguration IOcrEngineManager.OcrConfig

Returns

IPdfGenerator

CreatePdfImagesExtractor() 

[Register("createPdfImagesExtractor", "()Lio/scanbot/sdk/pdf/PdfImagesExtractor;", "")]
public IPdfImagesExtractor CreatePdfImagesExtractor()

Returns

IPdfImagesExtractor

CreatePdfPagesExtractor() 

[Register("createPdfPagesExtractor", "()Lio/scanbot/sdk/docprocessing/PdfPagesExtractor;", "")]
public IPdfPagesExtractor CreatePdfPagesExtractor()

Returns

IPdfPagesExtractor

CreateTextPatternScanner() 

[Register("createTextPatternScanner", "()Lio/scanbot/common/Result;", "")]
public IResult CreateTextPatternScanner()

Returns

IResult

CreateTextPatternScanner(TextPatternScannerConfiguration) 

[Register("createTextPatternScanner", "(Lio/scanbot/sdk/textpattern/TextPatternScannerConfiguration;)Lio/scanbot/common/Result;", "")]
public IResult CreateTextPatternScanner(TextPatternScannerConfiguration configuration)

Parameters

configuration TextPatternScannerConfiguration

Returns

IResult

CreateTiffGeneratorManager() 

[Register("createTiffGeneratorManager", "()Lio/scanbot/sdk/tiff/TiffGeneratorManager;", "")]
public TiffGeneratorManager CreateTiffGeneratorManager()

Returns

TiffGeneratorManager

CreateVinScanner() 

[Register("createVinScanner", "()Lio/scanbot/common/Result;", "")]
public IResult CreateVinScanner()

Returns

IResult

CreateVinScanner(VinScannerConfiguration) 

[Register("createVinScanner", "(Lio/scanbot/sdk/vin/VinScannerConfiguration;)Lio/scanbot/common/Result;", "")]
public IResult CreateVinScanner(VinScannerConfiguration configuration)

Parameters

configuration VinScannerConfiguration

Returns

IResult

FileIOProcessor() 

[Register("fileIOProcessor", "()Lio/scanbot/sdk/persistence/fileio/FileIOProcessor;", "")]
public IFileIOProcessor FileIOProcessor()

Returns

IFileIOProcessor

ResultRepositoryForClass(Class) 

[Register("resultRepositoryForClass", "(Ljava/lang/Class;)Lio/scanbot/sdk/ui/result/ResultRepository;", "")]
[JavaTypeParameters(new string[] { "T" })]
public IResultRepository ResultRepositoryForClass(Class clazz)

Parameters

clazz Class

Returns

IResultRepository

Wxb(ISdkComponent) 

[Register("wxb", "(Lio/scanbot/sdk/di/SdkComponent;)Lio/scanbot/sdk/docprocessing/DocumentApi;", "")]
public static IDocumentApi Wxb(ISdkComponent p0)

Parameters

p0 ISdkComponent

Returns

IDocumentApi

Wxd(ISdkComponent) 

[Register("wxd", "(Lio/scanbot/sdk/di/SdkComponent;)Lio/scanbot/sdk/persistence/BarcodeFileStorage;", "")]
public static BarcodeFileStorage Wxd(ISdkComponent p0)

Parameters

p0 ISdkComponent

Returns

BarcodeFileStorage

Wxe(ISdkComponent) 

[Register("wxe", "(Lio/scanbot/sdk/di/SdkComponent;)Lio/scanbot/common/Result;", "")]
public static IResult Wxe(ISdkComponent p0)

Parameters

p0 ISdkComponent

Returns

IResult

Wxh(ISdkComponent) 

[Register("wxh", "(Lio/scanbot/sdk/di/SdkComponent;)Lio/scanbot/sdk/blob/BlobFactory;", "")]
public static BlobFactory Wxh(ISdkComponent p0)

Parameters

p0 ISdkComponent

Returns

BlobFactory

Wxi(BarcodeScannerConfiguration, ISdkComponent) 

[Register("wxi", "(Lio/scanbot/sdk/barcode/BarcodeScannerConfiguration;Lio/scanbot/sdk/di/SdkComponent;)Lio/scanbot/common/Result;", "")]
public static IResult Wxi(BarcodeScannerConfiguration p0, ISdkComponent p1)

Parameters

p0 BarcodeScannerConfiguration
p1 ISdkComponent

Returns

IResult

Wxi(CheckScannerConfiguration, ISdkComponent) 

[Register("wxi", "(Lio/scanbot/sdk/check/CheckScannerConfiguration;Lio/scanbot/sdk/di/SdkComponent;)Lio/scanbot/common/Result;", "")]
public static IResult Wxi(CheckScannerConfiguration p0, ISdkComponent p1)

Parameters

p0 CheckScannerConfiguration
p1 ISdkComponent

Returns

IResult

Wxi(CreditCardScannerConfiguration, ISdkComponent) 

[Register("wxi", "(Lio/scanbot/sdk/creditcard/CreditCardScannerConfiguration;Lio/scanbot/sdk/di/SdkComponent;)Lio/scanbot/common/Result;", "")]
public static IResult Wxi(CreditCardScannerConfiguration p0, ISdkComponent p1)

Parameters

p0 CreditCardScannerConfiguration
p1 ISdkComponent

Returns

IResult

Wxi(ISdkComponent) 

[Register("wxi", "(Lio/scanbot/sdk/di/SdkComponent;)Lio/scanbot/sdk/analytics/IScanbotAnalyticsManager;", "")]
public static IScanbotAnalyticsManager Wxi(ISdkComponent p0)

Parameters

p0 ISdkComponent

Returns

IScanbotAnalyticsManager

Wxi(DocumentDataExtractorConfiguration, ISdkComponent) 

[Register("wxi", "(Lio/scanbot/sdk/documentdata/DocumentDataExtractorConfiguration;Lio/scanbot/sdk/di/SdkComponent;)Lio/scanbot/common/Result;", "")]
public static IResult Wxi(DocumentDataExtractorConfiguration p0, ISdkComponent p1)

Parameters

p0 DocumentDataExtractorConfiguration
p1 ISdkComponent

Returns

IResult

Wxi(DocumentQualityAnalyzerConfiguration, ISdkComponent) 

[Register("wxi", "(Lio/scanbot/sdk/documentqualityanalyzer/DocumentQualityAnalyzerConfiguration;Lio/scanbot/sdk/di/SdkComponent;)Lio/scanbot/common/Result;", "")]
public static IResult Wxi(DocumentQualityAnalyzerConfiguration p0, ISdkComponent p1)

Parameters

p0 DocumentQualityAnalyzerConfiguration
p1 ISdkComponent

Returns

IResult

Wxi(DocumentScannerConfiguration, ISdkComponent) 

[Register("wxi", "(Lio/scanbot/sdk/documentscanner/DocumentScannerConfiguration;Lio/scanbot/sdk/di/SdkComponent;)Lio/scanbot/common/Result;", "")]
public static IResult Wxi(DocumentScannerConfiguration p0, ISdkComponent p1)

Parameters

p0 DocumentScannerConfiguration
p1 ISdkComponent

Returns

IResult

Wxi(ImageRef, DocumentCleanupConfiguration, ISdkComponent) 

[Register("wxi", "(Lio/scanbot/sdk/image/ImageRef;Lio/scanbot/sdk/imageprocessing/DocumentCleanupConfiguration;Lio/scanbot/sdk/di/SdkComponent;)Lio/scanbot/common/Result;", "")]
public static IResult Wxi(ImageRef p0, DocumentCleanupConfiguration p1, ISdkComponent p2)

Parameters

p0 ImageRef
p1 DocumentCleanupConfiguration
p2 ISdkComponent

Returns

IResult

Wxi(MrzScannerConfiguration, ISdkComponent) 

[Register("wxi", "(Lio/scanbot/sdk/mrz/MrzScannerConfiguration;Lio/scanbot/sdk/di/SdkComponent;)Lio/scanbot/common/Result;", "")]
public static IResult Wxi(MrzScannerConfiguration p0, ISdkComponent p1)

Parameters

p0 MrzScannerConfiguration
p1 ISdkComponent

Returns

IResult

Wxi(TextPatternScannerConfiguration, ISdkComponent) 

[Register("wxi", "(Lio/scanbot/sdk/textpattern/TextPatternScannerConfiguration;Lio/scanbot/sdk/di/SdkComponent;)Lio/scanbot/common/Result;", "")]
public static IResult Wxi(TextPatternScannerConfiguration p0, ISdkComponent p1)

Parameters

p0 TextPatternScannerConfiguration
p1 ISdkComponent

Returns

IResult

Wxi(VinScannerConfiguration, ISdkComponent) 

[Register("wxi", "(Lio/scanbot/sdk/vin/VinScannerConfiguration;Lio/scanbot/sdk/di/SdkComponent;)Lio/scanbot/common/Result;", "")]
public static IResult Wxi(VinScannerConfiguration p0, ISdkComponent p1)

Parameters

p0 VinScannerConfiguration
p1 ISdkComponent

Returns

IResult

Wxi(IFunction1) 

[Register("wxi", "(Lkotlin/jvm/functions/Function1;)Ljava/lang/Object;", "")]
public static Object Wxi(IFunction1 p0)

Parameters

p0 IFunction1

Returns

Object

Wxi(IList, ISdkComponent) 

[Register("wxi", "(Ljava/util/List;Lio/scanbot/sdk/di/SdkComponent;)Lio/scanbot/common/Result;", "")]
public static IResult Wxi(IList p0, ISdkComponent p1)

Parameters

p0 IList
p1 ISdkComponent

Returns

IResult

Wxj(ISdkComponent) 

[Register("wxj", "(Lio/scanbot/sdk/di/SdkComponent;)Lio/scanbot/sdk/blob/BlobManager;", "")]
public static BlobManager Wxj(ISdkComponent p0)

Parameters

p0 ISdkComponent

Returns

BlobManager

Wxk(ISdkComponent) 

[Register("wxk", "(Lio/scanbot/sdk/di/SdkComponent;)Lio/scanbot/sdk/licensing/LicenseInfo;", "")]
public static LicenseInfo Wxk(ISdkComponent p0)

Parameters

p0 ISdkComponent

Returns

LicenseInfo

Wxl(ISdkComponent) 

[Register("wxl", "(Lio/scanbot/sdk/di/SdkComponent;)Lio/scanbot/sdk/docprocessing/PdfPagesExtractor;", "")]
public static IPdfPagesExtractor Wxl(ISdkComponent p0)

Parameters

p0 ISdkComponent

Returns

IPdfPagesExtractor

Wxm(ISdkComponent) 

[Register("wxm", "(Lio/scanbot/sdk/di/SdkComponent;)Ljava/util/Set;", "")]
public static ICollection Wxm(ISdkComponent p0)

Parameters

p0 ISdkComponent

Returns

ICollection

Wxn(ISdkComponent) 

[Register("wxn", "(Lio/scanbot/sdk/di/SdkComponent;)Lio/scanbot/sdk/tiff/TiffGeneratorManager;", "")]
public static TiffGeneratorManager Wxn(ISdkComponent p0)

Parameters

p0 ISdkComponent

Returns

TiffGeneratorManager

Wxo(ISdkComponent) 

[Register("wxo", "(Lio/scanbot/sdk/di/SdkComponent;)Lio/scanbot/sdk/persistence/fileio/FileIOProcessor;", "")]
public static IFileIOProcessor Wxo(ISdkComponent p0)

Parameters

p0 ISdkComponent

Returns

IFileIOProcessor

Wxp(ISdkComponent) 

[Register("wxp", "(Lio/scanbot/sdk/di/SdkComponent;)Lio/scanbot/sdk/persistence/cleanup/Cleaner;", "")]
public static Cleaner Wxp(ISdkComponent p0)

Parameters

p0 ISdkComponent

Returns

Cleaner

Wxr(ISdkComponent) 

[Register("wxr", "(Lio/scanbot/sdk/di/SdkComponent;)Lio/scanbot/sdk/persistence/page/PageFileStorage;", "")]
public static PageFileStorage Wxr(ISdkComponent p0)

Parameters

p0 ISdkComponent

Returns

PageFileStorage

Wxu(ISdkComponent) 

[Register("wxu", "(Lio/scanbot/sdk/di/SdkComponent;)Lio/scanbot/sdk/persistence/page/legacy/PageFileStorage;", "")]
public static PageFileStorage Wxu(ISdkComponent p0)

Parameters

p0 ISdkComponent

Returns

PageFileStorage

Wxv(ISdkComponent) 

[Register("wxv", "(Lio/scanbot/sdk/di/SdkComponent;)Lio/scanbot/sap/SapManager;", "")]
public static SapManager Wxv(ISdkComponent p0)

Parameters

p0 ISdkComponent

Returns

SapManager

Wxw(ISdkComponent) 

[Register("wxw", "(Lio/scanbot/sdk/di/SdkComponent;)Lio/scanbot/sdk/pdf/PdfImagesExtractor;", "")]
public static IPdfImagesExtractor Wxw(ISdkComponent p0)

Parameters

p0 ISdkComponent

Returns

IPdfImagesExtractor

Wxx(ISdkComponent) 

[Register("wxx", "(Lio/scanbot/sdk/di/SdkComponent;)Lio/scanbot/sdk/ocr/OcrEngineManager;", "")]
public static IOcrEngineManager Wxx(ISdkComponent p0)

Parameters

p0 ISdkComponent

Returns

IOcrEngineManager

Wxy(ISdkComponent) 

[Register("wxy", "(Lio/scanbot/sdk/di/SdkComponent;)Lio/scanbot/sdk/docprocessing/legacy/PageProcessor;", "")]
public static PageProcessor Wxy(ISdkComponent p0)

Parameters

p0 ISdkComponent

Returns

PageProcessor

Wxz(ISdkComponent) 

[Register("wxz", "(Lio/scanbot/sdk/di/SdkComponent;)Lio/scanbot/common/Result;", "")]
public static IResult Wxz(ISdkComponent p0)

Parameters

p0 ISdkComponent

Returns

IResult