net.doo.snap

Class ScanbotSDK

java.lang.Object

net.doo.snap.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.

Must be operated on the main thread.

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.

Constructor Summary

Constructors

Constructor and Description
ScanbotSDK(android.app.Activity activity)
ScanbotSDK(android.app.Application application)
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.
DocumentDraftExtractor	documentDraftExtractor() Provides DocumentDraftExtractor.
DocumentProcessor	documentProcessor() Provides DocumentProcessor.
boolean	isLicenseActive() Deprecated. use isLicenseValid()
boolean	isLicenseValid() Provides the status of the license.
PageFactory	pageFactory() Provides PageFactory.
PayFormScanner	payFormScanner() Provides PayFormScanner.
TextRecognition	textRecognition() Provides functionality for recognize text.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScanbotSDK

public ScanbotSDK(android.app.Activity activity)

ScanbotSDK

public ScanbotSDK(android.app.Service service)

ScanbotSDK

public ScanbotSDK(android.app.Application application)

Method Detail

isLicenseActive

@Deprecated
public boolean isLicenseActive()

Deprecated. use 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.

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. Must be called from the main thread.

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. Must be called from the main thread.

Returns:

instance of Cleaner. Never null

documentDraftExtractor

public DocumentDraftExtractor documentDraftExtractor()

Provides DocumentDraftExtractor. Must be called from the main thread.

Returns:

instance of DocumentDraftExtractor. Never null

pageFactory

public PageFactory pageFactory()

Provides PageFactory. Must be called from the main thread.

Returns:

instance of PageFactory. Never null

blobManager

public BlobManager blobManager()

Provides BlobManager. Must be called from the main thread.

Returns:

instance of BlobManager. Never null

blobFactory

public BlobFactory blobFactory()

Provides BlobFactory. Must be called from the main thread.

Returns:

instance of BlobFactory. Never null

payFormScanner

public PayFormScanner payFormScanner()

Provides PayFormScanner. Must be called from the main thread.

Returns:

instance of PayFormScanner. Never null

barcodeDetector

public ScanbotBarcodeDetector barcodeDetector()

Provides ScanbotBarcodeDetector. Must be called from the main thread.

Returns:

instance of ScanbotBarcodeDetector. Never null