io.scanbot.sdk.ui.view.idcard.configuration

Class IdCardScannerConfiguration

io.scanbot.sdk.ui.view.idcard.configuration.IdCardScannerConfiguration

public class IdCardScannerConfiguration

Class which is used to configure io.scanbot.sdk.ui.view.idcard.IdCardScannerActivity Contains settings indicating views Behaviour, Texts and Appearance

See Also:

io.scanbot.sdk.ui.view.idcard.IdCardScannerActivity

Constructor Detail

IdCardScannerConfiguration

public IdCardScannerConfiguration()

Class which is used to configure io.scanbot.sdk.ui.view.idcard.IdCardScannerActivity Contains settings indicating views Behaviour, Texts and Appearance

See Also:

io.scanbot.sdk.ui.view.idcard.IdCardScannerActivity

Method Detail

getIdCardCameraConfiguration

@NotNull
public java.util.Map<java.lang.String,java.io.Serializable> getIdCardCameraConfiguration()

setFlashEnabled

public void setFlashEnabled(boolean flashEnabled)

Controls whether the flash should be initially enabled. The default value is FALSE.

setOrientationLockMode

public void setOrientationLockMode(@NotNull
                                   io.scanbot.sdk.ui.view.base.configuration.CameraOrientationMode cameraOrientationMode)

Orientation lock mode of the camera: PORTRAIT or LANDSCAPE. By default the camera orientation is not locked.

setCameraModule

public void setCameraModule(@NotNull
                            io.scanbot.sdk.camera.CameraModule cameraModule)

Set supported camera module: CameraModule.BACK, CameraModule.FRONT or others. Optional. By default is CameraModule.BACK.

setTopBarBackgroundColor

public void setTopBarBackgroundColor(int topBarBackgroundColor)

Background color of the top toolbar.

setTopBarButtonsColor

public void setTopBarButtonsColor(int topBarButtonsColor)

Color of the titles of all buttons in the top toolbar.

setTopBarButtonsInactiveColor

public void setTopBarButtonsInactiveColor(int topBarButtonsInactiveColor)

Color of the titles of all buttons in the top toolbar.

setCameraOverlayColor

public void setCameraOverlayColor(int cameraOverlayColor)

Background color outside of the finder window.

setFinderLineWidth

public void setFinderLineWidth(int finderLineWidth)

Thickness of the finder window's outline.

setFinderLineColor

public void setFinderLineColor(int finderLineColor)

Color of the finder window's outline.

setCancelButtonTitle

public void setCancelButtonTitle(@NotNull
                                 java.lang.String cancelButtonTitle)

Title of the cancel button.

setEnableCameraExplanationText

public void setEnableCameraExplanationText(@NotNull
                                           java.lang.String enableCameraExplanationText)

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.

setEnableCameraButtonTitle

public void setEnableCameraButtonTitle(@NotNull
                                       java.lang.String enableCameraButtonTitle)

Title of the button that opens the screen where the user can allow the usage of the camera by the app.

setClearButtonTitle

public void setClearButtonTitle(@NotNull
                                java.lang.String clearButtonTitle)

Text of the button which clears the list of scanned fields.

setSubmitButtonTitle

public void setSubmitButtonTitle(@NotNull
                                 java.lang.String submitButtonTitle)

Text of the button which finishes the flow

setDetailsBackgroundColor

public void setDetailsBackgroundColor(int color)

The color of bottom sheet

setDetailsPrimaryColor

public void setDetailsPrimaryColor(int color)

The color of text elements in bottom sheet

setDetailsActionColor

public void setDetailsActionColor(int color)

The color of Submit button

setFieldsCountTextColor

public void setFieldsCountTextColor(int color)

Text color of the fields count label.

setFieldConfidenceHighColor

public void setFieldConfidenceHighColor(int color)

Color of confidence value label background in details screen, when the field confidence level is high.

setFieldConfidenceModerateColor

public void setFieldConfidenceModerateColor(int color)

Color of confidence value label background in details screen, when the field confidence level is moderate.

setFieldConfidenceLowColor

public void setFieldConfidenceLowColor(int color)

Color of confidence value label background in details screen, when the field confidence level is low.

setFieldConfidenceTextColor

public void setFieldConfidenceTextColor(int color)

Color of confidence value label text in details.

setTipTextColor

public void setTipTextColor(int color)

Color of tip text on scanning screen.

setTipBackgroundColor

public void setTipBackgroundColor(int color)

Color of tip background on scanning screen.

setFieldsCountText

public void setFieldsCountText(@NotNull
                               java.lang.String text)

String used for displaying amount of detected fields. Use %d for number formatting symbol.

setConfidenceValue

public void setConfidenceValue(@NotNull
                               java.lang.String text)

String that shows average confidence value of scanned card. Use %d as number formatting symbol.

setScanBackSideTitle

public void setScanBackSideTitle(@NotNull
                                 java.lang.String text)

String that asks user to scan back side of a card.

setScanFrontSideTitle

public void setScanFrontSideTitle(@NotNull
                                  java.lang.String text)

String that asks user to scan front side of a card.

setStartScanningTitle

public void setStartScanningTitle(@NotNull
                                  java.lang.String text)

String that asks user to start scanning a card.

setScannedEverythingTitle

public void setScannedEverythingTitle(@NotNull
                                      java.lang.String text)

String that notifies that both sides of card are scanned.

setImageTitle

public void setImageTitle(@NotNull
                          java.lang.String text)

A title to show image content.

setNoDataTitle

public void setNoDataTitle(@NotNull
                           java.lang.String text)

String that notifies that nothing was scanned yet.

setFieldIssueDateTitle

public void setFieldIssueDateTitle(@NotNull
                                   java.lang.String text)

A title for issuing date field in details screen.

setFieldHeightTitle

public void setFieldHeightTitle(@NotNull
                                java.lang.String text)

A title for height field in details screen.

setFieldEyeColorTitle

public void setFieldEyeColorTitle(@NotNull
                                  java.lang.String text)

A title for eye color field in details screen.

setFieldPINTitle

public void setFieldPINTitle(@NotNull
                             java.lang.String text)

A title for PIN field in details screen.

setFieldExpiryDateTitle

public void setFieldExpiryDateTitle(@NotNull
                                    java.lang.String text)

A title for expiry date field in details screen.

setFieldBirthPlaceTitle

public void setFieldBirthPlaceTitle(@NotNull
                                    java.lang.String text)

A title for birth place field in details screen.

setFieldNationalityTitle

public void setFieldNationalityTitle(@NotNull
                                     java.lang.String text)

A title for nationality field in details screen.

setFieldBirthDateTitle

public void setFieldBirthDateTitle(@NotNull
                                   java.lang.String text)

A title for birth date field in details screen.

setFieldMaidenNameTitle

public void setFieldMaidenNameTitle(@NotNull
                                    java.lang.String text)

A title for maiden name field in details screen.

setFieldGivenNamesTitle

public void setFieldGivenNamesTitle(@NotNull
                                    java.lang.String text)

A title for given names field in details screen.

setFieldSurnameTitle

public void setFieldSurnameTitle(@NotNull
                                 java.lang.String text)

A title for surname field in details screen.

setFieldIDTitle

public void setFieldIDTitle(@NotNull
                            java.lang.String text)

A title for id field in details screen.

setFieldIssuingAuthorityTitle

public void setFieldIssuingAuthorityTitle(@NotNull
                                          java.lang.String text)

A title for issuing authority field in details screen.

setFieldAddressTitle

public void setFieldAddressTitle(@NotNull
                                 java.lang.String text)

A title for address field in details screen.

setFieldPseudonymTitle

public void setFieldPseudonymTitle(@NotNull
                                   java.lang.String text)

A title for pseudonym field in details screen.

setFieldMRZTitle

public void setFieldMRZTitle(@NotNull
                             java.lang.String text)

A title for machine readable zone field in details screen.

setFieldSignatureTitle

public void setFieldSignatureTitle(@NotNull
                                   java.lang.String text)

A title for signature field in details screen.

setFieldPhotoTitle

public void setFieldPhotoTitle(@NotNull
                               java.lang.String text)

A title for photo field in details screen.

setFieldGenderTitle

public void setFieldGenderTitle(@NotNull
                                java.lang.String text)

A title for gender field in details screen.

setCountryCodeTitle

public void setCountryCodeTitle(@NotNull
                                java.lang.String text)

A title for country code in details screen.

setPassportTypeTitle

public void setPassportTypeTitle(@NotNull
                                 java.lang.String text)

A title for passport type in details screen.

setShouldSavePhotoImageInStorage

public void setShouldSavePhotoImageInStorage(boolean shouldSave)

Defines, if photo image should be stored in internal storage on disk.

setShouldSaveSignatureImageInStorage

public void setShouldSaveSignatureImageInStorage(boolean shouldSave)

Defines, if signature image should be stored in internal storage on disk.

setAcceptedDocumentTypes

public void setAcceptedDocumentTypes(@NotNull
                                     java.util.ArrayList<io.scanbot.sdk.idcardscanner.IdScanResult.DocumentType> documentTypes)

Accepted document types. All other document types will be ignored.

By default - IdScanResult.DocumentType.DEFAULT_TYPES.

setSharpnessAcceptanceFactor

public void setSharpnessAcceptanceFactor(float sharpnessAcceptanceFactor)

Accepted minimal sharpness score. Images with a score less than that will be rejected with RecognitionStatus::ErrorTooBlurry.

Default is 80

0 - any image will be accepted. 80 - a good compromise; the recommended setting. 100 - only very sharp images will be accepted.

setUseButtonsAllCaps

public void setUseButtonsAllCaps(boolean allCaps)

Controls whether buttons should use all capitals style