CognitoUserPool class


CognitoUserPool(String userPoolId, String clientId, {String? clientSecret, String? endpoint, Client? customClient, String? customUserAgent, CognitoStorage? storage, bool advancedSecurityDataCollectionFlag = true, ParamsDecorator? analyticsMetadataParamsDecorator})


advancedSecurityDataCollectionFlag bool
getter/setter pair
client Client?
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
lastUserKey String
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
storage CognitoStorage
getter/setter pair


getClientId() String?
getCurrentUser() Future<CognitoUser?>
getRegion() String?
getUserContextData(String? username) String?
This method returns the encoded data string used for cognito advanced security feature. This would be generated only when developer has included the JS used for collecting the data on their client. Please refer to documentation to know more about using AdvancedSecurity features TODO: not supported at the moment
getUserPoolId() String
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
signUp(String username, String password, {List<AttributeArg>? userAttributes, List<AttributeArg>? validationData, Map<String, String>? clientMetadata}) Future<CognitoUserPoolData>
Registers the user in the specified user pool and creates a user name, password, optional user attributes, optional validation data and optional client metadata.
toString() String
A string representation of this object.


operator ==(Object other) bool
The equality operator.