Package com.gemalto.mfs.mwsdk.cdcvm

Interface DeviceCVMVerifier

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

  • Method Details

    • startAuthentication

      void startAuthentication(@NonNull DeviceCVMVerifierInput deviceCVMVerifierInput)
      This method starts the end-user authentication by using the biometric fingerprint or device keyguard authentication. MPA is expected to launch either 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 MPA.
      Parameters:
      pDeviceCVMVerifyListener - Callback for either biometric fingerprint or device keyguard authentication status.

    • setKeyguardActivity

      void setKeyguardActivity(android.app.Activity keyguardRootActivity)
      An API to manage the device keyguard mechanism (PIN/pattern/password).
      Parameters:
      keyguardRootActivity - Use setKeyguardActivity(Activity,Class) instead.

    • setKeyguardActivity

      void setKeyguardActivity(@NonNull android.app.Activity keyguardRootActivity, @NonNull Class keyguardActivityClass)
      An API to manage the device keyguard mechanism (PIN/pattern/password).
      Parameters:
      keyguardRootActivity -
      keyguardActivityClass -

    • confirmCredential

      void confirmCredential(@NonNull CharSequence title, @NonNull CharSequence description)
      Deprecated.
      6.4.0, use startAuthentication(DeviceCVMVerifierInput) instead.
      An API to launch the device keyguard mechanism. The device keyguard can be a PIN/pattern/password defined by the end user in the Android system settings.


      IMPORTANT:

      • The device keyguard activity must be 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. Otherwise, a RuntimeException will be raised. In cases where BIOMETRICS is used as the CHVerificationMethod method, MPA must only call this method after at least 1 failed biometric fingerprint verification or else, the SDK will raise a IllegalStateException.
      • This API does nothing on Android Q (and later). This is because on Android Q, the fallback mechanism is built into the biometric prompt and explicitly launching the device keyguard will launch the biometric prompt.
      Parameters:
      title - Title to display on the device keyguard screen.
      description - Short message to be displayed on the device keyguard screen.

    • onDelegatedAuthPerformed

      void onDelegatedAuthPerformed(long timeStamp)
      Authentication is performed successfully by end user through MPA. Invokes SDK for further transaction steps.
      Parameters:
      timeStamp - The timestamp (in milliseconds) of the last successful end user authentication.
      Since:
      6.5.0

    • onDelegatedAuthCancelled

      void onDelegatedAuthCancelled()
      Delegated CDCVM by user. Invokes SDK to deactivate current transaction. Displays the respective CDCVM error from OS to end user.
      Since:
      6.5.0

    • setCVMType

      void setCVMType(CVMType cvm)
      An API to set the CVM type for biometric fingerprint or device keyguard.
      Parameters:
      cvm - CVMType