Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anitaa1990/biometric-auth-sample
Add Biometric Authentication to any Android app
https://github.com/anitaa1990/biometric-auth-sample
android android-architecture-components android-library android-p android-permissions android-platform android-sdk android-sdk-library androidp biometricprompt java
Last synced: 7 days ago
JSON representation
Add Biometric Authentication to any Android app
- Host: GitHub
- URL: https://github.com/anitaa1990/biometric-auth-sample
- Owner: anitaa1990
- Created: 2018-07-11T15:11:48.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-08-11T10:52:02.000Z (over 5 years ago)
- Last Synced: 2023-10-20T17:17:51.882Z (about 1 year ago)
- Topics: android, android-architecture-components, android-library, android-p, android-permissions, android-platform, android-sdk, android-sdk-library, androidp, biometricprompt, java
- Language: Java
- Homepage:
- Size: 192 KB
- Stars: 246
- Watchers: 14
- Forks: 142
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Biometric-Auth-Sample
Add Biometric Authentication to any Android app
This library provides an easy way to implement fingerprint authentication without having to deal with all the boilerplate stuff going on inside.
How to integrate the library in your app?
Gradle Dependecy
```gradle
dependencies {
implementation(group: 'com.an.biometric', name: 'biometric-auth', version: '0.1.0', ext: 'aar', classifier: '')
}
```
Usage
```
new BiometricManager.BiometricBuilder(MainActivity.this)
.setTitle("Add a title")
.setSubtitle("Add a subtitle")
.setDescription("Add a description")
.setNegativeButtonText("Add a cancel button")
.build()
.authenticate(biometricCallback);
```
The ```BiometricCallback``` class has the following callback methods:
```
new BiometricCallback() {
@Override
public void onSdkVersionNotSupported() {
/*
* Will be called if the device sdk version does not support Biometric authentication
*/
}
@Override
public void onBiometricAuthenticationNotSupported() {
/*
* Will be called if the device does not contain any fingerprint sensors
*/
}
@Override
public void onBiometricAuthenticationNotAvailable() {
/*
* The device does not have any biometrics registered in the device.
*/
}
@Override
public void onBiometricAuthenticationPermissionNotGranted() {
/*
* android.permission.USE_BIOMETRIC permission is not granted to the app
*/
}
@Override
public void onBiometricAuthenticationInternalError(String error) {
/*
* This method is called if one of the fields such as the title, subtitle,
* description or the negative button text is empty
*/
}
@Override
public void onAuthenticationFailed() {
/*
* When the fingerprint doesn’t match with any of the fingerprints registered on the device,
* then this callback will be triggered.
*/
}
@Override
public void onAuthenticationCancelled() {
/*
* The authentication is cancelled by the user.
*/
}
@Override
public void onAuthenticationSuccessful() {
/*
* When the fingerprint is has been successfully matched with one of the fingerprints
* registered on the device, then this callback will be triggered.
*/
}
@Override
public void onAuthenticationHelp(int helpCode, CharSequence helpString) {
/*
* This method is called when a non-fatal error has occurred during the authentication
* process. The callback will be provided with an help code to identify the cause of the
* error, along with a help message.
*/
}
@Override
public void onAuthenticationError(int errorCode, CharSequence errString) {
/*
* When an unrecoverable error has been encountered and the authentication process has
* completed without success, then this callback will be triggered. The callback is provided
* with an error code to identify the cause of the error, along with the error message.
*/
}
});
```