Constructor Detail

• IncodeWelcome.Builder

  IncodeWelcome.Builder(Application application, String apiUrl, String apiKey, String e2eeUrl)

  Constructor to initialize a Builder object.

  Parameters:

  application - client application.

  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)

  Constructor to initialize a Builder object.

  Parameters:

  application - client application.

  apiUrl - url of the server used for registration and authentication.

  apiKey - registered key to identify your application.

• IncodeWelcome.Builder

  IncodeWelcome.Builder(Application application)

  Constructor used for Capture Only SDK init.

  Parameters:

  application - client application.

• IncodeWelcome.Builder

  IncodeWelcome.Builder(Application application, String apiUrl)

  Constructor used for external token SDK init (no apiKey SDK init)

  Parameters:

  application - client application.

  apiUrl - url of the server used for registration and authentication.

Method Detail

• configureSSLPinning

   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

   IncodeWelcome.Builder configureSSLPinning(boolean isEnabled)

  Parameters:

  isEnabled - enable or disable SSL Certificate Pinning.

• setLoggingEnabled

   IncodeWelcome.Builder setLoggingEnabled(boolean enableLogging)

  Parameters:

  enableLogging - enables or disables Logcat SDK logs.

• setExternalAnalyticsEnabled

   IncodeWelcome.Builder setExternalAnalyticsEnabled(boolean enableExternalAnalytics)

  Parameters:

  enableExternalAnalytics - enables or disables collecting analytics events for screens outside of the Incode SDK.

• setExternalScreenshotsEnabled

   IncodeWelcome.Builder setExternalScreenshotsEnabled(boolean enableExternalScreenshots)

  Parameters:

  enableExternalScreenshots - enables or disables collecting screenshots of screens outside of the Incode SDK.

• setCaptureModeEnabled

   IncodeWelcome.Builder setCaptureModeEnabled()

• setTestModeEnabled

   IncodeWelcome.Builder setTestModeEnabled(boolean enableTestMode)

  Parameters:

  enableTestMode - enables or disables test mode.

• enableLocalFaceRecognition

  @Deprecated() IncodeWelcome.Builder enableLocalFaceRecognition(boolean enableLocalFaceRecognition)

  Parameters:

  enableLocalFaceRecognition - enables use of local face recognition within the SDK.

• enableLocalLiveness

  @Deprecated() IncodeWelcome.Builder enableLocalLiveness(boolean enableLocalLiveness)

  Parameters:

  enableLocalLiveness - enables use of local liveness within the SDK.

• enableMaskDetection

  @Deprecated() IncodeWelcome.Builder enableMaskDetection(boolean enableMaskDetection)

  Parameters:

  enableMaskDetection - enables use of mask detection feature within the SDK.

• disableHookCheck

   IncodeWelcome.Builder disableHookCheck(boolean disableHookCheck)

  Parameters:

  disableHookCheck - disables hooking framework check.

• disableEmulatorDetection

   IncodeWelcome.Builder disableEmulatorDetection(boolean disableEmulatorDetection)

  Parameters:

  disableEmulatorDetection - disables emulator detection.

• disableRootDetection

   IncodeWelcome.Builder disableRootDetection(boolean disableRootDetection)

  Parameters:

  disableRootDetection - disables root detection.

• disableVirtualEnvironmentDetection

   IncodeWelcome.Builder disableVirtualEnvironmentDetection(boolean disableVirtualEnvironmentDetection)

  Parameters:

  disableVirtualEnvironmentDetection - disables virtual environment detection.

• enableInstallSizeOptimization

   IncodeWelcome.Builder enableInstallSizeOptimization(boolean enableInstallSizeOptimization)

  Parameters:

  enableInstallSizeOptimization - enables post installation size reduction of the SDK

• build

   void build()

  Builds the IncodeWelcome object

• setSdkMode

   IncodeWelcome.Builder setSdkMode(SdkMode sdkMode)

  Sets the SdkMode

  Parameters:

  sdkMode - STANDARD or CAPTURE_ONLY

• setSSLConfig

   IncodeWelcome.Builder setSSLConfig(IncodeWelcome.SSLConfig sslConfig)

  Parameters:

  sslConfig - optional sslConfig for on-premise servers

• setABTestingEnabled

   IncodeWelcome.Builder setABTestingEnabled(boolean isEnabled)

  Parameters:

  isEnabled - enables AB testing for testing various features

• setCrashReportingEnabled

   IncodeWelcome.Builder setCrashReportingEnabled(boolean crashReportingEnabled)

  Parameters:

  crashReportingEnabled - enables or disables Sentry crash reporting tool, used to report Incode's SDK crashes.