Constructor Detail

• IdScan.Builder

  IdScan.Builder()

Method Detail

• setShowIdTutorials

   final IdScan.Builder setShowIdTutorials(Boolean showIdTutorials)

  Parameters:

  showIdTutorials - If true, tutorials will be shown on how to scan an ID.

  Returns:

  Builder

• setWaitForTutorials

   final IdScan.Builder setWaitForTutorials(Boolean waitForTutorials)

• setEnableFrontShownAsBackCheck

   final IdScan.Builder setEnableFrontShownAsBackCheck(Boolean enableFrontShownAsBackCheck)

  Enables/disables check if front shown while scanning back. Make sure to include 'com.incode.sdk:model-id-face-detection' in order to use this feature.

  Parameters:

  enableFrontShownAsBackCheck - If true, will perform check.

  Returns:

  Builder

• setEnableBackShownAsFrontCheck

   final IdScan.Builder setEnableBackShownAsFrontCheck(Boolean enableBackShownAsFrontCheck)

  Enables/disables check if back shown while scanning front Make sure to include 'com.incode.sdk:model-id-face-detection' in order to use this feature.

  Parameters:

  enableBackShownAsFrontCheck - If true, will perform check.

  Returns:

  Builder

• setShowIdTypeChooser

  @Deprecated(message = "use {@link #setIdType(IdType)}") final IdScan.Builder setShowIdTypeChooser(Boolean showIdTypeChooser)

• setIdType

   final IdScan.Builder setIdType(IdScan.IdType idType)

• setIdCategory

   final IdScan.Builder setIdCategory(IdCategory idCategory)

• setScanStep

   final IdScan.Builder setScanStep(IdScan.ScanStep scanStep)

  Sets which steps of the ID scanning process should be taken.

  Parameters:

  scanStep - Represents which steps in the ID scanning process will be included.

  Returns:

  Builder

• setShowRetakeScreen

  @JvmOverloads() final IdScan.Builder setShowRetakeScreen(Boolean showForManualCapture, Boolean showForAutoCapture)

  Parameters:

  showForAutoCapture - Shows (true) or hides (false) retake screen after auto capture mode was used.

  Returns:

  Builder

• setShowRetakeScreen

  @JvmOverloads() final IdScan.Builder setShowRetakeScreen(Boolean showForManualCapture)

  Returns:

  Builder

• setEnableRotationOnRetakeScreen

   final IdScan.Builder setEnableRotationOnRetakeScreen(Boolean enable)

• setAutocaptureUXMode

   final IdScan.Builder setAutocaptureUXMode(IdScan.AutocaptureUXMode autocaptureUXMode)

  Sets the type of feedback which is displayed before ID or Passport is captured in the scan process.

  Parameters:

  autocaptureUXMode - Countdown mode or HoldStill mode with the option to set duration.

  Returns:

  Builder

• setShowIdOverlay

   final IdScan.Builder setShowIdOverlay(Boolean isVisible)

  Enables ID overlay.

  Parameters:

  isVisible -

  • If true, will show ID overlay. Default is false.

  Returns:

  Builder

• setStreamFramesEnabled

   final IdScan.Builder setStreamFramesEnabled(Boolean streamFramesEnabled)

  Enables or disables video streaming of the IdScan module. Make sure to include 'com.incode.sdk:video-streaming' in order to use this feature.

  <p> Note: This setting is ignored if the device has 2GB of RAM or less.

  Parameters:

  streamFramesEnabled - If true, perform streaming during the ID scan.

  Returns:

  Builder

• setAutoCaptureTimeout

   final IdScan.Builder setAutoCaptureTimeout(Integer autoCaptureTimeout)

  Sets the ID auto capture timeout in seconds.

  Parameters:

  autoCaptureTimeout - Auto capture timeout value.

• setCaptureAttempts

   final IdScan.Builder setCaptureAttempts(Integer captureAttempts)

  Sets the ID capture attempts.

  Parameters:

  captureAttempts - Capture attempts value.

• build

   final IdScan build()