capacitor-plugin-scanbot-sdk
Version:
Scanbot Document and Barcode Scanner SDK for Capacitor
208 lines (174 loc) • 6.66 kB
TypeScript
import type { DeepPartial } from '../../utils/utils';
import { PartiallyConstructible } from '../../utils/utils';
/**
Configuration of the all strings for check scanner screen.
*/
export declare class CheckScannerScreenTextLocalization extends PartiallyConstructible {
/**
Title for the top bar.
Default is "Check Scanner"
*/
topBarTitle: string;
/**
Cancel button text for the top bar.
Default is "Cancel"
*/
topBarCancelButton: string;
/**
Text for the top user guidance caption.
Default is "Point the camera at the check"
*/
topUserGuidance: string;
/**
Text for the user guidance caption below the finder view.
Default is "Looking for check..."
*/
finderViewUserGuidance: string;
/**
Title for the introduction screen.
Default is "How to scan a check"
*/
introScreenTitle: string;
/**
Start scanning button text for the introduction screen.
Default is "Start Scanning"
*/
introScreenDoneButton: string;
/**
The text explanation of the introduction screen.
Default is "This scanner reads the MICR (Magnetic Ink Character Recognition) line – the numbers and characters printed at the bottom of your check.\n\nTo scan, place the check on a flat, well-lit surface and position your camera so the entire check is within the frame. The check data will be automatically extracted.\nTap 'Start Scanning' to begin."
*/
introScreenText: string;
/**
Caption for the success overlay.
Default is "Scanned successfully"
*/
completionOverlaySuccessMessage: string;
/**
Accessibility description for the 'open introduction screen' button in top bar.
Default is "Open Check Scanner introduction"
*/
accessibilityDescriptionOpenIntroScreenButton: string;
/**
Accessibility description for the 'done'/'start scanning' button in the introduction screen.
Default is "Start check scanning"
*/
accessibilityDescriptionIntroScreenDoneButton: string;
/**
Accessibility description for the 'cancel' button in the top bar.
Default is "Cancel check scanning"
*/
accessibilityDescriptionCancelButton: string;
/**
Accessibility description for the 'retry' button in the alerts.
Default is "Retry check scanning"
*/
accessibilityDescriptionRetryButton: string;
/**
Accessibility description for the 'close scanner' button in the alerts.
Default is "Close check scanner"
*/
accessibilityDescriptionCloseScannerButton: string;
/**
Try again button text for the alert.
Default is "Retry"
*/
checkAlertRetryButton: string;
/**
Close button text for the alert.
Default is "Close Scanner"
*/
checkAlertCloseScannerButton: string;
/**
Title for the alert when Check is not detected.
Default is "No check detected"
*/
checkNoCheckDetectedAlertTitle: string;
/**
Subtitle for the alert when Check is not detected.
Default is "The scanner couldn't detect the check. Please ensure the check is valid, well-lit, and fully visible, then try again."
*/
checkNoCheckDetectedAlertSubtitle: string;
/**
Title for the alert when the image is not good.
Default is "Check not recognized"
*/
checkImageNotGoodAlertTitle: string;
/**
Subtitle for the alert when the image is not good.
Default is "Make sure the check is valid, well-lit, and fully visible. Then try again."
*/
checkImageNotGoodAlertSubtitle: string;
/**
Accessibility description for the flash button.
Default is "Toggle flash"
*/
accessibilityDescriptionFlashButton: string;
/**
Accessibility description for the zoom button.
Default is "Toggle camera zoom"
*/
accessibilityDescriptionZoomButton: string;
/**
Accessibility description for the flip camera button.
Default is "Flip camera"
*/
accessibilityDescriptionFlipCameraButton: string;
/**
The title of the camera permission dialog.
Default is "Camera permission denied!"
*/
cameraPermissionEnableCameraTitle: string;
/**
The explanation text of the camera permission dialog.
Default is "Please allow the usage of the camera to start the scanning process."
*/
cameraPermissionEnableCameraExplanation: string;
/**
The 'enable' button title of the camera permission dialog.
Default is "Grant permission"
*/
cameraPermissionEnableCameraButton: string;
/**
The 'close' button title of the camera permission dialog.
Default is "Close"
*/
cameraPermissionCloseButton: string;
/**
The accessibility hint for the 'enable' button of the camera permission dialog.
Default is "Tap to grant camera permission"
*/
accessibilityDescriptionCameraPermissionEnableCameraButton: string;
/**
The accessibility hint for the 'close' button of the camera permission dialog.
Default is "Close screen without granting permission"
*/
accessibilityDescriptionCameraPermissionCloseButton: string;
/**
The user guidance text displayed when no check is found.
Default is "Looking for check..."
*/
checkUserGuidanceNoCheckFound: string;
/**
The user guidance text displayed when a check presence was detected.
Default is "Scanning the check..."
*/
checkUserGuidanceScanningProgress: string;
/**
The user guidance text displayed when it is too dark to capture an adequate image.
Default is "Too dark. Please turn on a light."
*/
checkUserGuidanceTooDark: string;
/**
The user guidance text displayed when the detected check is too far away and appears too small.
Default is "Please move closer to the check."
*/
checkUserGuidanceTooSmall: string;
/**
The user guidance text displayed when the detected check is not in a good perspective (device tilted).
Default is "Please hold your device straight over the check."
*/
checkUserGuidanceBadPerspective: string;
/** @param source {@displayType `DeepPartial<CheckScannerScreenTextLocalization>`} */
constructor(source?: DeepPartial<CheckScannerScreenTextLocalization>);
}