public class IdCardScannerConfiguration
Class which is used to configure io.scanbot.sdk.ui.view.idcard.IdCardScannerActivity Contains settings indicating views Behaviour, Texts and Appearance
public IdCardScannerConfiguration()
Class which is used to configure io.scanbot.sdk.ui.view.idcard.IdCardScannerActivity Contains settings indicating views Behaviour, Texts and Appearance
@NotNull public java.util.Map<java.lang.String,java.io.Serializable> getIdCardCameraConfiguration()
public void setFlashEnabled(boolean flashEnabled)
Controls whether the flash should be initially enabled. The default value is FALSE.
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.
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.
public void setTopBarBackgroundColor(int topBarBackgroundColor)
Background color of the top toolbar.
public void setTopBarButtonsColor(int topBarButtonsColor)
Color of the titles of all buttons in the top toolbar.
public void setTopBarButtonsInactiveColor(int topBarButtonsInactiveColor)
Color of the titles of all buttons in the top toolbar.
public void setCameraOverlayColor(int cameraOverlayColor)
Background color outside of the finder window.
public void setFinderLineWidth(int finderLineWidth)
Thickness of the finder window's outline.
public void setFinderLineColor(int finderLineColor)
Color of the finder window's outline.
public void setCancelButtonTitle(@NotNull
java.lang.String cancelButtonTitle)
Title of the cancel button.
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.
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.
public void setClearButtonTitle(@NotNull
java.lang.String clearButtonTitle)
Text of the button which clears the list of scanned fields.
public void setSubmitButtonTitle(@NotNull
java.lang.String submitButtonTitle)
Text of the button which finishes the flow
public void setDetailsBackgroundColor(int color)
The color of bottom sheet
public void setDetailsPrimaryColor(int color)
The color of text elements in bottom sheet
public void setDetailsActionColor(int color)
The color of Submit button
public void setFieldsCountTextColor(int color)
Text color of the fields count label.
public void setFieldConfidenceHighColor(int color)
Color of confidence value label background in details screen, when the field confidence level is high.
public void setFieldConfidenceModerateColor(int color)
Color of confidence value label background in details screen, when the field confidence level is moderate.
public void setFieldConfidenceLowColor(int color)
Color of confidence value label background in details screen, when the field confidence level is low.
public void setFieldConfidenceTextColor(int color)
Color of confidence value label text in details.
public void setTipTextColor(int color)
Color of tip text on scanning screen.
public void setTipBackgroundColor(int color)
Color of tip background on scanning screen.
public void setFieldsCountText(@NotNull
java.lang.String text)
String used for displaying amount of detected fields. Use %d for number formatting symbol.
public void setConfidenceValue(@NotNull
java.lang.String text)
String that shows average confidence value of scanned card. Use %d as number formatting symbol.
public void setScanBackSideTitle(@NotNull
java.lang.String text)
String that asks user to scan back side of a card.
public void setScanFrontSideTitle(@NotNull
java.lang.String text)
String that asks user to scan front side of a card.
public void setStartScanningTitle(@NotNull
java.lang.String text)
String that asks user to start scanning a card.
public void setScannedEverythingTitle(@NotNull
java.lang.String text)
String that notifies that both sides of card are scanned.
public void setImageTitle(@NotNull
java.lang.String text)
A title to show image content.
public void setNoDataTitle(@NotNull
java.lang.String text)
String that notifies that nothing was scanned yet.
public void setFieldIssueDateTitle(@NotNull
java.lang.String text)
A title for issuing date field in details screen.
public void setFieldHeightTitle(@NotNull
java.lang.String text)
A title for height field in details screen.
public void setFieldEyeColorTitle(@NotNull
java.lang.String text)
A title for eye color field in details screen.
public void setFieldPINTitle(@NotNull
java.lang.String text)
A title for PIN field in details screen.
public void setFieldExpiryDateTitle(@NotNull
java.lang.String text)
A title for expiry date field in details screen.
public void setFieldBirthPlaceTitle(@NotNull
java.lang.String text)
A title for birth place field in details screen.
public void setFieldNationalityTitle(@NotNull
java.lang.String text)
A title for nationality field in details screen.
public void setFieldBirthDateTitle(@NotNull
java.lang.String text)
A title for birth date field in details screen.
public void setFieldMaidenNameTitle(@NotNull
java.lang.String text)
A title for maiden name field in details screen.
public void setFieldGivenNamesTitle(@NotNull
java.lang.String text)
A title for given names field in details screen.
public void setFieldSurnameTitle(@NotNull
java.lang.String text)
A title for surname field in details screen.
public void setFieldIDTitle(@NotNull
java.lang.String text)
A title for id field in details screen.
public void setFieldIssuingAuthorityTitle(@NotNull
java.lang.String text)
A title for issuing authority field in details screen.
public void setFieldAddressTitle(@NotNull
java.lang.String text)
A title for address field in details screen.
public void setFieldPseudonymTitle(@NotNull
java.lang.String text)
A title for pseudonym field in details screen.
public void setFieldMRZTitle(@NotNull
java.lang.String text)
A title for machine readable zone field in details screen.
public void setFieldSignatureTitle(@NotNull
java.lang.String text)
A title for signature field in details screen.
public void setFieldPhotoTitle(@NotNull
java.lang.String text)
A title for photo field in details screen.
public void setFieldGenderTitle(@NotNull
java.lang.String text)
A title for gender field in details screen.
public void setCountryCodeTitle(@NotNull
java.lang.String text)
A title for country code in details screen.
public void setPassportTypeTitle(@NotNull
java.lang.String text)
A title for passport type in details screen.
public void setShouldSavePhotoImageInStorage(boolean shouldSave)
Defines, if photo image should be stored in internal storage on disk.
public void setShouldSaveSignatureImageInStorage(boolean shouldSave)
Defines, if signature image should be stored in internal storage on disk.
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.
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.
public void setUseButtonsAllCaps(boolean allCaps)
Controls whether buttons should use all capitals style