Skip to content

Commit df507eb

Browse files
Merge pull request #7 from dynamsoft-docs/preview
update to internal commit 9a446a9e
2 parents f1d72ad + 4f80b9a commit df507eb

File tree

2 files changed

+32
-8
lines changed

2 files changed

+32
-8
lines changed

programming/android/api-reference/parsed-result-item.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,19 @@ String getCodeType();
3838

3939
**Return Value**
4040

41-
Returns a string value representing the code type.
41+
Returns a string value representing the code type. It can be one of the following:
42+
43+
- "AADHAAR"
44+
- "AAMVA_DL_ID"
45+
- "AAMVA_DL_ID_WITH_MAG_STRIPE"
46+
- "MRTD_TD1_ID"
47+
- "MRTD_TD2_ID"
48+
- "MRTD_TD2_VISA"
49+
- "MRTD_TD3_PASSPORT"
50+
- "MRTD_TD3_VISA"
51+
- "MRTD_TD2_FRENCH_ID"
52+
- "SOUTH_AFRICA_DL"
53+
- "VIN"
4254

4355
## getJsonString
4456

@@ -70,7 +82,7 @@ Returns a string representing the specified field value.
7082

7183
## getFieldMappingStatus
7284

73-
Gets the mapping status of a specified field from the parsed result.
85+
Gets the mapping status of a specified field from the parsed result. Certain fields in the parsed result, such as the residing province or state, are abbreviated (e.g. BC standing for British Columbia). The library takes such fields and maps them to their full form. If the mapping is successful, the `MappingStatus` will be `MS_SUCCEEDED`. To learn of the other options of `MappingStatus`, please refer to the link below.
7486

7587
```java
7688
EnumMappingStatus getFieldMappingStatus(String fieldName);
@@ -90,7 +102,7 @@ Returns a [MappingStatus]({{ site.dcv_enumerations }}code-parser/mapping-status.
90102

91103
## getFieldValidationStatus
92104

93-
Gets the validation status of a specified field from the parsed result.
105+
Gets the validation status of a specified field from the parsed result. Certain fields can be validated with one of four possible validation methods: certification, checksum, length, and regex. Whether a field is validated or not, as well as the validation method, is determined by the code specification e.g. AAMVA specification.
94106

95107
```java
96108
EnumValidationStatus getFieldValidationStatus(String fieldName);
@@ -102,7 +114,7 @@ EnumValidationStatus getFieldValidationStatus(String fieldName);
102114

103115
**Return Value**
104116

105-
Returns a [ValidationStatus]({{ site.dcv_enumerations }}code-parser/validation-status.html?lang=android) enumeration value representing the validation status of a specified field.
117+
Returns a [ValidationStatus]({{ site.dcv_enumerations }}code-parser/validation-status.html?lang=android) enumeration value saying whether the validation of a specified field was successful, failed, or if it did not require validation.
106118

107119
**See Also**
108120

programming/ios/api-reference/parsed-result-item.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ class ParsedResultItem : CapturedResultItem
4848

4949
### getFieldMappingStatus
5050

51-
Gets the mapping status of a specified field from the parsed result.
51+
Gets the mapping status of a specified field from the parsed result. Certain fields in the parsed result, such as the residing province or state, are abbreviated (e.g. BC standing for British Columbia). The library takes such fields and maps them to their full form. If the mapping is successful, the `MappingStatus` will be `DSMappingStatusSucceeded`. To learn of the other options of `MappingStatus`, please refer to the link below.
5252

5353
<div class="sample-code-prefix"></div>
5454
>- Objective-C
@@ -73,7 +73,7 @@ Returns a [MappingStatus]({{ site.dcv_enumerations }}code-parser/mapping-status.
7373

7474
### getFieldValidationStatus
7575

76-
Gets the validation status of a specified field from the parsed result.
76+
Gets the validation status of a specified field from the parsed result. Certain fields can be validated with one of four possible validation methods: certification, checksum, length, and regex. Whether a field is validated or not, as well as the validation method, is determined by the code specification e.g. AAMVA specification.
7777

7878
<div class="sample-code-prefix"></div>
7979
>- Objective-C
@@ -94,7 +94,7 @@ func getFieldValidationStatus(_ fieldName:String) -> ValidationStatus
9494

9595
**Return Value**
9696

97-
Returns a [ValidationStatus]({{ site.dcv_enumerations }}code-parser/validation-status.html?lang=objc,swift) enumeration value representing the validation status of a specified field.
97+
Returns a [ValidationStatus]({{ site.dcv_enumerations }}code-parser/validation-status.html?lang=objc,swift) enumeration value saying whether the validation of a specified field was successful, failed, or if it did not require validation..
9898

9999
### getFieldValue
100100

@@ -125,7 +125,19 @@ Returns a string representing the specified field value.
125125

126126
### codeType
127127

128-
Gets the code type of the parsed result.
128+
Returns the code type of the parsed result. It can be one of the following:
129+
130+
- "AADHAAR"
131+
- "AAMVA_DL_ID"
132+
- "AAMVA_DL_ID_WITH_MAG_STRIPE"
133+
- "MRTD_TD1_ID"
134+
- "MRTD_TD2_ID"
135+
- "MRTD_TD2_VISA"
136+
- "MRTD_TD3_PASSPORT"
137+
- "MRTD_TD3_VISA"
138+
- "MRTD_TD2_FRENCH_ID"
139+
- "SOUTH_AFRICA_DL"
140+
- "VIN"
129141

130142
<div class="sample-code-prefix"></div>
131143
>- Objective-C

0 commit comments

Comments
 (0)