Android Scanbot SDK API reference/io.scanbot.sdk.ui_v2.document.configuration/DocumentScannerUserGuidance

DocumentScannerUserGuidance

data class DocumentScannerUserGuidance(var visibility: UserGuidanceVisibility = UserGuidanceVisibility.ENABLED, var title: StyledText = StyledText( text = "?cameraUserGuidanceStart", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), var background: BackgroundStyle = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false) ), var statesTitles: UserGuidanceStates = UserGuidanceStates( )) : Parcelable

Configuration of the hints guiding users through the scanning process.

Constructors

Link copied to clipboard
constructor(source: Map<String, Any?>)
constructor(json: JSONObject)
constructor(visibility: UserGuidanceVisibility = UserGuidanceVisibility.ENABLED, title: StyledText = StyledText( text = "?cameraUserGuidanceStart", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), background: BackgroundStyle = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false) ), statesTitles: UserGuidanceStates = UserGuidanceStates( ))

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
var background: BackgroundStyle

Configure the background style for the user guidance hints.

Link copied to clipboard
var statesTitles: UserGuidanceStates

Configure the titles of the user guidance hints for different states.

Link copied to clipboard
var title: StyledText

Configure the text style for the user guidance hints.

Link copied to clipboard
var visibility: UserGuidanceVisibility

Determines when the user guidance hints should be visible.

Functions

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