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

Aca(ISdkComponent) 

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

Parameters

p0 ISdkComponent

Returns

PageProcessor

Acc(ISdkComponent) 

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

Parameters

p0 ISdkComponent

Returns

Cleaner

Acd(ISdkComponent) 

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

Parameters

p0 ISdkComponent

Returns

PageFileStorage

Ace(ISdkComponent) 

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

Parameters

p0 ISdkComponent

Returns

IPdfImagesExtractor

Acf(ISdkComponent) 

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

Parameters

p0 ISdkComponent

Returns

IFileIOProcessor

Acg(ISdkComponent) 

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

Parameters

p0 ISdkComponent

Returns

SapManager

Ach(ISdkComponent) 

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

Parameters

p0 ISdkComponent

Returns

IPdfPagesExtractor

Acj(ISdkComponent) 

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

Parameters

p0 ISdkComponent

Returns

TiffGeneratorManager

Acl(ISdkComponent) 

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

Parameters

p0 ISdkComponent

Returns

IResult

Acm(ISdkComponent) 

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

Parameters

p0 ISdkComponent

Returns

ICollection

Acn(ISdkComponent) 

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

Parameters

p0 ISdkComponent

Returns

PageFileStorage

Acp(ISdkComponent) 

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

Parameters

p0 ISdkComponent

Returns

BlobFactory

Acq(ISdkComponent) 

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

Parameters

p0 ISdkComponent

Returns

BlobManager

Acr(ISdkComponent) 

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

Parameters

p0 ISdkComponent

Returns

BarcodeFileStorage

Act(ISdkComponent) 

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

Parameters

p0 ISdkComponent

Returns

IOcrEngineManager

Acv(ISdkComponent) 

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

Parameters

p0 ISdkComponent

Returns

LicenseInfo

Acw(ISdkComponent) 

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

Parameters

p0 ISdkComponent

Returns

IDocumentApi

Acy(BarcodeScannerConfiguration, ISdkComponent) 

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

Parameters

p0 BarcodeScannerConfiguration
p1 ISdkComponent

Returns

IResult

Acy(CheckScannerConfiguration, ISdkComponent) 

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

Parameters

p0 CheckScannerConfiguration
p1 ISdkComponent

Returns

IResult

Acy(CreditCardScannerConfiguration, ISdkComponent) 

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

Parameters

p0 CreditCardScannerConfiguration
p1 ISdkComponent

Returns

IResult

Acy(ISdkComponent) 

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

Parameters

p0 ISdkComponent

Returns

IScanbotAnalyticsManager

Acy(DocumentDataExtractorConfiguration, ISdkComponent) 

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

Parameters

p0 DocumentDataExtractorConfiguration
p1 ISdkComponent

Returns

IResult

Acy(DocumentQualityAnalyzerConfiguration, ISdkComponent) 

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

Parameters

p0 DocumentQualityAnalyzerConfiguration
p1 ISdkComponent

Returns

IResult

Acy(DocumentScannerConfiguration, ISdkComponent) 

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

Parameters

p0 DocumentScannerConfiguration
p1 ISdkComponent

Returns

IResult

Acy(MrzScannerConfiguration, ISdkComponent) 

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

Parameters

p0 MrzScannerConfiguration
p1 ISdkComponent

Returns

IResult

Acy(TextPatternScannerConfiguration, ISdkComponent) 

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

Parameters

p0 TextPatternScannerConfiguration
p1 ISdkComponent

Returns

IResult

Acy(VinScannerConfiguration, ISdkComponent) 

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

Parameters

p0 VinScannerConfiguration
p1 ISdkComponent

Returns

IResult

Acy(IFunction1) 

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

Parameters

p0 IFunction1

Returns

Object

Acy(IList, ISdkComponent) 

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

Parameters

p0 IList
p1 ISdkComponent

Returns

IResult

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

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

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