HVDocConfig class

HVDocConfig - used to configure the doc capture options for the sdk HVDocConfig is used to configure the document capture options for the SDK.

Constructors

HVDocConfig({HVDocCaptureUIStrings? hvDocCaptureUIStrings, bool? shouldShowTrustLogos, bool? shouldShowInstructionPage, bool? shouldEnableDocumentUpload, bool? shouldShowFlashIcon, DocumentType? docType, double? aspectRatioValue, bool? shouldAddPadding, double? padding, bool? shouldShowCloseAlert, String? closeAlertDialogTitle, String? closeAlertDialogDescription, bool? shouldAutoCapture, int? autoCaptureDuration, bool? shouldReadBarcode, int? readBarcodeTimeout, bool? disableBarcodeSkip, HVOCRAPIDetails? hvOCRAPIDetails, bool? shouldShowReviewScreen, bool? shouldEnableRetries})

Constructs a new HVDocConfig object with the specified configuration options.

Properties

aspectRatioValue ↔ double?

aspectRatioValue: The aspect ratio of the document to be captured. Type: double.

getter/setter pair

autoCaptureDuration ↔ int?

autoCaptureDuration: The wait duration for auto capture. Type: int. Please contact Hyperverge incase you want to enable this feature

getter/setter pair

closeAlertDialogDescription ↔ String?

closeAlertDialogDescription: The custom description for the alert dialog that appears when closing any screen. Type: String. ///

getter/setter pair

closeAlertDialogTitle ↔ String?

closeAlertDialogTitle: The custom title for the alert dialog that appears when closing any screen. Type: String.

getter/setter pair

disableBarcodeSkip ↔ bool?

If disableBarcodeSkip is set to true SDK forces users to scan barcode before enabling capture button to continue. Type: bool

getter/setter pair

docType ↔ DocumentType?

docType: The type of the document to be captured. Type: DocumentType.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

hvDocCaptureUIStrings ↔ HVDocCaptureUIStrings?

hvDocCaptureUIStrings: The document capture UI strings. Type: HVDocCaptureUIStrings.

getter/setter pair

hvOCRAPIDetails ↔ HVOCRAPIDetails?

hvOCRAPIDetails: The OCR API details. Type: HVOCRAPIDetails.

getter/setter pair

padding ↔ double?

padding: The padding value for document captures. Type: double.

getter/setter pair

readBarcodeTimeout ↔ int?

readBarcodeTimeout: The duration after which the capture button is enabled when readBarcode is enabled. Type: int.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

shouldAddPadding ↔ bool?

shouldAddPadding: Specifies whether the captured image needs to be padded. Type: bool.

getter/setter pair

shouldAutoCapture ↔ bool?

shouldAutoCapture: Specifies whether to enable auto capture functionality. Type: bool. Please contact Hyperverge incase you want to enable this feature

getter/setter pair

shouldEnableDocumentUpload ↔ bool?

shouldEnableDocumentUpload: Enables the document upload option. Type: bool.

getter/setter pair

shouldEnableRetries ↔ bool?

shouldEnableRetries: Specifies whether the SDK should handle retries after any document capture screen. Type: bool.

getter/setter pair

shouldReadBarcode ↔ bool?

shouldReadBarcode: Specifies whether to read barcode in document capture screen. Type: bool.

getter/setter pair

shouldShowCloseAlert ↔ bool?

shouldShowCloseAlert: Specifies whether to display the close alert dialog when the user tries to close any HyperSnapSDK screens. Type: bool.

getter/setter pair

shouldShowFlashIcon ↔ bool?

shouldShowFlashIcon: Specifies whether to display the flash icon to the user. Type: bool.

getter/setter pair

shouldShowInstructionPage ↔ bool?

shouldShowInstructionPage: Specifies whether to show the instructions page to the user. Type: bool.

getter/setter pair

shouldShowReviewScreen ↔ bool?

shouldShowReviewScreen: Specifies whether to show the review screen to the user. Type: bool.

getter/setter pair

shouldShowTrustLogos ↔ bool?

shouldShowTrustLogos: Specifies whether to show trust logos in HyperSnapSDK screens. Type: bool.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toMap() → Map<String, dynamic>

Converts the HVDocConfig object to a map of key-value pairs.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited