BiometricPromptCompat

中文文档

In Android P, Google provides a easier way for developers to use biometric sensors to authenticate user identity: BiometricPrompt. However, it is only supported in latest Android. We create a compat library to take it to All Android 6.0+ devices.

BiometricPromptCompat is designed to be compatible with lower versions of Android (6.0~8.1), and its interface is very close to the original BiometricPrompt to ensure a consistent UI on different Android.

Support Android X and it's written by Kotlin

usage:

• Add the library to your module build.gradle

dependencies {
     implementation 'io.putme2yourheart:biometric:1.0.1'
}

• If you support landscape, please add

  <activity android:configChanges="orientation|keyboardHidden|screenSize">
  </activity>

• Hardware detection & Enrolled Fingerprints

BiometricPromptCompat.isHardwareDetected(Context)

BiometricPromptCompat.hasEnrolledFingerprints(Context)

• You only need a few lines of code to use BiometricPromptCompat

     BiometricPromptCompat(this).authenticate {
            title("Title")
            subtitle("Subtitle")
            description("Description")
            negativeButton("NEGATIVE",
                DialogInterface.OnClickListener { dialog, which ->
                })
            succeededCallback {
                Toast.makeText(
                    this@MainActivity,
                    "Authentication!",
                    Toast.LENGTH_SHORT
                ).show()
            }
            failedCallback {
                Log.i(TAG, "onAuthenticationFailed")
            }
            errorCallback { errorCode, errString ->
                Log.i(TAG, "onAuthenticationError $errString")
            }
            helpCallback { helpCode, helpString ->
                Log.i(TAG, "onAuthenticationHelp $helpString")
            }
        }

Test & Screenshots:

Tested successfully in Android N & P.

• Android N

• Android P

License

Copyright 2019 putme2yourheart

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.