Class BarcodeScannerConfiguration
-
- All Implemented Interfaces:
-
android.os.Parcelable
public final class BarcodeScannerConfiguration implements Parcelable
Configuration of the barcode scanner screen.
-
-
Field Summary
Fields Modifier and Type Field Description public final static String
defaultJson
private String
version
private String
screen
private ScanbotPalette
palette
private ScanbotColor
backgroundColor
private TopBarConfiguration
topBar
private ActionBarConfiguration
actionBar
private ViewFinderConfiguration
viewFinder
private UserGuidanceConfiguration
userGuidance
private CameraPermissionScreen
cameraPermission
private CameraConfiguration
cameraConfiguration
private BarcodeRecognizerConfiguration
recognizerConfiguration
private BarcodeUseCase
useCase
private Sound
sound
private Vibration
vibration
private Timeouts
timeouts
-
Constructor Summary
Constructors Constructor Description BarcodeScannerConfiguration(Map<String, Object> json)
BarcodeScannerConfiguration(String json)
BarcodeScannerConfiguration()
BarcodeScannerConfiguration(String version, String screen, ScanbotPalette palette, ScanbotColor backgroundColor, TopBarConfiguration topBar, ActionBarConfiguration actionBar, ViewFinderConfiguration viewFinder, UserGuidanceConfiguration userGuidance, CameraPermissionScreen cameraPermission, CameraConfiguration cameraConfiguration, BarcodeRecognizerConfiguration recognizerConfiguration, BarcodeUseCase useCase, Sound sound, Vibration vibration, Timeouts timeouts)
-
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 ScanbotPalette
getPalette()
Define the screen's base color values from which other colors are derived. final Unit
setPalette(ScanbotPalette palette)
Define the screen's base color values from which other colors are derived. 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 BarcodeRecognizerConfiguration
getRecognizerConfiguration()
Configuration of the scanning behavior. final Unit
setRecognizerConfiguration(BarcodeRecognizerConfiguration recognizerConfiguration)
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. -
-
Constructor Detail
-
BarcodeScannerConfiguration
BarcodeScannerConfiguration(String json)
-
BarcodeScannerConfiguration
BarcodeScannerConfiguration()
-
BarcodeScannerConfiguration
BarcodeScannerConfiguration(String version, String screen, ScanbotPalette palette, ScanbotColor backgroundColor, TopBarConfiguration topBar, ActionBarConfiguration actionBar, ViewFinderConfiguration viewFinder, UserGuidanceConfiguration userGuidance, CameraPermissionScreen cameraPermission, CameraConfiguration cameraConfiguration, BarcodeRecognizerConfiguration recognizerConfiguration, BarcodeUseCase useCase, Sound sound, Vibration vibration, Timeouts timeouts)
-
-
Method Detail
-
getVersion
final String getVersion()
Version number of the configuration object.
-
setVersion
final Unit setVersion(String version)
Version number of the configuration object.
-
setScreen
final Unit setScreen(String screen)
The configuration object should be applied for this screen.
-
getPalette
final ScanbotPalette getPalette()
Define the screen's base color values from which other colors are derived.
-
setPalette
final Unit setPalette(ScanbotPalette palette)
Define the screen's base color values from which other colors are derived.
-
getBackgroundColor
final ScanbotColor getBackgroundColor()
Color of the screen's background.
-
setBackgroundColor
final Unit setBackgroundColor(ScanbotColor backgroundColor)
Color of the screen's background.
-
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.
-
getRecognizerConfiguration
final BarcodeRecognizerConfiguration getRecognizerConfiguration()
Configuration of the scanning behavior.
-
setRecognizerConfiguration
final Unit setRecognizerConfiguration(BarcodeRecognizerConfiguration recognizerConfiguration)
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.
-
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.
-
-
-
-