react-native-scanbot-sdk
Version:
Scanbot Document and Barcode Scanner SDK React Native Plugin for Android and iOS
205 lines (181 loc) • 8.31 kB
text/typescript
/// Auto-generated with ScanbotSDKCodegenV3. Modifications will be overwritten.
/// Generated from rtu-ui-v2/schemas/mrz/MRZScannerScreenTextLocalization.yaml
import { DeepPartial, PartiallyConstructible } from '../../utils/utils';
/**
Configuration of the all strings for MRZ scanner screen.
*/
export class MrzScannerScreenTextLocalization extends PartiallyConstructible {
/**
Title for the top bar.
Default is "MRZ Scanner"
*/
public topBarTitle: string = 'MRZ Scanner';
/**
Cancel button text for the top bar.
Default is "Cancel"
*/
public topBarCancelButton: string = 'Cancel';
/**
Text for the top user guidance caption.
Default is "Scan your Identity Document"
*/
public topUserGuidance: string = 'Scan your Identity Document';
/**
Text for the user guidance caption below the finder view.
Default is "Scan the MRZ"
*/
public finderViewUserGuidance: string = 'Scan the MRZ';
/**
Title for the introduction screen.
Default is "How to scan an MRZ"
*/
public introScreenTitle: string = 'How to scan an MRZ';
/**
Start scanning button text for the introduction screen.
Default is "Start Scanning"
*/
public introScreenDoneButton: string = 'Start Scanning';
/**
The text explanation for the introduction screen.
Default is "The Machine Readable Zone (MRZ) is a special code on your ID document (such as a passport or ID card) that contains your personal information in a machine-readable format.\n\nTo scan it, simply hold your camera over the document, so that it aligns with the MRZ section. Once scanned, the data will be automatically processed, and you will be directed to the results screen.\n\nPress 'Start Scanning' to begin."
*/
public introScreenText: string =
"The Machine Readable Zone (MRZ) is a special code on your ID document (such as a passport or ID card) that contains your personal information in a machine-readable format.\n\nTo scan it, simply hold your camera over the document, so that it aligns with the MRZ section. Once scanned, the data will be automatically processed, and you will be directed to the results screen.\n\nPress '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 introduction screen."
*/
public accessibilityDescriptionOpenIntroScreenButton: string = 'Open introduction screen.';
/**
Accessibility description for the 'done'/'start scanning' button in the introduction screen.
Default is "Start scanning"
*/
public accessibilityDescriptionIntroScreenDoneButton: string = 'Start scanning';
/**
Accessibility description for the 'cancel' button in the top bar.
Default is "Cancel"
*/
public accessibilityDescriptionCancelButton: string = 'Cancel';
/**
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';
/** @param source {@displayType `DeepPartial<MrzScannerScreenTextLocalization>`} */
public constructor(source: DeepPartial<MrzScannerScreenTextLocalization> = {}) {
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.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;
}
}
}