All Implemented Interfaces:


public final class IdScan.Builder

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description
`IdScan.Builder()`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final IdScan.Builder`	`from(IdScan existingIdScan)`
`final IdScan.Builder`	`setShowIdTutorials(Boolean showIdTutorials)`
`final IdScan.Builder`	`setWaitForTutorials(Boolean waitForTutorials)`
`final IdScan.Builder`	`setEnableFrontShownAsBackCheck(Boolean enableFrontShownAsBackCheck)`	Enables/disables check if front shown while scanning back.
`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.
`final IdScan.Builder`	`setShowIdTypeChooser(Boolean showIdTypeChooser)`	Controls whether the document selection (ID type chooser) screen is shown.
`final IdScan.Builder`	`setIdType(IdScan.IdType idType)`	Sets the document type to be used for the ID capture flow.
`final IdScan.Builder`	`setIdCategory(IdCategory idCategory)`
`final IdScan.Builder`	`setScanStep(IdScan.ScanStep scanStep)`	Sets which steps of the ID scanning process should be taken.
`final IdScan.Builder`	`setShowRetakeScreen(Boolean showForManualCapture, Boolean showForAutoCapture)`
`final IdScan.Builder`	`setShowRetakeScreen(Boolean showForManualCapture)`
`final IdScan.Builder`	`setShowRetakeScreenForAutoCapture(Boolean showRetakeScreenForAutoCapture)`	Controls whether the Review Screen is shown after using Auto Capture
`final IdScan.Builder`	`setShowRetakeScreenForManualCapture(Boolean showRetakeScreenForManualCapture)`	Controls whether the Review Screen is shown after using Manual Capture
`final IdScan.Builder`	`setEnableRotationOnRetakeScreen(Boolean enable)`
`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.
`final IdScan.Builder`	`setShowIdOverlay(Boolean isVisible)`	Enables ID overlay.
`final IdScan.Builder`	`setStreamFramesEnabled(Boolean streamFramesEnabled)`	Enables or disables video streaming of the IdScan module.
`final IdScan.Builder`	`setAutoCaptureTimeout(Integer autoCaptureTimeout)`	Sets the ID auto capture timeout in seconds.
`final IdScan.Builder`	`setAutoCaptureNoIdTimeout(Integer autoCaptureNoIdTimeout)`	Sets the ID auto capture timeout in seconds for the fallback timer.
`final IdScan.Builder`	`setCaptureAttempts(Integer captureAttempts)`	Sets the ID capture attempts.
`final IdScan.Builder`	`setStreamAudioEnabled(Boolean enabled)`	Enables or disables audio during streaming of the IdScan module.
`final IdScan.Builder`	`setDigitalIdEnabled(Boolean enabled)`	Enables or disables the Digital ID option, in form of a PDF file, on the Document chooser screen, when the IdType is not set.
`final IdScan`	`build()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IdScan.Builder
```
IdScan.Builder()
```
- Method Detail
  - from
```
 final IdScan.Builder from(IdScan existingIdScan)
```
  - setShowIdTutorials
```
 final IdScan.Builder setShowIdTutorials(Boolean showIdTutorials)
```
    Parameters:
    
    showIdTutorials - If true, tutorials will be shown on how to scan an ID.
    
    Returns:
    
    Builder
  - setWaitForTutorials
```
@Deprecated(message = "No longer supported in the new UI") 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
```
 final IdScan.Builder setShowIdTypeChooser(Boolean showIdTypeChooser)
```
    Controls whether the document selection (ID type chooser) screen is shown.
    If set to true, the SDK will display a document chooser screen, allowing the end user to select from the enabled document types.
    If set to false, the SDK will skip the chooser screen and proceed directly with the document type defined via IdScan.Builder.setIdType(IdScan.IdType).
    When using Dashboard (backend) configuration, the chooser will display only the document types enabled in the Dashboard. When using local configuration, the chooser will display ID and Passport by default, and optionally Digital ID (or any other available document type) if enabled.
    If both setShowIdTypeChooser(true) and setIdType(...) are provided, the chooser takes precedence and the explicitly set ID type is ignored.
    
    Since:
    
    5.33.0
    Previously Deprecated in: 2.4.0
  - setIdType
```
 final IdScan.Builder setIdType(IdScan.IdType idType)
```
    Sets the document type to be used for the ID capture flow.
    When the document chooser is not shown, this value determines which document type will be used for the capture process.
    If the chooser is disabled and no document type is explicitly set (or null is provided), the default document type is IdScan.IdType.ID.
    When using Dashboard (backend) configuration, the available document types are controlled by the Dashboard settings. In that case, this method defines the document type only if the chooser is disabled and the selected type is enabled in the configuration.
    Note: This setting is ignored if IdScan.Builder.setShowIdTypeChooser(true) is set.
    
    Since:
    
    2.4.0
  - 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
```
@Deprecated(message = "Deprecated to improve clarity. Manual and auto capture now have separate methods: [setShowRetakeScreenForManualCapture] and [setShowRetakeScreenForAutoCapture].")@JvmOverloads() final IdScan.Builder setShowRetakeScreen(Boolean showForManualCapture, Boolean showForAutoCapture)
```
    Parameters:
    
    showForManualCapture - Shows (true) or hides (false) retake screen after manual capture mode was used.
    
    showForAutoCapture - Shows (true) or hides (false) retake screen after auto capture mode was used.
    
    Returns:
    
    Builder
    
    Since:
    
    Deprecated in <a href=https://developer.incode.com/docs/changelog#/version-5340-core-light-267-nfc-140-qr-face-login-125---2025-mar-03>5.34.0</a>
  - setShowRetakeScreen
```
@Deprecated(message = "Deprecated to improve clarity. Manual and auto capture now have separate methods: [setShowRetakeScreenForManualCapture] and [setShowRetakeScreenForAutoCapture].")@JvmOverloads() final IdScan.Builder setShowRetakeScreen(Boolean showForManualCapture)
```
    Parameters:
    
    showForManualCapture - Shows (true) or hides (false) retake screen after manual capture mode was used.
    
    Returns:
    
    Builder
    
    Since:
    
    Deprecated in <a href=https://developer.incode.com/docs/changelog#/version-5340-core-light-267-nfc-140-qr-face-login-125---2025-mar-03>5.34.0</a>
  - setShowRetakeScreenForAutoCapture
```
 final IdScan.Builder setShowRetakeScreenForAutoCapture(Boolean showRetakeScreenForAutoCapture)
```
    Controls whether the Review Screen is shown after using Auto Capture
    
    Parameters:
    
    showRetakeScreenForAutoCapture - Shows (true) or hides (false) retake screen after auto capture mode was used.
    
    Returns:
    
    Builder
    
    Since:
    
    <a href="https://developer.incode.com/docs/changelog#/version-5290-kiosk-login-135-nfc-135-qr-face-login-123-core-light-264---2024-jul-19">5.29.0</a>
  - setShowRetakeScreenForManualCapture
```
 final IdScan.Builder setShowRetakeScreenForManualCapture(Boolean showRetakeScreenForManualCapture)
```
    Controls whether the Review Screen is shown after using Manual Capture
    
    Parameters:
    
    showRetakeScreenForManualCapture - Shows (true) or hides (false) retake screen after manual capture mode was used.
    
    Returns:
    
    Builder
    
    Since:
    
    <a href="https://developer.incode.com/docs/changelog#/version-5290-kiosk-login-135-nfc-135-qr-face-login-123-core-light-264---2024-jul-19">5.29.0</a>
  - setEnableRotationOnRetakeScreen
```
@Deprecated(message = "No longer supported in the new UI") final IdScan.Builder setEnableRotationOnRetakeScreen(Boolean enable)
```
  - setAutocaptureUXMode
```
@Deprecated(message = "No longer supported in the new UI") 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
```
@Deprecated(message = "No longer supported in the new UI") 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.
  - setAutoCaptureNoIdTimeout
```
 final IdScan.Builder setAutoCaptureNoIdTimeout(Integer autoCaptureNoIdTimeout)
```
    Sets the ID auto capture timeout in seconds for the fallback timer. The timer is counting down since start of the module, until an ID is detected for the first time.
    
    Parameters:
    
    autoCaptureNoIdTimeout - Auto capture fallback timeout value.
  - setCaptureAttempts
```
 final IdScan.Builder setCaptureAttempts(Integer captureAttempts)
```
    Sets the ID capture attempts.
    
    Parameters:
    
    captureAttempts - Capture attempts value.
  - setStreamAudioEnabled
```
 final IdScan.Builder setStreamAudioEnabled(Boolean enabled)
```
    Enables or disables audio during streaming of the IdScan module.
    
    Parameters:
    
    enabled - If true, audio is streamed along with video during ID scan.
  - setDigitalIdEnabled
```
 final IdScan.Builder setDigitalIdEnabled(Boolean enabled)
```
    Enables or disables the Digital ID option, in form of a PDF file, on the Document chooser screen, when the IdType is not set.
    
    Parameters:
    
    enabled - If true, Document chooser screen will show three instead of two document options, including the Digital ID.
  - build
```
 final IdScan build()
```

Class IdScan.Builder

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IdScan.Builder

Method Detail

from

setShowIdTutorials

setWaitForTutorials

setEnableFrontShownAsBackCheck

setEnableBackShownAsFrontCheck

setShowIdTypeChooser

setIdType

setIdCategory

setScanStep

setShowRetakeScreen

setShowRetakeScreen

setShowRetakeScreenForAutoCapture

setShowRetakeScreenForManualCapture

setEnableRotationOnRetakeScreen

setAutocaptureUXMode

setShowIdOverlay

setStreamFramesEnabled

setAutoCaptureTimeout

setAutoCaptureNoIdTimeout

setCaptureAttempts

setStreamAudioEnabled

setDigitalIdEnabled

build