Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 0 additions & 33 deletions programming/flutter/api-reference/enum/mapping-status.md

This file was deleted.

37 changes: 0 additions & 37 deletions programming/flutter/api-reference/enum/validation-status.md

This file was deleted.

18 changes: 3 additions & 15 deletions programming/flutter/api-reference/parsed-field.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
Expand All @@ -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`.
Expand All @@ -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.
15 changes: 13 additions & 2 deletions programming/flutter/api-reference/parsed-result-item.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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<String, ParsedField> parsedFields;
Expand Down
12 changes: 6 additions & 6 deletions programming/flutter/api-reference/parsed-result.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,19 @@ class ParsedResult
| -------- | ---- | ----------- |
| [`items`](#items) | *List\<ParsedResultItem\>?* | 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

A list of [`ParsedResultItem`](parsed-result-item.md), the basic unit representing a single parsed result from an encrypted text.

```dart
List<ParsedResultItem>? items;
```
```