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> source)UserGuidanceConfiguration(JSONObject json)UserGuidanceConfiguration(Boolean visible, StyledText title, BackgroundStyle background)
-
Method Summary
Modifier and Type Method Description final BooleangetVisible()Determines whether the user guidance is visible or not. final UnitsetVisible(Boolean visible)Determines whether the user guidance is visible or not. final StyledTextgetTitle()The title of the user guidance. final UnitsetTitle(StyledText title)The title of the user guidance. final BackgroundStylegetBackground()The background style used for the user guidance. final UnitsetBackground(BackgroundStyle background)The background style used for the user guidance. final JSONObjecttoJson(ToJsonConfiguration config)final UserGuidanceConfigurationclone()final static UserGuidanceConfigurationdefault()-
-
Constructor Detail
-
UserGuidanceConfiguration
UserGuidanceConfiguration(JSONObject json)
-
UserGuidanceConfiguration
UserGuidanceConfiguration(Boolean visible, StyledText title, BackgroundStyle background)
-
-
Method Detail
-
getVisible
final Boolean getVisible()
Determines whether the user guidance is visible or not.
Default is true
-
setVisible
final Unit setVisible(Boolean visible)
Determines whether the user guidance is visible or not.
Default is true
-
getTitle
final StyledText getTitle()
The title of the user guidance.
-
setTitle
final Unit setTitle(StyledText title)
The title of the user guidance.
-
getBackground
final BackgroundStyle getBackground()
The background style used for the user guidance.
-
setBackground
final Unit setBackground(BackgroundStyle background)
The background style used for the user guidance.
-
toJson
final JSONObject toJson(ToJsonConfiguration config)
-
clone
final UserGuidanceConfiguration clone()
-
default
final static UserGuidanceConfiguration default()
-
-
-
-