All Implemented Interfaces:: android.os.Parcelable


public final class CameraScreenConfiguration
 implements Parcelable

Configuration of the screen for scanning the pages with the camera.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private AcknowledgementScreenConfiguration`	`acknowledgement`
`private IntroductionScreenConfiguration`	`introduction`
`private ScanAssistanceOverlay`	`scanAssistanceOverlay`
`private CameraPermissionScreen`	`cameraPermission`
`private StyledText`	`topBarTitle`
`private IconButton`	`topBarIntroButton`
`private ButtonConfiguration`	`topBarBackButton`
`private UserGuidanceConfiguration`	`topUserGuidance`
`private DocumentScannerUserGuidance`	`userGuidance`
`private ScanbotColor`	`backgroundColor`
`private DocumentScannerCameraConfiguration`	`cameraConfiguration`
`private DocumentPolygonConfiguration`	`polygon`
`private CameraBottomBar`	`bottomBar`
`private ViewFinderConfiguration`	`viewFinder`
`private CaptureFeedback`	`captureFeedback`
`private Vibration`	`vibration`
`private Timeouts`	`timeouts`
`private ScanbotAlertDialog`	`limitReachedAlertDialog`
`private ScanbotAlertDialog`	`cancelAlertDialog`

Constructor Summary

Constructors
Constructor	Description
`CameraScreenConfiguration(Map<String, Object> source)`
`CameraScreenConfiguration(JSONObject json)`
CameraScreenConfiguration(AcknowledgementScreenConfiguration acknowledgement, IntroductionScreenConfiguration introduction, ScanAssistanceOverlay scanAssistanceOverlay, CameraPermissionScreen cameraPermission, StyledText topBarTitle, IconButton topBarIntroButton, ButtonConfiguration topBarBackButton, UserGuidanceConfiguration topUserGuidance, DocumentScannerUserGuidance userGuidance, ScanbotColor backgroundColor, DocumentScannerCameraConfiguration cameraConfiguration, DocumentPolygonConfiguration polygon, CameraBottomBar bottomBar, ViewFinderConfiguration viewFinder, CaptureFeedback captureFeedback, Vibration vibration, Timeouts timeouts, ScanbotAlertDialog limitReachedAlertDialog, ScanbotAlertDialog cancelAlertDialog)

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final AcknowledgementScreenConfiguration`	`getAcknowledgement()`	Configuration of the acknowledgement screen.
`final Unit`	`setAcknowledgement(AcknowledgementScreenConfiguration acknowledgement)`	Configuration of the acknowledgement screen.
`final IntroductionScreenConfiguration`	`getIntroduction()`	Configuration of the introduction screen.
`final Unit`	`setIntroduction(IntroductionScreenConfiguration introduction)`	Configuration of the introduction screen.
`final ScanAssistanceOverlay`	`getScanAssistanceOverlay()`	Configuration of the scan assistance overlay.
`final Unit`	`setScanAssistanceOverlay(ScanAssistanceOverlay scanAssistanceOverlay)`	Configuration of the scan assistance overlay.
`final CameraPermissionScreen`	`getCameraPermission()`	Configuration of the camera permission screen.
`final Unit`	`setCameraPermission(CameraPermissionScreen cameraPermission)`	Configuration of the camera permission screen.
`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 IconButton`	`getTopBarIntroButton()`	Configuration of the 'introduction' button, located in the top bar.
`final Unit`	`setTopBarIntroButton(IconButton topBarIntroButton)`	Configuration of the 'introduction' button, located in the top bar.
`final ButtonConfiguration`	`getTopBarBackButton()`	Configuration of the 'cancel' button, located in the top bar.
`final Unit`	`setTopBarBackButton(ButtonConfiguration topBarBackButton)`	Configuration of the 'cancel' button, located in the top bar.
`final UserGuidanceConfiguration`	`getTopUserGuidance()`	Configuration of the static user guidance, located just below the top bar.
`final Unit`	`setTopUserGuidance(UserGuidanceConfiguration topUserGuidance)`	Configuration of the static user guidance, located just below the top bar.
`final DocumentScannerUserGuidance`	`getUserGuidance()`	Configuration of the hints guiding users through the scanning process.
`final Unit`	`setUserGuidance(DocumentScannerUserGuidance userGuidance)`	Configuration of the hints guiding users through the scanning process.
`final ScanbotColor`	`getBackgroundColor()`	The background color of the camera screen.
`final Unit`	`setBackgroundColor(ScanbotColor backgroundColor)`	The background color of the camera screen.
`final DocumentScannerCameraConfiguration`	`getCameraConfiguration()`	Configuration of the camera behavior.
`final Unit`	`setCameraConfiguration(DocumentScannerCameraConfiguration cameraConfiguration)`	Configuration of the camera behavior.
`final DocumentPolygonConfiguration`	`getPolygon()`	Configuration of the document contour detection polygon.
`final Unit`	`setPolygon(DocumentPolygonConfiguration polygon)`	Configuration of the document contour detection polygon.
`final CameraBottomBar`	`getBottomBar()`	Configuration of the bottom bar for the camera screen.
`final Unit`	`setBottomBar(CameraBottomBar bottomBar)`	Configuration of the bottom bar for the camera screen.
`final ViewFinderConfiguration`	`getViewFinder()`	Configuration of the viewfinder.
`final Unit`	`setViewFinder(ViewFinderConfiguration viewFinder)`	Configuration of the viewfinder.
`final CaptureFeedback`	`getCaptureFeedback()`	Configuration of the feedback shown after snapping a page.
`final Unit`	`setCaptureFeedback(CaptureFeedback captureFeedback)`	Configuration of the feedback shown after snapping a page.
`final Vibration`	`getVibration()`	Configuration of the scan confirmation vibration.
`final Unit`	`setVibration(Vibration vibration)`	Configuration of the scan confirmation vibration.
`final Timeouts`	`getTimeouts()`	Configuration of timeouts.
`final Unit`	`setTimeouts(Timeouts timeouts)`	Configuration of timeouts.
`final ScanbotAlertDialog`	`getLimitReachedAlertDialog()`	Configuration of the alert dialog displayed when the scan limit is reached.
`final Unit`	`setLimitReachedAlertDialog(ScanbotAlertDialog limitReachedAlertDialog)`	Configuration of the alert dialog displayed when the scan limit is reached.
`final ScanbotAlertDialog`	`getCancelAlertDialog()`	Configuration of the alert dialog displayed when the 'cancel' button is pressed.
`final Unit`	`setCancelAlertDialog(ScanbotAlertDialog cancelAlertDialog)`	Configuration of the alert dialog displayed when the 'cancel' button is pressed.
`final JSONObject`	`toJson()`
`final static CameraScreenConfiguration`	`default()`

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

Constructor Detail

CameraScreenConfiguration

CameraScreenConfiguration(Map<String, Object> source)

CameraScreenConfiguration

CameraScreenConfiguration(JSONObject json)

CameraScreenConfiguration

CameraScreenConfiguration(AcknowledgementScreenConfiguration acknowledgement, IntroductionScreenConfiguration introduction, ScanAssistanceOverlay scanAssistanceOverlay, CameraPermissionScreen cameraPermission, StyledText topBarTitle, IconButton topBarIntroButton, ButtonConfiguration topBarBackButton, UserGuidanceConfiguration topUserGuidance, DocumentScannerUserGuidance userGuidance, ScanbotColor backgroundColor, DocumentScannerCameraConfiguration cameraConfiguration, DocumentPolygonConfiguration polygon, CameraBottomBar bottomBar, ViewFinderConfiguration viewFinder, CaptureFeedback captureFeedback, Vibration vibration, Timeouts timeouts, ScanbotAlertDialog limitReachedAlertDialog, ScanbotAlertDialog cancelAlertDialog)

Method Detail
- getAcknowledgement
```
 final AcknowledgementScreenConfiguration getAcknowledgement()
```
  Configuration of the acknowledgement screen.
- setAcknowledgement
```
 final Unit setAcknowledgement(AcknowledgementScreenConfiguration acknowledgement)
```
  Configuration of the acknowledgement screen.
- getIntroduction
```
 final IntroductionScreenConfiguration getIntroduction()
```
  Configuration of the introduction screen.
- setIntroduction
```
 final Unit setIntroduction(IntroductionScreenConfiguration introduction)
```
  Configuration of the introduction screen.
- getScanAssistanceOverlay
```
 final ScanAssistanceOverlay getScanAssistanceOverlay()
```
  Configuration of the scan assistance overlay.
- setScanAssistanceOverlay
```
 final Unit setScanAssistanceOverlay(ScanAssistanceOverlay scanAssistanceOverlay)
```
  Configuration of the scan assistance overlay.
- getCameraPermission
```
 final CameraPermissionScreen getCameraPermission()
```
  Configuration of the camera permission screen.
- setCameraPermission
```
 final Unit setCameraPermission(CameraPermissionScreen cameraPermission)
```
  Configuration of the camera permission screen.
- 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.
- getTopBarIntroButton
```
 final IconButton getTopBarIntroButton()
```
  Configuration of the 'introduction' button, located in the top bar.
- setTopBarIntroButton
```
 final Unit setTopBarIntroButton(IconButton topBarIntroButton)
```
  Configuration of the 'introduction' button, located in the top bar.
- getTopBarBackButton
```
 final ButtonConfiguration getTopBarBackButton()
```
  Configuration of the 'cancel' button, located in the top bar.
- setTopBarBackButton
```
 final Unit setTopBarBackButton(ButtonConfiguration topBarBackButton)
```
  Configuration of the 'cancel' button, located in the top bar.
- getTopUserGuidance
```
 final UserGuidanceConfiguration getTopUserGuidance()
```
  Configuration of the static user guidance, located just below the top bar.
- setTopUserGuidance
```
 final Unit setTopUserGuidance(UserGuidanceConfiguration topUserGuidance)
```
  Configuration of the static user guidance, located just below the top bar.
- getUserGuidance
```
 final DocumentScannerUserGuidance getUserGuidance()
```
  Configuration of the hints guiding users through the scanning process.
- setUserGuidance
```
 final Unit setUserGuidance(DocumentScannerUserGuidance userGuidance)
```
  Configuration of the hints guiding users through the scanning process.
- getBackgroundColor
```
 final ScanbotColor getBackgroundColor()
```
  The background color of the camera screen. Default is "#000000FF"
- setBackgroundColor
```
 final Unit setBackgroundColor(ScanbotColor backgroundColor)
```
  The background color of the camera screen. Default is "#000000FF"
- getCameraConfiguration
```
 final DocumentScannerCameraConfiguration getCameraConfiguration()
```
  Configuration of the camera behavior.
- setCameraConfiguration
```
 final Unit setCameraConfiguration(DocumentScannerCameraConfiguration cameraConfiguration)
```
  Configuration of the camera behavior.
- getPolygon
```
 final DocumentPolygonConfiguration getPolygon()
```
  Configuration of the document contour detection polygon.
- setPolygon
```
 final Unit setPolygon(DocumentPolygonConfiguration polygon)
```
  Configuration of the document contour detection polygon.
- getBottomBar
```
 final CameraBottomBar getBottomBar()
```
  Configuration of the bottom bar for the camera screen.
- setBottomBar
```
 final Unit setBottomBar(CameraBottomBar bottomBar)
```
  Configuration of the bottom bar for the camera screen.
- getViewFinder
```
 final ViewFinderConfiguration getViewFinder()
```
  Configuration of the viewfinder.
- setViewFinder
```
 final Unit setViewFinder(ViewFinderConfiguration viewFinder)
```
  Configuration of the viewfinder.
- getCaptureFeedback
```
 final CaptureFeedback getCaptureFeedback()
```
  Configuration of the feedback shown after snapping a page.
- setCaptureFeedback
```
 final Unit setCaptureFeedback(CaptureFeedback captureFeedback)
```
  Configuration of the feedback shown after snapping a page.
- getVibration
```
 final Vibration getVibration()
```
  Configuration of the scan confirmation vibration.
- setVibration
```
 final Unit setVibration(Vibration vibration)
```
  Configuration of the scan confirmation vibration.
- getTimeouts
```
 final Timeouts getTimeouts()
```
  Configuration of timeouts.
- setTimeouts
```
 final Unit setTimeouts(Timeouts timeouts)
```
  Configuration of timeouts.
- getLimitReachedAlertDialog
```
 final ScanbotAlertDialog getLimitReachedAlertDialog()
```
  Configuration of the alert dialog displayed when the scan limit is reached.
- setLimitReachedAlertDialog
```
 final Unit setLimitReachedAlertDialog(ScanbotAlertDialog limitReachedAlertDialog)
```
  Configuration of the alert dialog displayed when the scan limit is reached.
- getCancelAlertDialog
```
 final ScanbotAlertDialog getCancelAlertDialog()
```
  Configuration of the alert dialog displayed when the 'cancel' button is pressed.
- setCancelAlertDialog
```
 final Unit setCancelAlertDialog(ScanbotAlertDialog cancelAlertDialog)
```
  Configuration of the alert dialog displayed when the 'cancel' button is pressed.
- toJson
```
 final JSONObject toJson()
```
- default
```
 final static CameraScreenConfiguration default()
```

Class CameraScreenConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CameraScreenConfiguration

CameraScreenConfiguration

CameraScreenConfiguration

Method Detail

getAcknowledgement

setAcknowledgement

getIntroduction

setIntroduction

getScanAssistanceOverlay

setScanAssistanceOverlay

getCameraPermission

setCameraPermission

getTopBarTitle

setTopBarTitle

getTopBarIntroButton

setTopBarIntroButton

getTopBarBackButton

setTopBarBackButton

getTopUserGuidance

setTopUserGuidance

getUserGuidance

setUserGuidance

getBackgroundColor

setBackgroundColor

getCameraConfiguration

setCameraConfiguration

getPolygon

setPolygon

getBottomBar

setBottomBar

getViewFinder

setViewFinder

getCaptureFeedback

setCaptureFeedback

getVibration

setVibration

getTimeouts

setTimeouts

getLimitReachedAlertDialog

setLimitReachedAlertDialog

getCancelAlertDialog

setCancelAlertDialog

toJson

default