Class CreditCardScannerScreenTextLocalization
-
- All Implemented Interfaces:
-
android.os.Parcelable
public final class CreditCardScannerScreenTextLocalization implements Parcelable
Configuration of the all strings for credit card scanner screen.
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description CreditCardScannerScreenTextLocalization(Map<String, Object> source)
CreditCardScannerScreenTextLocalization(JSONObject json)
CreditCardScannerScreenTextLocalization(String topBarTitle, String topBarCancelButton, String topUserGuidance, String introScreenTitle, String introScreenDoneButton, String introScreenText, String completionOverlaySuccessMessage, String completionOverlayIncompleteDataMessage, String accessibilityDescriptionOpenIntroScreenButton, String accessibilityDescriptionIntroScreenDoneButton, String accessibilityDescriptionCancelButton, String accessibilityDescriptionFlashButton, String accessibilityDescriptionZoomButton, String accessibilityDescriptionFlipCameraButton, String creditCardUserGuidanceNoCardFound, String creditCardUserGuidanceScanningProgress, String creditCardUserGuidanceTooDark, String creditCardUserGuidanceTooSmall, String creditCardUserGuidanceBadPerspective, String cameraPermissionEnableCameraTitle, String cameraPermissionEnableCameraExplanation, String cameraPermissionEnableCameraButton, String cameraPermissionCloseButton, String accessibilityDescriptionCameraPermissionEnableCameraButton, String accessibilityDescriptionCameraPermissionCloseButton)
-
Method Summary
Modifier and Type Method Description final String
getTopBarTitle()
Title for the top bar. final Unit
setTopBarTitle(String topBarTitle)
Title for the top bar. final String
getTopBarCancelButton()
Cancel button text for the top bar. final Unit
setTopBarCancelButton(String topBarCancelButton)
Cancel button text for the top bar. final String
getTopUserGuidance()
Text for the top user guidance caption. final Unit
setTopUserGuidance(String topUserGuidance)
Text for the top user guidance caption. final String
getIntroScreenTitle()
Title for the introduction screen. final Unit
setIntroScreenTitle(String introScreenTitle)
Title for the introduction screen. final String
getIntroScreenDoneButton()
Start scanning button text for the introduction screen. final Unit
setIntroScreenDoneButton(String introScreenDoneButton)
Start scanning button text for the introduction screen. final String
getIntroScreenText()
The text explanation of the introduction screen. final Unit
setIntroScreenText(String introScreenText)
The text explanation of the introduction screen. final String
getCompletionOverlaySuccessMessage()
Caption for the success overlay. final Unit
setCompletionOverlaySuccessMessage(String completionOverlaySuccessMessage)
Caption for the success overlay. final String
getCompletionOverlayIncompleteDataMessage()
Caption for the success overlay when not all data from the card was scanned. final Unit
setCompletionOverlayIncompleteDataMessage(String completionOverlayIncompleteDataMessage)
Caption for the success overlay when not all data from the card was scanned. final String
getAccessibilityDescriptionOpenIntroScreenButton()
Accessibility description for the 'open introduction screen' button in top bar. final Unit
setAccessibilityDescriptionOpenIntroScreenButton(String accessibilityDescriptionOpenIntroScreenButton)
Accessibility description for the 'open introduction screen' button in top bar. final String
getAccessibilityDescriptionIntroScreenDoneButton()
Accessibility description for the 'done'/'start scanning' button in the introduction screen. final Unit
setAccessibilityDescriptionIntroScreenDoneButton(String accessibilityDescriptionIntroScreenDoneButton)
Accessibility description for the 'done'/'start scanning' button in the introduction screen. final String
getAccessibilityDescriptionCancelButton()
Accessibility description for the 'cancel' button in the top bar. final Unit
setAccessibilityDescriptionCancelButton(String accessibilityDescriptionCancelButton)
Accessibility description for the 'cancel' button in the top bar. final String
getAccessibilityDescriptionFlashButton()
Accessibility description for the flash button. final Unit
setAccessibilityDescriptionFlashButton(String accessibilityDescriptionFlashButton)
Accessibility description for the flash button. final String
getAccessibilityDescriptionZoomButton()
Accessibility description for the zoom button. final Unit
setAccessibilityDescriptionZoomButton(String accessibilityDescriptionZoomButton)
Accessibility description for the zoom button. final String
getAccessibilityDescriptionFlipCameraButton()
Accessibility description for the flip camera button. final Unit
setAccessibilityDescriptionFlipCameraButton(String accessibilityDescriptionFlipCameraButton)
Accessibility description for the flip camera button. final String
getCreditCardUserGuidanceNoCardFound()
The user guidance text displayed when no credit card is found. final Unit
setCreditCardUserGuidanceNoCardFound(String creditCardUserGuidanceNoCardFound)
The user guidance text displayed when no credit card is found. final String
getCreditCardUserGuidanceScanningProgress()
The user guidance text displayed when a card presence was detected. final Unit
setCreditCardUserGuidanceScanningProgress(String creditCardUserGuidanceScanningProgress)
The user guidance text displayed when a card presence was detected. final String
getCreditCardUserGuidanceTooDark()
The user guidance text displayed when it is too dark to capture an adequate image. final Unit
setCreditCardUserGuidanceTooDark(String creditCardUserGuidanceTooDark)
The user guidance text displayed when it is too dark to capture an adequate image. final String
getCreditCardUserGuidanceTooSmall()
The user guidance text displayed when the detected card is too far away and appears too small. final Unit
setCreditCardUserGuidanceTooSmall(String creditCardUserGuidanceTooSmall)
The user guidance text displayed when the detected card is too far away and appears too small. final String
getCreditCardUserGuidanceBadPerspective()
The user guidance text displayed when the detected card is not in a good perspective (device tilted). final Unit
setCreditCardUserGuidanceBadPerspective(String creditCardUserGuidanceBadPerspective)
The user guidance text displayed when the detected card is not in a good perspective (device tilted). final String
getCameraPermissionEnableCameraTitle()
The title of the camera permission dialog. final Unit
setCameraPermissionEnableCameraTitle(String cameraPermissionEnableCameraTitle)
The title of the camera permission dialog. final String
getCameraPermissionEnableCameraExplanation()
The explanation text of the camera permission dialog. final Unit
setCameraPermissionEnableCameraExplanation(String cameraPermissionEnableCameraExplanation)
The explanation text of the camera permission dialog. final String
getCameraPermissionEnableCameraButton()
The 'enable' button title of the camera permission dialog. final Unit
setCameraPermissionEnableCameraButton(String cameraPermissionEnableCameraButton)
The 'enable' button title of the camera permission dialog. final String
getCameraPermissionCloseButton()
The 'close' button title of the camera permission dialog. final Unit
setCameraPermissionCloseButton(String cameraPermissionCloseButton)
The 'close' button title of the camera permission dialog. final String
getAccessibilityDescriptionCameraPermissionEnableCameraButton()
The accessibility hint for the 'enable' button of the camera permission dialog. final Unit
setAccessibilityDescriptionCameraPermissionEnableCameraButton(String accessibilityDescriptionCameraPermissionEnableCameraButton)
The accessibility hint for the 'enable' button of the camera permission dialog. final String
getAccessibilityDescriptionCameraPermissionCloseButton()
The accessibility hint for the 'close' button of the camera permission dialog. final Unit
setAccessibilityDescriptionCameraPermissionCloseButton(String accessibilityDescriptionCameraPermissionCloseButton)
The accessibility hint for the 'close' button of the camera permission dialog. final JSONObject
toJson(ToJsonConfiguration config)
final CreditCardScannerScreenTextLocalization
clone()
final static CreditCardScannerScreenTextLocalization
default()
-
-
Constructor Detail
-
CreditCardScannerScreenTextLocalization
CreditCardScannerScreenTextLocalization(Map<String, Object> source)
-
CreditCardScannerScreenTextLocalization
CreditCardScannerScreenTextLocalization(JSONObject json)
-
CreditCardScannerScreenTextLocalization
CreditCardScannerScreenTextLocalization(String topBarTitle, String topBarCancelButton, String topUserGuidance, String introScreenTitle, String introScreenDoneButton, String introScreenText, String completionOverlaySuccessMessage, String completionOverlayIncompleteDataMessage, String accessibilityDescriptionOpenIntroScreenButton, String accessibilityDescriptionIntroScreenDoneButton, String accessibilityDescriptionCancelButton, String accessibilityDescriptionFlashButton, String accessibilityDescriptionZoomButton, String accessibilityDescriptionFlipCameraButton, String creditCardUserGuidanceNoCardFound, String creditCardUserGuidanceScanningProgress, String creditCardUserGuidanceTooDark, String creditCardUserGuidanceTooSmall, String creditCardUserGuidanceBadPerspective, String cameraPermissionEnableCameraTitle, String cameraPermissionEnableCameraExplanation, String cameraPermissionEnableCameraButton, String cameraPermissionCloseButton, String accessibilityDescriptionCameraPermissionEnableCameraButton, String accessibilityDescriptionCameraPermissionCloseButton)
-
-
Method Detail
-
getTopBarTitle
final String getTopBarTitle()
Title for the top bar.
Default is "Credit Card Scanner"
-
setTopBarTitle
final Unit setTopBarTitle(String topBarTitle)
Title for the top bar.
Default is "Credit Card Scanner"
-
getTopBarCancelButton
final String getTopBarCancelButton()
Cancel button text for the top bar.
Default is "Cancel"
-
setTopBarCancelButton
final Unit setTopBarCancelButton(String topBarCancelButton)
Cancel button text for the top bar.
Default is "Cancel"
-
getTopUserGuidance
final String getTopUserGuidance()
Text for the top user guidance caption.
Default is "Scan the credit card"
-
setTopUserGuidance
final Unit setTopUserGuidance(String topUserGuidance)
Text for the top user guidance caption.
Default is "Scan the credit card"
-
getIntroScreenTitle
final String getIntroScreenTitle()
Title for the introduction screen.
Default is "How to scan a credit card"
-
setIntroScreenTitle
final Unit setIntroScreenTitle(String introScreenTitle)
Title for the introduction screen.
Default is "How to scan a credit card"
-
getIntroScreenDoneButton
final String getIntroScreenDoneButton()
Start scanning button text for the introduction screen.
Default is "Start Scanning"
-
setIntroScreenDoneButton
final Unit setIntroScreenDoneButton(String introScreenDoneButton)
Start scanning button text for the introduction screen.
Default is "Start Scanning"
-
getIntroScreenText
final String getIntroScreenText()
The text explanation of the introduction screen.
Default is "To quickly and securely input your credit card details, please hold your device over the credit card, so that the camera aligns with the numbers on the front of the card. \n\nThe scanner will guide you to the optimal scanning position. Once the scan is complete, your card details will automatically be extracted and processed.\n\nPress 'Start Scanning' to begin."
-
setIntroScreenText
final Unit setIntroScreenText(String introScreenText)
The text explanation of the introduction screen.
Default is "To quickly and securely input your credit card details, please hold your device over the credit card, so that the camera aligns with the numbers on the front of the card. \n\nThe scanner will guide you to the optimal scanning position. Once the scan is complete, your card details will automatically be extracted and processed.\n\nPress 'Start Scanning' to begin."
-
getCompletionOverlaySuccessMessage
final String getCompletionOverlaySuccessMessage()
Caption for the success overlay.
Default is "Scanned successfully"
-
setCompletionOverlaySuccessMessage
final Unit setCompletionOverlaySuccessMessage(String completionOverlaySuccessMessage)
Caption for the success overlay.
Default is "Scanned successfully"
-
getCompletionOverlayIncompleteDataMessage
final String getCompletionOverlayIncompleteDataMessage()
Caption for the success overlay when not all data from the card was scanned.
Default is "Incomplete scan"
-
setCompletionOverlayIncompleteDataMessage
final Unit setCompletionOverlayIncompleteDataMessage(String completionOverlayIncompleteDataMessage)
Caption for the success overlay when not all data from the card was scanned.
Default is "Incomplete scan"
-
getAccessibilityDescriptionOpenIntroScreenButton
final String getAccessibilityDescriptionOpenIntroScreenButton()
Accessibility description for the 'open introduction screen' button in top bar.
Default is "Open introduction screen."
-
setAccessibilityDescriptionOpenIntroScreenButton
final Unit setAccessibilityDescriptionOpenIntroScreenButton(String accessibilityDescriptionOpenIntroScreenButton)
Accessibility description for the 'open introduction screen' button in top bar.
Default is "Open introduction screen."
-
getAccessibilityDescriptionIntroScreenDoneButton
final String getAccessibilityDescriptionIntroScreenDoneButton()
Accessibility description for the 'done'/'start scanning' button in the introduction screen.
Default is "Start scanning"
-
setAccessibilityDescriptionIntroScreenDoneButton
final Unit setAccessibilityDescriptionIntroScreenDoneButton(String accessibilityDescriptionIntroScreenDoneButton)
Accessibility description for the 'done'/'start scanning' button in the introduction screen.
Default is "Start scanning"
-
getAccessibilityDescriptionCancelButton
final String getAccessibilityDescriptionCancelButton()
Accessibility description for the 'cancel' button in the top bar.
Default is "Cancel"
-
setAccessibilityDescriptionCancelButton
final Unit setAccessibilityDescriptionCancelButton(String accessibilityDescriptionCancelButton)
Accessibility description for the 'cancel' button in the top bar.
Default is "Cancel"
-
getAccessibilityDescriptionFlashButton
final String getAccessibilityDescriptionFlashButton()
Accessibility description for the flash button.
Default is "Toggle flash"
-
setAccessibilityDescriptionFlashButton
final Unit setAccessibilityDescriptionFlashButton(String accessibilityDescriptionFlashButton)
Accessibility description for the flash button.
Default is "Toggle flash"
-
getAccessibilityDescriptionZoomButton
final String getAccessibilityDescriptionZoomButton()
Accessibility description for the zoom button.
Default is "Toggle camera zoom"
-
setAccessibilityDescriptionZoomButton
final Unit setAccessibilityDescriptionZoomButton(String accessibilityDescriptionZoomButton)
Accessibility description for the zoom button.
Default is "Toggle camera zoom"
-
getAccessibilityDescriptionFlipCameraButton
final String getAccessibilityDescriptionFlipCameraButton()
Accessibility description for the flip camera button.
Default is "Flip camera"
-
setAccessibilityDescriptionFlipCameraButton
final Unit setAccessibilityDescriptionFlipCameraButton(String accessibilityDescriptionFlipCameraButton)
Accessibility description for the flip camera button.
Default is "Flip camera"
-
getCreditCardUserGuidanceNoCardFound
final String getCreditCardUserGuidanceNoCardFound()
The user guidance text displayed when no credit card is found.
Default is "Looking for credit card..."
-
setCreditCardUserGuidanceNoCardFound
final Unit setCreditCardUserGuidanceNoCardFound(String creditCardUserGuidanceNoCardFound)
The user guidance text displayed when no credit card is found.
Default is "Looking for credit card..."
-
getCreditCardUserGuidanceScanningProgress
final String getCreditCardUserGuidanceScanningProgress()
The user guidance text displayed when a card presence was detected.
Default is "Scanning the credit card..."
-
setCreditCardUserGuidanceScanningProgress
final Unit setCreditCardUserGuidanceScanningProgress(String creditCardUserGuidanceScanningProgress)
The user guidance text displayed when a card presence was detected.
Default is "Scanning the credit card..."
-
getCreditCardUserGuidanceTooDark
final String getCreditCardUserGuidanceTooDark()
The user guidance text displayed when it is too dark to capture an adequate image.
Default is "Too dark. Please turn on a light."
-
setCreditCardUserGuidanceTooDark
final Unit setCreditCardUserGuidanceTooDark(String creditCardUserGuidanceTooDark)
The user guidance text displayed when it is too dark to capture an adequate image.
Default is "Too dark. Please turn on a light."
-
getCreditCardUserGuidanceTooSmall
final String getCreditCardUserGuidanceTooSmall()
The user guidance text displayed when the detected card is too far away and appears too small.
Default is "Please move closer to the credit card."
-
setCreditCardUserGuidanceTooSmall
final Unit setCreditCardUserGuidanceTooSmall(String creditCardUserGuidanceTooSmall)
The user guidance text displayed when the detected card is too far away and appears too small.
Default is "Please move closer to the credit card."
-
getCreditCardUserGuidanceBadPerspective
final String getCreditCardUserGuidanceBadPerspective()
The user guidance text displayed when the detected card is not in a good perspective (device tilted).
Default is "Please hold your device straight over the credit card."
-
setCreditCardUserGuidanceBadPerspective
final Unit setCreditCardUserGuidanceBadPerspective(String creditCardUserGuidanceBadPerspective)
The user guidance text displayed when the detected card is not in a good perspective (device tilted).
Default is "Please hold your device straight over the credit card."
-
getCameraPermissionEnableCameraTitle
final String getCameraPermissionEnableCameraTitle()
The title of the camera permission dialog.
Default is "Camera permission denied!"
-
setCameraPermissionEnableCameraTitle
final Unit setCameraPermissionEnableCameraTitle(String cameraPermissionEnableCameraTitle)
The title of the camera permission dialog.
Default is "Camera permission denied!"
-
getCameraPermissionEnableCameraExplanation
final String getCameraPermissionEnableCameraExplanation()
The explanation text of the camera permission dialog.
Default is "Please allow the usage of the camera to start the scanning process."
-
setCameraPermissionEnableCameraExplanation
final Unit setCameraPermissionEnableCameraExplanation(String cameraPermissionEnableCameraExplanation)
The explanation text of the camera permission dialog.
Default is "Please allow the usage of the camera to start the scanning process."
-
getCameraPermissionEnableCameraButton
final String getCameraPermissionEnableCameraButton()
The 'enable' button title of the camera permission dialog.
Default is "Grant permission"
-
setCameraPermissionEnableCameraButton
final Unit setCameraPermissionEnableCameraButton(String cameraPermissionEnableCameraButton)
The 'enable' button title of the camera permission dialog.
Default is "Grant permission"
-
getCameraPermissionCloseButton
final String getCameraPermissionCloseButton()
The 'close' button title of the camera permission dialog.
Default is "Close"
-
setCameraPermissionCloseButton
final Unit setCameraPermissionCloseButton(String cameraPermissionCloseButton)
The 'close' button title of the camera permission dialog.
Default is "Close"
-
getAccessibilityDescriptionCameraPermissionEnableCameraButton
final String getAccessibilityDescriptionCameraPermissionEnableCameraButton()
The accessibility hint for the 'enable' button of the camera permission dialog.
Default is "Tap to grant camera permission"
-
setAccessibilityDescriptionCameraPermissionEnableCameraButton
final Unit setAccessibilityDescriptionCameraPermissionEnableCameraButton(String accessibilityDescriptionCameraPermissionEnableCameraButton)
The accessibility hint for the 'enable' button of the camera permission dialog.
Default is "Tap to grant camera permission"
-
getAccessibilityDescriptionCameraPermissionCloseButton
final String getAccessibilityDescriptionCameraPermissionCloseButton()
The accessibility hint for the 'close' button of the camera permission dialog.
Default is "Close screen without granting permission"
-
setAccessibilityDescriptionCameraPermissionCloseButton
final Unit setAccessibilityDescriptionCameraPermissionCloseButton(String accessibilityDescriptionCameraPermissionCloseButton)
The accessibility hint for the 'close' button of the camera permission dialog.
Default is "Close screen without granting permission"
-
toJson
final JSONObject toJson(ToJsonConfiguration config)
-
clone
final CreditCardScannerScreenTextLocalization clone()
-
default
final static CreditCardScannerScreenTextLocalization default()
-
-
-
-