From 4f80b9a86bc96e588d168177d4c50b2acebbed98 Mon Sep 17 00:00:00 2001 From: DMGithubPublisher Date: Mon, 22 Jan 2024 21:28:43 -0800 Subject: [PATCH] update to internal commit 9a446a9e --- .../api-reference/parsed-result-item.md | 20 +++++++++++++++---- .../ios/api-reference/parsed-result-item.md | 20 +++++++++++++++---- 2 files changed, 32 insertions(+), 8 deletions(-) diff --git a/programming/android/api-reference/parsed-result-item.md b/programming/android/api-reference/parsed-result-item.md index cf156b9..810c163 100644 --- a/programming/android/api-reference/parsed-result-item.md +++ b/programming/android/api-reference/parsed-result-item.md @@ -38,7 +38,19 @@ String getCodeType(); **Return Value** -Returns a string value representing the code type. +Returns a string value representing the code type. It can be one of the following: + +- "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" ## getJsonString @@ -70,7 +82,7 @@ Returns a string representing the specified field value. ## getFieldMappingStatus -Gets the mapping status of a specified field from the parsed result. +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. ```java EnumMappingStatus getFieldMappingStatus(String fieldName); @@ -90,7 +102,7 @@ Returns a [MappingStatus]({{ site.dcv_enumerations }}code-parser/mapping-status. ## getFieldValidationStatus -Gets the validation status of a specified field from the parsed result. +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. ```java EnumValidationStatus getFieldValidationStatus(String fieldName); @@ -102,7 +114,7 @@ EnumValidationStatus getFieldValidationStatus(String fieldName); **Return Value** -Returns a [ValidationStatus]({{ site.dcv_enumerations }}code-parser/validation-status.html?lang=android) enumeration value representing the validation status of a specified field. +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. **See Also** diff --git a/programming/ios/api-reference/parsed-result-item.md b/programming/ios/api-reference/parsed-result-item.md index f4822b5..eacda15 100644 --- a/programming/ios/api-reference/parsed-result-item.md +++ b/programming/ios/api-reference/parsed-result-item.md @@ -48,7 +48,7 @@ class ParsedResultItem : CapturedResultItem ### getFieldMappingStatus -Gets the mapping status of a specified field from the parsed result. +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.
>- Objective-C @@ -73,7 +73,7 @@ Returns a [MappingStatus]({{ site.dcv_enumerations }}code-parser/mapping-status. ### getFieldValidationStatus -Gets the validation status of a specified field from the parsed result. +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.
>- Objective-C @@ -94,7 +94,7 @@ func getFieldValidationStatus(_ fieldName:String) -> ValidationStatus **Return Value** -Returns a [ValidationStatus]({{ site.dcv_enumerations }}code-parser/validation-status.html?lang=objc,swift) enumeration value representing the validation status of a specified field. +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.. ### getFieldValue @@ -125,7 +125,19 @@ Returns a string representing the specified field value. ### codeType -Gets the code type of the parsed result. +Returns the code type of the parsed result. It can be one of the following: + +- "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"
>- Objective-C