react-native-scanbot-sdk/src/ui_v2/check/CheckScannerScreenTextLocalization.ts

Scanbot Document and Barcode Scanner SDK React Native Plugin for Android and iOS

/// Auto-generated with ScanbotSDKCodegenV3. Modifications will be overwritten.
/// Generated from rtu-ui-v2/schemas/check/CheckScannerScreenTextLocalization.yaml

import { DeepPartial, PartiallyConstructible } from '../../utils/utils';

/**
Configuration of the all strings for check scanner screen.
*/
export class CheckScannerScreenTextLocalization extends PartiallyConstructible {
  /**
    Title for the top bar.
    
    Default is "Check Scanner"
    */
  public topBarTitle: string = 'Check Scanner';
  /**
    Cancel button text for the top bar.
    
    Default is "Cancel"
    */
  public topBarCancelButton: string = 'Cancel';
  /**
    Text for the top user guidance caption.
    
    Default is "Point the camera at the check"
    */
  public topUserGuidance: string = 'Point the camera at the check';
  /**
    Text for the user guidance caption below the finder view.
    
    Default is "Looking for check..."
    */
  public finderViewUserGuidance: string = 'Looking for check...';
  /**
    Title for the introduction screen.
    
    Default is "How to scan a check"
    */
  public introScreenTitle: string = 'How to scan a check';
  /**
    Start scanning button text for the introduction screen.
    
    Default is "Start Scanning"
    */
  public introScreenDoneButton: string = 'Start Scanning';
  /**
    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."
    */
  public introScreenText: string =
    "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.";
  /**
    Caption for the success overlay.
    
    Default is "Scanned successfully"
    */
  public completionOverlaySuccessMessage: string = 'Scanned successfully';
  /**
    Accessibility description for the 'open introduction screen' button in top bar.
    
    Default is "Open Check Scanner introduction"
    */
  public accessibilityDescriptionOpenIntroScreenButton: string = 'Open Check Scanner introduction';
  /**
    Accessibility description for the 'done'/'start scanning' button in the introduction screen.
    
    Default is "Start check scanning"
    */
  public accessibilityDescriptionIntroScreenDoneButton: string = 'Start check scanning';
  /**
    Accessibility description for the 'cancel' button in the top bar.
    
    Default is "Cancel check scanning"
    */
  public accessibilityDescriptionCancelButton: string = 'Cancel check scanning';
  /**
    Accessibility description for the 'retry' button in the alerts.
    
    Default is "Retry check scanning"
    */
  public accessibilityDescriptionRetryButton: string = 'Retry check scanning';
  /**
    Accessibility description for the 'close scanner' button in the alerts.
    
    Default is "Close check scanner"
    */
  public accessibilityDescriptionCloseScannerButton: string = 'Close check scanner';
  /**
    Try again button text for the alert.
    
    Default is "Retry"
    */
  public checkAlertRetryButton: string = 'Retry';
  /**
    Close button text for the alert.
    
    Default is "Close Scanner"
    */
  public checkAlertCloseScannerButton: string = 'Close Scanner';
  /**
    Title for the alert when Check is not detected.
    
    Default is "No check detected"
    */
  public checkNoCheckDetectedAlertTitle: string = 'No check detected';
  /**
    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."
    */
  public checkNoCheckDetectedAlertSubtitle: string =
    "The scanner couldn't detect the check. Please ensure the check is valid, well-lit, and fully visible, then try again.";
  /**
    Title for the alert when the image is not good.
    
    Default is "Check not recognized"
    */
  public checkImageNotGoodAlertTitle: string = 'Check not recognized';
  /**
    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."
    */
  public checkImageNotGoodAlertSubtitle: string =
    'Make sure the check is valid, well-lit, and fully visible. Then try again.';
  /**
    Accessibility description for the flash button.
    
    Default is "Toggle flash"
    */
  public accessibilityDescriptionFlashButton: string = 'Toggle flash';
  /**
    Accessibility description for the zoom button.
    
    Default is "Toggle camera zoom"
    */
  public accessibilityDescriptionZoomButton: string = 'Toggle camera zoom';
  /**
    Accessibility description for the flip camera button.
    
    Default is "Flip camera"
    */
  public accessibilityDescriptionFlipCameraButton: string = 'Flip camera';
  /**
    The title of the camera permission dialog.
    
    Default is "Camera permission denied!"
    */
  public cameraPermissionEnableCameraTitle: string = 'Camera permission denied!';
  /**
    The explanation text of the camera permission dialog.
    
    Default is "Please allow the usage of the camera to start the scanning process."
    */
  public cameraPermissionEnableCameraExplanation: string =
    'Please allow the usage of the camera to start the scanning process.';
  /**
    The 'enable' button title of the camera permission dialog.
    
    Default is "Grant permission"
    */
  public cameraPermissionEnableCameraButton: string = 'Grant permission';
  /**
    The 'close' button title of the camera permission dialog.
    
    Default is "Close"
    */
  public cameraPermissionCloseButton: string = 'Close';
  /**
    The accessibility hint for the 'enable' button of the camera permission dialog.
    
    Default is "Tap to grant camera permission"
    */
  public accessibilityDescriptionCameraPermissionEnableCameraButton: string =
    'Tap to grant camera permission';
  /**
    The accessibility hint for the 'close' button of the camera permission dialog.
    
    Default is "Close screen without granting permission"
    */
  public accessibilityDescriptionCameraPermissionCloseButton: string =
    'Close screen without granting permission';
  /**
    The user guidance text displayed when no check is found.
    
    Default is "Looking for check..."
    */
  public checkUserGuidanceNoCheckFound: string = 'Looking for check...';
  /**
    The user guidance text displayed when a check presence was detected.
    
    Default is "Scanning the check..."
    */
  public checkUserGuidanceScanningProgress: string = 'Scanning the check...';
  /**
    The user guidance text displayed when it is too dark to capture an adequate image.
    
    Default is "Too dark. Please turn on a light."
    */
  public checkUserGuidanceTooDark: string = 'Too dark. Please turn on a light.';
  /**
    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."
    */
  public checkUserGuidanceTooSmall: string = 'Please move closer to the check.';
  /**
    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."
    */
  public checkUserGuidanceBadPerspective: string =
    'Please hold your device straight over the check.';

  /** @param source {@displayType `DeepPartial<CheckScannerScreenTextLocalization>`} */
  public constructor(source: DeepPartial<CheckScannerScreenTextLocalization> = {}) {
    super();
    if (source.topBarTitle !== undefined) {
      this.topBarTitle = source.topBarTitle;
    }
    if (source.topBarCancelButton !== undefined) {
      this.topBarCancelButton = source.topBarCancelButton;
    }
    if (source.topUserGuidance !== undefined) {
      this.topUserGuidance = source.topUserGuidance;
    }
    if (source.finderViewUserGuidance !== undefined) {
      this.finderViewUserGuidance = source.finderViewUserGuidance;
    }
    if (source.introScreenTitle !== undefined) {
      this.introScreenTitle = source.introScreenTitle;
    }
    if (source.introScreenDoneButton !== undefined) {
      this.introScreenDoneButton = source.introScreenDoneButton;
    }
    if (source.introScreenText !== undefined) {
      this.introScreenText = source.introScreenText;
    }
    if (source.completionOverlaySuccessMessage !== undefined) {
      this.completionOverlaySuccessMessage = source.completionOverlaySuccessMessage;
    }
    if (source.accessibilityDescriptionOpenIntroScreenButton !== undefined) {
      this.accessibilityDescriptionOpenIntroScreenButton =
        source.accessibilityDescriptionOpenIntroScreenButton;
    }
    if (source.accessibilityDescriptionIntroScreenDoneButton !== undefined) {
      this.accessibilityDescriptionIntroScreenDoneButton =
        source.accessibilityDescriptionIntroScreenDoneButton;
    }
    if (source.accessibilityDescriptionCancelButton !== undefined) {
      this.accessibilityDescriptionCancelButton = source.accessibilityDescriptionCancelButton;
    }
    if (source.accessibilityDescriptionRetryButton !== undefined) {
      this.accessibilityDescriptionRetryButton = source.accessibilityDescriptionRetryButton;
    }
    if (source.accessibilityDescriptionCloseScannerButton !== undefined) {
      this.accessibilityDescriptionCloseScannerButton =
        source.accessibilityDescriptionCloseScannerButton;
    }
    if (source.checkAlertRetryButton !== undefined) {
      this.checkAlertRetryButton = source.checkAlertRetryButton;
    }
    if (source.checkAlertCloseScannerButton !== undefined) {
      this.checkAlertCloseScannerButton = source.checkAlertCloseScannerButton;
    }
    if (source.checkNoCheckDetectedAlertTitle !== undefined) {
      this.checkNoCheckDetectedAlertTitle = source.checkNoCheckDetectedAlertTitle;
    }
    if (source.checkNoCheckDetectedAlertSubtitle !== undefined) {
      this.checkNoCheckDetectedAlertSubtitle = source.checkNoCheckDetectedAlertSubtitle;
    }
    if (source.checkImageNotGoodAlertTitle !== undefined) {
      this.checkImageNotGoodAlertTitle = source.checkImageNotGoodAlertTitle;
    }
    if (source.checkImageNotGoodAlertSubtitle !== undefined) {
      this.checkImageNotGoodAlertSubtitle = source.checkImageNotGoodAlertSubtitle;
    }
    if (source.accessibilityDescriptionFlashButton !== undefined) {
      this.accessibilityDescriptionFlashButton = source.accessibilityDescriptionFlashButton;
    }
    if (source.accessibilityDescriptionZoomButton !== undefined) {
      this.accessibilityDescriptionZoomButton = source.accessibilityDescriptionZoomButton;
    }
    if (source.accessibilityDescriptionFlipCameraButton !== undefined) {
      this.accessibilityDescriptionFlipCameraButton =
        source.accessibilityDescriptionFlipCameraButton;
    }
    if (source.cameraPermissionEnableCameraTitle !== undefined) {
      this.cameraPermissionEnableCameraTitle = source.cameraPermissionEnableCameraTitle;
    }
    if (source.cameraPermissionEnableCameraExplanation !== undefined) {
      this.cameraPermissionEnableCameraExplanation = source.cameraPermissionEnableCameraExplanation;
    }
    if (source.cameraPermissionEnableCameraButton !== undefined) {
      this.cameraPermissionEnableCameraButton = source.cameraPermissionEnableCameraButton;
    }
    if (source.cameraPermissionCloseButton !== undefined) {
      this.cameraPermissionCloseButton = source.cameraPermissionCloseButton;
    }
    if (source.accessibilityDescriptionCameraPermissionEnableCameraButton !== undefined) {
      this.accessibilityDescriptionCameraPermissionEnableCameraButton =
        source.accessibilityDescriptionCameraPermissionEnableCameraButton;
    }
    if (source.accessibilityDescriptionCameraPermissionCloseButton !== undefined) {
      this.accessibilityDescriptionCameraPermissionCloseButton =
        source.accessibilityDescriptionCameraPermissionCloseButton;
    }
    if (source.checkUserGuidanceNoCheckFound !== undefined) {
      this.checkUserGuidanceNoCheckFound = source.checkUserGuidanceNoCheckFound;
    }
    if (source.checkUserGuidanceScanningProgress !== undefined) {
      this.checkUserGuidanceScanningProgress = source.checkUserGuidanceScanningProgress;
    }
    if (source.checkUserGuidanceTooDark !== undefined) {
      this.checkUserGuidanceTooDark = source.checkUserGuidanceTooDark;
    }
    if (source.checkUserGuidanceTooSmall !== undefined) {
      this.checkUserGuidanceTooSmall = source.checkUserGuidanceTooSmall;
    }
    if (source.checkUserGuidanceBadPerspective !== undefined) {
      this.checkUserGuidanceBadPerspective = source.checkUserGuidanceBadPerspective;
    }
  }
}