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

FieldType

data class FieldType(val name: String, val fullName: String, val normalizedName: String, val commonType: CommonFieldType?, val listIndex: Int? = null) : Parcelable

Generic Document Type.

Constructors

FieldType

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

constructor(json: JSONObject)

constructor(name: String, fullName: String, normalizedName: String, commonType: CommonFieldType?, listIndex: Int? = null)

Properties

commonType

val commonType: CommonFieldType?

Commonly occurring fields that have the same semantic meaning in different document types will often have a set common type.

fullName

val fullName: String

Unique global field type name prefixed with the document types of all containing documents.

listIndex

val listIndex: Int? = null

A document can contain multiple fields of the same name, the property serves for storing natural order of such fields, null if multiple entries aren't allowed for this field.

name

val name: String

Local field type name scoped to the containing document type.

normalizedName

val normalizedName: String

Normalized global field type name. Fields in document types derived from the same base document type in the schema will have the same normalized name.

Functions

clone

fun clone(): FieldType

toJson

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