# CheckScannerScreenConfiguration class

Annotations
  - @JsonSerializable(includeIfNull: false, createFactory: false, explicitToJson: true)

## Constructors

CheckScannerScreenConfiguration.new({String? version, String? screen, List<CheckStandard>? acceptedCheckStandards, CameraModule? cameraModule, Color? cameraOverlayColor, String? cancelButtonTitle, bool? cancelButtonHidden, bool? captureHighResolutionImage, String? enableCameraButtonTitle, String? enableCameraExplanationText, DialogStyle? errorDialogStyle, DialogButtonStyle? errorDialogButtonStyle, String? errorAlertTitle, String? errorAlertMessage, String? errorAlertButtonText, AspectRatio? finderAspectRatio, Color? finderLineColor, double? finderLineWidth, bool? flashButtonHidden, String? flashButtonTitle, bool? flashEnabled, OrientationLockMode? orientationLockMode, Color? topBarBackgroundColor, Color? topBarButtonsActiveColor, Color? topBarButtonsInactiveColor, Color? userGuidanceBackgroundColor, Color? userGuidanceTextColor, CheckUserGuidanceStrings? userGuidanceStringValues, bool? useButtonsAllCaps, CameraPreviewMode? cameraPreviewMode, bool? touchToFocusEnabled})

## Properties

acceptedCheckStandards ↔ List<CheckStandard>?
  Accepted check standards. Optional, by default - all checks are accepted. With an empty list no filter is applied and all checks are accepted.
  getter/setter pair
cameraModule ↔ CameraModule?
  The preferred camera module (default - BACK)
  getter/setter pair
cameraOverlayColor ↔ Color?
  Background color outside of the finder window.
  getter/setter pair
cameraPreviewMode ↔ CameraPreviewMode?
  Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only
  getter/setter pair
cancelButtonHidden ↔ bool?
  Whether the cancel button is hidden or not. iOS only.
  getter/setter pair
cancelButtonTitle ↔ String?
  Title of the cancel button.
  getter/setter pair
captureHighResolutionImage ↔ bool?
  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.
  getter/setter pair
enableCameraButtonTitle ↔ String?
  Title of the button that opens the screen where the user can allow the usage of the camera by the app.
  getter/setter pair
enableCameraExplanationText ↔ String?
  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.
  getter/setter pair
errorAlertButtonText ↔ String?
  String being displayed as the button text in the error alert that may occur when the recognition fails on captured high-resolution images. iOS only.
  getter/setter pair
errorAlertMessage ↔ String?
  String being displayed as the message in the error alert that may occur when the recognition fails on captured high-resolution images. iOS only.
  getter/setter pair
errorAlertTitle ↔ String?
  String being displayed as the title in the error alert that may occur when the recognition fails on captured high-resolution images. iOS only.
  getter/setter pair
errorDialogButtonStyle ↔ DialogButtonStyle?
  The style of the dialogs/alerts OK button in case of error. iOS Only.
  getter/setter pair
errorDialogStyle ↔ DialogStyle?
  The style of the dialog/alert in case of error. iOS Only.
  getter/setter pair
finderAspectRatio ↔ AspectRatio?
  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.
  getter/setter pair
finderLineColor ↔ Color?
  Foreground color of the detection overlay.
  getter/setter pair
finderLineWidth ↔ double?
  Width of finder frame border. Default is 2.
  getter/setter pair
flashButtonHidden ↔ bool?
  Controls whether the flash toggle button is hidden or not. iOS only.
  getter/setter pair
flashButtonTitle ↔ String?
  Title of the flash toggle button. iOS only.
  getter/setter pair
flashEnabled ↔ bool?
  Controls whether the flash should be initially enabled. The default value is FALSE.
  getter/setter pair
hashCode → int
  The hash code for this object.
  no setter inherited
orientationLockMode ↔ OrientationLockMode?
  UI Interface orientation lock mode
  getter/setter pair
runtimeType → Type
  A representation of the runtime type of the object.
  no setter inherited
screen ↔ String?
  The configuration object should be applied for this screen
  getter/setter pair
topBarBackgroundColor ↔ Color?
  The background color of the top toolbar.
  getter/setter pair
topBarButtonsActiveColor ↔ Color?
  The color of all active toggle buttons in the toolbar.
  getter/setter pair
topBarButtonsInactiveColor ↔ Color?
  The color of all inactive toggle buttons in the toolbar.
  getter/setter pair
touchToFocusEnabled ↔ bool?
  Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.
  getter/setter pair
useButtonsAllCaps ↔ bool?
  Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
  getter/setter pair
userGuidanceBackgroundColor ↔ Color?
  The background color of the user guidance hints.
  getter/setter pair
userGuidanceStringValues ↔ CheckUserGuidanceStrings?
  Configuration that helps to override default hint values.
  getter/setter pair
userGuidanceTextColor ↔ Color?
  The text color of the user guidance hints.
  getter/setter pair
version ↔ String?
  A version of the configuration object
  getter/setter pair

## Methods

noSuchMethod(Invocation invocation) → dynamic
  Invoked when a nonexistent method or property is accessed.
  inherited
toJson() → Map<String, dynamic>
toString() → String
  A string representation of this object.
  inherited

## Operators

operator ==(Object other) → bool
  The equality operator.
  inherited