diff --git a/_config.yml b/_config.yml index 7fa7c45..de4c2bb 100644 --- a/_config.yml +++ b/_config.yml @@ -19,6 +19,15 @@ dcp_maui: /code-parser/docs/mobile/programming/maui/ dcp_maui_api: /code-parser/docs/mobile/programming/maui/api-reference/ dcp_maui_release_notes: /code-parser/docs/mobile/programming/maui/release-notes/ +dbr_flutter: /barcode-reader/docs/mobile/programming/flutter/ +dbr_flutter_api: /barcode-reader/docs/mobile/programming/flutter/api-reference/ +dce_flutter: /camera-enhancer/docs/mobile/programming/flutter/ +dce_flutter_api: /camera-enhancer/docs/mobile/programming/flutter/api-reference/ +dcv_flutter: /capture-vision/docs/mobile/programming/flutter/ +dcv_flutter_api: /capture-vision/docs/mobile/programming/flutter/api-reference/ +dcp_flutter: /code-parser/docs/mobile/programming/flutter/ +dcp_flutter_api: /code-parser/docs/mobile/programming/flutter/api-reference/ + dcv_android_api: /capture-vision/docs/mobile/programming/android/api-reference/ dcv_ios_api: /capture-vision/docs/mobile/programming/ios/api-reference/ dcv_maui_api: /capture-vision/docs/mobile/programming/maui/api-reference/ 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 0000000..dde7a7f --- /dev/null +++ b/programming/flutter/api-reference/enum/mapping-status.md @@ -0,0 +1,33 @@ +--- +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 new file mode 100644 index 0000000..d86336b --- /dev/null +++ b/programming/flutter/api-reference/enum/validation-status.md @@ -0,0 +1,37 @@ +--- +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 new file mode 100644 index 0000000..bb21156 --- /dev/null +++ b/programming/flutter/api-reference/parsed-field.md @@ -0,0 +1,74 @@ +--- +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 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. | + +### value + +The processed value of the parsed field. + +```dart +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. + +```dart +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`. + +```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/parsed-result-item.md b/programming/flutter/api-reference/parsed-result-item.md new file mode 100644 index 0000000..8aa911c --- /dev/null +++ b/programming/flutter/api-reference/parsed-result-item.md @@ -0,0 +1,57 @@ +--- +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; +``` + +**Remarks** + +Once the field is accessed, it is represented as a [`ParsedField`](parsed-field.md) object. + +### 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/parsed-result.md b/programming/flutter/api-reference/parsed-result.md new file mode 100644 index 0000000..d90d82e --- /dev/null +++ b/programming/flutter/api-reference/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`]({{ site.dcv_flutter_api }}capture-vision-router/captured-result.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. | + +### 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