Android Scanbot SDK API reference/io.scanbot.sdk.ui_v2.common/UserGuidanceConfiguration

UserGuidanceConfiguration

data class UserGuidanceConfiguration(var visible: Boolean = true, var title: StyledText = StyledText( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), var background: BackgroundStyle = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("?sbColorSurfaceLow", isArgb = false) )) : Parcelable

Configuration of the hint guiding users through the scanning process.

Constructors

Link copied to clipboard
constructor(source: Map<String, Any?>)
constructor(json: JSONObject)
constructor(visible: Boolean = true, title: StyledText = StyledText( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), background: BackgroundStyle = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("?sbColorSurfaceLow", isArgb = false) ))

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
var background: BackgroundStyle

The background style used for the user guidance.

Link copied to clipboard
var title: StyledText

The title of the user guidance.

Link copied to clipboard
var visible: Boolean

Determines whether the user guidance is visible or not.

Functions

Link copied to clipboard
Link copied to clipboard
fun toJson(config: ToJsonConfiguration = ToJsonConfiguration.default()): JSONObject