diff --git a/programming/android/api-reference/code-parser-module.md b/programming/android/api-reference/code-parser-module.md index be18b84..d9dd34d 100644 --- a/programming/android/api-reference/code-parser-module.md +++ b/programming/android/api-reference/code-parser-module.md @@ -14,7 +14,7 @@ needAutoGenerateSidebar: true *Namespace:* com.dynamsoft.dcp -*Assembly:* DynamsoftCodeParser.aar +*Assembly:* DynamsoftCaptureVisionBundle.aar ```java class CodeParserModule diff --git a/programming/android/api-reference/code-parser.md b/programming/android/api-reference/code-parser.md index 2aaf93d..91bdbcf 100644 --- a/programming/android/api-reference/code-parser.md +++ b/programming/android/api-reference/code-parser.md @@ -14,7 +14,7 @@ The `CodeParser` class enable users to configure the code parser settings or par *Namespace:* com.dynamsoft.dcp -*Assembly:* DynamsoftCodeParser.aar +*Assembly:* DynamsoftCaptureVisionBundle.aar ```java class CodeParser diff --git a/programming/android/api-reference/enum/mapping-status.md b/programming/android/api-reference/enum/mapping-status.md new file mode 100644 index 0000000..1c34b53 --- /dev/null +++ b/programming/android/api-reference/enum/mapping-status.md @@ -0,0 +1,26 @@ +--- +layout: default-layout +title: MappingStatus - Dynamsoft Code Parser Enumerations +description: The enumeration MappingStatus of Dynamsoft Code Parser represents the outcome of a mapping operation on a field. +keywords: Mapping status +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: MappingStatus +--- + +# Enumeration MappingStatus + +`MappingStatus` represents the outcome of a mapping operation on a field. + +```java +@Retention(RetentionPolicy.CLASS) +public @interface EnumMappingStatus { + /** The field has no mapping specified. */ + public static final int MS_NONE = 0; + /** Find a mapping for the field value. */ + public static final int MS_SUCCEEDED = 1; + /** Failed to find a mapping for the field value. */ + public static final int MS_FAILED = 2; +} +``` diff --git a/programming/android/api-reference/enum/validation-status.md b/programming/android/api-reference/enum/validation-status.md new file mode 100644 index 0000000..7f75162 --- /dev/null +++ b/programming/android/api-reference/enum/validation-status.md @@ -0,0 +1,27 @@ +--- +layout: default-layout +title: ValidationStatus - Dynamsoft Code Parser Enumerations +description: The enumeration ValidationStatus of Dynamsoft Code Parser describes the outcome of a validation process on a field. +keywords: Validation status +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: ValidationStatus +--- + +# Enumeration ValidationStatus + +`ValidationStatus` describes the outcome of a validation process on a field. + +```java +@Retention(RetentionPolicy.CLASS) +public @interface EnumValidationStatus +{ + /** The field has no validation specified. */ + public static final int VS_NONE = 0; + /** The validation for the field has been succeeded. */ + public static final int VS_SUCCEEDED = 1; + /** The validation for the field has been failed. */ + public static final int VS_FAILED = 2; +} +``` diff --git a/programming/android/api-reference/parsed-result-item.md b/programming/android/api-reference/parsed-result-item.md index 48534a8..ccd876d 100644 --- a/programming/android/api-reference/parsed-result-item.md +++ b/programming/android/api-reference/parsed-result-item.md @@ -14,7 +14,7 @@ needAutoGenerateSidebar: true *Namespace:* com.dynamsoft.dcp -*Assembly:* DynamsoftCodeParser.aar +*Assembly:* DynamsoftCaptureVisionBundle.aar ```java class ParsedResultItem extends CapturedResultItem diff --git a/programming/android/api-reference/parsed-result.md b/programming/android/api-reference/parsed-result.md index b5001d0..011423f 100644 --- a/programming/android/api-reference/parsed-result.md +++ b/programming/android/api-reference/parsed-result.md @@ -15,7 +15,7 @@ needAutoGenerateSidebar: true *Namespace:* com.dynamsoft.dcp -*Assembly:* DynamsoftCodeParser.aar +*Assembly:* DynamsoftCaptureVisionBundle.aar ```java class ParsedResult @@ -23,39 +23,17 @@ class ParsedResult | Method | Description | |----------------------|-------------| -| [`getOriginalImageHashId`](#getoriginalimagehashid) | Gets the hash ID of the source image. | -| [`getOriginalImageTag`](#getoriginalimagetag) | Gets the tag of the source image. | | [`getItems`](#getitems) | Gets the parsed result item at the specified index. | -| [`getErrorCode`](#geterrorcode) | Gets the error code of the parsed result, if an error occurred. | -| [`getErrorString`](#geterrormessage) | Gets the error message of the parsed result, if an error occurred. | -### getOriginalImageHashId +The following methods are inherited from [`CapturedResultBase`]({{ site.dcv_android_api }}core/basic-structures/captured-result-base.html): -Gets the hash ID of the source image. - -```java -String getOriginalImageHashId(); -``` - -**Return value** - -Returns a pointer to a null-terminated string containing the hash ID of the source image. - -### getOriginalImageTag - -Gets the tag of the source image. - -```java -ImageTag getOriginalImageTag(); -``` - -**Return value** - -Returns a pointer to a CImageTag object representing the tag of the source image. - -**See Also** - -[ImageTag]({{ site.dcv_android_api }}core/basic-structures/image-tag.html) +| Method | Description | +| ------ | ----------- | +| [`getOriginalImageHashId`]({{ site.dcv_android_api }}core/basic-structures/captured-result-base.html#getoriginalimagehashid) | Gets the hash id of the original image. | +| [`getOriginalImageTag`]({{ site.dcv_android_api }}core/basic-structures/captured-result-base.html#getoriginalimagetag) | Gets the [ImageTag](image-tag.md) of the original image. | +| [`getRotationTransformMatrix`]({{ site.dcv_android_api }}core/basic-structures/captured-result-base.html#getrotationtransformmatrix) | Gets the rotation transformation matrix of the original image relative to the rotated image. | +| [`getErrorCode`]({{ site.dcv_android_api }}core/basic-structures/captured-result-base.html#geterrorcode) | Gets the error code of this result. | +| [`getErrorMessage`]({{ site.dcv_android_api }}core/basic-structures/captured-result-base.html#geterrormessage) | Gets the error message of this result. | ### getItems @@ -72,27 +50,3 @@ Returns an array of `ParsedResultItem`. **See Also** [ParsedResultItem]({{ site.dcp_android_api }}parsed-result-item.html) - -### getErrorCode - -Gets the error code of the parsed result, if an error occurred. - -```java -int getErrorCode(); -``` - -**Return value** - -Returns the error code of the parsed result, or 0 if no error occurred. - -### getErrorMessage - -Gets the error message of the parsed result, if an error occurred. - -```java -String getErrorMessage(); -``` - -**Return value** - -Returns a pointer to a null-terminated string containing the error message of the parsed result, or a pointer to an empty string if no error occurred. diff --git a/programming/ios/api-reference/code-parser-module.md b/programming/ios/api-reference/code-parser-module.md index 4a43490..b70ee0a 100644 --- a/programming/ios/api-reference/code-parser-module.md +++ b/programming/ios/api-reference/code-parser-module.md @@ -12,7 +12,7 @@ needAutoGenerateSidebar: true ## Definition -*Assembly:* DynamsoftCodeParser.xcframework +*Assembly:* DynamsoftCaptureVisionBundle.xcframework
>- Objective-C diff --git a/programming/ios/api-reference/code-parser.md b/programming/ios/api-reference/code-parser.md index fe20b41..4b06665 100644 --- a/programming/ios/api-reference/code-parser.md +++ b/programming/ios/api-reference/code-parser.md @@ -12,7 +12,7 @@ The `DSCodeParser` class enable users to configure the code parser settings or p ## Definition -*Assembly:* DynamsoftCodeParser.xcframework +*Assembly:* DynamsoftCaptureVisionBundle.xcframework
>- Objective-C diff --git a/programming/ios/api-reference/enum/mapping-status.md b/programming/ios/api-reference/enum/mapping-status.md new file mode 100644 index 0000000..32c3a47 --- /dev/null +++ b/programming/ios/api-reference/enum/mapping-status.md @@ -0,0 +1,43 @@ +--- +layout: default-layout +title: MappingStatus - Dynamsoft Code Parser Enumerations +description: The enumeration MappingStatus of Dynamsoft Code Parser represents the outcome of a mapping operation on a field. +keywords: Mapping status +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: MappingStatus +--- + +# Enumeration MappingStatus + +`MappingStatus` represents the outcome of a mapping operation on a field. + +
+ >- Objective-C + >- Swift + > +> +```objc +typedef NS_ENUM(NSInteger, DSMappingStatus) +{ + /** The field has no mapping specified. */ + DSMappingStatusNotSpecified = 0, + /** Find a mapping for the field value. */ + DSMappingStatusSucceeded = 1, + /** Failed to find a mapping for the field value. */ + DSMappingStatusFailed = 2 +}; +``` +> +```swift +public enum MappingStatus : Int +{ + /** The field has no mapping specified. */ + none = 0 + /** Find a mapping for the field value. */ + succeeded = 1 + /** Failed to find a mapping for the field value. */ + failed = 2 +} +``` diff --git a/programming/ios/api-reference/enum/validation-status.md b/programming/ios/api-reference/enum/validation-status.md new file mode 100644 index 0000000..f2f71c0 --- /dev/null +++ b/programming/ios/api-reference/enum/validation-status.md @@ -0,0 +1,43 @@ +--- +layout: default-layout +title: ValidationStatus - Dynamsoft Code Parser Enumerations +description: The enumeration ValidationStatus of Dynamsoft Code Parser describes the outcome of a validation process on a field. +keywords: Validation status +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: ValidationStatus +--- + +# Enumeration ValidationStatus + +`ValidationStatus` describes the outcome of a validation process on a field. + +
+ >- Objective-C + >- Swift + > +> +```objc +typedef NS_ENUM(NSInteger, DSValidationStatus) +{ + /** The field has no validation specified. */ + DSValidationStatusNone = 0, + /** The validation for the field has been succeeded. */ + DSValidationStatusSucceeded = 1, + /** The validation for the field has been failed. */ + DSValidationStatusFailed = 2 +}; +``` +> +```swift +public enum ValidationStatus : Int +{ + /** The field has no validation specified. */ + none = 0 + /** The validation for the field has been succeeded. */ + succeeded = 1 + /** The validation for the field has been failed. */ + failed = 2 +} +``` diff --git a/programming/ios/api-reference/parsed-result-item.md b/programming/ios/api-reference/parsed-result-item.md index cd99bfe..818a424 100644 --- a/programming/ios/api-reference/parsed-result-item.md +++ b/programming/ios/api-reference/parsed-result-item.md @@ -13,7 +13,7 @@ needAutoGenerateSidebar: true ## Definition -*Assembly:* DynamsoftCodeParser.xcframework +*Assembly:* DynamsoftCaptureVisionBundle.xcframework
>- Objective-C diff --git a/programming/ios/api-reference/parsed-result.md b/programming/ios/api-reference/parsed-result.md index accf579..323aea1 100644 --- a/programming/ios/api-reference/parsed-result.md +++ b/programming/ios/api-reference/parsed-result.md @@ -13,7 +13,7 @@ needAutoGenerateSidebar: true ## Definition -*Assembly:* DynamsoftCodeParser.xcframework +*Assembly:* DynamsoftCaptureVisionBundle.xcframework
>- Objective-C @@ -32,59 +32,19 @@ class ParsedResult : NSObject | Property | Type | Description | | -------- | ---- | ----------- | -| [`originalImageHashId`](#originalimagehashid) | *NSString \** | Gets the hash ID of the source image. | -| [`originalImageTag`](#originalimagetag) | *DSImageTag \** | Gets the tag of the source image. | | [`items`](#items) | *NSArray \** | Gets the parsed result item at the specified index. | -| [`errorCode`](#errorcode) | *NSInteger* | Gets the error code of the parsed result, if an error occurred. | -| [`errorString`](#errormessage) | *NSString \** | Gets the error message of the parsed result, if an error occurred. | -## Method Detail - -### originalImageHashId - -Gets the hash ID of the source image. - -
->- Objective-C ->- Swift -> ->1. -```objc -@property (nonatomic, nullable, readonly) NSString* originalImageHashId; -``` -2. -```swift -var originalImageHashId: String? { get } -``` - -**Return value** - -Returns a pointer to a null-terminated string containing the hash ID of the source image. - -### originalImageTag - -Gets the tag of the source image. - -
->- Objective-C ->- Swift -> ->1. -```objc -@property (nonatomic, nullable, readonly) DSImageTag* originalImageTag; -``` -2. -```swift -var originalImageTag: ImageTag? { get } -``` - -**Return value** - -Returns a pointer to a CImageTag object representing the tag of the source image. +The following attributes are inherited from [`DSCapturedResultBase`]({{ site.dcv_ios_api }}core/basic-structures/captured-result-base.html): -**See Also** +| Attributes | Type | Description | +| ---------- | ---- | ----------- | +| [`originalImageHashId`]({{ site.dcv_ios_api }}core/basic-structures/captured-result-base.html#originalimagehashid) | *NSString \** | The hash id of the original image. | +| [`originalImageTag`]({{ site.dcv_ios_api }}core/basic-structures/captured-result-base.html#originalimagetag) | *DSImageTag \** | The [DSImageTag](image-tag.md) of the original image. | +| [`rotationTransformMatrix`]({{ site.dcv_ios_api }}core/basic-structures/captured-result-base.html#rotationtransformmatrix) | *CGAffineTransform* | The rotation transformation matrix of the original image relative to the rotated image. | +| [`errorCode`]({{ site.dcv_ios_api }}core/basic-structures/captured-result-base.html#errorcode) | *NSInteger* | Get the error code of this result. | +| [`errorMessage`]({{ site.dcv_ios_api }}core/basic-structures/captured-result-base.html#errormessage) | *NSString \** | Get the error message of this result. | -[ImageTag]({{ site.dcv_ios_api }}core/basic-structures/image-tag.html) +## Method Detail ### items @@ -106,45 +66,3 @@ var items: [ParsedResultItem]? { get } **Return value** Returns an array of [`ParsedResultItem`](parsed-result-item.html). - -### errorCode - -Gets the error code of the parsed result, if an error occurred. - -
->- Objective-C ->- Swift -> ->1. -```objc -@property (nonatomic, assign, readonly) NSInteger errorCode; -``` -2. -```swift -var errorCode: Int { get } -``` - -**Return value** - -Returns the error code of the parsed result, or 0 if no error occurred. - -### errorMessage - -Gets the error message of the parsed result, if an error occurred. - -
->- Objective-C ->- Swift -> ->1. -```objc -@property (nonatomic, assign, readonly) NSString * errorMessage; -``` -2. -```swift -var errorMessage: String? { get } -``` - -**Return value** - -The error message in a string.