All Implemented Interfaces:: android.os.Parcelable


public final class DocumentScanningFlow
 implements Parcelable

Configuration of the document scanner screen.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private String`	`version`
`private String`	`screen`
`private Palette`	`palette`
`private DocumentScannerTextLocalization`	`localization`
`private DocumentFlowAppearanceConfiguration`	`appearance`
`private DocumentScannerOutputSettings`	`outputSettings`
`private DocumentScannerScreens`	`screens`
`private String`	`documentUuid`
`private Boolean`	`cleanScanningSession`
`private Boolean`	`keepScreenOn`

Constructor Summary

Constructors
Constructor	Description
`DocumentScanningFlow(Map<String, Object> source)`
`DocumentScanningFlow(JSONObject json)`
`DocumentScanningFlow(String version, String screen, Palette palette, DocumentScannerTextLocalization localization, DocumentFlowAppearanceConfiguration appearance, DocumentScannerOutputSettings outputSettings, DocumentScannerScreens screens, String documentUuid, Boolean cleanScanningSession, Boolean keepScreenOn)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getVersion()`	Version number of the configuration object.
`final Unit`	`setVersion(String version)`	Version number of the configuration object.
`final String`	`getScreen()`	The configuration object should be applied for this screen.
`final Unit`	`setScreen(String screen)`	The configuration object should be applied for this screen.
`final Palette`	`getPalette()`	Define the screen's base color values from which other colors are derived.
`final Unit`	`setPalette(Palette palette)`	Define the screen's base color values from which other colors are derived.
`final DocumentScannerTextLocalization`	`getLocalization()`	Configuration of all the strings for the document scanner screen.
`final Unit`	`setLocalization(DocumentScannerTextLocalization localization)`	Configuration of all the strings for the document scanner screen.
`final DocumentFlowAppearanceConfiguration`	`getAppearance()`	Configuration of the general appearance.
`final Unit`	`setAppearance(DocumentFlowAppearanceConfiguration appearance)`	Configuration of the general appearance.
`final DocumentScannerOutputSettings`	`getOutputSettings()`	Configuration of the output settings.
`final Unit`	`setOutputSettings(DocumentScannerOutputSettings outputSettings)`	Configuration of the output settings.
`final DocumentScannerScreens`	`getScreens()`	Configuration of the document scanner sub-screens.
`final Unit`	`setScreens(DocumentScannerScreens screens)`	Configuration of the document scanner sub-screens.
`final String`	`getDocumentUuid()`	The UUID of the existing document to be edited.
`final Unit`	`setDocumentUuid(String documentUuid)`	The UUID of the existing document to be edited.
`final Boolean`	`getCleanScanningSession()`	Clean the existing pages from the scanning session.
`final Unit`	`setCleanScanningSession(Boolean cleanScanningSession)`	Clean the existing pages from the scanning session.
`final Boolean`	`getKeepScreenOn()`	If enabled, the screen will not turn off while the barcode scanner is active.
`final Unit`	`setKeepScreenOn(Boolean keepScreenOn)`	If enabled, the screen will not turn off while the barcode scanner is active.
`final JSONObject`	`toJson(ToJsonConfiguration config)`
`final DocumentScanningFlow`	`clone()`
`final static DocumentScanningFlow`	`default()`

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

- Constructor Detail
  - DocumentScanningFlow
```
DocumentScanningFlow(Map<String, Object> source)
```
  - DocumentScanningFlow
```
DocumentScanningFlow(JSONObject json)
```
  - DocumentScanningFlow
```
DocumentScanningFlow(String version, String screen, Palette palette, DocumentScannerTextLocalization localization, DocumentFlowAppearanceConfiguration appearance, DocumentScannerOutputSettings outputSettings, DocumentScannerScreens screens, String documentUuid, Boolean cleanScanningSession, Boolean keepScreenOn)
```
- Method Detail
  - getVersion
```
 final String getVersion()
```
    Version number of the configuration object.
    Default is "1.0"
  - setVersion
```
 final Unit setVersion(String version)
```
    Version number of the configuration object.
    Default is "1.0"
  - getScreen
```
 final String getScreen()
```
    The configuration object should be applied for this screen.
    Default is "DocumentScanner"
  - setScreen
```
 final Unit setScreen(String screen)
```
    The configuration object should be applied for this screen.
    Default is "DocumentScanner"
  - getPalette
```
 final Palette getPalette()
```
    Define the screen's base color values from which other colors are derived.
  - setPalette
```
 final Unit setPalette(Palette palette)
```
    Define the screen's base color values from which other colors are derived.
  - getLocalization
```
 final DocumentScannerTextLocalization getLocalization()
```
    Configuration of all the strings for the document scanner screen.
  - setLocalization
```
 final Unit setLocalization(DocumentScannerTextLocalization localization)
```
    Configuration of all the strings for the document scanner screen.
  - getAppearance
```
 final DocumentFlowAppearanceConfiguration getAppearance()
```
    Configuration of the general appearance.
  - setAppearance
```
 final Unit setAppearance(DocumentFlowAppearanceConfiguration appearance)
```
    Configuration of the general appearance.
  - getOutputSettings
```
 final DocumentScannerOutputSettings getOutputSettings()
```
    Configuration of the output settings.
  - setOutputSettings
```
 final Unit setOutputSettings(DocumentScannerOutputSettings outputSettings)
```
    Configuration of the output settings.
  - getScreens
```
 final DocumentScannerScreens getScreens()
```
    Configuration of the document scanner sub-screens.
  - setScreens
```
 final Unit setScreens(DocumentScannerScreens screens)
```
    Configuration of the document scanner sub-screens.
  - getDocumentUuid
```
 final String getDocumentUuid()
```
    The UUID of the existing document to be edited.
  - setDocumentUuid
```
 final Unit setDocumentUuid(String documentUuid)
```
    The UUID of the existing document to be edited.
  - getCleanScanningSession
```
 final Boolean getCleanScanningSession()
```
    Clean the existing pages from the scanning session.
    Default is true
  - setCleanScanningSession
```
 final Unit setCleanScanningSession(Boolean cleanScanningSession)
```
    Clean the existing pages from the scanning session.
    Default is true
  - getKeepScreenOn
```
 final Boolean getKeepScreenOn()
```
    If enabled, the screen will not turn off while the barcode scanner is active. (Android only).
    Default is true
  - setKeepScreenOn
```
 final Unit setKeepScreenOn(Boolean keepScreenOn)
```
    If enabled, the screen will not turn off while the barcode scanner is active. (Android only).
    Default is true
  - toJson
```
 final JSONObject toJson(ToJsonConfiguration config)
```
  - clone
```
 final DocumentScanningFlow clone()
```
  - default
```
 final static DocumentScanningFlow default()
```

Class DocumentScanningFlow

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentScanningFlow

DocumentScanningFlow

DocumentScanningFlow

Method Detail

getVersion

setVersion

getScreen

setScreen

getPalette

setPalette

getLocalization

setLocalization

getAppearance

setAppearance

getOutputSettings

setOutputSettings

getScreens

setScreens

getDocumentUuid

setDocumentUuid

getCleanScanningSession

setCleanScanningSession

getKeepScreenOn

setKeepScreenOn

toJson

clone

default