Skip to content

Commit 984f850

Browse files
amro-dynamsoftamro-dynamsoft
authored
Merge pull request #23 from dynamsoft-docs/develop-flutter
Develop flutter
2 parents 84b2a75 + e7f56b4 commit 984f850

28 files changed

+2169
-3
lines changed

‎_config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,14 @@ maui_api: /mrz-scanner/docs/mobile/programming/maui/api-reference/
2323
maui_release_notes: /mrz-scanner/docs/mobile/programming/maui/release-notes/
2424
maui_faq: /mrz-scanner/docs/mobile/programming/maui/faq/
2525

26+
flutter: /mrz-scanner/docs/mobile/programming/flutter/
27+
flutter_api: /mrz-scanner/docs/mobile/programming/flutter/api-reference/
28+
flutter_release_notes: /mrz-scanner/docs/mobile/programming/flutter/release-notes/
29+
30+
react_native: /mrz-scanner/docs/mobile/programming/react-native/
31+
react_native_api: /mrz-scanner/docs/mobile/programming/react-native/api-reference/
32+
react_native_release_notes: /mrz-scanner/docs/mobile/programming/react-native/release-notes/
33+
2634
dcvb_android_api: /capture-vision/docs/mobile/programming/android/api-reference/
2735
dcvb_ios_api: /capture-vision/docs/mobile/programming/ios/api-reference/
2836

‎_includes/sidelist-full-tree.html‎

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,21 @@
11
<li lang="objectivec-swift">
2-
<a href="{{ site.ios }}" class="otherLinkColour">MRZ Scanner-iOS Introduction</a>
2+
<a href="{{ site.ios }}" class="otherLinkColour">MRZ Scanner iOS Introduction</a>
33
</li>
44
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-ios.html" -%}
55
<li lang="android">
6-
<a href="{{ site.android }}" class="otherLinkColour">MRZ Scanner-Android Introduction</a>
6+
<a href="{{ site.android }}" class="otherLinkColour">MRZ Scanner Android Introduction</a>
77
</li>
88
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-android.html" -%}
99
<li lang="maui">
10-
<a href="{{ site.maui }}" class="otherLinkColour">MRZ Scanner-MAUI Introduction</a>
10+
<a href="{{ site.maui }}" class="otherLinkColour">MRZ Scanner MAUI Introduction</a>
1111
</li>
1212
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-maui.html" -%}
13+
<li lang="flutter">
14+
<a href="{{ site.flutter }}" class="otherLinkColour">MRZ Scanner Flutter Introduction</a>
15+
</li>
16+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-maui.html" -%}
17+
<li lang="maui">
18+
<a href="{{ site.react_native }}" class="otherLinkColour">MRZ Scanner React Native Introduction</a>
19+
</li>
20+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-maui.html" -%}
21+

‎_includes/sidelist-programming/programming-flutter.html‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<li lang="flutter" class="category">DEVELOPMENT</li>
2+
3+
<li lang="flutter" ><a style="cursor:pointer;color:#3c3c3c">User Guide</a>
4+
<ul lang="flutter" >
5+
<li lang="flutter" ><a href="{{ site.flutter }}user-guide/index.html" class="otherLinkColour">MRZ Scanner User Guide</a> </li>
6+
<li lang="flutter" ><a href="{{ site.flutter }}user-guide/customize-mrz-scanner.html" class="otherLinkColour">MRZ Scanner Customization</a></li>
7+
</ul>
8+
</li>
9+
<li lang="flutter"><a href="{{ site.flutter }}samples/index.html" class="otherLinkColour">Demo &amp; Samples</a></li>
10+
11+
<li lang="flutter"><a href="{{ site.flutter_api }}index.html" class="otherLinkColour">API Reference</a>
12+
<ul lang="flutter">
13+
<li lang="flutter"><a>Classes</a>
14+
<ul lang="flutter">
15+
<li lang="flutter"><a href="{{ site.flutter_api }}mrz-scanner.html" class="otherLinkColour">MRZScanner</a></li>
16+
<li lang="flutter"><a href="{{ site.flutter_api }}mrz-scanner-config.html" class="otherLinkColour">MRZScannerConfig</a></li>
17+
<li lang="flutter"><a href="{{ site.flutter_api }}mrz-scan-result.html" class="otherLinkColour">MRZScanResult</a></li>
18+
<li lang="flutter"><a href="{{ site.flutter_api }}mrz-data.html" class="otherLinkColour">MRZData</a></li>
19+
</ul>
20+
</li>
21+
<li lang="flutter"><a class="otherLinkColour">Enumerations</a>
22+
<ul lang="flutter">
23+
<li lang="flutter"><a href="{{ site.flutter_api }}document-type.html?lang=flutter" class="otherLinkColour">EnumDocumentType</a></li>
24+
</ul>
25+
<ul lang="flutter">
26+
<li lang="flutter"><a href="{{ site.flutter_api }}result-status.html?lang=flutter" class="otherLinkColour">EnumResultStatus</a></li>
27+
</ul>
28+
</li>
29+
</ul>
30+
</li>
31+
32+
<li lang="flutter" class="category">USEFUL RESOURCES</li>
33+
34+
<li lang="flutter" ><a href="{{ site.flutter_release_notes }}" class="otherLinkColour">Release Notes</a>
35+
<ul lang="flutter" >
36+
<li lang="flutter" ><a href="{{ site.flutter_release_notes }}index.html" class="otherLinkColour">Version 3.x</a></li>
37+
</ul>
38+
</li>
39+
40+
<li lang="flutter" ><a href="{{ site.flutter }}user-guide/license-activation.html" class="otherLinkColour">License Initialization</a></li>
41+
42+
<li lang="flutter" class="category">OTHERS</li>
43+
<li lang="flutter" ><a target="_blank" href="{{ site.ios }}" class="otherLinkColour refreshLink">Develop for iOS (Objective-C & Swift)</a></li>
44+
<li lang="flutter" ><a target="_blank" href="{{ site.android }}" class="otherLinkColour refreshLink">Develop for Android (Java & Kotlin)</a></li>
45+
<li lang="react-native" ><a target="_blank" href="{{ site.maui }}" class="otherLinkColour refreshLink">Develop for MAUI</a></li>
46+
<li lang="react-native" ><a target="_blank" href="{{ site.react_native }}" class="otherLinkColour refreshLink">Develop for React Native</a></li>
47+

‎_includes/sidelist-programming/programming-react-native.html‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<li lang="react-native" class="category">DEVELOPMENT</li>
2+
3+
<li lang="react-native" ><a style="cursor:pointer;color:#3c3c3c">User Guide</a>
4+
<ul lang="react-native" >
5+
<li lang="react-native" ><a href="{{ site.react_native }}user-guide/index.html" class="otherLinkColour">MRZ Scanner User Guide</a> </li>
6+
<li lang="react-native" ><a href="{{ site.react_native }}user-guide/customize-mrz-scanner.html" class="otherLinkColour">MRZ Scanner Customization</a></li>
7+
</ul>
8+
</li>
9+
<li lang="react-native"><a href="{{ site.react_native }}samples/index.html" class="otherLinkColour">Demo &amp; Samples</a></li>
10+
11+
<li lang="react-native"><a href="{{ site.react_native_api }}index.html" class="otherLinkColour">API Reference</a>
12+
<ul lang="react-native">
13+
<li lang="react-native"><a>Classes</a>
14+
<ul lang="react-native">
15+
<li lang="react-native"><a href="{{ site.react_native_api }}mrz-scanner.html" class="otherLinkColour">MRZScanner</a></li>
16+
<li lang="react-native"><a href="{{ site.react_native_api }}mrz-scanner-config.html" class="otherLinkColour">MRZScannerConfig</a></li>
17+
<li lang="react-native"><a href="{{ site.react_native_api }}mrz-scan-result.html" class="otherLinkColour">MRZScanResult</a></li>
18+
<li lang="react-native"><a href="{{ site.react_native_api }}mrz-data.html" class="otherLinkColour">MRZData</a></li>
19+
</ul>
20+
</li>
21+
<li lang="react-native"><a class="otherLinkColour">Enumerations</a>
22+
<ul lang="react-native">
23+
<li lang="react-native"><a href="{{ site.react_native_api }}document-type.html?lang=react_native" class="otherLinkColour">EnumDocumentType</a></li>
24+
</ul>
25+
<ul lang="react-native">
26+
<li lang="react-native"><a href="{{ site.react_native_api }}result-status.html?lang=react_native" class="otherLinkColour">EnumResultStatus</a></li>
27+
</ul>
28+
</li>
29+
</ul>
30+
</li>
31+
32+
<li lang="react-native" class="category">USEFUL RESOURCES</li>
33+
34+
<li lang="react-native" ><a href="{{ site.react_native_release_notes }}" class="otherLinkColour">Release Notes</a>
35+
<ul lang="react-native" >
36+
<li lang="react-native" ><a href="{{ site.react_native_release_notes }}index.html" class="otherLinkColour">Version 3.x</a></li>
37+
</ul>
38+
</li>
39+
40+
<li lang="react-native" ><a href="{{ site.react_native }}user-guide/license-activation.html" class="otherLinkColour">License Initialization</a></li>
41+
42+
<li lang="react-native" class="category">OTHERS</li>
43+
<li lang="react-native" ><a target="_blank" href="{{ site.ios }}" class="otherLinkColour refreshLink">Develop for iOS (Objective-C & Swift)</a></li>
44+
<li lang="react-native" ><a target="_blank" href="{{ site.android }}" class="otherLinkColour refreshLink">Develop for Android (Java & Kotlin)</a></li>
45+
<li lang="react-native" ><a target="_blank" href="{{ site.maui }}" class="otherLinkColour refreshLink">Develop for MAUI</a></li>
46+
<li lang="react-native" ><a target="_blank" href="{{ site.flutter }}" class="otherLinkColour refreshLink">Develop for Flutter</a></li>
47+

‎programming/flutter/api-reference/document-type.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
layout: default-layout
3+
title: EnumDocumentType - Dynamsoft MRZ Scanner Flutter Edition
4+
description: EnumDocumentType of DynamsoftMRZScanner Flutter is an enumeration class that defines the result status of the MRZScanResult.
5+
keywords: document type, id cards, passports
6+
needAutoGenerateSidebar: true
7+
needGenerateH3Content: true
8+
breadcrumbText: EnumDocumentType
9+
---
10+
11+
# EnumDocumentType
12+
13+
`EnumDocumentType` is an enumeration class that defines the type of document to scan, such as ID cards or passports.
14+
15+
## Definition
16+
17+
*Assembly:* dynamsoft_mrz_scanner_bundle_flutter
18+
19+
```dart
20+
public enum EnumDocumentType
21+
{
22+
all, // supports both ID cards (TD1 and TD2) and passports (TD3)
23+
id, // only supports ID cards (TD1 and TD2)
24+
passport // only supports passports (TD3)
25+
}
26+
```
27+
28+
## Members
29+
30+
| Member | Description |
31+
| ------ | ----------- |
32+
| `all` | Supports both ID cards (TD1 and TD2) and passports (TD3) |
33+
| `id` | Only supports ID cards (TD1 and TD2) |
34+
| `passport` | Only supports passports (TD3) |
35+

‎programming/flutter/api-reference/index.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
layout: default-layout
3+
title: MRZScanner API reference - Dynamsoft MRZ Scanner Flutter Edition
4+
description: This is the main page of MRZScanner API Reference for Flutter Language.
5+
keywords: MRZScanner, api reference, Flutter
6+
---
7+
8+
# MRZScanner API References
9+
10+
`MRZScanner` is a ready-to-use component that enables developers to quickly set up an app for scanning MRZ codes on passports and ID cards. The `MRZScanner` simplifies the integration of MRZ scanning functionality into any application, making it easy to extract and process information from travel and identity documents.
11+
12+
## Classes
13+
14+
| Class | Description |
15+
| ----- | ----------- |
16+
| [`MRZScanner`](mrz-scanner.md) | The main class of `MRZScanner` component. It is an activity class that implements MRZ scanning features. |
17+
| [`MRZScannerConfig`](mrz-scanner-config.md) | The class that provides MRZ scanning configurations. |
18+
| [`MRZScanResult`](mrz-scan-result.md) | The MRZ scan result class. |
19+
| [`MRZData`](mrz-data.md) | The class that contains the parsed MRZ information. |
20+
| [`EnumResultStatus`](result-status.md) | A enumeration class that describes the result status. |
21+
| [`EnumDocumentType`](document-type.md) | A enumeration class that defines the type of document to scan, such as ID cards or passports. |

‎programming/flutter/api-reference/mrz-data.md‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
---
2+
layout: default-layout
3+
title: MRZData Class - Dynamsoft MRZ Scanner Flutter Edition
4+
description: MRZData of DynamsoftMRZScanner Flutter is a result class that contains the parsed MRZ information.
5+
keywords: MRZ, scanner, scan result
6+
needAutoGenerateSidebar: true
7+
needGenerateH3Content: true
8+
breadcrumbText: MRZData
9+
---
10+
11+
# MRZData
12+
13+
`MRZData` is a result class that is used to represent the parsed MRZ information.
14+
15+
## Definition
16+
17+
*Assembly:* dynamsoft_mrz_scanner_bundle_flutter
18+
19+
```dart
20+
class MRZData
21+
```
22+
23+
## Properties
24+
25+
| Property | Type | Description |
26+
| -------- | ---- | ----------- |
27+
| [`firstName`](#firstname) | *String* | The first name of the MRZ document holder. |
28+
| [`lastName`](#lastname) | *String* | The last name of the MRZ document holder. |
29+
| [`sex`](#sex) | *String* | The sex of the MRZ document holder. |
30+
| [`issuingState`](#issuingstate) | *String* | The issuing state (represented as the full name of the country/region) of the MRZ document. |
31+
| [`nationality`](#nationality) | *String* | The nationality (represented as the full name of the country/region) of the MRZ document holder. |
32+
| [`dateOfBirth`](#dateofbirth) | *String* | The date of birth of the MRZ document holder. |
33+
| [`dateOfExpire`](#dateofexpire) | *String* | The expiry date of the MRZ document. |
34+
| [`documentType`](#documenttype) | *String* | The type of MRTD that the MRZ document is. |
35+
| [`documentNumber`](#documentnumber) | *String* | The MRZ document number. |
36+
| [`age`](#age) | *int* | The age of the MRZ document holder. |
37+
| [`mrzText`](#mrztext) | *String* | The raw unparsed text of the MRZ. |
38+
39+
### firstName
40+
41+
Represents the first name of the MRZ document holder.
42+
43+
```dart
44+
String firstName;
45+
```
46+
47+
### lastName
48+
49+
Represents the last name of the MRZ document holder.
50+
51+
```dart
52+
String lastName;
53+
```
54+
55+
### sex
56+
57+
Represents the sex of the MRZ document holder.
58+
59+
```dart
60+
String sex;
61+
```
62+
63+
### issuingState
64+
65+
Represents the issuing state of the MRZ document.
66+
67+
```dart
68+
String issuingState;
69+
```
70+
71+
### nationality
72+
73+
Represents the nationality of the MRZ document holder.
74+
75+
```dart
76+
String nationality;
77+
```
78+
79+
### dateOfBirth
80+
81+
Represents the date of birth of the MRZ document holder.
82+
83+
```dart
84+
String dateOfBirth;
85+
```
86+
87+
### dateOfExpire
88+
89+
Represents the expiry date of the MRZ document.
90+
91+
```dart
92+
String dateOfExpire;
93+
```
94+
95+
### documentType
96+
97+
Represents the type of MRZ document.
98+
99+
```dart
100+
String documentType;
101+
```
102+
103+
### documentNumber
104+
105+
Represents the MRZ document number.
106+
107+
```dart
108+
String documentNumber;
109+
```
110+
111+
### age
112+
113+
Represents the age of the MRZ document holder.
114+
115+
```dart
116+
int age;
117+
```
118+
119+
### mrzText
120+
121+
Represents the raw text of the MRZ.
122+
123+
```dart
124+
String mrzText;
125+
```

‎programming/flutter/api-reference/mrz-scan-result.md‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
layout: default-layout
3+
title: MRZScanResult Class - Dynamsoft MRZ Scanner Flutter Edition
4+
description: MRZScanResult of DynamsoftMRZScanner Flutter is a result class that contains the parsed MRZ information from one scan and the additional information.
5+
keywords: MRZ, scanner, scan result
6+
needAutoGenerateSidebar: true
7+
needGenerateH3Content: true
8+
breadcrumbText: MRZScanResult
9+
---
10+
11+
# MRZScanResult
12+
13+
`MRZScanResult` is the most basic class to represent the full MRZ result object. It comes with a result status and the parsed MRZ info as a MRZData object.
14+
15+
## Definition
16+
17+
*Assembly:* dynamsoft_mrz_scanner_bundle_flutter
18+
19+
```dart
20+
class MRZScanResult
21+
```
22+
23+
## Properties
24+
25+
| Property | Type | Description |
26+
| -------- | ---- | ----------- |
27+
| [`mrzData`](#mrzdata) | [*MRZData?*](mrz-data.md) | Represents the parsed MRZ data. |
28+
| [`status`](#status) | [*EnumResultStatus*](result-status.md) | Represents the status of the result, which can be finished, canceled or exception. |
29+
| [`errorCode`](#errorcode) | *int?* | Represents the error code should something go wrong during the MRZ scanning process. |
30+
| [`errorString`](#errorstring) | *String?* | Represents the error message associated with the error code should something go wrong during the MRZ scanning process. |
31+
32+
### mrzData
33+
34+
Represents the parsed MRZ information as a [`MRZData`](mrz-data.md) object.
35+
36+
```dart
37+
MRZData? mrzData;
38+
```
39+
40+
### status
41+
42+
Represents the status of the result, which can be finished, canceled or exception. The status comes in the form of a [`EnumResultStatus`](result-status.md).
43+
44+
```dart
45+
EnumResultStatus status;
46+
```
47+
48+
**Remarks**
49+
50+
The result status can be one of three things:
51+
52+
- `finished`: The MRZ scanning is finished.
53+
- `canceled`: The MRZ scanning activity is closed before the process is finished.
54+
- `exception`: Failed to start MRZ scanning or an error occurs when scanning the MRZ.
55+
56+
### errorCode
57+
58+
Returns the error code when an exception occurs. This value is only valid when resultStatus is `exception`.
59+
60+
```dart
61+
int? errorCode;
62+
```
63+
64+
### errorString
65+
66+
Returns the error message associated with the error code when an exception occurs. This value is only valid when resultStatus is `exception`.
67+
68+
```dart
69+
String? errorMessage;
70+
```

0 commit comments

Comments
 (0)