MedicalCertificateScannerConfiguration class

Annotations

• @JsonSerializable(includeIfNull: false, createFactory: false, explicitToJson: true)

Constructors

MedicalCertificateScannerConfiguration.new({String? version, String? screen, CameraModule? cameraModule, Color? cameraOverlayColor, String? cancelButtonTitle, bool? cancelButtonHidden, String? enableCameraButtonTitle, String? enableCameraExplanationText, Color? finderLineColor, double? finderLineWidth, bool? flashButtonHidden, String? flashButtonTitle, bool? flashEnabled, OrientationLockMode? orientationLockMode, Color? topBarBackgroundColor, Color? topBarButtonsActiveColor, Color? topBarButtonsInactiveColor, bool? useButtonsAllCaps, Color? userGuidanceBackgroundColor, Color? userGuidanceTextColor, bool? userGuidanceHidden, bool? recognizePatientInfo, bool? returnCroppedDocumentImage, DialogStyle? errorDialogStyle, String? errorDialogTitle, Color? errorDialogAccentColor, String? errorDialogMessage, String? errorDialogOkButton, bool? errorDialogOkButtonFilled, Color? errorDialogOkButtonFilledTextColor, DialogButtonStyle? errorDialogButtonStyle, bool? showFinderOverlay, MedicalCertificateUserGuidanceStrings? userGuidanceStrings, CameraPreviewMode? cameraPreviewMode, bool? touchToFocusEnabled, AspectRatio? finderAspectRatio, AspectRatio? finderSecondaryAspectRatio})

Properties

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

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

errorDialogAccentColor ↔ Color?

The accent color of buttons on a error dialog.

getter/setter pair

errorDialogButtonStyle ↔ DialogButtonStyle?

The style of the dialogs/alerts OK button in case of error. iOS only.

getter/setter pair

errorDialogMessage ↔ String?

Error dialog message

getter/setter pair

errorDialogOkButton ↔ String?

Error dialog ok button text.

getter/setter pair

errorDialogOkButtonFilled ↔ bool?

Allows to set if the confirm button should be filled. Android only.

getter/setter pair

errorDialogOkButtonFilledTextColor ↔ Color?

Allows to set a text color of the filled button. Android only.

getter/setter pair

errorDialogStyle ↔ DialogStyle?

The style of the dialog/alert in case of error. iOS only.

getter/setter pair

errorDialogTitle ↔ String?

Error dialog title

getter/setter pair

finderAspectRatio ↔ AspectRatio?

Aspect ratio of the view finder (width \ height). Set to nil of no view finder should be displayed. iOS only.

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

finderSecondaryAspectRatio ↔ AspectRatio?

Secondary aspect ratio of finder frame (width \ height). Set to nil if no secondary view finder should be displayed. iOS only.

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

recognizePatientInfo ↔ bool?

Whether sdk should run recognition of Patient Information block.

getter/setter pair

returnCroppedDocumentImage ↔ bool?

Whether sdk should return cropped document image or not

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

showFinderOverlay ↔ bool?

Option to show or hide finder overlay

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

userGuidanceHidden ↔ bool?

Whether the user guidance label is hidden or not. iOS only.

getter/setter pair

userGuidanceStrings ↔ MedicalCertificateUserGuidanceStrings?

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