Android Scanbot SDK API reference/io.scanbot.sdk.ui_v2.document.configuration

Package-level declarations

Types

Link copied to clipboard
data class AcknowledgementBottomBar(var retakeButton: BarButtonConfiguration = BarButtonConfiguration( title = StyledText( text = "?acknowledgementRetakeButtonTitle", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), accessibilityDescription = "?accessibilityDescriptionAcknowledgementRetakeButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), icon = IconStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), var acceptWhenOkButton: BarButtonConfiguration = BarButtonConfiguration( title = StyledText( text = "?acknowledgementAcceptButtonTitle", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), accessibilityDescription = "?accessibilityDescriptionAcknowledgementAcceptButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), icon = IconStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), var acceptWhenNotOkButton: BarButtonConfiguration = BarButtonConfiguration( title = StyledText( text = "?acknowledgementAcceptButtonTitle", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), accessibilityDescription = "?accessibilityDescriptionAcknowledgementAcceptButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), icon = IconStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) )) : Parcelable

Configuration of the bottom bar for the acknowledgement screen.

Link copied to clipboard
enum AcknowledgementMode : Enum<AcknowledgementMode>

Determines, after each page is snapped, whether the acknowledgment screen should be displayed or not.

Link copied to clipboard
data class AcknowledgementScreenConfiguration(var topBarTitle: StyledText = StyledText( visible = false, text = "?acknowledgementTitle", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), var minimumQuality: DocumentQuality = DocumentQuality.POOR, var acknowledgementMode: AcknowledgementMode = AcknowledgementMode.ALWAYS, var badImageHint: IconUserGuidanceConfiguration = IconUserGuidanceConfiguration( visible = true, icon = IconStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), title = StyledText( text = "?acknowledgementScreenBadDocumentHint", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), background = BackgroundStyle( strokeColor = ScanbotColor("?sbColorNegative", isArgb = false), fillColor = ScanbotColor("?sbColorNegative", isArgb = false), strokeWidth = 0.0 ) ), var backgroundColor: ScanbotColor = ScanbotColor("?sbColorOutline", isArgb = false), var bottomBar: AcknowledgementBottomBar = AcknowledgementBottomBar( )) : Parcelable

Configuration of the acknowledgement screen.

Link copied to clipboard
data class CameraBottomBar(var importButton: BarButtonConfiguration = BarButtonConfiguration( title = StyledText( visible = false, text = "?cameraImportButtonTitle", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), accessibilityDescription = "?accessibilityDescriptionCameraImportButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), icon = IconStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), var autoSnappingModeButton: BarButtonConfiguration = BarButtonConfiguration( title = StyledText( visible = false, text = "?cameraAutoSnapButtonTitle", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), accessibilityDescription = "?accessibilityDescriptionCameraAutoSnapButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), icon = IconStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), var manualSnappingModeButton: BarButtonConfiguration = BarButtonConfiguration( title = StyledText( visible = false, text = "?cameraManualSnapButtonTitle", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), accessibilityDescription = "?accessibilityDescriptionCameraManualSnapButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), icon = IconStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), var shutterButton: ShutterButton = ShutterButton( accessibilityDescription = "?accessibilityDescriptionCameraShutterButton" ), var torchOnButton: BarButtonConfiguration = BarButtonConfiguration( title = StyledText( visible = false, text = "?cameraTorchOnButtonTitle", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), accessibilityDescription = "?accessibilityDescriptionCameraTorchOnButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), icon = IconStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), var torchOffButton: BarButtonConfiguration = BarButtonConfiguration( title = StyledText( visible = false, text = "?cameraTorchOffButtonTitle", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), accessibilityDescription = "?accessibilityDescriptionCameraTorchOffButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), icon = IconStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), var previewButton: PreviewButton = PagePreviewMode( )) : Parcelable

Configuration of the bottom bar for the camera screen.

Link copied to clipboard
data class CameraScreenConfiguration(var acknowledgement: AcknowledgementScreenConfiguration = AcknowledgementScreenConfiguration( ), var introduction: IntroductionScreenConfiguration = IntroductionScreenConfiguration( ), var scanAssistanceOverlay: ScanAssistanceOverlay = ScanAssistanceOverlay( ), var cameraPermission: CameraPermissionScreen = CameraPermissionScreen( statusBarMode = StatusBarMode.DARK, background = ScanbotColor("?sbColorSurface", isArgb = false), iconBackground = ScanbotColor("?sbColorOutline", isArgb = false), icon = IconStyle( visible = true, color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), enableCameraButton = ButtonConfiguration( visible = true, text = "?cameraPermissionEnableCameraButton", accessibilityDescription = "?accessibilityDescriptionCameraPermissionEnableCameraButton", background = BackgroundStyle( strokeColor = ScanbotColor("?sbColorPrimary", isArgb = false), fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), closeButton = ButtonConfiguration( visible = true, text = "?cameraPermissionCloseButton", accessibilityDescription = "?accessibilityDescriptionCameraPermissionCloseButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = false, color = ScanbotColor("?sbColorPrimary", isArgb = false), useShadow = false ) ), enableCameraTitle = StyledText( text = "?cameraPermissionEnableCameraTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), enableCameraExplanation = StyledText( text = "?cameraPermissionEnableCameraExplanation", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ) ), var topBarTitle: StyledText = StyledText( text = "?cameraTopBarTitle", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), var topBarIntroButton: IconButton = IconButton( color = ScanbotColor("?sbColorOnPrimary", isArgb = false), accessibilityDescription = "?accessibilityDescriptionCameraTopBarIntroButton" ), var topBarBackButton: ButtonConfiguration = ButtonConfiguration( visible = true, text = "?cameraTopBarCancelButtonTitle", accessibilityDescription = "?accessibilityDescriptionCameraTopBarCancelButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), var topUserGuidance: UserGuidanceConfiguration = UserGuidanceConfiguration( title = StyledText( text = "?cameraTopGuidance", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), var userGuidance: DocumentScannerUserGuidance = DocumentScannerUserGuidance( ), var backgroundColor: ScanbotColor = ScanbotColor("#000000FF", isArgb = false), var autoRotateImages: Boolean = true, var openReviewAfterEachScan: Boolean = false, var cameraConfiguration: DocumentScannerCameraConfiguration = DocumentScannerCameraConfiguration( ), var scannerParameters: DocumentScannerParameters = DocumentScannerParameters( ), var polygon: DocumentPolygonConfiguration = DocumentPolygonConfiguration( ), var bottomBar: CameraBottomBar = CameraBottomBar( ), var viewFinder: ViewFinderConfiguration = ViewFinderConfiguration( aspectRatio = AspectRatio( width = 21.0, height = 29.0 ), visible = false ), var captureFeedback: CaptureFeedback = CaptureFeedback( ), var vibration: Vibration = Vibration( enabled = true ), var timeouts: Timeouts = Timeouts( autoCancelTimeout = 0, initialScanDelay = 0 ), var limitReachedAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?cameraLimitReachedAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?cameraLimitReachedAlertSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), okButton = ButtonConfiguration( text = "?cameraLimitReachedOkButtonTitle", accessibilityDescription = "?accessibilityDescriptionCameraLimitReachedOkButton", background = BackgroundStyle( fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), cancelButton = ButtonConfiguration( visible = false ) ), var cancelAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?cameraCancelAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?cameraCancelAlertSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), okButton = ButtonConfiguration( text = "?cameraCancelYesButtonTitle", accessibilityDescription = "?accessibilityDescriptionCameraCancelYesButton", background = BackgroundStyle( fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), cancelButton = ButtonConfiguration( text = "?cameraCancelNoButtonTitle", accessibilityDescription = "?accessibilityDescriptionCameraCancelNoButton", background = BackgroundStyle( fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorPrimary", isArgb = false) ) ) )) : Parcelable

Configuration of the screen for scanning the pages with the camera.

Link copied to clipboard
data class CaptureFeedback(var cameraBlinkEnabled: Boolean = true, var snapFeedbackMode: PageSnapFeedbackMode = PageSnapFunnelAnimation( )) : Parcelable

Configuration of the feedback shown after snapping a page.

Link copied to clipboard
enum CapturePhotoQualityPrioritization : Enum<CapturePhotoQualityPrioritization>

Determines the prioritization of still image quality and capturing speed.

Link copied to clipboard
class CheckIntroImage : IntroImage, Parcelable

The image for the introduction screen with a check template.

Link copied to clipboard
class CreditCardIntroImage : IntroImage, Parcelable

The image for the introduction screen with a credit card template.

Link copied to clipboard
data class CroppingAppearanceConfiguration(var statusBarMode: StatusBarMode = StatusBarMode.LIGHT, var navigationBarMode: NavigationBarMode = NavigationBarMode.LIGHT, var topBarBackgroundColor: ScanbotColor = ScanbotColor("?sbColorPrimary", isArgb = false), var bottomBarBackgroundColor: ScanbotColor = ScanbotColor("?sbColorPrimary", isArgb = false), var orientationLockMode: OrientationLockMode = OrientationLockMode.NONE) : Parcelable

Configuration of the general appearance for the cropping screen.

Link copied to clipboard
data class CroppingBottomBar(var detectButton: BarButtonConfiguration = BarButtonConfiguration( title = StyledText( text = "?croppingDetectButtonTitle", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), accessibilityDescription = "?accessibilityDescriptionCroppingDetectButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), icon = IconStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), var rotateButton: BarButtonConfiguration = BarButtonConfiguration( title = StyledText( text = "?croppingRotateButtonTitle", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), accessibilityDescription = "?accessibilityDescriptionCroppingRotateButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), icon = IconStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), var resetButton: BarButtonConfiguration = BarButtonConfiguration( title = StyledText( text = "?croppingResetButtonTitle", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), accessibilityDescription = "?accessibilityDescriptionCroppingResetButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), icon = IconStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) )) : Parcelable

Configuration of the bottom bar for the cropping screen.

Link copied to clipboard
data class CroppingConfiguration(var version: String = "1.0", var screen: String = "CroppingConfiguration", var palette: Palette = Palette( sbColorPrimary = ScanbotColor("#C8193C", isArgb = false), sbColorPrimaryDisabled = ScanbotColor("#F5F5F5", isArgb = false), sbColorNegative = ScanbotColor("#FF3737", isArgb = false), sbColorPositive = ScanbotColor("#4EFFB4", isArgb = false), sbColorWarning = ScanbotColor("#FFCE5C", isArgb = false), sbColorSecondary = ScanbotColor("#FFEDEE", isArgb = false), sbColorSecondaryDisabled = ScanbotColor("#F5F5F5", isArgb = false), sbColorOnPrimary = ScanbotColor("#FFFFFF", isArgb = false), sbColorOnSecondary = ScanbotColor("#C8193C", isArgb = false), sbColorSurface = ScanbotColor("#FFFFFF", isArgb = false), sbColorOutline = ScanbotColor("#EFEFEF", isArgb = false), sbColorOnSurfaceVariant = ScanbotColor("#707070", isArgb = false), sbColorOnSurface = ScanbotColor("#000000", isArgb = false), sbColorSurfaceLow = ScanbotColor("#00000026", isArgb = false), sbColorSurfaceHigh = ScanbotColor("#0000007A", isArgb = false), sbColorModalOverlay = ScanbotColor("#000000A3", isArgb = false) ), var documentUuid: String, var pageUuid: String, var localization: CroppingTextLocalization = CroppingTextLocalization( ), var appearance: CroppingAppearanceConfiguration = CroppingAppearanceConfiguration( ), var cropping: CroppingScreenConfiguration = CroppingScreenConfiguration( ), var documentAnalysisMode: DocumentAnalysisMode = DocumentAnalysisMode.UNFILTERED_DOCUMENT) : Parcelable

Configuration of the standalone cropping screen.

Link copied to clipboard
data class CroppingResult(val documentUuid: String, val pageUuid: String, val errorMessage: String? = null) : Parcelable

Configuration of the cropping result.

Link copied to clipboard
data class CroppingScreenConfiguration(var topBarBackButton: ButtonConfiguration = ButtonConfiguration( visible = true, text = "?croppingTopBarCancelButtonTitle", accessibilityDescription = "?accessibilityDescriptionCroppingTopBarCancelButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), var topBarTitle: StyledText = StyledText( text = "?croppingScreenTitle", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), var topBarConfirmButton: ButtonConfiguration = ButtonConfiguration( visible = true, text = "?croppingTopBarConfirmButtonTitle", accessibilityDescription = "?accessibilityDescriptionCroppingTopBarConfirmButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), var backgroundColor: ScanbotColor = ScanbotColor("?sbColorOutline", isArgb = false), var croppingHandlerColor: ScanbotColor = ScanbotColor("?sbColorSurface", isArgb = false), var croppingPolygonColor: ScanbotColor = ScanbotColor("?sbColorSurface", isArgb = false), var croppingPolygonMagneticLineColor: ScanbotColor = ScanbotColor("?sbColorSurface", isArgb = false), var bottomBar: CroppingBottomBar = CroppingBottomBar( )) : Parcelable

Configuration of the screen for cropping the scanned pages.

Link copied to clipboard
data class CroppingTextLocalization(var cameraProgressOverlayTitle: String = "Please wait...", var croppingTopBarCancelButtonTitle: String = "Cancel", var croppingTopBarConfirmButtonTitle: String = "Done", var croppingDetectButtonTitle: String = "Detect", var croppingRotateButtonTitle: String = "Rotate", var croppingResetButtonTitle: String = "Reset", var croppingScreenTitle: String = "Crop", var accessibilityDescriptionCroppingTopBarConfirmButton: String = "Tap to apply changes", var accessibilityDescriptionCroppingTopBarCancelButton: String = "Tap to close screen without applying changes", var accessibilityDescriptionCroppingDetectButton: String = "Tap to detect document on the image", var accessibilityDescriptionCroppingRotateButton: String = "Tap to rotate document", var accessibilityDescriptionCroppingResetButton: String = "Tap to reset document contour to whole image") : Parcelable

Configuration of all the strings for the standalone cropping screen.

Link copied to clipboard
data class CustomImage(var uri: String) : IntroImage, Parcelable

A custom image for the introduction screen.

Link copied to clipboard
enum DocumentAnalysisMode : Enum<DocumentAnalysisMode>

Determines if the quality analysis for the acknowledgement mode will run on the filtered or the unfiltered image.

Link copied to clipboard
data class DocumentFlowAppearanceConfiguration(var statusBarMode: StatusBarMode = StatusBarMode.LIGHT, var navigationBarMode: NavigationBarMode = NavigationBarMode.LIGHT, var topBarBackgroundColor: ScanbotColor = ScanbotColor("?sbColorPrimary", isArgb = false), var bottomBarBackgroundColor: ScanbotColor = ScanbotColor("?sbColorPrimary", isArgb = false), var orientationLockMode: OrientationLockMode = OrientationLockMode.NONE) : Parcelable

Configuration of the general appearance.

Link copied to clipboard
class DocumentIntroImage : IntroImage, Parcelable

The image for the introduction screen with a document template.

Link copied to clipboard
data class DocumentNativeConfiguration(val testField: Boolean = false)

Android native configuration for the scanner.

Link copied to clipboard
data class DocumentPolygonConfiguration(var visibility: UserGuidanceVisibility = UserGuidanceVisibility.ENABLED, var documentOk: PolygonStyle = PolygonStyle( strokeColor = ScanbotColor("?sbColorPositive", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 2.0 ), var documentNotOk: PolygonStyle = PolygonStyle( strokeColor = ScanbotColor("?sbColorNegative", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 2.0 ), var autoSnapProgress: PolygonStyle = PolygonStyle( strokeColor = ScanbotColor("#40A9FF", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 2.0 )) : Parcelable

Configuration of the document contour detection polygon.

Link copied to clipboard
data class DocumentScannerCameraConfiguration(var cameraModule: CameraModule = CameraModule.BACK, var defaultZoomFactor: Double = 1.0, var autoCropOnManualSnap: Boolean = true, var flashEnabled: Boolean = false, var minFocusDistanceLock: Boolean = false, var touchToFocusEnabled: Boolean = false, var pinchToZoomEnabled: Boolean = true, var cameraPreviewMode: CameraPreviewMode = CameraPreviewMode.FILL_IN, var captureQualityPrioritization: CapturePhotoQualityPrioritization = CapturePhotoQualityPrioritization.BALANCED, var autoSnappingSensitivity: Double = 0.66, var autoSnappingDelay: Int = 200, var autoSnappingEnabled: Boolean = true, var captureWithHardwareButtonsEnabled: Boolean = true, var fpsLimit: Int = 20) : Parcelable

Configuration of the camera behavior.

Link copied to clipboard
data class DocumentScannerOutputSettings(var pagesScanLimit: Int = 0, var documentImageSizeLimit: Int = 0, var documentAnalysisMode: DocumentAnalysisMode = DocumentAnalysisMode.UNFILTERED_DOCUMENT, var defaultFilter: ParametricFilter? = null) : Parcelable

Configuration of the output settings.

Link copied to clipboard
data class DocumentScannerScreens(var camera: CameraScreenConfiguration = CameraScreenConfiguration( ), var review: ReviewScreenConfiguration = ReviewScreenConfiguration( ), var cropping: CroppingScreenConfiguration = CroppingScreenConfiguration( ), var reorderPages: ReorderPagesScreenConfiguration = ReorderPagesScreenConfiguration( )) : Parcelable

Configuration of the document scanner sub-screens.

Link copied to clipboard
data class DocumentScannerTextLocalization(var cameraTopBarCancelButtonTitle: String = "Cancel", var cameraTopBarTitle: String = "Scan Document", var cameraTopGuidance: String = "Scan each page of your document.", var cameraUserGuidanceStart: String = "Please hold your device over a document.", var cameraUserGuidanceNoDocumentFound: String = "No document found", var cameraUserGuidanceBadAspectRatio: String = "Bad aspect ratio", var cameraUserGuidanceOrientationMismatch: String = "Orientation mismatch", var cameraUserGuidanceBadAngles: String = "Bad angles", var cameraUserGuidanceTooNoisy: String = "Its too noisy. Try another background for the document", var cameraUserGuidanceTextHintOffCenter: String = "Document is off center", var cameraUserGuidanceTooSmall: String = "Document is too small. Move camera closer.", var cameraUserGuidanceTooDark: String = "Its too dark. Add more light.", var cameraUserGuidanceEnergySaveMode: String = "Energy save mode is on", var cameraUserGuidanceReadyToCapture: String = "Hold still capturing...", var cameraUserGuidanceReadyToCaptureManual: String = "Ready to capture!", var cameraImportButtonTitle: String = "Import", var cameraTorchOnButtonTitle: String = "On", var cameraTorchOffButtonTitle: String = "Off", var cameraAutoSnapButtonTitle: String = "Auto", var cameraManualSnapButtonTitle: String = "Manual", var cameraPreviewButtonTitle: String = "%d Pages", var cameraIntroDoneButton: String = "Done", var cameraIntroTitle: String = "How to scan a document", var cameraIntroSubtitle: String = "Follow the steps below to create a high-quality document scan", var cameraIntroItem1: String = "1. Place your document on a flat surface.", var cameraIntroItem2: String = "2. Hold your phone above the document.", var cameraIntroItem3: String = "3. Follow the on-screen guidance to find the optimal position.", var cameraIntroItem4: String = "4. Once you reach the optimal position, you can manually scan the document or let the app scan it automatically.", var cameraProgressOverlayTitle: String = "Please wait...", var cameraCancelAlertTitle: String = "Cancel?", var cameraCancelAlertSubtitle: String = "Canceling will delete all the pages scanned so far. Are you sure you want to cancel?", var cameraCancelNoButtonTitle: String = "No", var cameraCancelYesButtonTitle: String = "Yes, Cancel", var cameraLimitReachedAlertTitle: String = "You reached the limit!", var cameraLimitReachedAlertSubtitle: String = "You have scanned the maximum number of pages and cannot add any more. Please delete at least one page to perform a new scan.", var cameraLimitReachedOkButtonTitle: String = "Ok", var acknowledgementScreenBadDocumentHint: String = "The quality of your scan does not seem sufficient.", var acknowledgementRetakeButtonTitle: String = "Retake", var acknowledgementAcceptButtonTitle: String = "Use Scan", var reviewScreenTitle: String = "Review (%d)", var reviewTopBarBackButtonTitle: String = "Back", var reviewScreenPageCount: String = "Page %d/%d", var reviewScreenAddButtonTitle: String = "Add", var reviewScreenRetakeButtonTitle: String = "Retake", var reviewScreenCropButtonTitle: String = "Crop", var reviewScreenRotateButtonTitle: String = "Rotate", var reviewScreenDeleteButtonTitle: String = "Delete", var reviewScreenSubmitButtonTitle: String = "Submit", var reviewScreenDeleteAllButtonTitle: String = "Delete all", var reviewScreenReorderPagesButtonTitle: String = "Reorder pages", var zoomOverlayCancelButtonText: String = "Close", var reviewDeletePageAlertTitle: String = "Delete page?", var reviewDeleteAllPagesAlertTitle: String = "Delete all?", var reviewDeletePageAlertSubTitle: String = "Are you sure you want to delete the page?", var reviewDeleteAllPagesAlertSubtitle: String = "Are you sure you want to delete all pages?", var reviewDeletePageAlertConfirmButtonTitle: String = "Yes, Delete", var reviewDeleteAllPagesAlertDeleteButtonTitle: String = "Yes, Delete all", var reviewDeletePageAlertDeleteRetakeButtonTitle: String = "Delete and Retake", var reviewDeletePageAlertCancelButtonTitle: String = "Cancel", var reviewDeleteAllPagesAlertCancelButtonTitle: String = "Cancel", var acknowledgementTitle: String = "Acknowledgement", var reorderPageTitle: String = "Reorder Pages", var reorderPageGuidanceTitle: String = "Drag pages to reorder", var reorderPageText: String = "%d", var reorderTopBarConfirmButtonTitle: String = "Done", var reorderTopBarCancelButtonTitle: String = "Cancel", var croppingTopBarConfirmButtonTitle: String = "Done", var croppingTopBarCancelButtonTitle: String = "Cancel", var croppingDetectButtonTitle: String = "Detect", var croppingRotateButtonTitle: String = "Rotate", var croppingResetButtonTitle: String = "Reset", var croppingScreenTitle: String = "Crop", var accessibilityDescriptionCameraTopBarIntroButton: String = "Tap to open introduction screen", var accessibilityDescriptionCameraTopBarCancelButton: String = "Tap to close scanner screen", var accessibilityDescriptionCameraImportButton: String = "Tap to import image", var accessibilityDescriptionCameraTorchOnButton: String = "Tap to disable torch", var accessibilityDescriptionCameraTorchOffButton: String = "Tap to enable torch", var accessibilityDescriptionCameraShutterButton: String = "Tap to take image", var accessibilityDescriptionCameraAutoSnapButton: String = "Tap to enable manual snapping mode", var accessibilityDescriptionCameraManualSnapButton: String = "Tap to enable auto snapping mode", var accessibilityDescriptionCameraPreviewButton: String = "Tap to preview scanned pages", var accessibilityDescriptionCameraIntroDoneButton: String = "Tap to close introduction screen", var accessibilityDescriptionAcknowledgementRetakeButton: String = "Tap to retake the image", var accessibilityDescriptionAcknowledgementAcceptButton: String = "Tap to accept the image regardless of its quality", var accessibilityDescriptionCroppingTopBarConfirmButton: String = "Tap to apply changes", var accessibilityDescriptionCroppingTopBarCancelButton: String = "Tap to close screen without applying changes", var accessibilityDescriptionCroppingDetectButton: String = "Tap to detect document on the image", var accessibilityDescriptionCroppingRotateButton: String = "Tap to rotate document", var accessibilityDescriptionCroppingResetButton: String = "Tap to reset document contour to whole image", var accessibilityDescriptionReorderTopBarConfirmButton: String = "Tap to apply changes", var accessibilityDescriptionReorderTopBarCancelButton: String = "Tap to close screen without applying changes", var accessibilityDescriptionReviewNextPageButton: String = "Tap to switch to the new page", var accessibilityDescriptionReviewPreviousPageButton: String = "Tap to switch to the previous page", var accessibilityDescriptionReviewAddButton: String = "Tap to Add new page", var accessibilityDescriptionReviewRetakeButton: String = "Tap to Retake current selected page", var accessibilityDescriptionReviewCropButton: String = "Tap to Crop selected page", var accessibilityDescriptionReviewRotateButton: String = "Tap to Rotate selected page clockwise", var accessibilityDescriptionReviewDeleteButton: String = "Tap to Delete selected page", var accessibilityDescriptionReviewSubmitButton: String = "Tap to Submit document", var accessibilityDescriptionReviewMoreButton: String = "Tap to show additional options", var accessibilityDescriptionReviewDeleteAllButton: String = "Tap to Delete all pages", var accessibilityDescriptionReviewReorderPagesButton: String = "Tap to Reorder pages", var accessibilityDescriptionZoomOverlayCancelButton: String = "Tap to Close zoom overlay", var accessibilityDescriptionReviewZoomButton: String = "Tap to open zoom overlay for selected page", var accessibilityDescriptionReviewTopBarBackButton: String = "Tap to Close review screen", var accessibilityDescriptionReviewDeletePageAlertConfirmButton: String = "Tap to Delete page", var accessibilityDescriptionReviewDeleteAllPagesAlertDeleteButton: String = "Tap to Delete all pages", var accessibilityDescriptionReviewDeletePageAlertDeleteRetakeButton: String = "Tap to Delete page and Retake it", var accessibilityDescriptionReviewDeletePageAlertCancelButton: String = "Tap to Cancel operation", var accessibilityDescriptionReviewDeleteAllPagesAlertCancelButton: String = "Tap to Cancel operation", var accessibilityDescriptionCameraLimitReachedOkButton: String = "Tap to close alert dialog", var accessibilityDescriptionCameraCancelYesButton: String = "Tap to cancel document", var accessibilityDescriptionCameraCancelNoButton: String = "Tap to close alert dialog", var cameraPermissionEnableCameraTitle: String = "Camera permission denied!", var cameraPermissionEnableCameraExplanation: String = "Please allow the usage of the camera to start the scanning process.", var cameraPermissionEnableCameraButton: String = "Grant permission", var cameraPermissionCloseButton: String = "Close", var accessibilityDescriptionCameraPermissionEnableCameraButton: String = "Tap to grant camera permission", var accessibilityDescriptionCameraPermissionCloseButton: String = "Close screen without granting permission") : Parcelable

Configuration of all the strings for the standalone cropping screen.

Link copied to clipboard
data class DocumentScannerUserGuidance(var visibility: UserGuidanceVisibility = UserGuidanceVisibility.ENABLED, var title: StyledText = StyledText( text = "?cameraUserGuidanceStart", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), var background: BackgroundStyle = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false) ), var statesTitles: UserGuidanceStates = UserGuidanceStates( )) : Parcelable

Configuration of the hints guiding users through the scanning process.

Link copied to clipboard
data class DocumentScanningFlow(var version: String = "1.0", var screen: String = "DocumentScanner", var palette: Palette = Palette( sbColorPrimary = ScanbotColor("#C8193C", isArgb = false), sbColorPrimaryDisabled = ScanbotColor("#F5F5F5", isArgb = false), sbColorNegative = ScanbotColor("#FF3737", isArgb = false), sbColorPositive = ScanbotColor("#4EFFB4", isArgb = false), sbColorWarning = ScanbotColor("#FFCE5C", isArgb = false), sbColorSecondary = ScanbotColor("#FFEDEE", isArgb = false), sbColorSecondaryDisabled = ScanbotColor("#F5F5F5", isArgb = false), sbColorOnPrimary = ScanbotColor("#FFFFFF", isArgb = false), sbColorOnSecondary = ScanbotColor("#C8193C", isArgb = false), sbColorSurface = ScanbotColor("#FFFFFF", isArgb = false), sbColorOutline = ScanbotColor("#EFEFEF", isArgb = false), sbColorOnSurfaceVariant = ScanbotColor("#707070", isArgb = false), sbColorOnSurface = ScanbotColor("#000000", isArgb = false), sbColorSurfaceLow = ScanbotColor("#00000026", isArgb = false), sbColorSurfaceHigh = ScanbotColor("#0000007A", isArgb = false), sbColorModalOverlay = ScanbotColor("#000000A3", isArgb = false) ), var localization: DocumentScannerTextLocalization = DocumentScannerTextLocalization( ), var appearance: DocumentFlowAppearanceConfiguration = DocumentFlowAppearanceConfiguration( ), var outputSettings: DocumentScannerOutputSettings = DocumentScannerOutputSettings( ), var screens: DocumentScannerScreens = DocumentScannerScreens( ), var documentUuid: String? = null, var cleanScanningSession: Boolean = true, var showReviewScreenOnStart: Boolean = false, var keepScreenOn: Boolean = true) : Parcelable

Configuration of the document scanner screen.

Link copied to clipboard
class IdCardIntroImage : IntroImage, Parcelable

The image for the introduction screen with an ID card template.

Link copied to clipboard
data class IntroductionScreenConfiguration(var backgroundColor: ScanbotColor = ScanbotColor("?sbColorSurface", isArgb = false), var dividerColor: ScanbotColor = ScanbotColor("?sbColorOutline", isArgb = false), var handlerColor: ScanbotColor = ScanbotColor("?sbColorOutline", isArgb = false), var showAutomatically: Boolean = false, var topBarDoneButton: ButtonConfiguration = ButtonConfiguration( visible = true, text = "?cameraIntroDoneButton", accessibilityDescription = "?accessibilityDescriptionCameraIntroDoneButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorPrimary", isArgb = false), useShadow = false ) ), var title: StyledText = StyledText( text = "?cameraIntroTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), var subtitle: StyledText = StyledText( text = "?cameraIntroSubtitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), var items: List<IntroListEntry> = listOf( IntroListEntry( image = DocumentIntroImage( ), text = StyledText( text = "?cameraIntroItem1", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ) ), IntroListEntry( image = NoIntroImage( ), text = StyledText( text = "?cameraIntroItem2", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ) ), IntroListEntry( image = NoIntroImage( ), text = StyledText( text = "?cameraIntroItem3", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ) ), IntroListEntry( image = NoIntroImage( ), text = StyledText( text = "?cameraIntroItem4", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ) ) )) : Parcelable

Configuration of the introduction screen for the document scanner.

Link copied to clipboard
sealed class IntroImage : Parcelable

Determines the image for the introduction screen.

Link copied to clipboard
data class IntroListEntry(var image: IntroImage = NoIntroImage( ), var text: StyledText = StyledText( text = "?cameraIntroDescription", color = ScanbotColor("?sbColorOnSurface", isArgb = false) )) : Parcelable

An entry in the list of scanning steps of the introduction screen.

Link copied to clipboard
class KeyCodeLocalRegister(val mappedStrings: MutableMap<String, OnKeyCodeListener> = mutableMapOf())

Android native configuration for the scanner.

Link copied to clipboard
class MedicalCertificateIntroImage : IntroImage, Parcelable

The image for the introduction screen with a medical certificate template.

Link copied to clipboard
data class NoButtonMode(val visible: Boolean = false) : PreviewButton, Parcelable

Configuration of the 'preview' button in 'no button mode'.

Link copied to clipboard
class NoIntroImage : IntroImage, Parcelable

No image for the introduction screen.

Link copied to clipboard
class OnKeyCodeListener(val onKeyCode: (keyEvent: KeyEvent) -> Boolean = { false })
Link copied to clipboard
data class PagePreviewMode(var accessibilityDescription: String = "?accessibilityDescriptionCameraPreviewButton", var imagePlaceholderColor: ScanbotColor = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false), var pageCounter: BadgeStyle = BadgeStyle( visible = true, background = BackgroundStyle( strokeColor = ScanbotColor("?sbColorSurface", isArgb = false), fillColor = ScanbotColor("?sbColorSurface", isArgb = false) ), foregroundColor = ScanbotColor("?sbColorPrimary", isArgb = false) )) : PreviewButton, Parcelable

Configuration of the 'preview' button in 'page preview mode'.

Link copied to clipboard
data class PageSnapCheckMarkAnimation(var overlayColor: ScanbotColor = ScanbotColor("?sbColorModalOverlay", isArgb = false), var checkMarkBackgroundColor: ScanbotColor = ScanbotColor("?sbColorOutline", isArgb = false), var checkMarkColor: ScanbotColor = ScanbotColor("#00000000", isArgb = false)) : PageSnapFeedbackMode, Parcelable

Configuration of the check mark animation.

Link copied to clipboard
sealed class PageSnapFeedbackMode : Parcelable

The type of animation to display after snapping a page.

Link copied to clipboard
class PageSnapFeedbackNone : PageSnapFeedbackMode, Parcelable

To not use a snap animation.

Link copied to clipboard
data class PageSnapFunnelAnimation(var overlayColor: ScanbotColor = ScanbotColor("?sbColorModalOverlay", isArgb = false)) : PageSnapFeedbackMode, Parcelable

Configuration of the funnel animation.

Link copied to clipboard
sealed class PreviewButton : Parcelable

Configuration of the 'preview' button.

Link copied to clipboard
class ReceiptsIntroImage : IntroImage, Parcelable

The image for the introduction screen with a receipt template.

Link copied to clipboard
data class ReorderPagesScreenConfiguration(var topBarBackButton: ButtonConfiguration = ButtonConfiguration( visible = true, text = "?reorderTopBarCancelButtonTitle", accessibilityDescription = "?accessibilityDescriptionReorderTopBarCancelButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), var topBarTitle: StyledText = StyledText( text = "?reorderPageTitle", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), var topBarConfirmButton: ButtonConfiguration = ButtonConfiguration( visible = true, text = "?reorderTopBarConfirmButtonTitle", accessibilityDescription = "?accessibilityDescriptionReorderTopBarConfirmButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), var backgroundColor: ScanbotColor = ScanbotColor("?sbColorOutline", isArgb = false), var guidance: UserGuidanceConfiguration = UserGuidanceConfiguration( title = StyledText( text = "?reorderPageGuidanceTitle", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("?sbColorSurfaceLow", isArgb = false), strokeWidth = 0.0 ) ), var pageTextStyle: StyledText = StyledText( text = "?reorderPageText", color = ScanbotColor("?sbColorOnSurface", isArgb = false) )) : Parcelable

Configuration of the screen for reordering the scanned pages.

Link copied to clipboard
data class ReviewBottomBarConfiguration(var addButton: BarButtonConfiguration = BarButtonConfiguration( title = StyledText( text = "?reviewScreenAddButtonTitle", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), accessibilityDescription = "?accessibilityDescriptionReviewAddButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), icon = IconStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), var retakeButton: BarButtonConfiguration = BarButtonConfiguration( title = StyledText( text = "?reviewScreenRetakeButtonTitle", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), accessibilityDescription = "?accessibilityDescriptionReviewRetakeButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), icon = IconStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), var cropButton: BarButtonConfiguration = BarButtonConfiguration( title = StyledText( text = "?reviewScreenCropButtonTitle", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), accessibilityDescription = "?accessibilityDescriptionReviewCropButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), icon = IconStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), var rotateButton: BarButtonConfiguration = BarButtonConfiguration( title = StyledText( text = "?reviewScreenRotateButtonTitle", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), accessibilityDescription = "?accessibilityDescriptionReviewRotateButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), icon = IconStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), var deleteButton: BarButtonConfiguration = BarButtonConfiguration( title = StyledText( text = "?reviewScreenDeleteButtonTitle", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), accessibilityDescription = "?accessibilityDescriptionReviewDeleteButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), icon = IconStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), var submitButton: ButtonConfiguration = ButtonConfiguration( text = "?reviewScreenSubmitButtonTitle", accessibilityDescription = "?accessibilityDescriptionReviewSubmitButton", background = BackgroundStyle( strokeColor = ScanbotColor("?sbColorSurface", isArgb = false), fillColor = ScanbotColor("?sbColorSurface", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorOnSurface", isArgb = false) ) )) : Parcelable

Configuration of the bottom bar for the review screen.

Link copied to clipboard
data class ReviewMorePopupMenu(var backgroundColor: ScanbotColor = ScanbotColor("?sbColorSurface", isArgb = false), var reorderPages: PopupMenuItem = PopupMenuItem( title = StyledText( text = "?reviewScreenReorderPagesButtonTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), accessibilityDescription = "?accessibilityDescriptionReviewReorderPagesButton", icon = IconStyle( color = ScanbotColor("?sbColorOnSurface", isArgb = false) ) ), var deleteAll: PopupMenuItem = PopupMenuItem( title = StyledText( text = "?reviewScreenDeleteAllButtonTitle", color = ScanbotColor("?sbColorNegative", isArgb = false) ), accessibilityDescription = "?accessibilityDescriptionReviewDeleteAllButton", icon = IconStyle( color = ScanbotColor("?sbColorNegative", isArgb = false) ) )) : Parcelable

Configuration of the 'more' popup menu for the review screen.

Link copied to clipboard
data class ReviewScreenConfiguration(var enabled: Boolean = true, var showLastPageWhenAdding: Boolean = false, var topBarTitle: StyledText = StyledText( text = "?reviewScreenTitle", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), var topBarMoreButton: IconButton = IconButton( color = ScanbotColor("?sbColorOnPrimary", isArgb = false), accessibilityDescription = "?accessibilityDescriptionReviewMoreButton" ), var topBarBackButton: ButtonConfiguration = ButtonConfiguration( visible = true, text = "?reviewTopBarBackButtonTitle", accessibilityDescription = "?accessibilityDescriptionReviewTopBarBackButton", background = BackgroundStyle( strokeColor = ScanbotColor("#00000000", isArgb = false), fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( iconVisible = true, color = ScanbotColor("?sbColorOnPrimary", isArgb = false), useShadow = false ) ), var morePopup: ReviewMorePopupMenu = ReviewMorePopupMenu( ), var zoomButton: RoundButton = RoundButton( accessibilityDescription = "?accessibilityDescriptionReviewZoomButton", backgroundColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false), foregroundColor = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), var zoomOverlay: ZoomOverlay = ZoomOverlay( ), var backgroundColor: ScanbotColor = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false), var bottomBar: ReviewBottomBarConfiguration = ReviewBottomBarConfiguration( ), var switchNextPageButton: IconButton = IconButton( color = ScanbotColor("?sbColorOnPrimary", isArgb = false), accessibilityDescription = "?accessibilityDescriptionReviewNextPageButton" ), var switchPreviousPageButton: IconButton = IconButton( color = ScanbotColor("?sbColorOnPrimary", isArgb = false), accessibilityDescription = "?accessibilityDescriptionReviewPreviousPageButton" ), var pageCounter: UserGuidanceConfiguration = UserGuidanceConfiguration( title = StyledText( text = "?reviewScreenPageCount", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ), background = BackgroundStyle( fillColor = ScanbotColor("?sbColorSurfaceHigh", isArgb = false), strokeWidth = 0.0 ) ), var deleteAllPagesAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?reviewDeleteAllPagesAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?reviewDeleteAllPagesAlertSubtitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), okButton = ButtonConfiguration( text = "?reviewDeleteAllPagesAlertDeleteButtonTitle", accessibilityDescription = "?accessibilityDescriptionReviewDeleteAllPagesAlertDeleteButton", background = BackgroundStyle( fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), actionButton = ButtonConfiguration( visible = false ), cancelButton = ButtonConfiguration( text = "?reviewDeleteAllPagesAlertCancelButtonTitle", accessibilityDescription = "?accessibilityDescriptionReviewDeleteAllPagesAlertCancelButton", background = BackgroundStyle( fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorPrimary", isArgb = false) ) ) ), var deletePageAlertDialog: ScanbotAlertDialog = ScanbotAlertDialog( title = StyledText( text = "?reviewDeletePageAlertTitle", color = ScanbotColor("?sbColorOnSurface", isArgb = false) ), subtitle = StyledText( text = "?reviewDeletePageAlertSubTitle", color = ScanbotColor("?sbColorOnSurfaceVariant", isArgb = false) ), okButton = ButtonConfiguration( text = "?reviewDeletePageAlertConfirmButtonTitle", accessibilityDescription = "?accessibilityDescriptionReviewDeletePageAlertConfirmButton", background = BackgroundStyle( fillColor = ScanbotColor("?sbColorPrimary", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) ), actionButton = ButtonConfiguration( text = "?reviewDeletePageAlertDeleteRetakeButtonTitle", accessibilityDescription = "?accessibilityDescriptionReviewDeletePageAlertDeleteRetakeButton", background = BackgroundStyle( fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorPrimary", isArgb = false) ) ), cancelButton = ButtonConfiguration( text = "?reviewDeletePageAlertCancelButtonTitle", accessibilityDescription = "?accessibilityDescriptionReviewDeletePageAlertCancelButton", background = BackgroundStyle( fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorPrimary", isArgb = false) ) ) )) : Parcelable

Configuration of the screen for reviewing the scanned pages.

Link copied to clipboard
data class ScanAssistanceOverlay(var visible: Boolean = true, var backgroundColor: ScanbotColor = ScanbotColor("?sbColorModalOverlay", isArgb = false), var foregroundColor: ScanbotColor = ScanbotColor("?sbColorSurface", isArgb = false)) : Parcelable

Configuration of the scan assistance overlay.

Link copied to clipboard
data class ScanbotLocalTopBar(val title: () -> StyledText = { StyledText(false, "") }, val cancelButton: () -> ButtonConfiguration? = { null }, val cancelButtonIcon: () -> <Error class: unknown class> = { Icons.Default.Close }, val color: ScanbotColor = ScanbotColor("?sbColorPrimary"), val actions: <Error class: unknown class>.() -> Unit = {})
Link copied to clipboard
data class ShutterButton(var enabledInAutoSnappingMode: Boolean = true, var accessibilityDescription: String = "?accessibilityDescriptionCameraShutterButton", var outerColor: ScanbotColor = ScanbotColor("?sbColorOnPrimary", isArgb = false), var innerColor: ScanbotColor = ScanbotColor("?sbColorOnPrimary", isArgb = false)) : Parcelable

Configuration of the 'shutter' button.

Link copied to clipboard
data class TextButtonMode(var accessibilityDescription: String = "?accessibilityDescriptionCameraPreviewButton", var style: StyledText = StyledText( text = "?cameraPreviewButtonTitle", color = ScanbotColor("?sbColorOnPrimary", isArgb = false) )) : PreviewButton, Parcelable

Configuration of the 'preview' button in 'text button mode'.

Link copied to clipboard
data class UserGuidanceStates(var noDocumentFound: String = "?cameraUserGuidanceNoDocumentFound", var badAspectRatio: String = "?cameraUserGuidanceBadAspectRatio", var badAngles: String = "?cameraUserGuidanceBadAngles", var orientationMismatch: String = "?cameraUserGuidanceOrientationMismatch", var textHintOffCenter: String = "?cameraUserGuidanceTextHintOffCenter", var tooSmall: String = "?cameraUserGuidanceTooSmall", var tooNoisy: String = "?cameraUserGuidanceTooNoisy", var tooDark: String = "?cameraUserGuidanceTooDark", var energySaveMode: String = "?cameraUserGuidanceEnergySaveMode", var readyToCapture: String = "?cameraUserGuidanceReadyToCapture", var capturing: String = "?cameraUserGuidanceReadyToCapture", var captureManual: String = "?cameraUserGuidanceReadyToCaptureManual") : Parcelable

Configure the titles of the user guidance hints for different states.

Link copied to clipboard
enum UserGuidanceVisibility : Enum<UserGuidanceVisibility>

Determines the visibility mode for the document capturing user guidance labels.

Link copied to clipboard
data class ZoomOverlay(var overlayColor: ScanbotColor = ScanbotColor("?sbColorModalOverlay", isArgb = false), var closeButton: ButtonConfiguration = ButtonConfiguration( text = "?zoomOverlayCancelButtonText", accessibilityDescription = "?accessibilityDescriptionZoomOverlayCancelButton", background = BackgroundStyle( fillColor = ScanbotColor("#00000000", isArgb = false), strokeWidth = 0.0 ), foreground = ForegroundStyle( color = ScanbotColor("?sbColorOnPrimary", isArgb = false) ) )) : Parcelable

Configuration of the zoom overlay for the review screen.

Properties

Link copied to clipboard
val LocalDocumentAnimationMetadata: <Error class: unknown class>
Link copied to clipboard
val LocalDocumentNativeConfiguration: <Error class: unknown class>

Composition local for the DocumentNativeConfiguration.

Link copied to clipboard
val LocalKeyCodeProvider: <Error class: unknown class>

Composition local for the DocumentNativeConfiguration.

Functions

Link copied to clipboard
fun CroppingTextLocalization.mappedStrings(): MutableMap<String, String>
fun DocumentScannerTextLocalization.mappedStrings(): MutableMap<String, String>

Uses reflection to access all String fields of class and write field name and its value as a key-value pair into a map.

Link copied to clipboard
fun <Error class: unknown class>.registerKeyCodeHandler(key: String, onKeyCode: (keyEvent: KeyEvent) -> Boolean): <Error class: unknown class>
Link copied to clipboard
fun TopBar(config: ScanbotLocalTopBar, backButtonEnabled: Boolean = true, goBack: () -> Unit)