Skip navigation links
B C D E F G H I L M N O P R S T U Z 

B

BaseGenericDocumentCameraFragment - Class in io.scanbot.sdk.ui.view.genericdocument
Shows document recognizer camera screen of application
BaseGenericDocumentCameraFragment() - Constructor for class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
Shows document recognizer camera screen of application
BaseGenericDocumentCameraFragment.Companion - Class in io.scanbot.sdk.ui.view.genericdocument
 
BaseGenericDocumentRecognizerActivity - Class in io.scanbot.sdk.ui.view.genericdocument
Represents camera screen for document recognizer
BaseGenericDocumentRecognizerActivity() - Constructor for class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentRecognizerActivity
Represents camera screen for document recognizer
BaseGenericDocumentRecognizerActivity.Companion - Class in io.scanbot.sdk.ui.view.genericdocument
 

C

cameraPermissionDenied() - Method in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentCameraPresenter
User denied camera permission
cameraPermissionDenied() - Method in interface io.scanbot.sdk.ui.view.genericdocument.IGenericDocumentCameraView.Listener
User denied camera permission
cameraPermissionGranted() - Method in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentCameraPresenter
User accepted camera permission
cameraPermissionGranted() - Method in interface io.scanbot.sdk.ui.view.genericdocument.IGenericDocumentCameraView.Listener
User accepted camera permission
cameraPresenter - Variable in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
 
cameraView - Variable in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
 
checkCameraPermissionUseCase - Variable in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
 
clear() - Method in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentScanningSession
Clears the queue in the recognizer and current document state
clearClick() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListPresenter
User wants to clear the list of items
clearClick() - Method in interface io.scanbot.sdk.ui.view.genericdocument.list.IGenericDocumentFieldListView.Listener
User wants to clear the list of items
Companion - Static variable in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
 
Companion - Static variable in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentRecognizerActivity
 
Companion - Static variable in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentConfigurationHelper
 
Companion - Static variable in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentCameraPresenter
 
Companion - Static variable in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentCameraView
 
Companion - Static variable in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentScanningSession
 
Companion - Static variable in interface io.scanbot.sdk.ui.view.genericdocument.IGenericDocumentCameraView.Listener
 
Companion - Static variable in class io.scanbot.sdk.ui.view.genericdocument.IGenericDocumentCameraView.State
 
Companion - Static variable in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView
 
Companion - Static variable in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
Companion - Static variable in interface io.scanbot.sdk.ui.view.genericdocument.list.IGenericDocumentFieldListView.Listener
 
Companion - Static variable in class io.scanbot.sdk.ui.view.genericdocument.list.IGenericDocumentFieldListView.State
 
component1() - Method in class io.scanbot.sdk.ui.view.genericdocument.DocumentRecognitionState
average confidence of all the documents
component1() - Method in class io.scanbot.sdk.ui.view.genericdocument.IGenericDocumentCameraView.State
 
component1() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListPresenter.DocumentScanningFinished
 
component1() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
component1() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.IGenericDocumentFieldListView.State
 
component10() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
component11() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
component12() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
component13() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
component14() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
component15() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
component16() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
component17() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
component18() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
component2() - Method in class io.scanbot.sdk.ui.view.genericdocument.DocumentRecognitionState
current step of the process
component2() - Method in class io.scanbot.sdk.ui.view.genericdocument.IGenericDocumentCameraView.State
 
component2() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
component2() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.IGenericDocumentFieldListView.State
 
component3() - Method in class io.scanbot.sdk.ui.view.genericdocument.DocumentRecognitionState
documents which were already scanned
component3() - Method in class io.scanbot.sdk.ui.view.genericdocument.IGenericDocumentCameraView.State
 
component3() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
component3() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.IGenericDocumentFieldListView.State
 
component4() - Method in class io.scanbot.sdk.ui.view.genericdocument.IGenericDocumentCameraView.State
 
component4() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
component5() - Method in class io.scanbot.sdk.ui.view.genericdocument.IGenericDocumentCameraView.State
 
component5() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
component6() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
component7() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
component8() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
component9() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
Configuration(scanBackSideTitle, scanFrontSideTitle, startScanningTitle, scannedEverythingTitle, confidenceValue, fieldsCountText, imageTitle, noDataTitle, primaryColor, fieldsCountTextColor, fieldConfidenceHighColor, fieldConfidenceModerateColor, fieldConfidenceLowColor, fieldConfidenceTextColor, tipTextColor, tipBackgroundColor, fieldsDisplayMap, documentDisplayMap) - Constructor for class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
Configuration.Companion - Class in io.scanbot.sdk.ui.view.genericdocument.list
 
copy(averageConfidence, step, documents) - Method in class io.scanbot.sdk.ui.view.genericdocument.DocumentRecognitionState
State of the recognition process
copy(cameraOpened, cameraClosed, scanningPaused, cameraPermissionGranted, flash) - Method in class io.scanbot.sdk.ui.view.genericdocument.IGenericDocumentCameraView.State
copy(resultDocumentIds) - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListPresenter.DocumentScanningFinished
Event that user wants to finish the flow of scanning
copy(scanBackSideTitle, scanFrontSideTitle, startScanningTitle, scannedEverythingTitle, confidenceValue, fieldsCountText, imageTitle, noDataTitle, primaryColor, fieldsCountTextColor, fieldConfidenceHighColor, fieldConfidenceModerateColor, fieldConfidenceLowColor, fieldConfidenceTextColor, tipTextColor, tipBackgroundColor, fieldsDisplayMap, documentDisplayMap) - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
copy(documents, scanningStep, averageConfidence) - Method in class io.scanbot.sdk.ui.view.genericdocument.list.IGenericDocumentFieldListView.State
createFragment(scannerConfiguration) - Method in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentRecognizerActivity
Creates an instance of the corresponding fragment
CUSTOM_CONFIGURATION - Static variable in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
 
CUSTOM_CONFIGURATION - Static variable in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentRecognizerActivity
 

D

detailsClosed() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListPresenter
User closed the details screen
detailsClosed() - Method in interface io.scanbot.sdk.ui.view.genericdocument.list.IGenericDocumentFieldListView.Listener
User closed the details screen
detailsOpened() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListPresenter
User opened the details screen
detailsOpened() - Method in interface io.scanbot.sdk.ui.view.genericdocument.list.IGenericDocumentFieldListView.Listener
User opened the details screen
DocumentRecognitionState - Class in io.scanbot.sdk.ui.view.genericdocument
State of the recognition process
DocumentRecognitionState(averageConfidence, step, documents) - Constructor for class io.scanbot.sdk.ui.view.genericdocument.DocumentRecognitionState
State of the recognition process
DocumentRecognitionStep - Enum in io.scanbot.sdk.ui.view.genericdocument
Step of the recognition process
documentRecognizer - Variable in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
 
documentScanned(result) - Method in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentCameraPresenter
User have scanned document
documentScanned(result) - Method in interface io.scanbot.sdk.ui.view.genericdocument.IGenericDocumentCameraView.Listener
User have scanned document
DocumentScanningFinished(resultDocumentIds) - Constructor for class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListPresenter.DocumentScanningFinished
Event that user wants to finish the flow of scanning

E

equals(p) - Method in class io.scanbot.sdk.ui.view.genericdocument.DocumentRecognitionState
 
equals(p) - Method in class io.scanbot.sdk.ui.view.genericdocument.IGenericDocumentCameraView.State
 
equals(p) - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListPresenter.DocumentScanningFinished
 
equals(p) - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
equals(p) - Method in class io.scanbot.sdk.ui.view.genericdocument.list.IGenericDocumentFieldListView.State
 
EXTRACTED_FIELDS_EXTRA - Static variable in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentRecognizerActivity
 

F

fieldListPresenter - Variable in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
 
fieldListView - Variable in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
 
finishWithResult(resultDocumentIds) - Method in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
Delivers scanned document recognition results content to the user
finishWithResult(resultDocumentIds) - Method in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentRecognizerActivity
Delivers scanned document content to the user

G

GENERIC_DOCUMENT_SCANNER_ACCEPTED_SHARPNESS_SCORE - Static variable in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
 
GenericDocumentCameraPresenter - Class in io.scanbot.sdk.ui.view.genericdocument
GenericDocumentCameraPresenter(checkCameraPermissionUseCase, navigator, scanningSession) - Constructor for class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentCameraPresenter
GenericDocumentCameraPresenter.Companion - Class in io.scanbot.sdk.ui.view.genericdocument
 
GenericDocumentCameraView - Class in io.scanbot.sdk.ui.view.genericdocument
Represents camera view for GenericDocumentRecognizer scanner.
GenericDocumentCameraView(context, attrs) - Constructor for class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentCameraView
Represents camera view for GenericDocumentRecognizer scanner.
GenericDocumentCameraView.Companion - Class in io.scanbot.sdk.ui.view.genericdocument
 
GenericDocumentConfigurationHelper - Class in io.scanbot.sdk.ui.view.genericdocument.configuration
Incapsulates the logic of work with configuration for document recognizer view
GenericDocumentConfigurationHelper() - Constructor for class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentConfigurationHelper
Incapsulates the logic of work with configuration for document recognizer view
GenericDocumentConfigurationHelper.Companion - Class in io.scanbot.sdk.ui.view.genericdocument.configuration
 
GenericDocumentFieldListPresenter - Class in io.scanbot.sdk.ui.view.genericdocument.list
GenericDocumentFieldListPresenter(navigator, scanningSession, resultRepository) - Constructor for class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListPresenter
GenericDocumentFieldListPresenter.DocumentScanningFinished - Class in io.scanbot.sdk.ui.view.genericdocument.list
Event that user wants to finish the flow of scanning
GenericDocumentFieldListView - Class in io.scanbot.sdk.ui.view.genericdocument.list
Represents a list of scanned field of the document
GenericDocumentFieldListView(context, attrs) - Constructor for class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView
Represents a list of scanned field of the document
GenericDocumentFieldListView.Companion - Class in io.scanbot.sdk.ui.view.genericdocument.list
 
GenericDocumentFieldListView.Configuration - Class in io.scanbot.sdk.ui.view.genericdocument.list
 
GenericDocumentRecognizerConfiguration - Class in io.scanbot.sdk.ui.view.genericdocument.configuration
Class which is used to configure io.scanbot.sdk.ui.view.genericdocument.GenericDocumentRecognizerActivity Contains settings indicating views Behaviour, Texts and Appearance
GenericDocumentRecognizerConfiguration() - Constructor for class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
Class which is used to configure io.scanbot.sdk.ui.view.genericdocument.GenericDocumentRecognizerActivity Contains settings indicating views Behaviour, Texts and Appearance
GenericDocumentScanningSession - Class in io.scanbot.sdk.ui.view.genericdocument
Provides a wrapper for observing an document scanning result
GenericDocumentScanningSession(genericDocumentRecognizer) - Constructor for class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentScanningSession
Provides a wrapper for observing an document scanning result
GenericDocumentScanningSession.Companion - Class in io.scanbot.sdk.ui.view.genericdocument
 
getAllDocuments() - Method in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentScanningSession
Provides access to the current state
getAverageConfidence() - Method in class io.scanbot.sdk.ui.view.genericdocument.DocumentRecognitionState
average confidence of all the documents
getAverageConfidence() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.IGenericDocumentFieldListView.State
 
getCameraClosed() - Method in class io.scanbot.sdk.ui.view.genericdocument.IGenericDocumentCameraView.State
 
getCameraOpened() - Method in class io.scanbot.sdk.ui.view.genericdocument.IGenericDocumentCameraView.State
 
getCameraPermissionGranted() - Method in class io.scanbot.sdk.ui.view.genericdocument.IGenericDocumentCameraView.State
 
getCameraPresenter() - Method in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
 
getCameraView() - Method in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
 
getCheckCameraPermissionUseCase() - Method in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
 
getCheckCameraPermissionUseCase() - Method in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentCameraPresenter
 
getConfidenceValue() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
getDEFAULT() - Method in class io.scanbot.sdk.ui.view.genericdocument.State.Companion
Default state.
getDEFAULT() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.State.Companion
Default state.
getDocumentDisplayMap() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
getDocumentRecognizer() - Method in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
 
getDocuments() - Method in class io.scanbot.sdk.ui.view.genericdocument.DocumentRecognitionState
documents which were already scanned
getDocuments() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.IGenericDocumentFieldListView.State
 
getFieldConfidenceHighColor() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
getFieldConfidenceLowColor() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
getFieldConfidenceModerateColor() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
getFieldConfidenceTextColor() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
getFieldListPresenter() - Method in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
 
getFieldListView() - Method in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
 
getFieldsCountText() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
getFieldsCountTextColor() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
getFieldsDisplayMap() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
getFlash() - Method in class io.scanbot.sdk.ui.view.genericdocument.IGenericDocumentCameraView.State
 
getGenericDocumentConfiguration() - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
 
getImageTitle() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
getNavigator() - Method in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
 
getNoDataTitle() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
getNULL() - Method in class io.scanbot.sdk.ui.view.genericdocument.Listener.Companion
Null-object pattern.
getNULL() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.Listener.Companion
Null-object pattern.
getPrimaryColor() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
getResultDocumentIds() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListPresenter.DocumentScanningFinished
 
getScanBackSideTitle() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
getScanFrontSideTitle() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
getScannedEverythingTitle() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
getScanningPaused() - Method in class io.scanbot.sdk.ui.view.genericdocument.IGenericDocumentCameraView.State
 
getScanningStep() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.IGenericDocumentFieldListView.State
 
getStartScanningTitle() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
getStep() - Method in class io.scanbot.sdk.ui.view.genericdocument.DocumentRecognitionState
current step of the process
getTipBackgroundColor() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
getTipTextColor() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 

H

handle(result) - Method in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentCameraView
 
hashCode() - Method in class io.scanbot.sdk.ui.view.genericdocument.DocumentRecognitionState
 
hashCode() - Method in class io.scanbot.sdk.ui.view.genericdocument.IGenericDocumentCameraView.State
 
hashCode() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListPresenter.DocumentScanningFinished
 
hashCode() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
hashCode() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.IGenericDocumentFieldListView.State
 
HIGH_CONFIDENCE_VALUE - Static variable in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentScanningSession
 

I

IGenericDocumentCameraView - Interface in io.scanbot.sdk.ui.view.genericdocument
Represents camera screen
IGenericDocumentCameraView.Listener - Interface in io.scanbot.sdk.ui.view.genericdocument
Notified about user interactions.
IGenericDocumentCameraView.State - Class in io.scanbot.sdk.ui.view.genericdocument
IGenericDocumentFieldListView - Interface in io.scanbot.sdk.ui.view.genericdocument.list
Represents list of fields for a scanned document
IGenericDocumentFieldListView.Listener - Interface in io.scanbot.sdk.ui.view.genericdocument.list
Notified about user interactions.
IGenericDocumentFieldListView.State - Class in io.scanbot.sdk.ui.view.genericdocument.list
io.scanbot.sdk.ui.view.genericdocument - package io.scanbot.sdk.ui.view.genericdocument
 
io.scanbot.sdk.ui.view.genericdocument.configuration - package io.scanbot.sdk.ui.view.genericdocument.configuration
 
io.scanbot.sdk.ui.view.genericdocument.list - package io.scanbot.sdk.ui.view.genericdocument.list
 

L

Listener.Companion - Class in io.scanbot.sdk.ui.view.genericdocument
 
Listener.Companion - Class in io.scanbot.sdk.ui.view.genericdocument.list
 

M

MODERATE_CONFIDENCE_VALUE - Static variable in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentScanningSession
 

N

NAVIGATE_CAMERA_PERMISSION_SETTINGS - Static variable in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentCameraPresenter
 
NAVIGATE_CANCEL_LICENSE_INVALID - Static variable in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentCameraPresenter
 
NAVIGATE_CANCEL_SNAPPING - Static variable in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentCameraPresenter
 
NAVIGATE_REQUEST_CAMERA_PERMISSION - Static variable in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentCameraPresenter
 

O

observeDocumentRecognitionResults() - Method in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentScanningSession
Observes newly processed document
observeScanningPausedState() - Method in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentScanningSession
Observes the paused state of the session
observeScanReadyState() - Method in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentScanningSession
Observes the state of document scanning
onActivateCameraPermission() - Method in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentCameraPresenter
User wants to activate camera permission
onActivateCameraPermission() - Method in interface io.scanbot.sdk.ui.view.genericdocument.IGenericDocumentCameraView.Listener
User wants to activate camera permission
onBackPressed() - Method in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
 
onBackPressed() - Method in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentRecognizerActivity
 
onBackPressed() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView
Processing back press and collapsing bottom sheet if needed
onCameraOpened() - Method in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentCameraPresenter
Camera has been opened
onCameraOpened() - Method in interface io.scanbot.sdk.ui.view.genericdocument.IGenericDocumentCameraView.Listener
Camera has been opened
onCancelClicked() - Method in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentCameraPresenter
User wants to cancel snapping
onCancelClicked() - Method in interface io.scanbot.sdk.ui.view.genericdocument.IGenericDocumentCameraView.Listener
User wants to cancel snapping
onCancelScanning() - Method in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentRecognizerActivity
User wants to cancel scanning
onCancelScanninLicenseInvalid() - Method in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentRecognizerActivity
Scanning is canceled because of the invalid license
onCreate(savedInstanceState) - Method in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
 
onCreate(savedInstanceState) - Method in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentRecognizerActivity
 
onCreateView(inflater, container, savedInstanceState) - Method in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
 
onDetachedFromWindow() - Method in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentCameraView
 
onDetachedFromWindow() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView
 
onFlashClicked() - Method in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentCameraPresenter
User wants to change flash mode
onFlashClicked() - Method in interface io.scanbot.sdk.ui.view.genericdocument.IGenericDocumentCameraView.Listener
User wants to change flash mode
onRequestPermissionsResult(requestCode, permissions, grantResults) - Method in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
 
onStart() - Method in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
 
onStop() - Method in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
 

P

PACKAGE_SCHEME - Static variable in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentRecognizerActivity
 
pause() - Method in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentCameraPresenter
 
pause() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListPresenter
 
PERMISSIONS_REQUEST_CAMERA - Static variable in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
 
prepareDefault(context) - Method in class io.scanbot.sdk.ui.view.genericdocument.list.Configuration.Companion
 
pushNewDocumentRecognitionResult(result) - Method in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentScanningSession
Notifies about the event of document scanning
pushScanningPausedState(opened) - Method in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentScanningSession
Notifies about the event of pausing the session
pushScanReadyState(ready) - Method in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentScanningSession
Notifies about the event of scanning state

R

requestCameraPermission() - Method in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
 
requestCameraPermission() - Method in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentRecognizerActivity
User want to request camera permission
RESULT_LICENSE_INVALID - Static variable in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentRecognizerActivity
 
resume(view) - Method in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentCameraPresenter
 
resume(view) - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListPresenter
 

S

setAcceptedDocumentTypes(documentTypes) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
Accepted document types. All other document types will be ignored.
setAcceptedDocumentTypes(documentTypes) - Method in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentCameraView
Accepted document types. All other document types will be ignored.
setBottomSheetBackgroundColor(color) - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView
Sets a color of the bottom sheet
setBottomSheetPrimaryColor(color) - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView
Sets primary color for most of text's and other UI elements of the bottom sheet
setCameraModule(cameraModule) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
Set supported camera module: CameraModule.BACK, CameraModule.FRONT or others. Optional. By default is CameraModule.BACK.
setCameraModule(cameraModule) - Method in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentCameraView
Set camera module
setCameraModule(cameraModule) - Method in interface io.scanbot.sdk.ui.view.genericdocument.IGenericDocumentCameraView
Set camera module
setCameraOrientationMode(cameraOrientationMode) - Method in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentCameraView
Sets camera orientation mode
setCameraOrientationMode(cameraOrientationMode) - Method in interface io.scanbot.sdk.ui.view.genericdocument.IGenericDocumentCameraView
Sets camera orientation mode
setCameraOverlayColor(cameraOverlayColor) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
Background color outside of the finder window.
setCameraPresenter(p) - Method in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
 
setCameraView(p) - Method in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
 
setCancelButtonTitle(cancelButtonTitle) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
Title of the cancel button.
setCheckCameraPermissionUseCase(p) - Method in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
 
setCheckCameraPermissionUseCase(p) - Method in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentCameraPresenter
 
setClearButtonTitle(clearButtonTitle) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
Text of the button which clears the list of scanned fields.
setConfidenceValue(text) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
String that shows average confidence value of scanned document. Use %d as number formatting symbol.
setConfidenceValue(p) - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
setConfiguration(map) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentConfigurationHelper
 
setDetailsActionColor(color) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
The color of Submit button
setDetailsBackgroundColor(color) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
The color of bottom sheet
setDetailsPrimaryColor(color) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
The color of text elements in bottom sheet
setDocumentDisplayConfiguration(configuration) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
Allows to configure the display configuration for documents.
setDocumentRecognizer(p) - Method in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
 
setDocumentRecognizer(recognizer) - Method in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentCameraView
Sets instance of generic document recognizer to be used for this view
setEnableCameraButtonTitle(enableCameraButtonTitle) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
Title of the button that opens the screen where the user can allow the usage of the camera by the app.
setEnableCameraExplanationText(enableCameraExplanationText) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
setFieldConfidenceHighColor(color) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
Color of confidence value label background in details screen, when the field confidence level is high.
setFieldConfidenceHighColor(p) - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
setFieldConfidenceLowColor(color) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
Color of confidence value label background in details screen, when the field confidence level is low.
setFieldConfidenceLowColor(p) - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
setFieldConfidenceModerateColor(color) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
Color of confidence value label background in details screen, when the field confidence level is moderate.
setFieldConfidenceModerateColor(p) - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
setFieldConfidenceTextColor(color) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
Color of confidence value label text in details.
setFieldConfidenceTextColor(p) - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
setFieldListPresenter(p) - Method in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
 
setFieldListView(p) - Method in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
 
setFieldsCountText(text) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
String used for displaying amount of detected fields. Use %d for number formatting symbol.
setFieldsCountText(p) - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
setFieldsCountTextColor(color) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
Text color of the fields count label.
setFieldsCountTextColor(p) - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
setFieldsDisplayConfiguration(configuration) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
Allows to configure the display configuration for fields.
setFinderLineColor(finderLineColor) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
Color of the finder window's outline.
setFinderLineWidth(finderLineWidth) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
Thickness of the finder window's outline.
setFlashEnabled(flashEnabled) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
Controls whether the flash should be initially enabled. The default value is FALSE.
setFlashEnabled(flashEnabled) - Method in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentCameraPresenter
Enables/Disables flash
setImageTitle(text) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
A title to show image content.
setImageTitle(p) - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
setListener(listener) - Method in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentCameraView
 
setListener(listener) - Method in interface io.scanbot.sdk.ui.view.genericdocument.IGenericDocumentCameraView
 
setListener(listener) - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView
 
setListener(listener) - Method in interface io.scanbot.sdk.ui.view.genericdocument.list.IGenericDocumentFieldListView
 
setNoDataTitle(text) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
String that notifies that nothing was scanned yet.
setNoDataTitle(p) - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
setOrientationLockMode(cameraOrientationMode) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
Orientation lock mode of the camera: PORTRAIT or LANDSCAPE. By default the camera orientation is not locked.
setPrimaryColor(p) - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
setSavePhotoImageAllowed(allowed) - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListPresenter
Enables/Disables saving of the photo image in sdk storage
setSaveSignatureImageAllowed(allowed) - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListPresenter
Enables/Disables saving of the signature image in sdk storage
setScanBackSideTitle(text) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
String that asks user to scan back side of a document.
setScanBackSideTitle(p) - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
setScanFrontSideTitle(text) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
String that asks user to scan front side of a document.
setScanFrontSideTitle(p) - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
setScannedEverythingTitle(text) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
String that notifies that both sides of document are scanned.
setScannedEverythingTitle(p) - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
setSharpnessAcceptanceFactor(sharpnessAcceptanceFactor) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
Accepted minimal sharpness score. Images with a score less than that will be rejected with RecognitionStatus::ErrorTooBlurry.
setSharpnessAcceptanceFactor(sharpnessAcceptanceFactor) - Method in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentCameraView
Accepted minimal sharpness score. Images with a score less than that will be rejected with RecognitionStatus::ErrorTooBlurry.
setShouldSavePhotoImageInStorage(shouldSave) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
Defines, if photo image should be stored in internal storage on disk.
setShouldSaveSignatureImageInStorage(shouldSave) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
Defines, if signature image should be stored in internal storage on disk.
setStartScanningTitle(text) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
String that asks user to start scanning a document.
setStartScanningTitle(p) - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
setSubmitButtonTitle(submitButtonTitle) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
Text of the button which finishes the flow
setTipBackgroundColor(color) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
Color of tip background on scanning screen.
setTipBackgroundColor(p) - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
setTipTextColor(color) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
Color of tip text on scanning screen.
setTipTextColor(p) - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
setTopBarBackgroundColor(topBarBackgroundColor) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
Background color of the top toolbar.
setTopBarButtonsColor(topBarButtonsColor) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
Color of the titles of all buttons in the top toolbar.
setTopBarButtonsInactiveColor(topBarButtonsInactiveColor) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
Color of the titles of all buttons in the top toolbar.
setUseButtonsAllCaps(allCaps) - Method in class io.scanbot.sdk.ui.view.genericdocument.configuration.GenericDocumentRecognizerConfiguration
Controls whether buttons should use all capitals style
State(cameraOpened, cameraClosed, scanningPaused, cameraPermissionGranted, flash) - Constructor for class io.scanbot.sdk.ui.view.genericdocument.IGenericDocumentCameraView.State
State() - Constructor for class io.scanbot.sdk.ui.view.genericdocument.IGenericDocumentCameraView.State
State(documents, scanningStep, averageConfidence) - Constructor for class io.scanbot.sdk.ui.view.genericdocument.list.IGenericDocumentFieldListView.State
State() - Constructor for class io.scanbot.sdk.ui.view.genericdocument.list.IGenericDocumentFieldListView.State
State.Companion - Class in io.scanbot.sdk.ui.view.genericdocument
 
State.Companion - Class in io.scanbot.sdk.ui.view.genericdocument.list
 
submitButtonClick() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListPresenter
User wants to finish the flow
submitButtonClick() - Method in interface io.scanbot.sdk.ui.view.genericdocument.list.IGenericDocumentFieldListView.Listener
User wants to finish the flow

T

TAG - Static variable in class io.scanbot.sdk.ui.view.genericdocument.BaseGenericDocumentCameraFragment
 
toString() - Method in class io.scanbot.sdk.ui.view.genericdocument.DocumentRecognitionState
 
toString() - Method in class io.scanbot.sdk.ui.view.genericdocument.IGenericDocumentCameraView.State
 
toString() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListPresenter.DocumentScanningFinished
 
toString() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView.Configuration
 
toString() - Method in class io.scanbot.sdk.ui.view.genericdocument.list.IGenericDocumentFieldListView.State
 

U

updateState(newState) - Method in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentCameraView
 
updateState(newState) - Method in class io.scanbot.sdk.ui.view.genericdocument.list.GenericDocumentFieldListView
 

Z

ZERO_CONFIDENCE_VALUE - Static variable in class io.scanbot.sdk.ui.view.genericdocument.GenericDocumentScanningSession
 
B C D E F G H I L M N O P R S T U Z 
Skip navigation links