diff --git a/_config.yml b/_config.yml index a77227b..3fd7918 100644 --- a/_config.yml +++ b/_config.yml @@ -15,8 +15,13 @@ dcp_ios: /code-parser/docs/mobile/programming/ios/ dcp_ios_api: /code-parser/docs/mobile/programming/ios/api-reference/ dcp_ios_release_notes: /code-parser/docs/mobile/programming/ios/release-notes/ +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/ + 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/ dcv_enumerations: /capture-vision/docs/core/enums/ dcv_parameter_reference: /capture-vision/docs/core/parameters/reference/ dcv_parameter: /capture-vision/docs/core/parameters/ @@ -64,6 +69,11 @@ defaults: values: docRootName: "Code Parser iOS Edition" docHomePage: "/code-parser/docs/mobile/programming/ios/" + - scope: + path: "programming/maui" + values: + docRootName: "Code Parser MAUI Edition" + docHomePage: "/code-parser/docs/mobile/programming/maui/" - scope: path: "Hide_Tree_Page.html" values: diff --git a/_data/full_tree.yml b/_data/full_tree.yml index 71bec73..dbf13f9 100644 --- a/_data/full_tree.yml +++ b/_data/full_tree.yml @@ -2,3 +2,4 @@ tree_file_list: - sidelist-full-tree.html - sidelist-programming/programming-android.html - sidelist-programming/programming-ios.html + - sidelist-programming/programming-maui.html diff --git a/_data/product_version.yml b/_data/product_version.yml index 7e638de..3490622 100644 --- a/_data/product_version.yml +++ b/_data/product_version.yml @@ -4,5 +4,7 @@ version_info_list_mobile: - value: latest version - value: 2.x child: + - 2.2.11_android + - 2.2.10 - 2.0.21_ios - 2.0.20 diff --git a/_includes/sidelist-full-tree.html b/_includes/sidelist-full-tree.html index 06b0e94..310c8bc 100644 --- a/_includes/sidelist-full-tree.html +++ b/_includes/sidelist-full-tree.html @@ -7,3 +7,7 @@ DCP-iOS Introduction {%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-ios.html" -%} +
  • + DCP-MAUI Introduction +
    • +{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-maui.html" -%} diff --git a/_includes/sidelist-programming/programming-maui.html b/_includes/sidelist-programming/programming-maui.html new file mode 100644 index 0000000..dc8d2e2 --- /dev/null +++ b/_includes/sidelist-programming/programming-maui.html @@ -0,0 +1,24 @@ +
  • DEVELOPMENT ON MAUI
    • +
  • API Reference + +
    • +
  • USEFUL RESOURCES
    • +
  • Release Notes + +
    • diff --git a/programming/android/api-reference/parsed-result-item.md b/programming/android/api-reference/parsed-result-item.md index 810c163..9175147 100644 --- a/programming/android/api-reference/parsed-result-item.md +++ b/programming/android/api-reference/parsed-result-item.md @@ -8,7 +8,7 @@ needAutoGenerateSidebar: true # ParsedResultItem Class -`ParsedResultItem` it the basic unit of a parsed result. It stores the field name, value and additional information. +`ParsedResultItem` is the basic unit of a parsed result. It stores the field name, value and additional information. ## Definition diff --git a/programming/maui/api-reference/code-parser-module.md b/programming/maui/api-reference/code-parser-module.md new file mode 100644 index 0000000..420bb11 --- /dev/null +++ b/programming/maui/api-reference/code-parser-module.md @@ -0,0 +1,39 @@ +--- +layout: default-layout +title: CodeParserModule Class - DCP MAUI Edition API Reference +description: This page shows CodeParserModule Class of Dynamsoft Code Parser SDK MAUI Edition. +keywords: CodeParserModule, api reference, MAUI +needAutoGenerateSidebar: true +--- + +# CodeParserModule Class + +`CodeParserModule` class defines general functions of the code parser module. + +## Definition + +*Namespace:* Dynamsoft.CodeParser.Maui + +*Assembly:* Dynamsoft.CodeParser.Maui + +```csharp +class CodeParserModule +``` + +## Methods + +| Method | Description | +|--------|-------------| +| [`GetVersion`](#getversion) | Get version information of SDK.| + +### GetVersion + +Get version information of SDK. + +```csharp +static string GetVersion(); +``` + +**Return Value** + +The version information string. diff --git a/programming/maui/api-reference/enum/mapping-status.md b/programming/maui/api-reference/enum/mapping-status.md new file mode 100644 index 0000000..8c1ad71 --- /dev/null +++ b/programming/maui/api-reference/enum/mapping-status.md @@ -0,0 +1,31 @@ +--- +layout: default-layout +title: EnumMappingStatus - DCP MAUI Edition API Reference +description: Enumeration EnumMappingStatus of +keywords: Mapping status +needAutoGenerateSidebar: true +needGenerateH3Content: true +breadcrumbText: EnumMappingStatus +--- + +# EnumMappingStatus + +`MappingStatus` represents the outcome of a mapping operation on a field. + +## Definition + +*Namespace:* Dynamsoft.CodeParser.Maui + +*Assembly:* Dynamsoft.CodeParser.Maui + +```csharp +public enum EnumMappingStatus +{ + /** The field has no mapping specified. */ + MS_NONE = 0, + /** Find a mapping for the field value. */ + MS_SUCCEEDED = 1, + /** Failed to find a mapping for the field value. */ + MS_FAILED = 2 +} +``` diff --git a/programming/maui/api-reference/enum/validation-status.md b/programming/maui/api-reference/enum/validation-status.md new file mode 100644 index 0000000..a325957 --- /dev/null +++ b/programming/maui/api-reference/enum/validation-status.md @@ -0,0 +1,31 @@ +--- +layout: default-layout +title: EnumValidationStatus - DCP MAUI Edition API Reference +description: Enumeration EnumValidationStatus of +keywords: validation status +needAutoGenerateSidebar: true +needGenerateH3Content: true +breadcrumbText: EnumValidationStatus +--- + +# EnumValidationStatus + +`ValidationStatus` describes the outcome of a validation process on a field. + +## Definition + +*Namespace:* Dynamsoft.CodeParser.Maui + +*Assembly:* Dynamsoft.CodeParser.Maui + +```csharp +public enum EnumValidationStatus +{ + /** The field has no validation specified. */ + VS_NONE = 0, + /** The validation for the field has been succeeded. */ + VS_SUCCEEDED = 1, + /** The validation for the field has been failed. */ + VS_FAILED = 2 +} +``` diff --git a/programming/maui/api-reference/parsed-field.md b/programming/maui/api-reference/parsed-field.md new file mode 100644 index 0000000..70a3657 --- /dev/null +++ b/programming/maui/api-reference/parsed-field.md @@ -0,0 +1,62 @@ +--- +layout: default-layout +title: ParsedField Class - DCP MAUI Edition API Reference +description: ParsedField class defindes the parsed field with its name, value and addtitional information. +keywords: ParsedField, api reference, Android +needAutoGenerateSidebar: true +--- + +# ParsedField Class + +`ParsedField` class defindes the parsed field with its name, value and addtitional information. + +## Definition + +*Namespace:* Dynamsoft.CodeParser.Maui + +*Assembly:* Dynamsoft.CodeParser.Maui + +```csharp +class ParsedField +``` + +## Properties + +| Property | Type | Description | +| -------- | ---- | ----------- | +| [`Name`](#name) | *string* | The field name. | +| [`Value`](#value) | *string* | The field value. | +| [`MappingStatus`](#mappingstatus) | *EnumMappingStatus* | The mapping status of the field. | +| [`ValidationStatus`](#validationstatus) | *EnumValidationStatus* | The validation status of the field. | + +### Name + +The field name. + +```csharp +string Name { get; } +``` + +### Value + +The field value. + +```csharp +string Value { get; } +``` + +### MappingStatus + +The mapping status of the field. + +```csharp +EnumMappingStatus MappingStatus { get; } +``` + +### ValidationStatus + +The validation status of the field. + +```csharp +EnumValidationStatus ValidationStatus { get; } +``` diff --git a/programming/maui/api-reference/parsed-result-item.md b/programming/maui/api-reference/parsed-result-item.md new file mode 100644 index 0000000..5ee9d10 --- /dev/null +++ b/programming/maui/api-reference/parsed-result-item.md @@ -0,0 +1,67 @@ +--- +layout: default-layout +title: ParsedResultItem Class - DCP MAUI Edition API Reference +description: ParsedResultItem class of DCP MAUI is the basic unit of a parsed result. It stores the field name, value and additional information. +keywords: ParsedResultItem, api reference, Android +needAutoGenerateSidebar: true +--- + +# ParsedResultItem Class + +`ParsedResultItem` is the basic unit of a parsed result. It stores the field name, value and additional information. + +## Definition + +*Namespace:* Dynamsoft.CodeParser.Maui + +*Assembly:* Dynamsoft.CodeParser.Maui + +```csharp +class ParsedResultItem extends CapturedResultItem +``` + +## Properties + +| Property | Type | Description | +| -------- | ---- | ----------- | +| [`CodeType`](#codetype) | *string* | The code type of the parsed result. | +| [`JsonString`](#jsonstring) | *string* | The parsed result as a JSON formatted string. | +| [`ParsedFields`](#parsedfields) | *Dictionary* | The parsed result with name & value in a `Dictionary`. | + +### CodeType + +The code type of the parsed result. + +```csharp +string CodeType { get; } +``` + +The code type will be one of the follows: + +- "AADHAAR" +- "AAMVA_DL_ID" +- "AAMVA_DL_ID_WITH_MAG_STRIPE" +- "MRTD_TD1_ID" +- "MRTD_TD2_ID" +- "MRTD_TD2_VISA" +- "MRTD_TD3_PASSPORT" +- "MRTD_TD3_VISA" +- "MRTD_TD2_FRENCH_ID" +- "SOUTH_AFRICA_DL" +- "VIN" + +### JsonString + +The parsed result as a JSON formatted string. + +```csharp +string JsonString { get; } +``` + +### ParsedFields + +The parsed result with name & value in a `Dictionary`. + +```csharp +Dictionary ParsedFields { get; } +``` diff --git a/programming/maui/api-reference/parsed-result.md b/programming/maui/api-reference/parsed-result.md new file mode 100644 index 0000000..3914338 --- /dev/null +++ b/programming/maui/api-reference/parsed-result.md @@ -0,0 +1,65 @@ +--- +layout: default-layout +title: ParsedResult Class - DCP MAUI Edition API Reference +description: ParsedResult class of DCP MAUI stores all parsed result items that are obtained from a single image. +keywords: ParsedResult, api reference, Android +needAutoGenerateSidebar: true +--- + + +# ParsedResult Class + +`ParsedResult` class stores all parsed result items that are obtained from a single image. It carries additional information such as the original image data or error messages. + +## Definition + +*Namespace:* Dynamsoft.CodeParser.Maui + +*Assembly:* Dynamsoft.CodeParser.Maui + +```csharp +class ParsedResult +``` + +| Property | Type | Description | +|----------|------|-------------| +| [`OriginalImageHashId`](#originalimagehashid) | *string* | The hash ID of the source image. | +| [`Items`](#items) | *List* | The parsed result item at the specified index. | +| [`ErrorCode`](#errorcode) | *int* | The error code of the parsed result, if an error occurred. | +| [`ErrorString`](#errormessage) | *string* | The error message of the parsed result, if an error occurred. | + +### OriginalImageHashId + +The hash ID of the source image. + +```csharp +string OriginalImageHashId { get; } +``` + +### Items + +The parsed result item at the specified index. + +```csharp +List Items { get; } +``` + +**See Also** + +[ParsedResultItem]({{ site.dcp_maui_api }}parsed-result-item.html) + +### ErrorCode + +The error code of the parsed result, if an error occurred. + +```csharp +int ErrorCode { get; } +``` + +### ErrorMessage + +The error message of the parsed result, if an error occurred. + +```csharp +string ErrorMessage { get; } +``` diff --git a/programming/maui/index.md b/programming/maui/index.md new file mode 100644 index 0000000..58d15bd --- /dev/null +++ b/programming/maui/index.md @@ -0,0 +1,18 @@ +--- +layout: default-layout +title: Main Page - Dynamsoft Code Parser SDK MAUI Edition +description: This is the main page of Dynamsoft Code Parser SDK MAUI Edition. +keywords: MAUI +needAutoGenerateSidebar: true +needGenerateH3Content: true +--- + +# Dynamsoft Code Parser MAUI Edition Documentation + +## API Reference + +- [API Reference](api-reference/index.md) + +## Release Notes + +- [Version 2.x](release-notes/maui-2.md) diff --git a/programming/maui/release-notes/index.md b/programming/maui/release-notes/index.md new file mode 100644 index 0000000..b33c20d --- /dev/null +++ b/programming/maui/release-notes/index.md @@ -0,0 +1,11 @@ +--- +layout: default-layout +title: Release Notes - Dynamsoft Code Parser SDK MAUI Edition +description: This is the release notes page of Dynamsoft Code Parser SDK MAUI Edition. +keywords: release notes, MAUI +needAutoGenerateSidebar: false +--- + +# Release Notes - MAUI Edition + +- [2.2.110 (06/27/2024)](android-2.md#22110-06272024) diff --git a/programming/maui/release-notes/maui-2.md b/programming/maui/release-notes/maui-2.md new file mode 100644 index 0000000..1c6b515 --- /dev/null +++ b/programming/maui/release-notes/maui-2.md @@ -0,0 +1,14 @@ +--- +layout: default-layout +title: Release Notes v2.x - Dynamsoft Code Parser SDK MAUI Edition +description: This is the release notes page of Dynamsoft Code Parser SDK MAUI Edition v2.x. +keywords: release notes, MAUI +needGenerateH3Content: false +--- + +# Release Notes for MAUI Edition - 2.x + +## 2.2.110 (06/27/2024) + +{%- include release-notes/product-highlight-2.0.0.md -%} +