ParseUser class

Inheritance
Implemented types

Constructors

ParseUser(String username, String password, String emailAddress, {String sessionToken, bool debug, ParseClient client})
Creates an instance of ParseUser [...]
ParseUser.clone(Map<String, dynamic> map)
ParseUser.forQuery()

Properties

acl Map<String, dynamic>
read / write
authData Map<String, dynamic>
read / write
className String
Deprecated
@Deprecated('Prefer to use parseClassName'), read / write, inherited
createdAt DateTime
Returns DateTime createdAt
read-only, inherited
emailAddress String
read / write
emailVerified bool
read / write
hashCode int
The hash code for this object. [...]
read-only, inherited
objectId String
Returns String objectId
read / write, inherited
parseClassName String
read / write, inherited
password String
read / write
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
sessionToken String
read / write
type Type
read / write, inherited
updatedAt DateTime
Returns DateTime updatedAt
read-only, inherited
username String
read / write

Methods

add(String key, dynamic values) Future<ParseResponse>
Add a single element to an array of an object
@Deprecated('Prefer to use the setAdd() method in save()'), inherited
addAll(String key, List values) Future<ParseResponse>
Add a multiple elements to an array of an object
@Deprecated('Prefer to use the setAddAll() method in save()'), inherited
addRelation(String key, List values) → void
inherited
addUnique(String key, List values) Future<ParseResponse>
Add a multiple elements to an array of an object, but only when they are unique
@Deprecated('Prefer to use the setAddAll() method in save()'), inherited
clearUnsavedChanges() → void
inherited
clone(Map<String, dynamic> map) → dynamic
override
containsKey(Object key) bool
inherited
containsValue(Object value) bool
inherited
copy() → dynamic
Creates a copy of this class
@protected, inherited
create({bool allowCustomObjectId = false}) Future<ParseResponse>
Creates a new object and saves it online
inherited
decrement(String key, num amount) Future<ParseResponse>
Decreases a num of an object by x amount
@Deprecated('Prefer to use the setDecrement() method in save()'), inherited
delete<T extends ParseObject>({String id, String path}) Future<ParseResponse>
Deletes the current object locally and online
inherited
deleteLocalUserData() Future<void>
Delete the local user data.
destroy() Future<ParseResponse>
Removes a user from Parse Server locally and online
distinct<T extends ParseObject>(String query) Future<ParseResponse>
inherited
forgetLocalSession() → void
fromJson(Map<String, dynamic> objectData) → dynamic
inherited
fromPin(String objectId) → Future
Saves item to simple key pair value storage [...]
inherited
get<T>(String key, {T defaultValue}) → T
Gets type T from objectData [...]
inherited
getACL() ParseACL
Access the ParseACL governing this object.
inherited
getAll() Future<ParseResponse>
Gets all objects from this table - Limited response at the moment
inherited
getClassName() String
@Deprecated('Prefer to use parseClassName'), inherited
getObject(String objectId) Future<ParseResponse>
Gets an object from the server using it's String objectId
inherited
getObjectData() Map<String, dynamic>
@Deprecated('Prefer to use _getObjectData method, or operator [] for certain key.'), @protected, inherited
getRelation<T extends ParseObject>(String key) ParseRelation<T>
Get the instance of ParseRelation class associated with the given key.
inherited
getUpdatedUser({bool debug, ParseClient client}) Future<ParseResponse>
Get the updated version of the user from the server [...]
increment(String key, num amount) Future<ParseResponse>
Increases a num of an object by x amount
@Deprecated('Prefer to use the setIncrement() method in save()'), inherited
isDirty({String key}) bool
inherited
login({bool doNotSendInstallationID = false}) Future<ParseResponse>
Logs a user in via Parse [...]
loginAnonymous({bool doNotSendInstallationID = false}) Future<ParseResponse>
Logs in a user anonymously Set doNotSendInstallationID to 'true' in order to prevent the SDK from sending the installationID to the Server. This option is especially useful if you are running you application on web and you don't have permission to add 'X-Parse-Installation-Id' as an allowed header on your parse-server.
logout({bool deleteLocalUserData = true}) Future<ParseResponse>
Sends a request to delete the sessions token from the server. Will also delete the local user data unless deleteLocalUserData is false.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
pin() Future<bool>
Saves item to simple key pair value storage [...]
inherited
query<T extends ParseObject>(String query, {ProgressCallback progressCallback}) Future<ParseResponse>
Can be used to create custom queries
inherited
remove(String key, dynamic values) Future<ParseResponse>
Removes an element from an Array
@Deprecated('Prefer to use the setRemove() method in save()'), inherited
removeAll(String key, List values) Future<ParseResponse>
Remove multiple elements from an array of an object
@Deprecated('Prefer to use the setRemoveAll() method in save()'), inherited
removeRelation(String key, List values) → void
inherited
requestPasswordReset() Future<ParseResponse>
Sends a password reset email to the users email address
save() Future<ParseResponse>
Saves the current user [...]
override
saveInStorage(String key) Future<void>
Saves in storage
inherited
set<T>(String key, T value, {bool forceUpdate = true}) → void
Sets type T from objectData [...]
inherited
setACL<ParseACL>(ParseACL acl) → void
Set the ParseACL governing this object.
inherited
setAdd(String key, dynamic value) → void
Add a single element to an array of an object
inherited
setAddAll(String key, List values) → void
Add a multiple elements to an array of an object
inherited
setAddAllUnique(String key, List values) → void
Add a multiple elements to an array of an object
inherited
setAddUnique(String key, dynamic value) → void
inherited
setClassName(String className) String
@Deprecated('Prefer to use parseClassName'), inherited
setDecrement(String key, num amount) → void
Decreases a num of an object by x amount
inherited
setIncrement(String key, num amount) → void
Increases a num of an object by x amount
inherited
setObjectData(Map<String, dynamic> objectData) → void
@Deprecated('Prefer to use _setObjectData method, or operator [] for certain key.'), @protected, inherited
setRemove(String key, dynamic value) → void
Removes an element from an Array
inherited
setRemoveAll(String key, List values) → void
Remove multiple elements from an array of an object
inherited
signUp({bool allowWithoutEmail = false, bool doNotSendInstallationID = false}) Future<ParseResponse>
Registers a user on Parse Server [...]
toJson({bool full, bool forApiRQ = false, bool allowCustomObjectId = false}) Map<String, dynamic>
Converts object to String in JSON format
@protected, inherited
toPointer() Map<String, dynamic>
inherited
toString() String
Returns a string representation of this object.
inherited
unpin({String key}) Future<bool>
Saves item to simple key pair value storage [...]
inherited
unset(String key, {bool offlineOnly = false}) Future<ParseResponse>
Can be used set an objects variable to undefined rather than null [...]
inherited
update() Future<ParseResponse>
override
verificationEmailRequest() Future<ParseResponse>
Sends a verification email to the users email address

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited
operator [](Object key) → dynamic
inherited
operator []=(String key, dynamic value) → void
inherited

Static Methods

all({bool debug, ParseClient client}) Future<ParseResponse>
Gets a list of all users (limited return)
createUser([String username, String password, String emailAddress]) ParseUser
currentUser({ParseCloneable customUserObject}) Future
Gets the current user from storage [...]
getCurrentUserFromServer(String token, {bool debug, ParseClient client}) Future<ParseResponse>
Gets the current user from the server [...]
loginWith(String provider, Object authData, {bool doNotSendInstallationID = false, String username, String password, String email}) Future<ParseResponse>
Logs in a user using a service Set doNotSendInstallationID to 'true' in order to prevent the SDK from sending the installationID to the Server. This option is especially useful if you are running you application on web and you don't have permission to add 'X-Parse-Installation-Id' as an allowed header on your parse-server.

Constants

keyEmailAddress → const String
'email'
keyEmailVerified → const String
'emailVerified'
keyUsername → const String
'username'
path → const String
'$keyEndPointClasses$keyClassUser'