Package io.scanbot.sdk.ui_v2.common
Class UserGuidanceConfiguration
-
- All Implemented Interfaces:
-
android.os.Parcelable
public final class UserGuidanceConfiguration implements Parcelable
Configuration of the hint guiding users through the scanning process.
-
-
Field Summary
Fields Modifier and Type Field Description private Booleanvisibleprivate StyledTexttitleprivate BackgroundStylebackground
-
Constructor Summary
Constructors Constructor Description UserGuidanceConfiguration(Map<String, Object> json)UserGuidanceConfiguration()UserGuidanceConfiguration(Boolean visible, StyledText title, BackgroundStyle background)
-
Method Summary
Modifier and Type Method Description final BooleangetVisible()Whether the user guidance is visible. final UnitsetVisible(Boolean visible)Whether the user guidance is visible. final StyledTextgetTitle()Title of the user guidance. final UnitsetTitle(StyledText title)Title of the user guidance. final BackgroundStylegetBackground()Background style used for the user guidance. final UnitsetBackground(BackgroundStyle background)Background style used for the user guidance. -
-
Constructor Detail
-
UserGuidanceConfiguration
UserGuidanceConfiguration()
-
UserGuidanceConfiguration
UserGuidanceConfiguration(Boolean visible, StyledText title, BackgroundStyle background)
-
-
Method Detail
-
getVisible
final Boolean getVisible()
Whether the user guidance is visible.
-
setVisible
final Unit setVisible(Boolean visible)
Whether the user guidance is visible.
-
getTitle
final StyledText getTitle()
Title of the user guidance.
-
setTitle
final Unit setTitle(StyledText title)
Title of the user guidance.
-
getBackground
final BackgroundStyle getBackground()
Background style used for the user guidance.
-
setBackground
final Unit setBackground(BackgroundStyle background)
Background style used for the user guidance.
-
-
-
-