Skip to content

Commit cd338ce

Browse files
amro-dynamsoftamro-dynamsoft
committed
Flutter intro push
Adding the flutter docs to the main site,
1 parent b6c8155 commit cd338ce

File tree

13 files changed

+1041
-0
lines changed

13 files changed

+1041
-0
lines changed

‎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.
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+
Represents the error code should something go wrong during the MRZ scanning process.
59+
60+
```dart
61+
int? errorCode;
62+
```
63+
64+
### errorString
65+
66+
Represents the error message associated with the error code should something go wrong during the MRZ scanning process.
67+
68+
```dart
69+
String? errorMessage;
70+
```

‎programming/flutter/api-reference/mrz-scanner-config.md‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
---
2+
layout: default-layout
3+
title: MRZScannerConfig Class - Dynamsoft MRZ Scanner Flutter Edition
4+
description: MRZScannerConfig of DynamsoftMRZScanner Flutter is the class that defines the configurations for MRZ scanning.
5+
keywords: MRZ, scanner, config, flutter
6+
needAutoGenerateSidebar: true
7+
needGenerateH3Content: true
8+
breadcrumbText: MRZScannerConfig
9+
---
10+
11+
# MRZScannerConfig
12+
13+
`MRZScannerConfig` is responsible for the configuration of the MRZ Scanner, from assigning the MRZ Scanner license to configuring the supported document types, along with other customizations.
14+
15+
> [!NOTE]
16+
> If you are wondering about the different ways you can customize the MRZ Scanner, please refer to the [MRZ Scanner Customization Guide](../user-guide/customize-mrz-scanner.md).
17+
18+
## Definition
19+
20+
*Assembly:* dynamsoft_mrz_scanner_bundle_flutter
21+
22+
```dart
23+
final class MRZScannerConfig
24+
```
25+
26+
## Properties
27+
28+
| Property | Type | Description |
29+
| -------- | ---- | ----------- |
30+
| [`license`](#license) | *String* | Represents the MRZ Scanner license string. |
31+
| [`templateFile`](#templatefile) | *String* | Specifies the template configuration that defines the various MRZ Scanner parameters. |
32+
| [`documentType`](#documenttype) | [*EnumDocumentType*](document-type.md) | Specifies the type of document (ID or Passport) that the MRZ Scanner will recognize. |
33+
| [`isTorchButtonVisible`](#istorchbuttonvisible) | *bool* | Represents the visibility status of the torch button. |
34+
| [`isBeepEnabled`](#isbeepenabled) | *bool* | Determines whether a beep sound is triggered upon a successful MRZ scan. |
35+
| [`isCloseButtonVisible`](#isclosebuttonvisible) | *bool* | Represents the visibility status of the close button. |
36+
| [`isGuideFrameVisible`](#isguideframevisible) | *bool* | Represents the visibility status of the guide frame on the display. |
37+
| [`isCameraToggleButtonVisible`](#Iscameratogglebuttonvisible) | *bool* | Specifies whether the camera toggle button is displayed or not. |
38+
39+
### license
40+
41+
The license key is the only property whose ***value must be specified when instantiating the MRZ Scanner instance***. If the license is undefined, invalid, or expired, the MRZ Scanner cannot proceed with scanning, and instead displays a pop-up error message instructing the user to contact the app administrator to resolve this license issue.
42+
43+
```dart
44+
String license;
45+
```
46+
47+
### templateFile
48+
49+
Specifies the template configuration with a file path or a JSON string that defines the various MRZ Scanner parameters. These specialized templates are usually used for very specific and customized scanning scenarios.
50+
51+
```dart
52+
String? templateFile;
53+
```
54+
55+
**Remarks**
56+
57+
The MRZ Scanner comes with a default template file, but you may choose to use a custom template to target specialized use cases. We recommend contacting the [Dynamsoft Technical Support Team](https://www.dynamsoft.com/company/contact/) for assistance with template customization.
58+
59+
### documentType
60+
61+
Specifies the type of document that the MRZ Scanner will recognize, represented as a [`EnumDocumentType`](document-type.md). This property accepts values defined in the EnumDocumentType such as `EnumDocumentType.all` (TD1/2/3), `EnumDocumentType.id` (TD1/2), or `EnumDocumentType.passport` (TD3).
62+
63+
```dart
64+
EnumDocumentType? documentType;
65+
```
66+
67+
**Remarks**
68+
69+
If you would like to learn more about the supported document types, please refer to the [Supported Document Types](../user-guide/index.md#supported-machine-readable-travel-document-types) section of the user guide.
70+
71+
### isTorchButtonVisible
72+
73+
Determines whether the torch (flashlight) toggle button is visible on the scanning interface. Set to true to allow users to switch the device's flashlight on or off during MRZ scanning.
74+
75+
```dart
76+
bool? isTorchButtonVisible;
77+
```
78+
79+
### isBeepEnabled
80+
81+
Determines whether a beep sound is triggered upon a successful MRZ scan. When enabled (true), the scanner will play a sound to provide audible feedback.
82+
83+
```dart
84+
bool? isBeepEnabled;
85+
```
86+
87+
### isCloseButtonVisible
88+
89+
Controls the visibility of the close button on the scanner's UI. If true, a close button will be displayed allowing users to exit the MRZ scanning interface.
90+
91+
```dart
92+
bool? isCloseButtonVisible;
93+
```
94+
95+
### IsGuideFrameVisible
96+
97+
Represents the visibility status of the guide frame on the display.
98+
99+
```dart
100+
bool IsGuideFrameVisible { get; set; };
101+
```
102+
103+
### isCameraToggleButtonVisible
104+
105+
Specifies whether the camera toggle button is displayed. This button lets users switch between available cameras (e.g., front and rear).
106+
107+
```dart
108+
bool? isCameraToggleButtonVisible;
109+
```

0 commit comments

Comments
 (0)