All Implemented Interfaces:
```
public final class IncodeWelcome.Builder

                    
```
Provides the methods to create and initialize a IncodeWelcome object. Capture Only SDK init requires only application parameter. External token SDK init (no apiKey SDK init) requires application and apiUrl parameter.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private String`	`apiUrl`

Constructor Summary

Constructors
Constructor	Description
`IncodeWelcome.Builder(Application application, String apiUrl, String apiKey, String e2eeUrl)`
`IncodeWelcome.Builder(Application application, String apiUrl, String apiKey)`
`IncodeWelcome.Builder(Application application, String apiUrl)`
`IncodeWelcome.Builder(Application application)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getApiUrl()`
`final Unit`	`setApiUrl(String apiUrl)`
`final IncodeWelcome.Builder`	`setClientExperimentId(String clientExperimentId)`	Sets the client experiment ID for A/B testing.
`final IncodeWelcome.Builder`	`setSdkMode(SdkMode sdkMode)`	Sets the SdkMode
`final IncodeWelcome.Builder`	`setSSLConfig(IncodeWelcome.SSLConfig sslConfig)`
`final IncodeWelcome.Builder`	`configureSSLPinning(Boolean isEnabled, Boolean forceSSLPinning)`
`final IncodeWelcome.Builder`	`configureSSLPinning(Boolean isEnabled)`
`final IncodeWelcome.Builder`	`setLoggingEnabled(Boolean enableLogging)`
`final IncodeWelcome.Builder`	`setExternalAnalyticsEnabled(Boolean enableExternalAnalytics)`
`final IncodeWelcome.Builder`	`setExternalScreenshotsEnabled(Boolean enableExternalScreenshots)`
`final IncodeWelcome.Builder`	`setCaptureModeEnabled()`
`final IncodeWelcome.Builder`	`setTestModeEnabled(Boolean enableTestMode)`
`final IncodeWelcome.Builder`	`enableLocalFaceRecognition(Boolean enableLocalFaceRecognition)`
`final IncodeWelcome.Builder`	`enableLocalLiveness(Boolean enableLocalLiveness)`
`final IncodeWelcome.Builder`	`enableMaskDetection(Boolean enableMaskDetection)`
`final IncodeWelcome.Builder`	`disableHookCheck(Boolean disableHookCheck)`	Disables the hooking framework check.
`final IncodeWelcome.Builder`	`disableEmulatorDetection(Boolean disableEmulatorDetection)`	Disables emulator detection.
`final IncodeWelcome.Builder`	`disableRootDetection(Boolean disableRootDetection)`	Disables root detection.
`final IncodeWelcome.Builder`	`disableVirtualEnvironmentDetection(Boolean disableVirtualEnvironmentDetection)`	Disables virtual environment detection.
`final IncodeWelcome.Builder`	`enableInstallSizeOptimization(Boolean enableInstallSizeOptimization)`
`final IncodeWelcome.Builder`	`setCrashReportingEnabled(Boolean crashReportingEnabled)`
`final Unit`	`build()`	Builds the IncodeWelcome object

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

- Constructor Detail
  - IncodeWelcome.Builder
```
IncodeWelcome.Builder(Application application, String apiUrl, String apiKey, String e2eeUrl)
```
    Parameters:
    
    application - client application, this is a mandatory parameter.
    
    apiUrl - url of the server used for registration and authentication.
    
    apiKey - registered key to identify your application.
    
    e2eeUrl - url of the server used for End to End Encryption.
  - IncodeWelcome.Builder
```
IncodeWelcome.Builder(Application application, String apiUrl, String apiKey)
```
    Parameters:
    
    application - client application, this is a mandatory parameter.
    
    apiUrl - url of the server used for registration and authentication.
    
    apiKey - registered key to identify your application.
  - IncodeWelcome.Builder
```
IncodeWelcome.Builder(Application application, String apiUrl)
```
    Parameters:
    
    application - client application, this is a mandatory parameter.
    
    apiUrl - url of the server used for registration and authentication.
  - IncodeWelcome.Builder
```
IncodeWelcome.Builder(Application application)
```
    Parameters:
    
    application - client application, this is a mandatory parameter.
- Method Detail
  - getApiUrl
```
 final String getApiUrl()
```
  - setApiUrl
```
 final Unit setApiUrl(String apiUrl)
```
    Parameters:
    
    apiUrl - url of the server used for registration and authentication.
  - setClientExperimentId
```
 final IncodeWelcome.Builder setClientExperimentId(String clientExperimentId)
```
    Sets the client experiment ID for A/B testing.
  - setSdkMode
```
 final IncodeWelcome.Builder setSdkMode(SdkMode sdkMode)
```
    Sets the SdkMode
    
    Parameters:
    
    sdkMode - SdkMode.STANDARD or SdkMode.CAPTURE_ONLY
  - setSSLConfig
```
 final IncodeWelcome.Builder setSSLConfig(IncodeWelcome.SSLConfig sslConfig)
```
    Parameters:
    
    sslConfig - optional sslConfig for on-premise servers
  - configureSSLPinning
```
 final IncodeWelcome.Builder configureSSLPinning(Boolean isEnabled, Boolean forceSSLPinning)
```
    Parameters:
    
    isEnabled - enable or disable SSL Certificate Pinning.
    
    forceSSLPinning - force or not SDK to use SSL Certificate Pinning all the time.
  - configureSSLPinning
```
 final IncodeWelcome.Builder configureSSLPinning(Boolean isEnabled)
```
    Parameters:
    
    isEnabled - enable or disable SSL Certificate Pinning.
  - setLoggingEnabled
```
 final IncodeWelcome.Builder setLoggingEnabled(Boolean enableLogging)
```
    Parameters:
    
    enableLogging - enables or disables Logcat SDK logs.
  - setExternalAnalyticsEnabled
```
 final IncodeWelcome.Builder setExternalAnalyticsEnabled(Boolean enableExternalAnalytics)
```
    Parameters:
    
    enableExternalAnalytics - enables or disables collecting analytics events for screens outside of the Incode SDK.
  - setExternalScreenshotsEnabled
```
 final IncodeWelcome.Builder setExternalScreenshotsEnabled(Boolean enableExternalScreenshots)
```
    Parameters:
    
    enableExternalScreenshots - enables or disables collecting screenshots of screens outside of the Incode SDK.
  - setCaptureModeEnabled
```
 final IncodeWelcome.Builder setCaptureModeEnabled()
```
  - setTestModeEnabled
```
 final IncodeWelcome.Builder setTestModeEnabled(Boolean enableTestMode)
```
    Parameters:
    
    enableTestMode - enables or disables test mode.
  - enableLocalFaceRecognition
```
@Deprecated(message = "Please include model-face-recognition as a separate module in your project instead of using this method") final IncodeWelcome.Builder enableLocalFaceRecognition(Boolean enableLocalFaceRecognition)
```
    Parameters:
    
    enableLocalFaceRecognition - enables use of local face recognition within the SDK.
  - enableLocalLiveness
```
@Deprecated(message = "Please include model-liveness-detection as a separate module in your project instead of using this method") final IncodeWelcome.Builder enableLocalLiveness(Boolean enableLocalLiveness)
```
    Parameters:
    
    enableLocalLiveness - enables use of local liveness within the SDK.
  - enableMaskDetection
```
@Deprecated(message = "Please call {@link SelfieScan.Builder#setMaskCheckEnabled(boolean)} instead of using this method.") final IncodeWelcome.Builder enableMaskDetection(Boolean enableMaskDetection)
```
    Parameters:
    
    enableMaskDetection - enables use of mask detection feature within the SDK.
  - disableHookCheck
```
 final IncodeWelcome.Builder disableHookCheck(Boolean disableHookCheck)
```
    Disables the hooking framework check. If disabled, a Flow will continue to run regardless of the presence of a hooking framework.
    
    Parameters:
    
    disableHookCheck - Default value is false.
  - disableEmulatorDetection
```
 final IncodeWelcome.Builder disableEmulatorDetection(Boolean disableEmulatorDetection)
```
    Disables emulator detection. If disabled, a Flow will continue to run regardless of if the device is an emulator, or a real device.
    
    Parameters:
    
    disableEmulatorDetection - Default value is false.
  - disableRootDetection
```
 final IncodeWelcome.Builder disableRootDetection(Boolean disableRootDetection)
```
    Disables root detection. If disabled, a Flow will continue to run regardless of if this device has been rooted or not.
    
    Parameters:
    
    disableRootDetection - Default value is false.
  - disableVirtualEnvironmentDetection
```
 final IncodeWelcome.Builder disableVirtualEnvironmentDetection(Boolean disableVirtualEnvironmentDetection)
```
    Disables virtual environment detection. If disabled, a Flow will continue to run regardless of if the app is running in a virtual environment or not.
    
    Parameters:
    
    disableVirtualEnvironmentDetection - Default value is false.
  - enableInstallSizeOptimization
```
 final IncodeWelcome.Builder enableInstallSizeOptimization(Boolean enableInstallSizeOptimization)
```
    Parameters:
    
    enableInstallSizeOptimization - enables post installation size reduction of the SDK
  - setCrashReportingEnabled
```
 final IncodeWelcome.Builder setCrashReportingEnabled(Boolean crashReportingEnabled)
```
    Parameters:
    
    crashReportingEnabled - enables or disables Sentry crash reporting tool, used to report Incode's SDK crashes.
  - build
```
 final Unit build()
```
    Builds the IncodeWelcome object

Class IncodeWelcome.Builder

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IncodeWelcome.Builder

IncodeWelcome.Builder

IncodeWelcome.Builder

IncodeWelcome.Builder

Method Detail

getApiUrl

setApiUrl

setClientExperimentId

setSdkMode

setSSLConfig

configureSSLPinning

configureSSLPinning

setLoggingEnabled

setExternalAnalyticsEnabled

setExternalScreenshotsEnabled

setCaptureModeEnabled

setTestModeEnabled

enableLocalFaceRecognition

enableLocalLiveness

enableMaskDetection

disableHookCheck

disableEmulatorDetection

disableRootDetection

disableVirtualEnvironmentDetection

enableInstallSizeOptimization

setCrashReportingEnabled

build