Giter VIP home page Giter VIP logo

biometrickit's Introduction

BiometricKit Fingerprint Authentication Library

BiometricKit is a simple to use and android fingerprint authentication Library written in pure kotlin for Android M (API 23) and above that follows the material design guidelines. Guidelines

Download

Download the latest version via Gradle:

Step 1: Include jitpack to your projects build.gradle file

allprojects {
    repositories {
	...
	maven { url 'https://jitpack.io' }
    }
}

Step 2: Add the Kiyo dependency to your build.gradle file

dependencies
{
	implementation 'com.github.AlexJuca:BiometricKit:v0.0.1'
}

Usage

Step 1: Define the permissions needed.

<uses-permission android:name="android.permission.USE_BIOMETRIC"
        android:required="false" />
    <uses-permission android:name="android.permission.USE_FINGERPRINT"
        android:required="false" />

Step 2: Set up a BiometricKitCallback to handle callbacks.

private val biometricKitCallback: BiometricKitCallback = object: BiometricKitCallback {
        override fun onSdkVersionNotSupported() {

        }

        override fun onBiometricAuthenticationNotSupported() {

        }

        override fun onBiometricAuthenticationNotAvailable() {

        }

        override fun onBiometricAuthenticationPermissionNotGranted() {

        }

        override fun onBiometricAuthenticationInternalError(error: String) {

        }

        override fun onAuthenticationFailed() {

        }

        override fun onAuthenticationCancelled() {
            prompt.authenticate(this, false)
        }

        override fun onAuthenticationSuccessful() {
            Toast.makeText(this@MainActivity, "Bought successfully", Toast.LENGTH_SHORT).show()
        }

        override fun onAuthenticationHelp(helpCode: Int, helpString: CharSequence?) {

        }

        override fun onAuthenticationError(errorCode: Int, errString: CharSequence?) {

        }

    }

Step 3:

   val prompt = BiometricKit.BiometricBuilder(this as Context)
            .setTitle("Confirm Payment")
            .setSubtitle("[email protected]")
            .setDescription("Paying for Kamba Gas Service")
            .setNegativeButtonText("Cancel").setInstructions("Touch the fingerprint sensor")
            .build()

        prompt.authenticate(biometricKitCallback, true)

Version history

0.0.1: Initial Version - 28/03/2019

License

Copyright Alexandre Antonio Juca <[email protected]>

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.

biometrickit's People

Contributors

alexjuca avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.