CognitoSignUpOptions class
Cognito options for Amplify.Auth.signUp.
- Inheritance
-
- Object
- SignUpOptions
- CognitoSignUpOptions
- Annotations
-
- @zAmplifySerializable
- @Deprecated(_deprecatedMessage)
Constructors
-
CognitoSignUpOptions({Map<
CognitoUserAttributeKey, String> userAttributes = const {}, Map<String, String> ? validationData, Map<String, String> ? clientMetadata}) -
Cognito options for
Amplify.Auth.signUp. -
CognitoSignUpOptions.fromJson(Map<
String, Object?> json) -
Cognito options for
Amplify.Auth.signUp.factory
Properties
-
clientMetadata
→ Map<
String, String> -
Additional custom attributes to be sent to the service such as information
about the client.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- pluginOptions → CognitoSignUpPluginOptions
-
Plugin-specific options for
Amplify.Auth.signUp.no setteroverride -
props
→ List<
Object?> -
The type's equatable properties.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- runtimeTypeName → String
-
The string value of runtimeType, saving a runtime lookup and preventing
obfuscation during web compilation.
no setteroverride
-
userAttributes
→ Map<
CognitoUserAttributeKey, String> -
final
-
validationData
→ Map<
String, String> -
An optional map of arbitrary key-value pairs which will be passed to your
PreAuthentication Lambda trigger as-is, used for implementing additional
validations around authentication.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, Object?> -
Serializes
thisas a JSON object.override -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited