Skip to content

Commit 557449e

Browse files
Dynamsoft-HenryDynamsoft-Henry
authored
Merge pull request #22 from dynamsoft-docs/preview
Preview
2 parents fb25523 + 395c8d9 commit 557449e

File tree

6 files changed

+254
-0
lines changed

6 files changed

+254
-0
lines changed

‎_config.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,15 @@ dcp_maui: /code-parser/docs/mobile/programming/maui/
1919
dcp_maui_api: /code-parser/docs/mobile/programming/maui/api-reference/
2020
dcp_maui_release_notes: /code-parser/docs/mobile/programming/maui/release-notes/
2121

22+
dbr_flutter: /barcode-reader/docs/mobile/programming/flutter/
23+
dbr_flutter_api: /barcode-reader/docs/mobile/programming/flutter/api-reference/
24+
dce_flutter: /camera-enhancer/docs/mobile/programming/flutter/
25+
dce_flutter_api: /camera-enhancer/docs/mobile/programming/flutter/api-reference/
26+
dcv_flutter: /capture-vision/docs/mobile/programming/flutter/
27+
dcv_flutter_api: /capture-vision/docs/mobile/programming/flutter/api-reference/
28+
dcp_flutter: /code-parser/docs/mobile/programming/flutter/
29+
dcp_flutter_api: /code-parser/docs/mobile/programming/flutter/api-reference/
30+
2231
dcv_android_api: /capture-vision/docs/mobile/programming/android/api-reference/
2332
dcv_ios_api: /capture-vision/docs/mobile/programming/ios/api-reference/
2433
dcv_maui_api: /capture-vision/docs/mobile/programming/maui/api-reference/

‎programming/flutter/api-reference/enum/mapping-status.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
layout: default-layout
3+
title: EnumMappingStatus - Dynamsoft Barcode Reader Flutter
4+
description: Enumeration EnumMappingStatus of DBR Flutter Edition defines whether the field was mapped from the source data or not
5+
keywords: captured result, flutter, capture vision, mapping, code parser, mapping
6+
needAutoGenerateSidebar: true
7+
needGenerateH3Content: true
8+
breadcrumbText: EnumMappingStatus
9+
---
10+
11+
# EnumMappingStatus
12+
13+
`EnumMappingStatus` is an enumeration that represents whether the associated field was mapped from the source data or not.
14+
15+
## Definition
16+
17+
*Assembly:* dynamsoft_capture_vision_flutter
18+
19+
```dart
20+
enum EnumMappingStatus {
21+
none,
22+
succeeded,
23+
failed
24+
}
25+
```
26+
27+
## Members
28+
29+
| Member | Description |
30+
| ------ | ----------- |
31+
| `none` | No mapping has been performed. |
32+
| `succeeded` | Mapping of this field was successful. |
33+
| `failed` | Mapping of this field was unsuccessful. |

‎programming/flutter/api-reference/enum/validation-status.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
layout: default-layout
3+
title: EnumValidationStatus - Dynamsoft Barcode Reader Flutter
4+
description: Enumeration EnumValidationStatus of DBR Flutter Edition defines the status of a field's value after the internal validation checks
5+
keywords: captured result, flutter, capture vision, mapping, code parser, validation
6+
needAutoGenerateSidebar: true
7+
needGenerateH3Content: true
8+
breadcrumbText: EnumValidationStatus
9+
---
10+
11+
# EnumValidationStatus
12+
13+
`EnumValidationStatus` is an enumeration that represents whether the associated field's value passed the internal validation checks.
14+
15+
> [!NOTE]
16+
> 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.
17+
18+
19+
## Definition
20+
21+
*Assembly:* dynamsoft_capture_vision_flutter
22+
23+
```dart
24+
enum EnumValidationStatus {
25+
none,
26+
succeeded,
27+
failed
28+
}
29+
```
30+
31+
## Members
32+
33+
| Member | Description |
34+
| ------ | ----------- |
35+
| `none` | No validation check has been performed. |
36+
| `succeeded` | The validation of this field was successful. |
37+
| `failed` | The validation of this field was unsuccessful. |

‎programming/flutter/api-reference/parsed-field.md‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
layout: default-layout
3+
title: ParsedField Class - Dynamsoft Capture Vision Flutter Edition
4+
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.
5+
keywords: originalImageHashId, items, errorCode, ParsedField, api reference, barcode result, capture, flutter, code parser
6+
needAutoGenerateSidebar: true
7+
needGenerateH3Content: true
8+
breadcrumbText: ParsedField
9+
---
10+
11+
# ParsedField Class
12+
13+
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.
14+
15+
## Definition
16+
17+
*Assembly:* dynamsoft_capture_vision_flutter
18+
19+
```dart
20+
class ParsedField
21+
```
22+
23+
## Properties
24+
25+
| Property | Type | Description |
26+
| -------- | ---- | ----------- |
27+
| [`value`](#value) | *String* | The processed value of the parsed field. |
28+
| [`rawValue`](#value) | *String* | The raw string value of the field as obtained from the source data. |
29+
| [`mappingStatus`](#mappingstatus) | [*EnumMappingStatus*](./enum/mapping-status.md) | A status representing whether the field was mapped from the source data or not. |
30+
| [`validationStatus`](#validationstatus) | [*EnumValidationStatus*](./enum/validation-status.md) | The status of a field's value after the internal validation checks. |
31+
32+
### value
33+
34+
The processed value of the parsed field.
35+
36+
```dart
37+
String value;
38+
```
39+
40+
**Remarks**
41+
42+
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".
43+
44+
### rawValue
45+
46+
The raw string value of the field as obtained from the source data.
47+
48+
```dart
49+
String rawValue;
50+
```
51+
52+
**Remarks**
53+
54+
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".
55+
56+
### mappingStatus
57+
58+
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`.
59+
60+
```dart
61+
EnumMappingStatus mappingStatus;
62+
```
63+
64+
### validationStatus
65+
66+
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`.
67+
68+
```dart
69+
String codeType;
70+
```
71+
72+
**Remarks**
73+
74+
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.

‎programming/flutter/api-reference/parsed-result-item.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
layout: default-layout
3+
title: ParsedResultItem Class - Dynamsoft Capture Vision Flutter Edition
4+
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.
5+
keywords: originalImageHashId, items, errorCode, ParsedResultItem, api reference, barcode result, capture, flutter, code parser
6+
needAutoGenerateSidebar: true
7+
needGenerateH3Content: true
8+
breadcrumbText: ParsedResultItem
9+
---
10+
11+
# ParsedResultItem Class
12+
13+
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.
14+
15+
## Definition
16+
17+
*Assembly:* dynamsoft_capture_vision_flutter
18+
19+
```dart
20+
class ParsedResultItem
21+
```
22+
23+
## Properties
24+
25+
| Property | Type | Description |
26+
| -------- | ---- | ----------- |
27+
| [`parsedFields`](#parsedfields) | *Map\<String, ParsedField\>* | A map of parsed fields extracted from the parsed result. |
28+
| [`jsonString`](#jsonstring) | *String* | The raw JSON string representation of the parsed result. |
29+
| [`codeType`](#codetype) | *String* | The type of the encrypted code associated to the attached parsed result. |
30+
31+
### parsedFields
32+
33+
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.
34+
35+
```dart
36+
Map<String, ParsedField> parsedFields;
37+
```
38+
39+
**Remarks**
40+
41+
Once the field is accessed, it is represented as a [`ParsedField`](parsed-field.md) object.
42+
43+
### jsonString
44+
45+
The text of the parsed result as a JSON string.
46+
47+
```dart
48+
String jsonString;
49+
```
50+
51+
### codeType
52+
53+
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.
54+
55+
```dart
56+
String codeType;
57+
```

‎programming/flutter/api-reference/parsed-result.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
layout: default-layout
3+
title: ParsedResult Class - Dynamsoft Capture Vision Flutter Edition
4+
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.
5+
keywords: originalImageHashId, items, errorCode, ParsedResult, api reference, barcode result, capture, flutter, code parser
6+
needAutoGenerateSidebar: true
7+
needGenerateH3Content: true
8+
breadcrumbText: ParsedResult
9+
---
10+
11+
# ParsedResult Class
12+
13+
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.
14+
15+
## Definition
16+
17+
*Assembly:* dynamsoft_capture_vision_flutter
18+
19+
```dart
20+
class ParsedResult
21+
```
22+
23+
## Properties
24+
25+
| Property | Type | Description |
26+
| -------- | ---- | ----------- |
27+
| [`items`](#items) | *List\<ParsedResultItem\>?* | A list of [`ParsedResultItem`](parsed-result-item.md), the basic unit representing a single parsed result from an encrypted text. |
28+
29+
The following properties are inherited from [`CapturedResult`]({{ site.dcv_flutter_api }}capture-vision-router/captured-result.html):
30+
31+
| Property | Type | Description |
32+
| -------- | ---- | ----------- |
33+
| [`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. |
34+
| [`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. |
35+
| [`errorCode`]({{ site.dcv_flutter_api }}capture-vision-router/captured-result.html#errorcode) | *int* | The error code associated with the capture result. |
36+
| [`errorMessage`]({{ site.dcv_flutter_api }}capture-vision-router/captured-result.html#errormessage) | *String* | The error message associated with the capture result. |
37+
38+
### items
39+
40+
A list of [`ParsedResultItem`](parsed-result-item.md), the basic unit representing a single parsed result from an encrypted text.
41+
42+
```dart
43+
List<ParsedResultItem>? items;
44+
```

0 commit comments

Comments
 (0)