Package com.incode.welcome_sdk.modules
Class DocumentScan
-
- All Implemented Interfaces:
public final class DocumentScan extends BaseModule
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enumDocumentScan.DocumentSourceSubmission methods the end user can choose from on the V2 chooser screen.
public final classDocumentScan.Builder
-
Field Summary
Fields Modifier and Type Field Description public final static Set<DocumentScan.DocumentSource>DEFAULT_DOCUMENT_SOURCESprivate final Set<DocumentScan.DocumentSource>documentSourcesprivate final DocumentTypedocumentTypeprivate BooleanisShowTutorialsprivate BooleanisWaitForTutorialsprivate BooleanisShowDocumentProviderOptionsprivate BooleanisAllowSkipDocumentCaptureprivate final Modulesnameprivate final BooleanisNonUiMode
-
Constructor Summary
Constructors Constructor Description DocumentScan(DocumentType documentType)This method of initializing modules is deprecated. DocumentScan(DocumentType documentType, Boolean isShowTutorials, Boolean isWaitForTutorials, Boolean isShowDocumentProviderOptions, Boolean isAllowSkipDocumentCapture)
-
Method Summary
Modifier and Type Method Description final Set<DocumentScan.DocumentSource>getDocumentSources()Submission methods the chooser offers to the end user, as configured via Builder.setDocumentSources. final DocumentTypegetDocumentType()final BooleanisShowTutorials()final UnitsetShowTutorials(Boolean isShowTutorials)final BooleanisWaitForTutorials()final UnitsetWaitForTutorials(Boolean isWaitForTutorials)final BooleanisShowDocumentProviderOptions()final UnitsetShowDocumentProviderOptions(Boolean isShowDocumentProviderOptions)final BooleanisAllowSkipDocumentCapture()final UnitsetAllowSkipDocumentCapture(Boolean isAllowSkipDocumentCapture)UnitverifyConfiguration(List<Modules> modules)-
-
Constructor Detail
-
DocumentScan
DocumentScan(DocumentType documentType)
This method of initializing modules is deprecated.- Parameters:
documentType- One of supported document types:DocumentType.ADDRESS_STATEMENT
DocumentType.MEDICAL_DOC
DocumentType.OTHER_DOCUMENT_1
DocumentType.OTHER_DOCUMENT_2
DocumentType.OTHER_DOCUMENT_3
-
DocumentScan
DocumentScan(DocumentType documentType, Boolean isShowTutorials, Boolean isWaitForTutorials, Boolean isShowDocumentProviderOptions, Boolean isAllowSkipDocumentCapture)
-
-
Method Detail
-
getDocumentSources
final Set<DocumentScan.DocumentSource> getDocumentSources()
Submission methods the chooser offers to the end user, as configured via Builder.setDocumentSources. Defaults to DEFAULT_DOCUMENT_SOURCES (all three of DocumentSource.CAMERA, DocumentSource.FILE_UPLOAD, DocumentSource.IMAGE_UPLOAD).
Honored by both V1 and V2. In V1 it refines the provider options chooser shown via Builder.setShowDocumentProviderOptions; when that chooser is disabled, V1 remains camera-only.
-
getDocumentType
final DocumentType getDocumentType()
-
isShowTutorials
final Boolean isShowTutorials()
-
setShowTutorials
final Unit setShowTutorials(Boolean isShowTutorials)
-
isWaitForTutorials
final Boolean isWaitForTutorials()
-
setWaitForTutorials
final Unit setWaitForTutorials(Boolean isWaitForTutorials)
-
isShowDocumentProviderOptions
final Boolean isShowDocumentProviderOptions()
-
setShowDocumentProviderOptions
final Unit setShowDocumentProviderOptions(Boolean isShowDocumentProviderOptions)
-
isAllowSkipDocumentCapture
final Boolean isAllowSkipDocumentCapture()
-
setAllowSkipDocumentCapture
final Unit setAllowSkipDocumentCapture(Boolean isAllowSkipDocumentCapture)
-
verifyConfiguration
Unit verifyConfiguration(List<Modules> modules)
-
-
-
-