All Implemented Interfaces:

android.os.Parcelable
```
public final class DocumentScannerUserGuidance
 implements Parcelable
                    
```
Configuration of the hints 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 UserGuidanceVisibility`	`visibility`
`private StyledText`	`title`
`private BackgroundStyle`	`background`
`private UserGuidanceStates`	`statesTitles`

Constructor Summary

Constructors
Constructor	Description
`DocumentScannerUserGuidance(Map<String, Object> source)`
`DocumentScannerUserGuidance(JSONObject json)`
`DocumentScannerUserGuidance(UserGuidanceVisibility visibility, StyledText title, BackgroundStyle background, UserGuidanceStates statesTitles)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final UserGuidanceVisibility`	`getVisibility()`	Determines when the user guidance hints should be visible.
`final Unit`	`setVisibility(UserGuidanceVisibility visibility)`	Determines when the user guidance hints should be visible.
`final StyledText`	`getTitle()`	Configure the text style for the user guidance hints.
`final Unit`	`setTitle(StyledText title)`	Configure the text style for the user guidance hints.
`final BackgroundStyle`	`getBackground()`	Configure the background style for the user guidance hints.
`final Unit`	`setBackground(BackgroundStyle background)`	Configure the background style for the user guidance hints.
`final UserGuidanceStates`	`getStatesTitles()`	Configure the titles of the user guidance hints for different states.
`final Unit`	`setStatesTitles(UserGuidanceStates statesTitles)`	Configure the titles of the user guidance hints for different states.
`final JSONObject`	`toJson()`
`final static DocumentScannerUserGuidance`	`default()`

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

- Constructor Detail
  - DocumentScannerUserGuidance
```
DocumentScannerUserGuidance(Map<String, Object> source)
```
  - DocumentScannerUserGuidance
```
DocumentScannerUserGuidance(JSONObject json)
```
  - DocumentScannerUserGuidance
```
DocumentScannerUserGuidance(UserGuidanceVisibility visibility, StyledText title, BackgroundStyle background, UserGuidanceStates statesTitles)
```
- Method Detail
  - getVisibility
```
 final UserGuidanceVisibility getVisibility()
```
    Determines when the user guidance hints should be visible. Default is ENABLED
  - setVisibility
```
 final Unit setVisibility(UserGuidanceVisibility visibility)
```
    Determines when the user guidance hints should be visible. Default is ENABLED
  - getTitle
```
 final StyledText getTitle()
```
    Configure the text style for the user guidance hints.
  - setTitle
```
 final Unit setTitle(StyledText title)
```
    Configure the text style for the user guidance hints.
  - getBackground
```
 final BackgroundStyle getBackground()
```
    Configure the background style for the user guidance hints.
  - setBackground
```
 final Unit setBackground(BackgroundStyle background)
```
    Configure the background style for the user guidance hints.
  - getStatesTitles
```
 final UserGuidanceStates getStatesTitles()
```
    Configure the titles of the user guidance hints for different states.
  - setStatesTitles
```
 final Unit setStatesTitles(UserGuidanceStates statesTitles)
```
    Configure the titles of the user guidance hints for different states.
  - toJson
```
 final JSONObject toJson()
```
  - default
```
 final static DocumentScannerUserGuidance default()
```

Class DocumentScannerUserGuidance

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentScannerUserGuidance

DocumentScannerUserGuidance

DocumentScannerUserGuidance

Method Detail

getVisibility

setVisibility

getTitle

setTitle

getBackground

setBackground

getStatesTitles

setStatesTitles

toJson

default