RespondToAuthChallengeResult (aws-android-sdk-cognitoidentityprovider 2.81.1 API)

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

All Implemented Interfaces:

java.io.Serializable
```
public class RespondToAuthChallengeResult
extends java.lang.Object
implements java.io.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(java.lang.String key, java.lang.String value)` The challenge parameters.
`RespondToAuthChallengeResult`	`clearChallengeParametersEntries()` Removes all the entries added into ChallengeParameters.
`boolean`	`equals(java.lang.Object obj)`
`AuthenticationResultType`	`getAuthenticationResult()` The result returned by the server in response to the request to respond to the authentication challenge.
`java.lang.String`	`getChallengeName()` The challenge name.
`java.util.Map<java.lang.String,java.lang.String>`	`getChallengeParameters()` The challenge parameters.
`java.lang.String`	`getSession()` The session that should be passed both ways in challenge-response calls to the service.
`int`	`hashCode()`
`void`	`setAuthenticationResult(AuthenticationResultType authenticationResult)` The result returned by the server in response to the request to respond to the authentication challenge.
`void`	`setChallengeName(ChallengeNameType challengeName)` The challenge name.
`void`	`setChallengeName(java.lang.String challengeName)` The challenge name.
`void`	`setChallengeParameters(java.util.Map<java.lang.String,java.lang.String> challengeParameters)` The challenge parameters.
`void`	`setSession(java.lang.String session)` The session that should be passed both ways in challenge-response calls to the service.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`RespondToAuthChallengeResult`	`withAuthenticationResult(AuthenticationResultType authenticationResult)` The result returned by the server in response to the request to respond to the authentication challenge.
`RespondToAuthChallengeResult`	`withChallengeName(ChallengeNameType challengeName)` The challenge name.
`RespondToAuthChallengeResult`	`withChallengeName(java.lang.String challengeName)` The challenge name.
`RespondToAuthChallengeResult`	`withChallengeParameters(java.util.Map<java.lang.String,java.lang.String> challengeParameters)` The challenge parameters.
`RespondToAuthChallengeResult`	`withSession(java.lang.String session)` The session that should be passed both ways in challenge-response calls to the service.

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

- Constructor Detail
  - RespondToAuthChallengeResult
```
public RespondToAuthChallengeResult()
```
- Method Detail
  - getChallengeName
```
public java.lang.String getChallengeName()
```
    The challenge name. For more information, see InitiateAuth.
    
    Constraints:
    Allowed Values: SMS_MFA, SOFTWARE_TOKEN_MFA, SELECT_MFA_TYPE, MFA_SETUP, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED
    
    Returns:
    
    The challenge name. For more information, see InitiateAuth.
    
    See Also:
    
    ChallengeNameType
  - setChallengeName
```
public void setChallengeName(java.lang.String challengeName)
```
    The challenge name. For more information, see InitiateAuth.
    
    Constraints:
    Allowed Values: SMS_MFA, SOFTWARE_TOKEN_MFA, SELECT_MFA_TYPE, MFA_SETUP, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED
    
    Parameters:
    
    challengeName -
    The challenge name. For more information, see InitiateAuth.
    
    See Also:
    
    ChallengeNameType
  - withChallengeName
```
public RespondToAuthChallengeResult withChallengeName(java.lang.String challengeName)
```
    The challenge name. For more information, see InitiateAuth.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: SMS_MFA, SOFTWARE_TOKEN_MFA, SELECT_MFA_TYPE, MFA_SETUP, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED
    
    Parameters:
    
    challengeName -
    The challenge name. For more information, see InitiateAuth.
    
    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. For more information, see InitiateAuth.
    
    Constraints:
    Allowed Values: SMS_MFA, SOFTWARE_TOKEN_MFA, SELECT_MFA_TYPE, MFA_SETUP, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED
    
    Parameters:
    
    challengeName -
    The challenge name. For more information, see InitiateAuth.
    
    See Also:
    
    ChallengeNameType
  - withChallengeName
```
public RespondToAuthChallengeResult withChallengeName(ChallengeNameType challengeName)
```
    The challenge name. For more information, see InitiateAuth.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: SMS_MFA, SOFTWARE_TOKEN_MFA, SELECT_MFA_TYPE, MFA_SETUP, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED
    
    Parameters:
    
    challengeName -
    The challenge name. For more information, see InitiateAuth.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    ChallengeNameType
  - getSession
```
public java.lang.String getSession()
```
    The session that should be passed both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
    
    Constraints:
    Length: 20 - 2048
    
    Returns:
    
    The session that should be passed both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
  - setSession
```
public void setSession(java.lang.String session)
```
    The session that should be passed both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
    
    Constraints:
    Length: 20 - 2048
    
    Parameters:
    
    session -
    The session that should be passed both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
  - withSession
```
public RespondToAuthChallengeResult withSession(java.lang.String session)
```
    The session that should be passed both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 20 - 2048
    
    Parameters:
    
    session -
    The session that should be passed both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getChallengeParameters
```
public java.util.Map<java.lang.String,java.lang.String> getChallengeParameters()
```
    The challenge parameters. For more information, see InitiateAuth.
    
    Returns:
    
    The challenge parameters. For more information, see InitiateAuth.
  - setChallengeParameters
```
public void setChallengeParameters(java.util.Map<java.lang.String,java.lang.String> challengeParameters)
```
    The challenge parameters. For more information, see InitiateAuth.
    
    Parameters:
    
    challengeParameters -
    The challenge parameters. For more information, see InitiateAuth.
  - withChallengeParameters
```
public RespondToAuthChallengeResult withChallengeParameters(java.util.Map<java.lang.String,java.lang.String> challengeParameters)
```
    The challenge parameters. For more information, see InitiateAuth.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    challengeParameters -
    The challenge parameters. For more information, see InitiateAuth.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addChallengeParametersEntry
```
public RespondToAuthChallengeResult addChallengeParametersEntry(java.lang.String key,
                                                                java.lang.String value)
```
    The challenge parameters. For more information, see InitiateAuth.
    
    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 returned by the server in response to the request to respond to the authentication challenge.
    
    Returns:
    
    The result returned by the server in response to the request to respond to the authentication challenge.
  - setAuthenticationResult
```
public void setAuthenticationResult(AuthenticationResultType authenticationResult)
```
    The result returned by the server in response to the request to respond to the authentication challenge.
    
    Parameters:
    
    authenticationResult -
    The result returned by the server in response to the request to respond to the authentication challenge.
  - withAuthenticationResult
```
public RespondToAuthChallengeResult withAuthenticationResult(AuthenticationResultType authenticationResult)
```
    The result returned by the server in response to the request to respond to the authentication challenge.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    authenticationResult -
    The result returned by the server in response to the request to respond to the authentication challenge.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.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