LogoLogo
Useful links
  • Home
  • Product guides
  • API
  • SDKs
  • Overview
  • First steps
  • ANDROID
    • Getting Started with the SDK
    • Standalone Modules
      • Document Detector
        • Release Notes
        • Current Version
        • Requirements
        • Gradle Dependencies
        • Gradle Source Code
        • Setting up the SDK
          • Setting properties
          • Capture Stages
          • Messages Settings
          • Customization
          • Security Settings
          • Detection Steps
          • Upload Mode
          • Advanced Settings
            • Proxy configuration
            • Preview configuration
        • Start Document Detection
        • Source Code
        • Google security form
        • Reduce SDKs size
        • SDKs response
        • References
        • FAQ
      • Face Liveness
        • Release Notes
        • Current Version
        • Requirements
        • Gradle Dependencies
        • Gradle Source Code
        • SDK Lifecycle
        • Building the SDK
        • Start Liveness Verification
        • Source Code
        • References
        • Advanced Features
        • FAQ
      • Face Authenticator
        • Release Notes
      • Smart Auth
        • Release Notes
        • Current Version
        • Requirements
        • Gradle Dependencies
        • Gradle Source Code
        • Permissions
        • SDK Lifecycle
        • Building the SDK
        • Start Smart Authentication
        • Source Code
        • References
        • FAQ
      • Face Liveness (deprecated)
        • Release Notes
  • iOS
    • Getting Started with the SDK
    • Standalone Modules
      • Document Detector
        • Release Notes
        • Current Version
        • Requirements
        • Installing the SDK
        • Setting up the SDK
          • Setting properties
          • Messages Settings
          • Customization
          • Detection Steps
          • Upload Mode
          • Advanced Settings
            • Proxy configuration
            • Preview configuration
        • Start Document Detection
        • References
        • FAQ
      • Face Liveness
        • Release Notes
        • Installation
        • Current Version
        • Requirements
        • SDK Lifecycle
        • Building the SDK
        • Start Liveness Verification
        • Source Code
        • References
        • FAQ
      • Face Authenticator
        • Release Notes
        • Installation
        • Current Version
        • Requirements
        • Building the SDK
        • Start the SDK
        • References
        • FAQ
      • Smart Auth
        • Release Notes
        • Installation
        • Current Version
        • Requirements
        • SDK Lifecycle
        • Building the SDK
        • Start Smart Authentication
        • Source Code
        • References
        • FAQ
      • Face Liveness (deprecated)
        • Release Notes
  • REACT NATIVE
    • Standalone Modules
      • Document Detector
        • Release Notes
        • Current Version
        • Requirements
        • Installation
        • Hooks
        • Start Document Verification
        • Source Code
        • TypeScript References
        • Customizing Style
        • FAQ
      • Face Liveness
        • Release Notes
        • Current Version
        • Requirements
        • Installation
        • Hooks
        • Start Liveness Verification
        • Source Code
        • TypeScript References
        • FAQ
      • Face Authenticator
        • Release Notes
        • Current Version
        • Requirements
        • Installation
        • Hooks
        • Start Authentication Verification
        • Source Code
        • TypeScript References
        • FAQ
      • Smart Auth
        • Getting started
        • Release notes
        • Using Native Modules
          • Requirements
          • Gradle Source Code
          • Podfile Source Code
          • Native Module Android
          • Native Module iOS
          • Import Native Modules
          • Source Code
          • TypeScript References
          • FAQ
        • Using Expo Modules
          • Requirements
          • Create Local Expo Module
          • Gradle Source Code
          • Podspec Source Code
          • Native Module Android
          • Native Module iOS
          • Import Expo Modules
          • Source Code
          • TypeScript References
          • FAQ
  • WEB (JAVASCRIPT)
    • Standalone Modules
      • Document Detector
        • Getting started
        • SDK builder options
          • Analytics
          • Appearance
          • Messages
        • SDK methods
        • Event listeners
        • Customization
        • Release notes
      • Face Liveness
        • Customization
        • Release notes
      • Face Authenticator
        • Customization
        • Release notes
      • Smart Auth
        • SDK errors
        • Customization
        • Release notes
LogoLogo

2025 © Caf. - All rights reserved

On this page
  1. ANDROID
  2. Standalone Modules
  3. Document Detector
  4. Setting up the SDK

Messages Settings

To use, simply instantiate a MessageSettings object and use the methods as needed for customization.

Method
Description
Default Value

.setPopupDocumentSubtitleMessage(message: Int)

Subtitle message in the pop-up showing the document illustration.

"Place the document on a desk, center it on the frame, and hold for capture."

.setFitTheDocumentMessage(message: Int)

Message prompting the user to fit the document to the frame.

"Fit the document on the frame."

.setHoldItMessage(message: Int)

Message shown during the capture process.

"Keep it steady."

.setVerifyingQualityMessage(message: Int)

Message displayed during the quality verification request.

"Checking document..."

.setLowQualityDocumentMessage(message: Int)

Message shown when the document capture fails due to low quality.

"Couldn't read the information. Please try again."

.setUploadingImageMessage(message: Int)

Message shown when saving the captured image to the server.

"Uploading image..."

.setShowOpenDocumentErrorMessage(show: Boolean, message: Int)

Message shown if an open document is detected.

"Close your document and try again."

.setWaitMessage(show: Boolean, message: Int)

Message displayed when starting the camera.

"Please wait..."

.setSensorLuminosityMessage(message: Int)

Message shown when the brightness level is too low.

"The area is too dark."

.setSensorOrientationMessage(message: Int)

Message shown when the orientation threshold is not met.

"Point the camera downward."

.setSensorStabilityMessage(message: Int)

Message shown when the device is not stable enough.

"Hold the device steady."

.setWrongDocumentTypeMessageResourceId(message: Int)

Message shown when the document type is incorrect. Use %1$s for the expected document.

"This document is not %1$s."

.setPositiveButtonMessage(message: Int)

Customizes the confirmation button text.

"OK, got it."

.setUploadedImageIsTooLargeTitle(message: Int)

Title for the upload popup when the file exceeds the max size.

"File size exceeded."

.setUploadedImageIsTooLargeMessage(message: Int)

Message for the upload popup when the file exceeds the max size. Use %1$s for max size.

"The file exceeds the max size of %1$d MB. Upload a smaller file."

.setUploadedImageHasInvalidFormatTitle(message: Int)

Title for the upload popup when the file format is invalid.

"Invalid format."

.setUploadedImageNotSupportedFormatMessage(message: Int)

Message for unsupported file formats in the upload popup.

"Unsupported file format. Use JPG, PNG, or PDF."

.setUploadedImageGenericErrorTitle(message: Int)

Generic error title for the upload popup.

"Something went wrong."

.setUploadedImageWrongMessage(message: Int)

Message for an unexpected document in the upload popup.

"This is not the expected document. Upload the correct one."

.setUploadedImageLowQualityTitle(message: Int)

Title for the upload popup when the image quality is low.

"Low quality image."

.setUploadedImageLowQualityMessage(message: Int)

Message for low-quality images in the upload popup.

"The image quality is too low. Upload a better one."

.setUploadPopupLoadingMessage(message: Int)

Message shown during file upload in the popup.

"Uploading document..."

.setPredictorScanDocumentMessage(resId: Int)

Message prompting the user to scan a document.

"Scan a document."

.setPredictorGetCloserMessage(resId: Int)

Message asking the user to get closer to the document.

"Move closer to the document."

.setPredictorCentralizeMessage(resId: Int)

Message asking the user to center the document.

"Center the document."

.setPredictorMoveAwayMessage(resId: Int)

Message asking the user to move away from the document.

"Move farther from the document."

.setPredictorAlignDocumentMessage(resId: Int)

Message asking the user to align the document.

"Align the document."

.setPredictorTurnDocumentMessage(resId: Int)

Message asking the user to rotate the document 90 degrees.

"Rotate the document ⤵️."

.setPredictorCapturedMessage(resId: Int)

Message confirming the document has been captured.

"Document captured."

.setUnsupportedDocumentMessage(message: Int)

Message for unsupported documents.

"This document is not supported."

.setDocumentNotFoundMessage(message: Int)

Message when no document is detected.

"No document found."

Example

val messageSettings = MessageSetings()
    .setFitTheDocumentMessage(R.string.example_resource)
    .setHoldItMessage(R.string.example_resource);

Last updated 2 months ago