com.amazonaws.mobileconnectors.cognitoidentityprovider

Class CognitoUserAttributes

java.lang.Object

com.amazonaws.mobileconnectors.cognitoidentityprovider.CognitoUserAttributes

public class CognitoUserAttributes
extends java.lang.Object

Encapsulates all user attributes and provides methods to access them.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CognitoUserAttributes() Public constructor, creates an "empty container".
protected	CognitoUserAttributes(java.util.List<AttributeType> userAttributes) Constructor for internal use.

Method Summary

Modifier and Type	Method and Description
void	addAttribute(java.lang.String attributeName, java.lang.String value) Adds an attribute to this object.
java.util.Map<java.lang.String,java.lang.String>	getAttributes() Returns the user attributes as a key, value pairs.
protected java.util.List<AttributeType>	getAttributesList() Returns the user attributes as a AttributeType list.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CognitoUserAttributes

public CognitoUserAttributes()

Public constructor, creates an "empty container". Use addAttribute(String, String) method to add user attributes.

CognitoUserAttributes

protected CognitoUserAttributes(java.util.List<AttributeType> userAttributes)

Constructor for internal use.

Parameters:

userAttributes - REQUIRED: Cognito user attributes as a list.

Method Detail

addAttribute

public void addAttribute(java.lang.String attributeName,
                         java.lang.String value)

Adds an attribute to this object.

Will add the attribute and its value. Overrides an earlier value set for an attribute which was already added to this object.

Parameters:

attributeName - REQUIRED: The attribute name.

value - REQUIRED: Value for the attribute.

getAttributes

public java.util.Map<java.lang.String,java.lang.String> getAttributes()

Returns the user attributes as a key, value pairs.

Returns:

User attributes as key, value pairs

getAttributesList

protected java.util.List<AttributeType> getAttributesList()

Returns the user attributes as a AttributeType list.

Returns:

AttributeType Cognito user attributes as a list.