Android Scanbot Barcode SDK API reference

7.1.0

Android Scanbot Barcode SDK API reference/io.scanbot.sdk.genericdocument.entity/Field

Field

data class Field(val type: FieldType, val value: OcrResult?, val confidenceWeight: Double = 1.0, val image: ImageRef? = null, val polygonInRoot: List<PointF>, val validationStatus: FieldValidationStatus = FieldValidationStatus.NONE, val parsedData: List<FieldParsedData> = listOf( )) : AutoCloseable, Parcelable

Generic document field.

Constructors

constructor(source: Map<String, Any?>)

constructor(json: JSONObject)

constructor(type: FieldType, value: OcrResult?, confidenceWeight: Double = 1.0, image: ImageRef? = null, polygonInRoot: List<PointF>, validationStatus: FieldValidationStatus = FieldValidationStatus.NONE, parsedData: List<FieldParsedData> = listOf( ))

Properties

confidenceWeight

val confidenceWeight: Double = 1.0

Confidence weight.

val image: ImageRef? = null

Crop of the field.

val parsedData: List<FieldParsedData>

Parsed data.

val polygonInRoot: List<PointF>

Coordinates of the field in the root document coordinate system.

val type: FieldType

The type of the field.

validationStatus

val validationStatus: FieldValidationStatus

Field validation status. Applicable only to fields that support some kind of validation.

val value: OcrResult?

Value of the field. Applicable only to text fields.

Functions

fun clone(): Field

open override fun close()

fun toJson(config: ToJsonConfiguration = ToJsonConfiguration.default()): JSONObject