Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion programming/android/api-reference/code-parser-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ needAutoGenerateSidebar: true

*Namespace:* com.dynamsoft.dcp

*Assembly:* DynamsoftCodeParser.aar
*Assembly:* DynamsoftCaptureVisionBundle.aar

```java
class CodeParserModule
Expand Down
2 changes: 1 addition & 1 deletion programming/android/api-reference/code-parser.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
26 changes: 26 additions & 0 deletions programming/android/api-reference/enum/mapping-status.md
Original file line number Diff line number Diff line change
@@ -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;
}
```
27 changes: 27 additions & 0 deletions programming/android/api-reference/enum/validation-status.md
Original file line number Diff line number Diff line change
@@ -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;
}
```
2 changes: 1 addition & 1 deletion programming/android/api-reference/parsed-result-item.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ needAutoGenerateSidebar: true

*Namespace:* com.dynamsoft.dcp

*Assembly:* DynamsoftCodeParser.aar
*Assembly:* DynamsoftCaptureVisionBundle.aar

```java
class ParsedResultItem extends CapturedResultItem
Expand Down
64 changes: 9 additions & 55 deletions programming/android/api-reference/parsed-result.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,47 +15,25 @@ needAutoGenerateSidebar: true

*Namespace:* com.dynamsoft.dcp

*Assembly:* DynamsoftCodeParser.aar
*Assembly:* DynamsoftCaptureVisionBundle.aar

```java
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

Expand All @@ -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.
2 changes: 1 addition & 1 deletion programming/ios/api-reference/code-parser-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ needAutoGenerateSidebar: true

## Definition

*Assembly:* DynamsoftCodeParser.xcframework
*Assembly:* DynamsoftCaptureVisionBundle.xcframework

<div class="sample-code-prefix"></div>
>- Objective-C
Expand Down
2 changes: 1 addition & 1 deletion programming/ios/api-reference/code-parser.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The `DSCodeParser` class enable users to configure the code parser settings or p

## Definition

*Assembly:* DynamsoftCodeParser.xcframework
*Assembly:* DynamsoftCaptureVisionBundle.xcframework

<div class="sample-code-prefix"></div>
>- Objective-C
Expand Down
43 changes: 43 additions & 0 deletions programming/ios/api-reference/enum/mapping-status.md
Original file line number Diff line number Diff line change
@@ -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.

<div class="sample-code-prefix template2"></div>
>- 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
}
```
43 changes: 43 additions & 0 deletions programming/ios/api-reference/enum/validation-status.md
Original file line number Diff line number Diff line change
@@ -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.

<div class="sample-code-prefix template2"></div>
>- 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
}
```
2 changes: 1 addition & 1 deletion programming/ios/api-reference/parsed-result-item.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ needAutoGenerateSidebar: true

## Definition

*Assembly:* DynamsoftCodeParser.xcframework
*Assembly:* DynamsoftCaptureVisionBundle.xcframework

<div class="sample-code-prefix"></div>
>- Objective-C
Expand Down
Loading