CognitoUserAttributeKey class
User attributes available for configuring via Amplify.Auth.signUp,
or updating via Amplify.Auth.updateUserAttribute and
Amplify.Auth.updateUserAttributes.
More information about these attributes can be found here.
Use CognitoUserAttributeKey.custom to create a custom Cognito attribute.
- Inheritance
-
- Object
- UserAttributeKey
- CognitoUserAttributeKey
- Annotations
Constructors
- CognitoUserAttributeKey.custom(String _key)
-
Creates a custom Cognito attribute.
const
- CognitoUserAttributeKey.parse(String key)
-
Parses the given Cognito attribute key.
factory
Properties
- hashCode → int
-
The hash code for this object.
no setteroverride
- isCustom → bool
-
Whether this is a custom key.
final
- key → String
-
The JSON key for this attribute.
no setteroverride
- readOnly → bool
-
Whether this attribute can only be read from Cognito.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
compareTo(
UserAttributeKey other) → int -
Compares this object to another object.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
override
Constants
- address → const CognitoUserAttributeKey
- The user's preferred postal address.
- birthdate → const CognitoUserAttributeKey
- The user's birthday, represented as an ISO 8601 YYYY-MM-DD format.
- customPrefix → const String
- Prefix for custom Cognito attributes.
- email → const CognitoUserAttributeKey
- The user's preferred e-mail address.
- emailVerified → const CognitoUserAttributeKey
- Whether the user's preferred e-mail address has been verified in Cognito.
- familyName → const CognitoUserAttributeKey
- Surname(s) or last name(s) of the user.
- gender → const CognitoUserAttributeKey
- The user's gender.
- givenName → const CognitoUserAttributeKey
- Given name(s) or first name(s) of the user.
- identities → const CognitoUserAttributeKey
- Federated identities of the user.
- locale → const CognitoUserAttributeKey
-
The user's locale, represented as a BCP47 language tag, e.g.
en-US. - middleName → const CognitoUserAttributeKey
- Middle name(s) of the user.
- name → const CognitoUserAttributeKey
- The user's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the user's locale and preferences.
- nickname → const CognitoUserAttributeKey
- Casual name of the user that may or may not be the same as their given name.
- phoneNumber → const CognitoUserAttributeKey
- The user's preferred telephone number.
- phoneNumberVerified → const CognitoUserAttributeKey
- Whether the user's preferred telephone number has been verified in Cognito.
- picture → const CognitoUserAttributeKey
- URL of the user's profile picture.
- preferredUsername → const CognitoUserAttributeKey
- The username by which the user wishes to be referred to.
- profile → const CognitoUserAttributeKey
- URL of the user's profile page.
- sub → const CognitoUserAttributeKey
- The user ID.
- updatedAt → const CognitoUserAttributeKey
- The time the user's information was last updated.
-
values
→ const List<
CognitoUserAttributeKey> - website → const CognitoUserAttributeKey
- URL of the user's Web page or blog.
- zoneinfo → const CognitoUserAttributeKey
-
A string from the zoneinfo time zone
database representing the user's time zone, e.g.
America/Los_Angeles.