DocumentDataExtractorScreenTextLocalization

data class DocumentDataExtractorScreenTextLocalization(var topBarTitle: String = "Document Data Extractor", var topBarCancelButton: String = "Cancel", var topUserGuidance: String = "Point the camera at the ID document", var introScreenTitle: String = "How to scan an ID document", var introScreenDoneButton: String = "Start Scanning", var introScreenText: String = "To scan an ID, position the document within the frame, ensuring it's properly aligned and all key details are clearly visible. The scanner will then automatically extract essential information like name, date of birth, and document number. Once scanned, the data will be processed.", var completionOverlaySuccessMessage: String = "Scanned successfully", var accessibilityDescriptionOpenIntroScreenButton: String = "Open ID document scanning introduction", var accessibilityDescriptionIntroScreenDoneButton: String = "Start ID scanning", var accessibilityDescriptionCancelButton: String = "Cancel ID scanning", var accessibilityDescriptionRetryButton: String = "Retry ID scanning", var accessibilityDescriptionCloseScannerButton: String = "Close the scanner", var documentDataExtractorAlertRetryButton: String = "Retry", var documentDataExtractorAlertCloseScannerButton: String = "Close Scanner", var documentDataExtractorNoDocumentDetectedAlertTitle: String = "No document detected", var documentDataExtractorNoDocumentDetectedAlertSubtitle: String = "The scanner couldn't detect the document. Please ensure it's well-lit and fully visible, then try again.", var documentDataExtractorCantProcessDocumentAlertTitle: String = "Document could not be processed", var documentDataExtractorCantProcessDocumentAlertSubtitle: String = "This document doesn't meet the processing requirements. Please check accepted document types and try again.", var documentDataExtractorUnsupportedDocumentAlertTitle: String = "Unsupported document", var documentDataExtractorUnsupportedDocumentAlertSubtitle: String = "This document type isn't supported. Please try again with a valid document format.", var documentDataExtractorScanningTooLongAlertTitle: String = "Scanning took too long", var documentDataExtractorScanningTooLongAlertSubtitle: String = "Scanning took longer than expected. Please ensure the document is well-lit and fully visible, then try again.", var accessibilityDescriptionFlashButton: String = "Toggle flash", var accessibilityDescriptionZoomButton: String = "Toggle camera zoom", var accessibilityDescriptionFlipCameraButton: String = "Flip camera", 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", var documentUserGuidanceNoDocumentFound: String = "Looking for document...", var documentUserGuidanceScanningProgress: String = "Scanning the document...", var documentUserGuidanceTooDark: String = "Too dark. Please turn on a light.", var documentUserGuidanceTooSmall: String = "Please move closer to the document.", var documentUserGuidanceBadPerspective: String = "Please hold your device straight over the document.") : Parcelable

Configuration of the all strings for document data extractor screen.

Constructors

constructor(source: Map<String, Any?>)
constructor(json: JSONObject)
constructor(topBarTitle: String = "Document Data Extractor", topBarCancelButton: String = "Cancel", topUserGuidance: String = "Point the camera at the ID document", introScreenTitle: String = "How to scan an ID document", introScreenDoneButton: String = "Start Scanning", introScreenText: String = "To scan an ID, position the document within the frame, ensuring it's properly aligned and all key details are clearly visible. The scanner will then automatically extract essential information like name, date of birth, and document number. Once scanned, the data will be processed.", completionOverlaySuccessMessage: String = "Scanned successfully", accessibilityDescriptionOpenIntroScreenButton: String = "Open ID document scanning introduction", accessibilityDescriptionIntroScreenDoneButton: String = "Start ID scanning", accessibilityDescriptionCancelButton: String = "Cancel ID scanning", accessibilityDescriptionRetryButton: String = "Retry ID scanning", accessibilityDescriptionCloseScannerButton: String = "Close the scanner", documentDataExtractorAlertRetryButton: String = "Retry", documentDataExtractorAlertCloseScannerButton: String = "Close Scanner", documentDataExtractorNoDocumentDetectedAlertTitle: String = "No document detected", documentDataExtractorNoDocumentDetectedAlertSubtitle: String = "The scanner couldn't detect the document. Please ensure it's well-lit and fully visible, then try again.", documentDataExtractorCantProcessDocumentAlertTitle: String = "Document could not be processed", documentDataExtractorCantProcessDocumentAlertSubtitle: String = "This document doesn't meet the processing requirements. Please check accepted document types and try again.", documentDataExtractorUnsupportedDocumentAlertTitle: String = "Unsupported document", documentDataExtractorUnsupportedDocumentAlertSubtitle: String = "This document type isn't supported. Please try again with a valid document format.", documentDataExtractorScanningTooLongAlertTitle: String = "Scanning took too long", documentDataExtractorScanningTooLongAlertSubtitle: String = "Scanning took longer than expected. Please ensure the document is well-lit and fully visible, then try again.", accessibilityDescriptionFlashButton: String = "Toggle flash", accessibilityDescriptionZoomButton: String = "Toggle camera zoom", accessibilityDescriptionFlipCameraButton: String = "Flip camera", cameraPermissionEnableCameraTitle: String = "Camera permission denied!", cameraPermissionEnableCameraExplanation: String = "Please allow the usage of the camera to start the scanning process.", cameraPermissionEnableCameraButton: String = "Grant permission", cameraPermissionCloseButton: String = "Close", accessibilityDescriptionCameraPermissionEnableCameraButton: String = "Tap to grant camera permission", accessibilityDescriptionCameraPermissionCloseButton: String = "Close screen without granting permission", documentUserGuidanceNoDocumentFound: String = "Looking for document...", documentUserGuidanceScanningProgress: String = "Scanning the document...", documentUserGuidanceTooDark: String = "Too dark. Please turn on a light.", documentUserGuidanceTooSmall: String = "Please move closer to the document.", documentUserGuidanceBadPerspective: String = "Please hold your device straight over the document.")

Types

Link copied to clipboard
object Companion

Properties

The accessibility hint for the 'close' button of the camera permission dialog.

The accessibility hint for the 'enable' button of the camera permission dialog.

Link copied to clipboard

Accessibility description for the 'cancel' button in the top bar.

Accessibility description for the 'close scanner' button in the alerts.

Link copied to clipboard

Accessibility description for the flash button.

Link copied to clipboard

Accessibility description for the flip camera button.

Accessibility description for the 'done'/'start scanning' button in the introduction screen.

Accessibility description for the 'open introduction screen' button in top bar.

Link copied to clipboard

Accessibility description for the retry button in the alerts.

Link copied to clipboard

Accessibility description for the zoom button.

Link copied to clipboard

The 'close' button title of the camera permission dialog.

Link copied to clipboard

The 'enable' button title of the camera permission dialog.

Link copied to clipboard

The explanation text of the camera permission dialog.

Link copied to clipboard

The title of the camera permission dialog.

Link copied to clipboard

Caption for the success overlay.

Close Scanner button text for the alert.

Link copied to clipboard

Try again button text for the alert.

Subtitle for the alert when document cannot be processed.

Title for the alert when document cannot be processed.

Subtitle for the alert when no document is detected.

Title for the alert when no document is detected.

Subtitle for the alert when scanning takes too long.

Title for the alert when scanning takes too long.

Subtitle for the alert when document is not supported.

Title for the alert when document is not supported.

Link copied to clipboard

The user guidance text displayed when the detected document is not in a good perspective (device tilted).

Link copied to clipboard

The user guidance text displayed when no document is found.

Link copied to clipboard

The user guidance text displayed when a document presence was detected.

Link copied to clipboard

The user guidance text displayed when it is too dark to capture an adequate image.

Link copied to clipboard

The user guidance text displayed when the detected document is too far away and appears too small.

Link copied to clipboard

Start scanning button text for the introduction screen.

Link copied to clipboard

The text explanation for the introduction screen.

Link copied to clipboard

Title for the introduction screen.

Link copied to clipboard

Cancel button text for the top bar.

Link copied to clipboard

Title for the top bar.

Link copied to clipboard

Text for the top user guidance caption.

Functions

Link copied to clipboard
Link copied to clipboard

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 toJson(config: ToJsonConfiguration = ToJsonConfiguration.default()): JSONObject