Android Scanbot SDK API reference/io.scanbot.sdk.ui_v2.check.configuration/CheckScannerGuidanceStates

CheckScannerGuidanceStates

data class CheckScannerGuidanceStates(var noCheckFound: String = "?checkUserGuidanceNoCheckFound", var scanningProgress: String = "?checkUserGuidanceScanningProgress", var tooDark: String = "?checkUserGuidanceTooDark", var tooSmall: String = "?checkUserGuidanceTooSmall", var badPerspective: String = "?checkUserGuidanceBadPerspective") : Parcelable

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

Constructors

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

constructor(json: JSONObject)

constructor(noCheckFound: String = "?checkUserGuidanceNoCheckFound", scanningProgress: String = "?checkUserGuidanceScanningProgress", tooDark: String = "?checkUserGuidanceTooDark", tooSmall: String = "?checkUserGuidanceTooSmall", badPerspective: String = "?checkUserGuidanceBadPerspective")

Types

Companion

object Companion

Properties

badPerspective

var badPerspective: String

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

noCheckFound

var noCheckFound: String

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

scanningProgress

var scanningProgress: String

The user guidance text displayed when a check 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 check is too far away and appears too small.

Functions

clone

fun clone(): CheckScannerGuidanceStates

toJson

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