IntroductionScreenConfiguration

data class IntroductionScreenConfiguration(var backgroundColor: ScanbotColor = ScanbotColor("?sbColorSurface", isArgb = false), var dividerColor: ScanbotColor = ScanbotColor("?sbColorOutline", isArgb = false), var handlerColor: ScanbotColor = ScanbotColor("?sbColorOutline", isArgb = false), var showAutomatically: Boolean = false, var topBarDoneButton: ButtonConfiguration = ButtonConfiguration( visible = true, text = "?cameraIntroDoneButton", accessibilityDescription = "?accessibilityDescriptionCameraIntroDoneButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorPrimary", isArgb = false), useShadow = false ) ), var title: StyledText = StyledText( text = "?cameraIntroTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), var subtitle: StyledText = StyledText( text = "?cameraIntroSubtitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), var items: List<IntroListEntry> = listOf( IntroListEntry( image = DocumentIntroImage( ), text = StyledText( text = "?cameraIntroItem1", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ) ), IntroListEntry( image = NoIntroImage( ), text = StyledText( text = "?cameraIntroItem2", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ) ), IntroListEntry( image = NoIntroImage( ), text = StyledText( text = "?cameraIntroItem3", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ) ), IntroListEntry( image = NoIntroImage( ), text = StyledText( text = "?cameraIntroItem4", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ) ) )) : Parcelable

Configuration of the introduction screen for the document scanner.

Constructors

Link copied to clipboard
constructor(source: Map<String, Any?>)
constructor(json: JSONObject)
constructor(backgroundColor: ScanbotColor = ScanbotColor("?sbColorSurface", isArgb = false), dividerColor: ScanbotColor = ScanbotColor("?sbColorOutline", isArgb = false), handlerColor: ScanbotColor = ScanbotColor("?sbColorOutline", isArgb = false), showAutomatically: Boolean = false, topBarDoneButton: ButtonConfiguration = ButtonConfiguration( visible = true, text = "?cameraIntroDoneButton", accessibilityDescription = "?accessibilityDescriptionCameraIntroDoneButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorPrimary", isArgb = false), useShadow = false ) ), title: StyledText = StyledText( text = "?cameraIntroTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle: StyledText = StyledText( text = "?cameraIntroSubtitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), items: List<IntroListEntry> = listOf( IntroListEntry( image = DocumentIntroImage( ), text = StyledText( text = "?cameraIntroItem1", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ) ), IntroListEntry( image = NoIntroImage( ), text = StyledText( text = "?cameraIntroItem2", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ) ), IntroListEntry( image = NoIntroImage( ), text = StyledText( text = "?cameraIntroItem3", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ) ), IntroListEntry( image = NoIntroImage( ), text = StyledText( text = "?cameraIntroItem4", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ) ) ))

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The background color of the introduction screen.

Link copied to clipboard

The divider color of the introduction screen.

Link copied to clipboard

The handle color of the introduction screen.

Link copied to clipboard

Configure the scanning steps of the introduction screen.

Link copied to clipboard

Determines whether the introduction screen should automatically be shown or not when the scanning session starts.

Link copied to clipboard

The subtitle of the introduction screen.

Link copied to clipboard

The title of the introduction screen, located in the top bar.

Link copied to clipboard

Configuration of the 'done' button, located in the top bar.

Functions

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