io.scanbot.sdk

Class ScanbotSDK

io.scanbot.sdk.ScanbotSDK

public class ScanbotSDK

Provider for Scanbot SDK features.

Typical use case is to create this object in Activity.onCreate 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 class 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.

See Also:

class ScanbotSDK

Field Detail

Companion

public static io.scanbot.sdk.ScanbotSDK.Companion Companion

Constructor Detail

ScanbotSDK

public ScanbotSDK(@NotNull
                  android.content.Context context)

Provider for Scanbot SDK features.

Typical use case is to create this object in Activity.onCreate 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 class 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.

See Also:

class ScanbotSDK

ScanbotSDK

public ScanbotSDK(@NotNull
                  android.app.Activity activity)

ScanbotSDK

public ScanbotSDK(@NotNull
                  android.app.Service service)

ScanbotSDK

public ScanbotSDK(@NotNull
                  android.app.Application application)

Method Detail

isLicenseActive

public boolean isLicenseActive()

Deprecated.

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()

Deprecated.

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.

getLicenseInfo

@NotNull
public io.scanbot.sap.SdkLicenseInfo getLicenseInfo()

Provides full info of the license current state. 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:

SdkLicenseInfo with license status enum end expiration date if license is valid, otherwise date will be null

getPageFileStorage

@NotNull
public io.scanbot.sdk.persistence.PageFileStorage getPageFileStorage()

Deprecated.

Provides PageFileStorage.

Returns:

instance of PageFileStorage. Never null

getSdkComponent

@Nullable
public SdkComponent getSdkComponent()

pageProcessor

@NotNull
public io.scanbot.sdk.docprocessing.PageProcessor pageProcessor()

Provides PageProcessor.

Returns:

instance of PageProcessor. Never null

barcodeFileStorage

@NotNull
public io.scanbot.sdk.persistence.BarcodeFileStorage barcodeFileStorage()

Provides BarcodeFileStorage.

Returns:

instance of BarcodeFileStorage. Never null

fileIOProcessor

@NotNull
public io.scanbot.sdk.persistence.fileio.FileIOProcessor fileIOProcessor()

Provides FileIOProcessor.

Returns:

instance of FileIOProcessor. Never null

pdfRenderer

@NotNull
public PDFRenderer pdfRenderer()

Provides functionality for PDF rendering.

Returns:

interface PDFRenderer.

ocrRecognizer

@NotNull
public io.scanbot.sdk.ocr.OpticalCharacterRecognizer ocrRecognizer()

Provides functionality for OCR .

Returns:

OpticalCharacterRecognizer.

cleaner

@NotNull
public io.scanbot.sdk.persistence.cleanup.Cleaner cleaner()

Provides Cleaner.

Returns:

instance of Cleaner. Never null

blobManager

@NotNull
public io.scanbot.sdk.blob.BlobManager blobManager()

Provides BlobManager.

Returns:

instance of BlobManager. Never null

blobFactory

@NotNull
public io.scanbot.sdk.blob.BlobFactory blobFactory()

Provides BlobFactory.

Returns:

instance of BlobFactory. Never null

payFormScanner

@NotNull
public io.scanbot.sdk.payformscanner.PayFormScanner payFormScanner()

Provides PayFormScanner.

Returns:

instance of PayFormScanner. Never null

mrzScanner

@NotNull
public io.scanbot.sdk.mrzscanner.MRZScanner mrzScanner()

Provides MRZScanner.

Returns:

instance of MRZScanner. Never null

textOrientationScanner

@NotNull
public io.scanbot.sdk.textorientation.TextOrientationScanner textOrientationScanner()

Provides TextOrientationScanner.

Returns:

instance of TextOrientationScanner. Never null

dcScanner

@NotNull
public io.scanbot.sdk.dcscanner.DCScanner dcScanner()

Provides DCScanner.

Returns:

instance of DCScanner. Never null

barcodeDetector

@NotNull
public io.scanbot.sdk.barcode.ScanbotBarcodeDetector barcodeDetector()

Provides ScanbotBarcodeDetector.

Returns:

instance of ScanbotBarcodeDetector. Never null

tiffWriter

@NotNull
public io.scanbot.sdk.tiff.TIFFWriter tiffWriter()

Provides io.scanbot.tiffwriter.TIFFWriter.

Returns:

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

See Also:

io.scanbot.tiffwriter.TIFFWriter

pageFileStorage

@NotNull
public io.scanbot.sdk.persistence.PageFileStorage pageFileStorage()

Provides PageFileStorage.

Returns:

instance of PageFileStorage. Never null

chequeScanner

@NotNull
public io.scanbot.sdk.chequescanner.ChequeScanner chequeScanner()

Provides ChequeScanner.

Returns:

instance of ChequeScanner. Never null

healthInsuranceCardScanner

@NotNull
public io.scanbot.sdk.hicscanner.HealthInsuranceCardScanner healthInsuranceCardScanner()

Provides HealthInsuranceCardScanner.

Returns:

instance of HealthInsuranceCardScanner. Never null

filterPredictor

@NotNull
public io.scanbot.sdk.filterpredictor.FilterPredictor filterPredictor()

Provides FilterPredictor.

Returns:

new instance of FilterPredictor. Never null

multipleObjectsDetector

@NotNull
public io.scanbot.multipleobjectsscanner.MultipleObjectsDetector multipleObjectsDetector()

Provides MultipleObjectsDetector.

Returns:

instance of MultipleObjectsDetector. Never null

idCardScanner

@Deprecated
 @NotNull
public io.scanbot.sdk.idcardscanner.IdCardScanner idCardScanner()

Deprecated.

Provides IdCardScanner

Returns:

instance of IdCardScanner. Never null

genericDocumentRecognizer

@NotNull
public io.scanbot.sdk.genericdocument.GenericDocumentRecognizer genericDocumentRecognizer()

Provides GenericDocumentRecognizer

Returns:

instance of GenericDocumentRecognizer. Never null

imageProcessor

@NotNull
public io.scanbot.sdk.process.ImageProcessor imageProcessor()

Provides ImageProcessor.

Returns:

instance of ImageProcessor. Never null

blurEstimator

@NotNull
public io.scanbot.sdk.process.BlurEstimator blurEstimator()

Provides BlurEstimator.

Returns:

instance of BlurEstimator. Never null

businessCardsImageProcessor

@NotNull
public BusinessCardsImageProcessor businessCardsImageProcessor()

Provides interface BusinessCardsImageProcessor.

Returns:

instance of interface BusinessCardsImageProcessor. Never null

See Also:

interface BusinessCardsImageProcessor

contourDetector

@NotNull
public io.scanbot.sdk.core.contourdetector.ContourDetector contourDetector()

Provides ContourDetector.

Returns:

a new instance of ContourDetector. Never null

genericTextRecognizer

@NotNull
public io.scanbot.sdk.generictext.GenericTextRecognizer genericTextRecognizer()

Provides GenericTextRecognizer.

Returns:

a new instance of GenericTextRecognizer. Never null

licensePlateScanner

@NotNull
public io.scanbot.sdk.licenseplate.LicensePlateScanner licensePlateScanner()

Provides LicensePlateScanner.

Returns:

a new instance of LicensePlateScanner. Never null

passportNfcScanner

@NotNull
public io.scanbot.sdk.nfcscanner.passport.PassportNfcScanner passportNfcScanner()

Provides PassportNfcScanner.

Returns:

instance of PassportNfcScanner. Never null

resultRepositoryForClass

@NotNull
public <T> io.scanbot.sdk.ui.result.ResultRepository<T> resultRepositoryForClass(@NotNull
                                                                                          java.lang.Class<T> clazz)

Provides result repository for the given class

To get access to the full result object it is needed to do the following:

val resultWrapper: ResultWrapper val result = ScanbotSDK(context).resultRepositoryForClass(resultWrapper.clazz).getResultAndErase(resultWrapper.resultId) The result object will contain the full GenericDocument object

Parameters:

clazz - class of the result object, might be taken from io.scanbot.sdk.ui.result.ResultWrapper