All Implemented Interfaces:: android.os.Parcelable


public final class CheckScannerJsonConfiguration
 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 List<JsonCheckStandard>`	`acceptedCheckStandards`
`private JsonCameraModule`	`cameraModule`
`private JsonColor`	`cameraOverlayColor`
`private String`	`cancelButtonTitle`
`private Boolean`	`captureHighResolutionImage`
`private String`	`enableCameraButtonTitle`
`private String`	`enableCameraExplanationText`
`private JsonAspectRatio`	`finderAspectRatio`
`private JsonColor`	`finderLineColor`
`private Double`	`finderLineWidth`
`private Boolean`	`flashEnabled`
`private JsonOrientationLockMode`	`orientationLockMode`
`private JsonColor`	`topBarBackgroundColor`
`private JsonColor`	`topBarButtonsActiveColor`
`private JsonColor`	`topBarButtonsInactiveColor`
`private JsonColor`	`userGuidanceBackgroundColor`
`private JsonColor`	`userGuidanceTextColor`
`private JsonCheckUserGuidanceStrings`	`userGuidanceStringValues`
`private Boolean`	`useButtonsAllCaps`
`private JsonCameraPreviewMode`	`cameraPreviewMode`
`private Boolean`	`touchToFocusEnabled`

Constructor Summary

Constructors
Constructor	Description
CheckScannerJsonConfiguration(String version, String screen, List<JsonCheckStandard> acceptedCheckStandards, JsonCameraModule cameraModule, JsonColor cameraOverlayColor, String cancelButtonTitle, Boolean captureHighResolutionImage, String enableCameraButtonTitle, String enableCameraExplanationText, JsonAspectRatio finderAspectRatio, JsonColor finderLineColor, Double finderLineWidth, Boolean flashEnabled, JsonOrientationLockMode orientationLockMode, JsonColor topBarBackgroundColor, JsonColor topBarButtonsActiveColor, JsonColor topBarButtonsInactiveColor, JsonColor userGuidanceBackgroundColor, JsonColor userGuidanceTextColor, JsonCheckUserGuidanceStrings userGuidanceStringValues, Boolean useButtonsAllCaps, 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 List<JsonCheckStandard>`	`getAcceptedCheckStandards()`	Accepted check standards.
`final Unit`	`setAcceptedCheckStandards(List<JsonCheckStandard> acceptedCheckStandards)`	Accepted check standards.
`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 Boolean`	`getCaptureHighResolutionImage()`	Set high-resolution Check image capturing.
`final Unit`	`setCaptureHighResolutionImage(Boolean captureHighResolutionImage)`	Set high-resolution Check image capturing.
`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 JsonAspectRatio`	`getFinderAspectRatio()`	Aspect ratio of finder frame (width \ height), which is used to build actual finder frame.
`final Unit`	`setFinderAspectRatio(JsonAspectRatio finderAspectRatio)`	Aspect ratio of finder frame (width \ height), which is used to build actual finder frame.
`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 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 JsonCheckUserGuidanceStrings`	`getUserGuidanceStringValues()`	Configuration that helps to override default hint values.
`final Unit`	`setUserGuidanceStringValues(JsonCheckUserGuidanceStrings userGuidanceStringValues)`	Configuration that helps to override default hint values.
`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 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
  - CheckScannerJsonConfiguration
```
CheckScannerJsonConfiguration(String version, String screen, List<JsonCheckStandard> acceptedCheckStandards, JsonCameraModule cameraModule, JsonColor cameraOverlayColor, String cancelButtonTitle, Boolean captureHighResolutionImage, String enableCameraButtonTitle, String enableCameraExplanationText, JsonAspectRatio finderAspectRatio, JsonColor finderLineColor, Double finderLineWidth, Boolean flashEnabled, JsonOrientationLockMode orientationLockMode, JsonColor topBarBackgroundColor, JsonColor topBarButtonsActiveColor, JsonColor topBarButtonsInactiveColor, JsonColor userGuidanceBackgroundColor, JsonColor userGuidanceTextColor, JsonCheckUserGuidanceStrings userGuidanceStringValues, Boolean useButtonsAllCaps, 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
  - getAcceptedCheckStandards
```
 final List<JsonCheckStandard> getAcceptedCheckStandards()
```
    Accepted check standards. Optional, by default - all checks are accepted. With an empty list no filter is applied and all checks are accepted.
  - setAcceptedCheckStandards
```
 final Unit setAcceptedCheckStandards(List<JsonCheckStandard> acceptedCheckStandards)
```
    Accepted check standards. Optional, by default - all checks are accepted. With an empty list no filter is applied and all checks are accepted.
  - 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.
  - getCaptureHighResolutionImage
```
 final Boolean getCaptureHighResolutionImage()
```
    Set high-resolution Check image capturing. If set to TRUE a high-resolution photo of the check is captured to run the recognition on. Upon successful recognition the recognition result also contains a high-resolution image of the check. If set to FALSE, the video frames will be used for recognition and result image delivery. The default value is TRUE.
  - setCaptureHighResolutionImage
```
 final Unit setCaptureHighResolutionImage(Boolean captureHighResolutionImage)
```
    Set high-resolution Check image capturing. If set to TRUE a high-resolution photo of the check is captured to run the recognition on. Upon successful recognition the recognition result also contains a high-resolution image of the check. If set to FALSE, the video frames will be used for recognition and result image delivery. The default value is TRUE.
  - 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.
  - getFinderAspectRatio
```
 final JsonAspectRatio getFinderAspectRatio()
```
    Aspect ratio of finder frame (width \ height), which is used to build actual finder frame. Default is 1 - it is a square frame, which is good for QR capturing.
  - setFinderAspectRatio
```
 final Unit setFinderAspectRatio(JsonAspectRatio finderAspectRatio)
```
    Aspect ratio of finder frame (width \ height), which is used to build actual finder frame. Default is 1 - it is a square frame, which is good for QR capturing.
  - 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.
  - 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.
  - getUserGuidanceStringValues
```
 final JsonCheckUserGuidanceStrings getUserGuidanceStringValues()
```
    Configuration that helps to override default hint values.
  - setUserGuidanceStringValues
```
 final Unit setUserGuidanceStringValues(JsonCheckUserGuidanceStrings userGuidanceStringValues)
```
    Configuration that helps to override default hint values.
  - 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.
  - 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 CheckScannerJsonConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CheckScannerJsonConfiguration

Method Detail

getVersion

setVersion

getScreen

setScreen

getAcceptedCheckStandards

setAcceptedCheckStandards

getCameraModule

setCameraModule

getCameraOverlayColor

setCameraOverlayColor

getCancelButtonTitle

setCancelButtonTitle

getCaptureHighResolutionImage

setCaptureHighResolutionImage

getEnableCameraButtonTitle

setEnableCameraButtonTitle

getEnableCameraExplanationText

setEnableCameraExplanationText

getFinderAspectRatio

setFinderAspectRatio

getFinderLineColor

setFinderLineColor

getFinderLineWidth

setFinderLineWidth

getFlashEnabled

setFlashEnabled

getOrientationLockMode

setOrientationLockMode

getTopBarBackgroundColor

setTopBarBackgroundColor

getTopBarButtonsActiveColor

setTopBarButtonsActiveColor

getTopBarButtonsInactiveColor

setTopBarButtonsInactiveColor

getUserGuidanceBackgroundColor

setUserGuidanceBackgroundColor

getUserGuidanceTextColor

setUserGuidanceTextColor

getUserGuidanceStringValues

setUserGuidanceStringValues

getUseButtonsAllCaps

setUseButtonsAllCaps

getCameraPreviewMode

setCameraPreviewMode

getTouchToFocusEnabled

setTouchToFocusEnabled