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
10 changes: 10 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand Down Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions _data/full_tree.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 2 additions & 0 deletions _data/product_version.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 4 additions & 0 deletions _includes/sidelist-full-tree.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,7 @@
<a href="{{ site.dcp_ios }}" class="otherLinkColour">DCP-iOS Introduction</a>
</li>
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-ios.html" -%}
<li lang="maui">
<a href="{{ site.dcp_maui }}" class="otherLinkColour">DCP-MAUI Introduction</a>
</li>
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-maui.html" -%}
24 changes: 24 additions & 0 deletions _includes/sidelist-programming/programming-maui.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<li lang="maui" class="category">DEVELOPMENT ON MAUI</li>
<li lang="maui"><a class="otherLinkColour">API Reference</a>
<ul>
<li><a class="otherLinkColour">Classes</a>
<ul>
<li><a href="{{ site.dcp_maui_api }}code-parser-module.html" class="otherLinkColour">CodeParserModule</a></li>
<li><a href="{{ site.dcp_maui_api }}parsed-result-item.html" class="otherLinkColour">ParsedResultItem</a></li>
<li><a href="{{ site.dcp_maui_api }}parsed-result.html" class="otherLinkColour">ParsedResult</a></li>
</ul>
</li>
<li><a class="otherLinkColour">Enumerations</a>
<ul>
<li><a href="{{ site.dcp_maui_api }}enum/mapping-status.html" class="otherLinkColour">MappingStatus</a></li>
<li><a href="{{ site.dcp_maui_api }}enum/validation-status.html" class="otherLinkColour">ValidationStatus</a></li>
</ul>
</li>
</ul>
</li>
<li lang="maui" class="category">USEFUL RESOURCES</li>
<li lang="maui"><a href="{{ site.dcp_maui }}release-notes/index.html" class="otherLinkColour">Release Notes</a>
<ul >
<li ><a href="{{ site.dcp_maui }}release-notes/maui-2.html" class="otherLinkColour">Version 2.x</a></li>
</ul>
</li>
2 changes: 1 addition & 1 deletion programming/android/api-reference/parsed-result-item.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
39 changes: 39 additions & 0 deletions programming/maui/api-reference/code-parser-module.md
Original file line number Diff line number Diff line change
@@ -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.
31 changes: 31 additions & 0 deletions programming/maui/api-reference/enum/mapping-status.md
Original file line number Diff line number Diff line change
@@ -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
}
```
31 changes: 31 additions & 0 deletions programming/maui/api-reference/enum/validation-status.md
Original file line number Diff line number Diff line change
@@ -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
}
```
62 changes: 62 additions & 0 deletions programming/maui/api-reference/parsed-field.md
Original file line number Diff line number Diff line change
@@ -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; }
```
67 changes: 67 additions & 0 deletions programming/maui/api-reference/parsed-result-item.md
Original file line number Diff line number Diff line change
@@ -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<string, ParsedField> ParsedFields { get; }
```
65 changes: 65 additions & 0 deletions programming/maui/api-reference/parsed-result.md
Original file line number Diff line number Diff line change
@@ -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<ParsedResultItem>* | 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<ParsedResultItem> 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; }
```
Loading