AuthenticationState (TSHPay API)

java.lang.Object
- com.gemalto.mfs.mwsdk.provisioning.model.AuthenticationState

public class AuthenticationState
extends java.lang.Object

This class represents the state of authentication.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class AuthenticationState.AuthState
The enum class for authentication states.

Constructor Summary

Constructors
Constructor	Description
`AuthenticationState(AuthenticationState.AuthState state, CHVerificationMethod cvm, java.lang.String tokenID)`	Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`CHVerificationMethod`	`getCvm()`	Get CVM method to be used for Authentication
`AuthenticationState.AuthState`	`getState()`	Get the auth State to determine if authentication is needed or not can be either `AuthenticationState.AuthState.AUTH_NEEDED` or `AuthenticationState.AuthState.AUTH_NOT_NEEDED`
`java.lang.String`	`getTokenID()`	get the Token ID to be activated for replenishment with the help of authentication.

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

- Constructor Detail
  - AuthenticationState
```
public AuthenticationState(AuthenticationState.AuthState state,
                           CHVerificationMethod cvm,
                           java.lang.String tokenID)
```
    Constructor
    
    Parameters:
    
    state - the AuthenticationState.AuthState
    
    cvm - the card holder verification method CHVerificationMethod
    
    tokenID - the token ID
- Method Detail
  - getCvm
```
public CHVerificationMethod getCvm()
```
    Get CVM method to be used for Authentication
    
    Returns:
    
    the cvm, see CHVerificationMethod
  - getState
```
public AuthenticationState.AuthState getState()
```
    Get the auth State to determine if authentication is needed or not can be either AuthenticationState.AuthState.AUTH_NEEDED or AuthenticationState.AuthState.AUTH_NOT_NEEDED
    
    Returns:
    
    the authentication state AuthenticationState.AuthState
  - getTokenID
```
public java.lang.String getTokenID()
```
    get the Token ID to be activated for replenishment with the help of authentication. Can be null if AuthenticationState.AuthState is AuthenticationState.AuthState.AUTH_NOT_NEEDED.
    
    Returns:
    
    tokenID