diff --git a/assets/js/dcpMobileVersionSearch.json b/assets/js/dcpMobileVersionSearch.json deleted file mode 100644 index 0f9db5c..0000000 --- a/assets/js/dcpMobileVersionSearch.json +++ /dev/null @@ -1,311 +0,0 @@ -[ - { - "version": "2.2.11", - "matchList": { - "android":{ - "dcvRepoMobile": [ - { - "path": "/programming/android/api-reference/license", - "version": "3.2.20" - }, { - "path": "/programming/android/api-reference/core", - "version": "3.2.30" - } - ], - "dcvRepoCore": [ - { - "path": "/enums/core", - "version": "3.2.30" - },{ - "path": "/parameters/reference/capture-vision-template", - "version": "2.2.30" - },{ - "path": "/parameters/reference/target-roi-def", - "version": "2.2.30" - },{ - "path": "/parameters/reference/code-parser-task-settings", - "version": "2.2.10" - },{ - "path": "/parameters/reference/image-parameter", - "version": "2.2.30" - },{ - "path": "/parameters/reference/semantic-processing", - "version": "3.2.10" - },{ - "path": "/parameters/reference/image-source-options", - "version": "3.2.30" - },{ - "path": "/parameters/reference/global-parameter", - "version": "2.2.30" - },{ - "path": "/parameters/reference/label-recognizer-task-settings", - "version": "3.2.10" - },{ - "path": "/parameters/reference/text-line-specification", - "version": "3.2.30" - },{ - "path": "/parameters/reference/barcode-reader-task-settings", - "version": "10.2.10" - } - ] - } - } - }, { - "version": "2.2.10", - "matchList": { - "android":{ - "dcvRepoMobile": [ - { - "path": "/programming/android/api-reference/license", - "version": "3.2.10" - }, { - "path": "/programming/android/api-reference/core", - "version": "3.2.10" - } - ], - "dcvRepoCore": [ - { - "path": "/enums/core", - "version": "3.2.10" - },{ - "path": "/parameters/reference/capture-vision-template", - "version": "2.2.10" - },{ - "path": "/parameters/reference/target-roi-def", - "version": "2.2.10" - },{ - "path": "/parameters/reference/code-parser-task-settings", - "version": "2.2.10" - },{ - "path": "/parameters/reference/image-parameter", - "version": "2.2.10" - },{ - "path": "/parameters/reference/semantic-processing", - "version": "3.2.10" - },{ - "path": "/parameters/reference/image-source-options", - "version": "3.2.10" - },{ - "path": "/parameters/reference/global-parameter", - "version": "2.2.10" - },{ - "path": "/parameters/reference/label-recognizer-task-settings", - "version": "3.2.10" - },{ - "path": "/parameters/reference/text-line-specification", - "version": "3.2.10" - },{ - "path": "/parameters/reference/barcode-reader-task-settings", - "version": "10.2.10" - } - ] - }, - "ios":{ - "dcvRepoMobile": [ - { - "path": "/programming/objectivec-swift/api-reference/license", - "version": "3.2.11" - }, { - "path": "/programming/objectivec-swift/api-reference/core", - "version": "3.2.11" - } - ], - "dcvRepoCore": [ - { - "path": "/enums/core", - "version": "3.2.10" - },{ - "path": "/parameters/reference/capture-vision-template", - "version": "2.2.10" - },{ - "path": "/parameters/reference/target-roi-def", - "version": "2.2.10" - },{ - "path": "/parameters/reference/code-parser-task-settings", - "version": "2.2.10" - },{ - "path": "/parameters/reference/image-parameter", - "version": "2.2.10" - },{ - "path": "/parameters/reference/semantic-processing", - "version": "3.2.10" - },{ - "path": "/parameters/reference/image-source-options", - "version": "3.2.10" - },{ - "path": "/parameters/reference/global-parameter", - "version": "2.2.10" - },{ - "path": "/parameters/reference/label-recognizer-task-settings", - "version": "3.2.10" - },{ - "path": "/parameters/reference/text-line-specification", - "version": "3.2.10" - },{ - "path": "/parameters/reference/barcode-reader-task-settings", - "version": "10.2.10" - } - ] - } - } - }, { - "version": "2.0.21", - "matchList": { - "ios":{ - "dcvRepoMobile": [ - { - "path": "/programming/objectivec-swift/api-reference/license", - "version": "3.0.20" - }, { - "path": "/programming/objectivec-swift/api-reference/core", - "version": "3.0.20" - } - ], - "dcvRepoCore": [ - { - "path": "/enums/core", - "version": "3.0.20" - },{ - "path": "/parameters/reference/capture-vision-template", - "version": "2.0.21" - },{ - "path": "/parameters/reference/target-roi-def", - "version": "2.0.21" - },{ - "path": "/parameters/reference/code-parser-task-settings", - "version": "2.0.20" - },{ - "path": "/parameters/reference/image-parameter", - "version": "2.0.21" - },{ - "path": "/parameters/reference/semantic-processing", - "version": "3.0.20" - },{ - "path": "/parameters/reference/image-source-options", - "version": "3.0.20" - },{ - "path": "/parameters/reference/global-parameter", - "version": "2.0.21" - },{ - "path": "/parameters/reference/label-recognizer-task-settings", - "version": "3.0.20" - },{ - "path": "/parameters/reference/text-line-specification", - "version": "3.0.20" - },{ - "path": "/parameters/reference/barcode-reader-task-settings", - "version": "10.0.21" - } - ] - } - } - },{ - "version": "2.0.20", - "matchList": { - "android":{ - "dcvRepoMobile": [ - { - "path": "/programming/android/api-reference/license", - "version": "3.0.20" - }, { - "path": "/programming/android/api-reference/core", - "version": "3.0.20" - } - ], - "dcvRepoCore": [ - { - "path": "/enums/core", - "version": "3.0.20" - },{ - "path": "/parameters/reference/capture-vision-template", - "version": "2.0.21" - },{ - "path": "/parameters/reference/target-roi-def", - "version": "2.0.21" - },{ - "path": "/parameters/reference/code-parser-task-settings", - "version": "2.0.20" - },{ - "path": "/parameters/reference/image-parameter", - "version": "2.0.21" - },{ - "path": "/parameters/reference/semantic-processing", - "version": "3.0.20" - },{ - "path": "/parameters/reference/image-source-options", - "version": "3.0.20" - },{ - "path": "/parameters/reference/global-parameter", - "version": "2.0.21" - },{ - "path": "/parameters/reference/label-recognizer-task-settings", - "version": "3.0.20" - },{ - "path": "/parameters/reference/text-line-specification", - "version": "3.0.20" - },{ - "path": "/parameters/reference/barcode-reader-task-settings", - "version": "10.0.20" - } - ] - }, - "ios":{ - "dcvRepoMobile": [ - { - "path": "/programming/objectivec-swift/api-reference/utility", - "version": "1.0.21" - }, { - "path": "/programming/objectivec-swift/api-reference/license", - "version": "3.0.20" - }, { - "path": "/programming/objectivec-swift/api-reference/capture-vision-router", - "version": "2.0.21" - }, { - "path": "/programming/objectivec-swift/api-reference/core", - "version": "3.0.20" - }, { - "path": "/programming/objectivec-swift/api-reference/image-processing", - "version": "2.0.21" - } - ], - "dcvRepoCore": [ - { - "path": "/enums/core", - "version": "3.0.20" - },{ - "path": "/parameters/reference/capture-vision-template", - "version": "2.0.21" - },{ - "path": "/parameters/reference/target-roi-def", - "version": "2.0.21" - },{ - "path": "/parameters/reference/code-parser-task-settings", - "version": "2.0.20" - },{ - "path": "/parameters/reference/image-parameter", - "version": "2.0.21" - },{ - "path": "/parameters/reference/semantic-processing", - "version": "3.0.20" - },{ - "path": "/parameters/reference/image-source-options", - "version": "3.0.20" - },{ - "path": "/parameters/reference/global-parameter", - "version": "2.0.21" - },{ - "path": "/parameters/reference/label-recognizer-task-settings", - "version": "3.0.20" - },{ - "path": "/parameters/reference/text-line-specification", - "version": "3.0.20" - },{ - "path": "/parameters/reference/barcode-reader-task-settings", - "version": "10.0.20" - } - ] - } - } - } -] - \ No newline at end of file diff --git a/programming/android/api-reference/parsed-result-item-v2.4.2000.md b/programming/android/api-reference/parsed-result-item-v2.4.2000.md deleted file mode 100644 index 9175147..0000000 --- a/programming/android/api-reference/parsed-result-item-v2.4.2000.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -layout: default-layout -title: ParsedResultItem Class - Dynamsoft Code Parser SDK Android Edition API Reference -description: This page shows ParsedResultItem Class of Dynamsoft Code Parser SDK Android Edition. -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:* com.dynamsoft.dcp - -*Assembly:* DynamsoftCodeParser.aar - -```java -class ParsedResultItem extends CapturedResultItem -``` - - | Method | Description | - |----------------------|-------------| - | [`getCodeType`](#getcodetype) | Gets the code type of the parsed result. | - | [`getFieldMappingStatus`](#getfieldmappingstatus) | Gets the mapping status of a specified field from the parsed result. | - | [`getFieldValidationStatus`](#getfieldvalidationstatus) | Gets the validation status of a specified field from the parsed result. | - | [`getFieldValue`](#getfieldvalue) | Gets the value of a specified field from the parsed result. | - | [`getJsonString`](#getjsonstring) | Gets the parsed result as a JSON formatted string. | - -## getCodeType - -Gets the code type of the parsed result. - -```java -String getCodeType(); -``` - -**Return Value** - -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 - -Gets the parsed result as a JSON formatted string. - -```java -String getJsonString(); -``` - -**Return Value** - -Returns a JSON formatted string representing the parsed result. - -## getFieldValue - -Gets the value of a specified field from the parsed result. - -```java -String getFieldValue(String fieldName); -``` - -**Parameters** - -`[in] fieldName`: The name of the field. - -**Return Value** - -Returns a string representing the specified field value. - -## getFieldMappingStatus - -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); -``` - -**Parameters** - -`[in] fieldName`: The name of the field. - -**Return Value** - -Returns a [MappingStatus]({{ site.dcv_enumerations }}code-parser/mapping-status.html?lang=android) enumeration value representing the mapping status of a specified field. - -**See Also** - -[MappingStatus]({{ site.dcv_enumerations }}code-parser/mapping-status.html?lang=android) - -## getFieldValidationStatus - -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); -``` - -**Parameters** - -`[in] fieldName`: The name of the field. - -**Return Value** - -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** - -[ValidationStatus]({{ site.dcv_enumerations }}code-parser/validation-status.html?lang=android) - -## getParsedFields - -Get the field names and values of the parsed fields as a `HashMap`. The field names are stored as the key of the HashMap while the field values are stored as the value. - -```java -HashMap getParsedFields(); -``` - -**Return Value** - -A HashMap that contains the names and values of the parsed fields. diff --git a/programming/ios/api-reference/parsed-result-item-v2.4.2000.md b/programming/ios/api-reference/parsed-result-item-v2.4.2000.md deleted file mode 100644 index eacda15..0000000 --- a/programming/ios/api-reference/parsed-result-item-v2.4.2000.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -layout: default-layout -title: DSParsedResultItem Class - Dynamsoft Code Parser SDK iOS Edition API Reference -description: This page shows DSParsedResultItem Class of Dynamsoft Code Parser SDK iOS Edition. -keywords: DSParsedResultItem, api reference, iOS -needAutoGenerateSidebar: true ---- - - -# DSParsedResultItem Class - -`ParsedResultItem` it the basic unit of a parsed result. It stores the field name, value and additional information. - -## Definition - -*Assembly:* DynamsoftCodeParser.xcframework - -
->- Objective-C ->- Swift -> ->1. -```objc -@interface DSParsedResultItem: DSCapturedResultItem -``` -2. -```swift -class ParsedResultItem : CapturedResultItem -``` - -## Method Summary - -| Method | Description | -| ------ | ----------- | -| [`getFieldMappingStatus`](#getfieldmappingstatus) | Gets the mapping status of a specified field from the parsed result. | -| [`getFieldValidationStatus`](#getfieldvalidationstatus) | Gets the validation status of a specified field from the parsed result. | -| [`getFieldValue`](#getfieldvalue) | Gets the value of a specified field from the parsed result. | - -## Property Summary - -| Property | Type | Description | -| -------- | ---- | ----------- | -| [`codeType`](#codetype) | *NSString* | Gets the code type of the parsed result. | -| [`jsonString`](#jsonstring) | *NSString* | Gets the parsed result as a JSON formatted string. | -| [`parsedFields`](#parsedfields) | *NSDictionary* | A `NSDictionary` object stores the field names and values of the parsed fields. | - -## Method Detail - -### getFieldMappingStatus - -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 ->- Swift -> ->1. -```objc -- (DSMappingStatus *)getFieldMappingStatus(NSString *)fieldName; -``` -2. -```swift -func getFieldMappingStatus(_ fieldName:String) -> MappingStatus -``` - -**Parameters** - -`fieldName`: The name of the field. - -**Return Value** - -Returns a [MappingStatus]({{ site.dcv_enumerations }}code-parser/mapping-status.html?lang=objc,swift) enumeration value representing the mapping status of a specified field. - -### getFieldValidationStatus - -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 ->- Swift -> ->1. -```objc -- (DSValidationStatus *)getFieldValidationStatus(NSString *)fieldName; -``` -2. -```swift -func getFieldValidationStatus(_ fieldName:String) -> ValidationStatus -``` - -**Parameters** - -`fieldName`: The name of the field. - -**Return Value** - -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 - -Gets the value of a specified field from the parsed result. - -
->- Objective-C ->- Swift -> ->1. -```objc -- (NSString *)getFieldValue(NSString *)fieldName; -``` -2. -```swift -func getFieldValue(_ fieldName:String) -> String -``` - -**Parameters** - -`fieldName`: The name of the field. - -**Return Value** - -Returns a string representing the specified field value. - -## Property Detail - -### codeType - -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 ->- Swift -> ->1. -```objc -@property (nonatomic, readonly) NSString * codeType; -``` -2. -```swift -var codeType: String? { get } -``` - -### jsonString - -The parsed result as a JSON formatted string. - -
->- Objective-C ->- Swift -> ->1. -```objc -@property (nonatomic, readonly) NSString * jsonString; -``` -2. -```swift -var jsonString: String? { get } -``` - -### parsedFields - -A `NSDictionary` object stores the field names and values of the parsed fields. The field names are stored as the key of the HashMap while the field values are stored as the value. - -
->- Objective-C ->- Swift -> ->1. -```objc -@property (nonatomic, readonly) NSDictionary * parsedFields; -``` -2. -```swift -var parsedFields: NSDictionary { get } -``` diff --git a/programming/maui/api-reference/enum/code-type.md b/programming/maui/api-reference/enum/code-type.md new file mode 100644 index 0000000..b78974b --- /dev/null +++ b/programming/maui/api-reference/enum/code-type.md @@ -0,0 +1,36 @@ +--- +layout: default-layout +title: EnumCodeType - DCP MAUI Edition API Reference +description: Enumeration EnumCodeType of DCP MAUI edition represents the type of the parsed content. +keywords: Code type +needAutoGenerateSidebar: true +needGenerateH3Content: true +breadcrumbText: EnumCodeType +--- + +# EnumCodeType + +`CodeType` represents the type of the parsed content. + +## Definition + +*Namespace:* Dynamsoft.CodeParser.Maui + +*Assembly:* Dynamsoft.CodeParser.Maui + +```csharp +public class EnumCodeType { + public const string CT_MRTD_TD1_ID = "MRTD_TD1_ID"; + public const string CT_MRTD_TD2_ID = "MRTD_TD2_ID"; + public const string CT_MRTD_TD2_VISA = "MRTD_TD2_VISA"; + public const string CT_MRTD_TD3_PASSPORT = "MRTD_TD3_PASSPORT"; + public const string CT_MRTD_TD3_VISA = "MRTD_TD3_VISA"; + public const string CT_MRTD_TD2_FRENCH_ID = "MRTD_TD2_FRENCH_ID"; + public const string CT_AAMVA_DL_ID = "AAMVA_DL_ID"; + public const string CT_AAMVA_DL_ID_WITH_MAG_STRIPE = "AAMVA_DL_ID_WITH_MAG_STRIPE"; + public const string CT_SOUTH_AFRICA_DL = "SOUTH_AFRICA_DL"; + public const string CT_AADHAAR = "AADHAAR"; + public const string CT_VIN = "VIN"; + public const string CT_GS1_AI = "GS1_AI"; +} +``` diff --git a/programming/maui/api-reference/enum/mapping-status.md b/programming/maui/api-reference/enum/mapping-status.md index 8c1ad71..b06cfab 100644 --- a/programming/maui/api-reference/enum/mapping-status.md +++ b/programming/maui/api-reference/enum/mapping-status.md @@ -1,7 +1,7 @@ --- layout: default-layout title: EnumMappingStatus - DCP MAUI Edition API Reference -description: Enumeration EnumMappingStatus of +description: Enumeration EnumMappingStatus of DCP MAUI edition represents the outcome of a mapping operation on a field. keywords: Mapping status needAutoGenerateSidebar: true needGenerateH3Content: true diff --git a/programming/maui/api-reference/enum/validation-status.md b/programming/maui/api-reference/enum/validation-status.md index a325957..f845704 100644 --- a/programming/maui/api-reference/enum/validation-status.md +++ b/programming/maui/api-reference/enum/validation-status.md @@ -1,7 +1,7 @@ --- layout: default-layout title: EnumValidationStatus - DCP MAUI Edition API Reference -description: Enumeration EnumValidationStatus of +description: Enumeration EnumValidationStatus of DCP MAUI edition describes the outcome of a validation process on a field. keywords: validation status needAutoGenerateSidebar: true needGenerateH3Content: true diff --git a/programming/maui/api-reference/parsed-result-v2.6.1001.md b/programming/maui/api-reference/parsed-result-v2.6.1001.md deleted file mode 100644 index 3914338..0000000 --- a/programming/maui/api-reference/parsed-result-v2.6.1001.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -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* | 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 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; } -```