All Implemented Interfaces:: android.os.Parcelable

public final class BarcodeScannerScreenConfiguration
 implements Parcelable

Configuration of the barcode scanner screen.

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 Palette`	`palette`
`private BarcodeTextLocalization`	`localization`
`private ScanbotColor`	`backgroundColor`
`private TopBarConfiguration`	`topBar`
`private ActionBarConfiguration`	`actionBar`
`private ViewFinderConfiguration`	`viewFinder`
`private UserGuidanceConfiguration`	`userGuidance`
`private CameraPermissionScreen`	`cameraPermission`
`private CameraConfiguration`	`cameraConfiguration`
`private BarcodeScannerConfiguration`	`scannerConfiguration`
`private BarcodeUseCase`	`useCase`
`private Sound`	`sound`
`private Vibration`	`vibration`
`private Timeouts`	`timeouts`
`private Boolean`	`keepScreenOn`

Constructor Summary

Constructors
Constructor	Description
`BarcodeScannerScreenConfiguration(Map<String, Object> source)`
`BarcodeScannerScreenConfiguration(JSONObject json)`
BarcodeScannerScreenConfiguration(String version, String screen, Palette palette, BarcodeTextLocalization localization, ScanbotColor backgroundColor, TopBarConfiguration topBar, ActionBarConfiguration actionBar, ViewFinderConfiguration viewFinder, UserGuidanceConfiguration userGuidance, CameraPermissionScreen cameraPermission, CameraConfiguration cameraConfiguration, BarcodeScannerConfiguration scannerConfiguration, BarcodeUseCase useCase, Sound sound, Vibration vibration, Timeouts timeouts, 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 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 BarcodeTextLocalization`	`getLocalization()`	Configuration of the all strings for barcode scanner.
`final Unit`	`setLocalization(BarcodeTextLocalization localization)`	Configuration of the all strings for barcode scanner.
`final ScanbotColor`	`getBackgroundColor()`	Color of the screen's background.
`final Unit`	`setBackgroundColor(ScanbotColor backgroundColor)`	Color of the screen's background.
`final TopBarConfiguration`	`getTopBar()`	Configuration of the top bar.
`final Unit`	`setTopBar(TopBarConfiguration topBar)`	Configuration of the top bar.
`final ActionBarConfiguration`	`getActionBar()`	Configuration of the action bar.
`final Unit`	`setActionBar(ActionBarConfiguration actionBar)`	Configuration of the action bar.
`final ViewFinderConfiguration`	`getViewFinder()`	Configuration of the view finder.
`final Unit`	`setViewFinder(ViewFinderConfiguration viewFinder)`	Configuration of the view finder.
`final UserGuidanceConfiguration`	`getUserGuidance()`	Configuration of the text hint guiding users to move the view finder over a barcode.
`final Unit`	`setUserGuidance(UserGuidanceConfiguration userGuidance)`	Configuration of the text hint guiding users to move the view finder over a barcode.
`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 CameraConfiguration`	`getCameraConfiguration()`	Configuration of the camera behavior.
`final Unit`	`setCameraConfiguration(CameraConfiguration cameraConfiguration)`	Configuration of the camera behavior.
`final BarcodeScannerConfiguration`	`getScannerConfiguration()`	Configuration of the scanning behavior.
`final Unit`	`setScannerConfiguration(BarcodeScannerConfiguration scannerConfiguration)`	Configuration of the scanning behavior.
`final BarcodeUseCase`	`getUseCase()`	Configuration of the barcode scanner screen's behavior.
`final Unit`	`setUseCase(BarcodeUseCase useCase)`	Configuration of the barcode scanner screen's behavior.
`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 scan scan confirmation vibration.
`final Unit`	`setVibration(Vibration vibration)`	Configuration of the scan scan confirmation vibration.
`final Timeouts`	`getTimeouts()`	Configuration of timeouts.
`final Unit`	`setTimeouts(Timeouts timeouts)`	Configuration of timeouts.
`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 BarcodeScannerScreenConfiguration`	`clone()`
`final static BarcodeScannerScreenConfiguration`	`default()`

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

Constructor Detail

BarcodeScannerScreenConfiguration

BarcodeScannerScreenConfiguration(Map<String, Object> source)

BarcodeScannerScreenConfiguration

BarcodeScannerScreenConfiguration(JSONObject json)

BarcodeScannerScreenConfiguration

BarcodeScannerScreenConfiguration(String version, String screen, Palette palette, BarcodeTextLocalization localization, ScanbotColor backgroundColor, TopBarConfiguration topBar, ActionBarConfiguration actionBar, ViewFinderConfiguration viewFinder, UserGuidanceConfiguration userGuidance, CameraPermissionScreen cameraPermission, CameraConfiguration cameraConfiguration, BarcodeScannerConfiguration scannerConfiguration, BarcodeUseCase useCase, Sound sound, Vibration vibration, Timeouts timeouts, 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 "BarcodeScanner"
- 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 BarcodeTextLocalization getLocalization()
```
  Configuration of the all strings for barcode scanner.
- setLocalization
```
 final Unit setLocalization(BarcodeTextLocalization localization)
```
  Configuration of the all strings for barcode scanner.
- getBackgroundColor
```
 final ScanbotColor getBackgroundColor()
```
  Color of the screen's background.
  Default is "?sbColorSurfaceLow"
- setBackgroundColor
```
 final Unit setBackgroundColor(ScanbotColor backgroundColor)
```
  Color of the screen's background.
  Default is "?sbColorSurfaceLow"
- getTopBar
```
 final TopBarConfiguration getTopBar()
```
  Configuration of the top bar.
- setTopBar
```
 final Unit setTopBar(TopBarConfiguration topBar)
```
  Configuration of the top bar.
- getActionBar
```
 final ActionBarConfiguration getActionBar()
```
  Configuration of the action bar.
- setActionBar
```
 final Unit setActionBar(ActionBarConfiguration actionBar)
```
  Configuration of the action bar.
- getViewFinder
```
 final ViewFinderConfiguration getViewFinder()
```
  Configuration of the view finder.
- setViewFinder
```
 final Unit setViewFinder(ViewFinderConfiguration viewFinder)
```
  Configuration of the view finder.
- getUserGuidance
```
 final UserGuidanceConfiguration getUserGuidance()
```
  Configuration of the text hint guiding users to move the view finder over a barcode.
- setUserGuidance
```
 final Unit setUserGuidance(UserGuidanceConfiguration userGuidance)
```
  Configuration of the text hint guiding users to move the view finder over a barcode.
- 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.
- getCameraConfiguration
```
 final CameraConfiguration getCameraConfiguration()
```
  Configuration of the camera behavior.
- setCameraConfiguration
```
 final Unit setCameraConfiguration(CameraConfiguration cameraConfiguration)
```
  Configuration of the camera behavior.
- getScannerConfiguration
```
 final BarcodeScannerConfiguration getScannerConfiguration()
```
  Configuration of the scanning behavior.
- setScannerConfiguration
```
 final Unit setScannerConfiguration(BarcodeScannerConfiguration scannerConfiguration)
```
  Configuration of the scanning behavior.
- getUseCase
```
 final BarcodeUseCase getUseCase()
```
  Configuration of the barcode scanner screen's behavior.
- setUseCase
```
 final Unit setUseCase(BarcodeUseCase useCase)
```
  Configuration of the barcode scanner screen's behavior.
- 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 scan scan confirmation vibration.
- setVibration
```
 final Unit setVibration(Vibration vibration)
```
  Configuration of the scan scan confirmation vibration.
- getTimeouts
```
 final Timeouts getTimeouts()
```
  Configuration of timeouts.
- setTimeouts
```
 final Unit setTimeouts(Timeouts timeouts)
```
  Configuration of timeouts.
- 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 BarcodeScannerScreenConfiguration clone()
```
- default
```
 final static BarcodeScannerScreenConfiguration default()
```

Class BarcodeScannerScreenConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BarcodeScannerScreenConfiguration

BarcodeScannerScreenConfiguration

BarcodeScannerScreenConfiguration

Method Detail

getVersion

getScreen

getPalette

setPalette

getLocalization

setLocalization

getBackgroundColor

setBackgroundColor

getTopBar

setTopBar

getActionBar

setActionBar

getViewFinder

setViewFinder

getUserGuidance

setUserGuidance

getCameraPermission

setCameraPermission

getCameraConfiguration

setCameraConfiguration

getScannerConfiguration

setScannerConfiguration

getUseCase

setUseCase

getSound

setSound

getVibration

setVibration

getTimeouts

setTimeouts

getKeepScreenOn

setKeepScreenOn

toJson

clone

default