ScanCompletionOverlay

All Implemented Interfaces:

android.os.Parcelable
```
public final class ScanCompletionOverlay
 implements Parcelable
                    
```
Configuration of the overlay to be shown after the successful scan.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private StyledText`	`message`
`private ScanbotColor`	`iconColor`
`private ScanbotColor`	`overlayBackgroundColor`
`private Integer`	`timeout`

Constructor Summary

Constructors
Constructor	Description
`ScanCompletionOverlay(Map<String, Object> source)`
`ScanCompletionOverlay(JSONObject json)`
`ScanCompletionOverlay(StyledText message, ScanbotColor iconColor, ScanbotColor overlayBackgroundColor, Integer timeout)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final StyledText`	`getMessage()`	A caption below the icon.
`final Unit`	`setMessage(StyledText message)`	A caption below the icon.
`final ScanbotColor`	`getIconColor()`	Color of the icon.
`final Unit`	`setIconColor(ScanbotColor iconColor)`	Color of the icon.
`final ScanbotColor`	`getOverlayBackgroundColor()`	Background color of the overlay.
`final Unit`	`setOverlayBackgroundColor(ScanbotColor overlayBackgroundColor)`	Background color of the overlay.
`final Integer`	`getTimeout()`	Timeout in milliseconds after which the overlay is automatically dismissed.
`final Unit`	`setTimeout(Integer timeout)`	Timeout in milliseconds after which the overlay is automatically dismissed.
`final JSONObject`	`toJson(ToJsonConfiguration config)`
`final ScanCompletionOverlay`	`clone()`
`final static ScanCompletionOverlay`	`default()`

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

Constructor Detail

ScanCompletionOverlay

ScanCompletionOverlay(Map<String, Object> source)

ScanCompletionOverlay
```
ScanCompletionOverlay(JSONObject json)
```

ScanCompletionOverlay

ScanCompletionOverlay(StyledText message, ScanbotColor iconColor, ScanbotColor overlayBackgroundColor, Integer timeout)

Method Detail
- getMessage
```
 final StyledText getMessage()
```
  A caption below the icon.
- setMessage
```
 final Unit setMessage(StyledText message)
```
  A caption below the icon.
- getIconColor
```
 final ScanbotColor getIconColor()
```
  Color of the icon.
  Default is "?sbColorOnPrimary"
- setIconColor
```
 final Unit setIconColor(ScanbotColor iconColor)
```
  Color of the icon.
  Default is "?sbColorOnPrimary"
- getOverlayBackgroundColor
```
 final ScanbotColor getOverlayBackgroundColor()
```
  Background color of the overlay.
  Default is "?sbColorSurfaceHigh"
- setOverlayBackgroundColor
```
 final Unit setOverlayBackgroundColor(ScanbotColor overlayBackgroundColor)
```
  Background color of the overlay.
  Default is "?sbColorSurfaceHigh"
- getTimeout
```
 final Integer getTimeout()
```
  Timeout in milliseconds after which the overlay is automatically dismissed.
  Default is 1000
- setTimeout
```
 final Unit setTimeout(Integer timeout)
```
  Timeout in milliseconds after which the overlay is automatically dismissed.
  Default is 1000
- toJson
```
 final JSONObject toJson(ToJsonConfiguration config)
```
- clone
```
 final ScanCompletionOverlay clone()
```
- default
```
 final static ScanCompletionOverlay default()
```