Android Scanbot SDK API reference/io.scanbot.sdk.ui_v2.documentdataextractor.configuration/DocumentDataExtractorGuidanceStates

DocumentDataExtractorGuidanceStates

data class DocumentDataExtractorGuidanceStates(var noDocumentFound: String = "?documentUserGuidanceNoDocumentFound", var scanningProgress: String = "?documentUserGuidanceScanningProgress", var tooDark: String = "?documentUserGuidanceTooDark", var tooSmall: String = "?documentUserGuidanceTooSmall", var badPerspective: String = "?documentUserGuidanceBadPerspective") : Parcelable

Configure the captions of the user guidance hints for different scanning states.

Constructors

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

constructor(json: JSONObject)

constructor(noDocumentFound: String = "?documentUserGuidanceNoDocumentFound", scanningProgress: String = "?documentUserGuidanceScanningProgress", tooDark: String = "?documentUserGuidanceTooDark", tooSmall: String = "?documentUserGuidanceTooSmall", badPerspective: String = "?documentUserGuidanceBadPerspective")

Types

Companion

object Companion

Properties

badPerspective

var badPerspective: String

The user guidance text displayed when the detected document is not in a good perspective (device tilted).

noDocumentFound

var noDocumentFound: String

The user guidance text displayed when no document is found. Initial state.

scanningProgress

var scanningProgress: String

The user guidance text displayed when a document presence was detected and scanning is in progress.

tooDark

var tooDark: String

The user guidance text displayed when it is too dark to capture an adequate image.

tooSmall

var tooSmall: String

The user guidance text displayed when the detected document is too far away and appears too small.

Functions

clone

fun clone(): DocumentDataExtractorGuidanceStates

toJson

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