RespondToAuthChallengeResult (AWS SDK for Android - Amazon Cognito Identity Provider 2.6.15 API)

java.lang.Object
- com.amazonaws.services.cognitoidentityprovider.model.RespondToAuthChallengeResult

All Implemented Interfaces:

Serializable
```
public class RespondToAuthChallengeResult
extends Object
implements Serializable
```
The response to respond to the authentication challenge.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

RespondToAuthChallengeResult()

Constructors
Constructor and Description
`RespondToAuthChallengeResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RespondToAuthChallengeResult`	`addChallengeParametersEntry(String key, String value)` The challenge parameters.
`RespondToAuthChallengeResult`	`clearChallengeParametersEntries()` Removes all the entries added into ChallengeParameters.
`boolean`	`equals(Object obj)`
`AuthenticationResultType`	`getAuthenticationResult()` The result type of the authentication result.
`String`	`getChallengeName()` The challenge name.
`Map<String,String>`	`getChallengeParameters()` The challenge parameters.
`String`	`getSession()` The session.
`int`	`hashCode()`
`void`	`setAuthenticationResult(AuthenticationResultType authenticationResult)` The result type of the authentication result.
`void`	`setChallengeName(ChallengeNameType challengeName)` The challenge name.
`void`	`setChallengeName(String challengeName)` The challenge name.
`void`	`setChallengeParameters(Map<String,String> challengeParameters)` The challenge parameters.
`void`	`setSession(String session)` The session.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`RespondToAuthChallengeResult`	`withAuthenticationResult(AuthenticationResultType authenticationResult)` The result type of the authentication result.
`RespondToAuthChallengeResult`	`withChallengeName(ChallengeNameType challengeName)` The challenge name.
`RespondToAuthChallengeResult`	`withChallengeName(String challengeName)` The challenge name.
`RespondToAuthChallengeResult`	`withChallengeParameters(Map<String,String> challengeParameters)` The challenge parameters.
`RespondToAuthChallengeResult`	`withSession(String session)` The session.

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

- Constructor Detail
  - RespondToAuthChallengeResult
```
public RespondToAuthChallengeResult()
```
- Method Detail
  - getChallengeName
```
public String getChallengeName()
```
    The challenge name.
    
    Constraints:
    Allowed Values: SMS_MFA, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED
    
    Returns:
    
    The challenge name.
    
    See Also:
    
    ChallengeNameType
  - setChallengeName
```
public void setChallengeName(String challengeName)
```
    The challenge name.
    
    Constraints:
    Allowed Values: SMS_MFA, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED
    
    Parameters:
    
    challengeName -
    The challenge name.
    
    See Also:
    
    ChallengeNameType
  - withChallengeName
```
public RespondToAuthChallengeResult withChallengeName(String challengeName)
```
    The challenge name.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: SMS_MFA, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED
    
    Parameters:
    
    challengeName -
    The challenge name.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    ChallengeNameType
  - setChallengeName
```
public void setChallengeName(ChallengeNameType challengeName)
```
    The challenge name.
    
    Constraints:
    Allowed Values: SMS_MFA, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED
    
    Parameters:
    
    challengeName -
    The challenge name.
    
    See Also:
    
    ChallengeNameType
  - withChallengeName
```
public RespondToAuthChallengeResult withChallengeName(ChallengeNameType challengeName)
```
    The challenge name.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: SMS_MFA, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED
    
    Parameters:
    
    challengeName -
    The challenge name.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    ChallengeNameType
  - getSession
```
public String getSession()
```
    The session.
    
    Constraints:
    Length: 20 - 2048
    
    Returns:
    
    The session.
  - setSession
```
public void setSession(String session)
```
    The session.
    
    Constraints:
    Length: 20 - 2048
    
    Parameters:
    
    session -
    The session.
  - withSession
```
public RespondToAuthChallengeResult withSession(String session)
```
    The session.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 20 - 2048
    
    Parameters:
    
    session -
    The session.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getChallengeParameters
```
public Map<String,String> getChallengeParameters()
```
    The challenge parameters.
    
    Returns:
    
    The challenge parameters.
  - setChallengeParameters
```
public void setChallengeParameters(Map<String,String> challengeParameters)
```
    The challenge parameters.
    
    Parameters:
    
    challengeParameters -
    The challenge parameters.
  - withChallengeParameters
```
public RespondToAuthChallengeResult withChallengeParameters(Map<String,String> challengeParameters)
```
    The challenge parameters.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    challengeParameters -
    The challenge parameters.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addChallengeParametersEntry
```
public RespondToAuthChallengeResult addChallengeParametersEntry(String key,
                                                                String value)
```
    The challenge parameters.
    
    The method adds a new key-value pair into ChallengeParameters parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    key - The key of the entry to be added into ChallengeParameters.
    
    value - The corresponding value of the entry to be added into ChallengeParameters.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearChallengeParametersEntries
```
public RespondToAuthChallengeResult clearChallengeParametersEntries()
```
    Removes all the entries added into ChallengeParameters.
    Returns a reference to this object so that method calls can be chained together.
  - getAuthenticationResult
```
public AuthenticationResultType getAuthenticationResult()
```
    The result type of the authentication result.
    
    Returns:
    
    The result type of the authentication result.
  - setAuthenticationResult
```
public void setAuthenticationResult(AuthenticationResultType authenticationResult)
```
    The result type of the authentication result.
    
    Parameters:
    
    authenticationResult -
    The result type of the authentication result.
  - withAuthenticationResult
```
public RespondToAuthChallengeResult withAuthenticationResult(AuthenticationResultType authenticationResult)
```
    The result type of the authentication result.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    authenticationResult -
    The result type of the authentication result.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class RespondToAuthChallengeResult

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RespondToAuthChallengeResult

Method Detail

getChallengeName

setChallengeName

withChallengeName

setChallengeName

withChallengeName

getSession

setSession

withSession

getChallengeParameters

setChallengeParameters

withChallengeParameters

addChallengeParametersEntry

clearChallengeParametersEntries

getAuthenticationResult

setAuthenticationResult

withAuthenticationResult

toString

hashCode

equals