Constructor Detail

• CommonConfig.Builder

  CommonConfig.Builder()

Method Detail

• setRecognitionThreshold

   final CommonConfig.Builder setRecognitionThreshold(Float recognitionThreshold)

  Set custom face recognition threshold

  Parameters:

  recognitionThreshold - Threshold value, between 0 and 1

  Returns:

  Builder

• setSpoofThreshold

   final CommonConfig.Builder setSpoofThreshold(Float spoofThreshold)

  Set custom spoof detection threshold

  Parameters:

  spoofThreshold - Threshold value, between 0 and 1

  Returns:

  Builder

• setMaskThreshold

  @Deprecated(message = "Not used anymore") final CommonConfig.Builder setMaskThreshold(Float maskThreshold)

  Set custom mask detection threshold

  Parameters:

  maskThreshold - Threshold value, between 0 and 1

  Returns:

  Builder

  Since:

  Deprecated in 5.18.0

• setIdGlareThreshold

   final CommonConfig.Builder setIdGlareThreshold(Float idGlareThreshold)

  Parameters:

  idGlareThreshold - Glare threshold value for ID Scan, values between 0 and 1.

  Returns:

  Builder

• setIdBlurThreshold

   final CommonConfig.Builder setIdBlurThreshold(Float idBlurThreshold)

  Parameters:

  idBlurThreshold - Blurriness threshold value for ID Scan, values between 0 and 1.

  Returns:

  Builder

• setShowCloseButton

   final CommonConfig.Builder setShowCloseButton(Boolean showCloseButton)

  Sets whether the close button will be shown during the flow or not.

  Parameters:

  showCloseButton - Shows or hides close button; Default: hidden

  Returns:

  Builder

  Since:

  5.0.0

• setShowExitConfirmation

   final CommonConfig.Builder setShowExitConfirmation(Boolean showExitConfirmation)

  Parameters:

  showExitConfirmation - Shows (true) or hides (false) exit confirmation screen after the user presses the back button.

  Returns:

  Builder

• setLocalizationLanguage

   final CommonConfig.Builder setLocalizationLanguage(String localizationLanguage)

  Set the SDK language.

  After canceling the SDK flow, reset the application language and call the Activity.recreate() method in the com.incode.welcome_sdk.IncodeWelcome.OnboardingListener.onSuccess, com.incode.welcome_sdk.IncodeWelcome.OnboardingListener.onUserCancelled, and com.incode.welcome_sdk.IncodeWelcome.OnboardingListener.onError methods of com.incode.welcome_sdk.IncodeWelcome.OnboardingListener if the application language is different from the SDK language.

  Make sure you have included 'extensions' dependency in the corresponding build.gradle file.

  Parameters:

  localizationLanguage - Locale code as either languageCode_countryCode or BCP 47 languageCode-countryCode (e.g.

  Returns:

  Builder

  Since:

  5.8.0

• setThemeConfiguration

   final CommonConfig.Builder setThemeConfiguration(ThemeConfiguration themeConfiguration)

  Sets ThemeConfiguration for modules that use traditional Android XML layouts. The logo from ThemeConfiguration.Builder.setLogo also applies to UX V2 screens. The other styles apply to XML layouts only.

  Parameters:

  themeConfiguration - Contains Theme and Styling customization

  Returns:

  Builder

• setThemeConfig

   final CommonConfig.Builder setThemeConfig(IncodeThemeConfig themeConfig)

  Sets IncodeThemeConfig used in modules designed using Compose, currently supported in following modules:

  • ID V2

  Parameters:

  themeConfig - IncodeThemeConfig that is used as theme source or null.

  Returns:

  Builder

• setUXConfig

   final CommonConfig.Builder setUXConfig(IncodeUXConfig uxConfig)

  Applies V2 customizations and configurations for the UX.

  Parameters:

  uxConfig - IncodeUXConfig containing V2 UX customizations.

  Returns:

  Builder

• setUIConfigFromJson

   final CommonConfig.Builder setUIConfigFromJson(Context context, String json)

  Configures the SDK theme and UX from a single JSON document. Replaces any theme and UX configuration set earlier on this builder, like every other setter. A missing or null theme or ux section sets that part to the SDK default. To combine a JSON theme with a programmatic UX config, call setUXConfig after this method.

  Parameters:

  context - Context used to resolve font resources referenced by the theme.

  json - JSON document with theme and ux objects.

  Returns:

  Builder

• setShowDelayedOnboardingIntroScreen

   final CommonConfig.Builder setShowDelayedOnboardingIntroScreen(Boolean showDelayedOnboardingIntroScreen)

  Parameters:

  showDelayedOnboardingIntroScreen - Shows or hides the introduction screen when the SDK is started in Delayed mode.

  Returns:

  Builder

• build

   final CommonConfig build()

• from

   final static CommonConfig.Builder from(CommonConfig existingConfig)