com.amazonaws.mobileconnectors.cognitoidentityprovider

Class CognitoUserSettings

java.lang.Object

com.amazonaws.mobileconnectors.cognitoidentityprovider.CognitoUserSettings

public class CognitoUserSettings
extends java.lang.Object

This class encapsulates all settings for a user.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CognitoUserSettings() Constructs an "empty" user settings object.
protected	CognitoUserSettings(java.util.List<MFAOptionType> userSettingsList) Constructs from MFAOptionType List

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getSettings() Return user settings as key, value pairs.
protected java.util.List<MFAOptionType>	getSettingsList() Returns a MFAOptionType list
void	setSettings(java.lang.String attributeName, java.lang.String option) Sets user settings.

Methods inherited from class java.lang.Object

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

Constructor Detail

CognitoUserSettings

public CognitoUserSettings()

Constructs an "empty" user settings object.

CognitoUserSettings

protected CognitoUserSettings(java.util.List<MFAOptionType> userSettingsList)

Constructs from MFAOptionType List

Parameters:

userSettingsList - REQUIRED: User settings as a MFAOptionType list.

Method Detail

getSettingsList

protected java.util.List<MFAOptionType> getSettingsList()

Returns a MFAOptionType list

Returns:

User settings as a MFAOptionType list.

getSettings

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

Return user settings as key, value pairs.

Returns:

user settings as a key, value pairs.

setSettings

public void setSettings(java.lang.String attributeName,
                        java.lang.String option)

Sets user settings.

Add a new setting for this user. This will override an earlier value set for an attribute in this object.

Parameters:

attributeName - REQUIRED: User's attribute name, whose setting is being changed

option - REQUIRED: The value of the setting.