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

Inheritors

Constructors

Link copied to clipboard
constructor(activity: Activity)
constructor(service: Service)
constructor(context: Context)
constructor(application: Application)

Types

Link copied to clipboard
object Companion
Link copied to clipboard
data class Configuration(val ocrBlobsPath: String?, val sdkFilesDirectory: File?, val documentDraftExtractor: DocumentDraftExtractor?, val ocrSettings: OcrSettings?, val pdfImagesExtractorSettings: PdfImagesExtractorSettings, var documentScannerConfiguration: DocumentScannerConfiguration = DocumentScannerConfiguration())

Properties

Link copied to clipboard
open override val availableDiskSpace: Long

Provides full info of how much space available to write data by sdk in bytes. You can check this value before creating page images by sdk. But please don't forget that one page contains more than one image inside.

Link copied to clipboard
Link copied to clipboard
open override val licenseInfo: LicenseInfo

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.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override val totalDiskSpace: Long

Provides full info of how much space total exist on this device storage in bytes.

Link copied to clipboard
open override val usedDiskSpace: Long

Provides full info of how much space used on this device storage in bytes.

Functions

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun createCheckScanner(configuration: CheckScannerConfiguration = CheckScannerConfiguration.default()): Result<CheckScanner>

Provides CheckScanner.

Link copied to clipboard

Provides Cleaner.

Link copied to clipboard
fun createCreditCardScanner(configuration: CreditCardScannerConfiguration = CreditCardScannerConfiguration.default()): Result<CreditCardScanner>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun createDocumentScanner(configuration: DocumentScannerConfiguration = DocumentScannerConfiguration.default()): Result<DocumentScanner>

Provides DocumentScanner.

Link copied to clipboard
fun createMrzScanner(configuration: MrzScannerConfiguration = MrzScannerConfiguration.default()): Result<MrzScanner>

Provides MrzScanner.

Link copied to clipboard

Provides functionality for OCR .

Link copied to clipboard
Link copied to clipboard

Provides functionality for PDF generation with or without performing OCR.

Link copied to clipboard
fun createTextPatternScanner(configuration: TextPatternScannerConfiguration = TextPatternScannerConfiguration.default()): Result<TextPatternScanner>
Link copied to clipboard
fun createVinScanner(configuration: VinScannerConfiguration = VinScannerConfiguration.default()): Result<VinScanner>

Provides VinScanner.

Link copied to clipboard
Link copied to clipboard

Provides result repository for the given class