All Implemented Interfaces:: android.os.Parcelable


public final class MedicalCertificateScannerJsonConfiguration
 implements Parcelable

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private String`	`version`
`private String`	`screen`
`private JsonCameraModule`	`cameraModule`
`private JsonColor`	`cameraOverlayColor`
`private String`	`cancelButtonTitle`
`private String`	`enableCameraButtonTitle`
`private String`	`enableCameraExplanationText`
`private JsonColor`	`finderLineColor`
`private Double`	`finderLineWidth`
`private Boolean`	`flashEnabled`
`private JsonOrientationLockMode`	`orientationLockMode`
`private JsonColor`	`topBarBackgroundColor`
`private JsonColor`	`topBarButtonsActiveColor`
`private JsonColor`	`topBarButtonsInactiveColor`
`private Boolean`	`useButtonsAllCaps`
`private JsonColor`	`userGuidanceBackgroundColor`
`private JsonColor`	`userGuidanceTextColor`
`private Boolean`	`recognizePatientInfo`
`private Boolean`	`returnCroppedDocumentImage`
`private String`	`errorDialogTitle`
`private JsonColor`	`errorDialogAccentColor`
`private String`	`errorDialogMessage`
`private String`	`errorDialogOkButton`
`private Boolean`	`errorDialogOkButtonFilled`
`private JsonColor`	`errorDialogOkButtonFilledTextColor`
`private Boolean`	`showFinderOverlay`
`private JsonMedicalCertificateUserGuidanceStrings`	`userGuidanceStrings`
`private JsonCameraPreviewMode`	`cameraPreviewMode`
`private Boolean`	`touchToFocusEnabled`

Constructor Summary

Constructors
Constructor	Description
MedicalCertificateScannerJsonConfiguration(String version, String screen, JsonCameraModule cameraModule, JsonColor cameraOverlayColor, String cancelButtonTitle, String enableCameraButtonTitle, String enableCameraExplanationText, JsonColor finderLineColor, Double finderLineWidth, Boolean flashEnabled, JsonOrientationLockMode orientationLockMode, JsonColor topBarBackgroundColor, JsonColor topBarButtonsActiveColor, JsonColor topBarButtonsInactiveColor, Boolean useButtonsAllCaps, JsonColor userGuidanceBackgroundColor, JsonColor userGuidanceTextColor, Boolean recognizePatientInfo, Boolean returnCroppedDocumentImage, String errorDialogTitle, JsonColor errorDialogAccentColor, String errorDialogMessage, String errorDialogOkButton, Boolean errorDialogOkButtonFilled, JsonColor errorDialogOkButtonFilledTextColor, Boolean showFinderOverlay, JsonMedicalCertificateUserGuidanceStrings userGuidanceStrings, JsonCameraPreviewMode cameraPreviewMode, Boolean touchToFocusEnabled)

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getVersion()`	A version of the configuration object
`final Unit`	`setVersion(String version)`	A version of the configuration object
`final String`	`getScreen()`	The configuration object should be applied for this screen
`final Unit`	`setScreen(String screen)`	The configuration object should be applied for this screen
`final JsonCameraModule`	`getCameraModule()`	The preferred camera module (default - BACK)
`final Unit`	`setCameraModule(JsonCameraModule cameraModule)`	The preferred camera module (default - BACK)
`final JsonColor`	`getCameraOverlayColor()`	Background color outside of the finder window.
`final Unit`	`setCameraOverlayColor(JsonColor cameraOverlayColor)`	Background color outside of the finder window.
`final String`	`getCancelButtonTitle()`	Title of the cancel button.
`final Unit`	`setCancelButtonTitle(String cancelButtonTitle)`	Title of the cancel button.
`final String`	`getEnableCameraButtonTitle()`	Title of the button that opens the screen where the user can allow the usage of the camera by the app.
`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.
`final String`	`getEnableCameraExplanationText()`	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 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.
`final JsonColor`	`getFinderLineColor()`	Foreground color of the detection overlay.
`final Unit`	`setFinderLineColor(JsonColor finderLineColor)`	Foreground color of the detection overlay.
`final Double`	`getFinderLineWidth()`	Width of finder frame border.
`final Unit`	`setFinderLineWidth(Double finderLineWidth)`	Width of finder frame border.
`final Boolean`	`getFlashEnabled()`	Controls whether the flash should be initially enabled.
`final Unit`	`setFlashEnabled(Boolean flashEnabled)`	Controls whether the flash should be initially enabled.
`final JsonOrientationLockMode`	`getOrientationLockMode()`	UI Interface orientation lock mode
`final Unit`	`setOrientationLockMode(JsonOrientationLockMode orientationLockMode)`	UI Interface orientation lock mode
`final JsonColor`	`getTopBarBackgroundColor()`	The background color of the top toolbar.
`final Unit`	`setTopBarBackgroundColor(JsonColor topBarBackgroundColor)`	The background color of the top toolbar.
`final JsonColor`	`getTopBarButtonsActiveColor()`	The color of all active toggle buttons in the toolbar.
`final Unit`	`setTopBarButtonsActiveColor(JsonColor topBarButtonsActiveColor)`	The color of all active toggle buttons in the toolbar.
`final JsonColor`	`getTopBarButtonsInactiveColor()`	The color of all inactive toggle buttons in the toolbar.
`final Unit`	`setTopBarButtonsInactiveColor(JsonColor topBarButtonsInactiveColor)`	The color of all inactive toggle buttons in the toolbar.
`final Boolean`	`getUseButtonsAllCaps()`	Controls whether buttons should use all capitals style, as defined by the Android Material Design.
`final Unit`	`setUseButtonsAllCaps(Boolean useButtonsAllCaps)`	Controls whether buttons should use all capitals style, as defined by the Android Material Design.
`final JsonColor`	`getUserGuidanceBackgroundColor()`	The background color of the user guidance hints.
`final Unit`	`setUserGuidanceBackgroundColor(JsonColor userGuidanceBackgroundColor)`	The background color of the user guidance hints.
`final JsonColor`	`getUserGuidanceTextColor()`	The text color of the user guidance hints.
`final Unit`	`setUserGuidanceTextColor(JsonColor userGuidanceTextColor)`	The text color of the user guidance hints.
`final Boolean`	`getRecognizePatientInfo()`	Whether sdk should run recognition of Patient Information block.
`final Unit`	`setRecognizePatientInfo(Boolean recognizePatientInfo)`	Whether sdk should run recognition of Patient Information block.
`final Boolean`	`getReturnCroppedDocumentImage()`	Whether sdk should return cropped document image or not
`final Unit`	`setReturnCroppedDocumentImage(Boolean returnCroppedDocumentImage)`	Whether sdk should return cropped document image or not
`final String`	`getErrorDialogTitle()`	Error dialog title
`final Unit`	`setErrorDialogTitle(String errorDialogTitle)`	Error dialog title
`final JsonColor`	`getErrorDialogAccentColor()`	The accent color of buttons on a error dialog.
`final Unit`	`setErrorDialogAccentColor(JsonColor errorDialogAccentColor)`	The accent color of buttons on a error dialog.
`final String`	`getErrorDialogMessage()`	Error dialog message
`final Unit`	`setErrorDialogMessage(String errorDialogMessage)`	Error dialog message
`final String`	`getErrorDialogOkButton()`	Error dialog ok button text.
`final Unit`	`setErrorDialogOkButton(String errorDialogOkButton)`	Error dialog ok button text.
`final Boolean`	`getErrorDialogOkButtonFilled()`	Allows to set if the confirm button should be filled.
`final Unit`	`setErrorDialogOkButtonFilled(Boolean errorDialogOkButtonFilled)`	Allows to set if the confirm button should be filled.
`final JsonColor`	`getErrorDialogOkButtonFilledTextColor()`	Allows to set a text color of the filled button.
`final Unit`	`setErrorDialogOkButtonFilledTextColor(JsonColor errorDialogOkButtonFilledTextColor)`	Allows to set a text color of the filled button.
`final Boolean`	`getShowFinderOverlay()`	Option to show or hide finder overlay
`final Unit`	`setShowFinderOverlay(Boolean showFinderOverlay)`	Option to show or hide finder overlay
`final JsonMedicalCertificateUserGuidanceStrings`	`getUserGuidanceStrings()`	Configuration that helps to override default hint values
`final Unit`	`setUserGuidanceStrings(JsonMedicalCertificateUserGuidanceStrings userGuidanceStrings)`	Configuration that helps to override default hint values
`final JsonCameraPreviewMode`	`getCameraPreviewMode()`	Preview mode of the camera.
`final Unit`	`setCameraPreviewMode(JsonCameraPreviewMode cameraPreviewMode)`	Preview mode of the camera.
`final Boolean`	`getTouchToFocusEnabled()`	Whether touch-to-focus is enabled on camera preview.
`final Unit`	`setTouchToFocusEnabled(Boolean touchToFocusEnabled)`	Whether touch-to-focus is enabled on camera preview.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MedicalCertificateScannerJsonConfiguration
```
MedicalCertificateScannerJsonConfiguration(String version, String screen, JsonCameraModule cameraModule, JsonColor cameraOverlayColor, String cancelButtonTitle, String enableCameraButtonTitle, String enableCameraExplanationText, JsonColor finderLineColor, Double finderLineWidth, Boolean flashEnabled, JsonOrientationLockMode orientationLockMode, JsonColor topBarBackgroundColor, JsonColor topBarButtonsActiveColor, JsonColor topBarButtonsInactiveColor, Boolean useButtonsAllCaps, JsonColor userGuidanceBackgroundColor, JsonColor userGuidanceTextColor, Boolean recognizePatientInfo, Boolean returnCroppedDocumentImage, String errorDialogTitle, JsonColor errorDialogAccentColor, String errorDialogMessage, String errorDialogOkButton, Boolean errorDialogOkButtonFilled, JsonColor errorDialogOkButtonFilledTextColor, Boolean showFinderOverlay, JsonMedicalCertificateUserGuidanceStrings userGuidanceStrings, JsonCameraPreviewMode cameraPreviewMode, Boolean touchToFocusEnabled)
```
- Method Detail
  - getVersion
```
 final String getVersion()
```
    A version of the configuration object
  - setVersion
```
 final Unit setVersion(String version)
```
    A version of the configuration object
  - getScreen
```
 final String getScreen()
```
    The configuration object should be applied for this screen
  - setScreen
```
 final Unit setScreen(String screen)
```
    The configuration object should be applied for this screen
  - getCameraModule
```
 final JsonCameraModule getCameraModule()
```
    The preferred camera module (default - BACK)
  - setCameraModule
```
 final Unit setCameraModule(JsonCameraModule cameraModule)
```
    The preferred camera module (default - BACK)
  - getCameraOverlayColor
```
 final JsonColor getCameraOverlayColor()
```
    Background color outside of the finder window.
  - setCameraOverlayColor
```
 final Unit setCameraOverlayColor(JsonColor cameraOverlayColor)
```
    Background color outside of the finder window.
  - getCancelButtonTitle
```
 final String getCancelButtonTitle()
```
    Title of the cancel button.
  - setCancelButtonTitle
```
 final Unit setCancelButtonTitle(String cancelButtonTitle)
```
    Title of the cancel button.
  - getEnableCameraButtonTitle
```
 final String getEnableCameraButtonTitle()
```
    Title of the button that opens the screen where the user can allow the usage of the camera by the app.
  - 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.
  - getEnableCameraExplanationText
```
 final String getEnableCameraExplanationText()
```
    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.
  - 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.
  - getFinderLineColor
```
 final JsonColor getFinderLineColor()
```
    Foreground color of the detection overlay.
  - setFinderLineColor
```
 final Unit setFinderLineColor(JsonColor finderLineColor)
```
    Foreground color of the detection overlay.
  - getFinderLineWidth
```
 final Double getFinderLineWidth()
```
    Width of finder frame border. Default is 2.
  - setFinderLineWidth
```
 final Unit setFinderLineWidth(Double finderLineWidth)
```
    Width of finder frame border. Default is 2.
  - getFlashEnabled
```
 final Boolean getFlashEnabled()
```
    Controls whether the flash should be initially enabled. The default value is FALSE.
  - setFlashEnabled
```
 final Unit setFlashEnabled(Boolean flashEnabled)
```
    Controls whether the flash should be initially enabled. The default value is FALSE.
  - getOrientationLockMode
```
 final JsonOrientationLockMode getOrientationLockMode()
```
    UI Interface orientation lock mode
  - setOrientationLockMode
```
 final Unit setOrientationLockMode(JsonOrientationLockMode orientationLockMode)
```
    UI Interface orientation lock mode
  - getTopBarBackgroundColor
```
 final JsonColor getTopBarBackgroundColor()
```
    The background color of the top toolbar.
  - setTopBarBackgroundColor
```
 final Unit setTopBarBackgroundColor(JsonColor topBarBackgroundColor)
```
    The background color of the top toolbar.
  - getTopBarButtonsActiveColor
```
 final JsonColor getTopBarButtonsActiveColor()
```
    The color of all active toggle buttons in the toolbar.
  - setTopBarButtonsActiveColor
```
 final Unit setTopBarButtonsActiveColor(JsonColor topBarButtonsActiveColor)
```
    The color of all active toggle buttons in the toolbar.
  - getTopBarButtonsInactiveColor
```
 final JsonColor getTopBarButtonsInactiveColor()
```
    The color of all inactive toggle buttons in the toolbar.
  - setTopBarButtonsInactiveColor
```
 final Unit setTopBarButtonsInactiveColor(JsonColor topBarButtonsInactiveColor)
```
    The color of all inactive toggle buttons in the toolbar.
  - getUseButtonsAllCaps
```
 final Boolean getUseButtonsAllCaps()
```
    Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
  - setUseButtonsAllCaps
```
 final Unit setUseButtonsAllCaps(Boolean useButtonsAllCaps)
```
    Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
  - getUserGuidanceBackgroundColor
```
 final JsonColor getUserGuidanceBackgroundColor()
```
    The background color of the user guidance hints.
  - setUserGuidanceBackgroundColor
```
 final Unit setUserGuidanceBackgroundColor(JsonColor userGuidanceBackgroundColor)
```
    The background color of the user guidance hints.
  - getUserGuidanceTextColor
```
 final JsonColor getUserGuidanceTextColor()
```
    The text color of the user guidance hints.
  - setUserGuidanceTextColor
```
 final Unit setUserGuidanceTextColor(JsonColor userGuidanceTextColor)
```
    The text color of the user guidance hints.
  - getRecognizePatientInfo
```
 final Boolean getRecognizePatientInfo()
```
    Whether sdk should run recognition of Patient Information block.
  - setRecognizePatientInfo
```
 final Unit setRecognizePatientInfo(Boolean recognizePatientInfo)
```
    Whether sdk should run recognition of Patient Information block.
  - getReturnCroppedDocumentImage
```
 final Boolean getReturnCroppedDocumentImage()
```
    Whether sdk should return cropped document image or not
  - setReturnCroppedDocumentImage
```
 final Unit setReturnCroppedDocumentImage(Boolean returnCroppedDocumentImage)
```
    Whether sdk should return cropped document image or not
  - getErrorDialogTitle
```
 final String getErrorDialogTitle()
```
    Error dialog title
  - setErrorDialogTitle
```
 final Unit setErrorDialogTitle(String errorDialogTitle)
```
    Error dialog title
  - getErrorDialogAccentColor
```
 final JsonColor getErrorDialogAccentColor()
```
    The accent color of buttons on a error dialog.
  - setErrorDialogAccentColor
```
 final Unit setErrorDialogAccentColor(JsonColor errorDialogAccentColor)
```
    The accent color of buttons on a error dialog.
  - getErrorDialogMessage
```
 final String getErrorDialogMessage()
```
    Error dialog message
  - setErrorDialogMessage
```
 final Unit setErrorDialogMessage(String errorDialogMessage)
```
    Error dialog message
  - getErrorDialogOkButton
```
 final String getErrorDialogOkButton()
```
    Error dialog ok button text.
  - setErrorDialogOkButton
```
 final Unit setErrorDialogOkButton(String errorDialogOkButton)
```
    Error dialog ok button text.
  - getErrorDialogOkButtonFilled
```
 final Boolean getErrorDialogOkButtonFilled()
```
    Allows to set if the confirm button should be filled. Android only.
  - setErrorDialogOkButtonFilled
```
 final Unit setErrorDialogOkButtonFilled(Boolean errorDialogOkButtonFilled)
```
    Allows to set if the confirm button should be filled. Android only.
  - getErrorDialogOkButtonFilledTextColor
```
 final JsonColor getErrorDialogOkButtonFilledTextColor()
```
    Allows to set a text color of the filled button. Android only.
  - setErrorDialogOkButtonFilledTextColor
```
 final Unit setErrorDialogOkButtonFilledTextColor(JsonColor errorDialogOkButtonFilledTextColor)
```
    Allows to set a text color of the filled button. Android only.
  - getShowFinderOverlay
```
 final Boolean getShowFinderOverlay()
```
    Option to show or hide finder overlay
  - setShowFinderOverlay
```
 final Unit setShowFinderOverlay(Boolean showFinderOverlay)
```
    Option to show or hide finder overlay
  - getUserGuidanceStrings
```
 final JsonMedicalCertificateUserGuidanceStrings getUserGuidanceStrings()
```
    Configuration that helps to override default hint values
  - setUserGuidanceStrings
```
 final Unit setUserGuidanceStrings(JsonMedicalCertificateUserGuidanceStrings userGuidanceStrings)
```
    Configuration that helps to override default hint values
  - getCameraPreviewMode
```
 final JsonCameraPreviewMode getCameraPreviewMode()
```
    Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only
  - setCameraPreviewMode
```
 final Unit setCameraPreviewMode(JsonCameraPreviewMode cameraPreviewMode)
```
    Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only
  - getTouchToFocusEnabled
```
 final Boolean getTouchToFocusEnabled()
```
    Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.
  - setTouchToFocusEnabled
```
 final Unit setTouchToFocusEnabled(Boolean touchToFocusEnabled)
```
    Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.

Class MedicalCertificateScannerJsonConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MedicalCertificateScannerJsonConfiguration

Method Detail

getVersion

setVersion

getScreen

setScreen

getCameraModule

setCameraModule

getCameraOverlayColor

setCameraOverlayColor

getCancelButtonTitle

setCancelButtonTitle

getEnableCameraButtonTitle

setEnableCameraButtonTitle

getEnableCameraExplanationText

setEnableCameraExplanationText

getFinderLineColor

setFinderLineColor

getFinderLineWidth

setFinderLineWidth

getFlashEnabled

setFlashEnabled

getOrientationLockMode

setOrientationLockMode

getTopBarBackgroundColor

setTopBarBackgroundColor

getTopBarButtonsActiveColor

setTopBarButtonsActiveColor

getTopBarButtonsInactiveColor

setTopBarButtonsInactiveColor

getUseButtonsAllCaps

setUseButtonsAllCaps

getUserGuidanceBackgroundColor

setUserGuidanceBackgroundColor

getUserGuidanceTextColor

setUserGuidanceTextColor

getRecognizePatientInfo

setRecognizePatientInfo

getReturnCroppedDocumentImage

setReturnCroppedDocumentImage

getErrorDialogTitle

setErrorDialogTitle

getErrorDialogAccentColor

setErrorDialogAccentColor

getErrorDialogMessage

setErrorDialogMessage

getErrorDialogOkButton

setErrorDialogOkButton

getErrorDialogOkButtonFilled

setErrorDialogOkButtonFilled

getErrorDialogOkButtonFilledTextColor

setErrorDialogOkButtonFilledTextColor

getShowFinderOverlay

setShowFinderOverlay

getUserGuidanceStrings

setUserGuidanceStrings

getCameraPreviewMode

setCameraPreviewMode

getTouchToFocusEnabled

setTouchToFocusEnabled