Package com.incode.welcome_sdk

Class IncodeWelcome.Builder

  • All Implemented Interfaces:
    
public final class IncodeWelcome.Builder

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

    Since:

    1.0.0

    • 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

      • 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

      • 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! If test mode is enabled on a non-emulator device while emulator detection is enabled, an IllegalStateException will be thrown when trying to initialize the Incode Welcome SDK.

        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.

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

        Note: This setting is ignored if test mode is enabled.

        Parameters:
        disableHookCheck - Default value is false.
        Since:

        Standard Releases: 3.0.1

        Special Versions: Removed in 5.43.0-hardened

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

        Note: This setting needs to be disabled to use test mode on an emulator.

        Parameters:
        disableEmulatorDetection - Default value is false.
        Since:

        Standard Releases: 3.3.1

        Special Versions: Removed in 5.43.0-hardened

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

        Note: This setting is ignored if test mode is enabled.

        Parameters:
        disableRootDetection - Default value is false.
        Since:

        Standard Releases: 3.3.1

        Special Versions: Removed in 5.43.0-hardened

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

        Note: This setting is ignored if test mode is enabled.

        Parameters:
        disableVirtualEnvironmentDetection - Default value is false.
        Since:

        Standard Releases: 5.24.0

        Special Versions: Removed in 5.43.0-hardened

      • build

         final Unit build()

        Builds the IncodeWelcome object