MfaCheckResult (formcycle: bom 8.5.6 API)

java.lang.Object
- de.xima.fc.user.access.MfaCheckResult

All Implemented Interfaces:

Serializable
```
public final class MfaCheckResult
extends Object
implements Serializable
```
Result of a MfaChecker check.

Since:

8.5.6

Author:

Norman Lorenz

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class MfaCheckResult.Builder
Builder for MfaCheckResult.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static MfaCheckResult.Builder`	`builder()`
`boolean`	`equals(Object o)`
`MfaMethod`	`getMethod()`	The method the user configured, or `null` if the user has not configured any method.
`MfaRequirementSource`	`getSource()`	Who requires multi-factor authentication, or `null` if the status is `MfaStatus.NOT_REQUIRED`.
`MfaStatus`	`getStatus()`	The multi-factor authentication status of the user.
`int`	`hashCode()`
`boolean`	`isRequired()`	Returns whether the user has to complete multi-factor authentication now.
`boolean`	`isSetupPending()`	Whether the user configured a method whose setup is not yet completed.
`String`	`toString()`

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

- Method Detail
  - isRequired
```
public boolean isRequired()
```
    Returns whether the user has to complete multi-factor authentication now.
    
    Returns:
    
    true if the status is MfaStatus.REQUIRED
    
    Since:
    
    8.5.6
  - builder
```
public static MfaCheckResult.Builder builder()
```
  - getStatus
```
public MfaStatus getStatus()
```
    The multi-factor authentication status of the user.
  - getSource
```
public MfaRequirementSource getSource()
```
    Who requires multi-factor authentication, or null if the status is MfaStatus.NOT_REQUIRED.
  - getMethod
```
public MfaMethod getMethod()
```
    The method the user configured, or null if the user has not configured any method.
  - isSetupPending
```
public boolean isSetupPending()
```
    Whether the user configured a method whose setup is not yet completed.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object