All Implemented Interfaces:: android.os.Parcelable


public final class IconUserGuidanceConfiguration
 implements Parcelable

Configuration of the hint guiding users through the scanning process.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private Boolean`	`visible`
`private IconStyle`	`icon`
`private StyledText`	`title`
`private BackgroundStyle`	`background`

Constructor Summary

Constructors
Constructor	Description
`IconUserGuidanceConfiguration(Map<String, Object> source)`
`IconUserGuidanceConfiguration(JSONObject json)`
`IconUserGuidanceConfiguration(Boolean visible, IconStyle icon, StyledText title, BackgroundStyle background)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Boolean`	`getVisible()`	Whether the user guidance is visible.
`final Unit`	`setVisible(Boolean visible)`	Whether the user guidance is visible.
`final IconStyle`	`getIcon()`	Icon of the user guidance.
`final Unit`	`setIcon(IconStyle icon)`	Icon of the user guidance.
`final StyledText`	`getTitle()`	Title of the user guidance.
`final Unit`	`setTitle(StyledText title)`	Title of the user guidance.
`final BackgroundStyle`	`getBackground()`	Background style used for the user guidance.
`final Unit`	`setBackground(BackgroundStyle background)`	Background style used for the user guidance.
`final JSONObject`	`toJson()`
`final static IconUserGuidanceConfiguration`	`default()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IconUserGuidanceConfiguration

IconUserGuidanceConfiguration(Map<String, Object> source)

IconUserGuidanceConfiguration

IconUserGuidanceConfiguration(JSONObject json)

IconUserGuidanceConfiguration

IconUserGuidanceConfiguration(Boolean visible, IconStyle icon, StyledText title, BackgroundStyle background)

Method Detail

getVisible
```
 final Boolean getVisible()
```
Whether the user guidance is visible. Default is true

setVisible
```
 final Unit setVisible(Boolean visible)
```
Whether the user guidance is visible. Default is true

getIcon
```
 final IconStyle getIcon()
```
Icon of the user guidance.

setIcon
```
 final Unit setIcon(IconStyle icon)
```
Icon of the user guidance.

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.

toJson
```
 final JSONObject toJson()
```

default

 final static IconUserGuidanceConfiguration default()

Class IconUserGuidanceConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IconUserGuidanceConfiguration

IconUserGuidanceConfiguration

IconUserGuidanceConfiguration

Method Detail

getVisible

setVisible

getIcon

setIcon

getTitle

setTitle

getBackground

setBackground

toJson

default