All Implemented Interfaces:: android.os.Parcelable


public final class CreditCardScannerScreenConfiguration
 implements Parcelable

Configuration of the screen for detecting credit card data.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`version`
`private final String`	`screen`
`private CreditCardScannerScreenTextLocalization`	`localization`
`private Palette`	`palette`
`private ScanbotColor`	`backgroundColor`
`private CameraConfiguration`	`cameraConfiguration`
`private CameraPermissionScreen`	`cameraPermission`
`private UserGuidanceConfiguration`	`topUserGuidance`
`private CreditCardScanGuidanceConfiguration`	`scanStatusUserGuidance`
`private TopBarConfiguration`	`topBar`
`private IconButton`	`topBarOpenIntroScreenButton`
`private CreditCardScannerIntroScreenConfiguration`	`introScreen`
`private ActionBarConfiguration`	`actionBar`
`private PermanentViewFinderConfiguration`	`viewFinder`
`private CreditCardScannerConfiguration`	`scannerConfiguration`
`private Boolean`	`exampleOverlayVisible`
`private CreditCardScanningProgressConfiguration`	`scanningProgress`
`private Integer`	`scanIncompleteDataTimeout`
`private ScanCompletionOverlay`	`successOverlay`
`private ScanCompletionOverlay`	`incompleteDataOverlay`
`private Sound`	`sound`
`private Vibration`	`vibration`
`private Boolean`	`keepScreenOn`

Constructor Summary

Constructors
Constructor	Description
`CreditCardScannerScreenConfiguration(Map<String, Object> source)`
`CreditCardScannerScreenConfiguration(JSONObject json)`
CreditCardScannerScreenConfiguration(String version, String screen, CreditCardScannerScreenTextLocalization localization, Palette palette, ScanbotColor backgroundColor, CameraConfiguration cameraConfiguration, CameraPermissionScreen cameraPermission, UserGuidanceConfiguration topUserGuidance, CreditCardScanGuidanceConfiguration scanStatusUserGuidance, TopBarConfiguration topBar, IconButton topBarOpenIntroScreenButton, CreditCardScannerIntroScreenConfiguration introScreen, ActionBarConfiguration actionBar, PermanentViewFinderConfiguration viewFinder, CreditCardScannerConfiguration scannerConfiguration, Boolean exampleOverlayVisible, CreditCardScanningProgressConfiguration scanningProgress, Integer scanIncompleteDataTimeout, ScanCompletionOverlay successOverlay, ScanCompletionOverlay incompleteDataOverlay, Sound sound, Vibration vibration, 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 String`	`getScreen()`	The configuration object should be applied for this screen.
`final CreditCardScannerScreenTextLocalization`	`getLocalization()`	Configuration of the all strings for credit card scanner screen.
`final Unit`	`setLocalization(CreditCardScannerScreenTextLocalization localization)`	Configuration of the all strings for credit card scanner 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 ScanbotColor`	`getBackgroundColor()`	The background color of the credit card scanner screen.
`final Unit`	`setBackgroundColor(ScanbotColor backgroundColor)`	The background color of the credit card scanner screen.
`final CameraConfiguration`	`getCameraConfiguration()`	Configuration of the camera behavior.
`final Unit`	`setCameraConfiguration(CameraConfiguration cameraConfiguration)`	Configuration of the camera behavior.
`final CameraPermissionScreen`	`getCameraPermission()`	Configuration of the dialog for requesting camera permissions.
`final Unit`	`setCameraPermission(CameraPermissionScreen cameraPermission)`	Configuration of the dialog for requesting camera permissions.
`final UserGuidanceConfiguration`	`getTopUserGuidance()`	Configuration of the top user guidance.
`final Unit`	`setTopUserGuidance(UserGuidanceConfiguration topUserGuidance)`	Configuration of the top user guidance.
`final CreditCardScanGuidanceConfiguration`	`getScanStatusUserGuidance()`	Configuration of the user guidance for the scanning status.
`final Unit`	`setScanStatusUserGuidance(CreditCardScanGuidanceConfiguration scanStatusUserGuidance)`	Configuration of the user guidance for the scanning status.
`final TopBarConfiguration`	`getTopBar()`	Configuration of the top bar on the credit card scanner screen.
`final Unit`	`setTopBar(TopBarConfiguration topBar)`	Configuration of the top bar on the credit card scanner screen.
`final IconButton`	`getTopBarOpenIntroScreenButton()`	Configuration of the button in the top bar that opens the introduction screen.
`final Unit`	`setTopBarOpenIntroScreenButton(IconButton topBarOpenIntroScreenButton)`	Configuration of the button in the top bar that opens the introduction screen.
`final CreditCardScannerIntroScreenConfiguration`	`getIntroScreen()`	Configuration of the introduction screen for the credit card scanner.
`final Unit`	`setIntroScreen(CreditCardScannerIntroScreenConfiguration introScreen)`	Configuration of the introduction screen for the credit card scanner.
`final ActionBarConfiguration`	`getActionBar()`	Configuration of the action bar.
`final Unit`	`setActionBar(ActionBarConfiguration actionBar)`	Configuration of the action bar.
`final PermanentViewFinderConfiguration`	`getViewFinder()`	Configuration of the view finder.
`final Unit`	`setViewFinder(PermanentViewFinderConfiguration viewFinder)`	Configuration of the view finder.
`final CreditCardScannerConfiguration`	`getScannerConfiguration()`	Configuration for the credit card recognizer.
`final Unit`	`setScannerConfiguration(CreditCardScannerConfiguration scannerConfiguration)`	Configuration for the credit card recognizer.
`final Boolean`	`getExampleOverlayVisible()`	Flag to show or hide the preset button.
`final Unit`	`setExampleOverlayVisible(Boolean exampleOverlayVisible)`	Flag to show or hide the preset button.
`final CreditCardScanningProgressConfiguration`	`getScanningProgress()`	Configuration of visualization of the scanning progress.
`final Unit`	`setScanningProgress(CreditCardScanningProgressConfiguration scanningProgress)`	Configuration of visualization of the scanning progress.
`final Integer`	`getScanIncompleteDataTimeout()`	Timeout for the scan process.
`final Unit`	`setScanIncompleteDataTimeout(Integer scanIncompleteDataTimeout)`	Timeout for the scan process.
`final ScanCompletionOverlay`	`getSuccessOverlay()`	Configuration of the success overlay.
`final Unit`	`setSuccessOverlay(ScanCompletionOverlay successOverlay)`	Configuration of the success overlay.
`final ScanCompletionOverlay`	`getIncompleteDataOverlay()`	Configuration of the success overlay.
`final Unit`	`setIncompleteDataOverlay(ScanCompletionOverlay incompleteDataOverlay)`	Configuration of the success overlay.
`final Sound`	`getSound()`	Configuration of the scan confirmation sound.
`final Unit`	`setSound(Sound sound)`	Configuration of the scan confirmation sound.
`final Vibration`	`getVibration()`	Configuration of the vibration feedback.
`final Unit`	`setVibration(Vibration vibration)`	Configuration of the vibration feedback.
`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 CreditCardScannerScreenConfiguration`	`clone()`
`final static CreditCardScannerScreenConfiguration`	`default()`

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

Constructor Detail

CreditCardScannerScreenConfiguration

CreditCardScannerScreenConfiguration(Map<String, Object> source)

CreditCardScannerScreenConfiguration

CreditCardScannerScreenConfiguration(JSONObject json)

CreditCardScannerScreenConfiguration

CreditCardScannerScreenConfiguration(String version, String screen, CreditCardScannerScreenTextLocalization localization, Palette palette, ScanbotColor backgroundColor, CameraConfiguration cameraConfiguration, CameraPermissionScreen cameraPermission, UserGuidanceConfiguration topUserGuidance, CreditCardScanGuidanceConfiguration scanStatusUserGuidance, TopBarConfiguration topBar, IconButton topBarOpenIntroScreenButton, CreditCardScannerIntroScreenConfiguration introScreen, ActionBarConfiguration actionBar, PermanentViewFinderConfiguration viewFinder, CreditCardScannerConfiguration scannerConfiguration, Boolean exampleOverlayVisible, CreditCardScanningProgressConfiguration scanningProgress, Integer scanIncompleteDataTimeout, ScanCompletionOverlay successOverlay, ScanCompletionOverlay incompleteDataOverlay, Sound sound, Vibration vibration, Boolean keepScreenOn)

Method Detail
- getVersion
```
 final String getVersion()
```
  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 "CreditCardScanner"
- getLocalization
```
 final CreditCardScannerScreenTextLocalization getLocalization()
```
  Configuration of the all strings for credit card scanner screen.
- setLocalization
```
 final Unit setLocalization(CreditCardScannerScreenTextLocalization localization)
```
  Configuration of the all strings for credit card scanner screen.
- 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.
- getBackgroundColor
```
 final ScanbotColor getBackgroundColor()
```
  The background color of the credit card scanner screen.
  Default is "?sbColorSurfaceLow"
- setBackgroundColor
```
 final Unit setBackgroundColor(ScanbotColor backgroundColor)
```
  The background color of the credit card scanner screen.
  Default is "?sbColorSurfaceLow"
- getCameraConfiguration
```
 final CameraConfiguration getCameraConfiguration()
```
  Configuration of the camera behavior.
- setCameraConfiguration
```
 final Unit setCameraConfiguration(CameraConfiguration cameraConfiguration)
```
  Configuration of the camera behavior.
- getCameraPermission
```
 final CameraPermissionScreen getCameraPermission()
```
  Configuration of the dialog for requesting camera permissions.
- setCameraPermission
```
 final Unit setCameraPermission(CameraPermissionScreen cameraPermission)
```
  Configuration of the dialog for requesting camera permissions.
- getTopUserGuidance
```
 final UserGuidanceConfiguration getTopUserGuidance()
```
  Configuration of the top user guidance.
- setTopUserGuidance
```
 final Unit setTopUserGuidance(UserGuidanceConfiguration topUserGuidance)
```
  Configuration of the top user guidance.
- getScanStatusUserGuidance
```
 final CreditCardScanGuidanceConfiguration getScanStatusUserGuidance()
```
  Configuration of the user guidance for the scanning status.
- setScanStatusUserGuidance
```
 final Unit setScanStatusUserGuidance(CreditCardScanGuidanceConfiguration scanStatusUserGuidance)
```
  Configuration of the user guidance for the scanning status.
- getTopBar
```
 final TopBarConfiguration getTopBar()
```
  Configuration of the top bar on the credit card scanner screen.
- setTopBar
```
 final Unit setTopBar(TopBarConfiguration topBar)
```
  Configuration of the top bar on the credit card scanner screen.
- getTopBarOpenIntroScreenButton
```
 final IconButton getTopBarOpenIntroScreenButton()
```
  Configuration of the button in the top bar that opens the introduction screen.
- setTopBarOpenIntroScreenButton
```
 final Unit setTopBarOpenIntroScreenButton(IconButton topBarOpenIntroScreenButton)
```
  Configuration of the button in the top bar that opens the introduction screen.
- getIntroScreen
```
 final CreditCardScannerIntroScreenConfiguration getIntroScreen()
```
  Configuration of the introduction screen for the credit card scanner.
- setIntroScreen
```
 final Unit setIntroScreen(CreditCardScannerIntroScreenConfiguration introScreen)
```
  Configuration of the introduction screen for the credit card scanner.
- getActionBar
```
 final ActionBarConfiguration getActionBar()
```
  Configuration of the action bar.
- setActionBar
```
 final Unit setActionBar(ActionBarConfiguration actionBar)
```
  Configuration of the action bar.
- getViewFinder
```
 final PermanentViewFinderConfiguration getViewFinder()
```
  Configuration of the view finder.
- setViewFinder
```
 final Unit setViewFinder(PermanentViewFinderConfiguration viewFinder)
```
  Configuration of the view finder.
- getScannerConfiguration
```
 final CreditCardScannerConfiguration getScannerConfiguration()
```
  Configuration for the credit card recognizer.
- setScannerConfiguration
```
 final Unit setScannerConfiguration(CreditCardScannerConfiguration scannerConfiguration)
```
  Configuration for the credit card recognizer.
- getExampleOverlayVisible
```
 final Boolean getExampleOverlayVisible()
```
  Flag to show or hide the preset button.
  Default is true
- setExampleOverlayVisible
```
 final Unit setExampleOverlayVisible(Boolean exampleOverlayVisible)
```
  Flag to show or hide the preset button.
  Default is true
- getScanningProgress
```
 final CreditCardScanningProgressConfiguration getScanningProgress()
```
  Configuration of visualization of the scanning progress.
- setScanningProgress
```
 final Unit setScanningProgress(CreditCardScanningProgressConfiguration scanningProgress)
```
  Configuration of visualization of the scanning progress.
- getScanIncompleteDataTimeout
```
 final Integer getScanIncompleteDataTimeout()
```
  Timeout for the scan process. If the scan process takes longer than this value, the incomplete result will be returned.
  Default is 3000
- setScanIncompleteDataTimeout
```
 final Unit setScanIncompleteDataTimeout(Integer scanIncompleteDataTimeout)
```
  Timeout for the scan process. If the scan process takes longer than this value, the incomplete result will be returned.
  Default is 3000
- getSuccessOverlay
```
 final ScanCompletionOverlay getSuccessOverlay()
```
  Configuration of the success overlay.
- setSuccessOverlay
```
 final Unit setSuccessOverlay(ScanCompletionOverlay successOverlay)
```
  Configuration of the success overlay.
- getIncompleteDataOverlay
```
 final ScanCompletionOverlay getIncompleteDataOverlay()
```
  Configuration of the success overlay.
- setIncompleteDataOverlay
```
 final Unit setIncompleteDataOverlay(ScanCompletionOverlay incompleteDataOverlay)
```
  Configuration of the success overlay.
- getSound
```
 final Sound getSound()
```
  Configuration of the scan confirmation sound.
- setSound
```
 final Unit setSound(Sound sound)
```
  Configuration of the scan confirmation sound.
- getVibration
```
 final Vibration getVibration()
```
  Configuration of the vibration feedback.
- setVibration
```
 final Unit setVibration(Vibration vibration)
```
  Configuration of the vibration feedback.
- 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 CreditCardScannerScreenConfiguration clone()
```
- default
```
 final static CreditCardScannerScreenConfiguration default()
```

Class CreditCardScannerScreenConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CreditCardScannerScreenConfiguration

CreditCardScannerScreenConfiguration

CreditCardScannerScreenConfiguration

Method Detail

getVersion

getScreen

getLocalization

setLocalization

getPalette

setPalette

getBackgroundColor

setBackgroundColor

getCameraConfiguration

setCameraConfiguration

getCameraPermission

setCameraPermission

getTopUserGuidance

setTopUserGuidance

getScanStatusUserGuidance

setScanStatusUserGuidance

getTopBar

setTopBar

getTopBarOpenIntroScreenButton

setTopBarOpenIntroScreenButton

getIntroScreen

setIntroScreen

getActionBar

setActionBar

getViewFinder

setViewFinder

getScannerConfiguration

setScannerConfiguration

getExampleOverlayVisible

setExampleOverlayVisible

getScanningProgress

setScanningProgress

getScanIncompleteDataTimeout

setScanIncompleteDataTimeout

getSuccessOverlay

setSuccessOverlay

getIncompleteDataOverlay

setIncompleteDataOverlay

getSound

setSound

getVibration

setVibration

getKeepScreenOn

setKeepScreenOn

toJson

clone

default