io.scanbot.sdk

Class ScanbotSDK

java.lang.Object

io.scanbot.sdk.ScanbotSDK

public class ScanbotSDK
extends java.lang.Object

Provider for Scanbot SDK features.

Typical use case is to create this object in Activity.onCreate(Bundle) or Service.onCreate(), but it's allowed to create it during any other point of lifecycle before onDestroy.

Note that each instance stores reference to given context, so it should not be cached statically. All necessary caching is already done by ScanbotSDK itself - some methods might return same instance repeatedly.

Some insight - Scanbot uses Dependency Injection internally, but we do not want to expose it to users of the library to ensure that changes in DI implementation won't affect users of the library.

Field Summary

Fields

Modifier and Type	Field and Description
protected static SdkComponent	sdkComponent

Constructor Summary

Constructors

Modifier	Constructor and Description
	ScanbotSDK(android.app.Activity activity)
	ScanbotSDK(android.app.Application application)
protected	ScanbotSDK(android.content.Context context)
	ScanbotSDK(android.app.Service service)

Method Summary

Modifier and Type	Method and Description
ScanbotBarcodeDetector	barcodeDetector() Provides ScanbotBarcodeDetector.
BlobFactory	blobFactory() Provides BlobFactory.
BlobManager	blobManager() Provides BlobManager.
Cleaner	cleaner() Provides Cleaner.
DCScanner	dcScanner() Provides DCScanner.
DocumentDraftExtractor	documentDraftExtractor() Provides DocumentDraftExtractor.
DocumentProcessor	documentProcessor() Provides DocumentProcessor.
PageFileStorage	getPageFileStorage() Provides PageFileStorage.
SdkComponent	getSdkComponent()
boolean	isLicenseActive() Provides the status of the license.
boolean	isLicenseValid() Provides the status of the license.
MRZScanner	mrzScanner() Provides MRZScanner.
PageFactory	pageFactory() Provides PageFactory.
PayFormScanner	payFormScanner() Provides PayFormScanner.
TextRecognition	textRecognition() Provides functionality for recognize text.
TIFFWriter	tiffWriter() Provides io.scanbot.tiffwriter.TIFFWriter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

sdkComponent

protected static SdkComponent sdkComponent

Constructor Detail

ScanbotSDK

public ScanbotSDK(android.app.Activity activity)

ScanbotSDK

public ScanbotSDK(android.app.Service service)

ScanbotSDK

public ScanbotSDK(android.app.Application application)

ScanbotSDK

protected ScanbotSDK(android.content.Context context)

Method Detail

getSdkComponent

public SdkComponent getSdkComponent()

isLicenseActive

public boolean isLicenseActive()

Provides the status of the license. Returned value is consistent during lifetime of the process, i.e. if license is active at application start-up it will remain that way until app will be killed.

Returns:

true if Scanbot SDK license is active and all features can be used normally. false if license is not active and usage of SDK features will result in either RuntimeException or no-op.

isLicenseValid

public boolean isLicenseValid()

Provides the status of the license. Returned value is consistent during lifetime of the process, i.e. if license is active at application start-up it will remain that way until app will be killed.

Returns:

true if Scanbot SDK license is active and all features can be used normally. false if license is not active and usage of SDK features will result in either RuntimeException or no-op.

documentProcessor

public DocumentProcessor documentProcessor()

Provides DocumentProcessor.

Returns:

instance of DocumentProcessor. Never null

textRecognition

public TextRecognition textRecognition()

Provides functionality for recognize text. Should be called for each case of text recognition.

Returns:

TextRecognition. Should be acquired for each case of text recognizing.

cleaner

public Cleaner cleaner()

Provides Cleaner.

Returns:

instance of Cleaner. Never null

documentDraftExtractor

public DocumentDraftExtractor documentDraftExtractor()

Provides DocumentDraftExtractor.

Returns:

instance of DocumentDraftExtractor. Never null

pageFactory

public PageFactory pageFactory()

Provides PageFactory.

Returns:

instance of PageFactory. Never null

blobManager

public BlobManager blobManager()

Provides BlobManager.

Returns:

instance of BlobManager. Never null

blobFactory

public BlobFactory blobFactory()

Provides BlobFactory.

Returns:

instance of BlobFactory. Never null

payFormScanner

public PayFormScanner payFormScanner()

Provides PayFormScanner.

Returns:

instance of PayFormScanner. Never null

mrzScanner

public MRZScanner mrzScanner()

Provides MRZScanner.

Returns:

instance of MRZScanner. Never null

dcScanner

public DCScanner dcScanner()

Provides DCScanner.

Returns:

instance of DCScanner. Never null

barcodeDetector

public ScanbotBarcodeDetector barcodeDetector()

Provides ScanbotBarcodeDetector.

Returns:

instance of ScanbotBarcodeDetector. Never null

tiffWriter

public TIFFWriter tiffWriter()

Provides io.scanbot.tiffwriter.TIFFWriter.

Returns:

instance of io.scanbot.tiffwriter.TIFFWriter. Never null

getPageFileStorage

public PageFileStorage getPageFileStorage()

Provides PageFileStorage.

Returns:

instance of PageFileStorage. Never null