Skip to content

Commit 818057f

Browse files
a362758199a362758199
authored
Merge pull request #17 from dynamsoft-docs/preview
update to internal commit 3ebc93f7
2 parents 2a718d6 + 52d6461 commit 818057f

File tree

12 files changed

+164
-153
lines changed

12 files changed

+164
-153
lines changed

‎programming/android/api-reference/code-parser-module.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ needAutoGenerateSidebar: true
1414

1515
*Namespace:* com.dynamsoft.dcp
1616

17-
*Assembly:* DynamsoftCodeParser.aar
17+
*Assembly:* DynamsoftCaptureVisionBundle.aar
1818

1919
```java
2020
class CodeParserModule

‎programming/android/api-reference/code-parser.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The `CodeParser` class enable users to configure the code parser settings or par
1414

1515
*Namespace:* com.dynamsoft.dcp
1616

17-
*Assembly:* DynamsoftCodeParser.aar
17+
*Assembly:* DynamsoftCaptureVisionBundle.aar
1818

1919
```java
2020
class CodeParser

‎programming/android/api-reference/enum/mapping-status.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
layout: default-layout
3+
title: MappingStatus - Dynamsoft Code Parser Enumerations
4+
description: The enumeration MappingStatus of Dynamsoft Code Parser represents the outcome of a mapping operation on a field.
5+
keywords: Mapping status
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
breadcrumbText: MappingStatus
10+
---
11+
12+
# Enumeration MappingStatus
13+
14+
`MappingStatus` represents the outcome of a mapping operation on a field.
15+
16+
```java
17+
@Retention(RetentionPolicy.CLASS)
18+
public @interface EnumMappingStatus {
19+
/** The field has no mapping specified. */
20+
public static final int MS_NONE = 0;
21+
/** Find a mapping for the field value. */
22+
public static final int MS_SUCCEEDED = 1;
23+
/** Failed to find a mapping for the field value. */
24+
public static final int MS_FAILED = 2;
25+
}
26+
```

‎programming/android/api-reference/enum/validation-status.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
layout: default-layout
3+
title: ValidationStatus - Dynamsoft Code Parser Enumerations
4+
description: The enumeration ValidationStatus of Dynamsoft Code Parser describes the outcome of a validation process on a field.
5+
keywords: Validation status
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
breadcrumbText: ValidationStatus
10+
---
11+
12+
# Enumeration ValidationStatus
13+
14+
`ValidationStatus` describes the outcome of a validation process on a field.
15+
16+
```java
17+
@Retention(RetentionPolicy.CLASS)
18+
public @interface EnumValidationStatus
19+
{
20+
/** The field has no validation specified. */
21+
public static final int VS_NONE = 0;
22+
/** The validation for the field has been succeeded. */
23+
public static final int VS_SUCCEEDED = 1;
24+
/** The validation for the field has been failed. */
25+
public static final int VS_FAILED = 2;
26+
}
27+
```

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ needAutoGenerateSidebar: true
1414

1515
*Namespace:* com.dynamsoft.dcp
1616

17-
*Assembly:* DynamsoftCodeParser.aar
17+
*Assembly:* DynamsoftCaptureVisionBundle.aar
1818

1919
```java
2020
class ParsedResultItem extends CapturedResultItem

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

Lines changed: 9 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -15,47 +15,25 @@ needAutoGenerateSidebar: true
1515

1616
*Namespace:* com.dynamsoft.dcp
1717

18-
*Assembly:* DynamsoftCodeParser.aar
18+
*Assembly:* DynamsoftCaptureVisionBundle.aar
1919

2020
```java
2121
class ParsedResult
2222
```
2323

2424
| Method | Description |
2525
|----------------------|-------------|
26-
| [`getOriginalImageHashId`](#getoriginalimagehashid) | Gets the hash ID of the source image. |
27-
| [`getOriginalImageTag`](#getoriginalimagetag) | Gets the tag of the source image. |
2826
| [`getItems`](#getitems) | Gets the parsed result item at the specified index. |
29-
| [`getErrorCode`](#geterrorcode) | Gets the error code of the parsed result, if an error occurred. |
30-
| [`getErrorString`](#geterrormessage) | Gets the error message of the parsed result, if an error occurred. |
3127

32-
### getOriginalImageHashId
28+
The following methods are inherited from [`CapturedResultBase`]({{ site.dcv_android_api }}core/basic-structures/captured-result-base.html):
3329

34-
Gets the hash ID of the source image.
35-
36-
```java
37-
String getOriginalImageHashId();
38-
```
39-
40-
**Return value**
41-
42-
Returns a pointer to a null-terminated string containing the hash ID of the source image.
43-
44-
### getOriginalImageTag
45-
46-
Gets the tag of the source image.
47-
48-
```java
49-
ImageTag getOriginalImageTag();
50-
```
51-
52-
**Return value**
53-
54-
Returns a pointer to a CImageTag object representing the tag of the source image.
55-
56-
**See Also**
57-
58-
[ImageTag]({{ site.dcv_android_api }}core/basic-structures/image-tag.html)
30+
| Method | Description |
31+
| ------ | ----------- |
32+
| [`getOriginalImageHashId`]({{ site.dcv_android_api }}core/basic-structures/captured-result-base.html#getoriginalimagehashid) | Gets the hash id of the original image. |
33+
| [`getOriginalImageTag`]({{ site.dcv_android_api }}core/basic-structures/captured-result-base.html#getoriginalimagetag) | Gets the [ImageTag](image-tag.md) of the original image. |
34+
| [`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. |
35+
| [`getErrorCode`]({{ site.dcv_android_api }}core/basic-structures/captured-result-base.html#geterrorcode) | Gets the error code of this result. |
36+
| [`getErrorMessage`]({{ site.dcv_android_api }}core/basic-structures/captured-result-base.html#geterrormessage) | Gets the error message of this result. |
5937

6038
### getItems
6139

@@ -72,27 +50,3 @@ Returns an array of `ParsedResultItem`.
7250
**See Also**
7351

7452
[ParsedResultItem]({{ site.dcp_android_api }}parsed-result-item.html)
75-
76-
### getErrorCode
77-
78-
Gets the error code of the parsed result, if an error occurred.
79-
80-
```java
81-
int getErrorCode();
82-
```
83-
84-
**Return value**
85-
86-
Returns the error code of the parsed result, or 0 if no error occurred.
87-
88-
### getErrorMessage
89-
90-
Gets the error message of the parsed result, if an error occurred.
91-
92-
```java
93-
String getErrorMessage();
94-
```
95-
96-
**Return value**
97-
98-
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.

‎programming/ios/api-reference/code-parser-module.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ needAutoGenerateSidebar: true
1212

1313
## Definition
1414

15-
*Assembly:* DynamsoftCodeParser.xcframework
15+
*Assembly:* DynamsoftCaptureVisionBundle.xcframework
1616

1717
<div class="sample-code-prefix"></div>
1818
>- Objective-C

‎programming/ios/api-reference/code-parser.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The `DSCodeParser` class enable users to configure the code parser settings or p
1212

1313
## Definition
1414

15-
*Assembly:* DynamsoftCodeParser.xcframework
15+
*Assembly:* DynamsoftCaptureVisionBundle.xcframework
1616

1717
<div class="sample-code-prefix"></div>
1818
>- Objective-C

‎programming/ios/api-reference/enum/mapping-status.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
layout: default-layout
3+
title: MappingStatus - Dynamsoft Code Parser Enumerations
4+
description: The enumeration MappingStatus of Dynamsoft Code Parser represents the outcome of a mapping operation on a field.
5+
keywords: Mapping status
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
breadcrumbText: MappingStatus
10+
---
11+
12+
# Enumeration MappingStatus
13+
14+
`MappingStatus` represents the outcome of a mapping operation on a field.
15+
16+
<div class="sample-code-prefix template2"></div>
17+
>- Objective-C
18+
>- Swift
19+
>
20+
>
21+
```objc
22+
typedef NS_ENUM(NSInteger, DSMappingStatus)
23+
{
24+
/** The field has no mapping specified. */
25+
DSMappingStatusNotSpecified = 0,
26+
/** Find a mapping for the field value. */
27+
DSMappingStatusSucceeded = 1,
28+
/** Failed to find a mapping for the field value. */
29+
DSMappingStatusFailed = 2
30+
};
31+
```
32+
>
33+
```swift
34+
public enum MappingStatus : Int
35+
{
36+
/** The field has no mapping specified. */
37+
none = 0
38+
/** Find a mapping for the field value. */
39+
succeeded = 1
40+
/** Failed to find a mapping for the field value. */
41+
failed = 2
42+
}
43+
```

‎programming/ios/api-reference/enum/validation-status.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
layout: default-layout
3+
title: ValidationStatus - Dynamsoft Code Parser Enumerations
4+
description: The enumeration ValidationStatus of Dynamsoft Code Parser describes the outcome of a validation process on a field.
5+
keywords: Validation status
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
breadcrumbText: ValidationStatus
10+
---
11+
12+
# Enumeration ValidationStatus
13+
14+
`ValidationStatus` describes the outcome of a validation process on a field.
15+
16+
<div class="sample-code-prefix template2"></div>
17+
>- Objective-C
18+
>- Swift
19+
>
20+
>
21+
```objc
22+
typedef NS_ENUM(NSInteger, DSValidationStatus)
23+
{
24+
/** The field has no validation specified. */
25+
DSValidationStatusNone = 0,
26+
/** The validation for the field has been succeeded. */
27+
DSValidationStatusSucceeded = 1,
28+
/** The validation for the field has been failed. */
29+
DSValidationStatusFailed = 2
30+
};
31+
```
32+
>
33+
```swift
34+
public enum ValidationStatus : Int
35+
{
36+
/** The field has no validation specified. */
37+
none = 0
38+
/** The validation for the field has been succeeded. */
39+
succeeded = 1
40+
/** The validation for the field has been failed. */
41+
failed = 2
42+
}
43+
```

0 commit comments

Comments
 (0)