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 when using either the no apiKey approach, or SdkMode.CAPTURE_ONLY.

  Valid values include:

  • "experimentV2" - Enables UX V2 for all modules that support it

  • An experiment ID provided by your Enterprise Customer Success Manager (ECSM)

  Please get in contact with your ECSM before using this API as misuse can produce large, unexpected changes to the UX!

  Parameters:

  clientExperimentId - The experiment ID to use for a particular A/B test; Default is empty ("").

  Since:

  5.37.0

• 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)

  Enables or disables test mode. Test mode can be used to experiment on devices without access to Camera hardware or when putting an app that integrates the Incode Welcome SDK into an automated test suite. It will insert dummy results in place of modules requiring access to a Camera.

  Make sure test mode is off on production devices!

  Parameters:

  enableTestMode - true to enable 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.

• 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.

• setGoogleWalletEnvironment

   final IncodeWelcome.Builder setGoogleWalletEnvironment(GoogleWalletEnvironment environment)

  Sets the Google Wallet environment.

  This setting applies only when the optional wallets dependency is included and the Google Wallet ID feature is used.

  Parameters:

  environment - GoogleWalletEnvironment.PRODUCTION or GoogleWalletEnvironment.SANDBOX.

  Since:

  5.48.0

• build

   final Unit build()

  Builds the IncodeWelcome object