All Implemented Interfaces:: android.os.Parcelable


public final class SingleScanningMode
extends BarcodeUseCase implements Parcelable

Configuration of the single barcode scanning mode.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`_type`
`private Boolean`	`confirmationSheetEnabled`
`private Boolean`	`barcodeImageVisible`
`private ScanbotColor`	`sheetColor`
`private ScanbotColor`	`dividerColor`
`private ScanbotColor`	`modalOverlayColor`
`private StyledText`	`barcodeTitle`
`private StyledText`	`barcodeSubtitle`
`private ButtonConfiguration`	`submitButton`
`private ButtonConfiguration`	`cancelButton`
`private BarcodeInfoMapping`	`barcodeInfoMapping`
`private ArOverlayGeneralConfiguration`	`arOverlay`

Constructor Summary

Constructors
Constructor	Description
`SingleScanningMode(Map<String, Object> source)`
`SingleScanningMode(JSONObject json)`
`SingleScanningMode(Boolean confirmationSheetEnabled, Boolean barcodeImageVisible, ScanbotColor sheetColor, ScanbotColor dividerColor, ScanbotColor modalOverlayColor, StyledText barcodeTitle, StyledText barcodeSubtitle, ButtonConfiguration submitButton, ButtonConfiguration cancelButton, BarcodeInfoMapping barcodeInfoMapping, ArOverlayGeneralConfiguration arOverlay)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`String`	`get_type()`
`final Boolean`	`getConfirmationSheetEnabled()`	If enabled, the confirmation sheet will be shown after the barcode has been scanned.
`final Unit`	`setConfirmationSheetEnabled(Boolean confirmationSheetEnabled)`	If enabled, the confirmation sheet will be shown after the barcode has been scanned.
`final Boolean`	`getBarcodeImageVisible()`	If enabled, the barcode image will be shown on the confirmation sheet.
`final Unit`	`setBarcodeImageVisible(Boolean barcodeImageVisible)`	If enabled, the barcode image will be shown on the confirmation sheet.
`final ScanbotColor`	`getSheetColor()`	Color of the confirmation sheet's background.
`final Unit`	`setSheetColor(ScanbotColor sheetColor)`	Color of the confirmation sheet's background.
`final ScanbotColor`	`getDividerColor()`	Color of the divider and separator lines in the confirmation sheet.
`final Unit`	`setDividerColor(ScanbotColor dividerColor)`	Color of the divider and separator lines in the confirmation sheet.
`final ScanbotColor`	`getModalOverlayColor()`	Background color of the overlay surrounding the confirmation sheet.
`final Unit`	`setModalOverlayColor(ScanbotColor modalOverlayColor)`	Background color of the overlay surrounding the confirmation sheet.
`final StyledText`	`getBarcodeTitle()`	Appearance of the barcode title (the barcode's value) on the confirmation sheet.
`final Unit`	`setBarcodeTitle(StyledText barcodeTitle)`	Appearance of the barcode title (the barcode's value) on the confirmation sheet.
`final StyledText`	`getBarcodeSubtitle()`	Appearance of the barcode subtitle (the barcode's symbology) on the confirmation sheet.
`final Unit`	`setBarcodeSubtitle(StyledText barcodeSubtitle)`	Appearance of the barcode subtitle (the barcode's symbology) on the confirmation sheet.
`final ButtonConfiguration`	`getSubmitButton()`	Appearance of the confirm button on the confirmation sheet.
`final Unit`	`setSubmitButton(ButtonConfiguration submitButton)`	Appearance of the confirm button on the confirmation sheet.
`final ButtonConfiguration`	`getCancelButton()`	Appearance of the cancel button on the confirmation sheet.
`final Unit`	`setCancelButton(ButtonConfiguration cancelButton)`	Appearance of the cancel button on the confirmation sheet.
`final BarcodeInfoMapping`	`getBarcodeInfoMapping()`	Appearance of the barcode info mapping.
`final Unit`	`setBarcodeInfoMapping(BarcodeInfoMapping barcodeInfoMapping)`	Appearance of the barcode info mapping.
`final ArOverlayGeneralConfiguration`	`getArOverlay()`	Configuration of the AR overlay.
`final Unit`	`setArOverlay(ArOverlayGeneralConfiguration arOverlay)`	Configuration of the AR overlay.
`JSONObject`	`toJson()`
`final static SingleScanningMode`	`default()`

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

- Constructor Detail
  - SingleScanningMode
```
SingleScanningMode(Map<String, Object> source)
```
  - SingleScanningMode
```
SingleScanningMode(JSONObject json)
```
  - SingleScanningMode
```
SingleScanningMode(Boolean confirmationSheetEnabled, Boolean barcodeImageVisible, ScanbotColor sheetColor, ScanbotColor dividerColor, ScanbotColor modalOverlayColor, StyledText barcodeTitle, StyledText barcodeSubtitle, ButtonConfiguration submitButton, ButtonConfiguration cancelButton, BarcodeInfoMapping barcodeInfoMapping, ArOverlayGeneralConfiguration arOverlay)
```
- Method Detail
  - get_type
```
 String get_type()
```
  - getConfirmationSheetEnabled
```
 final Boolean getConfirmationSheetEnabled()
```
    If enabled, the confirmation sheet will be shown after the barcode has been scanned. Default is false
  - setConfirmationSheetEnabled
```
 final Unit setConfirmationSheetEnabled(Boolean confirmationSheetEnabled)
```
    If enabled, the confirmation sheet will be shown after the barcode has been scanned. Default is false
  - getBarcodeImageVisible
```
 final Boolean getBarcodeImageVisible()
```
    If enabled, the barcode image will be shown on the confirmation sheet. Default is true
  - setBarcodeImageVisible
```
 final Unit setBarcodeImageVisible(Boolean barcodeImageVisible)
```
    If enabled, the barcode image will be shown on the confirmation sheet. Default is true
  - getSheetColor
```
 final ScanbotColor getSheetColor()
```
    Color of the confirmation sheet's background. Default is "?sbColorSurface"
  - setSheetColor
```
 final Unit setSheetColor(ScanbotColor sheetColor)
```
    Color of the confirmation sheet's background. Default is "?sbColorSurface"
  - getDividerColor
```
 final ScanbotColor getDividerColor()
```
    Color of the divider and separator lines in the confirmation sheet. Default is "?sbColorOutline"
  - setDividerColor
```
 final Unit setDividerColor(ScanbotColor dividerColor)
```
    Color of the divider and separator lines in the confirmation sheet. Default is "?sbColorOutline"
  - getModalOverlayColor
```
 final ScanbotColor getModalOverlayColor()
```
    Background color of the overlay surrounding the confirmation sheet. Default is "?sbColorModalOverlay"
  - setModalOverlayColor
```
 final Unit setModalOverlayColor(ScanbotColor modalOverlayColor)
```
    Background color of the overlay surrounding the confirmation sheet. Default is "?sbColorModalOverlay"
  - getBarcodeTitle
```
 final StyledText getBarcodeTitle()
```
    Appearance of the barcode title (the barcode's value) on the confirmation sheet.
  - setBarcodeTitle
```
 final Unit setBarcodeTitle(StyledText barcodeTitle)
```
    Appearance of the barcode title (the barcode's value) on the confirmation sheet.
  - getBarcodeSubtitle
```
 final StyledText getBarcodeSubtitle()
```
    Appearance of the barcode subtitle (the barcode's symbology) on the confirmation sheet.
  - setBarcodeSubtitle
```
 final Unit setBarcodeSubtitle(StyledText barcodeSubtitle)
```
    Appearance of the barcode subtitle (the barcode's symbology) on the confirmation sheet.
  - getSubmitButton
```
 final ButtonConfiguration getSubmitButton()
```
    Appearance of the confirm button on the confirmation sheet.
  - setSubmitButton
```
 final Unit setSubmitButton(ButtonConfiguration submitButton)
```
    Appearance of the confirm button on the confirmation sheet.
  - getCancelButton
```
 final ButtonConfiguration getCancelButton()
```
    Appearance of the cancel button on the confirmation sheet.
  - setCancelButton
```
 final Unit setCancelButton(ButtonConfiguration cancelButton)
```
    Appearance of the cancel button on the confirmation sheet.
  - getBarcodeInfoMapping
```
 final BarcodeInfoMapping getBarcodeInfoMapping()
```
    Appearance of the barcode info mapping.
  - setBarcodeInfoMapping
```
 final Unit setBarcodeInfoMapping(BarcodeInfoMapping barcodeInfoMapping)
```
    Appearance of the barcode info mapping.
  - getArOverlay
```
 final ArOverlayGeneralConfiguration getArOverlay()
```
    Configuration of the AR overlay.
  - setArOverlay
```
 final Unit setArOverlay(ArOverlayGeneralConfiguration arOverlay)
```
    Configuration of the AR overlay.
  - toJson
```
 JSONObject toJson()
```
  - default
```
 final static SingleScanningMode default()
```

Class SingleScanningMode

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SingleScanningMode

SingleScanningMode

SingleScanningMode

Method Detail

get_type

getConfirmationSheetEnabled

setConfirmationSheetEnabled

getBarcodeImageVisible

setBarcodeImageVisible

getSheetColor

setSheetColor

getDividerColor

setDividerColor

getModalOverlayColor

setModalOverlayColor

getBarcodeTitle

setBarcodeTitle

getBarcodeSubtitle

setBarcodeSubtitle

getSubmitButton

setSubmitButton

getCancelButton

setCancelButton

getBarcodeInfoMapping

setBarcodeInfoMapping

getArOverlay

setArOverlay

toJson

default