# FingerprintManagerCompat.AuthenticationCallback

added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  
belongs to Maven artifact com.android.support:support-compat:28.0.0-alpha1  
Summary:[Ctors](https://developer.android.com/reference/android/support/v4/hardware/fingerprint/FingerprintManagerCompat.AuthenticationCallback#pubctors)\|[Methods](https://developer.android.com/reference/android/support/v4/hardware/fingerprint/FingerprintManagerCompat.AuthenticationCallback#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/support/v4/hardware/fingerprint/FingerprintManagerCompat.AuthenticationCallback#inhmethods)\|[\[Expand All\]](https://developer.android.com/reference/android/support/v4/hardware/fingerprint/FingerprintManagerCompat.AuthenticationCallback#)  

# FingerprintManagerCompat.AuthenticationCallback

| This package is part of the Android[support library](https://developer.android.com/topic/libraries/support-library)which is no longer maintained. The support library has been superseded by[AndroidX](https://developer.android.com/jetpack/androidx)which is part of[Jetpack](https://developer.android.com/jetpack). We recommend using the AndroidX libraries in all new projects. You should also consider[migrating](https://developer.android.com/jetpack/androidx/migrate)existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library[class mappings](https://developer.android.com/jetpack/androidx/migrate/class-mappings).

`
public
static

abstract
class
FingerprintManagerCompat.AuthenticationCallback
`  
`

extends Object


``


`

|---|-----------------------------------------------------------------------------------------|
| java.lang.Object                                                                           ||
| ↳ | android.support.v4.hardware.fingerprint.FingerprintManagerCompat.AuthenticationCallback |

<br />

*** ** * ** ***

Callback structure provided to[authenticate(CryptoObject, int, CancellationSignal, AuthenticationCallback, Handler)](https://developer.android.com/reference/android/support/v4/hardware/fingerprint/FingerprintManagerCompat#authenticate(android.support.v4.hardware.fingerprint.FingerprintManagerCompat.CryptoObject, int, android.support.v4.os.CancellationSignal, android.support.v4.hardware.fingerprint.FingerprintManagerCompat.AuthenticationCallback, android.os.Handler)). Users of[authenticate(CryptoObject, int, CancellationSignal, AuthenticationCallback, Handler)](https://developer.android.com/reference/android/support/v4/hardware/fingerprint/FingerprintManagerCompat#authenticate(android.support.v4.hardware.fingerprint.FingerprintManagerCompat.CryptoObject, int, android.support.v4.os.CancellationSignal, android.support.v4.hardware.fingerprint.FingerprintManagerCompat.AuthenticationCallback, android.os.Handler))must provide an implementation of this for listening to fingerprint events.

## Summary

|                                                                                                             ### Public constructors                                                                                                             ||
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| ` `[FingerprintManagerCompat.AuthenticationCallback](https://developer.android.com/reference/android/support/v4/hardware/fingerprint/FingerprintManagerCompat.AuthenticationCallback#FingerprintManagerCompat.AuthenticationCallback())`() ` |

|                                                                                                                                                                                                                                                       ### Public methods                                                                                                                                                                                                                                                       ||
|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` void` | ` `[onAuthenticationError](https://developer.android.com/reference/android/support/v4/hardware/fingerprint/FingerprintManagerCompat.AuthenticationCallback#onAuthenticationError(int, java.lang.CharSequence))`(int errMsgId, CharSequence errString) ` Called when an unrecoverable error has been encountered and the operation is complete.                                                                                                                                                                        |
| ` void` | ` `[onAuthenticationFailed](https://developer.android.com/reference/android/support/v4/hardware/fingerprint/FingerprintManagerCompat.AuthenticationCallback#onAuthenticationFailed())`() ` Called when a fingerprint is valid but not recognized.                                                                                                                                                                                                                                                                     |
| ` void` | ` `[onAuthenticationHelp](https://developer.android.com/reference/android/support/v4/hardware/fingerprint/FingerprintManagerCompat.AuthenticationCallback#onAuthenticationHelp(int, java.lang.CharSequence))`(int helpMsgId, CharSequence helpString) ` Called when a recoverable error has been encountered during authentication.                                                                                                                                                                                   |
| ` void` | ` `[onAuthenticationSucceeded](https://developer.android.com/reference/android/support/v4/hardware/fingerprint/FingerprintManagerCompat.AuthenticationCallback#onAuthenticationSucceeded(android.support.v4.hardware.fingerprint.FingerprintManagerCompat.AuthenticationResult))`(`[FingerprintManagerCompat.AuthenticationResult](https://developer.android.com/reference/android/support/v4/hardware/fingerprint/FingerprintManagerCompat.AuthenticationResult)` result) ` Called when a fingerprint is recognized. |

| ### Inherited methods |
|-----------------------|---|
| [![](https://developer.android.com/static/assets/images/styles/disclosure_down.png)](https://developer.android.com/reference/android/support/v4/hardware/fingerprint/FingerprintManagerCompat.AuthenticationCallback#)From class` java.lang.Object ` |-------------------|-------------------------------| | ` Object`         | ` clone() `                   | | ` boolean`        | ` equals(Object arg0) `       | | ` void`           | ` finalize() `                | | ` final Class<?>` | ` getClass() `                | | ` int`            | ` hashCode() `                | | ` final void`     | ` notify() `                  | | ` final void`     | ` notifyAll() `               | | ` String`         | ` toString() `                | | ` final void`     | ` wait(long arg0, int arg1) ` | | ` final void`     | ` wait(long arg0) `           | | ` final void`     | ` wait() `                    | ||

## Public constructors

### FingerprintManagerCompat.AuthenticationCallback

added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
FingerprintManagerCompat.AuthenticationCallback ()
```

<br />

<br />

## Public methods

### onAuthenticationError

added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void onAuthenticationError (int errMsgId, 
                CharSequence errString)
```

Called when an unrecoverable error has been encountered and the operation is complete. No further callbacks will be made on this object.

<br />

|                                        Parameters                                         ||
|-------------|------------------------------------------------------------------------------|
| `errMsgId`  | `int`: An integer identifying the error message <br />                       |
| `errString` | `CharSequence`: A human-readable error string that can be shown in UI <br /> |

### onAuthenticationFailed

added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void onAuthenticationFailed ()
```

Called when a fingerprint is valid but not recognized.

<br />

### onAuthenticationHelp

added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void onAuthenticationHelp (int helpMsgId, 
                CharSequence helpString)
```

Called when a recoverable error has been encountered during authentication. The help string is provided to give the user guidance for what went wrong, such as "Sensor dirty, please clean it."

<br />

|                                      Parameters                                      ||
|--------------|------------------------------------------------------------------------|
| `helpMsgId`  | `int`: An integer identifying the error message <br />                 |
| `helpString` | `CharSequence`: A human-readable string that can be shown in UI <br /> |

### onAuthenticationSucceeded

added in[version 24.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void onAuthenticationSucceeded (FingerprintManagerCompat.AuthenticationResult result)
```

Called when a fingerprint is recognized.

<br />

|                                                     Parameters                                                     ||
|----------|----------------------------------------------------------------------------------------------------------|
| `result` | `FingerprintManagerCompat.AuthenticationResult`: An object containing authentication-related data <br /> |

-

  ## Classes

  - [FingerprintManagerCompat](https://developer.android.com/reference/android/support/v4/hardware/fingerprint/FingerprintManagerCompat)
  - [FingerprintManagerCompat.AuthenticationCallback](https://developer.android.com/reference/android/support/v4/hardware/fingerprint/FingerprintManagerCompat.AuthenticationCallback)
  - [FingerprintManagerCompat.AuthenticationResult](https://developer.android.com/reference/android/support/v4/hardware/fingerprint/FingerprintManagerCompat.AuthenticationResult)
  - [FingerprintManagerCompat.CryptoObject](https://developer.android.com/reference/android/support/v4/hardware/fingerprint/FingerprintManagerCompat.CryptoObject)