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

DocumentDataExtractorGuidanceConfiguration

data class DocumentDataExtractorGuidanceConfiguration(var visibility: Boolean = true, var title: StyledText = StyledText( text = "?documentUserGuidanceNoDocumentFound", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), var background: BackgroundStyle = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("?sbColorSurfaceLow", isArgb = false) ), var statesTitles: DocumentDataExtractorGuidanceStates = DocumentDataExtractorGuidanceStates( )) : Parcelable

Configuration of the hints guiding users through the document scanning process.

Constructors

constructor(source: Map<String, Any?>)
constructor(json: JSONObject)
constructor(visibility: Boolean = true, title: StyledText = StyledText( text = "?documentUserGuidanceNoDocumentFound", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), background: BackgroundStyle = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("?sbColorSurfaceLow", isArgb = false) ), statesTitles: DocumentDataExtractorGuidanceStates = DocumentDataExtractorGuidanceStates( ))

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: DocumentDataExtractorGuidanceStates

Configure the captions 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: Boolean

Determines whether the user guidance hints should be visible (enabled).

Functions

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