ValidatedUsernameCallback (forgerock-auth 3.4.0 API)

java.lang.Object
- org.forgerock.android.auth.callback.AbstractCallback
- - org.forgerock.android.auth.callback.AbstractValidatedCallback
  - - org.forgerock.android.auth.callback.ValidatedUsernameCallback

All Implemented Interfaces:

java.io.Serializable, Callback
```
public class ValidatedUsernameCallback
extends AbstractValidatedCallback
```
Callback to collect a username and validate it against IDM policy.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.forgerock.android.auth.callback.AbstractValidatedCallback
  AbstractValidatedCallback.FailedPolicy

Field Summary
- Fields inherited from class org.forgerock.android.auth.callback.AbstractCallback
  _id, content, VALUE

Constructor Summary

Constructors
Constructor Description

ValidatedUsernameCallback()

ValidatedUsernameCallback(org.json.JSONObject raw, int index)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getPrompt()`
`java.lang.String`	`getType()`	Return the type of the Callback, the type name should align with the Callback type returned from AM
`protected void`	`setAttribute(java.lang.String name, java.lang.Object value)`
`void`	`setUsername(java.lang.String username)`	Set the retrieved username.

Methods inherited from class org.forgerock.android.auth.callback.AbstractValidatedCallback
getFailedPolicies, getPolicies, getValidateOnly, setValidateOnly

Methods inherited from class org.forgerock.android.auth.callback.AbstractCallback
get_id, getContent, getContentAsJson, getInputValue, getInputValue, getName, setContent, setValue, setValue

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

- Constructor Detail
  - ValidatedUsernameCallback
```
public ValidatedUsernameCallback(@NotNull
                                 org.json.JSONObject raw,
                                 int index)
                          throws org.json.JSONException
```
    Throws:
    
    org.json.JSONException
  - ValidatedUsernameCallback
```
public ValidatedUsernameCallback()
```
- Method Detail
  - setAttribute
```
protected void setAttribute(java.lang.String name,
                            java.lang.Object value)
```
    Overrides:
    
    setAttribute in class AbstractValidatedCallback
  - setUsername
```
public void setUsername(java.lang.String username)
```
    Set the retrieved username.
    
    Parameters:
    
    username - the retrieved name (which may be null).
  - getType
```
public java.lang.String getType()
```
    Description copied from interface: Callback
    
    Return the type of the Callback, the type name should align with the Callback type returned from AM
  - getPrompt
```
public java.lang.String getPrompt()
```
    Specified by:
    
    getPrompt in class AbstractValidatedCallback