Package com.gemalto.mfs.mwsdk.cdcvm

Interface DeviceCVMVerifier

  • public interface DeviceCVMVerifier
    Device CVM (Biofingerprint or device keyguard) verification interface. Use this class to start the biometric fingerprint authentication or device keyguard authentication.

    • Method Detail

      • startAuthentication

        void startAuthentication​(@NonNull
                         DeviceCVMVerifierInput deviceCVMVerifierInput)
        This method starts the end-user authentication by using the biometric fingerprint method or device keyguard authentication. The MPA is expected to launch the biometric fingerprint or device keyguard authentication screen to the end-user according to the chosen CHVerificationMethod.
        Parameters:
        deviceCVMVerifierInput - the object containing the input needed for authentication

      • setDeviceCVMVerifyListener

        void setDeviceCVMVerifyListener​(DeviceCVMVerifyListener pDeviceCVMVerifyListener)
        An API to set the callback to delegate the biometric fingerprint authentication result to the MPA.
        Parameters:
        pDeviceCVMVerifyListener - callback for the biometric fingerprint/Device keyguard authentication status

      • setKeyguardActivity

        void setKeyguardActivity​(android.app.Activity keyguardRootActivity)
        An API to manage the keyguard mechanism (PIN / Pattern / Password)
        Parameters:
        keyguardRootActivity - use setKeyguardActivity(Activity,Class) instead

      • setKeyguardActivity

        void setKeyguardActivity​(@NonNull
                         android.app.Activity keyguardRootActivity,
                         @NonNull
                         java.lang.Class keyguardActivityClass)
        An API to manage the keyguard mechanism (PIN / Pattern / Password)
        Parameters:
        keyguardRootActivity -
        keyguardActivityClass -

      • confirmCredential

        void confirmCredential​(@NonNull
                       java.lang.CharSequence title,
                       @NonNull
                       java.lang.CharSequence description)
        Deprecated.
        6.4.0, please use startAuthentication(DeviceCVMVerifierInput) instead.
        An API to launch the keyguard mechanism. Keyguard can either be PIN / Pattern / Password defined by the end-user in the Android system settings.


        IMPORTANT:

        • The keyguard activity must have already been set by calling setKeyguardActivity(Activity,Class) before calling this API. Otherwise, a RuntimeException will be thrown.
        • The SDK will verify if the device is secured with a PIN, pattern or password. If not, a RuntimeException will be raised. In case of BIOMETRICS as CHVerificationMethod method, the MPA must only call this method after at least 1 failed biometric fingerprint verification or else, the SDK will raise an IllegalStateException.
        • This API does nothing on Android Q (and up). This is because, on Android Q, the fallback mechanism is built into the biometric prompt and explicitly launching the keyguard will just launch the biometric prompt.
        Parameters:
        title - Title to show on the keyguard screen.
        description - Short message to be shown on the keyguard screen.

      • onDelegatedAuthPerformed

        void onDelegatedAuthPerformed​(long timeStamp)
        Authentication is performed successfully by user through MPA. Invoke SDK for further transaction steps.
        Parameters:
        timeStamp - Timestamp(in milliSecond) last successful user authentication
        Since:
        6.5.0

      • onDelegatedAuthCancelled

        void onDelegatedAuthCancelled()
        Delegated CDCVM authentication is failed by user. Invoke SDK to deactivate current transaction. Show respective CDCVM error from OS to user.
        Since:
        6.5.0

      • setCVMType

        void setCVMType​(CVMType cvm)
        An API to set the CVM type for Biometric/DeviceKeyguard.
        Parameters:
        cvm - CVMType