Skip to content

Commit be361c6

Browse files
update to internal commit 3ebc93f7
1 parent d77bea8 commit be361c6

File tree

2 files changed

+17
-145
lines changed

2 files changed

+17
-145
lines changed

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

Lines changed: 8 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -23,39 +23,17 @@ class ParsedResult
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/parsed-result.md

Lines changed: 9 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -32,59 +32,19 @@ class ParsedResult : NSObject
3232

3333
| Property | Type | Description |
3434
| -------- | ---- | ----------- |
35-
| [`originalImageHashId`](#originalimagehashid) | *NSString \** | Gets the hash ID of the source image. |
36-
| [`originalImageTag`](#originalimagetag) | *DSImageTag \** | Gets the tag of the source image. |
3735
| [`items`](#items) | *NSArray<DSParsedResultItem*> \** | Gets the parsed result item at the specified index. |
38-
| [`errorCode`](#errorcode) | *NSInteger* | Gets the error code of the parsed result, if an error occurred. |
39-
| [`errorString`](#errormessage) | *NSString \** | Gets the error message of the parsed result, if an error occurred. |
4036

41-
## Method Detail
42-
43-
### originalImageHashId
44-
45-
Gets the hash ID of the source image.
46-
47-
<div class="sample-code-prefix"></div>
48-
>- Objective-C
49-
>- Swift
50-
>
51-
>1.
52-
```objc
53-
@property (nonatomic, nullable, readonly) NSString* originalImageHashId;
54-
```
55-
2.
56-
```swift
57-
var originalImageHashId: String? { get }
58-
```
59-
60-
**Return value**
61-
62-
Returns a pointer to a null-terminated string containing the hash ID of the source image.
63-
64-
### originalImageTag
65-
66-
Gets the tag of the source image.
67-
68-
<div class="sample-code-prefix"></div>
69-
>- Objective-C
70-
>- Swift
71-
>
72-
>1.
73-
```objc
74-
@property (nonatomic, nullable, readonly) DSImageTag* originalImageTag;
75-
```
76-
2.
77-
```swift
78-
var originalImageTag: ImageTag? { get }
79-
```
80-
81-
**Return value**
82-
83-
Returns a pointer to a CImageTag object representing the tag of the source image.
37+
The following attributes are inherited from [`DSCapturedResultBase`]({{ site.dcv_ios_api }}core/basic-structures/captured-result-base.html):
8438

85-
**See Also**
39+
| Attributes | Type | Description |
40+
| ---------- | ---- | ----------- |
41+
| [`originalImageHashId`]({{ site.dcv_ios_api }}core/basic-structures/captured-result-base.html#originalimagehashid) | *NSString \** | The hash id of the original image. |
42+
| [`originalImageTag`]({{ site.dcv_ios_api }}core/basic-structures/captured-result-base.html#originalimagetag) | *DSImageTag \** | The [DSImageTag](image-tag.md) of the original image. |
43+
| [`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. |
44+
| [`errorCode`]({{ site.dcv_ios_api }}core/basic-structures/captured-result-base.html#errorcode) | *NSInteger* | Get the error code of this result. |
45+
| [`errorMessage`]({{ site.dcv_ios_api }}core/basic-structures/captured-result-base.html#errormessage) | *NSString \** | Get the error message of this result. |
8646

87-
[ImageTag]({{ site.dcv_ios_api }}core/basic-structures/image-tag.html)
47+
## Method Detail
8848

8949
### items
9050

@@ -106,45 +66,3 @@ var items: [ParsedResultItem]? { get }
10666
**Return value**
10767

10868
Returns an array of [`ParsedResultItem`](parsed-result-item.html).
109-
110-
### errorCode
111-
112-
Gets the error code of the parsed result, if an error occurred.
113-
114-
<div class="sample-code-prefix"></div>
115-
>- Objective-C
116-
>- Swift
117-
>
118-
>1.
119-
```objc
120-
@property (nonatomic, assign, readonly) NSInteger errorCode;
121-
```
122-
2.
123-
```swift
124-
var errorCode: Int { get }
125-
```
126-
127-
**Return value**
128-
129-
Returns the error code of the parsed result, or 0 if no error occurred.
130-
131-
### errorMessage
132-
133-
Gets the error message of the parsed result, if an error occurred.
134-
135-
<div class="sample-code-prefix"></div>
136-
>- Objective-C
137-
>- Swift
138-
>
139-
>1.
140-
```objc
141-
@property (nonatomic, assign, readonly) NSString * errorMessage;
142-
```
143-
2.
144-
```swift
145-
var errorMessage: String? { get }
146-
```
147-
148-
**Return value**
149-
150-
The error message in a string.

0 commit comments

Comments
 (0)