diff --git a/programming/flutter/api-reference/enum/mapping-status.md b/programming/flutter/api-reference/enum/mapping-status.md deleted file mode 100644 index dde7a7f..0000000 --- a/programming/flutter/api-reference/enum/mapping-status.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -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 EnumMappingStatus { - none, - succeeded, - failed -} -``` - -## Members - -| Member | Description | -| ------ | ----------- | -| `none` | No mapping has been performed. | -| `succeeded` | Mapping of this field was successful. | -| `failed` | Mapping of this field was unsuccessful. | diff --git a/programming/flutter/api-reference/enum/validation-status.md b/programming/flutter/api-reference/enum/validation-status.md deleted file mode 100644 index d86336b..0000000 --- a/programming/flutter/api-reference/enum/validation-status.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -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 EnumValidationStatus { - none, - succeeded, - failed -} -``` - -## Members - -| Member | Description | -| ------ | ----------- | -| `none` | No validation check has been performed. | -| `succeeded` | The validation of this field was successful. | -| `failed` | The validation of this field was unsuccessful. | diff --git a/programming/flutter/api-reference/parsed-field.md b/programming/flutter/api-reference/parsed-field.md index bb21156..02fb54d 100644 --- a/programming/flutter/api-reference/parsed-field.md +++ b/programming/flutter/api-reference/parsed-field.md @@ -26,8 +26,8 @@ class ParsedField | -------- | ---- | ----------- | | [`value`](#value) | *String* | The processed value of the parsed field. | | [`rawValue`](#value) | *String* | The raw string value of the field as obtained from the source data. | -| [`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. | +| [`mappingStatus`](#mappingstatus) | [*EnumMappingStatus*]({{ site.dcv_flutter_api }}core/enum/mapping-status.html) | A status representing whether the field was mapped from the source data or not. | +| [`validationStatus`](#validationstatus) | [*EnumValidationStatus*]({{ site.dcv_flutter_api }}core/enum/validation-status.html) | The status of a field's value after the internal validation checks. | ### value @@ -37,10 +37,6 @@ The processed value of the parsed field. String value; ``` -**Remarks** - -The processed value usually comes in handy when dealing with country codes. For example, if the passport is from Canada, the processed string value would be "Canada" while the raw string value is "CAN". - ### rawValue The raw string value of the field as obtained from the source data. @@ -49,10 +45,6 @@ The raw string value of the field as obtained from the source data. String rawValue; ``` -**Remarks** - -The processed value usually comes in handy when dealing with country codes. For example, if the passport is from Canada, the processed string value would be "Canada" while the raw string value is "CAN". - ### 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`. @@ -66,9 +58,5 @@ EnumMappingStatus mappingStatus; 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; +EnumValidationStatus validationStatus; ``` - -**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/parsed-result-item.md b/programming/flutter/api-reference/parsed-result-item.md index 8aa911c..c13cd97 100644 --- a/programming/flutter/api-reference/parsed-result-item.md +++ b/programming/flutter/api-reference/parsed-result-item.md @@ -17,7 +17,7 @@ The `ParsedResultItem` class represents the most basic unit of a parsed result. *Assembly:* dynamsoft_capture_vision_flutter ```dart -class ParsedResultItem +class ParsedResultItem extends CapturedResultItem ``` ## Properties @@ -28,9 +28,20 @@ class ParsedResultItem | [`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. | +The following methods are inherited from [`CapturedResultItem`]({{ site.dcv_flutter_api }}core/captured-result-item.html). + +| Property | Type | Description | +| -------- | ---- | ----------- | +| [`targetROIDefName`]({{ site.dcv_flutter_api }}core/captured-result-item.html#targetroidefname) | *String* | The name of the target region of interest (ROI) where the captured result was found. | +| [`taskName`]({{ site.dcv_flutter_api }}core/captured-result-item.html#taskname) | *String* | The name of the recognition task that produced the CapturedResultItem. | +| [`type`]({{ site.dcv_flutter_api }}core/captured-result-item.html#type) | [*EnumCapturedResultItemType*]({{ site.dcv_flutter_api }}core/enum/captured-result-item-type.html) | The type of the captured result item. | + ### 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. +A map of the parsed fields extracted from the parsed result. + +- Key: The field names of the code. [Check the available field names]({{ site.code_types }}) +- Value: [`ParsedField`](parsed-field.md) ```dart Map parsedFields; diff --git a/programming/flutter/api-reference/parsed-result.md b/programming/flutter/api-reference/parsed-result.md index d90d82e..81049ac 100644 --- a/programming/flutter/api-reference/parsed-result.md +++ b/programming/flutter/api-reference/parsed-result.md @@ -26,14 +26,14 @@ class ParsedResult | -------- | ---- | ----------- | | [`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`]({{ site.dcv_flutter_api }}capture-vision-router/captured-result.html): +The following properties are inherited from [`CapturedResultBase`]({{ site.dcv_flutter_api }}core/captured-result-base.html): | Property | Type | Description | | -------- | ---- | ----------- | -| [`originalImageHashId`]({{ site.dcv_flutter_api }}capture-vision-router/captured-result.html#originalimagehashid) | *String* | The hash id of the original image. You can use this ID to get the original image via the `IntermediateResultManager` class. | -| [`rotationTransformMatrix`]({{ site.dcv_flutter_api }}capture-vision-router/captured-result.html#rotationtransformmatrix) | *Matrix4* | The rotation transformation matrix of the original image relative to the rotated image. | -| [`errorCode`]({{ site.dcv_flutter_api }}capture-vision-router/captured-result.html#errorcode) | *int* | The error code associated with the capture result. | -| [`errorMessage`]({{ site.dcv_flutter_api }}capture-vision-router/captured-result.html#errormessage) | *String* | The error message associated with the capture result. | +| [`originalImageHashId`]({{ site.dcv_flutter_api }}core/captured-result-base.html#originalimagehashid) | *String* | The hash id of the original image. You can use this ID to get the original image via the `IntermediateResultManager` class. | +| [`rotationTransformMatrix`]({{ site.dcv_flutter_api }}core/captured-result-base.html#rotationtransformmatrix) | *Matrix4* | The rotation transformation matrix of the original image relative to the rotated image. | +| [`errorCode`]({{ site.dcv_flutter_api }}core/captured-result-base.html#errorcode) | *int* | The error code associated with the capture result. | +| [`errorMessage`]({{ site.dcv_flutter_api }}core/captured-result-base.html#errormessage) | *String* | The error message associated with the capture result. | ### items @@ -41,4 +41,4 @@ A list of [`ParsedResultItem`](parsed-result-item.md), the basic unit representi ```dart List? items; -``` \ No newline at end of file +```