Class MedicalCertificateScannerConfiguration
-
- All Implemented Interfaces:
public final class MedicalCertificateScannerConfigurationClass which is used to configure MedicalCertificateScannerActivity. Contains settings indicating views Behaviour, Texts and Appearance.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classMedicalCertificateScannerConfiguration.Companion
-
Field Summary
Fields Modifier and Type Field Description private final MedicalCertificateScannerJsonConfigurationparamsprivate final MedicalCertificateScannerNativeConfigurationnativeParamspublic final static MedicalCertificateScannerConfiguration.CompanionCompanion
-
Constructor Summary
Constructors Constructor Description MedicalCertificateScannerConfiguration()
-
Method Summary
Modifier and Type Method Description final MedicalCertificateScannerJsonConfigurationgetParams()final MedicalCertificateScannerNativeConfigurationgetNativeParams()final UnitsetFlashEnabled(Boolean flashEnabled)Controls whether the flash should be initially enabled. final UnitsetOrientationLockMode(CameraOrientationMode cameraOrientationMode)Orientation lock mode of the camera: CameraOrientationMode.PORTRAIT or CameraOrientationMode.LANDSCAPE. final UnitsetCameraModule(CameraModule cameraModule)Set supported camera module: CameraModule.BACK, CameraModule.FRONT or others. final UnitsetCameraPreviewMode(CameraPreviewMode cameraPreviewMode)Preview mode of the camera: CameraPreviewMode.FIT_IN or CameraPreviewMode.FIT_IN. final UnitsetTopBarBackgroundColor(Integer topBarBackgroundColor)Background color of the top toolbar. final UnitsetTopBarButtonsColor(Integer topBarButtonsColor)Color of the titles of all buttons in the top toolbar. final UnitsetTopBarButtonsInactiveColor(Integer topBarButtonsInactiveColor)Color of the titles of all buttons in the top toolbar. final UnitsetCancelButtonTitle(String cancelButtonTitle)Title of the cancel button. final UnitsetEnableCameraExplanationText(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. final UnitsetEnableCameraButtonTitle(String enableCameraButtonTitle)Title of the button that opens the screen where the user can allow the usage of the camera by the app. final UnitsetUseButtonsAllCaps(Boolean allCaps)Controls whether buttons should use all capitals style. final UnitsetScanPatientInfo(Boolean isEnabled)Whether sdk should run scanning of Patient Information block. final UnitsetReturnCroppedDocumentImage(Boolean isEnabled)Whether sdk should return cropped document image or not final UnitsetCameraOverlayColor(Integer cameraOverlayColor)Background color outside of the finder window. final UnitsetFinderLineWidth(Integer finderLineWidth)Thickness of the finder window's outline in Px. final UnitsetFinderLineColor(Integer finderLineColor)Color of the finder window's outline. final UnitsetShowFinderOverlay(Boolean show)Option to show or hide finder overlay. final UnitsetUserGuidanceBackgroundColor(Integer userGuidanceBackgroundColor)The background color of the user guidance hints. final UnitsetUserGuidanceTextColor(Integer userGuidanceTextColor)The text color of the user guidance hints. final UnitsetUserGuidanceStrings(String cameraOpen, String scanning, String capturing, String processing)Configuration that helps to override default hint values. final UnitsetErrorDialogTitle(String title)Error dialog title. final UnitsetErrorDialogMessage(String message)Error dialog message. final UnitsetErrorDialogOkButtonTitle(String title)Error dialog ok button text. final UnitsetErrorDialogAccentColor(Integer dialogAccentColor)The accent color of buttons on a error dialog. final UnitsetErrorDialogOkButtonFilled(Boolean buttonFilled)Allows to set if the confirm button should be filled. final UnitsetErrorDialogOkButtonFilledTextColor(Integer textColor)Allows to set a text color of the filled button. final UnitsetTouchToFocusEnabled(Boolean enabled)Controls whether the touch to focus feature should be enabled. -
-
Method Detail
-
getParams
final MedicalCertificateScannerJsonConfiguration getParams()
-
getNativeParams
final MedicalCertificateScannerNativeConfiguration getNativeParams()
-
setFlashEnabled
final Unit setFlashEnabled(Boolean flashEnabled)
Controls whether the flash should be initially enabled. The default value is FALSE.
-
setOrientationLockMode
final Unit setOrientationLockMode(CameraOrientationMode cameraOrientationMode)
Orientation lock mode of the camera: CameraOrientationMode.PORTRAIT or CameraOrientationMode.LANDSCAPE. By default the camera orientation is not locked.
-
setCameraModule
final Unit setCameraModule(CameraModule cameraModule)
Set supported camera module: CameraModule.BACK, CameraModule.FRONT or others. Optional. By default is CameraModule.BACK.
-
setCameraPreviewMode
final Unit setCameraPreviewMode(CameraPreviewMode cameraPreviewMode)
Preview mode of the camera: CameraPreviewMode.FIT_IN or CameraPreviewMode.FIT_IN. Optional, default is CameraPreviewMode.FILL_IN.
-
setTopBarBackgroundColor
final Unit setTopBarBackgroundColor(Integer topBarBackgroundColor)
Background color of the top toolbar.
-
setTopBarButtonsColor
final Unit setTopBarButtonsColor(Integer topBarButtonsColor)
Color of the titles of all buttons in the top toolbar.
-
setTopBarButtonsInactiveColor
final Unit setTopBarButtonsInactiveColor(Integer topBarButtonsInactiveColor)
Color of the titles of all buttons in the top toolbar.
-
setCancelButtonTitle
final Unit setCancelButtonTitle(String cancelButtonTitle)
Title of the cancel button.
-
setEnableCameraExplanationText
final Unit setEnableCameraExplanationText(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
final Unit setEnableCameraButtonTitle(String enableCameraButtonTitle)
Title of the button that opens the screen where the user can allow the usage of the camera by the app.
-
setUseButtonsAllCaps
final Unit setUseButtonsAllCaps(Boolean allCaps)
Controls whether buttons should use all capitals style.
-
setScanPatientInfo
final Unit setScanPatientInfo(Boolean isEnabled)
Whether sdk should run scanning of Patient Information block.
- Parameters:
isEnabled-should scan patient info block if true
-
setReturnCroppedDocumentImage
final Unit setReturnCroppedDocumentImage(Boolean isEnabled)
Whether sdk should return cropped document image or not
- Parameters:
isEnabled-return cropped image if true
-
setCameraOverlayColor
final Unit setCameraOverlayColor(Integer cameraOverlayColor)
Background color outside of the finder window.
-
setFinderLineWidth
final Unit setFinderLineWidth(Integer finderLineWidth)
Thickness of the finder window's outline in Px.
-
setFinderLineColor
final Unit setFinderLineColor(Integer finderLineColor)
Color of the finder window's outline.
-
setShowFinderOverlay
final Unit setShowFinderOverlay(Boolean show)
Option to show or hide finder overlay.
-
setUserGuidanceBackgroundColor
final Unit setUserGuidanceBackgroundColor(Integer userGuidanceBackgroundColor)
The background color of the user guidance hints.
-
setUserGuidanceTextColor
final Unit setUserGuidanceTextColor(Integer userGuidanceTextColor)
The text color of the user guidance hints.
-
setUserGuidanceStrings
final Unit setUserGuidanceStrings(String cameraOpen, String scanning, String capturing, String processing)
Configuration that helps to override default hint values.
- Parameters:
cameraOpen-text that shown on camera open
scanning-text that shown when camera seeking for the document on the visible area, shown after first result from the detector
capturing-text that will be shown when we are making high res image snap before reading medical certificate data
processing-text that shown when detector tries to read fields from snapped image
-
setErrorDialogTitle
final Unit setErrorDialogTitle(String title)
Error dialog title.
-
setErrorDialogMessage
final Unit setErrorDialogMessage(String message)
Error dialog message.
-
setErrorDialogOkButtonTitle
final Unit setErrorDialogOkButtonTitle(String title)
Error dialog ok button text.
-
setErrorDialogAccentColor
final Unit setErrorDialogAccentColor(Integer dialogAccentColor)
The accent color of buttons on a error dialog.
-
setErrorDialogOkButtonFilled
final Unit setErrorDialogOkButtonFilled(Boolean buttonFilled)
Allows to set if the confirm button should be filled.
-
setErrorDialogOkButtonFilledTextColor
final Unit setErrorDialogOkButtonFilledTextColor(Integer textColor)
Allows to set a text color of the filled button. See setErrorDialogOkButtonFilled.
-
setTouchToFocusEnabled
final Unit setTouchToFocusEnabled(Boolean enabled)
Controls whether the touch to focus feature should be enabled. Default is
true.
-
-
-
-