IconUserGuidanceConfiguration

All Implemented Interfaces:

android.os.Parcelable
```
public final class IconUserGuidanceConfiguration
 implements Parcelable
                    
```
Configuration of the hint (containing an icon) 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()`	Determines whether the user guidance is visible or not.
`final Unit`	`setVisible(Boolean visible)`	Determines whether the user guidance is visible or not.
`final IconStyle`	`getIcon()`	Configuration of the icon appearance.
`final Unit`	`setIcon(IconStyle icon)`	Configuration of the icon appearance.
`final StyledText`	`getTitle()`	The title of the user guidance.
`final Unit`	`setTitle(StyledText title)`	The title of the user guidance.
`final BackgroundStyle`	`getBackground()`	Configuration of the background appearance for the user guidance hints.
`final Unit`	`setBackground(BackgroundStyle background)`	Configuration of the background appearance for the user guidance hints.
`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()
```
    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
  - getIcon
```
 final IconStyle getIcon()
```
    Configuration of the icon appearance.
  - setIcon
```
 final Unit setIcon(IconStyle icon)
```
    Configuration of the icon appearance.
  - 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()
```
    Configuration of the background appearance for the user guidance hints.
  - setBackground
```
 final Unit setBackground(BackgroundStyle background)
```
    Configuration of the background appearance for the user guidance hints.
  - toJson
```
 final JSONObject toJson()
```
  - default
```
 final static IconUserGuidanceConfiguration default()
```