All Implemented Interfaces:: android.os.Parcelable


public final class AcknowledgementScreenConfiguration
 implements Parcelable

Configuration of the acknowledgement screen.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private StyledText`	`topBarTitle`
`private DocumentQuality`	`minimumQuality`
`private AcknowledgementMode`	`acknowledgementMode`
`private IconUserGuidanceConfiguration`	`badImageHint`
`private ScanbotColor`	`backgroundColor`
`private AcknowledgementBottomBar`	`bottomBar`

Constructor Summary

Constructors
Constructor	Description
`AcknowledgementScreenConfiguration(Map<String, Object> source)`
`AcknowledgementScreenConfiguration(JSONObject json)`
`AcknowledgementScreenConfiguration(StyledText topBarTitle, DocumentQuality minimumQuality, AcknowledgementMode acknowledgementMode, IconUserGuidanceConfiguration badImageHint, ScanbotColor backgroundColor, AcknowledgementBottomBar bottomBar)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final StyledText`	`getTopBarTitle()`	Configuration of the title, located in the top bar.
`final Unit`	`setTopBarTitle(StyledText topBarTitle)`	Configuration of the title, located in the top bar.
`final DocumentQuality`	`getMinimumQuality()`	The minimum quality of a scanned page to be deemed acceptable.
`final Unit`	`setMinimumQuality(DocumentQuality minimumQuality)`	The minimum quality of a scanned page to be deemed acceptable.
`final AcknowledgementMode`	`getAcknowledgementMode()`	Determines, after each page is snapped, whether the acknowledgment screen should be displayed or not.
`final Unit`	`setAcknowledgementMode(AcknowledgementMode acknowledgementMode)`	Determines, after each page is snapped, whether the acknowledgment screen should be displayed or not.
`final IconUserGuidanceConfiguration`	`getBadImageHint()`	Configuration of the hint that explains that the quality of the scanned page is unacceptable.
`final Unit`	`setBadImageHint(IconUserGuidanceConfiguration badImageHint)`	Configuration of the hint that explains that the quality of the scanned page is unacceptable.
`final ScanbotColor`	`getBackgroundColor()`	The background color of the acknowledgement screen.
`final Unit`	`setBackgroundColor(ScanbotColor backgroundColor)`	The background color of the acknowledgement screen.
`final AcknowledgementBottomBar`	`getBottomBar()`	Configuration of the bottom bar for the acknowledgement screen.
`final Unit`	`setBottomBar(AcknowledgementBottomBar bottomBar)`	Configuration of the bottom bar for the acknowledgement screen.
`final JSONObject`	`toJson(ToJsonConfiguration config)`
`final AcknowledgementScreenConfiguration`	`clone()`
`final static AcknowledgementScreenConfiguration`	`default()`

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

- Constructor Detail
  - AcknowledgementScreenConfiguration
```
AcknowledgementScreenConfiguration(Map<String, Object> source)
```
  - AcknowledgementScreenConfiguration
```
AcknowledgementScreenConfiguration(JSONObject json)
```
  - AcknowledgementScreenConfiguration
```
AcknowledgementScreenConfiguration(StyledText topBarTitle, DocumentQuality minimumQuality, AcknowledgementMode acknowledgementMode, IconUserGuidanceConfiguration badImageHint, ScanbotColor backgroundColor, AcknowledgementBottomBar bottomBar)
```
- Method Detail
  - getTopBarTitle
```
 final StyledText getTopBarTitle()
```
    Configuration of the title, located in the top bar.
  - setTopBarTitle
```
 final Unit setTopBarTitle(StyledText topBarTitle)
```
    Configuration of the title, located in the top bar.
  - getMinimumQuality
```
 final DocumentQuality getMinimumQuality()
```
    The minimum quality of a scanned page to be deemed acceptable. Used in conjunction with the acknowledgement mode.
    Default is POOR
  - setMinimumQuality
```
 final Unit setMinimumQuality(DocumentQuality minimumQuality)
```
    The minimum quality of a scanned page to be deemed acceptable. Used in conjunction with the acknowledgement mode.
    Default is POOR
  - getAcknowledgementMode
```
 final AcknowledgementMode getAcknowledgementMode()
```
    Determines, after each page is snapped, whether the acknowledgment screen should be displayed or not.
    Default is ALWAYS
  - setAcknowledgementMode
```
 final Unit setAcknowledgementMode(AcknowledgementMode acknowledgementMode)
```
    Determines, after each page is snapped, whether the acknowledgment screen should be displayed or not.
    Default is ALWAYS
  - getBadImageHint
```
 final IconUserGuidanceConfiguration getBadImageHint()
```
    Configuration of the hint that explains that the quality of the scanned page is unacceptable.
  - setBadImageHint
```
 final Unit setBadImageHint(IconUserGuidanceConfiguration badImageHint)
```
    Configuration of the hint that explains that the quality of the scanned page is unacceptable.
  - getBackgroundColor
```
 final ScanbotColor getBackgroundColor()
```
    The background color of the acknowledgement screen.
    Default is "?sbColorOutline"
  - setBackgroundColor
```
 final Unit setBackgroundColor(ScanbotColor backgroundColor)
```
    The background color of the acknowledgement screen.
    Default is "?sbColorOutline"
  - getBottomBar
```
 final AcknowledgementBottomBar getBottomBar()
```
    Configuration of the bottom bar for the acknowledgement screen.
  - setBottomBar
```
 final Unit setBottomBar(AcknowledgementBottomBar bottomBar)
```
    Configuration of the bottom bar for the acknowledgement screen.
  - toJson
```
 final JSONObject toJson(ToJsonConfiguration config)
```
  - clone
```
 final AcknowledgementScreenConfiguration clone()
```
  - default
```
 final static AcknowledgementScreenConfiguration default()
```

Class AcknowledgementScreenConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AcknowledgementScreenConfiguration

AcknowledgementScreenConfiguration

AcknowledgementScreenConfiguration

Method Detail

getTopBarTitle

setTopBarTitle

getMinimumQuality

setMinimumQuality

getAcknowledgementMode

setAcknowledgementMode

getBadImageHint

setBadImageHint

getBackgroundColor

setBackgroundColor

getBottomBar

setBottomBar

toJson

clone

default