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>
getter/setter pair
authData ↔ Map<String, dynamic>?
getter/setter pair
createdAt → DateTime?
Returns DateTime createdAt
no setterinherited
emailAddress ↔ String?
getter/setter pair
emailVerified ↔ bool?
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
objectId ↔ String?
Returns String objectId
getter/setter pairinherited
parseClassName ↔ String
refers to the Table Name in your Parse Server
getter/setter pairinherited
password ↔ String?
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sessionToken ↔ String?
getter/setter pair
updatedAt → DateTime?
Returns DateTime updatedAt
no setterinherited
username ↔ String?
getter/setter pair

Methods

addRelation(String key, List<ParseObject> objets) → void
Add multiple objets to a relation associated with a given key
inherited
clearUnsavedChanges() → void
inherited
clone(Map<String, dynamic> map) → dynamic
override
containsKey(String key) → bool
inherited
containsValue(Object value) → bool
inherited
copy() → dynamic
Creates a copy of this class
inherited
create({bool allowCustomObjectId = false}) → Future<ParseResponse>
Creates a new object and saves it online
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
fetch({List<String>? include}) → Future<ParseObject>
Fetches this object with the data from the server.
inherited
forgetLocalSession() → void
fromJson(Map<String, dynamic> objectData) → dynamic
inherited
fromJsonForManualObject(Map<String, dynamic> objectData) → dynamic
inherited
fromPin(String objectId) → Future
Get item from value storage
inherited
get<T>(String key, {T? defaultValue}) → T?
Get a value of type T associated with a given key
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
getObject(String objectId, {List<String>? include}) → Future<ParseResponse>
Gets an object from the server using it's objectId
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
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 nonexistent method or property is accessed.
inherited
pin() → Future<bool>
Saves item to value storage
inherited
query<T extends ParseObject>(String query, {ProgressCallback? progressCallback}) → Future<ParseResponse>
Can be used to create custom queries
inherited
removeRelation(String key, List<ParseObject> objets) → void
Remove multiple objets from a relation associated with a given key
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
Add a key-value pair to this object.
inherited
setACL<ParseACL>(ParseACL acl) → void
Set the ParseACL governing this object.
inherited
setAdd<T>(String key, T element) → void
Add an element to the end of the array associated with a given key
inherited
setAddAll(String key, List elements) → void
Add multiple elements to the end of the array associated with a given key
inherited
setAddAllUnique(String key, List elements) → void
Add multiple elements to the array associated with a given key, only adding elements which are not already present in the array. The position of the insert is not guaranteed
inherited
setAddUnique(String key, dynamic element) → void
Add an element to the array associated with a given key, only if it is not already present in the array. The position of the insert is not guaranteed
inherited
setDecrement(String key, num amount) → void
Decrement a num value associated with a given key by the given amount
inherited
setIncrement(String key, num amount) → void
Increment a num value associated with a given key by the given amount
inherited
setRemove(String key, dynamic element) → void
Remove every instance of an element from an array associated with a given key
inherited
setRemoveAll(String key, List elements) → void
Removes all instances of the elements contained in a List from the array associated with a given key
inherited
signUp({bool allowWithoutEmail = false, bool doNotSendInstallationID = false}) → Future<ParseResponse>
Registers a user on Parse Server
toJson({bool full = false, bool forApiRQ = false, bool allowCustomObjectId = false}) → Map<String, dynamic>
Converts object to String in JSON format
inherited
toPointer() → Map<String, dynamic>
inherited
toString() → String
A string representation of this object.
inherited
unpin({String? key}) → Future<bool>
Remove item from 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>
Send the updated object to the server.
override
verificationEmailRequest() → Future<ParseResponse>
Sends a verification email to the users email address

Operators

operator ==(Object other) → bool
The equality operator.
inherited
operator [](String 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
keyEmailVerified → const String
keyUsername → const String
path → const String