capacitor-plugin-scanbot-sdk
Version:
Scanbot Document and Barcode Scanner SDK for Capacitor
160 lines (134 loc) • 5.04 kB
TypeScript
import type { DeepPartial } from '../../utils/utils';
import { PartiallyConstructible } from '../../utils/utils';
/**
Configuration of the all strings for generic text scanner screen.
*/
export declare class VinScannerScreenTextLocalization extends PartiallyConstructible {
/**
Title for the top bar.
Default is "VIN 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 VIN"
*/
topUserGuidance: string;
/**
Text for the user guidance caption below the finder view.
Default is "Looking for VIN..."
*/
finderViewUserGuidance: string;
/**
Title for the introduction screen.
Default is "How to scan a VIN"
*/
introScreenTitle: string;
/**
Start scanning button text for the introduction screen.
Default is "Start Scanning"
*/
introScreenDoneButton: string;
/**
The text explanation for the introduction screen.
Default is "A VIN (Vehicle Identification Number) is a unique code you'll find on a vehicle's windshield or on the inside of the driver's door. \n\nTo scan, simply point your camera at the VIN, ensuring it's within the frame. The VIN will be automatically extracted.\n\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 VIN Scanner introduction"
*/
accessibilityDescriptionOpenIntroScreenButton: string;
/**
Accessibility description for the 'done'/'start scanning' button in the introduction screen.
Default is "Start VIN scanning"
*/
accessibilityDescriptionIntroScreenDoneButton: string;
/**
Accessibility description for the 'cancel' button in the top bar.
Default is "Cancel VIN scanning"
*/
accessibilityDescriptionCancelButton: string;
/**
Title for the text pattern confirmation alert.
Default is "VIN detected"
*/
vinConfirmationAlertTitle: string;
/**
Cancel button text for the text pattern confirmation alert.
Default is "Cancel"
*/
vinConfirmationAlertCancelButton: string;
/**
Submit button text for the text pattern confirmation alert.
Default is "Submit"
*/
vinConfirmationAlertSubmitButton: string;
/**
Accessibility description for the cancel button in the text pattern confirmation alert.
Default is "Cancel VIN scanning"
*/
accessibilityDescriptionConfirmationCancelButton: string;
/**
Accessibility description for the submit button in the text pattern confirmation alert.
Default is "Submit VIN scan result"
*/
accessibilityDescriptionConfirmationSubmitButton: 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;
/** @param source {@displayType `DeepPartial<VinScannerScreenTextLocalization>`} */
constructor(source?: DeepPartial<VinScannerScreenTextLocalization>);
}