# scanbot_sdk_ui_v2 library

## Classes

AcknowledgementBottomBar
  Configuration of the bottom bar for the acknowledgement screen.
AcknowledgementScreenConfiguration
  Configuration of the acknowledgement screen.
ActionBarConfiguration
  Configuration of the buttons available in the action bar.
AddPageParams
ApplyImageFiltersResult
ArOverlayFindAndPickConfiguration
  Configuration of the AR overlay.
ArOverlayGeneralConfiguration
  Configuration of the AR overlay displayed on top of barcodes in the camera preview.
ArOverlayPolygonConfiguration
  Configuration of the overlay polygon displayed on top of a barcode in the camera preview.
AspectRatio
  Configuration of the finder's aspect ratio.
BackgroundStyle
  Configuration of the background appearance for buttons and hints.
BadgedButton
  Configuration of the button with a badge.
BadgeStyle
  Configuration of the badge.
BarButtonConfiguration
  Configuration of the button located on a bar.
BarcodeInfoMapping
  Configuration of the barcode data mapping.
BarcodeItem
  Data about the scanned barcode.
BarcodeItemConfiguration
  Configuration of the barcode info box displayed in the camera preview.
BarcodeItemErrorState
  Configuration of the the mapper's error dialog.
BarcodeMappedData
  Format of the mapped barcode data.
BarcodeRecognizerConfiguration
  Configuration of the scanning behavior.
BarcodeScannerConfiguration
  Configuration of the barcode scanner screen.
BarcodeScannerResult
  Results of the barcode scan.
BarcodeTextLocalization
  Configuration of the all strings for barcode scanner.
BarcodeUseCase
  Configuration of the barcode scanner screen's behavior.
ButtonConfiguration
  Configuration of the button.
CameraBottomBar
  Configuration of the bottom bar for the camera screen.
CameraConfiguration
  Configuration of the camera settings to be used while scanning.
CameraPermissionScreen
  Configuration of the camera permission request view.
CameraScreenConfiguration
  Configuration of the screen for scanning the pages with the camera.
CaptureFeedback
  Configuration of the feedback shown after snapping a page.
CheckIntroImage
  The image for the introduction screen with a check template.
CreateDocumentParams
CreatePDFResult
CreateTIFFResult
CreditCardIntroImage
  The image for the introduction screen with a credit card template.
CroppingAppearanceConfiguration
  Configuration of the general appearance for the cropping screen.
CroppingBottomBar
  Configuration of the bottom bar for the cropping screen.
CroppingConfiguration
  Configuration of the standalone cropping screen.
CroppingResult
  Configuration of the cropping result.
CroppingScreenConfiguration
  Configuration of the screen for cropping the scanned pages.
CroppingTextLocalization
  Configuration of all the strings for the standalone cropping screen.
CustomImage
  A custom image for the introduction screen.
DocumentExistsResult
DocumentFlowAppearanceConfiguration
  Configuration of the general appearance.
DocumentFromLegacyPagesParams
DocumentIntroImage
  The image for the introduction screen with a document template.
DocumentPolygonConfiguration
  Configuration of the document contour detection polygon.
DocumentQualityAnalyzerResult
DocumentScannerCameraConfiguration
  Configuration of the camera behavior.
DocumentScannerOutputSettings
  Configuration of the output settings.
DocumentScannerScreens
  Configuration of the document scanner sub-screens.
DocumentScannerTextLocalization
  Configuration of all the strings for the standalone cropping screen.
DocumentScannerUserGuidance
  Configuration of the hints guiding users through the scanning process.
DocumentScanningFlow
  Configuration of the document scanner screen.
ExpectedBarcode
  Configuration of the barcode to find and scan.
FindAndPickArOverlayPolygonConfiguration
  Configuration of the overlay polygon displayed on top of a barcode in the camera preview.
FindAndPickBadgeConfiguration
  Configuration of the round badge on find and pick ar layer.
FindAndPickScanningMode
  Configuration of the Find and Pick barcode scanning mode.
FinderCorneredStyle
  A variant of the viewfinder displaying only the four corners of the scanning area.
FinderStrokedStyle
  A variant of the viewfinder displaying a full outline of the scanning area.
FinderStyle
  The visual appearance of the viewfinder.
ForegroundStyle
  Configuration of the appearance for foreground elements (e.g. text and/or icons, etc).
IconButton
  Configuration of the icon appearance on a button.
IconStyle
  Configuration of the icon appearance.
IconUserGuidanceConfiguration
  Configuration of the hint (containing an icon) guiding users through the scanning process.
IdCardIntroImage
  The image for the introduction screen with an ID card template.
IntroductionScreenConfiguration
  Configuration of the introduction screen for the document scanner.
IntroImage
  Determines the image for the introduction screen.
IntroListEntry
  An entry in the list of scanning steps of the introduction screen.
ManualCountEditDialog
  Configuration of the dialog to manually edit the barcode count.
MedicalCertificateIntroImage
  The image for the introduction screen with a medical certificate template.
ModifyPageParams
MovePageParams
MultipleScanningMode
  Configuration of the mode for scanning multiple barcodes.
NoButtonMode
  Configuration of the 'preview' button in 'no button mode'.
NoIntroImage
  No image for the introduction screen.
PagePreviewMode
  Configuration of the 'preview' button in 'page preview mode'.
PageSnapCheckMarkAnimation
  Configuration of the check mark animation.
PageSnapFeedbackMode
  The type of animation to display after snapping a page.
PageSnapFeedbackNone
  To not use a snap animation.
PageSnapFunnelAnimation
  Configuration of the funnel animation.
Palette
  Value palette describing the colors of the scanner screens.
PDFFromDocumentParams
PerformOCRArguments
PerformOCRResult
PolygonStyle
  Configuration of the polygon appearance.
PopupMenuItem
  Configuration for the popup menu items.
PreviewButton
  Configuration of the 'preview' button.
ReceiptsIntroImage
  The image for the introduction screen with a receipt template.
RemovePageParams
ReorderPagesScreenConfiguration
  Configuration of the screen for reordering the scanned pages.
ResultWrapper<T>
ReviewBottomBarConfiguration
  Configuration of the bottom bar for the review screen.
ReviewMorePopupMenu
  Configuration of the 'more' popup menu for the review screen.
ReviewScreenConfiguration
  Configuration of the screen for reviewing the scanned pages.
RoundButton
  Configuration of the round button.
ScanAssistanceOverlay
  Configuration of the scan assistance overlay.
ScanbotAlertDialog
  Configuration of the the standard alert dialog.
ScanbotColor
ScanbotSdkUiV2
  A utility class providing methods to launch Ready-to-Use V2 UI components of the Scanbot SDK.
Sheet
  Configuration of the preview mode for scanning multiple barcodes.
SheetContent
  Configuration of the list containing the barcodes that have already been scanned.
ShutterButton
  Configuration of the 'shutter' button.
SingleScanningMode
  Configuration of the single barcode scanning mode.
Sound
  Configuration for the sound.
StoredDocumentIDsResult
StyledText
  Configuration of the text field appearance.
SwipeToDelete
  Configuration of the swipe-to-delete button.
TextButtonMode
  Configuration of the 'preview' button in 'text button mode'.
TIFFFromDocumentParams
Timeouts
  Configuration of timeouts.
TopBarConfiguration
  Configuration of the top bar's appearance.
UserGuidanceConfiguration
  Configuration of the hint guiding users through the scanning process.
UserGuidanceStates
  Configure the titles of the user guidance hints for different states.
Vibration
  Configure the vibration.
ViewFinderConfiguration
  Configuration of the scanning interface's viewfinder, serving as guidance to the user.
ZoomOverlay
  Configuration of the zoom overlay for the review screen.

## Enums

AcknowledgementMode
  Determines, after each page is snapped, whether the acknowledgment screen should be displayed or not.
AustraliaPostCustomerFormat
  The customer format used in AUSTRALIA_POST codes. Only relevant for format codes 59 and 62.
BarcodeDocumentFormat
  Type of barcode document format used.
BarcodeFormat
  Barcode symbology used.
BarcodeItemInfoPosition
  Where to display the barcode info box in the camera preview.
BarcodesExtensionFilter
  Filter for extended EAN and UPC barcodes.
CameraModule
  Determines which camera module to use on start-up.
CameraPreviewMode
  Configuration of the camera preview mode.
CapturePhotoQualityPrioritization
  Determines the prioritization of still image quality and capturing speed.
CollapsedVisibleHeight
  Configuration of the barcodes result sheet's height while collapsed.
DocumentAnalysisMode
  Determines if the quality analysis for the acknowledgement mode will run on the filtered or the unfiltered image.
DocumentDetectionStatus
  The status of the document detection.
DocumentQuality
  The result of the document quality check.
Gs1Handling
  GS1_COMPOSITE barcode type handling
MSIPlesseyChecksumAlgorithm
  Type of MSI plessey checksum algorithm used.
MultipleBarcodesScanningMode
  Configuration of the mode used for scanning multiple barcodes.
OperationStatus
OrientationLockMode
  Configure the orientation of the interface.
PageImageSource
  The source of an image.
PageRotation
SheetMode
  Configuration of the barcode result sheet's default visibility state.
SoundType
  Determines the successful detection sound.
StatusBarMode
  The visual mode used for the status bar icons.
TopBarMode
  The visual mode used for the top bar.
UserGuidanceVisibility
  Determines the visibility mode for the document capturing user guidance labels.

## Extensions

OperationStatusExtension on OperationStatus