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: 2 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ dcv_flutter_api: /capture-vision/docs/mobile/programming/flutter/api-reference/
dcp_flutter: /code-parser/docs/mobile/programming/flutter/
dcp_flutter_api: /code-parser/docs/mobile/programming/flutter/api-reference/

dcv_react_native_api: /capture-vision/docs/mobile/programming/react-native/api-reference/

dcv_android_api: /capture-vision/docs/mobile/programming/android/api-reference/
dcv_ios_api: /capture-vision/docs/mobile/programming/ios/api-reference/
dcv_maui_api: /capture-vision/docs/mobile/programming/maui/api-reference/
Expand Down
2 changes: 1 addition & 1 deletion programming/flutter/api-reference/parsed-result.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The `ParsedResult` class represents the result of a code parsing process. It pro
*Assembly:* dynamsoft_capture_vision_flutter

```dart
class ParsedResult
class ParsedResult extends CapturedResultBase
```

## Properties
Expand Down
33 changes: 33 additions & 0 deletions programming/react-native/api-reference/enum/mapping-status.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
layout: default-layout
title: EnumMappingStatus - Dynamsoft Capture Vision React Native
description: Enumeration EnumMappingStatus of Dynamsoft Capture Vision React Native Edition defines whether the field was mapped from the source data or not
keywords: captured result, react native, capture vision, mapping, code parser, mapping
needAutoGenerateSidebar: true
needGenerateH3Content: true
breadcrumbText: EnumMappingStatus
---

# EnumMappingStatus

`EnumMappingStatus` is an enumeration that represents whether the associated field was mapped from the source data or not.

## Definition

*Assembly:* dynamsoft-capture-vision-react-native

```js
enum EnumMappingStatus {
MS_NONE,
MS_SUCCEEDED,
MS_FAILED
}
```

## Members

| Member | Description |
| ------ | ----------- |
| `MS_NONE` | No mapping has been performed. |
| `MS_SUCCEEDED` | Mapping of this field was successful. |
| `MS_FAILED` | Mapping of this field was unsuccessful. |
33 changes: 33 additions & 0 deletions programming/react-native/api-reference/enum/validation-status.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
layout: default-layout
title: EnumValidationStatus - Dynamsoft Capture Vision React Native
description: Enumeration EnumValidationStatus of Dynamsoft Capture Vision React Native Edition defines the status of a field's value after the internal validation checks
keywords: captured result, react native, capture vision, mapping, code parser, validation
needAutoGenerateSidebar: true
needGenerateH3Content: true
breadcrumbText: EnumValidationStatus
---

# EnumValidationStatus

`EnumValidationStatus` is an enumeration that represents whether the associated field's value passed the internal validation checks.

## Definition

*Assembly:* dynamsoft-capture-vision-react-native

```js
enum EnumValidationStatus {
VS_NONE,
VS_SUCCEEDED,
VS_FAILED
}
```

## Members

| Member | Description |
| ------ | ----------- |
| `VS_NONE` | No validation check has been performed. |
| `VS_SUCCEEDED` | The validation of this field was successful. |
| `VS_FAILED` | The validation of this field was unsuccessful. |
53 changes: 53 additions & 0 deletions programming/react-native/api-reference/parsed-field.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
layout: default-layout
title: ParsedField - Dynamsoft Capture Vision React Native Edition
description: Interface ParsedField represents the result of a code parsing process. It provides access to the individual parsed items resulting from a document or an encrypted text.
keywords: originalImageHashId, items, errorCode, ParsedField, api reference, barcode result, capture, React Native, code parser
needAutoGenerateSidebar: true
needGenerateH3Content: true
breadcrumbText: ParsedField
---

# Interface ParsedField

Interface `ParsedField` represents a field from the [`ParsedResultItem`](parsed-result-item.md) output of an encrypted text coming from a document or a data source. It contains the parsed value along with its mapping and validation status.

## Definition

*Assembly:* dynamsoft-capture-vision-react-native

```js
interface ParsedField
```

## Properties

| Property | Type | Description |
| -------- | ---- | ----------- |
| [`value`](#value) | *String* | The processed value of the parsed field. |
| [`mappingStatus`](#mappingstatus) | [*EnumMappingStatus*](enum/mapping-status.md) | A status representing whether the field was mapped from the source data or not. |
| [`validationStatus`](#validationstatus) | [*EnumValidationStatus*](enum/validation-status.md) | The status of a field's value after the internal validation checks. |

### value

The processed value of the parsed field.

```js
value?: string
```

### mappingStatus

A status representing whether the field was mapped from the source data or not, represented as a [`EnumMappingStatus`](enum/mapping-status.md). If the field was unsuccessful during the mapping process, the mappingStatus would be `EnumMappingStatus.failed`.

```js
mappingStatus?: EnumMappingStatus | number
```

### validationStatus

The status of a field's value after the internal validation checks, represented as a [`EnumValidationStatus`](enum/validation-status.md). Once a field is parsed by the Code Parser, it is run through validation checks to make sure that the information is accurate and correct. If a field's value does not pass, the validationStatus would be `EnumValidationStatus.failed`.

```js
validationStatus?: EnumValidationStatus | number
```
64 changes: 64 additions & 0 deletions programming/react-native/api-reference/parsed-result-item.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
layout: default-layout
title: ParsedResultItem - Dynamsoft Capture Vision React Native Edition
description: Interface ParsedResult represents the result of a code parsing process. It provides access to the individual parsed items resulting from a document or an encrypted text.
keywords: originalImageHashId, items, errorCode, ParsedResultItem, api reference, barcode result, capture, React Native, code parser
needAutoGenerateSidebar: true
needGenerateH3Content: true
breadcrumbText: ParsedResultItem
---

# Interface ParsedResultItem

Interface `ParsedResultItem` represents the most basic unit of a parsed result. It includes specific details relevant to the parsed data, including the code type, the raw JSON string, and a map of the individual parsed fields.

## Definition

*Assembly:* dynamsoft-capture-vision-react-native

```js
interface ParsedResultItem extends CapturedResultItem
```

## Properties

| Property | Type | Description |
| -------- | ---- | ----------- |
| [`parsedFields`](#parsedfields) | *Map\<String, ParsedField\>* | A map of parsed fields extracted from the parsed result. |
| [`jsonString`](#jsonstring) | *String* | The raw JSON string representation of the parsed result. |
| [`codeType`](#codetype) | *String* | The type of the encrypted code associated to the attached parsed result. |

The following methods are inherited from [`CapturedResultItem`]({{ site.dcv_react_native_api }}core/captured-result-item.html).

| Property | Type | Description |
| -------- | ---- | ----------- |
| [`targetROIDefName`]({{ site.dcv_react_native_api }}core/captured-result-item.html#targetroidefname) | *String* | The name of the target region of interest (ROI) where the captured result was found. |
| [`taskName`]({{ site.dcv_react_native_api }}core/captured-result-item.html#taskname) | *String* | The name of the recognition task that produced the CapturedResultItem. |
| [`type`]({{ site.dcv_react_native_api }}core/captured-result-item.html#type) | [*EnumCapturedResultItemType*]({{ site.dcv_react_native_api }}core/enum/captured-result-item-type.html) | The type of the captured result item. |

### parsedFields

A map of the parsed fields extracted from the parsed result.

- Key: The field names of the code. [Check the available field names]({{ site.code_types }})
- Value: [`ParsedField`](parsed-field.md)

```js
parsedFields?: Record<string, ParsedField>
```

### jsonString

The text of the parsed result as a JSON string.

```js
jsonString: string
```

### codeType

The type of the encrypted code associated to the attached parsed result. The code can be a MRZ document (passport, visa, etc.), a driver license (North America or South Africa), or an Aadhar card.

```js
codeType: string
```
44 changes: 44 additions & 0 deletions programming/react-native/api-reference/parsed-result.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
layout: default-layout
title: ParsedResult - Dynamsoft Capture Vision React Native Edition
description: Interface ParsedResult represents the result of a code parsing process. It provides access to the individual parsed items resulting from a document or an encrypted text.
keywords: originalImageHashId, items, errorCode, ParsedResult, api reference, barcode result, capture, React Native, code parser
needAutoGenerateSidebar: true
needGenerateH3Content: true
breadcrumbText: ParsedResult
---

# Interface ParsedResult

Interface `ParsedResult` represents the result of a code parsing process. It provides access to the individual parsed items resulting from a document or an encrypted text.

## Definition

*Assembly:* dynamsoft-capture-vision-react-native

```js
interface ParsedResult extends CapturedResultBase
```

## Properties

| Property | Type | Description |
| -------- | ---- | ----------- |
| [`items`](#items) | *Array\<ParsedResultItem\>* | A list of [`ParsedResultItem`](parsed-result-item.md), the basic unit representing a single parsed result from an encrypted text. |

The following properties are inherited from [`CapturedResultBase`]({{ site.dcv_react_native_api }}core/captured-result-base.html):

| Property | Type | Description |
| -------- | ---- | ----------- |
| [`originalImageHashId`]({{ site.dcv_react_native_api }}core/captured-result-base.html#originalimagehashid) | *String* | The hash id of the original image. You can use this ID to get the original image via the `IntermediateResultManager` interface. |
| [`rotationTransformMatrix`]({{ site.dcv_react_native_api }}core/captured-result-base.html#rotationtransformmatrix) | *Matrix4* | The rotation transformation matrix of the original image relative to the rotated image. |
| [`errorCode`]({{ site.dcv_react_native_api }}core/captured-result-base.html#errorcode) | *int* | The error code associated with the capture result. |
| [`errorMessage`]({{ site.dcv_react_native_api }}core/captured-result-base.html#errormessage) | *String* | The error message associated with the capture result. |

### items

A list of [`ParsedResultItem`](parsed-result-item.md), the basic unit representing a single parsed result from an encrypted text.

```js
items?: Array<ParsedResultItem>
```