FaceAuthStatus (Mobile Protector SDK Core Documentation (5.4.1))

java.lang.Object
- java.lang.Enum<FaceAuthStatus>
- - com.gemalto.idp.mobile.authentication.mode.face.FaceAuthStatus

All Implemented Interfaces:

Serializable, Comparable<FaceAuthStatus>
```
public enum FaceAuthStatus
extends Enum<FaceAuthStatus>
```
The face verification status values

Since:

4.2

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ALREADY_EXTRACTING` Face engine is already busy, extracting a face from an image.
`BAD_QUALITY` The image quality is too bad (too much light, too dark, too blur..) to perform the biometric action.
`CAMERA_NOT_FOUND` Front camera has not been detected on the device.
`CANCELED` Biometric action has been canceled.
`ERROR` An error occurred.
`LIVENESS_CHECK_FAILED` Face engine failed to detect a live user
`MATCH_NOT_FOUND` User has not been identified.
`NONE`
`REQUIRED_LIVE_ACTION` A user action is required to complete the biometric process.
`SUCCESS`
`TIMEOUT` Timeout has been reached.
`USER_EXIST` User already enrolled.
`USER_NOT_FOUND` User not recognized as an enrolled user.
`USER_REENROLL_NEEDED` User need to be re-enrolled.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static FaceAuthStatus`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static FaceAuthStatus[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - NONE
```
public static final FaceAuthStatus NONE
```
  - SUCCESS
```
public static final FaceAuthStatus SUCCESS
```
  - REQUIRED_LIVE_ACTION
```
public static final FaceAuthStatus REQUIRED_LIVE_ACTION
```
    A user action is required to complete the biometric process. When this status is returned, check FaceAuthLivenessAction for the required actions.
  - ERROR
```
public static final FaceAuthStatus ERROR
```
    An error occurred.
  - TIMEOUT
```
public static final FaceAuthStatus TIMEOUT
```
    Timeout has been reached.
  - BAD_QUALITY
```
public static final FaceAuthStatus BAD_QUALITY
```
    The image quality is too bad (too much light, too dark, too blur..) to perform the biometric action. This is mainly for enrollment and the quality threshold can be configured in FaceAuthEnrollerSettings.
  - CAMERA_NOT_FOUND
```
public static final FaceAuthStatus CAMERA_NOT_FOUND
```
    Front camera has not been detected on the device.
  - CANCELED
```
public static final FaceAuthStatus CANCELED
```
    Biometric action has been canceled.
  - MATCH_NOT_FOUND
```
public static final FaceAuthStatus MATCH_NOT_FOUND
```
    User has not been identified.
  - USER_EXIST
```
public static final FaceAuthStatus USER_EXIST
```
    User already enrolled.
  - USER_NOT_FOUND
```
public static final FaceAuthStatus USER_NOT_FOUND
```
    User not recognized as an enrolled user.
  - USER_REENROLL_NEEDED
```
public static final FaceAuthStatus USER_REENROLL_NEEDED
```
    User need to be re-enrolled.
  - ALREADY_EXTRACTING
```
public static final FaceAuthStatus ALREADY_EXTRACTING
```
    Face engine is already busy, extracting a face from an image.
  - LIVENESS_CHECK_FAILED
```
public static final FaceAuthStatus LIVENESS_CHECK_FAILED
```
    Face engine failed to detect a live user
- Method Detail
  - values
```
public static FaceAuthStatus[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (FaceAuthStatus c : FaceAuthStatus.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static FaceAuthStatus valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null

Enum FaceAuthStatus

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NONE

SUCCESS

REQUIRED_LIVE_ACTION

ERROR

TIMEOUT

BAD_QUALITY

CAMERA_NOT_FOUND

CANCELED

MATCH_NOT_FOUND

USER_EXIST

USER_NOT_FOUND

USER_REENROLL_NEEDED

ALREADY_EXTRACTING

LIVENESS_CHECK_FAILED

Method Detail

values

valueOf