capacitor-plugin-scanbot-sdk
    Preparing search index...

    Class DocumentScannerTextLocalization

    Configuration of all the strings for the standalone cropping screen.

    Index

    Constructors

    Properties

    accessibilityDescriptionAcknowledgementAcceptButton accessibilityDescriptionAcknowledgementRetakeButton accessibilityDescriptionCameraAutoSnapButton accessibilityDescriptionCameraCancelNoButton accessibilityDescriptionCameraCancelYesButton accessibilityDescriptionCameraImportButton accessibilityDescriptionCameraIntroDoneButton accessibilityDescriptionCameraLimitReachedOkButton accessibilityDescriptionCameraManualSnapButton accessibilityDescriptionCameraPermissionCloseButton accessibilityDescriptionCameraPermissionEnableCameraButton accessibilityDescriptionCameraPreviewButton accessibilityDescriptionCameraShutterButton accessibilityDescriptionCameraTopBarCancelButton accessibilityDescriptionCameraTopBarIntroButton accessibilityDescriptionCameraTorchOffButton accessibilityDescriptionCameraTorchOnButton accessibilityDescriptionCroppingDetectButton accessibilityDescriptionCroppingResetButton accessibilityDescriptionCroppingRotateButton accessibilityDescriptionCroppingTopBarCancelButton accessibilityDescriptionCroppingTopBarConfirmButton accessibilityDescriptionReorderTopBarCancelButton accessibilityDescriptionReorderTopBarConfirmButton accessibilityDescriptionReviewAddButton accessibilityDescriptionReviewCropButton accessibilityDescriptionReviewDeleteAllButton accessibilityDescriptionReviewDeleteAllPagesAlertCancelButton accessibilityDescriptionReviewDeleteAllPagesAlertDeleteButton accessibilityDescriptionReviewDeleteButton accessibilityDescriptionReviewDeletePageAlertCancelButton accessibilityDescriptionReviewDeletePageAlertConfirmButton accessibilityDescriptionReviewDeletePageAlertDeleteRetakeButton accessibilityDescriptionReviewMoreButton accessibilityDescriptionReviewNextPageButton accessibilityDescriptionReviewPreviousPageButton accessibilityDescriptionReviewReorderPagesButton accessibilityDescriptionReviewRetakeButton accessibilityDescriptionReviewRotateButton accessibilityDescriptionReviewSubmitButton accessibilityDescriptionReviewTopBarBackButton accessibilityDescriptionReviewZoomButton accessibilityDescriptionZoomOverlayCancelButton acknowledgementAcceptButtonTitle acknowledgementRetakeButtonTitle acknowledgementScreenBadDocumentHint acknowledgementTitle cameraAutoSnapButtonTitle cameraBadgedPreviewButtonTitle cameraCancelAlertSubtitle cameraCancelAlertTitle cameraCancelNoButtonTitle cameraCancelYesButtonTitle cameraImportButtonTitle cameraIntroDoneButton cameraIntroItem1 cameraIntroItem2 cameraIntroItem3 cameraIntroItem4 cameraIntroSubtitle cameraIntroTitle cameraLimitReachedAlertSubtitle cameraLimitReachedAlertTitle cameraLimitReachedOkButtonTitle cameraManualSnapButtonTitle cameraPermissionCloseButton cameraPermissionEnableCameraButton cameraPermissionEnableCameraExplanation cameraPermissionEnableCameraTitle cameraPreviewButtonTitle cameraProgressOverlayTitle cameraTopBarCancelButtonTitle cameraTopBarTitle cameraTopGuidance cameraTorchOffButtonTitle cameraTorchOnButtonTitle cameraUserGuidanceBadAngles cameraUserGuidanceBadAspectRatio cameraUserGuidanceEnergySaveMode cameraUserGuidanceNoDocumentFound cameraUserGuidanceOrientationMismatch cameraUserGuidanceReadyToCapture cameraUserGuidanceReadyToCaptureManual cameraUserGuidanceStart cameraUserGuidanceTextHintOffCenter cameraUserGuidanceTooDark cameraUserGuidanceTooNoisy cameraUserGuidanceTooSmall croppingDetectButtonTitle croppingResetButtonTitle croppingRotateButtonTitle croppingScreenTitle croppingTopBarCancelButtonTitle croppingTopBarConfirmButtonTitle reorderPageGuidanceTitle reorderPageText reorderPageTitle reorderTopBarCancelButtonTitle reorderTopBarConfirmButtonTitle reviewDeleteAllPagesAlertCancelButtonTitle reviewDeleteAllPagesAlertDeleteButtonTitle reviewDeleteAllPagesAlertSubtitle reviewDeleteAllPagesAlertTitle reviewDeletePageAlertCancelButtonTitle reviewDeletePageAlertConfirmButtonTitle reviewDeletePageAlertDeleteRetakeButtonTitle reviewDeletePageAlertSubTitle reviewDeletePageAlertTitle reviewScreenAddButtonTitle reviewScreenCropButtonTitle reviewScreenDeleteAllButtonTitle reviewScreenDeleteButtonTitle reviewScreenPageCount reviewScreenReorderPagesButtonTitle reviewScreenRetakeButtonTitle reviewScreenRotateButtonTitle reviewScreenSubmitButtonTitle reviewScreenTitle reviewTopBarBackButtonTitle zoomOverlayCancelButtonText

    Constructors

    Properties

    accessibilityDescriptionAcknowledgementAcceptButton: string

    The accessibility hint for the 'accept' button of the acknowledgement screen.

    Default is "Tap to accept the image regardless of its quality"

    accessibilityDescriptionAcknowledgementRetakeButton: string

    The accessibility hint for the 'retake' button of the acknowledgement screen.

    Default is "Tap to retake the image"

    accessibilityDescriptionCameraAutoSnapButton: string

    The accessibility hint for the 'auto snapping' mode button, located in the bottom bar of the camera screen.

    Default is "Tap to enable manual snapping mode"

    accessibilityDescriptionCameraCancelNoButton: string

    The accessibility hint for the 'no' button of the cancel camera screen alert dialog.

    Default is "Tap to close alert dialog"

    accessibilityDescriptionCameraCancelYesButton: string

    The accessibility hint for the 'yes' button of the cancel camera screen alert dialog.

    Default is "Tap to cancel document"

    accessibilityDescriptionCameraImportButton: string

    The accessibility hint for the 'import image' button, located in the bottom bar of the camera screen.

    Default is "Tap to import image"

    accessibilityDescriptionCameraIntroDoneButton: string

    The accessibility hint for the 'done' button of the introduction screen.

    Default is "Tap to close introduction screen"

    accessibilityDescriptionCameraLimitReachedOkButton: string

    The accessibility hint for the 'OK' button of the page limit reached alert dialog.

    Default is "Tap to close alert dialog"

    accessibilityDescriptionCameraManualSnapButton: string

    The accessibility hint for the 'manual snapping' mode button, located in the bottom bar of the camera screen.

    Default is "Tap to enable auto snapping mode"

    accessibilityDescriptionCameraPermissionCloseButton: string

    The accessibility hint for the 'close' button of the camera permission dialog.

    Default is "Close screen without granting permission"

    accessibilityDescriptionCameraPermissionEnableCameraButton: string

    The accessibility hint for the 'enable' button of the camera permission dialog.

    Default is "Tap to grant camera permission"

    accessibilityDescriptionCameraPreviewButton: string

    The accessibility hint for the 'preview' button, located in the bottom bar of the camera screen.

    Default is "Tap to preview scanned pages"

    accessibilityDescriptionCameraShutterButton: string

    The accessibility hint for the 'shutter' button, located in the bottom bar of the camera screen.

    Default is "Tap to take image"

    accessibilityDescriptionCameraTopBarCancelButton: string

    The accessibility hint for the 'cancel' button, located in the top bar of the camera screen.

    Default is "Tap to close scanner screen"

    accessibilityDescriptionCameraTopBarIntroButton: string

    The accessibility hint for the 'introduction' button, located in the top bar of the camera screen.

    Default is "Tap to open introduction screen"

    accessibilityDescriptionCameraTorchOffButton: string

    The accessibility hint for the 'flashlight off' button, located in the bottom bar of the camera screen.

    Default is "Tap to enable torch"

    accessibilityDescriptionCameraTorchOnButton: string

    The accessibility hint for the 'flashlight on' button, located in the bottom bar of the camera screen.

    Default is "Tap to disable torch"

    accessibilityDescriptionCroppingDetectButton: string

    The accessibility hint for the 'detect document' button, located in the bottom bar of the cropping screen.

    Default is "Tap to detect document on the image"

    accessibilityDescriptionCroppingResetButton: string

    The accessibility hint for the 'reset detection' button, located in the bottom bar of the cropping screen.

    Default is "Tap to reset document contour to whole image"

    accessibilityDescriptionCroppingRotateButton: string

    The accessibility hint for the 'rotate page' button, located in the bottom bar of the cropping screen.

    Default is "Tap to rotate document"

    accessibilityDescriptionCroppingTopBarCancelButton: string

    The accessibility hint for the 'cancel' button, located in the top bar of the cropping screen.

    Default is "Tap to close screen without applying changes"

    accessibilityDescriptionCroppingTopBarConfirmButton: string

    The accessibility hint for the 'confirm' button, located in the top bar of the cropping screen.

    Default is "Tap to apply changes"

    accessibilityDescriptionReorderTopBarCancelButton: string

    The accessibility hint for the 'cancel' button, located in the top bar of the reorder pages screen.

    Default is "Tap to close screen without applying changes"

    accessibilityDescriptionReorderTopBarConfirmButton: string

    The accessibility hint for the 'confirm' button, located in the top bar of the reorder pages screen.

    Default is "Tap to apply changes"

    accessibilityDescriptionReviewAddButton: string

    The accessibility hint for the 'add' button, located in the bottom bar of the review screen.

    Default is "Tap to Add new page"

    accessibilityDescriptionReviewCropButton: string

    The accessibility hint for the 'crop' button, located in the bottom bar of the review screen.

    Default is "Tap to Crop selected page"

    accessibilityDescriptionReviewDeleteAllButton: string

    The accessibility hint for the 'delete all' menu button, accessed via the 'more' button of the review screen.

    Default is "Tap to Delete all pages"

    accessibilityDescriptionReviewDeleteAllPagesAlertCancelButton: string

    The accessibility hint for the 'cancel' button of the delete all pages alert dialog for the review screen.

    Default is "Tap to Cancel operation"

    accessibilityDescriptionReviewDeleteAllPagesAlertDeleteButton: string

    The accessibility hint for the 'confirm' button of the delete all pages alert dialog for the review screen.

    Default is "Tap to Delete all pages"

    accessibilityDescriptionReviewDeleteButton: string

    The accessibility hint for the 'delete' button, located in the bottom bar of the review screen.

    Default is "Tap to Delete selected page"

    accessibilityDescriptionReviewDeletePageAlertCancelButton: string

    The accessibility hint for the 'cancel' button of the delete page alert dialog for the review screen.

    Default is "Tap to Cancel operation"

    accessibilityDescriptionReviewDeletePageAlertConfirmButton: string

    The accessibility hint for the 'confirm' button of the delete page alert dialog for the review screen.

    Default is "Tap to Delete page"

    accessibilityDescriptionReviewDeletePageAlertDeleteRetakeButton: string

    The accessibility hint for the 'delete and retake' button of the delete page alert dialog for the review screen.

    Default is "Tap to Delete page and Retake it"

    accessibilityDescriptionReviewMoreButton: string

    The accessibility hint for the 'more' button, located in the top bar of the review screen.

    Default is "Tap to show additional options"

    accessibilityDescriptionReviewNextPageButton: string

    The accessibility hint for the 'next page' button of the review screen.

    Default is "Tap to switch to the new page"

    accessibilityDescriptionReviewPreviousPageButton: string

    The accessibility hint for the 'previous page' button of the review screen.

    Default is "Tap to switch to the previous page"

    accessibilityDescriptionReviewReorderPagesButton: string

    The accessibility hint for the 'reorder pages' menu button, accessed via the 'more' button of the review screen.

    Default is "Tap to Reorder pages"

    accessibilityDescriptionReviewRetakeButton: string

    The accessibility hint for the 'retake' button, located in the bottom bar of the review screen.

    Default is "Tap to Retake current selected page"

    accessibilityDescriptionReviewRotateButton: string

    The accessibility hint for the 'rotate' button, located in the bottom bar of the review screen.

    Default is "Tap to Rotate selected page clockwise"

    accessibilityDescriptionReviewSubmitButton: string

    The accessibility hint for the 'submit' button, located in the bottom bar of the review screen.

    Default is "Tap to Submit document"

    accessibilityDescriptionReviewTopBarBackButton: string

    The accessibility hint for the 'back' button, located in the top bar of the review screen.

    Default is "Tap to Close review screen"

    accessibilityDescriptionReviewZoomButton: string

    The accessibility hint for the 'zoom' button of the review screen.

    Default is "Tap to open zoom overlay for selected page"

    accessibilityDescriptionZoomOverlayCancelButton: string

    The accessibility hint for the 'close' button of the zoom overlay for the review screen.

    Default is "Tap to Close zoom overlay"

    acknowledgementAcceptButtonTitle: string

    The 'accept' button title of the acknowledgement screen.

    Default is "Use Scan"

    acknowledgementRetakeButtonTitle: string

    The 'retake' button title of the acknowledgement screen.

    Default is "Retake"

    acknowledgementScreenBadDocumentHint: string

    The hint text of the acknowledgement screen explaining that the quality of the scanned page is unacceptable.

    Default is "The quality of your scan does not seem sufficient."

    acknowledgementTitle: string

    The title of the acknowledgement screen, located in the top bar.

    Default is "Acknowledgement"

    cameraAutoSnapButtonTitle: string

    The 'auto snapping' mode button title, located in the bottom bar of the camera screen.

    Default is "Auto"

    cameraBadgedPreviewButtonTitle: string

    The 'preview' button title, located in the bottom bar of the camera screen. With the badge showing the number of captured pages.

    Default is "Submit"

    cameraCancelAlertSubtitle: string

    The subtitle of the cancel camera screen alert dialog.

    Default is "Canceling will delete all the pages scanned so far. Are you sure you want to cancel?"

    cameraCancelAlertTitle: string

    The title of the cancel camera screen alert dialog.

    Default is "Cancel?"

    cameraCancelNoButtonTitle: string

    The 'no' button title of the cancel camera screen alert dialog.

    Default is "No"

    cameraCancelYesButtonTitle: string

    The 'yes' button title of the cancel camera screen alert dialog.

    Default is "Yes, Cancel"

    cameraImportButtonTitle: string

    The 'import image' button title, located in the bottom bar of the camera screen.

    Default is "Import"

    cameraIntroDoneButton: string

    The 'done' button title of the introduction screen, located in the top bar.

    Default is "Done"

    cameraIntroItem1: string

    The first scanning step text of the introduction screen.

    Default is "1. Place your document on a flat surface."

    cameraIntroItem2: string

    The second scanning step text of the introduction screen.

    Default is "2. Hold your phone above the document."

    cameraIntroItem3: string

    The third scanning step text of the introduction screen.

    Default is "3. Follow the on-screen guidance to find the optimal position."

    cameraIntroItem4: string

    The fourth scanning step text of the introduction screen.

    Default is "4. Once you reach the optimal position, you can manually scan the document or let the app scan it automatically."

    cameraIntroSubtitle: string

    The subtitle of the introduction screen.

    Default is "Follow the steps below to create a high-quality document scan"

    cameraIntroTitle: string

    The title of the introduction screen, located in the top bar.

    Default is "How to scan a document"

    cameraLimitReachedAlertSubtitle: string

    The subtitle of the page limit reached alert dialog.

    Default is "You have scanned the maximum number of pages and cannot add any more. Please delete at least one page to perform a new scan."

    cameraLimitReachedAlertTitle: string

    The title of the page limit reached alert dialog.

    Default is "You reached the limit!"

    cameraLimitReachedOkButtonTitle: string

    The 'OK' button title of the page limit reached alert dialog.

    Default is "Ok"

    cameraManualSnapButtonTitle: string

    The 'manual snapping' mode button title, located in the bottom bar of the camera screen.

    Default is "Manual"

    cameraPermissionCloseButton: string

    The 'close' button title of the camera permission dialog.

    Default is "Close"

    cameraPermissionEnableCameraButton: string

    The 'enable' button title of the camera permission dialog.

    Default is "Grant permission"

    cameraPermissionEnableCameraExplanation: string

    The explanation text of the camera permission dialog.

    Default is "Please allow the usage of the camera to start the scanning process."

    cameraPermissionEnableCameraTitle: string

    The title of the camera permission dialog.

    Default is "Camera permission denied!"

    cameraPreviewButtonTitle: string

    The 'preview' button title, located in the bottom bar of the camera screen. '%d' denotes the total number of captured pages.

    Default is "%d Pages"

    cameraProgressOverlayTitle: string

    The progress overlay title that is displayed on the camera screen during processing.

    Default is "Please wait..."

    cameraTopBarCancelButtonTitle: string

    The 'cancel' button title, located in the top bar of the camera screen and the reorder pages screen.

    Default is "Cancel"

    cameraTopBarTitle: string

    The title of the camera screen, located in the top bar.

    Default is "Scan Document"

    cameraTopGuidance: string

    The text for the static user guidance, located just below the top bar of the camera screen.

    Default is "Scan each page of your document."

    cameraTorchOffButtonTitle: string

    The 'flashlight off' button title, located in the bottom bar of the camera screen.

    Default is "Off"

    cameraTorchOnButtonTitle: string

    The 'flashlight on' button title, located in the bottom bar of the camera screen.

    Default is "On"

    cameraUserGuidanceBadAngles: string

    The user guidance text displayed when the document pitch/skew angle is unacceptable.

    Default is "Bad angles"

    cameraUserGuidanceBadAspectRatio: string

    The user guidance text displayed a detected documents aspect ratio is not within the acceptable range.

    Default is "Bad aspect ratio"

    cameraUserGuidanceEnergySaveMode: string

    The user guidance text displayed when the device is in energy saving mode. iOS only.

    Default is "Energy save mode is on"

    cameraUserGuidanceNoDocumentFound: string

    The user guidance text displayed when no document is found.

    Default is "No document found"

    cameraUserGuidanceOrientationMismatch: string

    The user guidance text displayed when a landscape document is detected when the camera is in portrait mode (and vice versa).

    Default is "Orientation mismatch"

    cameraUserGuidanceReadyToCapture: string

    The user guidance text displayed when the document is ready to be captured in 'auto snapping' mode.

    Default is "Hold still capturing..."

    cameraUserGuidanceReadyToCaptureManual: string

    The user guidance text displayed when the document is ready to be captured in 'manual snapping' mode.

    Default is "Ready to capture!"

    cameraUserGuidanceStart: string

    The user guidance text that is initially displayed, before a document is detected.

    Default is "Please hold your device over a document."

    cameraUserGuidanceTextHintOffCenter: string

    The user guidance text displayed when the document is not centered in the finder view.

    Default is "Document is off center"

    cameraUserGuidanceTooDark: string

    The user guidance text displayed when it is too dark to capture an adequate image.

    Default is "Its too dark. Add more light."

    cameraUserGuidanceTooNoisy: string

    The user guidance text displayed when the background is too noisy.

    Default is "Its too noisy. Try another background for the document"

    cameraUserGuidanceTooSmall: string

    The user guidance text displayed when the document is too far from camera.

    Default is "Document is too small. Move camera closer."

    croppingDetectButtonTitle: string

    The 'detect document' button title, located in the bottom bar of the cropping screen.

    Default is "Detect"

    croppingResetButtonTitle: string

    The 'reset detection' button title, located in the bottom bar of the cropping screen.

    Default is "Reset"

    croppingRotateButtonTitle: string

    The 'rotate page' button title, located in the bottom bar of the cropping screen.

    Default is "Rotate"

    croppingScreenTitle: string

    The title of the cropping screen, located in the top bar.

    Default is "Crop"

    croppingTopBarCancelButtonTitle: string

    The 'cancel' button title, located in the top bar of the cropping screen.

    Default is "Cancel"

    croppingTopBarConfirmButtonTitle: string

    The 'confirm' button title, located in the top bar of the cropping screen.

    Default is "Done"

    reorderPageGuidanceTitle: string

    The text for the static user guidance, located just below the top bar of the reorder pages screen.

    Default is "Drag pages to reorder"

    reorderPageText: string

    The title below each page object of the reorder pages screen. '%d' denotes the current page number.

    Default is "%d"

    reorderPageTitle: string

    The title of the reorder pages screen, located in the top bar.

    Default is "Reorder Pages"

    reorderTopBarCancelButtonTitle: string

    The 'cancel' button title, located in the top bar of the reorder pages screen.

    Default is "Cancel"

    reorderTopBarConfirmButtonTitle: string

    The 'confirm' button title, located in the top bar of the reorder pages screen.

    Default is "Done"

    reviewDeleteAllPagesAlertCancelButtonTitle: string

    The 'cancel' button title of the delete all pages alert dialog for the review screen.

    Default is "Cancel"

    reviewDeleteAllPagesAlertDeleteButtonTitle: string

    The 'confirm' button title of the delete all pages alert dialog for the review screen.

    Default is "Yes, Delete all"

    reviewDeleteAllPagesAlertSubtitle: string

    The subtitle of the delete all pages alert dialog for the review screen.

    Default is "Are you sure you want to delete all pages?"

    reviewDeleteAllPagesAlertTitle: string

    The title of the delete all pages alert dialog for the review screen.

    Default is "Delete all?"

    reviewDeletePageAlertCancelButtonTitle: string

    The 'cancel' button title of the delete page alert dialog for the review screen.

    Default is "Cancel"

    reviewDeletePageAlertConfirmButtonTitle: string

    The 'confirm' button title of the delete page alert dialog for the review screen.

    Default is "Yes, Delete"

    reviewDeletePageAlertDeleteRetakeButtonTitle: string

    The 'delete and retake' button title of the delete page alert dialog for the review screen.

    Default is "Delete and Retake"

    reviewDeletePageAlertSubTitle: string

    The subtitle of the delete page alert dialog for the review screen.

    Default is "Are you sure you want to delete the page?"

    reviewDeletePageAlertTitle: string

    The title of the delete page alert dialog for the review screen.

    Default is "Delete page?"

    reviewScreenAddButtonTitle: string

    The 'add' button title, located in the bottom bar of the review screen.

    Default is "Add"

    reviewScreenCropButtonTitle: string

    The 'crop' button title, located in the bottom bar of the review screen.

    Default is "Crop"

    reviewScreenDeleteAllButtonTitle: string

    The 'delete all' menu button title, accessed via the 'more' button of the review screen.

    Default is "Delete all"

    reviewScreenDeleteButtonTitle: string

    The 'delete' button title, located in the bottom bar of the review screen.

    Default is "Delete"

    reviewScreenPageCount: string

    The page count label text. The first occurrence of '%d' denotes the current page number, while the second occurrence of '%d' denotes the total number of captured pages.

    Default is "Page %d/%d"

    reviewScreenReorderPagesButtonTitle: string

    The 'reorder pages' menu button title, accessed via the 'more' button of the review screen.

    Default is "Reorder pages"

    reviewScreenRetakeButtonTitle: string

    The 'retake' button title, located in the bottom bar of the review screen.

    Default is "Retake"

    reviewScreenRotateButtonTitle: string

    The 'rotate' button title, located in the bottom bar of the review screen.

    Default is "Rotate"

    reviewScreenSubmitButtonTitle: string

    The 'submit' button title, located in the bottom bar of the review screen.

    Default is "Submit"

    reviewScreenTitle: string

    The title of the review screen, located in the top bar. '%d' denotes the total number of captured pages.

    Default is "Review (%d)"

    reviewTopBarBackButtonTitle: string

    The 'back' button title, located in the top bar of the review screen.

    Default is "Back"

    zoomOverlayCancelButtonText: string

    The 'close' button title of the zoom overlay for the review screen.

    Default is "Close"