diff --git a/_includes/sidelist-programming/programming-flutter.html b/_includes/sidelist-programming/programming-flutter.html index 3f360cb1..e2862c97 100644 --- a/_includes/sidelist-programming/programming-flutter.html +++ b/_includes/sidelist-programming/programming-flutter.html @@ -34,8 +34,12 @@
  • CapturedResultReceiver
  • CapturedResult
  • DecodedBarcodesResult
    • +
  • BarcodeResultItem
  • CameraEnhancer
  • LicenseManager
    • +
  • ParsedResult
    • +
  • ParsedResultItem
    • +
  • ParsedField
  • SimplifiedCaptureVisionSettings
  • SimplifiedBarcodeReaderSettings
    • @@ -49,6 +53,8 @@
  • EnumGrayscaleEnhancementMode
  • EnumGrayscaleTransformationMode
  • EnumCapturedResultItemType
    • +
  • EnumMappingStatus
    • +
  • EnumValidationStatus
    • diff --git a/programming/flutter/api-reference/barcode-scanner/barcode-scan-result.md b/programming/flutter/api-reference/barcode-scanner/barcode-scan-result.md index dee49599..3d475fed 100644 --- a/programming/flutter/api-reference/barcode-scanner/barcode-scan-result.md +++ b/programming/flutter/api-reference/barcode-scanner/barcode-scan-result.md @@ -12,7 +12,7 @@ breadcrumbText: BarcodeScanResult `BarcodeScanResult` is a result class that contains all the decoded barcodes and their associated info. -## Definition +## Definition *Assembly:* dynamsoft-barcode-reader-bundle-flutter @@ -25,22 +25,22 @@ class BarcodeScanResult | Property | Type | Description | | -------- | ---- | ----------- | -| [`barcodes`](#barcodes) | *List\* | Represents all the decoded barcodes in a list of [`BarcodeResultItem`](../barcode-result-item.md). | +| [`barcodes`](#barcodes) | *List\* | Represents all the decoded barcodes in a list of [`BarcodeResultItem`](../capture-vision-router-lite/barcode-result-item.md). | | [`status`](#status) | [*EnumResultStatus*](../enum/result-status.md) | Represents the result status, which can be finished, canceled or exception. | | [`errorCode`](#errorcode) | *int* | Represents the error code should something go wrong during the barcode scanning process. | | [`errorString`](#errorstring) | *string* | Represents the error message associated with the error code should something go wrong during the barcode scanning process. | ### barcodes -Represents all the decoded barcodes in an array of [`BarcodeResultItem`](../barcode-result-item.md). +Represents all the decoded barcodes in an array of [`BarcodeResultItem`](../capture-vision-router-lite/barcode-result-item.md). ```dart List? barcodes; ``` -**See also** +**Remarks** -- [`BarcodeResultItem`](../barcode-result-item.md). +Each individual decoded barcode comes out as a [`BarcodeResultItem`](../capture-vision-router-lite/barcode-result-item.md), which is part of the Foundational Capture Vision API. ### status diff --git a/programming/flutter/api-reference/barcode-scanner/index.md b/programming/flutter/api-reference/barcode-scanner/index.md index 8ed7ec79..90e1ee01 100644 --- a/programming/flutter/api-reference/barcode-scanner/index.md +++ b/programming/flutter/api-reference/barcode-scanner/index.md @@ -37,5 +37,5 @@ The BarcodeScanner class is built on top of the Capture Vision Foundational API ### BarcodeScanResult -[`BarcodeScanResult`](barcode-scan-result.md) is a result class that contains all the decoded barcodes and their associated info. This class is dependent on the [`BarcodeResultItem`](../barcode-result-item.md) class which is part of the Capture Vision Foundational API. +[`BarcodeScanResult`](barcode-scan-result.md) is a result class that contains all the decoded barcodes and their associated info. This class is dependent on the [`BarcodeResultItem`](../capture-vision-router-lite/barcode-result-item.md) class which is part of the Capture Vision Foundational API. diff --git a/programming/flutter/api-reference/capture-vision-router-lite/barcode-result-item.md b/programming/flutter/api-reference/capture-vision-router-lite/barcode-result-item.md new file mode 100644 index 00000000..6ccab5ff --- /dev/null +++ b/programming/flutter/api-reference/capture-vision-router-lite/barcode-result-item.md @@ -0,0 +1,116 @@ +--- +layout: default-layout +title: BarcodeResultItem Class - Dynamsoft Barcode Reader Flutter Edition +description: BarcodeResultItem class represents a barcode result item decoded by barcode reader engine. It is derived from CapturedResultItem. +keywords: GetFormat, GetText, GetLocation, GetConfidence, GetModuleSize, BarcodeResultItem, api reference, flutter, barcode reader +needAutoGenerateSidebar: true +needGenerateH3Content: true +breadcrumbText: BarcodeResultItem +--- + +# BarcodeResultItem Class + +The `BarcodeResultItem` class represents a single barcode result decoded by the barcode reader. It is part of the [`DecodedBarcodesResult`](../api-reference/capture-vision-router-lite/decoded-barcodes-result.md), which is what the library outputs at the end of the barcode recognition process. + +## Definition + +*Assembly:* dynamsoft_capture_vision_flutter + +```dart +class BarcodeResultItem +``` + +## Properties + +| Property | Type | Description | +| -------- | ---- | ----------- | +| [`format`](#format) | *[EnumBarcodeFormat](./enum/barcode-format.md)* | The format of the barcode represented as [`EnumBarcodeFormat`](./enum/barcode-format.md). | +| [`formatString`](#formatstring) | *String* | The format of the barcode as a text string. | +| [`text`](#text) | *String* | The decoded text of the barcode. | +| [`bytes`](#bytes) | *Uint8List* | The raw bytes of the barcode. | +| [`location`](#location) | *Quadrilateral* | The location of the barcode in the image/frame. | +| [`confidence`](#confidence) | *int* | The confidence of the barcode result. | +| [`angle`](#angle) | *int* | The angle at which the barcode is detected if it's not aligned in the image/frame. | +| [`moduleSize`](#modulesize) | *int* | The size of the smallest module (dot or line) of the barcode. | +| [`isDPM`](#isdpm) | *bool* | Indicates whether the barcode is a Dot Peen Marking (DPM). | +| [`isMirrored`](#ismirrored) | *bool* | Indicates whether the barcode image is mirrored. | + +### format + +The format of the barcode represented as [`EnumBarcodeFormat`](./enum/barcode-format.md). + +```dart +EnumBarcodeFormat format; +``` + +### formatString + +The format of the barcode as a text string instead of a `EnumBarcodeFormat`. + +```dart +String formatString; +``` + +### text + +The decoded text of the barcode. + +```dart +String text; +``` + +### bytes + +The raw bytes of the barcode. + +```dart +Uint8List bytes; +``` + +### location + +The location of the barcode in the image/frame as a `Quadrilateral`. The quadrilateral contains the four vertex points of the location, with the first vertex being the left-most vertex, then going in a clockwise direction for the remaining points. + +```dart +Quadrilateral location; +``` + +### confidence + +The confidence of the barcode result is a measure of the result's accuracy. If the confidence is lower than 30, the result will not be output by default as it is considered quite inaccurate. + +```dart +int confidence; +``` + +### angle + +The angle at which the barcode is detected if it's not aligned in the image/frame. + +```dart +int angle; +``` + +### moduleSize + +The size of the smallest module (dot or line) of the barcode. + +```dart +int moduleSize; +``` + +### isDPM + +Indicates whether the barcode is a Dot Peen Marking (DPM), which is a unique type of Datamatrix code. + +```dart +bool isDPM; +``` + +### isMirrored + +Indicates whether the barcode image is mirrored. + +```dart +bool isMirrored; +``` diff --git a/programming/flutter/api-reference/capture-vision-router-lite/captured-result.md b/programming/flutter/api-reference/capture-vision-router-lite/captured-result.md index 43b67e4e..074febb4 100644 --- a/programming/flutter/api-reference/capture-vision-router-lite/captured-result.md +++ b/programming/flutter/api-reference/capture-vision-router-lite/captured-result.md @@ -13,7 +13,7 @@ noTitleIndex: true The `CapturedResult` class represents the result of a capture operation on an image. Internally, `CapturedResult` stores an array of `CapturedResultItem`, each of which may be a barcode, text line, detected quad, normalized image, original image, or parsed item depending on the functional product that is used. > [!TIP] -> In the context of the Barcode Reader, you will most likely be using the [DecodedBarcodesResult]({{ site.dbr_maui_api }}decoded-barcodes-result.html) as the main result type. +> In the context of the Barcode Reader, you will most likely be using the [DecodedBarcodesResult](decoded-barcodes-result.md) as the main result type. ## Definition diff --git a/programming/flutter/api-reference/capture-vision-router-lite/decoded-barcodes-result.md b/programming/flutter/api-reference/capture-vision-router-lite/decoded-barcodes-result.md index 77cde8f4..9f1913d5 100644 --- a/programming/flutter/api-reference/capture-vision-router-lite/decoded-barcodes-result.md +++ b/programming/flutter/api-reference/capture-vision-router-lite/decoded-barcodes-result.md @@ -24,16 +24,16 @@ class DecodedBarcodesResult | Property | Type | Description | | -------- | ---- | ----------- | -| [`items`](#items) | *List?* | A list of [`BarcodeResultItem`](barcode-result-item.md), the basic unit representing a single barcode result. | +| [`items`](#items) | *List\?* | A list of [`BarcodeResultItem`](barcode-result-item.md), the basic unit representing a single barcode result. | The following properties are inherited from [`CapturedResult`](./capture-vision-router-lite/captured-result.md): | Property | Type | Description | | -------- | ---- | ----------- | -| [`originalImageHashId`](#originalimagehashid) | *String* | The hash id of the original image. You can use this ID to get the original image via the `IntermediateResultManager` class. | -| [`rotationTransformMatrix`](#rotationtransformmatrix) | *Matrix4* | The rotation transformation matrix of the original image relative to the rotated image. | -| [`errorCode`](#errorcode) | *int* | The error code associated with the capture result. | -| [`errorMessage`](#errormessage) | *String* | The error message associated with the capture result. | +| [`originalImageHashId`](../capture-vision-router-lite/captured-result.md#originalimagehashid) | *String* | The hash id of the original image. You can use this ID to get the original image via the `IntermediateResultManager` class. | +| [`rotationTransformMatrix`](../capture-vision-router-lite/captured-result.md#rotationtransformmatrix) | *Matrix4* | The rotation transformation matrix of the original image relative to the rotated image. | +| [`errorCode`](../capture-vision-router-lite/captured-result.md#errorcode) | *int* | The error code associated with the capture result. | +| [`errorMessage`](../capture-vision-router-lite/captured-result.md#errormessage) | *String* | The error message associated with the capture result. | ### items diff --git a/programming/flutter/api-reference/capture-vision-router-lite/parsed-field.md b/programming/flutter/api-reference/capture-vision-router-lite/parsed-field.md new file mode 100644 index 00000000..2e564a8e --- /dev/null +++ b/programming/flutter/api-reference/capture-vision-router-lite/parsed-field.md @@ -0,0 +1,57 @@ +--- +layout: default-layout +title: ParsedField Class - Dynamsoft Capture Vision Flutter Edition +description: The ParsedField class represents the result of a code parsing process. It provides access to the individual parsed items resulting from a document or an encrypted text. +keywords: originalImageHashId, items, errorCode, ParsedField, api reference, barcode result, capture, flutter, code parser +needAutoGenerateSidebar: true +needGenerateH3Content: true +breadcrumbText: ParsedField +--- + +# ParsedField Class + +The `ParsedField` class represents a field from the [`ParsedResultItem`](parsed-result-item.md) output of an encrypted text coming from a document or a data source. It contains the parsed value along with its mapping and validation status. + +## Definition + +*Assembly:* dynamsoft_capture_vision_flutter + +```dart +class ParsedField +``` + +## Properties + +| Property | Type | Description | +| -------- | ---- | ----------- | +| [`value`](#value) | *String* | The raw string value of the parsed field. | +| [`mappingStatus`](#mappingstatus) | [*EnumMappingStatus*](../enum/mapping-status.md) | A status representing whether the field was mapped from the source data or not. | +| [`validationStatus`](#validationstatus) | [*EnumValidationStatus*](../enum/validation-status.md) | The status of a field's value after the internal validation checks. | + +### value + +The raw string value of the parsed field. + +```dart +String value; +``` + +### mappingStatus + +A status representing whether the field was mapped from the source data or not, represented as a [`EnumMappingStatus`](../enum/mapping-status.md). If the field was unsuccessful during the mapping process, the mappingStatus would be `EnumMappingStatus.failed`. + +```dart +EnumMappingStatus mappingStatus; +``` + +### validationStatus + +The status of a field's value after the internal validation checks, represented as a [`EnumValidationStatus`](../enum/validation-status.md). Once a field is parsed by the Code Parser, it is run through validation checks to make sure that the information is accurate and correct. If a field's value does not pass, the validationStatus would be `EnumValidationStatus.failed`. + +```dart +String codeType; +``` + +**Remarks** + +An example of a failed validation check is if the month of a birth date is April 31 for instance. Since that is anb invalid day, the date of birth field will be marked as invalid. The validation check does not compare the info of a parsed field against a database or anything of the kind in order to verify if the information is correct. diff --git a/programming/flutter/api-reference/capture-vision-router-lite/parsed-result-item.md b/programming/flutter/api-reference/capture-vision-router-lite/parsed-result-item.md new file mode 100644 index 00000000..1e57d4dd --- /dev/null +++ b/programming/flutter/api-reference/capture-vision-router-lite/parsed-result-item.md @@ -0,0 +1,53 @@ +--- +layout: default-layout +title: ParsedResultItem Class - Dynamsoft Capture Vision Flutter Edition +description: The ParsedResult class represents the result of a code parsing process. It provides access to the individual parsed items resulting from a document or an encrypted text. +keywords: originalImageHashId, items, errorCode, ParsedResultItem, api reference, barcode result, capture, flutter, code parser +needAutoGenerateSidebar: true +needGenerateH3Content: true +breadcrumbText: ParsedResultItem +--- + +# ParsedResultItem Class + +The `ParsedResultItem` class represents the most basic unit of a parsed result. It includes specific details relevant to the parsed data, including the code type, the raw JSON string, and a map of the individual parsed fields. + +## Definition + +*Assembly:* dynamsoft_capture_vision_flutter + +```dart +class ParsedResultItem +``` + +## Properties + +| Property | Type | Description | +| -------- | ---- | ----------- | +| [`parsedFields`](#parsedfields) | *Map\* | A map of parsed fields extracted from the parsed result. | +| [`jsonString`](#jsonstring) | *String* | The raw JSON string representation of the parsed result. | +| [`codeType`](#codetype) | *String* | The type of the encrypted code associated to the attached parsed result. | + +### parsedFields + +A map of the parsed fields extracted from the parsed result. Each field can then be accessed by the associated key, allowing the developer to present the parsed info in a user-friendly manner. + +```dart +Map parsedFields; +``` + +### jsonString + +The text of the parsed result as a JSON string. + +```dart +String jsonString; +``` + +### codeType + +The type of the encrypted code associated to the attached parsed result. The code can be a MRZ document (passport, visa, etc.), a driver license (North America or South Africa), or an Aadhar card. + +```dart +String codeType; +``` diff --git a/programming/flutter/api-reference/capture-vision-router-lite/parsed-result.md b/programming/flutter/api-reference/capture-vision-router-lite/parsed-result.md new file mode 100644 index 00000000..ebe2b288 --- /dev/null +++ b/programming/flutter/api-reference/capture-vision-router-lite/parsed-result.md @@ -0,0 +1,44 @@ +--- +layout: default-layout +title: ParsedResult Class - Dynamsoft Capture Vision Flutter Edition +description: The ParsedResult class represents the result of a code parsing process. It provides access to the individual parsed items resulting from a document or an encrypted text. +keywords: originalImageHashId, items, errorCode, ParsedResult, api reference, barcode result, capture, flutter, code parser +needAutoGenerateSidebar: true +needGenerateH3Content: true +breadcrumbText: ParsedResult +--- + +# ParsedResult Class + +The `ParsedResult` class represents the result of a code parsing process. It provides access to the individual parsed items resulting from a document or an encrypted text. + +## Definition + +*Assembly:* dynamsoft_capture_vision_flutter + +```dart +class ParsedResult +``` + +## Properties + +| Property | Type | Description | +| -------- | ---- | ----------- | +| [`items`](#items) | *List\?* | A list of [`ParsedResultItem`](parsed-result-item.md), the basic unit representing a single parsed result from an encrypted text. | + +The following properties are inherited from [`CapturedResult`](./capture-vision-router-lite/captured-result.md): + +| Property | Type | Description | +| -------- | ---- | ----------- | +| [`originalImageHashId`](../capture-vision-router-lite/captured-result.md#originalimagehashid) | *String* | The hash id of the original image. You can use this ID to get the original image via the `IntermediateResultManager` class. | +| [`rotationTransformMatrix`](../capture-vision-router-lite/captured-result.md#rotationtransformmatrix) | *Matrix4* | The rotation transformation matrix of the original image relative to the rotated image. | +| [`errorCode`](../capture-vision-router-lite/captured-result.md#errorcode) | *int* | The error code associated with the capture result. | +| [`errorMessage`](../capture-vision-router-lite/captured-result.md#errormessage) | *String* | The error message associated with the capture result. | + +### items + +A list of [`ParsedResultItem`](parsed-result-item.md), the basic unit representing a single parsed result from an encrypted text. + +```dart +List? items; +``` \ No newline at end of file diff --git a/programming/flutter/api-reference/capture-vision-router-lite/simplified-barcode-reader-settings.md b/programming/flutter/api-reference/capture-vision-router-lite/simplified-barcode-reader-settings.md index 108e5ba0..8521e89d 100644 --- a/programming/flutter/api-reference/capture-vision-router-lite/simplified-barcode-reader-settings.md +++ b/programming/flutter/api-reference/capture-vision-router-lite/simplified-barcode-reader-settings.md @@ -29,14 +29,14 @@ class SimplifiedBarcodeReaderSettings |----------|------|-------------| | [`barcodeFormatIds`](#barcodeformatids) | [*EnumBarcodeFormat*](./enum/barcode-format.md) | Specifies which barcode format(s) the Barcode Reader will target. | | [`expectedBarcodesCount`](#expectedbarcodescount) | *int* | Determines the expected barcode count, which can be set to 0 if the barcode count is unknown. | -| [`localizationModes`](#localizationmodes) | *List* | Defines which localization modes (as [`EnumLocalizationMode`](./enum/localization-mode.md)) the barcode reader will use during the detection process. | +| [`localizationModes`](#localizationmodes) | *List\* | Defines which localization modes (as [`EnumLocalizationMode`](./enum/localization-mode.md)) the barcode reader will use during the detection process. | | [`deblurModes`](#deblurmodes) | *List* | Sets which deblur algorithms (as [`EnumDeblurMode`](./enum/deblur-mode.md)) the library will apply during the detection process when dealing with blurry images/frames. | | [`minResultConfidence`](#minresultconfidence) | *int* | Specifies the minimum barcode result confidence to help filter out inaccurate results. | | [`minBarcodeTextLength`](#minbarcodetextlength) | *int* | Sets the minimum barcode text length (in characters) for the barcode result to be considered valid. | | [`barcodeTextRegExPattern`](#barcodetextregexpattern) | *String* | Defines a regular expression pattern that the barcode text must match to be considered valid. | | [`maxThreadsInOneTask`](#maxthreadsinonetask) | *int* | Establishes the maximum number of threads available for a single detection task. | -| [`grayscaleTransformationModes`](#grayscaletransformationmodes) | *List* | Determines which grayscale transformation modes (as [`EnumGrayscaleTransformationMode`](./enum/grayscale-transformation-mode.md)) the barcode reader will apply before the detection process. | -| [`grayscaleEnhancementModes`](#grayscaleenhancementmodes) | *List* | Sets which grayscale enhancement modes (as [`EnumGrayscaleEnhancementModes`](./enum/grayscale-enhancement-mode.md)) the library will apply before the detection process. | +| [`grayscaleTransformationModes`](#grayscaletransformationmodes) | *List\* | Determines which grayscale transformation modes (as [`EnumGrayscaleTransformationMode`](./enum/grayscale-transformation-mode.md)) the barcode reader will apply before the detection process. | +| [`grayscaleEnhancementModes`](#grayscaleenhancementmodes) | *List\* | Sets which grayscale enhancement modes (as [`EnumGrayscaleEnhancementModes`](./enum/grayscale-enhancement-mode.md)) the library will apply before the detection process. | | [`scaleDownThreshold`](#scaledownthreshold) | *int* | Defines the threshold for scaling down the image/frame before processing to help with memory overhead. | ### barcodeFormatIds diff --git a/programming/flutter/api-reference/enum/captured-result-item-type.md b/programming/flutter/api-reference/enum/captured-result-item-type.md index e183236b..c22082d1 100644 --- a/programming/flutter/api-reference/enum/captured-result-item-type.md +++ b/programming/flutter/api-reference/enum/captured-result-item-type.md @@ -20,31 +20,13 @@ breadcrumbText: EnumCapturedResultItemType *Assembly:* dynamsoft_capture_vision_flutter ```dart -enum EnumDeblurMode +enum EnumCapturedResultItemType { - /** Skips the process, no deblurring is applied. */ - skip, - /** Applies a direct binarization algorithm for generating the binary image. */ - directBinarization, - /** Utilizes a threshold binarization algorithm for generating the binary image, dynamically determining the threshold based on the image content. */ - thresholdBinarization, - /** Employs a gray equalization algorithm to adjust the contrast and brightness, improving the clarity of the gray-scale image before binarization. */ - grayEqualization, - /** Implements a smoothing algorithm to reduce noise and artifacts, smoothing out the gray-scale image before binarization. */ - smoothing, - /** Uses a morphing algorithm to enhance the gray-scale image before binarization. */ - morphing, - /** Engages in a deep analysis of the grayscale image based on the barcode format to intelligently generate the optimized binary image, tailored to complex or severely blurred images. */ - deepAnalysis, - /** Applies a sharpening algorithm to enhance the edges and details of the barcode, making it more distinguishable on the gray-scale image before binarization. */ - sharpening, - /** Decodes the barcodes based on the binary image obtained during the localization process. */ - basedOnLocBin, - /** Combines sharpening and smoothing algorithms for a comprehensive deblurring effect, targeting both clarity and smoothness of the gray-scale image before binarization. */ - sharpeningSmoothing, - /** Use the deep learning algorithm to recognize the barcodes. */ - neuralNetwork, - /**Placeholder value with no functional meaning. */ - end + /** The original image on which the capture process was performed. This result type can be output by any of the Capture Vision functional products (Barcode Reader, Label Recognizer, and Document Normalizer) */ + originalImage, + /** The decoded barcode, which is the result at the end of a Barcode Reader task. */ + barcode, + /** The parsed result, which is the result at the end of a Code Parser task. */ + parsedResult } ``` diff --git a/programming/flutter/api-reference/enum/mapping-status.md b/programming/flutter/api-reference/enum/mapping-status.md new file mode 100644 index 00000000..c67795a7 --- /dev/null +++ b/programming/flutter/api-reference/enum/mapping-status.md @@ -0,0 +1,29 @@ +--- +layout: default-layout +title: EnumMappingStatus - Dynamsoft Barcode Reader Flutter +description: Enumeration EnumMappingStatus of DBR Flutter Edition defines whether the field was mapped from the source data or not +keywords: captured result, flutter, capture vision, mapping, code parser, mapping +needAutoGenerateSidebar: true +needGenerateH3Content: true +breadcrumbText: EnumMappingStatus +--- + +# EnumMappingStatus + +`EnumMappingStatus` is an enumeration that represents whether the associated field was mapped from the source data or not. + +## Definition + +*Assembly:* dynamsoft_capture_vision_flutter + +```dart +enum EnumDeblurMode +{ + /** No mapping has been performed. */ + none, + /** Mapping of this field was successful. */ + succeeded, + /** Mapping of this field was unsuccessful. */ + failed +} +``` diff --git a/programming/flutter/api-reference/enum/result-status.md b/programming/flutter/api-reference/enum/result-status.md index 31a7ff36..e57fa778 100644 --- a/programming/flutter/api-reference/enum/result-status.md +++ b/programming/flutter/api-reference/enum/result-status.md @@ -1,8 +1,8 @@ --- layout: default-layout title: EnumResultStatus - Dynamsoft Barcode Reader Flutter Edition -description: EnumResultStatus of DynamsoftBarcodeReader MAUI is an enumeration class that defines the result status of the BarcodeScanResult. -keywords: BarcodeReader, BarcodeScanResult, EnumResultStatus +description: EnumResultStatus of DynamsoftBarcodeReader Flutter is an enumeration class that defines the result status of the BarcodeScanResult. +keywords: BarcodeReader, BarcodeScanResult, EnumResultStatus, BarcodeScanner needAutoGenerateSidebar: true needGenerateH3Content: true breadcrumbText: EnumResultStatus @@ -10,7 +10,7 @@ breadcrumbText: EnumResultStatus # EnumResultStatus -`EnumResultStatus` is a enumeration that defines the result status of the associated `BarcodeScanResult`. +`EnumResultStatus` is a enumeration that defines the result status of the associated [`BarcodeScanResult`](../capture-vision-router-lite/barcode-result-item.md). ## Definition diff --git a/programming/flutter/api-reference/enum/validation-status.md b/programming/flutter/api-reference/enum/validation-status.md new file mode 100644 index 00000000..bf0d088f --- /dev/null +++ b/programming/flutter/api-reference/enum/validation-status.md @@ -0,0 +1,33 @@ +--- +layout: default-layout +title: EnumValidationStatus - Dynamsoft Barcode Reader Flutter +description: Enumeration EnumValidationStatus of DBR Flutter Edition defines the status of a field's value after the internal validation checks +keywords: captured result, flutter, capture vision, mapping, code parser, validation +needAutoGenerateSidebar: true +needGenerateH3Content: true +breadcrumbText: EnumValidationStatus +--- + +# EnumValidationStatus + +`EnumValidationStatus` is an enumeration that represents whether the associated field's value passed the internal validation checks. + +> [!NOTE] +> An example of a failed validation check is if the month of a birth date is April 31 for instance. Since that is anb invalid day, the date of birth field will be marked as invalid. The validation check does not compare the info of a parsed field against a database or anything of the kind in order to verify if the information is correct. + + +## Definition + +*Assembly:* dynamsoft_capture_vision_flutter + +```dart +enum EnumDeblurMode +{ + /** No validation check has been performed. */ + none, + /** The validation of this field was successful. */ + succeeded, + /** The validation of this field was unsuccessful. */ + failed +} +``` diff --git a/programming/flutter/driver-license-user-guide.md b/programming/flutter/driver-license-user-guide.md index b4971f65..dc616523 100644 --- a/programming/flutter/driver-license-user-guide.md +++ b/programming/flutter/driver-license-user-guide.md @@ -345,7 +345,7 @@ If everything is set up correctly, you should see the app running on your device ## Full Sample Code -The full sample code is available [here](./ScanDriversLicense). +The full sample code is available [here](https://github.com/Dynamsoft/barcode-reader-flutter-samples/tree/main/ScanDriversLicense). ## License diff --git a/programming/flutter/release-notes/index.md b/programming/flutter/release-notes/index.md index 0f31274a..99156972 100644 --- a/programming/flutter/release-notes/index.md +++ b/programming/flutter/release-notes/index.md @@ -1,6 +1,6 @@ --- layout: default-layout -title: MAUI Release Notes - Dynamsoft Barcode Reader Flutter SDK +title: Flutter Release Notes - Dynamsoft Barcode Reader Flutter SDK description: This is the release notes page of Dynamsoft Barcode Reader for Flutter SDK. keywords: release notes, Flutter, barcode reader needAutoGenerateSidebar: false