All Implemented Interfaces:: android.os.Parcelable


public final class ScanAssistanceOverlay
 implements Parcelable

Configuration of the scan assistance overlay.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private Boolean`	`visible`
`private ScanbotColor`	`backgroundColor`
`private ScanbotColor`	`foregroundColor`

Constructor Summary

Constructors
Constructor	Description
`ScanAssistanceOverlay(Map<String, Object> source)`
`ScanAssistanceOverlay(JSONObject json)`
`ScanAssistanceOverlay(Boolean visible, ScanbotColor backgroundColor, ScanbotColor foregroundColor)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Boolean`	`getVisible()`	Determines whether the scan assistance overlay is visible or not.
`final Unit`	`setVisible(Boolean visible)`	Determines whether the scan assistance overlay is visible or not.
`final ScanbotColor`	`getBackgroundColor()`	The background color of the scan assistance overlay.
`final Unit`	`setBackgroundColor(ScanbotColor backgroundColor)`	The background color of the scan assistance overlay.
`final ScanbotColor`	`getForegroundColor()`	The foreground color of the scan assistance overlay image.
`final Unit`	`setForegroundColor(ScanbotColor foregroundColor)`	The foreground color of the scan assistance overlay image.
`final JSONObject`	`toJson()`
`final static ScanAssistanceOverlay`	`default()`

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

- Constructor Detail
  - ScanAssistanceOverlay
```
ScanAssistanceOverlay(Map<String, Object> source)
```
  - ScanAssistanceOverlay
```
ScanAssistanceOverlay(JSONObject json)
```
  - ScanAssistanceOverlay
```
ScanAssistanceOverlay(Boolean visible, ScanbotColor backgroundColor, ScanbotColor foregroundColor)
```
- Method Detail
  - getVisible
```
 final Boolean getVisible()
```
    Determines whether the scan assistance overlay is visible or not. If the viewfinder is enabled, this flag is ignored and the scan assistance overlay is not displayed. Default is true
  - setVisible
```
 final Unit setVisible(Boolean visible)
```
    Determines whether the scan assistance overlay is visible or not. If the viewfinder is enabled, this flag is ignored and the scan assistance overlay is not displayed. Default is true
  - getBackgroundColor
```
 final ScanbotColor getBackgroundColor()
```
    The background color of the scan assistance overlay. Default is "?sbColorModalOverlay"
  - setBackgroundColor
```
 final Unit setBackgroundColor(ScanbotColor backgroundColor)
```
    The background color of the scan assistance overlay. Default is "?sbColorModalOverlay"
  - getForegroundColor
```
 final ScanbotColor getForegroundColor()
```
    The foreground color of the scan assistance overlay image. Default is "?sbColorSurface"
  - setForegroundColor
```
 final Unit setForegroundColor(ScanbotColor foregroundColor)
```
    The foreground color of the scan assistance overlay image. Default is "?sbColorSurface"
  - toJson
```
 final JSONObject toJson()
```
  - default
```
 final static ScanAssistanceOverlay default()
```

Class ScanAssistanceOverlay

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ScanAssistanceOverlay

ScanAssistanceOverlay

ScanAssistanceOverlay

Method Detail

getVisible

setVisible

getBackgroundColor

setBackgroundColor

getForegroundColor

setForegroundColor

toJson

default